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