(define-minor-mode): Generate `turn-on-MODE' and `turn-off-MODE'
[emacs.git] / man / emacs.texi
blob2f050f4346e0326e59f2c9d40b095cfc28010ef8
1 \input texinfo
3 @setchapternewpage odd
4 @settitle GNU Emacs Manual
5 @setfilename ../info/emacs
6 @synindex pg cp
8 @ifnottex
9 @c The edition number appears in several places in this file
10 This is the fourteenth edition of the @cite{GNU Emacs Manual},
11 updated for Emacs version 21.1
12 @c Please REMEMBER to update edition number in *three* places in this file.
14 @dircategory Emacs
15 @direntry
16 * Emacs: (emacs).       The extensible self-documenting text editor.
17 @end direntry
19 Published by the Free Software Foundation
20 59 Temple Place, Suite 330
21 Boston, MA  02111-1307 USA
23 Copyright (C) 1985, 1986,1987,1993,1994,1995,1996,1997,1998,1999,2000
24    Free Software Foundation, Inc.
26 Permission is granted to copy, distribute and/or modify this document
27 under the terms of the GNU Free Documentation License, Version 1.1 or
28 any later version published by the Free Software Foundation; with the
29 Invariant Sections being ``The GNU Manifesto'', ``Distribution'' and
30 ``GNU GENERAL PUBLIC LICENSE'', with the Front-Cover texts being ``A GNU
31 Manual'', and with the Back-Cover Texts as in (a) below.  A copy of the
32 license is included in the section entitled ``GNU Free Documentation
33 License''.
35 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
36 this GNU Manual, like GNU software.  Copies published by the Free
37 Software Foundation raise funds for GNU development.''
38 @end ifnottex
40 @c in general, keep the following line commented out, unless doing a
41 @c copy of this manual that will be published.  the manual should go
42 @c onto the distribution in the full, 8.5 x 11" size.  
44 @smallbook
46 @iftex
47 @kbdinputstyle code
49 @shorttitlepage GNU Emacs Manual
50 @end iftex
51 @titlepage
52 @sp 6
53 @center @titlefont{GNU Emacs Manual}
54 @sp 4
55 @center Fourteenth Edition, Updated for Emacs Version 21.1
56 @sp 5
57 @center Richard Stallman
58 @page
59 @vskip 0pt plus 1filll
60 Copyright @copyright{} 1985, 1986, 1987, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000
61    Free Software Foundation, Inc.
62 @sp 2
63 Fourteenth Edition @*
64 Updated for Emacs Version 21.1, @*
65 August 2000
67 ISBN 1-882114-06-X
68 @sp 1
69 Published by the Free Software Foundation @*
70 59 Temple Place, Suite 330 @*
71 Boston, MA  02111-1307 USA
72 @sp 1
73 Permission is granted to copy, distribute and/or modify this document
74 under the terms of the GNU Free Documentation License, Version 1.1 or
75 any later version published by the Free Software Foundation; with the
76 Invariant Sections being ``The GNU Manifesto'', ``Distribution'' and
77 ``GNU GENERAL PUBLIC LICENSE'', with the Front-Cover texts being ``A GNU
78 Manual'', and with the Back-Cover Texts as in (a) below.  A copy of the
79 license is included in the section entitled ``GNU Free Documentation
80 License''.
82 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
83 this GNU Manual, like GNU software.  Copies published by the Free
84 Software Foundation raise funds for GNU development.''
86 @sp 2
87 Cover art by Etienne Suvasa.
89 @end titlepage
90 @page
91 @ifnottex
92 @node Top, Distrib, (dir), (dir)
93 @top The Emacs Editor
95 Emacs is the extensible, customizable, self-documenting real-time
96 display editor.  This Info file describes how to edit with Emacs and
97 some of how to customize it; it corresponds to GNU Emacs version 21.1.
98 For information on extending Emacs, see @ref{,Emacs Lisp,, elisp, The
99 Emacs Lisp Reference Manual}.
100 @end ifnottex
102 @ignore
103 These subcategories have been deleted for simplicity
104 and to avoid conflicts.
105 Completion
106 Backup Files
107 Auto-Saving: Protection Against Disasters
108 Snapshots
109 Text Mode
110 Outline Mode
111 @TeX{} Mode
112 Formatted Text
113 Fortran Mode
114 Fortran Indentation
115 Shell Command History
117 The ones for Dired and Rmail have had the items turned into :: items
118 to avoid conflicts.
119 Also Running Shell Commands from Emacs
120 and Sending Mail and Registers and Minibuffer.
121 @end ignore
123 @menu
124 * Distrib::             How to get the latest Emacs distribution.
125 * Copying::             The GNU General Public License gives you permission
126                           to redistribute GNU Emacs on certain terms;
127                           it also explains that there is no warranty.
128 * GNU Free Documentation License:: The license for this documentation.
129 * Intro::               An introduction to Emacs concepts.
130 * Glossary::            The glossary.
131 * Antinews::            Information about Emacs version 20.
132 * MS-DOS::              Using Emacs on MS-DOS (otherwise known as "MS-DOG").
133 * Manifesto::           What's GNU?  Gnu's Not Unix!
134 * Acknowledgments::     Major contributors to GNU Emacs.
136 Indexes (nodes containing large menus)
137 * Key Index::           An item for each standard Emacs key sequence.
138 * Command Index::       An item for each command name.
139 * Variable Index::      An item for each documented variable.
140 * Concept Index::       An item for each concept.
142 Important General Concepts
143 * Screen::              How to interpret what you see on the screen.
144 * User Input::          Kinds of input events (characters, buttons,
145                           function keys).
146 * Keys::                Key sequences: what you type to request one
147                           editing action.
148 * Commands::            Named functions run by key sequences to do editing.
149 * Text Characters::     Character set for text (the contents of buffers 
150                           and strings).
151 * Entering Emacs::      Starting Emacs from the shell.
152 * Exiting::             Stopping or killing Emacs.
153 * Command Arguments::   Hairy startup options.
155 Fundamental Editing Commands
156 * Basic::               The most basic editing commands.
157 * Minibuffer::          Entering arguments that are prompted for.
158 * M-x::                 Invoking commands by their names.
159 * Help::                Commands for asking Emacs about its commands.
161 Important Text-Changing Commands
162 * Mark::                The mark: how to delimit a ``region'' of text.
163 * Killing::             Killing text.
164 * Yanking::             Recovering killed text.  Moving text.
165 * Accumulating Text::   Other ways of copying text.
166 * Rectangles::          Operating on the text inside a rectangle on the screen.
167 * Registers::           Saving a text string or a location in the buffer.
168 * Display::             Controlling what text is displayed.
169 * Search::              Finding or replacing occurrences of a string.
170 * Fixit::               Commands especially useful for fixing typos.
172 Major Structures of Emacs
173 * Files::               All about handling files.
174 * Buffers::             Multiple buffers; editing several files at once.
175 * Windows::             Viewing two pieces of text at once.
176 * Frames::              Running the same Emacs session in multiple X windows.
177 * International::       Using non-ASCII character sets (the MULE features).
179 Advanced Features
180 * Major Modes::         Text mode vs. Lisp mode vs. C mode ...
181 * Indentation::         Editing the white space at the beginnings of lines.
182 * Text::                Commands and modes for editing English.
183 * Programs::            Commands and modes for editing programs.
184 * Building::            Compiling, running and debugging programs.
185 * Abbrevs::             How to define text abbreviations to reduce
186                           the number of characters you must type.
187 * Picture::             Editing pictures made up of characters
188                           using the quarter-plane screen model.
189 * Sending Mail::        Sending mail in Emacs.
190 * Rmail::               Reading mail in Emacs.
191 * Dired::               You can ``edit'' a directory to manage files in it.
192 * Calendar/Diary::      The calendar and diary facilities.
193 * Gnus::                How to read netnews with Emacs.
194 * Shell::               Executing shell commands from Emacs.
195 * Emacs Server::        Using Emacs as an editing server for @code{mail}, etc.
196 * Hardcopy::            Printing buffers or regions.
197 * PostScript::          Printing buffers or regions as PostScript.
198 * PostScript Variables::
199                         Customizing the PostScript printing commands.
200 * Sorting::             Sorting lines, paragraphs or pages within Emacs.
201 * Narrowing::           Restricting display and editing to a portion
202                           of the buffer.
203 * Two-Column::          Splitting apart columns to edit them
204                           in side-by-side windows.
205 * Editing Binary Files::
206                         Using Hexl mode to edit binary files.
207 * Saving Emacs Sessions::
208                         Saving Emacs state from one session to the next.
209 * Recursive Edit::      A command can allow you to do editing
210                           "within the command".  This is called a
211                           `recursive editing level'.
212 * Emulation::           Emulating some other editors with Emacs.
213 * Hyperlinking::        Following links in buffers.
214 * Dissociated Press::   Dissociating text for fun.
215 * Amusements::          Various games and hacks.
216 * Customization::       Modifying the behavior of Emacs.
218 Recovery from Problems
219 * Quitting::            Quitting and aborting.
220 * Lossage::             What to do if Emacs is hung or malfunctioning.
221 * Bugs::                How and when to report a bug.
222 * Contributing::        How to contribute improvements to Emacs.
223 * Service::             How to get help for your own Emacs needs.
225 Here are some other nodes which are really inferiors of the ones
226 already listed, mentioned here so you can get to them in one step:
228  --- The Detailed Node Listing ---
230 The Organization of the Screen
232 * Point::               The place in the text where editing commands operate.
233 * Echo Area::           Short messages appear at the bottom of the screen.
234 * Mode Line::           Interpreting the mode line.
235 * Menu Bar::            How to use the menu bar.
237 Basic Editing Commands
239 * Inserting Text::      Inserting text by simply typing it.
240 * Moving Point::        How to move the cursor to the place where you want to
241                           change something.
242 * Erasing::             Deleting and killing text.
243 * Undo::                Undoing recent changes in the text.
244 * Files: Basic Files.   Visiting, creating, and saving files.
245 * Help: Basic Help.     Asking what a character does.
246 * Blank Lines::         Commands to make or delete blank lines.
247 * Continuation Lines::  Lines too wide for the screen.
248 * Position Info::       What page, line, row, or column is point on?
249 * Arguments::           Numeric arguments for repeating a command.
251 The Minibuffer
253 * Minibuffer File::     Entering file names with the minibuffer.
254 * Minibuffer Edit::     How to edit in the minibuffer.
255 * Completion::          An abbreviation facility for minibuffer input.
256 * Minibuffer History::  Reusing recent minibuffer arguments.
257 * Repetition::          Re-executing commands that used the minibuffer.
259 Help
261 * Help Summary::        Brief list of all Help commands.
262 * Key Help::            Asking what a key does in Emacs.
263 * Name Help::           Asking about a command, variable or function name.
264 * Apropos::             Asking what pertains to a given topic.
265 * Library Keywords::    Finding Lisp libraries by keywords (topics).
266 * Language Help::       Help relating to international language support.
267 * Misc Help::           Other help commands.
269 The Mark and the Region
271 * Setting Mark::        Commands to set the mark.
272 * Transient Mark::      How to make Emacs highlight the region--
273                           when there is one.
274 * Using Region::        Summary of ways to operate on contents of the region.
275 * Marking Objects::     Commands to put region around textual units.
276 * Mark Ring::           Previous mark positions saved so you can go back there.
277 * Global Mark Ring::    Previous mark positions in various buffers.
279 Deletion and Killing
281 * Deletion::            Commands for deleting small amounts of text and
282                           blank areas.
283 * Killing by Lines::    How to kill entire lines of text at one time.
284 * Other Kill Commands:: Commands to kill large regions of text and
285                           syntactic units such as words and sentences. 
287 Yanking
289 * Kill Ring::           Where killed text is stored.  Basic yanking.
290 * Appending Kills::     Several kills in a row all yank together.
291 * Earlier Kills::       Yanking something killed some time ago.
293 Registers
295 * RegPos::              Saving positions in registers.
296 * RegText::             Saving text in registers.
297 * RegRect::             Saving rectangles in registers.
298 * RegConfig::           Saving window configurations in registers.
299 * RegFiles::            File names in registers.
300 * Bookmarks::           Bookmarks are like registers, but persistent.
302 Controlling the Display
304 * Scrolling::              Moving text up and down in a window.
305 * Horizontal Scrolling::   Moving text left and right in a window.
306 * Follow Mode::            Follow mode lets two windows scroll as one.
307 * Selective Display::      Hiding lines with lots of indentation.
308 * Optional Mode Line::     Optional mode line display features.
309 * Text Display::           How text is normally displayed.
310 * Display Vars::           Information on variables for customizing display.
312 Searching and Replacement
314 * Incremental Search::     Search happens as you type the string.
315 * Nonincremental Search::  Specify entire string and then search.
316 * Word Search::            Search for sequence of words.
317 * Regexp Search::          Search for match for a regexp.
318 * Regexps::                Syntax of regular expressions.
319 * Search Case::            To ignore case while searching, or not.
320 * Replace::                Search, and replace some or all matches.
321 * Other Repeating Search:: Operating on all matches for some regexp.
323 Replacement Commands
325 * Unconditional Replace::  Replacing all matches for a string.
326 * Regexp Replace::         Replacing all matches for a regexp.
327 * Replacement and Case::   How replacements preserve case of letters.
328 * Query Replace::          How to use querying.
330 Commands for Fixing Typos
332 * Kill Errors::         Commands to kill a batch of recently entered text.
333 * Transpose::           Exchanging two characters, words, lines, lists...
334 * Fixing Case::         Correcting case of last word entered.
335 * Spelling::            Apply spelling checker to a word or a whole buffer.
337 File Handling
339 * File Names::          How to type and edit file-name arguments.
340 * Visiting::            Visiting a file prepares Emacs to edit the file.
341 * Saving::              Saving makes your changes permanent.
342 * Reverting::           Reverting cancels all the changes not saved.
343 * Auto Save::           Auto Save periodically protects against loss of data.
344 * File Aliases::        Handling multiple names for one file.
345 * Version Control::     Version control systems (RCS, CVS and SCCS).
346 * Directories::         Creating, deleting, and listing file directories.
347 * Comparing Files::     Finding where two files differ.
348 * Misc File Ops::       Other things you can do on files.
349 * Compressed Files::    Accessing compressed files.
350 * Remote Files::        Accessing files on other sites.
351 * Quoted File Names::   Quoting special characters in file names.
353 Saving Files
355 * Backup::              How Emacs saves the old version of your file.
356 * Interlocking::        How Emacs protects against simultaneous editing
357                           of one file by two users.
359 Version Control
361 * Introduction to VC::  How version control works in general.
362 * VC Mode Line::     How the mode line shows version control status.
363 * Basic VC Editing::    How to edit a file under version control.
364 * Old Versions::        Examining and comparing old versions.
365 * Secondary VC Commands::    The commands used a little less frequently.
366 * Branches::            Multiple lines of development.
367 * Snapshots::           Sets of file versions treated as a unit.
368 * Miscellaneous VC::    Various other commands and features of VC.
369 * Customizing VC::      Variables that change VC's behavior.
371 Using Multiple Buffers
373 * Select Buffer::       Creating a new buffer or reselecting an old one.
374 * List Buffers::        Getting a list of buffers that exist.
375 * Misc Buffer::         Renaming; changing read-onlyness; copying text.
376 * Kill Buffer::         Killing buffers you no longer need.
377 * Several Buffers::     How to go through the list of all buffers
378                           and operate variously on several of them.
379 * Indirect Buffers::    An indirect buffer shares the text of another buffer. 
381 Multiple Windows
383 * Basic Window::        Introduction to Emacs windows.
384 * Split Window::        New windows are made by splitting existing windows.
385 * Other Window::        Moving to another window or doing something to it.
386 * Pop Up Window::       Finding a file or buffer in another window.
387 * Force Same Window::   Forcing certain buffers to appear in the selected
388                           window rather than in another window.
389 * Change Window::       Deleting windows and changing their sizes.
391 Frames and X Windows
393 * Mouse Commands::      Moving, cutting, and pasting, with the mouse.
394 * Secondary Selection:: Cutting without altering point and mark.
395 * Mouse References::    Using the mouse to select an item from a list.
396 * Menu Mouse Clicks::   Mouse clicks that bring up menus.
397 * Mode Line Mouse::     Mouse clicks on the mode line.
398 * Creating Frames::     Creating additional Emacs frames with various contents.
399 * Multiple Displays::   How one Emacs job can talk to several displays.
400 * Special Buffer Frames::  You can make certain buffers have their own frames.
401 * Frame Parameters::    Changing the colors and other modes of frames.
402 * Scroll Bars::         How to enable and disable scroll bars; how to use them.
403 * Menu Bars::           Enabling and disabling the menu bar.
404 * Faces::               How to change the display style using faces.
405 * Font Lock::           Minor mode for syntactic highlighting using faces.
406 * Support Modes::       Font Lock support modes make Font Lock faster.
407 * Misc X::              Iconifying and deleting frames.  Region highlighting.
408 * Non-Window Terminals::  Multiple frames on terminals that show only one.
410 Font Lock Support Modes
412 * Fast Lock Mode::      Saving font information in files.
413 * Lazy Lock Mode::      Fontifying only text that is actually displayed.
414 * Fast or Lazy::        Which support mode is best for you?
416 International Character Set Support
418 * International Intro::     Basic concepts of multibyte characters.
419 * Enabling Multibyte::      Controlling whether to use multibyte characters.
420 * Language Environments::   Setting things up for the language you use.
421 * Input Methods::           Entering text characters not on your keyboard.
422 * Select Input Method::     Specifying your choice of input methods.
423 * Coding Systems::          Character set conversion when you read and
424                               write files, and so on.
425 * Recognize Coding::        How Emacs figures out which conversion to use.
426 * Specify Coding::          Various ways to choose which conversion to use.
427 * Fontsets::                Fontsets are collections of fonts
428                               that cover the whole spectrum of characters.
429 * Defining Fontsets::       Defining a new fontset.
430 * Single-Byte Character Support::
431                             You can pick one European character set
432                             to use without multibyte characters.
434 Major Modes
436 * Choosing Modes::      How major modes are specified or chosen.
438 Indentation
440 * Indentation Commands::  Various commands and techniques for indentation.
441 * Tab Stops::             You can set arbitrary "tab stops" and then
442                             indent to the next tab stop when you want to.
443 * Just Spaces::           You can request indentation using just spaces.
445 Commands for Human Languages
447 * Words::               Moving over and killing words.
448 * Sentences::           Moving over and killing sentences.
449 * Paragraphs::          Moving over paragraphs.
450 * Pages::               Moving over pages.
451 * Filling::             Filling or justifying text.
452 * Case::                Changing the case of text.
453 * Text Mode::           The major modes for editing text files.
454 * Outline Mode::        Editing outlines.
455 * TeX Mode::            Editing input to the formatter TeX.
456 * Nroff Mode::          Editing input to the formatter nroff.
457 * Formatted Text::      Editing formatted text directly in WYSIWYG fashion.
459 Filling Text
461 * Auto Fill::           Auto Fill mode breaks long lines automatically.
462 * Fill Commands::       Commands to refill paragraphs and center lines.
463 * Fill Prefix::         Filling paragraphs that are indented
464                           or in a comment, etc.
465 * Adaptive Fill::       How Emacs can determine the fill prefix automatically.
467 Editing Programs
469 * Program Modes::       Major modes for editing programs.
470 * Lists::               Expressions with balanced parentheses.
471 * List Commands::       The commands for working with list and sexps.
472 * Defuns::              Each program is made up of separate functions.
473                           There are editing commands to operate on them.
474 * Program Indent::      Adjusting indentation to show the nesting.
475 * Matching::            Insertion of a close-delimiter flashes matching open.
476 * Comments::            Inserting, killing, and aligning comments.
477 * Balanced Editing::    Inserting two matching parentheses at once, etc.
478 * Symbol Completion::   Completion on symbol names of your program or language.
479 * Documentation::       Getting documentation of functions you plan to call.
480 * Change Log::          Maintaining a change history for your program.
481 * Tags::                Go directly to any function in your program in one
482                           command.  Tags remembers which file it is in.
483 * Emerge::              A convenient way of merging two versions of a program.
484 * C Modes::             Special commands of C, C++, Objective-C and Java modes.
485 * Fortran::             Fortran mode and its special features.
486 * Asm Mode::            Asm mode and its special features.
488 Indentation for Programs
490 * Basic Indent::        Indenting a single line.
491 * Multi-line Indent::   Commands to reindent many lines at once.
492 * Lisp Indent::         Specifying how each Lisp function should be indented.
493 * C Indent::            Choosing an indentation style for C code.
495 Tags Tables
497 * Tag Syntax::          Tag syntax for various types of code and text files.  
498 * Create Tags Table::   Creating a tags table with @code{etags}.
499 * Select Tags Table::   How to visit a tags table.
500 * Find Tag::            Commands to find the definition of a specific tag. 
501 * Tags Search::         Using a tags table for searching and replacing.
502 * List Tags::           Listing and finding tags defined in a file.
504 Merging Files with Emerge
506 * Overview of Emerge::  How to start Emerge.  Basic concepts.
507 * Submodes of Emerge::  Fast mode vs. Edit mode.
508                           Skip Prefers mode and Auto Advance mode.
509 * State of Difference:: You do the merge by specifying state A or B
510                           for each difference.
511 * Merge Commands::      Commands for selecting a difference,
512                           changing states of differences, etc.
513 * Exiting Emerge::      What to do when you've finished the merge.
514 * Combining in Emerge::     How to keep both alternatives for a difference.
515 * Fine Points of Emerge::   Misc.
517 Compiling and Testing Programs
519 * Compilation::         Compiling programs in languages other
520                           than Lisp (C, Pascal, etc.).
521 * Compilation Mode::    The mode for visiting compiler errors.
522 * Compilation Shell::   Customizing your shell properly
523                           for use in the compilation buffer.
524 * Debuggers::           Running symbolic debuggers for non-Lisp programs. 
525 * Executing Lisp::      Various modes for editing Lisp programs, 
526                           with different facilities for running
527                           the Lisp programs. 
528 * Lisp Libraries::      Creating Lisp programs to run in Emacs.
529 * Lisp Interaction::    Executing Lisp in an Emacs buffer.
530 * Lisp Eval::           Executing a single Lisp expression in Emacs.
531 * External Lisp::       Communicating through Emacs with a separate Lisp. 
533 Running Debuggers Under Emacs
535 * Starting GUD::        How to start a debugger subprocess.
536 * Debugger Operation::  Connection between the debugger and source buffers.
537 * Commands of GUD::     Key bindings for common commands.
538 * GUD Customization::   Defining your own commands for GUD.
540 Abbrevs
542 * Abbrev Concepts::     Fundamentals of defined abbrevs.
543 * Defining Abbrevs::    Defining an abbrev, so it will expand when typed.
544 * Expanding Abbrevs::   Controlling expansion: prefixes, canceling expansion.
545 * Editing Abbrevs::     Viewing or editing the entire list of defined abbrevs.
546 * Saving Abbrevs::      Saving the entire list of abbrevs for another session.
547 * Dynamic Abbrevs::     Abbreviations for words already in the buffer.
549 Editing Pictures
551 * Basic Picture::       Basic concepts and simple commands of Picture Mode.
552 * Insert in Picture::   Controlling direction of cursor motion
553                           after "self-inserting" characters.
554 * Tabs in Picture::     Various features for tab stops and indentation.
555 * Rectangles in Picture:: Clearing and superimposing rectangles.
557 Sending Mail
559 * Mail Format::         Format of the mail being composed.
560 * Mail Headers::        Details of permitted mail header fields.
561 * Mail Aliases::        Abbreviating and grouping mail addresses.
562 * Mail Mode::           Special commands for editing mail being composed.
563 * Distracting NSA::     How to distract the NSA's attention.
564 * Mail Methods::        Using alternative mail-composition methods.
566 Reading Mail with Rmail
568 * Rmail Basics::        Basic concepts of Rmail, and simple use.
569 * Rmail Scrolling::     Scrolling through a message.
570 * Rmail Motion::        Moving to another message.
571 * Rmail Deletion::      Deleting and expunging messages.
572 * Rmail Inbox::         How mail gets into the Rmail file.
573 * Rmail Files::         Using multiple Rmail files.
574 * Rmail Output::        Copying message out to files.
575 * Rmail Labels::        Classifying messages by labeling them.
576 * Rmail Attributes::    Certain standard labels, called attributes.
577 * Rmail Reply::         Sending replies to messages you are viewing.
578 * Rmail Summary::       Summaries show brief info on many messages.
579 * Rmail Sorting::       Sorting messages in Rmail.
580 * Rmail Display::       How Rmail displays a message; customization.
581 * Rmail Editing::       Editing message text and headers in Rmail.
582 * Rmail Digest::        Extracting the messages from a digest message.
583 * Out of Rmail::        Converting an Rmail file to mailbox format.
584 * Rmail Rot13::         Reading messages encoded in the rot13 code.
585 * Movemail::            More details of fetching new mail.
587 Dired, the Directory Editor
589 * Dired Enter::              How to invoke Dired.
590 * Dired Commands::           Commands in the Dired buffer.
591 * Dired Deletion::           Deleting files with Dired.
592 * Flagging Many Files::      Flagging files based on their names.
593 * Dired Visiting::           Other file operations through Dired.
594 * Marks vs Flags::           Flagging for deletion vs marking.
595 * Operating on Files::       How to copy, rename, print, compress, etc.
596                                either one file or several files.
597 * Shell Commands in Dired::  Running a shell command on the marked files.
598 * Transforming File Names::  Using patterns to rename multiple files.
599 * Comparison in Dired::      Running `diff' by way of Dired.
600 * Subdirectories in Dired::  Adding subdirectories to the Dired buffer.
601 * Subdirectory Motion::      Moving across subdirectories, and up and down.
602 * Hiding Subdirectories::    Making subdirectories visible or invisible.
603 * Dired Updating::           Discarding lines for files of no interest.
604 * Dired and Find::           Using `find' to choose the files for Dired.
606 The Calendar and the Diary
608 * Calendar Motion::     Moving through the calendar; selecting a date.
609 * Scroll Calendar::     Bringing earlier or later months onto the screen.
610 * Counting Days::       How many days are there between two dates?
611 * General Calendar::    Exiting or recomputing the calendar.
612 * LaTeX Calendar::        Print a calendar using LaTeX.
613 * Holidays::            Displaying dates of holidays.
614 * Sunrise/Sunset::      Displaying local times of sunrise and sunset.
615 * Lunar Phases::        Displaying phases of the moon.
616 * Other Calendars::     Converting dates to other calendar systems.
617 * Diary::               Displaying events from your diary.
618 * Appointments::        Reminders when it's time to do something.
619 * Daylight Savings::    How to specify when daylight savings time is active.
621 Movement in the Calendar
623 * Calendar Unit Motion::      Moving by days, weeks, months, and years.
624 * Move to Beginning or End::  Moving to start/end of weeks, months, and years.
625 * Specified Dates::           Moving to the current date or another
626                                 specific date.
628 Conversion To and From Other Calendars
630 * Calendar Systems::       The calendars Emacs understands
631                              (aside from Gregorian).
632 * To Other Calendar::      Converting the selected date to various calendars.
633 * From Other Calendar::    Moving to a date specified in another calendar.
634 * Mayan Calendar::         Moving to a date specified in a Mayan calendar.
636 The Diary
638 * Diary Commands::         Viewing diary entries and associated calendar dates.
639 * Format of Diary File::   Entering events in your diary.
640 * Date Formats::           Various ways you can specify dates.
641 * Adding to Diary::        Commands to create diary entries.
642 * Special Diary Entries::  Anniversaries, blocks of dates, cyclic entries, etc.
644 @sc{Gnus}
646 * Buffers of Gnus::     The group, summary, and article buffers.
647 * Gnus Startup::        What you should know about starting Gnus.
648 * Summary of Gnus::     A short description of the basic Gnus commands.
650 Running Shell Commands from Emacs
652 * Single Shell::        How to run one shell command and return.
653 * Interactive Shell::   Permanent shell taking input via Emacs.
654 * Shell Mode::          Special Emacs commands used with permanent shell.
655 * Shell History::       Repeating previous commands in a shell buffer.
656 * Shell Options::       Options for customizing Shell mode.
657 * Remote Host::         Connecting to another computer.
659 Customization
661 * Minor Modes::         Each minor mode is one feature you can turn on
662                           independently of any others.
663 * Variables::           Many Emacs commands examine Emacs variables
664                           to decide what to do; by setting variables,
665                           you can control their functioning.
666 * Keyboard Macros::     A keyboard macro records a sequence of
667                           keystrokes to be replayed with a single command. 
668 * Key Bindings::        The keymaps say what command each key runs.
669                           By changing them, you can "redefine keys".
670 * Keyboard Translations::
671                         If your keyboard passes an undesired code
672                            for a key, you can tell Emacs to
673                            substitute another code. 
674 * Syntax::              The syntax table controls how words and
675                            expressions are parsed.
676 * Init File::           How to write common customizations in the
677                           @file{.emacs} file. 
679 Variables
681 * Examining::           Examining or setting one variable's value.
682 * Easy Customization::
683                         Convenient and easy customization of variables.
684 * Hooks::               Hook variables let you specify programs for parts
685                           of Emacs to run on particular occasions.
686 * Locals::              Per-buffer values of variables.
687 * File Variables::      How files can specify variable values.
689 Keyboard Macros
691 * Basic Kbd Macro::     Defining and running keyboard macros.
692 * Save Kbd Macro::      Giving keyboard macros names; saving them in files.
693 * Kbd Macro Query::     Making keyboard macros do different things each time.
695 Customizing Key Bindings
697 * Keymaps::             Generalities.  The global keymap.
698 * Prefix Keymaps::      Keymaps for prefix keys.
699 * Local Keymaps::       Major and minor modes have their own keymaps.
700 * Minibuffer Maps::     The minibuffer uses its own local keymaps.
701 * Rebinding::           How to redefine one key's meaning conveniently.
702 * Init Rebinding::      Rebinding keys with your init file, @file{.emacs}.
703 * Function Keys::       Rebinding terminal function keys.
704 * Named ASCII Chars::   Distinguishing @key{TAB} from @kbd{C-i}, and so on.
705 * Mouse Buttons::       Rebinding mouse buttons in Emacs.
706 * Disabling::           Disabling a command means confirmation is required
707                           before it can be executed.  This is done to protect
708                           beginners from surprises.
710 The Init File, @file{~/.emacs}
712 * Init Syntax::         Syntax of constants in Emacs Lisp.
713 * Init Examples::       How to do some things with an init file.
714 * Terminal Init::       Each terminal type can have an init file.
715 * Find Init::           How Emacs finds the init file.
717 Dealing with Emacs Trouble
719 * DEL Gets Help::       What to do if @key{DEL} doesn't delete.
720 * Stuck Recursive::     `[...]' in mode line around the parentheses.
721 * Screen Garbled::      Garbage on the screen.
722 * Text Garbled::        Garbage in the text.
723 * Unasked-for Search::  Spontaneous entry to incremental search.
724 * Memory Full::         How to cope when you run out of memory.
725 * Emergency Escape::    Emergency escape---
726                           What to do if Emacs stops responding.
727 * Total Frustration::   When you are at your wits' end.
729 Reporting Bugs
731 * Criteria:  Bug Criteria.       Have you really found a bug?
732 * Understanding Bug Reporting::  How to report a bug effectively.
733 * Checklist::                    Steps to follow for a good bug report.
734 * Sending Patches::              How to send a patch for GNU Emacs.
736 Command Line Options and Arguments
738 * Action Arguments::    Arguments to visit files, load libraries,
739                           and call functions.
740 * Initial Options::     Arguments that take effect while starting Emacs.
741 * Command Example::     Examples of using command line arguments.
742 * Resume Arguments::    Specifying arguments when you resume a running Emacs.
743 * Environment::         Environment variables that Emacs uses.
745 * Display X::           Changing the default display and using remote login.
746 * Font X::              Choosing a font for text, under X.
747 * Colors X::            Choosing colors, under X.
748 * Window Size X::       Start-up window size, under X.
749 * Borders X::           Internal and external borders, under X.
750 * Title X::             Specifying the initial frame's title.
751 * Icons X::             Choosing what sort of icon to use, under X.
752 * Resources X::         Advanced use of classes and resources, under X.
753 * Lucid Resources::     X resources for Lucid menus.
754 * Motif Resources::     X resources for Motif menus.
756 Environment Variables
758 * General Variables::   Environment variables that all versions of Emacs use.
759 * Misc Variables::      Certain system specific variables.
761 MS-DOS and Windows 95/98/NT
763 * MS-DOS Input::        Keyboard and mouse usage on MS-DOS.
764 * MS-DOS Display::      Fonts, frames and display size on MS-DOS.
765 * MS-DOS File Names::   File-name conventions on MS-DOS.
766 * Text and Binary::     Text files on MS-DOS use CRLF to separate lines.
767 * MS-DOS Printing::     How to specify the printer on MS-DOS.
768 * MS-DOS Processes::    Running subprocesses on MS-DOS.
769 * Windows Processes::   Running subprocesses on Windows.
770 * Windows System Menu:: Controlling what the ALT key does.
771 @end menu
773 @iftex
774 @unnumbered Preface
776   This manual documents the use and simple customization of the Emacs
777 editor.  The reader is not expected to be a programmer; simple
778 customizations do not require programming skill.  But the user who is not
779 interested in customizing can ignore the scattered customization hints.
781   This is primarily a reference manual, but can also be used as a
782 primer.  For complete beginners, it is a good idea to start with the
783 on-line, learn-by-doing tutorial, before reading the manual.  To run the
784 tutorial, start Emacs and type @kbd{C-h t}.  This way you can learn
785 Emacs by using Emacs on a specially designed file which describes
786 commands, tells you when to try them, and then explains the results you
787 see.
789   On first reading, just skim chapters 1 and 2, which describe the
790 notational conventions of the manual and the general appearance of the
791 Emacs display screen.  Note which questions are answered in these
792 chapters, so you can refer back later.  After reading chapter 4, you
793 should practice the commands there.  The next few chapters describe
794 fundamental techniques and concepts that are used constantly.  You need
795 to understand them thoroughly, experimenting with them if necessary.
797   Chapters 14 through 19 describe intermediate-level features that are
798 useful for all kinds of editing.  Chapter 20 and following chapters
799 describe features that you may or may not want to use; read those
800 chapters when you need them.
802   Read the Trouble chapter if Emacs does not seem to be working
803 properly.  It explains how to cope with some common problems
804 (@pxref{Lossage}), as well as when and how to report Emacs bugs
805 (@pxref{Bugs}).
807   To find the documentation on a particular command, look in the index.
808 Keys (character commands) and command names have separate indexes.  There
809 is also a glossary, with a cross reference for each term.
811   This manual is available as a printed book and also as an Info file.
812 The Info file is for on-line perusal with the Info program, which will
813 be the principal way of viewing documentation on-line in the GNU system.
814 Both the Info file and the Info program itself are distributed along
815 with GNU Emacs.  The Info file and the printed book contain
816 substantially the same text and are generated from the same source
817 files, which are also distributed along with GNU Emacs.
819   GNU Emacs is a member of the Emacs editor family.  There are many Emacs
820 editors, all sharing common principles of organization.  For information on
821 the underlying philosophy of Emacs and the lessons learned from its
822 development, write for a copy of AI memo 519a, ``Emacs, the Extensible,
823 Customizable Self-Documenting Display Editor,'' to Publications Department,
824 Artificial Intelligence Lab, 545 Tech Square, Cambridge, MA 02139, USA@.  At
825 last report they charge $2.25 per copy.  Another useful publication is LCS
826 TM-165, ``A Cookbook for an Emacs,'' by Craig Finseth, available from
827 Publications Department, Laboratory for Computer Science, 545 Tech Square,
828 Cambridge, MA 02139, USA@.  The price today is $3.
830 This edition of the manual is intended for use with GNU Emacs installed
831 on GNU and Unix systems.  GNU Emacs can also be used on VMS, MS-DOS
832 (also called MS-DOG), Windows NT, and Windows 95 systems.  Those systems use
833 different file name syntax; in addition, VMS and MS-DOS do not support
834 all GNU Emacs features.  We don't try to describe VMS usage in this
835 manual.  @xref{MS-DOS}, for information about using Emacs on MS-DOS.
836 @end iftex
838 @node Distrib, Copying, Top, Top
839 @unnumbered Distribution
841 GNU Emacs is @dfn{free software}; this means that everyone is free to
842 use it and free to redistribute it on certain conditions.  GNU Emacs is
843 not in the public domain; it is copyrighted and there are restrictions
844 on its distribution, but these restrictions are designed to permit
845 everything that a good cooperating citizen would want to do.  What is
846 not allowed is to try to prevent others from further sharing any version
847 of GNU Emacs that they might get from you.  The precise conditions are
848 found in the GNU General Public License that comes with Emacs and also
849 appears following this section.
851 One way to get a copy of GNU Emacs is from someone else who has it.  You
852 need not ask for our permission to do so, or tell any one else; just
853 copy it.  If you have access to the Internet, you can get the latest
854 distribution version of GNU Emacs by anonymous FTP; see the file
855 @file{etc/FTP} in the Emacs distribution for more information.
857 You may also receive GNU Emacs when you buy a computer.  Computer
858 manufacturers are free to distribute copies on the same terms that apply to
859 everyone else.  These terms require them to give you the full sources,
860 including whatever changes they may have made, and to permit you to
861 redistribute the GNU Emacs received from them under the usual terms of the
862 General Public License.  In other words, the program must be free for you
863 when you get it, not just free for the manufacturer.
865 You can also order copies of GNU Emacs from the Free Software Foundation
866 on CD-ROM@.  This is a convenient and reliable way to get a copy; it is
867 also a good way to help fund our work.  (The Foundation has always
868 received most of its funds in this way.)  An order form is included in
869 the file @file{etc/ORDERS} in the Emacs distribution, and on our web
870 site in @url{http://www.gnu.org/order/order.html}.  For further
871 information, write to
873 @display
874 Free Software Foundation
875 59 Temple Place, Suite 330
876 Boston, MA  02111-1307 USA
878 @end display
880 The income from distribution fees goes to support the foundation's
881 purpose: the development of new free software, and improvements to our
882 existing programs including GNU Emacs.
884 If you find GNU Emacs useful, please @strong{send a donation} to the
885 Free Software Foundation to support our work.  Donations to the Free
886 Software Foundation are tax deductible in the US.  If you use GNU Emacs
887 at your workplace, please suggest that the company make a donation.  If
888 company policy is unsympathetic to the idea of donating to charity, you
889 might instead suggest ordering a CD-ROM from the Foundation
890 occasionally, or subscribing to periodic updates.
892 @iftex
893 Contributors to GNU Emacs include Per Abrahamsen, Jay K. Adams, Joe
894 Arceneaux, Boaz Ben-Zvi, Jim Blandy, Terrence Brannon, Frank Bresz,
895 Peter Breton, Kevin Broadey, Vincent Broman, David M. Brown, Bill
896 Carpenter, Hans Chalupsky, Bob Chassell, James Clark, Mike Clarkson,
897 Glynn Clements, Andrew Csillag, Doug Cutting, Michael DeCorte, Gary
898 Delp, Matthieu Devin, Eri Ding, Carsten Dominik, Scott Draves, Viktor
899 Dukhovni, John Eaton, Rolf Ebert, Stephen Eglen, Torbj@"orn Einarsson,
900 Tsugumoto Enami, Hans Henrik Eriksen, Michael Ernst, Ata Etemadi,
901 Frederick Farnback, Fred Fish, Karl Fogel, Gary Foster, Noah Friedman,
902 Keith Gabryelski, Kevin Gallagher, Kevin Gallo, Howard Gayle, Stephen
903 Gildea, David Gillespie, Bob Glickstein, Boris Goldowsky, Michelangelo
904 Grigni, Michael Gschwind, Henry Guillaume, Doug Gwyn, Ken'ichi Handa,
905 Chris Hanson, K. Shane Hartman, John Heidemann, Markus Heritsch, Karl
906 Heuer, Manabu Higashida, Anders Holst, Kurt Hornik, Tom Houlder, Lars
907 Ingebrigtsen, Andrew Innes, Michael K. Johnson, Kyle Jones, Tomoji
908 Kagatani, Brewster Kahle, David Kaufman, Henry Kautz, Howard Kaye,
909 Michael Kifer, Richard King, Larry K. Kolodney, Robert Krawitz,
910 Sebastian Kremer, Geoff Kuenning, David K@aa gedal, Daniel LaLiberte,
911 Aaron Larson, James R. Larus, Frederic Lepied, Lars Lindberg, Eric
912 Ludlam, Neil M. Mager, Ken Manheimer, Bill Mann, Brian Marick, Simon
913 Marshall, Bengt Martensson, Charlie Martin, Thomas May, Roland McGrath,
914 David Megginson, Wayne Mesard, Richard Mlynarik, Keith Moore, Erik
915 Naggum, Thomas Neumann, Mike Newton, Jurgen Nickelsen, Jeff Norden,
916 Andrew Norman, Jeff Peck, Damon Anton Permezel, Tom Perrine, Jens
917 Petersen, Daniel Pfeiffer, Fred Pierresteguy, Christian Plaunt,
918 Francesco A. Potorti, Michael D. Prange, Ashwin Ram, Eric S. Raymond,
919 Paul Reilly, Edward M. Reingold, Rob Riepel, Roland B. Roberts, John
920 Robinson, Danny Roozendaal, William Rosenblatt, Guillermo J. Rozas, Ivar
921 Rummelhoff, Wolfgang Rupprecht, James B. Salem, Masahiko Sato, William
922 Schelter, Ralph Schleicher, Gregor Schmid, Michael Schmidt, Ronald
923 S. Schnell, Philippe Schnoebelen, Stephen Schoef, Randal Schwartz,
924 Manuel Serrano, Stanislav Shalunov, Mark Shapiro, Richard Sharman, Olin
925 Shivers, Espen Skoglund, Rick Sladkey, Lynn Slater, Chris Smith, David
926 Smith, Paul D. Smith, William Sommerfeld, Michael Staats, Sam Steingold,
927 Ake Stenhoff, Peter Stephenson, Jonathan Stigelman, Steve Strassman,
928 Jens T. Berger Thielemann, Spencer Thomas, Jim Thompson, Masanobu Umeda,
929 Neil W. Van Dyke, Ulrik Vieth, Geoffrey Voelker, Johan Vromans, Barry
930 Warsaw, Morten Welinder, Joseph Brian Wells, Rodney Whitby, Ed
931 Wilkinson, Mike Williams, Steven A. Wood, Dale R. Worley, Felix
932 S. T. Wu, Tom Wurgler, Eli Zaretskii, Jamie Zawinski, Ian T. Zimmermann,
933 Reto Zimmermann, and Neal Ziring.
934 @end iftex
936 @node Copying, GNU Free Documentation License, Distrib, Top
937 @unnumbered GNU GENERAL PUBLIC LICENSE
938 @center Version 2, June 1991
940 @display
941 Copyright @copyright{} 1989, 1991 Free Software Foundation, Inc.
942 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
944 Everyone is permitted to copy and distribute verbatim copies
945 of this license document, but changing it is not allowed.
946 @end display
948 @unnumberedsec Preamble
950   The licenses for most software are designed to take away your
951 freedom to share and change it.  By contrast, the GNU General Public
952 License is intended to guarantee your freedom to share and change free
953 software---to make sure the software is free for all its users.  This
954 General Public License applies to most of the Free Software
955 Foundation's software and to any other program whose authors commit to
956 using it.  (Some other Free Software Foundation software is covered by
957 the GNU Library General Public License instead.)  You can apply it to
958 your programs, too.
960   When we speak of free software, we are referring to freedom, not
961 price.  Our General Public Licenses are designed to make sure that you
962 have the freedom to distribute copies of free software (and charge for
963 this service if you wish), that you receive source code or can get it
964 if you want it, that you can change the software or use pieces of it
965 in new free programs; and that you know you can do these things.
967   To protect your rights, we need to make restrictions that forbid
968 anyone to deny you these rights or to ask you to surrender the rights.
969 These restrictions translate to certain responsibilities for you if you
970 distribute copies of the software, or if you modify it.
972   For example, if you distribute copies of such a program, whether
973 gratis or for a fee, you must give the recipients all the rights that
974 you have.  You must make sure that they, too, receive or can get the
975 source code.  And you must show them these terms so they know their
976 rights.
978   We protect your rights with two steps: (1) copyright the software, and
979 (2) offer you this license which gives you legal permission to copy,
980 distribute and/or modify the software.
982   Also, for each author's protection and ours, we want to make certain
983 that everyone understands that there is no warranty for this free
984 software.  If the software is modified by someone else and passed on, we
985 want its recipients to know that what they have is not the original, so
986 that any problems introduced by others will not reflect on the original
987 authors' reputations.
989   Finally, any free program is threatened constantly by software
990 patents.  We wish to avoid the danger that redistributors of a free
991 program will individually obtain patent licenses, in effect making the
992 program proprietary.  To prevent this, we have made it clear that any
993 patent must be licensed for everyone's free use or not licensed at all.
995   The precise terms and conditions for copying, distribution and
996 modification follow.
998 @iftex
999 @unnumberedsec TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
1000 @end iftex
1001 @ifinfo
1002 @center TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
1003 @end ifinfo
1005 @enumerate 0
1006 @item
1007 This License applies to any program or other work which contains
1008 a notice placed by the copyright holder saying it may be distributed
1009 under the terms of this General Public License.  The ``Program'', below,
1010 refers to any such program or work, and a ``work based on the Program''
1011 means either the Program or any derivative work under copyright law:
1012 that is to say, a work containing the Program or a portion of it,
1013 either verbatim or with modifications and/or translated into another
1014 language.  (Hereinafter, translation is included without limitation in
1015 the term ``modification''.)  Each licensee is addressed as ``you''.
1017 Activities other than copying, distribution and modification are not
1018 covered by this License; they are outside its scope.  The act of
1019 running the Program is not restricted, and the output from the Program
1020 is covered only if its contents constitute a work based on the
1021 Program (independent of having been made by running the Program).
1022 Whether that is true depends on what the Program does.
1024 @item
1025 You may copy and distribute verbatim copies of the Program's
1026 source code as you receive it, in any medium, provided that you
1027 conspicuously and appropriately publish on each copy an appropriate
1028 copyright notice and disclaimer of warranty; keep intact all the
1029 notices that refer to this License and to the absence of any warranty;
1030 and give any other recipients of the Program a copy of this License
1031 along with the Program.
1033 You may charge a fee for the physical act of transferring a copy, and
1034 you may at your option offer warranty protection in exchange for a fee.
1036 @item
1037 You may modify your copy or copies of the Program or any portion
1038 of it, thus forming a work based on the Program, and copy and
1039 distribute such modifications or work under the terms of Section 1
1040 above, provided that you also meet all of these conditions:
1042 @enumerate a
1043 @item
1044 You must cause the modified files to carry prominent notices
1045 stating that you changed the files and the date of any change.
1047 @item
1048 You must cause any work that you distribute or publish, that in
1049 whole or in part contains or is derived from the Program or any
1050 part thereof, to be licensed as a whole at no charge to all third
1051 parties under the terms of this License.
1053 @item
1054 If the modified program normally reads commands interactively
1055 when run, you must cause it, when started running for such
1056 interactive use in the most ordinary way, to print or display an
1057 announcement including an appropriate copyright notice and a
1058 notice that there is no warranty (or else, saying that you provide
1059 a warranty) and that users may redistribute the program under
1060 these conditions, and telling the user how to view a copy of this
1061 License.  (Exception: if the Program itself is interactive but
1062 does not normally print such an announcement, your work based on
1063 the Program is not required to print an announcement.)
1064 @end enumerate
1066 These requirements apply to the modified work as a whole.  If
1067 identifiable sections of that work are not derived from the Program,
1068 and can be reasonably considered independent and separate works in
1069 themselves, then this License, and its terms, do not apply to those
1070 sections when you distribute them as separate works.  But when you
1071 distribute the same sections as part of a whole which is a work based
1072 on the Program, the distribution of the whole must be on the terms of
1073 this License, whose permissions for other licensees extend to the
1074 entire whole, and thus to each and every part regardless of who wrote it.
1076 Thus, it is not the intent of this section to claim rights or contest
1077 your rights to work written entirely by you; rather, the intent is to
1078 exercise the right to control the distribution of derivative or
1079 collective works based on the Program.
1081 In addition, mere aggregation of another work not based on the Program
1082 with the Program (or with a work based on the Program) on a volume of
1083 a storage or distribution medium does not bring the other work under
1084 the scope of this License.
1086 @item
1087 You may copy and distribute the Program (or a work based on it,
1088 under Section 2) in object code or executable form under the terms of
1089 Sections 1 and 2 above provided that you also do one of the following:
1091 @enumerate a
1092 @item
1093 Accompany it with the complete corresponding machine-readable
1094 source code, which must be distributed under the terms of Sections
1095 1 and 2 above on a medium customarily used for software interchange; or,
1097 @item
1098 Accompany it with a written offer, valid for at least three
1099 years, to give any third party, for a charge no more than your
1100 cost of physically performing source distribution, a complete
1101 machine-readable copy of the corresponding source code, to be
1102 distributed under the terms of Sections 1 and 2 above on a medium
1103 customarily used for software interchange; or,
1105 @item
1106 Accompany it with the information you received as to the offer
1107 to distribute corresponding source code.  (This alternative is
1108 allowed only for noncommercial distribution and only if you
1109 received the program in object code or executable form with such
1110 an offer, in accord with Subsection b above.)
1111 @end enumerate
1113 The source code for a work means the preferred form of the work for
1114 making modifications to it.  For an executable work, complete source
1115 code means all the source code for all modules it contains, plus any
1116 associated interface definition files, plus the scripts used to
1117 control compilation and installation of the executable.  However, as a
1118 special exception, the source code distributed need not include
1119 anything that is normally distributed (in either source or binary
1120 form) with the major components (compiler, kernel, and so on) of the
1121 operating system on which the executable runs, unless that component
1122 itself accompanies the executable.
1124 If distribution of executable or object code is made by offering
1125 access to copy from a designated place, then offering equivalent
1126 access to copy the source code from the same place counts as
1127 distribution of the source code, even though third parties are not
1128 compelled to copy the source along with the object code.
1130 @item
1131 You may not copy, modify, sublicense, or distribute the Program
1132 except as expressly provided under this License.  Any attempt
1133 otherwise to copy, modify, sublicense or distribute the Program is
1134 void, and will automatically terminate your rights under this License.
1135 However, parties who have received copies, or rights, from you under
1136 this License will not have their licenses terminated so long as such
1137 parties remain in full compliance.
1139 @item
1140 You are not required to accept this License, since you have not
1141 signed it.  However, nothing else grants you permission to modify or
1142 distribute the Program or its derivative works.  These actions are
1143 prohibited by law if you do not accept this License.  Therefore, by
1144 modifying or distributing the Program (or any work based on the
1145 Program), you indicate your acceptance of this License to do so, and
1146 all its terms and conditions for copying, distributing or modifying
1147 the Program or works based on it.
1149 @item
1150 Each time you redistribute the Program (or any work based on the
1151 Program), the recipient automatically receives a license from the
1152 original licensor to copy, distribute or modify the Program subject to
1153 these terms and conditions.  You may not impose any further
1154 restrictions on the recipients' exercise of the rights granted herein.
1155 You are not responsible for enforcing compliance by third parties to
1156 this License.
1158 @item
1159 If, as a consequence of a court judgment or allegation of patent
1160 infringement or for any other reason (not limited to patent issues),
1161 conditions are imposed on you (whether by court order, agreement or
1162 otherwise) that contradict the conditions of this License, they do not
1163 excuse you from the conditions of this License.  If you cannot
1164 distribute so as to satisfy simultaneously your obligations under this
1165 License and any other pertinent obligations, then as a consequence you
1166 may not distribute the Program at all.  For example, if a patent
1167 license would not permit royalty-free redistribution of the Program by
1168 all those who receive copies directly or indirectly through you, then
1169 the only way you could satisfy both it and this License would be to
1170 refrain entirely from distribution of the Program.
1172 If any portion of this section is held invalid or unenforceable under
1173 any particular circumstance, the balance of the section is intended to
1174 apply and the section as a whole is intended to apply in other
1175 circumstances.
1177 It is not the purpose of this section to induce you to infringe any
1178 patents or other property right claims or to contest validity of any
1179 such claims; this section has the sole purpose of protecting the
1180 integrity of the free software distribution system, which is
1181 implemented by public license practices.  Many people have made
1182 generous contributions to the wide range of software distributed
1183 through that system in reliance on consistent application of that
1184 system; it is up to the author/donor to decide if he or she is willing
1185 to distribute software through any other system and a licensee cannot
1186 impose that choice.
1188 This section is intended to make thoroughly clear what is believed to
1189 be a consequence of the rest of this License.
1191 @item
1192 If the distribution and/or use of the Program is restricted in
1193 certain countries either by patents or by copyrighted interfaces, the
1194 original copyright holder who places the Program under this License
1195 may add an explicit geographical distribution limitation excluding
1196 those countries, so that distribution is permitted only in or among
1197 countries not thus excluded.  In such case, this License incorporates
1198 the limitation as if written in the body of this License.
1200 @item
1201 The Free Software Foundation may publish revised and/or new versions
1202 of the General Public License from time to time.  Such new versions will
1203 be similar in spirit to the present version, but may differ in detail to
1204 address new problems or concerns.
1206 Each version is given a distinguishing version number.  If the Program
1207 specifies a version number of this License which applies to it and ``any
1208 later version'', you have the option of following the terms and conditions
1209 either of that version or of any later version published by the Free
1210 Software Foundation.  If the Program does not specify a version number of
1211 this License, you may choose any version ever published by the Free Software
1212 Foundation.
1214 @item
1215 If you wish to incorporate parts of the Program into other free
1216 programs whose distribution conditions are different, write to the author
1217 to ask for permission.  For software which is copyrighted by the Free
1218 Software Foundation, write to the Free Software Foundation; we sometimes
1219 make exceptions for this.  Our decision will be guided by the two goals
1220 of preserving the free status of all derivatives of our free software and
1221 of promoting the sharing and reuse of software generally.
1223 @iftex
1224 @heading NO WARRANTY
1225 @end iftex
1226 @ifinfo
1227 @center NO WARRANTY
1228 @end ifinfo
1230 @item
1231 BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
1232 FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW@.  EXCEPT WHEN
1233 OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
1234 PROVIDE THE PROGRAM ``AS IS'' WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
1235 OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
1236 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE@.  THE ENTIRE RISK AS
1237 TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU@.  SHOULD THE
1238 PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
1239 REPAIR OR CORRECTION.
1241 @item
1242 IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
1243 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
1244 REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
1245 INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
1246 OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
1247 TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
1248 YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
1249 PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
1250 POSSIBILITY OF SUCH DAMAGES.
1251 @end enumerate
1253 @iftex
1254 @heading END OF TERMS AND CONDITIONS
1255 @end iftex
1256 @ifinfo
1257 @center END OF TERMS AND CONDITIONS
1258 @end ifinfo
1260 @page
1261 @unnumberedsec How to Apply These Terms to Your New Programs
1263   If you develop a new program, and you want it to be of the greatest
1264 possible use to the public, the best way to achieve this is to make it
1265 free software which everyone can redistribute and change under these terms.
1267   To do so, attach the following notices to the program.  It is safest
1268 to attach them to the start of each source file to most effectively
1269 convey the exclusion of warranty; and each file should have at least
1270 the ``copyright'' line and a pointer to where the full notice is found.
1272 @smallexample
1273 @var{one line to give the program's name and an idea of what it does.}
1274 Copyright (C) 19@var{yy}  @var{name of author}
1276 This program is free software; you can redistribute it and/or
1277 modify it under the terms of the GNU General Public License
1278 as published by the Free Software Foundation; either version 2
1279 of the License, or (at your option) any later version.
1281 This program is distributed in the hope that it will be useful,
1282 but WITHOUT ANY WARRANTY; without even the implied warranty of
1283 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE@.  See the
1284 GNU General Public License for more details.
1286 You should have received a copy of the GNU General Public License along
1287 with this program; if not, write to the Free Software Foundation, Inc.,
1288 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
1289 @end smallexample
1291 Also add information on how to contact you by electronic and paper mail.
1293 If the program is interactive, make it output a short notice like this
1294 when it starts in an interactive mode:
1296 @smallexample
1297 Gnomovision version 69, Copyright (C) 20@var{yy} @var{name of author}
1298 Gnomovision comes with ABSOLUTELY NO WARRANTY; for details
1299 type `show w'.  This is free software, and you are welcome
1300 to redistribute it under certain conditions; type `show c' 
1301 for details.
1302 @end smallexample
1304 The hypothetical commands @samp{show w} and @samp{show c} should show
1305 the appropriate parts of the General Public License.  Of course, the
1306 commands you use may be called something other than @samp{show w} and
1307 @samp{show c}; they could even be mouse-clicks or menu items---whatever
1308 suits your program.
1310 You should also get your employer (if you work as a programmer) or your
1311 school, if any, to sign a ``copyright disclaimer'' for the program, if
1312 necessary.  Here is a sample; alter the names:
1314 @smallexample
1315 @group
1316 Yoyodyne, Inc., hereby disclaims all copyright
1317 interest in the program `Gnomovision'
1318 (which makes passes at compilers) written 
1319 by James Hacker.
1321 @var{signature of Ty Coon}, 1 April 1989
1322 Ty Coon, President of Vice
1323 @end group
1324 @end smallexample
1326 This General Public License does not permit incorporating your program into
1327 proprietary programs.  If your program is a subroutine library, you may
1328 consider it more useful to permit linking proprietary applications with the
1329 library.  If this is what you want to do, use the GNU Library General
1330 Public License instead of this License.
1332 @include doclicense.texi
1334 @node Intro, Glossary, GNU Free Documentation License, Top
1335 @unnumbered Introduction
1337   You are reading about GNU Emacs, the GNU incarnation of the advanced,
1338 self-documenting, customizable, extensible real-time display editor Emacs.
1339 (The `G' in `GNU' is not silent.)
1341   We say that Emacs is a @dfn{display} editor because normally the text
1342 being edited is visible on the screen and is updated automatically as you
1343 type your commands.  @xref{Screen,Display}.
1345   We call it a @dfn{real-time} editor because the display is updated very
1346 frequently, usually after each character or pair of characters you
1347 type.  This minimizes the amount of information you must keep in your
1348 head as you edit.  @xref{Basic,Real-time,Basic Editing}.
1350   We call Emacs advanced because it provides facilities that go beyond
1351 simple insertion and deletion: controlling subprocesses; automatic
1352 indentation of programs; viewing two or more files at once; editing
1353 formatted text; and dealing in terms of characters, words, lines,
1354 sentences, paragraphs, and pages, as well as expressions and comments in
1355 several different programming languages.
1357   @dfn{Self-documenting} means that at any time you can type a special
1358 character, @kbd{Control-h}, to find out what your options are.  You can
1359 also use it to find out what any command does, or to find all the commands
1360 that pertain to a topic.  @xref{Help}.
1362   @dfn{Customizable} means that you can change the definitions of Emacs
1363 commands in little ways.  For example, if you use a programming language in
1364 which comments start with @samp{<**} and end with @samp{**>}, you can tell
1365 the Emacs comment manipulation commands to use those strings
1366 (@pxref{Comments}).  Another sort of customization is rearrangement of the
1367 command set.  For example, if you prefer the four basic cursor motion
1368 commands (up, down, left and right) on keys in a diamond pattern on the
1369 keyboard, you can rebind the keys that way.  @xref{Customization}.
1371   @dfn{Extensible} means that you can go beyond simple customization and
1372 write entirely new commands, programs in the Lisp language to be run by
1373 Emacs's own Lisp interpreter.  Emacs is an ``on-line extensible''
1374 system, which means that it is divided into many functions that call
1375 each other, any of which can be redefined in the middle of an editing
1376 session.  Almost any part of Emacs can be replaced without making a
1377 separate copy of all of Emacs.  Most of the editing commands of Emacs
1378 are written in Lisp already; the few exceptions could have been written
1379 in Lisp but are written in C for efficiency.  Although only a programmer
1380 can write an extension, anybody can use it afterward.  If you want to
1381 learn Emacs Lisp programming, we recommend the @cite{Introduction to
1382 Emacs Lisp} by Robert J. Chassell, also published by the Free Software
1383 Foundation.
1385    When run under the X Window System, Emacs provides its own menus and
1386 convenient bindings to mouse buttons.  But Emacs can provide many of the
1387 benefits of a window system on a text-only terminal.  For instance, you
1388 can look at or edit several files at once, move text between files, and
1389 edit files while running shell commands.
1391 @include screen.texi
1392 @include commands.texi
1393 @include entering.texi
1394 @include basic.texi
1395 @include mini.texi
1396 @include m-x.texi
1397 @include help.texi
1398 @include mark.texi
1399 @include killing.texi
1400 @include regs.texi
1401 @include display.texi
1402 @include search.texi
1403 @include fixit.texi
1404 @include files.texi
1405 @include buffers.texi
1406 @include windows.texi
1407 @include frames.texi
1408 @include mule.texi
1409 @include major.texi
1410 @include indent.texi
1411 @include text.texi
1412 @include programs.texi
1413 @include building.texi
1414 @include abbrevs.texi
1415 @include picture.texi
1416 @include sending.texi
1417 @include rmail.texi
1418 @include dired.texi
1419 @include calendar.texi
1420 @include misc.texi
1421 @include custom.texi
1422 @include trouble.texi
1423 @include cmdargs.texi
1425 @include anti.texi
1426 @include msdog.texi
1427 @include gnu.texi
1428 @include glossary.texi
1429 @ifinfo
1430 @include ack.texi
1431 @end ifinfo
1433 @node Key Index, Command Index, Glossary, Top
1434 @unnumbered Key (Character) Index
1435 @printindex ky
1437 @node Command Index, Variable Index, Key Index, Top
1438 @unnumbered Command and Function Index
1439 @printindex fn
1441 @node Variable Index, Concept Index, Command Index, Top
1442 @unnumbered Variable Index
1443 @printindex vr
1445 @node Concept Index, Acknowledgments, Variable Index, Top
1446 @unnumbered Concept Index
1447 @printindex cp
1449 @summarycontents
1450 @contents
1451 @bye