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