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