(enriched-mode): Specify :group.
[emacs.git] / man / emacs.texi
blob0ad3a5148c92a99811732f257d9909aa474f9cee
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  22.0.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, 2004 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 * Emacs Invocation::    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 (cutting) text.
162 * Yanking::             Recovering killed text.  Moving text. (Pasting.)
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.
169 * Keyboard Macros::     A keyboard macro records a sequence of
170                           keystrokes to be replayed with a single command.
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-@acronym{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 * Maintaining::         Features for maintaining large programs.
186 * Abbrevs::             How to define text abbreviations to reduce
187                           the number of characters you must type.
188 * Picture::             Editing pictures made up of characters
189                           using the quarter-plane screen model.
190 * Sending Mail::        Sending mail in Emacs.
191 * Rmail::               Reading mail in Emacs.
192 * Dired::               You can ``edit'' a directory to manage files in it.
193 * Calendar/Diary::      The calendar and diary facilities.
194 * Gnus::                How to read netnews with Emacs.
195 * Shell::               Executing shell commands from Emacs.
196 * Emacs Server::        Using Emacs as an editing server for @code{mail}, etc.
197 * Hardcopy::            Printing buffers or regions.
198 * PostScript::          Printing buffers or regions as PostScript.
199 * PostScript Variables::
200                         Customizing the PostScript printing commands.
201 * Sorting::             Sorting lines, paragraphs or pages within Emacs.
202 * Narrowing::           Restricting display and editing to a portion
203                           of the buffer.
204 * Two-Column::          Splitting apart columns to edit them
205                           in side-by-side windows.
206 * Editing Binary Files::
207                         Using Hexl mode to edit binary files.
208 * Saving Emacs Sessions::
209                         Saving Emacs state from one session to the next.
210 * Recursive Edit::      A command can allow you to do editing
211                           "within the command".  This is called a
212                           "recursive editing level".
213 * Emulation::           Emulating some other editors with Emacs.
214 * Hyperlinking::        Following links in buffers.
215 * Dissociated Press::   Dissociating text for fun.
216 * Amusements::          Various games and hacks.
217 * Customization::       Modifying the behavior of Emacs.
218 * X Resources::         X resources for customizing Emacs.
220 Recovery from Problems
221 * Quitting::            Quitting and aborting.
222 * Lossage::             What to do if Emacs is hung or malfunctioning.
223 * Bugs::                How and when to report a bug.
224 * Contributing::        How to contribute improvements to Emacs.
225 * Service::             How to get help for your own Emacs needs.
228 Detailed Node Listing
229 ---------------------
231 Here are some other nodes which are really inferiors of the ones
232 already listed, mentioned here so you can get to them in one step:
234 The Organization of the Screen
236 * Point::               The place in the text where editing commands operate.
237 * Echo Area::           Short messages appear at the bottom of the screen.
238 * Mode Line::           Interpreting the mode line.
239 * Menu Bar::            How to use the menu bar.
241 Basic Editing Commands
243 * Inserting Text::      Inserting text by simply typing it.
244 * Moving Point::        How to move the cursor to the place where you want to
245                           change something.
246 * Erasing::             Deleting and killing text.
247 * Undo::                Undoing recent changes in the text.
248 * Files: Basic Files.   Visiting, creating, and saving files.
249 * Help: Basic Help.     Asking what a character does.
250 * Blank Lines::         Commands to make or delete blank lines.
251 * Continuation Lines::  Lines too wide for the screen.
252 * Position Info::       What page, line, row, or column is point on?
253 * Arguments::           Numeric arguments for repeating a command.
255 The Minibuffer
257 * Minibuffer File::     Entering file names with the minibuffer.
258 * Minibuffer Edit::     How to edit in the minibuffer.
259 * Completion::          An abbreviation facility for minibuffer input.
260 * Minibuffer History::  Reusing recent minibuffer arguments.
261 * Repetition::          Re-executing commands that used the minibuffer.
263 Help
265 * Help Summary::        Brief list of all Help commands.
266 * Key Help::            Asking what a key does in Emacs.
267 * Name Help::           Asking about a command, variable or function name.
268 * Apropos::             Asking what pertains to a given topic.
269 * Library Keywords::    Finding Lisp libraries by keywords (topics).
270 * Language Help::       Help relating to international language support.
271 * Misc Help::           Other help commands.
273 The Mark and the Region
275 * Setting Mark::        Commands to set the mark.
276 * Transient Mark::      How to make Emacs highlight the region--
277                           when there is one.
278 * Using Region::        Summary of ways to operate on contents of the region.
279 * Marking Objects::     Commands to put region around textual units.
280 * Mark Ring::           Previous mark positions saved so you can go back there.
281 * Global Mark Ring::    Previous mark positions in various buffers.
283 Killing
285 * Deletion::            Commands for deleting small amounts of text and
286                           blank areas.
287 * Killing by Lines::    How to kill entire lines of text at one time.
288 * Other Kill Commands:: Commands to kill large regions of text and
289                           syntactic units such as words and sentences.
290 * Graphical Kill::      The kill ring on graphical terminals:
291                           yanking between applications.
293 Yanking
295 * Kill Ring::           Where killed text is stored.  Basic yanking.
296 * Appending Kills::     Several kills in a row all yank together.
297 * Earlier Kills::       Yanking something killed some time ago.
299 Registers
301 * RegPos::              Saving positions in registers.
302 * RegText::             Saving text in registers.
303 * RegRect::             Saving rectangles in registers.
304 * RegConfig::           Saving window configurations in registers.
305 * RegFiles::            File names in registers.
306 * Bookmarks::           Bookmarks are like registers, but persistent.
308 Controlling the Display
310 * Faces::                  How to change the display style using faces.
311 * Font Lock::              Minor mode for syntactic highlighting using faces.
312 * Highlight Changes::      Using colors to show where you changed the buffer.
313 * Highlight Interactively:: Tell Emacs what text to highlight.
314 * Scrolling::              Moving text up and down in a window.
315 * Horizontal Scrolling::   Moving text left and right in a window.
316 * Fringes::                Enabling or disabling window fringes.
317 * Useless Whitespace::     Showing possibly-spurious trailing whitespace.
318 * Follow Mode::            Follow mode lets two windows scroll as one.
319 * Selective Display::      Hiding lines with lots of indentation.
320 * Optional Mode Line::     Optional mode line display features.
321 * Text Display::           How text characters are normally displayed.
322 * Cursor Display::         Features for displaying the cursor.
323 * Display Custom::         Information on variables for customizing display.
325 Searching and Replacement
327 * Incremental Search::     Search happens as you type the string.
328 * Nonincremental Search::  Specify entire string and then search.
329 * Word Search::            Search for sequence of words.
330 * Regexp Search::          Search for match for a regexp.
331 * Regexps::                Syntax of regular expressions.
332 * Search Case::            To ignore case while searching, or not.
333 * Replace::                Search, and replace some or all matches.
334 * Other Repeating Search:: Operating on all matches for some regexp.
336 Replacement Commands
338 * Unconditional Replace::  Replacing all matches for a string.
339 * Regexp Replace::         Replacing all matches for a regexp.
340 * Replacement and Case::   How replacements preserve case of letters.
341 * Query Replace::          How to use querying.
343 Commands for Fixing Typos
345 * Kill Errors::         Commands to kill a batch of recently entered text.
346 * Transpose::           Exchanging two characters, words, lines, lists...
347 * Fixing Case::         Correcting case of last word entered.
348 * Spelling::            Apply spelling checker to a word or a whole buffer.
350 Keyboard Macros
352 * Basic Keyboard Macro::     Defining and running keyboard macros.
353 * Keyboard Macro Ring::      Where previous keyboard macros are saved.
354 * Keyboard Macro Counter::   Inserting incrementing numbers in macros.
355 * Keyboard Macro Query::     Making keyboard macros do different things each time.
356 * Save Keyboard Macro::      Giving keyboard macros names; saving them in files.
357 * Edit Keyboard Macro::      Editing keyboard macros.
358 * Keyboard Macro Step-Edit::   Interactively executing and editing a keyboard macro.
360 File Handling
362 * File Names::          How to type and edit file-name arguments.
363 * Visiting::            Visiting a file prepares Emacs to edit the file.
364 * Saving::              Saving makes your changes permanent.
365 * Reverting::           Reverting cancels all the changes not saved.
366 * Auto Save::           Auto Save periodically protects against loss of data.
367 * File Aliases::        Handling multiple names for one file.
368 * Version Control::     Version control systems (RCS, CVS and SCCS).
369 * Directories::         Creating, deleting, and listing file directories.
370 * Comparing Files::     Finding where two files differ.
371 * Misc File Ops::       Other things you can do on files.
372 * Compressed Files::    Accessing compressed files.
373 * Remote Files::        Accessing files on other sites.
374 * Quoted File Names::   Quoting special characters in file names.
376 Saving Files
378 * Backup::              How Emacs saves the old version of your file.
379 * Interlocking::        How Emacs protects against simultaneous editing
380                           of one file by two users.
382 Version Control
384 * Introduction to VC::  How version control works in general.
385 * VC Mode Line::     How the mode line shows version control status.
386 * Basic VC Editing::    How to edit a file under version control.
387 * Old Versions::        Examining and comparing old versions.
388 * Secondary VC Commands::    The commands used a little less frequently.
389 * Branches::            Multiple lines of development.
390 * Snapshots::           Sets of file versions treated as a unit.
391 * Miscellaneous VC::    Various other commands and features of VC.
392 * Customizing VC::      Variables that change VC's behavior.
394 Using Multiple Buffers
396 * Select Buffer::       Creating a new buffer or reselecting an old one.
397 * List Buffers::        Getting a list of buffers that exist.
398 * Misc Buffer::         Renaming; changing read-onliness; copying text.
399 * Kill Buffer::         Killing buffers you no longer need.
400 * Several Buffers::     How to go through the list of all buffers
401                           and operate variously on several of them.
402 * Indirect Buffers::    An indirect buffer shares the text of another buffer.
404 Multiple Windows
406 * Basic Window::        Introduction to Emacs windows.
407 * Split Window::        New windows are made by splitting existing windows.
408 * Other Window::        Moving to another window or doing something to it.
409 * Pop Up Window::       Finding a file or buffer in another window.
410 * Force Same Window::   Forcing certain buffers to appear in the selected
411                           window rather than in another window.
412 * Change Window::       Deleting windows and changing their sizes.
414 Frames and X Windows
416 * Mouse Commands::      Moving, cutting, and pasting, with the mouse.
417 * Secondary Selection:: Cutting without altering point and mark.
418 * Clipboard::           Using the clipboard for selections.
419 * Mouse References::    Using the mouse to select an item from a list.
420 * Menu Mouse Clicks::   Mouse clicks that bring up menus.
421 * Mode Line Mouse::     Mouse clicks on the mode line.
422 * Creating Frames::     Creating additional Emacs frames with various contents.
423 * Frame Commands::      Iconifying, deleting, and switching frames.
424 * Speedbar::            How to make and use a speedbar frame.
425 * Multiple Displays::   How one Emacs job can talk to several displays.
426 * Special Buffer Frames::  You can make certain buffers have their own frames.
427 * Frame Parameters::    Changing the colors and other modes of frames.
428 * Scroll Bars::         How to enable and disable scroll bars; how to use them.
429 * Wheeled Mice::        Using mouse wheels for scrolling.
430 * Drag and Drop::       Using drag and drop to open files and insert text.
431 * Menu Bars::           Enabling and disabling the menu bar.
432 * Tool Bars::           Enabling and disabling the tool bar.
433 * Dialog Boxes::        Controlling use of dialog boxes.
434 * Tooltips::            Showing "tooltips", AKA "balloon help" for active text.
435 * Mouse Avoidance::     Moving the mouse pointer out of the way.
436 * Non-Window Terminals::  Multiple frames on terminals that show only one.
437 * XTerm Mouse::         Using the mouse in an XTerm terminal emulator.
439 International Character Set Support
441 * International Chars::     Basic concepts of multibyte characters.
442 * Enabling Multibyte::      Controlling whether to use multibyte characters.
443 * Language Environments::   Setting things up for the language you use.
444 * Input Methods::           Entering text characters not on your keyboard.
445 * Select Input Method::     Specifying your choice of input methods.
446 * Coding Systems::          Character set conversion when you read and
447                               write files, and so on.
448 * Recognize Coding::        How Emacs figures out which conversion to use.
449 * Specify Coding::          Various ways to choose which conversion to use.
450 * Fontsets::                Fontsets are collections of fonts
451                               that cover the whole spectrum of characters.
452 * Defining Fontsets::       Defining a new fontset.
453 * Single-Byte Character Support::
454                             You can pick one European character set
455                             to use without multibyte characters.
457 Major Modes
459 * Choosing Modes::      How major modes are specified or chosen.
461 Indentation
463 * Indentation Commands::  Various commands and techniques for indentation.
464 * Tab Stops::             You can set arbitrary "tab stops" and then
465                             indent to the next tab stop when you want to.
466 * Just Spaces::           You can request indentation using just spaces.
468 Commands for Human Languages
470 * Words::               Moving over and killing words.
471 * Sentences::           Moving over and killing sentences.
472 * Paragraphs::          Moving over paragraphs.
473 * Pages::               Moving over pages.
474 * Filling::             Filling or justifying text.
475 * Case::                Changing the case of text.
476 * Text Mode::           The major modes for editing text files.
477 * Outline Mode::        Editing outlines.
478 * TeX Mode::            Editing input to the formatter TeX.
479 * Nroff Mode::          Editing input to the formatter nroff.
480 * Formatted Text::      Editing formatted text directly in WYSIWYG fashion.
482 Filling Text
484 * Auto Fill::           Auto Fill mode breaks long lines automatically.
485 * Fill Commands::       Commands to refill paragraphs and center lines.
486 * Fill Prefix::         Filling paragraphs that are indented
487                           or in a comment, etc.
488 * Adaptive Fill::       How Emacs can determine the fill prefix automatically.
490 Editing Programs
492 * Program Modes::       Major modes for editing programs.
493 * Defuns::              Commands to operate on major top-level parts
494                           of a program.
495 * Program Indent::      Adjusting indentation to show the nesting.
496 * Comments::            Inserting, killing, and aligning comments.
497 * Parentheses::         Commands that operate on parentheses.
498 * Documentation::       Getting documentation of functions you plan to call.
499 * Hideshow::            Displaying blocks selectively.
500 * Symbol Completion::   Completion on symbol names of your program or language.
501 * Glasses::             Making identifiersLikeThis more readable.
502 * Misc for Programs::   Other Emacs features useful for editing programs.
503 * C Modes::             Special commands of C, C++, Objective-C,
504                           Java, and Pike modes.
505 * Fortran::             Fortran mode and its special features.
506 * Asm Mode::            Asm mode and its special features.
508 Top-Level Definitions, or Defuns
510 * Left Margin Paren::   An open-paren or similar opening delimiter
511                           starts a defun if it is at the left margin.
512 * Moving by Defuns::    Commands to move over or mark a major definition.
513 * Imenu::               Making buffer indexes as menus.
514 * Which Function::      Which Function mode shows which function you are in.
516 Indentation for Programs
518 * Basic Indent::        Indenting a single line.
519 * Multi-line Indent::   Commands to reindent many lines at once.
520 * Lisp Indent::         Specifying how each Lisp function should be indented.
521 * C Indent::            Extra features for indenting C and related modes.
522 * Custom C Indent::     Controlling indentation style for C and related modes.
524 Commands for Editing with Parentheses
526 * Expressions::         Expressions with balanced parentheses.
527 * Moving by Parens::    Commands for moving up, down and across
528                           in the structure of parentheses.
529 * Matching::            Insertion of a close-delimiter flashes matching open.
531 Manipulating Comments
533 * Comment Commands::    Inserting, killing, and indenting comments.
534 * Multi-Line Comments:: Commands for adding and editing multi-line comments.
535 * Options for Comments::Customizing the comment features.
537 Documentation Lookup
539 * Info Lookup::         Looking up library functions and commands
540                           in Info files.
541 * Man Page::            Looking up man pages of library functions and commands.
542 * Lisp Doc::            Looking up Emacs Lisp functions, etc.
544 C and Related Modes
546 * Motion in C::         Commands to move by C statements, etc.
547 * Electric C::          Colon and other chars can automatically reindent.
548 * Hungry Delete::       A more powerful DEL command.
549 * Other C Commands::    Filling comments, viewing expansion of macros,
550                           and other neat features.
552 Fortran Mode
554 * Motion: Fortran Motion.        Moving point by statements or subprograms.
555 * Indent: Fortran Indent.        Indentation commands for Fortran.
556 * Comments: Fortran Comments.    Inserting and aligning comments.
557 * Autofill: Fortran Autofill.    Auto fill minor mode for Fortran.
558 * Columns: Fortran Columns.      Measuring columns for valid Fortran.
559 * Abbrev: Fortran Abbrev.        Built-in abbrevs for Fortran keywords.
561 Compiling and Testing Programs
563 * Compilation::         Compiling programs in languages other
564                           than Lisp (C, Pascal, etc.).
565 * Compilation Mode::    The mode for visiting compiler errors.
566 * Compilation Shell::   Customizing your shell properly
567                           for use in the compilation buffer.
568 * Grep Searching::      Searching with grep.
569 * Flymake::             Finding syntax errors on the fly.
570 * Debuggers::           Running symbolic debuggers for non-Lisp programs.
571 * Executing Lisp::      Various modes for editing Lisp programs,
572                           with different facilities for running
573                           the Lisp programs.
574 * Lisp Libraries::      Creating Lisp programs to run in Emacs.
575 * Lisp Interaction::    Executing Lisp in an Emacs buffer.
576 * Lisp Eval::           Executing a single Lisp expression in Emacs.
577 * External Lisp::       Communicating through Emacs with a separate Lisp.
579 Running Debuggers Under Emacs
581 * Starting GUD::        How to start a debugger subprocess.
582 * Debugger Operation::  Connection between the debugger and source buffers.
583 * Commands of GUD::     Key bindings for common commands.
584 * GUD Customization::   Defining your own commands for GUD.
586 Maintaining Programs
588 * Change Log::          Maintaining a change history for your program.
589 @ignore
590 * Authors::             Maintaining the Emacs @file{AUTHORS} file.
591 @end ignore
592 * Tags::                Go direct to any function in your program in one
593                           command.  Tags remembers which file it is in.
594 * Emerge::              A convenient way of merging two versions of a program.
596 Tags Tables
598 * Tag Syntax::          Tag syntax for various types of code and text files.
599 * Create Tags Table::   Creating a tags table with @code{etags}.
600 * Select Tags Table::   How to visit a tags table.
601 * Find Tag::            Commands to find the definition of a specific tag.
602 * Tags Search::         Using a tags table for searching and replacing.
603 * List Tags::           Listing and finding tags defined in a file.
605 Merging Files with Emerge
607 * Overview of Emerge::  How to start Emerge.  Basic concepts.
608 * Submodes of Emerge::  Fast mode vs. Edit mode.
609                           Skip Prefers mode and Auto Advance mode.
610 * State of Difference:: You do the merge by specifying state A or B
611                           for each difference.
612 * Merge Commands::      Commands for selecting a difference,
613                           changing states of differences, etc.
614 * Exiting Emerge::      What to do when you've finished the merge.
615 * Combining in Emerge::     How to keep both alternatives for a difference.
616 * Fine Points of Emerge::   Misc.
618 Abbrevs
620 * Abbrev Concepts::     Fundamentals of defined abbrevs.
621 * Defining Abbrevs::    Defining an abbrev, so it will expand when typed.
622 * Expanding Abbrevs::   Controlling expansion: prefixes, canceling expansion.
623 * Editing Abbrevs::     Viewing or editing the entire list of defined abbrevs.
624 * Saving Abbrevs::      Saving the entire list of abbrevs for another session.
625 * Dynamic Abbrevs::     Abbreviations for words already in the buffer.
627 Editing Pictures
629 * Basic Picture::       Basic concepts and simple commands of Picture Mode.
630 * Insert in Picture::   Controlling direction of cursor motion
631                           after "self-inserting" characters.
632 * Tabs in Picture::     Various features for tab stops and indentation.
633 * Rectangles in Picture:: Clearing and superimposing rectangles.
635 Sending Mail
637 * Mail Format::         Format of the mail being composed.
638 * Mail Headers::        Details of permitted mail header fields.
639 * Mail Aliases::        Abbreviating and grouping mail addresses.
640 * Mail Mode::           Special commands for editing mail being composed.
641 * Mail Amusements::     Distract the NSA's attention; add a fortune to a msg.
642 * Mail Methods::        Using alternative mail-composition methods.
644 Reading Mail with Rmail
646 * Rmail Basics::        Basic concepts of Rmail, and simple use.
647 * Rmail Scrolling::     Scrolling through a message.
648 * Rmail Motion::        Moving to another message.
649 * Rmail Deletion::      Deleting and expunging messages.
650 * Rmail Inbox::         How mail gets into the Rmail file.
651 * Rmail Files::         Using multiple Rmail files.
652 * Rmail Output::        Copying message out to files.
653 * Rmail Labels::        Classifying messages by labeling them.
654 * Rmail Attributes::    Certain standard labels, called attributes.
655 * Rmail Reply::         Sending replies to messages you are viewing.
656 * Rmail Summary::       Summaries show brief info on many messages.
657 * Rmail Sorting::       Sorting messages in Rmail.
658 * Rmail Display::       How Rmail displays a message; customization.
659 * Rmail Editing::       Editing message text and headers in Rmail.
660 * Rmail Digest::        Extracting the messages from a digest message.
661 * Out of Rmail::        Converting an Rmail file to mailbox format.
662 * Rmail Rot13::         Reading messages encoded in the rot13 code.
663 * Movemail::            More details of fetching new mail.
665 Dired, the Directory Editor
667 * Dired Enter::              How to invoke Dired.
668 * Dired Navigation::         How to move in the Dired buffer.
669 * Dired Deletion::           Deleting files with Dired.
670 * Flagging Many Files::      Flagging files based on their names.
671 * Dired Visiting::           Other file operations through Dired.
672 * Marks vs Flags::           Flagging for deletion vs marking.
673 * Operating on Files::       How to copy, rename, print, compress, etc.
674                                either one file or several files.
675 * Shell Commands in Dired::  Running a shell command on the marked files.
676 * Transforming File Names::  Using patterns to rename multiple files.
677 * Comparison in Dired::      Running `diff' by way of Dired.
678 * Subdirectories in Dired::  Adding subdirectories to the Dired buffer.
679 * Subdirectory Motion::      Moving across subdirectories, and up and down.
680 * Hiding Subdirectories::    Making subdirectories visible or invisible.
681 * Dired Updating::           Discarding lines for files of no interest.
682 * Dired and Find::           Using `find' to choose the files for Dired.
683 * Dired and Find::           Using `find' to choose the files for Dired.
684 * Wdired::                   Operating on files by editing the Dired buffer.
685 * Misc Dired Features::      Various other features.
687 The Calendar and the Diary
689 * Calendar Motion::     Moving through the calendar; selecting a date.
690 * Scroll Calendar::     Bringing earlier or later months onto the screen.
691 * Counting Days::       How many days are there between two dates?
692 * General Calendar::    Exiting or recomputing the calendar.
693 * LaTeX Calendar::        Print a calendar using LaTeX.
694 * Holidays::            Displaying dates of holidays.
695 * Sunrise/Sunset::      Displaying local times of sunrise and sunset.
696 * Lunar Phases::        Displaying phases of the moon.
697 * Other Calendars::     Converting dates to other calendar systems.
698 * Diary::               Displaying events from your diary.
699 * Appointments::        Reminders when it's time to do something.
700 * Daylight Savings::    How to specify when daylight savings time is active.
702 Movement in the Calendar
704 * Calendar Unit Motion::      Moving by days, weeks, months, and years.
705 * Move to Beginning or End::  Moving to start/end of weeks, months, and years.
706 * Specified Dates::           Moving to the current date or another
707                                 specific date.
709 Conversion To and From Other Calendars
711 * Calendar Systems::       The calendars Emacs understands
712                              (aside from Gregorian).
713 * To Other Calendar::      Converting the selected date to various calendars.
714 * From Other Calendar::    Moving to a date specified in another calendar.
715 * Mayan Calendar::         Moving to a date specified in a Mayan calendar.
717 The Diary
719 * Displaying the Diary::   Viewing diary entries and associated calendar dates.
720 * Format of Diary File::   Entering events in your diary.
721 * Date Formats::           Various ways you can specify dates.
722 * Adding to Diary::        Commands to create diary entries.
723 * Special Diary Entries::  Anniversaries, blocks of dates, cyclic entries, etc.
725 Gnus
727 * Buffers of Gnus::     The group, summary, and article buffers.
728 * Gnus Startup::        What you should know about starting Gnus.
729 * Summary of Gnus::     A short description of the basic Gnus commands.
731 Running Shell Commands from Emacs
733 * Single Shell::        How to run one shell command and return.
734 * Interactive Shell::   Permanent shell taking input via Emacs.
735 * Shell Mode::          Special Emacs commands used with permanent shell.
736 * Shell History::       Repeating previous commands in a shell buffer.
737 * Shell Options::       Options for customizing Shell mode.
738 * Remote Host::         Connecting to another computer.
740 Customization
742 * Minor Modes::         Each minor mode is one feature you can turn on
743                           independently of any others.
744 * Easy Customization::
745                         Convenient way to browse and change user options.
746 * Variables::           Many Emacs commands examine Emacs variables
747                           to decide what to do; by setting variables,
748                           you can control their functioning.
749 * Key Bindings::        The keymaps say what command each key runs.
750                           By changing them, you can "redefine keys".
751 * Keyboard Translations::
752                         If your keyboard passes an undesired code
753                            for a key, you can tell Emacs to
754                            substitute another code.
755 * Syntax::              The syntax table controls how words and
756                            expressions are parsed.
757 * Init File::           How to write common customizations in the
758                           @file{.emacs} file.
760 Variables
762 * Examining::           Examining or setting one variable's value.
763 * Hooks::               Hook variables let you specify programs for parts
764                           of Emacs to run on particular occasions.
765 * Locals::              Per-buffer values of variables.
766 * File Variables::      How files can specify variable values.
768 Customizing Key Bindings
770 * Keymaps::             Generalities.  The global keymap.
771 * Prefix Keymaps::      Keymaps for prefix keys.
772 * Local Keymaps::       Major and minor modes have their own keymaps.
773 * Minibuffer Maps::     The minibuffer uses its own local keymaps.
774 * Rebinding::           How to redefine one key's meaning conveniently.
775 * Init Rebinding::      Rebinding keys with your init file, @file{.emacs}.
776 * Function Keys::       Rebinding terminal function keys.
777 * Named ASCII Chars::   Distinguishing @key{TAB} from @kbd{C-i}, and so on.
778 * Mouse Buttons::       Rebinding mouse buttons in Emacs.
779 * Disabling::           Disabling a command means confirmation is required
780                           before it can be executed.  This is done to protect
781                           beginners from surprises.
783 The Init File, @file{~/.emacs}
785 * Init Syntax::         Syntax of constants in Emacs Lisp.
786 * Init Examples::       How to do some things with an init file.
787 * Terminal Init::       Each terminal type can have an init file.
788 * Find Init::           How Emacs finds the init file.
790 Dealing with Emacs Trouble
792 * DEL Does Not Delete:: What to do if @key{DEL} doesn't delete.
793 * Stuck Recursive::     `[...]' in mode line around the parentheses.
794 * Screen Garbled::      Garbage on the screen.
795 * Text Garbled::        Garbage in the text.
796 * Unasked-for Search::  Spontaneous entry to incremental search.
797 * Memory Full::         How to cope when you run out of memory.
798 * Emergency Escape::    Emergency escape---
799                           What to do if Emacs stops responding.
800 * Total Frustration::   When you are at your wits' end.
802 Reporting Bugs
804 * Criteria:  Bug Criteria.       Have you really found a bug?
805 * Understanding Bug Reporting::  How to report a bug effectively.
806 * Checklist::                    Steps to follow for a good bug report.
807 * Sending Patches::              How to send a patch for GNU Emacs.
809 Command Line Options and Arguments
811 * Action Arguments::    Arguments to visit files, load libraries,
812                           and call functions.
813 * Initial Options::     Arguments that take effect while starting Emacs.
814 * Command Example::     Examples of using command line arguments.
815 * Resume Arguments::    Specifying arguments when you resume a running Emacs.
816 * Environment::         Environment variables that Emacs uses.
817 * Display X::           Changing the default display and using remote login.
818 * Font X::              Choosing a font for text, under X.
819 * Colors::              Choosing display colors.
820 * Window Size X::       Start-up window size, under X.
821 * Borders X::           Internal and external borders, under X.
822 * Title X::             Specifying the initial frame's title.
823 * Icons X::             Choosing what sort of icon to use, under X.
824 * Misc X::              Other display options.
826 X Resources
828 * Resources::           Using X resources with Emacs (in general).
829 * Table of Resources::  Table of specific X resources that affect Emacs.
830 * Face Resources::      X resources for customizing faces.
831 * Lucid Resources::     X resources for Lucid menus.
832 * LessTif Resources::   X resources for LessTif and Motif menus.
834 Environment Variables
836 * General Variables::   Environment variables that all versions of Emacs use.
837 * Misc Variables::      Certain system specific variables.
839 MS-DOS and Windows 95/98/NT
841 * MS-DOS Keyboard::     Keyboard usage on MS-DOS.
842 * MS-DOS Mouse::        Mouse usage on MS-DOS.
843 * MS-DOS Display::      Fonts, frames and display size on MS-DOS.
844 * MS-DOS File Names::   File-name conventions on MS-DOS.
845 * Text and Binary::     Text files on MS-DOS use CRLF to separate lines.
846 * MS-DOS Printing::     How to specify the printer on MS-DOS.
847 * MS-DOS Processes::    Running subprocesses on MS-DOS.
848 * Windows Processes::   Running subprocesses on Windows.
849 * Windows System Menu:: Controlling what the ALT key does.
850 @end menu
852 @iftex
853 @unnumbered Preface
855   This manual documents the use and simple customization of the Emacs
856 editor.  The reader is not expected to be a programmer; simple
857 customizations do not require programming skill.  But the user who is not
858 interested in customizing can ignore the scattered customization hints.
860   This is primarily a reference manual, but can also be used as a
861 primer.  For complete beginners, it is a good idea to start with the
862 on-line, learn-by-doing tutorial, before reading the manual.  To run the
863 tutorial, start Emacs and type @kbd{C-h t}.  This way you can learn
864 Emacs by using Emacs on a specially designed file which describes
865 commands, tells you when to try them, and then explains the results you
866 see.
868   On first reading, just skim chapters 1 and 2, which describe the
869 notational conventions of the manual and the general appearance of the
870 Emacs display screen.  Note which questions are answered in these
871 chapters, so you can refer back later.  After reading chapter 4, you
872 should practice the commands there.  The next few chapters describe
873 fundamental techniques and concepts that are used constantly.  You need
874 to understand them thoroughly, experimenting with them if necessary.
876   Chapters 14 through 19 describe intermediate-level features that are
877 useful for all kinds of editing.  Chapter 20 and following chapters
878 describe features that you may or may not want to use; read those
879 chapters when you need them.
881   Read the Trouble chapter if Emacs does not seem to be working
882 properly.  It explains how to cope with some common problems
883 (@pxref{Lossage}), as well as when and how to report Emacs bugs
884 (@pxref{Bugs}).
886   To find the documentation on a particular command, look in the index.
887 Keys (character commands) and command names have separate indexes.  There
888 is also a glossary, with a cross reference for each term.
890   This manual is available as a printed book and also as an Info file.
891 The Info file is for on-line perusal with the Info program, which will
892 be the principal way of viewing documentation on-line in the GNU system.
893 Both the Info file and the Info program itself are distributed along
894 with GNU Emacs.  The Info file and the printed book contain
895 substantially the same text and are generated from the same source
896 files, which are also distributed along with GNU Emacs.
898   GNU Emacs is a member of the Emacs editor family.  There are many Emacs
899 editors, all sharing common principles of organization.  For information on
900 the underlying philosophy of Emacs and the lessons learned from its
901 development, write for a copy of AI memo 519a, ``Emacs, the Extensible,
902 Customizable Self-Documenting Display Editor,'' to Publications Department,
903 Artificial Intelligence Lab, 545 Tech Square, Cambridge, MA 02139, USA@.  At
904 last report they charge $2.25 per copy.  Another useful publication is LCS
905 TM-165, ``A Cookbook for an Emacs,'' by Craig Finseth, available from
906 Publications Department, Laboratory for Computer Science, 545 Tech Square,
907 Cambridge, MA 02139, USA@.  The price today is $3.
909 This edition of the manual is intended for use with GNU Emacs installed
910 on GNU and Unix systems.  GNU Emacs can also be used on VMS, MS-DOS
911 (also called MS-DOG), Windows NT, and Windows 95 systems.  Those systems use
912 different file name syntax; in addition, VMS and MS-DOS do not support
913 all GNU Emacs features.  We don't try to describe VMS usage in this
914 manual.  @xref{MS-DOS}, for information about using Emacs on MS-DOS.
915 @end iftex
917 @node Distrib, Intro, Top, Top
918 @unnumbered Distribution
920 GNU Emacs is @dfn{free software}; this means that everyone is free to
921 use it and free to redistribute it on certain conditions.  GNU Emacs is
922 not in the public domain; it is copyrighted and there are restrictions
923 on its distribution, but these restrictions are designed to permit
924 everything that a good cooperating citizen would want to do.  What is
925 not allowed is to try to prevent others from further sharing any version
926 of GNU Emacs that they might get from you.  The precise conditions are
927 found in the GNU General Public License that comes with Emacs and also
928 appears following this section.
930 One way to get a copy of GNU Emacs is from someone else who has it.  You
931 need not ask for our permission to do so, or tell any one else; just
932 copy it.  If you have access to the Internet, you can get the latest
933 distribution version of GNU Emacs by anonymous FTP; see the file
934 @file{etc/FTP} in the Emacs distribution for more information.
936 You may also receive GNU Emacs when you buy a computer.  Computer
937 manufacturers are free to distribute copies on the same terms that apply to
938 everyone else.  These terms require them to give you the full sources,
939 including whatever changes they may have made, and to permit you to
940 redistribute the GNU Emacs received from them under the usual terms of the
941 General Public License.  In other words, the program must be free for you
942 when you get it, not just free for the manufacturer.
944 You can also order copies of GNU Emacs from the Free Software
945 Foundation.  This is a convenient and reliable way to get a copy; it
946 is also a good way to help fund our work.  (The Foundation has always
947 received most of its funds in this way.)  An order form is included in
948 the file @file{etc/ORDERS} in the Emacs distribution, and on our web
949 site in @url{http://www.gnu.org/order/order.html}.  For further
950 information, write to
952 @display
953 Free Software Foundation
954 59 Temple Place, Suite 330
955 Boston, MA  02111-1307 USA
957 @end display
959 The income from distribution fees goes to support the foundation's
960 purpose: the development of new free software, and improvements to our
961 existing programs including GNU Emacs.
963 If you find GNU Emacs useful, please @strong{send a donation} to the
964 Free Software Foundation to support our work.  Donations to the Free
965 Software Foundation are tax deductible in the US.  If you use GNU Emacs
966 at your workplace, please suggest that the company make a donation.  If
967 company policy is unsympathetic to the idea of donating to charity, you
968 might instead suggest ordering a CD-ROM from the Foundation
969 occasionally, or subscribing to periodic updates.
971 @iftex
972 @node Acknowledgments, Intro, Distrib, Top
973 @unnumberedsec Acknowledgments
975 Contributors to GNU Emacs include Per Abrahamsen, Tomas Abrahamsson,
976 Jay K.@: Adams, Joe Arceneaux, Miles Bader, David Bakhash, Eli
977 Barzilay, Steven L.@: Baur, Boaz Ben-Zvi, Ray Blaak, Jim Blandy, Per
978 Bothner, Terrence Brannon, Frank Bresz, Peter Breton, Emmanuel Briot,
979 Kevin Broadey, Vincent Broman, David M.@: Brown, Georges Brun-Cottan,
980 W@l{}odek Bzyl, Bill Carpenter, Per Cederqvist, Hans Chalupsky, Chris
981 Chase, Bob Chassell, Andrew Choi, James Clark, Mike Clarkson, Glynn
982 Clements, Andrew Csillag, Doug Cutting, Michael DeCorte, Gary Delp,
983 Matthieu Devin, Eri Ding, Jan Dj@"{a}rv, Carsten Dominik, Scott
984 Draves, Benjamin Drieu, Viktor Dukhovni, John Eaton, Rolf Ebert,
985 Stephen Eglen, Torbj@"orn Einarsson, Tsugutomo Enami, Hans Henrik
986 Eriksen, Michael Ernst, Ata Etemadi, Frederick Farnbach, Oscar
987 Figueiredo, Fred Fish, Karl Fogel, Gary Foster, Noah Friedman,
988 Hallvard Furuseth, Keith Gabryelski, Kevin Gallagher, Kevin Gallo,
989 Juan Le@'{o}n Lahoz Garc@'{i}a, Howard Gayle, Stephen Gildea, Julien
990 Gilles, David Gillespie, Bob Glickstein, Boris Goldowsky, Michelangelo
991 Grigni, Odd Gripenstam, Kai Gro@ss{}johann, Michael Gschwind, Henry
992 Guillaume, Doug Gwyn, Ken'ichi Handa, Chris Hanson, K. Shane Hartman,
993 John Heidemann, Jon K.@: Hellan, Markus Heritsch, Karl Heuer, Manabu
994 Higashida, Anders Holst, Kurt Hornik, Tom Houlder, Denis Howe, Lars
995 Ingebrigtsen, Andrew Innes, Seiichiro Inoue, Ulf Jasper, Michael
996 K. Johnson, Kyle Jones, Terry Jones, Simon Josefsson, Tomoji Kagatani,
997 Brewster Kahle, David Kaufman, Henry Kautz, Taichi Kawabata, Howard
998 Kaye, Michael Kifer, Richard King, Peter Kleiweg, Larry K.@: Kolodney,
999 Pavel Kobiakov, Larry K.@: Kolodney, David M.@: Koppelman, Koseki
1000 Yoshinori, Robert Krawitz, Sebastian Kremer, Ryszard Kubiak, Geoff
1001 Kuenning, David K@aa{}gedal, Daniel LaLiberte, Aaron Larson, James
1002 R.@: Larus, Vinicius Jose Latorre, Frederic Lepied, Peter Liljenberg,
1003 Lars Lindberg, Chris Lindblad, Anders Lindgren, Thomas Link, Dave
1004 Love, Eric Ludlam, Alan Mackenzie, Christopher J.@: Madsen,
1005 Neil M.@: Mager, Ken Manheimer, Bill Mann, Brian Marick, Simon
1006 Marshall, Bengt Martensson, Charlie Martin, Thomas May, Roland McGrath,
1007 Will Mengarini, David Megginson, Wayne Mesard, Brad Miller, Richard
1008 Mlynarik, Gerd Moellmann, Stefan Monnier, Morioka Tomohiko, Keith
1009 Moore, Sen Nagata, Erik Naggum, Thomas Neumann, Thien-Thi Nguyen, Mike
1010 Newton, Jurgen Nickelsen, Dan Nicolaescu, Jeff Norden, Andrew Norman,
1011 Alexandre Oliva, Bob Olson, Takaaki Ota, Pieter E.@: J.@: Pareit,
1012 David Pearson, Jeff Peck, Damon Anton Permezel, Tom Perrine, William
1013 M.@: Perry, Per Persson, Jens Petersen, Daniel Pfeiffer, Richard
1014 L.@: Pieri, Fred Pierresteguy, Christian Plaunt, David Ponce, Francesco
1015 A. Potorti, Michael D. Prange, Mukesh Prasad, Marko Rahamaa, Ashwin
1016 Ram, Eric S. Raymond, Paul Reilly, Edward M. Reingold, Alex Rezinsky,
1017 Rob Riepel, Nick Roberts, Roland B.@: Roberts, John Robinson, Danny
1018 Roozendaal, William Rosenblatt, Guillermo J.@: Rozas, Ivar Rummelhoff,
1019 Jason Rumney, Wolfgang Rupprecht, Kevin Ryde, James B. Salem, Masahiko
1020 Sato, Holger Schauer, William Schelter, Ralph Schleicher, Gregor
1021 Schmid, Michael Schmidt, Ronald S. Schnell, Philippe Schnoebelen, Jan
1022 Schormann, Alex Schroeder, Stephen Schoef, Randal Schwartz, Oliver
1023 Seidel, Manuel Serrano, Hovav Shacham, Stanislav Shalunov, Mark
1024 Shapiro, Richard Sharman, Olin Shivers, Espen Skoglund, Rick Sladkey,
1025 Lynn Slater, Chris Smith, David Smith, Paul D.@: Smith, Andre Spiegel,
1026 Michael Staats, William Sommerfeld, Michael Staats, Sam Steingold, Ake
1027 Stenhoff, Peter Stephenson, Ken Stevens, Jonathan Stigelman, Martin
1028 Stjernholm, Kim F.@: Storm, Steve Strassman, Olaf Sylvester, Naoto
1029 Takahashi, Jean-Philippe Theberge, Jens T.@: Berger Thielemann,
1030 Spencer Thomas, Jim Thompson, Tom Tromey, Daiki Ueno, Masanobu Umeda,
1031 Rajesh Vaidheeswarran, Neil W.@: Van Dyke, Didier Verna, Ulrik Vieth,
1032 Geoffrey Voelker, Johan Vromans, Inge Wallin, Colin Walters, Barry
1033 Warsaw, Morten Welinder, Joseph Brian Wells, Rodney Whitby, John
1034 Wiegley, Ed Wilkinson, Mike Williams, Bill Wohler, Steven A. Wood,
1035 Dale R.@: Worley, Francis J.@: Wright, Felix S. T. Wu, Tom Wurgler,
1036 Masatake Yamato, Jonathan Yavner, Ilya Zakharevich, Milan Zamazal,
1037 Victor Zandy, Eli Zaretskii, Jamie Zawinski, Shenghuo Zhu, Ian
1038 T.@: Zimmermann, Reto Zimmermann, Neal Ziring, and Detlev Zundel.
1039 @end iftex
1041 @node Intro, Glossary, Distrib, Top
1042 @unnumbered Introduction
1044   You are reading about GNU Emacs, the GNU incarnation of the advanced,
1045 self-documenting, customizable, extensible real-time display editor Emacs.
1046 (The `G' in `GNU' is not silent.)
1048   We say that Emacs is a @dfn{display} editor because normally the text
1049 being edited is visible on the screen and is updated automatically as you
1050 type your commands.  @xref{Screen,Display}.
1052   We call it a @dfn{real-time} editor because the display is updated very
1053 frequently, usually after each character or pair of characters you
1054 type.  This minimizes the amount of information you must keep in your
1055 head as you edit.  @xref{Basic,Real-time,Basic Editing}.
1057   We call Emacs advanced because it provides facilities that go beyond
1058 simple insertion and deletion: controlling subprocesses; automatic
1059 indentation of programs; viewing two or more files at once; editing
1060 formatted text; and dealing in terms of characters, words, lines,
1061 sentences, paragraphs, and pages, as well as expressions and comments in
1062 several different programming languages.
1064   @dfn{Self-documenting} means that at any time you can type a special
1065 character, @kbd{Control-h}, to find out what your options are.  You can
1066 also use it to find out what any command does, or to find all the commands
1067 that pertain to a topic.  @xref{Help}.
1069   @dfn{Customizable} means that you can change the definitions of Emacs
1070 commands in little ways.  For example, if you use a programming language in
1071 which comments start with @samp{<**} and end with @samp{**>}, you can tell
1072 the Emacs comment manipulation commands to use those strings
1073 (@pxref{Comments}).  Another sort of customization is rearrangement of the
1074 command set.  For example, if you prefer the four basic cursor motion
1075 commands (up, down, left and right) on keys in a diamond pattern on the
1076 keyboard, you can rebind the keys that way.  @xref{Customization}.
1078   @dfn{Extensible} means that you can go beyond simple customization and
1079 write entirely new commands, programs in the Lisp language to be run by
1080 Emacs's own Lisp interpreter.  Emacs is an ``on-line extensible''
1081 system, which means that it is divided into many functions that call
1082 each other, any of which can be redefined in the middle of an editing
1083 session.  Almost any part of Emacs can be replaced without making a
1084 separate copy of all of Emacs.  Most of the editing commands of Emacs
1085 are written in Lisp; the few exceptions could have been written
1086 in Lisp but are written in C for efficiency.  Although only a programmer
1087 can write an extension, anybody can use it afterward.  If you want to
1088 learn Emacs Lisp programming, we recommend the @cite{Introduction to
1089 Emacs Lisp} by Robert J. Chassell, also published by the Free Software
1090 Foundation.
1092    When run under the X Window System, Emacs provides its own menus and
1093 convenient bindings to mouse buttons.  But Emacs can provide many of the
1094 benefits of a window system on a text-only terminal.  For instance, you
1095 can look at or edit several files at once, move text between files, and
1096 edit files while running shell commands.
1098 @include screen.texi
1099 @include commands.texi
1100 @include entering.texi
1101 @include basic.texi
1102 @include mini.texi
1103 @include m-x.texi
1104 @include help.texi
1105 @include mark.texi
1106 @include killing.texi
1107 @include regs.texi
1108 @include display.texi
1109 @include search.texi
1110 @include fixit.texi
1111 @include kmacro.texi
1112 @include files.texi
1113 @include buffers.texi
1114 @include windows.texi
1115 @include frames.texi
1116 @include mule.texi
1117 @include major.texi
1118 @include indent.texi
1119 @include text.texi
1120 @include programs.texi
1121 @include building.texi
1122 @include maintaining.texi
1123 @include abbrevs.texi
1124 @include picture.texi
1125 @include sending.texi
1126 @include rmail.texi
1127 @include dired.texi
1128 @include calendar.texi
1129 @include misc.texi
1130 @include custom.texi
1131 @include trouble.texi
1133 @node Copying, GNU Free Documentation License, Service, Top
1134 @appendix GNU GENERAL PUBLIC LICENSE
1135 @center Version 2, June 1991
1137 @display
1138 Copyright @copyright{} 1989, 1991 Free Software Foundation, Inc.
1139 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
1141 Everyone is permitted to copy and distribute verbatim copies
1142 of this license document, but changing it is not allowed.
1143 @end display
1145 @unnumberedsec Preamble
1147   The licenses for most software are designed to take away your
1148 freedom to share and change it.  By contrast, the GNU General Public
1149 License is intended to guarantee your freedom to share and change free
1150 software---to make sure the software is free for all its users.  This
1151 General Public License applies to most of the Free Software
1152 Foundation's software and to any other program whose authors commit to
1153 using it.  (Some other Free Software Foundation software is covered by
1154 the GNU Library General Public License instead.)  You can apply it to
1155 your programs, too.
1157   When we speak of free software, we are referring to freedom, not
1158 price.  Our General Public Licenses are designed to make sure that you
1159 have the freedom to distribute copies of free software (and charge for
1160 this service if you wish), that you receive source code or can get it
1161 if you want it, that you can change the software or use pieces of it
1162 in new free programs; and that you know you can do these things.
1164   To protect your rights, we need to make restrictions that forbid
1165 anyone to deny you these rights or to ask you to surrender the rights.
1166 These restrictions translate to certain responsibilities for you if you
1167 distribute copies of the software, or if you modify it.
1169   For example, if you distribute copies of such a program, whether
1170 gratis or for a fee, you must give the recipients all the rights that
1171 you have.  You must make sure that they, too, receive or can get the
1172 source code.  And you must show them these terms so they know their
1173 rights.
1175   We protect your rights with two steps: (1) copyright the software, and
1176 (2) offer you this license which gives you legal permission to copy,
1177 distribute and/or modify the software.
1179   Also, for each author's protection and ours, we want to make certain
1180 that everyone understands that there is no warranty for this free
1181 software.  If the software is modified by someone else and passed on, we
1182 want its recipients to know that what they have is not the original, so
1183 that any problems introduced by others will not reflect on the original
1184 authors' reputations.
1186   Finally, any free program is threatened constantly by software
1187 patents.  We wish to avoid the danger that redistributors of a free
1188 program will individually obtain patent licenses, in effect making the
1189 program proprietary.  To prevent this, we have made it clear that any
1190 patent must be licensed for everyone's free use or not licensed at all.
1192   The precise terms and conditions for copying, distribution and
1193 modification follow.
1195 @iftex
1196 @unnumberedsec TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
1197 @end iftex
1198 @ifinfo
1199 @center TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
1200 @end ifinfo
1202 @enumerate 0
1203 @item
1204 This License applies to any program or other work which contains
1205 a notice placed by the copyright holder saying it may be distributed
1206 under the terms of this General Public License.  The ``Program,'' below,
1207 refers to any such program or work, and a ``work based on the Program''
1208 means either the Program or any derivative work under copyright law:
1209 that is to say, a work containing the Program or a portion of it,
1210 either verbatim or with modifications and/or translated into another
1211 language.  (Hereinafter, translation is included without limitation in
1212 the term ``modification.'')  Each licensee is addressed as ``you.''
1214 Activities other than copying, distribution and modification are not
1215 covered by this License; they are outside its scope.  The act of
1216 running the Program is not restricted, and the output from the Program
1217 is covered only if its contents constitute a work based on the
1218 Program (independent of having been made by running the Program).
1219 Whether that is true depends on what the Program does.
1221 @item
1222 You may copy and distribute verbatim copies of the Program's
1223 source code as you receive it, in any medium, provided that you
1224 conspicuously and appropriately publish on each copy an appropriate
1225 copyright notice and disclaimer of warranty; keep intact all the
1226 notices that refer to this License and to the absence of any warranty;
1227 and give any other recipients of the Program a copy of this License
1228 along with the Program.
1230 You may charge a fee for the physical act of transferring a copy, and
1231 you may at your option offer warranty protection in exchange for a fee.
1233 @item
1234 You may modify your copy or copies of the Program or any portion
1235 of it, thus forming a work based on the Program, and copy and
1236 distribute such modifications or work under the terms of Section 1
1237 above, provided that you also meet all of these conditions:
1239 @enumerate a
1240 @item
1241 You must cause the modified files to carry prominent notices
1242 stating that you changed the files and the date of any change.
1244 @item
1245 You must cause any work that you distribute or publish, that in
1246 whole or in part contains or is derived from the Program or any
1247 part thereof, to be licensed as a whole at no charge to all third
1248 parties under the terms of this License.
1250 @item
1251 If the modified program normally reads commands interactively
1252 when run, you must cause it, when started running for such
1253 interactive use in the most ordinary way, to print or display an
1254 announcement including an appropriate copyright notice and a
1255 notice that there is no warranty (or else, saying that you provide
1256 a warranty) and that users may redistribute the program under
1257 these conditions, and telling the user how to view a copy of this
1258 License.  (Exception: if the Program itself is interactive but
1259 does not normally print such an announcement, your work based on
1260 the Program is not required to print an announcement.)
1261 @end enumerate
1263 These requirements apply to the modified work as a whole.  If
1264 identifiable sections of that work are not derived from the Program,
1265 and can be reasonably considered independent and separate works in
1266 themselves, then this License, and its terms, do not apply to those
1267 sections when you distribute them as separate works.  But when you
1268 distribute the same sections as part of a whole which is a work based
1269 on the Program, the distribution of the whole must be on the terms of
1270 this License, whose permissions for other licensees extend to the
1271 entire whole, and thus to each and every part regardless of who wrote it.
1273 Thus, it is not the intent of this section to claim rights or contest
1274 your rights to work written entirely by you; rather, the intent is to
1275 exercise the right to control the distribution of derivative or
1276 collective works based on the Program.
1278 In addition, mere aggregation of another work not based on the Program
1279 with the Program (or with a work based on the Program) on a volume of
1280 a storage or distribution medium does not bring the other work under
1281 the scope of this License.
1283 @item
1284 You may copy and distribute the Program (or a work based on it,
1285 under Section 2) in object code or executable form under the terms of
1286 Sections 1 and 2 above provided that you also do one of the following:
1288 @enumerate a
1289 @item
1290 Accompany it with the complete corresponding machine-readable
1291 source code, which must be distributed under the terms of Sections
1292 1 and 2 above on a medium customarily used for software interchange; or,
1294 @item
1295 Accompany it with a written offer, valid for at least three
1296 years, to give any third party, for a charge no more than your
1297 cost of physically performing source distribution, a complete
1298 machine-readable copy of the corresponding source code, to be
1299 distributed under the terms of Sections 1 and 2 above on a medium
1300 customarily used for software interchange; or,
1302 @item
1303 Accompany it with the information you received as to the offer
1304 to distribute corresponding source code.  (This alternative is
1305 allowed only for noncommercial distribution and only if you
1306 received the program in object code or executable form with such
1307 an offer, in accord with Subsection b above.)
1308 @end enumerate
1310 The source code for a work means the preferred form of the work for
1311 making modifications to it.  For an executable work, complete source
1312 code means all the source code for all modules it contains, plus any
1313 associated interface definition files, plus the scripts used to
1314 control compilation and installation of the executable.  However, as a
1315 special exception, the source code distributed need not include
1316 anything that is normally distributed (in either source or binary
1317 form) with the major components (compiler, kernel, and so on) of the
1318 operating system on which the executable runs, unless that component
1319 itself accompanies the executable.
1321 If distribution of executable or object code is made by offering
1322 access to copy from a designated place, then offering equivalent
1323 access to copy the source code from the same place counts as
1324 distribution of the source code, even though third parties are not
1325 compelled to copy the source along with the object code.
1327 @item
1328 You may not copy, modify, sublicense, or distribute the Program
1329 except as expressly provided under this License.  Any attempt
1330 otherwise to copy, modify, sublicense or distribute the Program is
1331 void, and will automatically terminate your rights under this License.
1332 However, parties who have received copies, or rights, from you under
1333 this License will not have their licenses terminated so long as such
1334 parties remain in full compliance.
1336 @item
1337 You are not required to accept this License, since you have not
1338 signed it.  However, nothing else grants you permission to modify or
1339 distribute the Program or its derivative works.  These actions are
1340 prohibited by law if you do not accept this License.  Therefore, by
1341 modifying or distributing the Program (or any work based on the
1342 Program), you indicate your acceptance of this License to do so, and
1343 all its terms and conditions for copying, distributing or modifying
1344 the Program or works based on it.
1346 @item
1347 Each time you redistribute the Program (or any work based on the
1348 Program), the recipient automatically receives a license from the
1349 original licensor to copy, distribute or modify the Program subject to
1350 these terms and conditions.  You may not impose any further
1351 restrictions on the recipients' exercise of the rights granted herein.
1352 You are not responsible for enforcing compliance by third parties to
1353 this License.
1355 @item
1356 If, as a consequence of a court judgment or allegation of patent
1357 infringement or for any other reason (not limited to patent issues),
1358 conditions are imposed on you (whether by court order, agreement or
1359 otherwise) that contradict the conditions of this License, they do not
1360 excuse you from the conditions of this License.  If you cannot
1361 distribute so as to satisfy simultaneously your obligations under this
1362 License and any other pertinent obligations, then as a consequence you
1363 may not distribute the Program at all.  For example, if a patent
1364 license would not permit royalty-free redistribution of the Program by
1365 all those who receive copies directly or indirectly through you, then
1366 the only way you could satisfy both it and this License would be to
1367 refrain entirely from distribution of the Program.
1369 If any portion of this section is held invalid or unenforceable under
1370 any particular circumstance, the balance of the section is intended to
1371 apply and the section as a whole is intended to apply in other
1372 circumstances.
1374 It is not the purpose of this section to induce you to infringe any
1375 patents or other property right claims or to contest validity of any
1376 such claims; this section has the sole purpose of protecting the
1377 integrity of the free software distribution system, which is
1378 implemented by public license practices.  Many people have made
1379 generous contributions to the wide range of software distributed
1380 through that system in reliance on consistent application of that
1381 system; it is up to the author/donor to decide if he or she is willing
1382 to distribute software through any other system and a licensee cannot
1383 impose that choice.
1385 This section is intended to make thoroughly clear what is believed to
1386 be a consequence of the rest of this License.
1388 @item
1389 If the distribution and/or use of the Program is restricted in
1390 certain countries either by patents or by copyrighted interfaces, the
1391 original copyright holder who places the Program under this License
1392 may add an explicit geographical distribution limitation excluding
1393 those countries, so that distribution is permitted only in or among
1394 countries not thus excluded.  In such case, this License incorporates
1395 the limitation as if written in the body of this License.
1397 @item
1398 The Free Software Foundation may publish revised and/or new versions
1399 of the General Public License from time to time.  Such new versions will
1400 be similar in spirit to the present version, but may differ in detail to
1401 address new problems or concerns.
1403 Each version is given a distinguishing version number.  If the Program
1404 specifies a version number of this License which applies to it and ``any
1405 later version,'' you have the option of following the terms and conditions
1406 either of that version or of any later version published by the Free
1407 Software Foundation.  If the Program does not specify a version number of
1408 this License, you may choose any version ever published by the Free Software
1409 Foundation.
1411 @item
1412 If you wish to incorporate parts of the Program into other free
1413 programs whose distribution conditions are different, write to the author
1414 to ask for permission.  For software which is copyrighted by the Free
1415 Software Foundation, write to the Free Software Foundation; we sometimes
1416 make exceptions for this.  Our decision will be guided by the two goals
1417 of preserving the free status of all derivatives of our free software and
1418 of promoting the sharing and reuse of software generally.
1420 @iftex
1421 @heading NO WARRANTY
1422 @end iftex
1423 @ifinfo
1424 @center NO WARRANTY
1425 @end ifinfo
1427 @item
1428 BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
1429 FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW@.  EXCEPT WHEN
1430 OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
1431 PROVIDE THE PROGRAM ``AS IS'' WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
1432 OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
1433 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE@.  THE ENTIRE RISK AS
1434 TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU@.  SHOULD THE
1435 PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
1436 REPAIR OR CORRECTION.
1438 @item
1439 IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
1440 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
1441 REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
1442 INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
1443 OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
1444 TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
1445 YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
1446 PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
1447 POSSIBILITY OF SUCH DAMAGES.
1448 @end enumerate
1450 @iftex
1451 @heading END OF TERMS AND CONDITIONS
1452 @end iftex
1453 @ifinfo
1454 @center END OF TERMS AND CONDITIONS
1455 @end ifinfo
1457 @page
1458 @unnumberedsec How to Apply These Terms to Your New Programs
1460   If you develop a new program, and you want it to be of the greatest
1461 possible use to the public, the best way to achieve this is to make it
1462 free software which everyone can redistribute and change under these terms.
1464   To do so, attach the following notices to the program.  It is safest
1465 to attach them to the start of each source file to most effectively
1466 convey the exclusion of warranty; and each file should have at least
1467 the ``copyright'' line and a pointer to where the full notice is found.
1469 @smallexample
1470 @var{one line to give the program's name and an idea of what it does.}
1471 Copyright (C) 19@var{yy}  @var{name of author}
1473 This program is free software; you can redistribute it and/or
1474 modify it under the terms of the GNU General Public License
1475 as published by the Free Software Foundation; either version 2
1476 of the License, or (at your option) any later version.
1478 This program is distributed in the hope that it will be useful,
1479 but WITHOUT ANY WARRANTY; without even the implied warranty of
1480 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE@.  See the
1481 GNU General Public License for more details.
1483 You should have received a copy of the GNU General Public License along
1484 with this program; if not, write to the Free Software Foundation, Inc.,
1485 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
1486 @end smallexample
1488 Also add information on how to contact you by electronic and paper mail.
1490 If the program is interactive, make it output a short notice like this
1491 when it starts in an interactive mode:
1493 @smallexample
1494 Gnomovision version 69, Copyright (C) 20@var{yy} @var{name of author}
1495 Gnomovision comes with ABSOLUTELY NO WARRANTY; for details
1496 type `show w'.  This is free software, and you are welcome
1497 to redistribute it under certain conditions; type `show c'
1498 for details.
1499 @end smallexample
1501 The hypothetical commands @samp{show w} and @samp{show c} should show
1502 the appropriate parts of the General Public License.  Of course, the
1503 commands you use may be called something other than @samp{show w} and
1504 @samp{show c}; they could even be mouse-clicks or menu items---whatever
1505 suits your program.
1507 You should also get your employer (if you work as a programmer) or your
1508 school, if any, to sign a ``copyright disclaimer'' for the program, if
1509 necessary.  Here is a sample; alter the names:
1511 @smallexample
1512 @group
1513 Yoyodyne, Inc., hereby disclaims all copyright
1514 interest in the program `Gnomovision'
1515 (which makes passes at compilers) written
1516 by James Hacker.
1518 @var{signature of Ty Coon}, 1 April 1989
1519 Ty Coon, President of Vice
1520 @end group
1521 @end smallexample
1523 This General Public License does not permit incorporating your program into
1524 proprietary programs.  If your program is a subroutine library, you may
1525 consider it more useful to permit linking proprietary applications with the
1526 library.  If this is what you want to do, use the GNU Library General
1527 Public License instead of this License.
1529 @include doclicense.texi
1530 @include cmdargs.texi
1531 @include xresources.texi
1533 @include anti.texi
1534 @include macos.texi
1535 @include msdog.texi
1536 @include gnu.texi
1537 @include glossary.texi
1538 @ifnottex
1539 @include ack.texi
1540 @end ifnottex
1542 @c The Option Index is produced only in the on-line version,
1543 @c because the index entries related to command-line options
1544 @c tend to point to the same pages and all begin with a dash.
1545 @c This, and the need to keep the node links consistent, are
1546 @c the reasons for the funky @iftex/@ifnottex dance below.
1547 @c The Option Index is _not_ before Key Index, because that
1548 @c would require changes in the glossary.texi's @node line.
1549 @c It is not after Concept Index for similar reasons.
1551 @iftex
1552 @node Key Index, Command Index, Glossary, Top
1553 @unnumbered Key (Character) Index
1554 @printindex ky
1555 @end iftex
1557 @ifnottex
1558 @node Key Index, Option Index, Glossary, Top
1559 @unnumbered Key (Character) Index
1560 @printindex ky
1562 @node Option Index, Command Index, Key Index, Top
1563 @unnumbered Command-Line Options Index
1564 @printindex op
1566 @node Command Index, Variable Index, Option Index, Top
1567 @unnumbered Command and Function Index
1568 @printindex fn
1569 @end ifnottex
1571 @iftex
1572 @node Command Index, Variable Index, Key Index, Top
1573 @unnumbered Command and Function Index
1574 @printindex fn
1575 @end iftex
1577 @node Variable Index, Concept Index, Command Index, Top
1578 @unnumbered Variable Index
1579 @printindex vr
1581 @node Concept Index, Acknowledgments, Variable Index, Top
1582 @unnumbered Concept Index
1583 @printindex cp
1585 @summarycontents
1586 @contents
1587 @bye
1589 @ignore
1590    arch-tag: ed48740a-410b-46ea-9387-c9a9252a3392
1591 @end ignore