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