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