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