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