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