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