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