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