(vc-mcvs-registered, vc-mcvs-root): Check if file-name-directory returns nil.
[emacs.git] / man / emacs.texi
blobca5ddf039ba151bf56c6da39b85c76b7b46725ba
1 \input texinfo
3 @setfilename ../info/emacs
4 @settitle GNU Emacs Manual
6 @c The edition number appears in several places in this file
7 @set EDITION   Fourteenth
8 @set EMACSVER  21.3.50
10 @copying
11 This is the @value{EDITION} edition of the @cite{GNU Emacs Manual},
12 updated for Emacs version @value{EMACSVER}.
14 Copyright (C) 1985, 1986, 1987, 1993, 1994, 1995, 1996, 1997, 1998,
15 1999, 2000, 2001, 2002 Free Software Foundation, Inc.
17 @quotation
18 Permission is granted to copy, distribute and/or modify this document
19 under the terms of the GNU Free Documentation License, Version 1.1 or
20 any later version published by the Free Software Foundation; with the
21 Invariant Sections being ``The GNU Manifesto'', ``Distribution'' and
22 ``GNU GENERAL PUBLIC LICENSE'', with the Front-Cover texts being ``A GNU
23 Manual,'' and with the Back-Cover Texts as in (a) below.  A copy of the
24 license is included in the section entitled ``GNU Free Documentation
25 License.''
27 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
28 this GNU Manual, like GNU software.  Copies published by the Free
29 Software Foundation raise funds for GNU development.''
30 @end quotation
31 @end copying
33 @dircategory Emacs
34 @direntry
35 * Emacs: (emacs).       The extensible self-documenting text editor.
36 @end direntry
38 @c in general, keep the following line commented out, unless doing a
39 @c copy of this manual that will be published.  the manual should go
40 @c onto the distribution in the full, 8.5 x 11" size.
42 @c @smallbook
44 @setchapternewpage odd
45 @defcodeindex op
46 @synindex pg cp
48 @iftex
49 @kbdinputstyle code
51 @shorttitlepage GNU Emacs Manual
52 @end iftex
54 @titlepage
55 @sp 6
56 @center @titlefont{GNU Emacs Manual}
57 @sp 4
58 @center @value{EDITION} Edition, Updated for Emacs Version @value{EMACSVER}.
59 @sp 5
60 @center Richard Stallman
61 @page
62 @vskip 0pt plus 1filll
63 @insertcopying
65 @sp 2
66 ISBN 1-882114-06-X @*
67 Published by the Free Software Foundation @*
68 59 Temple Place, Suite 330 @*
69 Boston, MA  02111-1307 USA
71 @sp 2
72 Cover art by Etienne Suvasa.
74 @end titlepage
75 @page
76 @ifnottex
77 @node Top, Distrib, (dir), (dir)
78 @top The Emacs Editor
80 Emacs is the extensible, customizable, self-documenting real-time
81 display editor.  This Info file describes how to edit with Emacs and
82 some of how to customize it; it corresponds to GNU Emacs version
83 @value{EMACSVER}.
85 @ifinfo
86 If you never before used the Info documentation system, type @kbd{h},
87 and Emacs will take you to a programmed instruction sequence for the
88 Info commands.
89 @end ifinfo
91 For information on extending Emacs, see @ref{Top, Emacs Lisp,, elisp, The
92 Emacs Lisp Reference Manual}.
93 @end ifnottex
95 @ignore
96 These subcategories have been deleted for simplicity
97 and to avoid conflicts.
98 Completion
99 Backup Files
100 Auto-Saving: Protection Against Disasters
101 Snapshots
102 Text Mode
103 Outline Mode
104 @TeX{} Mode
105 Formatted Text
106 Fortran Mode
107 Fortran Indentation
108 Shell Command History
110 The ones for Dired and Rmail have had the items turned into :: items
111 to avoid conflicts.
112 Also Running Shell Commands from Emacs
113 and Sending Mail and Registers and Minibuffer.
114 @end ignore
116 @menu
117 * Distrib::             How to get the latest Emacs distribution.
118 * Copying::             The GNU General Public License gives you permission
119                           to redistribute GNU Emacs on certain terms;
120                           it also explains that there is no warranty.
121 * GNU Free Documentation License:: The license for this documentation.
122 * Intro::               An introduction to Emacs concepts.
123 * Glossary::            The glossary.
124 * Antinews::            Information about Emacs version 20.
125 * Mac OS::              Using Emacs in the Mac.
126 * MS-DOS::              Using Emacs on MS-DOS (otherwise known as "MS-DOG").
127 * Manifesto::           What's GNU?  Gnu's Not Unix!
128 * Acknowledgments::     Major contributors to GNU Emacs.
130 Indexes (nodes containing large menus)
131 * Key Index::           An item for each standard Emacs key sequence.
132 * Command Index::       An item for each command name.
133 * Variable Index::      An item for each documented variable.
134 * Concept Index::       An item for each concept.
135 @c This is last because @ifnottex leaves an empty line.
136 @ifnottex
137 * Option Index::        An item for every command-line option.
138 @end ifnottex
140 Important General Concepts
141 * Screen::              How to interpret what you see on the screen.
142 * User Input::          Kinds of input events (characters, buttons,
143                           function keys).
144 * Keys::                Key sequences: what you type to request one
145                           editing action.
146 * Commands::            Named functions run by key sequences to do editing.
147 * Text Characters::     Character set for text (the contents of buffers
148                           and strings).
149 * Entering Emacs::      Starting Emacs from the shell.
150 * Exiting::             Stopping or killing Emacs.
151 * Command Arguments::   Hairy startup options.
153 Fundamental Editing Commands
154 * Basic::               The most basic editing commands.
155 * Minibuffer::          Entering arguments that are prompted for.
156 * M-x::                 Invoking commands by their names.
157 * Help::                Commands for asking Emacs about its commands.
159 Important Text-Changing Commands
160 * Mark::                The mark: how to delimit a ``region'' of text.
161 * Killing::             Killing text.
162 * Yanking::             Recovering killed text.  Moving text.
163 * Accumulating Text::   Other ways of copying text.
164 * Rectangles::          Operating on the text inside a rectangle on the screen.
165 * Registers::           Saving a text string or a location in the buffer.
166 * Display::             Controlling what text is displayed.
167 * Search::              Finding or replacing occurrences of a string.
168 * Fixit::               Commands especially useful for fixing typos.
170 Major Structures of Emacs
171 * Files::               All about handling files.
172 * Buffers::             Multiple buffers; editing several files at once.
173 * Windows::             Viewing two pieces of text at once.
174 * Frames::              Running the same Emacs session in multiple X windows.
175 * International::       Using non-ASCII character sets (the MULE features).
177 Advanced Features
178 * Major Modes::         Text mode vs. Lisp mode vs. C mode ...
179 * Indentation::         Editing the white space at the beginnings of lines.
180 * Text::                Commands and modes for editing English.
181 * Programs::            Commands and modes for editing programs.
182 * Building::            Compiling, running and debugging programs.
183 * Maintaining::         Features for maintaining large programs.
184 * Abbrevs::             How to define text abbreviations to reduce
185                           the number of characters you must type.
186 * Picture::             Editing pictures made up of characters
187                           using the quarter-plane screen model.
188 * Sending Mail::        Sending mail in Emacs.
189 * Rmail::               Reading mail in Emacs.
190 * Dired::               You can ``edit'' a directory to manage files in it.
191 * Calendar/Diary::      The calendar and diary facilities.
192 * Gnus::                How to read netnews with Emacs.
193 * Shell::               Executing shell commands from Emacs.
194 * Emacs Server::        Using Emacs as an editing server for @code{mail}, etc.
195 * Hardcopy::            Printing buffers or regions.
196 * PostScript::          Printing buffers or regions as PostScript.
197 * PostScript Variables::
198                         Customizing the PostScript printing commands.
199 * Sorting::             Sorting lines, paragraphs or pages within Emacs.
200 * Narrowing::           Restricting display and editing to a portion
201                           of the buffer.
202 * Two-Column::          Splitting apart columns to edit them
203                           in side-by-side windows.
204 * Editing Binary Files::
205                         Using Hexl mode to edit binary files.
206 * Saving Emacs Sessions::
207                         Saving Emacs state from one session to the next.
208 * Recursive Edit::      A command can allow you to do editing
209                           "within the command".  This is called a
210                           "recursive editing level".
211 * Emulation::           Emulating some other editors with Emacs.
212 * Hyperlinking::        Following links in buffers.
213 * Dissociated Press::   Dissociating text for fun.
214 * Amusements::          Various games and hacks.
215 * Customization::       Modifying the behavior of Emacs.
216 * X Resources::         X resources for customizing 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 Custom::         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-onliness; 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 * Clipboard::           Using the clipboard for selections.
396 * Mouse References::    Using the mouse to select an item from a list.
397 * Menu Mouse Clicks::   Mouse clicks that bring up menus.
398 * Mode Line Mouse::     Mouse clicks on the mode line.
399 * Creating Frames::     Creating additional Emacs frames with various contents.
400 * Frame Commands::      Iconifying, deleting, and switching frames.
401 * Speedbar::            How to make and use a speedbar frame.
402 * Multiple Displays::   How one Emacs job can talk to several displays.
403 * Special Buffer Frames::  You can make certain buffers have their own frames.
404 * Frame Parameters::    Changing the colors and other modes of frames.
405 * Scroll Bars::         How to enable and disable scroll bars; how to use them.
406 * Wheeled Mice::        Using mouse wheels for scrolling.
407 * Menu Bars::           Enabling and disabling the menu bar.
408 * Tool Bars::           Enabling and disabling the tool bar.
409 * Dialog Boxes::        Controlling use of dialog boxes.
410 * Faces::               How to change the display style using faces.
411 * Font Lock::           Minor mode for syntactic highlighting using faces.
412 * Highlight Changes::   Using colors to show where you changed the buffer.
413 * Highlight Interactively:: Tell Emacs what text to highlight.
414 * Useless Whitespace::  Showing possibly-spurious trailing whitespace.
415 * Tooltips::            Showing "tooltips", AKA "ballon help" for active text.
416 * Mouse Avoidance::     Moving the mouse pointer out of the way.
417 * Non-Window Terminals::  Multiple frames on terminals that show only one.
418 * XTerm Mouse::         Using the mouse in an XTerm terminal emulator.
420 International Character Set Support
422 * International Chars::     Basic concepts of multibyte characters.
423 * Enabling Multibyte::      Controlling whether to use multibyte characters.
424 * Language Environments::   Setting things up for the language you use.
425 * Input Methods::           Entering text characters not on your keyboard.
426 * Select Input Method::     Specifying your choice of input methods.
427 * Coding Systems::          Character set conversion when you read and
428                               write files, and so on.
429 * Recognize Coding::        How Emacs figures out which conversion to use.
430 * Specify Coding::          Various ways to choose which conversion to use.
431 * Fontsets::                Fontsets are collections of fonts
432                               that cover the whole spectrum of characters.
433 * Defining Fontsets::       Defining a new fontset.
434 * Single-Byte Character Support::
435                             You can pick one European character set
436                             to use without multibyte characters.
438 Major Modes
440 * Choosing Modes::      How major modes are specified or chosen.
442 Indentation
444 * Indentation Commands::  Various commands and techniques for indentation.
445 * Tab Stops::             You can set arbitrary "tab stops" and then
446                             indent to the next tab stop when you want to.
447 * Just Spaces::           You can request indentation using just spaces.
449 Commands for Human Languages
451 * Words::               Moving over and killing words.
452 * Sentences::           Moving over and killing sentences.
453 * Paragraphs::          Moving over paragraphs.
454 * Pages::               Moving over pages.
455 * Filling::             Filling or justifying text.
456 * Case::                Changing the case of text.
457 * Text Mode::           The major modes for editing text files.
458 * Outline Mode::        Editing outlines.
459 * TeX Mode::            Editing input to the formatter TeX.
460 * Nroff Mode::          Editing input to the formatter nroff.
461 * Formatted Text::      Editing formatted text directly in WYSIWYG fashion.
463 Filling Text
465 * Auto Fill::           Auto Fill mode breaks long lines automatically.
466 * Fill Commands::       Commands to refill paragraphs and center lines.
467 * Fill Prefix::         Filling paragraphs that are indented
468                           or in a comment, etc.
469 * Adaptive Fill::       How Emacs can determine the fill prefix automatically.
471 Editing Programs
473 * Program Modes::       Major modes for editing programs.
474 * Defuns::              Commands to operate on major top-level parts
475                           of a program.
476 * Program Indent::      Adjusting indentation to show the nesting.
477 * Comments::            Inserting, killing, and aligning comments.
478 * Parentheses::         Commands that operate on parentheses.
479 * Documentation::       Getting documentation of functions you plan to call.
480 * Hideshow::            Displaying blocks selectively.
481 * Symbol Completion::   Completion on symbol names of your program or language.
482 * Glasses::             Making identifiersLikeThis more readable.
483 * Misc for Programs::   Other Emacs features useful for editing programs.
484 * C Modes::             Special commands of C, C++, Objective-C,
485                           Java, and Pike modes.
486 * Fortran::             Fortran mode and its special features.
487 * Asm Mode::            Asm mode and its special features.
489 Top-Level Definitions, or Defuns
491 * Left Margin Paren::   An open-paren or similar opening delimiter
492                           starts a defun if it is at the left margin.
493 * Moving by Defuns::    Commands to move over or mark a major definition.
494 * Imenu::               Making buffer indexes as menus.
495 * Which Function::      Which Function mode shows which function you are in.
497 Indentation for Programs
499 * Basic Indent::        Indenting a single line.
500 * Multi-line Indent::   Commands to reindent many lines at once.
501 * Lisp Indent::         Specifying how each Lisp function should be indented.
502 * C Indent::            Extra features for indenting C and related modes.
503 * Custom C Indent::     Controlling indentation style for C and related modes.
505 Commands for Editing with Parentheses
507 * Expressions::         Expressions with balanced parentheses.
508 * Moving by Parens::    Commands for moving up, down and across
509                           in the structure of parentheses.
510 * Matching::            Insertion of a close-delimiter flashes matching open.
512 Manipulating Comments
514 * Comment Commands::    Inserting, killing, and indenting comments.
515 * Multi-Line Comments:: Commands for adding and editing multi-line comments.
516 * Options for Comments::Customizing the comment features.
518 Documentation Lookup
520 * Info Lookup::         Looking up library functions and commands
521                           in Info files.
522 * Man Page::            Looking up man pages of library functions and commands.
523 * Lisp Doc::            Looking up Emacs Lisp functions, etc.
525 C and Related Modes
527 * Motion in C::         Commands to move by C statements, etc.
528 * Electric C::          Colon and other chars can automatically reindent.
529 * Hungry Delete::       A more powerful DEL command.
530 * Other C Commands::    Filling comments, viewing expansion of macros,
531                           and other neat features.
532 * Comments in C::       Options for customizing comment style.
534 Fortran Mode
536 * Motion: Fortran Motion.        Moving point by statements or subprograms.
537 * Indent: Fortran Indent.        Indentation commands for Fortran.
538 * Comments: Fortran Comments.    Inserting and aligning comments.
539 * Autofill: Fortran Autofill.    Auto fill minor mode for Fortran.
540 * Columns: Fortran Columns.      Measuring columns for valid Fortran.
541 * Abbrev: Fortran Abbrev.        Built-in abbrevs for Fortran keywords.
543 Compiling and Testing Programs
545 * Compilation::         Compiling programs in languages other
546                           than Lisp (C, Pascal, etc.).
547 * Compilation Mode::    The mode for visiting compiler errors.
548 * Compilation Shell::   Customizing your shell properly
549                           for use in the compilation buffer.
550 * Debuggers::           Running symbolic debuggers for non-Lisp programs.
551 * Executing Lisp::      Various modes for editing Lisp programs,
552                           with different facilities for running
553                           the Lisp programs.
554 * Lisp Libraries::      Creating Lisp programs to run in Emacs.
555 * Lisp Interaction::    Executing Lisp in an Emacs buffer.
556 * Lisp Eval::           Executing a single Lisp expression in Emacs.
557 * External Lisp::       Communicating through Emacs with a separate Lisp.
559 Running Debuggers Under Emacs
561 * Starting GUD::        How to start a debugger subprocess.
562 * Debugger Operation::  Connection between the debugger and source buffers.
563 * Commands of GUD::     Key bindings for common commands.
564 * GUD Customization::   Defining your own commands for GUD.
566 Maintaining Programs
568 * Change Log::          Maintaining a change history for your program.
569 @ignore
570 * Authors::             Maintaining the Emacs @file{AUTHORS} file.
571 @end ignore
572 * Tags::                Go direct to any function in your program in one
573                           command.  Tags remembers which file it is in.
574 * Emerge::              A convenient way of merging two versions of a program.
576 Tags Tables
578 * Tag Syntax::          Tag syntax for various types of code and text files.
579 * Create Tags Table::   Creating a tags table with @code{etags}.
580 * Select Tags Table::   How to visit a tags table.
581 * Find Tag::            Commands to find the definition of a specific tag.
582 * Tags Search::         Using a tags table for searching and replacing.
583 * List Tags::           Listing and finding tags defined in a file.
585 Merging Files with Emerge
587 * Overview of Emerge::  How to start Emerge.  Basic concepts.
588 * Submodes of Emerge::  Fast mode vs. Edit mode.
589                           Skip Prefers mode and Auto Advance mode.
590 * State of Difference:: You do the merge by specifying state A or B
591                           for each difference.
592 * Merge Commands::      Commands for selecting a difference,
593                           changing states of differences, etc.
594 * Exiting Emerge::      What to do when you've finished the merge.
595 * Combining in Emerge::     How to keep both alternatives for a difference.
596 * Fine Points of Emerge::   Misc.
598 Abbrevs
600 * Abbrev Concepts::     Fundamentals of defined abbrevs.
601 * Defining Abbrevs::    Defining an abbrev, so it will expand when typed.
602 * Expanding Abbrevs::   Controlling expansion: prefixes, canceling expansion.
603 * Editing Abbrevs::     Viewing or editing the entire list of defined abbrevs.
604 * Saving Abbrevs::      Saving the entire list of abbrevs for another session.
605 * Dynamic Abbrevs::     Abbreviations for words already in the buffer.
607 Editing Pictures
609 * Basic Picture::       Basic concepts and simple commands of Picture Mode.
610 * Insert in Picture::   Controlling direction of cursor motion
611                           after "self-inserting" characters.
612 * Tabs in Picture::     Various features for tab stops and indentation.
613 * Rectangles in Picture:: Clearing and superimposing rectangles.
615 Sending Mail
617 * Mail Format::         Format of the mail being composed.
618 * Mail Headers::        Details of permitted mail header fields.
619 * Mail Aliases::        Abbreviating and grouping mail addresses.
620 * Mail Mode::           Special commands for editing mail being composed.
621 * Mail Amusements::     Distract the NSA's attention; add a fortune to a msg.
622 * Mail Methods::        Using alternative mail-composition methods.
624 Reading Mail with Rmail
626 * Rmail Basics::        Basic concepts of Rmail, and simple use.
627 * Rmail Scrolling::     Scrolling through a message.
628 * Rmail Motion::        Moving to another message.
629 * Rmail Deletion::      Deleting and expunging messages.
630 * Rmail Inbox::         How mail gets into the Rmail file.
631 * Rmail Files::         Using multiple Rmail files.
632 * Rmail Output::        Copying message out to files.
633 * Rmail Labels::        Classifying messages by labeling them.
634 * Rmail Attributes::    Certain standard labels, called attributes.
635 * Rmail Reply::         Sending replies to messages you are viewing.
636 * Rmail Summary::       Summaries show brief info on many messages.
637 * Rmail Sorting::       Sorting messages in Rmail.
638 * Rmail Display::       How Rmail displays a message; customization.
639 * Rmail Editing::       Editing message text and headers in Rmail.
640 * Rmail Digest::        Extracting the messages from a digest message.
641 * Out of Rmail::        Converting an Rmail file to mailbox format.
642 * Rmail Rot13::         Reading messages encoded in the rot13 code.
643 * Movemail::            More details of fetching new mail.
645 Dired, the Directory Editor
647 * Dired Enter::              How to invoke Dired.
648 * Dired Navigation::         How to move in the Dired buffer.
649 * Dired Deletion::           Deleting files with Dired.
650 * Flagging Many Files::      Flagging files based on their names.
651 * Dired Visiting::           Other file operations through Dired.
652 * Marks vs Flags::           Flagging for deletion vs marking.
653 * Operating on Files::       How to copy, rename, print, compress, etc.
654                                either one file or several files.
655 * Shell Commands in Dired::  Running a shell command on the marked files.
656 * Transforming File Names::  Using patterns to rename multiple files.
657 * Comparison in Dired::      Running `diff' by way of Dired.
658 * Subdirectories in Dired::  Adding subdirectories to the Dired buffer.
659 * Subdirectory Motion::      Moving across subdirectories, and up and down.
660 * Hiding Subdirectories::    Making subdirectories visible or invisible.
661 * Dired Updating::           Discarding lines for files of no interest.
662 * Dired and Find::           Using `find' to choose the files for Dired.
664 The Calendar and the Diary
666 * Calendar Motion::     Moving through the calendar; selecting a date.
667 * Scroll Calendar::     Bringing earlier or later months onto the screen.
668 * Counting Days::       How many days are there between two dates?
669 * General Calendar::    Exiting or recomputing the calendar.
670 * LaTeX Calendar::        Print a calendar using LaTeX.
671 * Holidays::            Displaying dates of holidays.
672 * Sunrise/Sunset::      Displaying local times of sunrise and sunset.
673 * Lunar Phases::        Displaying phases of the moon.
674 * Other Calendars::     Converting dates to other calendar systems.
675 * Diary::               Displaying events from your diary.
676 * Appointments::        Reminders when it's time to do something.
677 * Daylight Savings::    How to specify when daylight savings time is active.
679 Movement in the Calendar
681 * Calendar Unit Motion::      Moving by days, weeks, months, and years.
682 * Move to Beginning or End::  Moving to start/end of weeks, months, and years.
683 * Specified Dates::           Moving to the current date or another
684                                 specific date.
686 Conversion To and From Other Calendars
688 * Calendar Systems::       The calendars Emacs understands
689                              (aside from Gregorian).
690 * To Other Calendar::      Converting the selected date to various calendars.
691 * From Other Calendar::    Moving to a date specified in another calendar.
692 * Mayan Calendar::         Moving to a date specified in a Mayan calendar.
694 The Diary
696 * Diary Commands::         Viewing diary entries and associated calendar dates.
697 * Format of Diary File::   Entering events in your diary.
698 * Date Formats::           Various ways you can specify dates.
699 * Adding to Diary::        Commands to create diary entries.
700 * Special Diary Entries::  Anniversaries, blocks of dates, cyclic entries, etc.
702 @sc{Gnus}
704 * Buffers of Gnus::     The group, summary, and article buffers.
705 * Gnus Startup::        What you should know about starting Gnus.
706 * Summary of Gnus::     A short description of the basic Gnus commands.
708 Running Shell Commands from Emacs
710 * Single Shell::        How to run one shell command and return.
711 * Interactive Shell::   Permanent shell taking input via Emacs.
712 * Shell Mode::          Special Emacs commands used with permanent shell.
713 * Shell History::       Repeating previous commands in a shell buffer.
714 * Shell Options::       Options for customizing Shell mode.
715 * Remote Host::         Connecting to another computer.
717 Customization
719 * Minor Modes::         Each minor mode is one feature you can turn on
720                           independently of any others.
721 * Variables::           Many Emacs commands examine Emacs variables
722                           to decide what to do; by setting variables,
723                           you can control their functioning.
724 * Keyboard Macros::     A keyboard macro records a sequence of
725                           keystrokes to be replayed with a single command.
726 * Key Bindings::        The keymaps say what command each key runs.
727                           By changing them, you can "redefine keys".
728 * Keyboard Translations::
729                         If your keyboard passes an undesired code
730                            for a key, you can tell Emacs to
731                            substitute another code.
732 * Syntax::              The syntax table controls how words and
733                            expressions are parsed.
734 * Init File::           How to write common customizations in the
735                           @file{.emacs} file.
737 Variables
739 * Examining::           Examining or setting one variable's value.
740 * Easy Customization::
741                         Convenient and easy customization of variables.
742 * Hooks::               Hook variables let you specify programs for parts
743                           of Emacs to run on particular occasions.
744 * Locals::              Per-buffer values of variables.
745 * File Variables::      How files can specify variable values.
747 Keyboard Macros
749 * Basic Kbd Macro::     Defining and running keyboard macros.
750 * Save Kbd Macro::      Giving keyboard macros names; saving them in files.
751 * Kbd Macro Query::     Making keyboard macros do different things each time.
753 Customizing Key Bindings
755 * Keymaps::             Generalities.  The global keymap.
756 * Prefix Keymaps::      Keymaps for prefix keys.
757 * Local Keymaps::       Major and minor modes have their own keymaps.
758 * Minibuffer Maps::     The minibuffer uses its own local keymaps.
759 * Rebinding::           How to redefine one key's meaning conveniently.
760 * Init Rebinding::      Rebinding keys with your init file, @file{.emacs}.
761 * Function Keys::       Rebinding terminal function keys.
762 * Named ASCII Chars::   Distinguishing @key{TAB} from @kbd{C-i}, and so on.
763 * Mouse Buttons::       Rebinding mouse buttons in Emacs.
764 * Disabling::           Disabling a command means confirmation is required
765                           before it can be executed.  This is done to protect
766                           beginners from surprises.
768 The Init File, @file{~/.emacs}
770 * Init Syntax::         Syntax of constants in Emacs Lisp.
771 * Init Examples::       How to do some things with an init file.
772 * Terminal Init::       Each terminal type can have an init file.
773 * Find Init::           How Emacs finds the init file.
775 Dealing with Emacs Trouble
777 * DEL Does Not Delete:: What to do if @key{DEL} doesn't delete.
778 * Stuck Recursive::     `[...]' in mode line around the parentheses.
779 * Screen Garbled::      Garbage on the screen.
780 * Text Garbled::        Garbage in the text.
781 * Unasked-for Search::  Spontaneous entry to incremental search.
782 * Memory Full::         How to cope when you run out of memory.
783 * Emergency Escape::    Emergency escape---
784                           What to do if Emacs stops responding.
785 * Total Frustration::   When you are at your wits' end.
787 Reporting Bugs
789 * Criteria:  Bug Criteria.       Have you really found a bug?
790 * Understanding Bug Reporting::  How to report a bug effectively.
791 * Checklist::                    Steps to follow for a good bug report.
792 * Sending Patches::              How to send a patch for GNU Emacs.
794 Command Line Options and Arguments
796 * Action Arguments::    Arguments to visit files, load libraries,
797                           and call functions.
798 * Initial Options::     Arguments that take effect while starting Emacs.
799 * Command Example::     Examples of using command line arguments.
800 * Resume Arguments::    Specifying arguments when you resume a running Emacs.
801 * Environment::         Environment variables that Emacs uses.
802 * Display X::           Changing the default display and using remote login.
803 * Font X::              Choosing a font for text, under X.
804 * Colors::              Choosing display colors.
805 * Window Size X::       Start-up window size, under X.
806 * Borders X::           Internal and external borders, under X.
807 * Title X::             Specifying the initial frame's title.
808 * Icons X::             Choosing what sort of icon to use, under X.
810 X Resources
812 * Resources::           Using X resources with Emacs (in general).
813 * Table of Resources::  Table of specific X resources that affect Emacs.
814 * Face Resources::      X resources for customizing faces.
815 * Lucid Resources::     X resources for Lucid menus.
816 * LessTif Resources::   X resources for LessTif and Motif menus.
818 Environment Variables
820 * General Variables::   Environment variables that all versions of Emacs use.
821 * Misc Variables::      Certain system specific variables.
823 MS-DOS and Windows 95/98/NT
825 * MS-DOS Input::        Keyboard and mouse usage on MS-DOS.
826 * MS-DOS Display::      Fonts, frames and display size on MS-DOS.
827 * MS-DOS File Names::   File-name conventions on MS-DOS.
828 * Text and Binary::     Text files on MS-DOS use CRLF to separate lines.
829 * MS-DOS Printing::     How to specify the printer on MS-DOS.
830 * MS-DOS Processes::    Running subprocesses on MS-DOS.
831 * Windows Processes::   Running subprocesses on Windows.
832 * Windows System Menu:: Controlling what the ALT key does.
833 @end menu
835 @iftex
836 @unnumbered Preface
838   This manual documents the use and simple customization of the Emacs
839 editor.  The reader is not expected to be a programmer; simple
840 customizations do not require programming skill.  But the user who is not
841 interested in customizing can ignore the scattered customization hints.
843   This is primarily a reference manual, but can also be used as a
844 primer.  For complete beginners, it is a good idea to start with the
845 on-line, learn-by-doing tutorial, before reading the manual.  To run the
846 tutorial, start Emacs and type @kbd{C-h t}.  This way you can learn
847 Emacs by using Emacs on a specially designed file which describes
848 commands, tells you when to try them, and then explains the results you
849 see.
851   On first reading, just skim chapters 1 and 2, which describe the
852 notational conventions of the manual and the general appearance of the
853 Emacs display screen.  Note which questions are answered in these
854 chapters, so you can refer back later.  After reading chapter 4, you
855 should practice the commands there.  The next few chapters describe
856 fundamental techniques and concepts that are used constantly.  You need
857 to understand them thoroughly, experimenting with them if necessary.
859   Chapters 14 through 19 describe intermediate-level features that are
860 useful for all kinds of editing.  Chapter 20 and following chapters
861 describe features that you may or may not want to use; read those
862 chapters when you need them.
864   Read the Trouble chapter if Emacs does not seem to be working
865 properly.  It explains how to cope with some common problems
866 (@pxref{Lossage}), as well as when and how to report Emacs bugs
867 (@pxref{Bugs}).
869   To find the documentation on a particular command, look in the index.
870 Keys (character commands) and command names have separate indexes.  There
871 is also a glossary, with a cross reference for each term.
873   This manual is available as a printed book and also as an Info file.
874 The Info file is for on-line perusal with the Info program, which will
875 be the principal way of viewing documentation on-line in the GNU system.
876 Both the Info file and the Info program itself are distributed along
877 with GNU Emacs.  The Info file and the printed book contain
878 substantially the same text and are generated from the same source
879 files, which are also distributed along with GNU Emacs.
881   GNU Emacs is a member of the Emacs editor family.  There are many Emacs
882 editors, all sharing common principles of organization.  For information on
883 the underlying philosophy of Emacs and the lessons learned from its
884 development, write for a copy of AI memo 519a, ``Emacs, the Extensible,
885 Customizable Self-Documenting Display Editor,'' to Publications Department,
886 Artificial Intelligence Lab, 545 Tech Square, Cambridge, MA 02139, USA@.  At
887 last report they charge $2.25 per copy.  Another useful publication is LCS
888 TM-165, ``A Cookbook for an Emacs,'' by Craig Finseth, available from
889 Publications Department, Laboratory for Computer Science, 545 Tech Square,
890 Cambridge, MA 02139, USA@.  The price today is $3.
892 This edition of the manual is intended for use with GNU Emacs installed
893 on GNU and Unix systems.  GNU Emacs can also be used on VMS, MS-DOS
894 (also called MS-DOG), Windows NT, and Windows 95 systems.  Those systems use
895 different file name syntax; in addition, VMS and MS-DOS do not support
896 all GNU Emacs features.  We don't try to describe VMS usage in this
897 manual.  @xref{MS-DOS}, for information about using Emacs on MS-DOS.
898 @end iftex
900 @node Distrib, Copying, Top, Top
901 @unnumbered Distribution
903 GNU Emacs is @dfn{free software}; this means that everyone is free to
904 use it and free to redistribute it on certain conditions.  GNU Emacs is
905 not in the public domain; it is copyrighted and there are restrictions
906 on its distribution, but these restrictions are designed to permit
907 everything that a good cooperating citizen would want to do.  What is
908 not allowed is to try to prevent others from further sharing any version
909 of GNU Emacs that they might get from you.  The precise conditions are
910 found in the GNU General Public License that comes with Emacs and also
911 appears following this section.
913 One way to get a copy of GNU Emacs is from someone else who has it.  You
914 need not ask for our permission to do so, or tell any one else; just
915 copy it.  If you have access to the Internet, you can get the latest
916 distribution version of GNU Emacs by anonymous FTP; see the file
917 @file{etc/FTP} in the Emacs distribution for more information.
919 You may also receive GNU Emacs when you buy a computer.  Computer
920 manufacturers are free to distribute copies on the same terms that apply to
921 everyone else.  These terms require them to give you the full sources,
922 including whatever changes they may have made, and to permit you to
923 redistribute the GNU Emacs received from them under the usual terms of the
924 General Public License.  In other words, the program must be free for you
925 when you get it, not just free for the manufacturer.
927 You can also order copies of GNU Emacs from the Free Software Foundation
928 on CD-ROM@.  This is a convenient and reliable way to get a copy; it is
929 also a good way to help fund our work.  (The Foundation has always
930 received most of its funds in this way.)  An order form is included in
931 the file @file{etc/ORDERS} in the Emacs distribution, and on our web
932 site in @url{http://www.gnu.org/order/order.html}.  For further
933 information, write to
935 @display
936 Free Software Foundation
937 59 Temple Place, Suite 330
938 Boston, MA  02111-1307 USA
940 @end display
942 The income from distribution fees goes to support the foundation's
943 purpose: the development of new free software, and improvements to our
944 existing programs including GNU Emacs.
946 If you find GNU Emacs useful, please @strong{send a donation} to the
947 Free Software Foundation to support our work.  Donations to the Free
948 Software Foundation are tax deductible in the US.  If you use GNU Emacs
949 at your workplace, please suggest that the company make a donation.  If
950 company policy is unsympathetic to the idea of donating to charity, you
951 might instead suggest ordering a CD-ROM from the Foundation
952 occasionally, or subscribing to periodic updates.
954 @iftex
955 Contributors to GNU Emacs include Per Abrahamsen, Jay K. Adams, Joe
956 Arceneaux, Boaz Ben-Zvi, Jim Blandy, Terrence Brannon, Frank Bresz,
957 Peter Breton, Kevin Broadey, Vincent Broman, David M. Brown, Bill
958 Carpenter, Hans Chalupsky, Bob Chassell, James Clark, Mike Clarkson,
959 Glynn Clements, Andrew Csillag, Doug Cutting, Michael DeCorte, Gary
960 Delp, Matthieu Devin, Eri Ding, Carsten Dominik, Scott Draves, Viktor
961 Dukhovni, John Eaton, Rolf Ebert, Stephen Eglen, Torbj@"orn Einarsson,
962 Tsugutomo Enami, Hans Henrik Eriksen, Michael Ernst, Ata Etemadi,
963 Frederick Farnbach, Fred Fish, Karl Fogel, Gary Foster, Noah Friedman,
964 Keith Gabryelski, Kevin Gallagher, Kevin Gallo, Howard Gayle, Stephen
965 Gildea, David Gillespie, Bob Glickstein, Boris Goldowsky, Michelangelo
966 Grigni, Michael Gschwind, Henry Guillaume, Doug Gwyn, Ken'ichi Handa,
967 Chris Hanson, K. Shane Hartman, John Heidemann, Markus Heritsch, Karl
968 Heuer, Manabu Higashida, Anders Holst, Kurt Hornik, Tom Houlder, Lars
969 Ingebrigtsen, Andrew Innes, Michael K. Johnson, Kyle Jones, Tomoji
970 Kagatani, Brewster Kahle, David Kaufman, Henry Kautz, Howard Kaye,
971 Michael Kifer, Richard King, Larry K. Kolodney, Robert Krawitz,
972 Sebastian Kremer, Geoff Kuenning, David K@aa gedal, Daniel LaLiberte,
973 Aaron Larson, James R. Larus, Frederic Lepied, Lars Lindberg, Eric
974 Ludlam, Neil M. Mager, Ken Manheimer, Bill Mann, Brian Marick, Simon
975 Marshall, Bengt Martensson, Charlie Martin, Thomas May, Roland McGrath,
976 David Megginson, Wayne Mesard, Richard Mlynarik, Keith Moore, Erik
977 Naggum, Thomas Neumann, Mike Newton, Jurgen Nickelsen, Jeff Norden,
978 Andrew Norman, Jeff Peck, Damon Anton Permezel, Tom Perrine, Jens
979 Petersen, Daniel Pfeiffer, Fred Pierresteguy, Christian Plaunt,
980 Francesco A. Potorti, Michael D. Prange, Ashwin Ram, Eric S. Raymond,
981 Paul Reilly, Edward M. Reingold, Rob Riepel, Roland B. Roberts, John
982 Robinson, Danny Roozendaal, William Rosenblatt, Guillermo J. Rozas, Ivar
983 Rummelhoff, Wolfgang Rupprecht, James B. Salem, Masahiko Sato, William
984 Schelter, Ralph Schleicher, Gregor Schmid, Michael Schmidt, Ronald
985 S. Schnell, Philippe Schnoebelen, Stephen Schoef, Randal Schwartz,
986 Manuel Serrano, Stanislav Shalunov, Mark Shapiro, Richard Sharman, Olin
987 Shivers, Espen Skoglund, Rick Sladkey, Lynn Slater, Chris Smith, David
988 Smith, Paul D. Smith, William Sommerfeld, Michael Staats, Sam Steingold,
989 Ake Stenhoff, Peter Stephenson, Jonathan Stigelman, Steve Strassman,
990 Jens T. Berger Thielemann, Spencer Thomas, Jim Thompson, Masanobu Umeda,
991 Neil W. Van Dyke, Ulrik Vieth, Geoffrey Voelker, Johan Vromans, Barry
992 Warsaw, Morten Welinder, Joseph Brian Wells, Rodney Whitby, Ed
993 Wilkinson, Mike Williams, Steven A. Wood, Dale R. Worley, Felix
994 S. T. Wu, Tom Wurgler, Eli Zaretskii, Jamie Zawinski, Ian T. Zimmermann,
995 Reto Zimmermann, and Neal Ziring.
996 @end iftex
998 @node Copying, GNU Free Documentation License, Distrib, Top
999 @unnumbered GNU GENERAL PUBLIC LICENSE
1000 @center Version 2, June 1991
1002 @display
1003 Copyright @copyright{} 1989, 1991 Free Software Foundation, Inc.
1004 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
1006 Everyone is permitted to copy and distribute verbatim copies
1007 of this license document, but changing it is not allowed.
1008 @end display
1010 @unnumberedsec Preamble
1012   The licenses for most software are designed to take away your
1013 freedom to share and change it.  By contrast, the GNU General Public
1014 License is intended to guarantee your freedom to share and change free
1015 software---to make sure the software is free for all its users.  This
1016 General Public License applies to most of the Free Software
1017 Foundation's software and to any other program whose authors commit to
1018 using it.  (Some other Free Software Foundation software is covered by
1019 the GNU Library General Public License instead.)  You can apply it to
1020 your programs, too.
1022   When we speak of free software, we are referring to freedom, not
1023 price.  Our General Public Licenses are designed to make sure that you
1024 have the freedom to distribute copies of free software (and charge for
1025 this service if you wish), that you receive source code or can get it
1026 if you want it, that you can change the software or use pieces of it
1027 in new free programs; and that you know you can do these things.
1029   To protect your rights, we need to make restrictions that forbid
1030 anyone to deny you these rights or to ask you to surrender the rights.
1031 These restrictions translate to certain responsibilities for you if you
1032 distribute copies of the software, or if you modify it.
1034   For example, if you distribute copies of such a program, whether
1035 gratis or for a fee, you must give the recipients all the rights that
1036 you have.  You must make sure that they, too, receive or can get the
1037 source code.  And you must show them these terms so they know their
1038 rights.
1040   We protect your rights with two steps: (1) copyright the software, and
1041 (2) offer you this license which gives you legal permission to copy,
1042 distribute and/or modify the software.
1044   Also, for each author's protection and ours, we want to make certain
1045 that everyone understands that there is no warranty for this free
1046 software.  If the software is modified by someone else and passed on, we
1047 want its recipients to know that what they have is not the original, so
1048 that any problems introduced by others will not reflect on the original
1049 authors' reputations.
1051   Finally, any free program is threatened constantly by software
1052 patents.  We wish to avoid the danger that redistributors of a free
1053 program will individually obtain patent licenses, in effect making the
1054 program proprietary.  To prevent this, we have made it clear that any
1055 patent must be licensed for everyone's free use or not licensed at all.
1057   The precise terms and conditions for copying, distribution and
1058 modification follow.
1060 @iftex
1061 @unnumberedsec TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
1062 @end iftex
1063 @ifinfo
1064 @center TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
1065 @end ifinfo
1067 @enumerate 0
1068 @item
1069 This License applies to any program or other work which contains
1070 a notice placed by the copyright holder saying it may be distributed
1071 under the terms of this General Public License.  The ``Program,'' below,
1072 refers to any such program or work, and a ``work based on the Program''
1073 means either the Program or any derivative work under copyright law:
1074 that is to say, a work containing the Program or a portion of it,
1075 either verbatim or with modifications and/or translated into another
1076 language.  (Hereinafter, translation is included without limitation in
1077 the term ``modification.'')  Each licensee is addressed as ``you.''
1079 Activities other than copying, distribution and modification are not
1080 covered by this License; they are outside its scope.  The act of
1081 running the Program is not restricted, and the output from the Program
1082 is covered only if its contents constitute a work based on the
1083 Program (independent of having been made by running the Program).
1084 Whether that is true depends on what the Program does.
1086 @item
1087 You may copy and distribute verbatim copies of the Program's
1088 source code as you receive it, in any medium, provided that you
1089 conspicuously and appropriately publish on each copy an appropriate
1090 copyright notice and disclaimer of warranty; keep intact all the
1091 notices that refer to this License and to the absence of any warranty;
1092 and give any other recipients of the Program a copy of this License
1093 along with the Program.
1095 You may charge a fee for the physical act of transferring a copy, and
1096 you may at your option offer warranty protection in exchange for a fee.
1098 @item
1099 You may modify your copy or copies of the Program or any portion
1100 of it, thus forming a work based on the Program, and copy and
1101 distribute such modifications or work under the terms of Section 1
1102 above, provided that you also meet all of these conditions:
1104 @enumerate a
1105 @item
1106 You must cause the modified files to carry prominent notices
1107 stating that you changed the files and the date of any change.
1109 @item
1110 You must cause any work that you distribute or publish, that in
1111 whole or in part contains or is derived from the Program or any
1112 part thereof, to be licensed as a whole at no charge to all third
1113 parties under the terms of this License.
1115 @item
1116 If the modified program normally reads commands interactively
1117 when run, you must cause it, when started running for such
1118 interactive use in the most ordinary way, to print or display an
1119 announcement including an appropriate copyright notice and a
1120 notice that there is no warranty (or else, saying that you provide
1121 a warranty) and that users may redistribute the program under
1122 these conditions, and telling the user how to view a copy of this
1123 License.  (Exception: if the Program itself is interactive but
1124 does not normally print such an announcement, your work based on
1125 the Program is not required to print an announcement.)
1126 @end enumerate
1128 These requirements apply to the modified work as a whole.  If
1129 identifiable sections of that work are not derived from the Program,
1130 and can be reasonably considered independent and separate works in
1131 themselves, then this License, and its terms, do not apply to those
1132 sections when you distribute them as separate works.  But when you
1133 distribute the same sections as part of a whole which is a work based
1134 on the Program, the distribution of the whole must be on the terms of
1135 this License, whose permissions for other licensees extend to the
1136 entire whole, and thus to each and every part regardless of who wrote it.
1138 Thus, it is not the intent of this section to claim rights or contest
1139 your rights to work written entirely by you; rather, the intent is to
1140 exercise the right to control the distribution of derivative or
1141 collective works based on the Program.
1143 In addition, mere aggregation of another work not based on the Program
1144 with the Program (or with a work based on the Program) on a volume of
1145 a storage or distribution medium does not bring the other work under
1146 the scope of this License.
1148 @item
1149 You may copy and distribute the Program (or a work based on it,
1150 under Section 2) in object code or executable form under the terms of
1151 Sections 1 and 2 above provided that you also do one of the following:
1153 @enumerate a
1154 @item
1155 Accompany it with the complete corresponding machine-readable
1156 source code, which must be distributed under the terms of Sections
1157 1 and 2 above on a medium customarily used for software interchange; or,
1159 @item
1160 Accompany it with a written offer, valid for at least three
1161 years, to give any third party, for a charge no more than your
1162 cost of physically performing source distribution, a complete
1163 machine-readable copy of the corresponding source code, to be
1164 distributed under the terms of Sections 1 and 2 above on a medium
1165 customarily used for software interchange; or,
1167 @item
1168 Accompany it with the information you received as to the offer
1169 to distribute corresponding source code.  (This alternative is
1170 allowed only for noncommercial distribution and only if you
1171 received the program in object code or executable form with such
1172 an offer, in accord with Subsection b above.)
1173 @end enumerate
1175 The source code for a work means the preferred form of the work for
1176 making modifications to it.  For an executable work, complete source
1177 code means all the source code for all modules it contains, plus any
1178 associated interface definition files, plus the scripts used to
1179 control compilation and installation of the executable.  However, as a
1180 special exception, the source code distributed need not include
1181 anything that is normally distributed (in either source or binary
1182 form) with the major components (compiler, kernel, and so on) of the
1183 operating system on which the executable runs, unless that component
1184 itself accompanies the executable.
1186 If distribution of executable or object code is made by offering
1187 access to copy from a designated place, then offering equivalent
1188 access to copy the source code from the same place counts as
1189 distribution of the source code, even though third parties are not
1190 compelled to copy the source along with the object code.
1192 @item
1193 You may not copy, modify, sublicense, or distribute the Program
1194 except as expressly provided under this License.  Any attempt
1195 otherwise to copy, modify, sublicense or distribute the Program is
1196 void, and will automatically terminate your rights under this License.
1197 However, parties who have received copies, or rights, from you under
1198 this License will not have their licenses terminated so long as such
1199 parties remain in full compliance.
1201 @item
1202 You are not required to accept this License, since you have not
1203 signed it.  However, nothing else grants you permission to modify or
1204 distribute the Program or its derivative works.  These actions are
1205 prohibited by law if you do not accept this License.  Therefore, by
1206 modifying or distributing the Program (or any work based on the
1207 Program), you indicate your acceptance of this License to do so, and
1208 all its terms and conditions for copying, distributing or modifying
1209 the Program or works based on it.
1211 @item
1212 Each time you redistribute the Program (or any work based on the
1213 Program), the recipient automatically receives a license from the
1214 original licensor to copy, distribute or modify the Program subject to
1215 these terms and conditions.  You may not impose any further
1216 restrictions on the recipients' exercise of the rights granted herein.
1217 You are not responsible for enforcing compliance by third parties to
1218 this License.
1220 @item
1221 If, as a consequence of a court judgment or allegation of patent
1222 infringement or for any other reason (not limited to patent issues),
1223 conditions are imposed on you (whether by court order, agreement or
1224 otherwise) that contradict the conditions of this License, they do not
1225 excuse you from the conditions of this License.  If you cannot
1226 distribute so as to satisfy simultaneously your obligations under this
1227 License and any other pertinent obligations, then as a consequence you
1228 may not distribute the Program at all.  For example, if a patent
1229 license would not permit royalty-free redistribution of the Program by
1230 all those who receive copies directly or indirectly through you, then
1231 the only way you could satisfy both it and this License would be to
1232 refrain entirely from distribution of the Program.
1234 If any portion of this section is held invalid or unenforceable under
1235 any particular circumstance, the balance of the section is intended to
1236 apply and the section as a whole is intended to apply in other
1237 circumstances.
1239 It is not the purpose of this section to induce you to infringe any
1240 patents or other property right claims or to contest validity of any
1241 such claims; this section has the sole purpose of protecting the
1242 integrity of the free software distribution system, which is
1243 implemented by public license practices.  Many people have made
1244 generous contributions to the wide range of software distributed
1245 through that system in reliance on consistent application of that
1246 system; it is up to the author/donor to decide if he or she is willing
1247 to distribute software through any other system and a licensee cannot
1248 impose that choice.
1250 This section is intended to make thoroughly clear what is believed to
1251 be a consequence of the rest of this License.
1253 @item
1254 If the distribution and/or use of the Program is restricted in
1255 certain countries either by patents or by copyrighted interfaces, the
1256 original copyright holder who places the Program under this License
1257 may add an explicit geographical distribution limitation excluding
1258 those countries, so that distribution is permitted only in or among
1259 countries not thus excluded.  In such case, this License incorporates
1260 the limitation as if written in the body of this License.
1262 @item
1263 The Free Software Foundation may publish revised and/or new versions
1264 of the General Public License from time to time.  Such new versions will
1265 be similar in spirit to the present version, but may differ in detail to
1266 address new problems or concerns.
1268 Each version is given a distinguishing version number.  If the Program
1269 specifies a version number of this License which applies to it and ``any
1270 later version,'' you have the option of following the terms and conditions
1271 either of that version or of any later version published by the Free
1272 Software Foundation.  If the Program does not specify a version number of
1273 this License, you may choose any version ever published by the Free Software
1274 Foundation.
1276 @item
1277 If you wish to incorporate parts of the Program into other free
1278 programs whose distribution conditions are different, write to the author
1279 to ask for permission.  For software which is copyrighted by the Free
1280 Software Foundation, write to the Free Software Foundation; we sometimes
1281 make exceptions for this.  Our decision will be guided by the two goals
1282 of preserving the free status of all derivatives of our free software and
1283 of promoting the sharing and reuse of software generally.
1285 @iftex
1286 @heading NO WARRANTY
1287 @end iftex
1288 @ifinfo
1289 @center NO WARRANTY
1290 @end ifinfo
1292 @item
1293 BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
1294 FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW@.  EXCEPT WHEN
1295 OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
1296 PROVIDE THE PROGRAM ``AS IS'' WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
1297 OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
1298 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE@.  THE ENTIRE RISK AS
1299 TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU@.  SHOULD THE
1300 PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
1301 REPAIR OR CORRECTION.
1303 @item
1304 IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
1305 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
1306 REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
1307 INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
1308 OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
1309 TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
1310 YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
1311 PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
1312 POSSIBILITY OF SUCH DAMAGES.
1313 @end enumerate
1315 @iftex
1316 @heading END OF TERMS AND CONDITIONS
1317 @end iftex
1318 @ifinfo
1319 @center END OF TERMS AND CONDITIONS
1320 @end ifinfo
1322 @page
1323 @unnumberedsec How to Apply These Terms to Your New Programs
1325   If you develop a new program, and you want it to be of the greatest
1326 possible use to the public, the best way to achieve this is to make it
1327 free software which everyone can redistribute and change under these terms.
1329   To do so, attach the following notices to the program.  It is safest
1330 to attach them to the start of each source file to most effectively
1331 convey the exclusion of warranty; and each file should have at least
1332 the ``copyright'' line and a pointer to where the full notice is found.
1334 @smallexample
1335 @var{one line to give the program's name and an idea of what it does.}
1336 Copyright (C) 19@var{yy}  @var{name of author}
1338 This program is free software; you can redistribute it and/or
1339 modify it under the terms of the GNU General Public License
1340 as published by the Free Software Foundation; either version 2
1341 of the License, or (at your option) any later version.
1343 This program is distributed in the hope that it will be useful,
1344 but WITHOUT ANY WARRANTY; without even the implied warranty of
1345 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE@.  See the
1346 GNU General Public License for more details.
1348 You should have received a copy of the GNU General Public License along
1349 with this program; if not, write to the Free Software Foundation, Inc.,
1350 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
1351 @end smallexample
1353 Also add information on how to contact you by electronic and paper mail.
1355 If the program is interactive, make it output a short notice like this
1356 when it starts in an interactive mode:
1358 @smallexample
1359 Gnomovision version 69, Copyright (C) 20@var{yy} @var{name of author}
1360 Gnomovision comes with ABSOLUTELY NO WARRANTY; for details
1361 type `show w'.  This is free software, and you are welcome
1362 to redistribute it under certain conditions; type `show c'
1363 for details.
1364 @end smallexample
1366 The hypothetical commands @samp{show w} and @samp{show c} should show
1367 the appropriate parts of the General Public License.  Of course, the
1368 commands you use may be called something other than @samp{show w} and
1369 @samp{show c}; they could even be mouse-clicks or menu items---whatever
1370 suits your program.
1372 You should also get your employer (if you work as a programmer) or your
1373 school, if any, to sign a ``copyright disclaimer'' for the program, if
1374 necessary.  Here is a sample; alter the names:
1376 @smallexample
1377 @group
1378 Yoyodyne, Inc., hereby disclaims all copyright
1379 interest in the program `Gnomovision'
1380 (which makes passes at compilers) written
1381 by James Hacker.
1383 @var{signature of Ty Coon}, 1 April 1989
1384 Ty Coon, President of Vice
1385 @end group
1386 @end smallexample
1388 This General Public License does not permit incorporating your program into
1389 proprietary programs.  If your program is a subroutine library, you may
1390 consider it more useful to permit linking proprietary applications with the
1391 library.  If this is what you want to do, use the GNU Library General
1392 Public License instead of this License.
1394 @include doclicense.texi
1396 @node Intro, Glossary, GNU Free Documentation License, Top
1397 @unnumbered Introduction
1399   You are reading about GNU Emacs, the GNU incarnation of the advanced,
1400 self-documenting, customizable, extensible real-time display editor Emacs.
1401 (The `G' in `GNU' is not silent.)
1403   We say that Emacs is a @dfn{display} editor because normally the text
1404 being edited is visible on the screen and is updated automatically as you
1405 type your commands.  @xref{Screen,Display}.
1407   We call it a @dfn{real-time} editor because the display is updated very
1408 frequently, usually after each character or pair of characters you
1409 type.  This minimizes the amount of information you must keep in your
1410 head as you edit.  @xref{Basic,Real-time,Basic Editing}.
1412   We call Emacs advanced because it provides facilities that go beyond
1413 simple insertion and deletion: controlling subprocesses; automatic
1414 indentation of programs; viewing two or more files at once; editing
1415 formatted text; and dealing in terms of characters, words, lines,
1416 sentences, paragraphs, and pages, as well as expressions and comments in
1417 several different programming languages.
1419   @dfn{Self-documenting} means that at any time you can type a special
1420 character, @kbd{Control-h}, to find out what your options are.  You can
1421 also use it to find out what any command does, or to find all the commands
1422 that pertain to a topic.  @xref{Help}.
1424   @dfn{Customizable} means that you can change the definitions of Emacs
1425 commands in little ways.  For example, if you use a programming language in
1426 which comments start with @samp{<**} and end with @samp{**>}, you can tell
1427 the Emacs comment manipulation commands to use those strings
1428 (@pxref{Comments}).  Another sort of customization is rearrangement of the
1429 command set.  For example, if you prefer the four basic cursor motion
1430 commands (up, down, left and right) on keys in a diamond pattern on the
1431 keyboard, you can rebind the keys that way.  @xref{Customization}.
1433   @dfn{Extensible} means that you can go beyond simple customization and
1434 write entirely new commands, programs in the Lisp language to be run by
1435 Emacs's own Lisp interpreter.  Emacs is an ``on-line extensible''
1436 system, which means that it is divided into many functions that call
1437 each other, any of which can be redefined in the middle of an editing
1438 session.  Almost any part of Emacs can be replaced without making a
1439 separate copy of all of Emacs.  Most of the editing commands of Emacs
1440 are written in Lisp; the few exceptions could have been written
1441 in Lisp but are written in C for efficiency.  Although only a programmer
1442 can write an extension, anybody can use it afterward.  If you want to
1443 learn Emacs Lisp programming, we recommend the @cite{Introduction to
1444 Emacs Lisp} by Robert J. Chassell, also published by the Free Software
1445 Foundation.
1447    When run under the X Window System, Emacs provides its own menus and
1448 convenient bindings to mouse buttons.  But Emacs can provide many of the
1449 benefits of a window system on a text-only terminal.  For instance, you
1450 can look at or edit several files at once, move text between files, and
1451 edit files while running shell commands.
1453 @include screen.texi
1454 @include commands.texi
1455 @include entering.texi
1456 @include basic.texi
1457 @include mini.texi
1458 @include m-x.texi
1459 @include help.texi
1460 @include mark.texi
1461 @include killing.texi
1462 @include regs.texi
1463 @include display.texi
1464 @include search.texi
1465 @include fixit.texi
1466 @include files.texi
1467 @include buffers.texi
1468 @include windows.texi
1469 @include frames.texi
1470 @include mule.texi
1471 @include major.texi
1472 @include indent.texi
1473 @include text.texi
1474 @include programs.texi
1475 @include building.texi
1476 @include maintaining.texi
1477 @include abbrevs.texi
1478 @include picture.texi
1479 @include sending.texi
1480 @include rmail.texi
1481 @include dired.texi
1482 @include calendar.texi
1483 @include misc.texi
1484 @include custom.texi
1485 @include trouble.texi
1486 @include cmdargs.texi
1487 @include xresources.texi
1489 @include anti.texi
1490 @include macos.texi
1491 @include msdog.texi
1492 @include gnu.texi
1493 @include glossary.texi
1494 @ifinfo
1495 @include ack.texi
1496 @end ifinfo
1498 @c The Option Index is produced only in the on-line version,
1499 @c because the index entries related to command-line options
1500 @c tend to point to the same pages and all begin with a dash.
1501 @c This, and the need to keep the node links consistent, are
1502 @c the reasons for the funky @iftex/@ifnottex dance below.
1503 @c The Option Index is _not_ before Key Index, because that
1504 @c would require changes in the glossary.texi's @node line.
1505 @c It is not after Concept Index for similar reasons.
1507 @iftex
1508 @node Key Index, Command Index, Glossary, Top
1509 @unnumbered Key (Character) Index
1510 @printindex ky
1511 @end iftex
1513 @ifnottex
1514 @node Key Index, Option Index, Glossary, Top
1515 @unnumbered Key (Character) Index
1516 @printindex ky
1518 @node Option Index, Command Index, Key Index, Top
1519 @unnumbered Command-Line Options Index
1520 @printindex op
1522 @node Command Index, Variable Index, Option Index, Top
1523 @unnumbered Command and Function Index
1524 @printindex fn
1525 @end ifnottex
1527 @iftex
1528 @node Command Index, Variable Index, Key Index, Top
1529 @unnumbered Command and Function Index
1530 @printindex fn
1531 @end iftex
1533 @node Variable Index, Concept Index, Command Index, Top
1534 @unnumbered Variable Index
1535 @printindex vr
1537 @node Concept Index, Acknowledgments, Variable Index, Top
1538 @unnumbered Concept Index
1539 @printindex cp
1541 @summarycontents
1542 @contents
1543 @bye