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