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