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