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