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.2 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 and Microsoft Windows.
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 * Basic 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.
288 * CUA Bindings:: Using @kbd{C-x}, @kbd{C-c}, @kbd{C-v} for copy
289 and paste, with enhanced rectangle support.
293 * Kill Ring:: Where killed text is stored. Basic yanking.
294 * Appending Kills:: Several kills in a row all yank together.
295 * Earlier Kills:: Yanking something killed some time ago.
299 * RegPos:: Saving positions in registers.
300 * RegText:: Saving text in registers.
301 * RegRect:: Saving rectangles in registers.
302 * RegConfig:: Saving window configurations in registers.
303 * RegNumbers:: Numbers in registers.
304 * RegFiles:: File names in registers.
305 * Bookmarks:: Bookmarks are like registers, but persistent.
307 Controlling the Display
309 * Scrolling:: Moving text up and down in a window.
310 * Horizontal Scrolling:: Moving text left and right in a window.
311 * Follow Mode:: Follow mode lets two windows scroll as one.
312 * Faces:: How to change the display style using faces.
313 * Standard Faces:: Emacs' predefined faces.
314 * Font Lock:: Minor mode for syntactic highlighting using faces.
315 * Highlight Interactively:: Tell Emacs what text to highlight.
316 * Fringes:: Enabling or disabling window fringes.
317 * Useless Whitespace:: Showing possibly-spurious trailing whitespace.
318 * Selective Display:: Hiding lines with lots of indentation.
319 * Optional Mode Line:: Optional mode line display features.
320 * Text Display:: How text characters are normally displayed.
321 * Cursor Display:: Features for displaying the cursor.
322 * Display Custom:: Information on variables for customizing display.
324 Searching and Replacement
326 * Incremental Search:: Search happens as you type the string.
327 * Nonincremental Search:: Specify entire string and then search.
328 * Word Search:: Search for sequence of words.
329 * Regexp Search:: Search for match for a regexp.
330 * Regexps:: Syntax of regular expressions.
331 * Search Case:: To ignore case while searching, or not.
332 * Replace:: Search, and replace some or all matches.
333 * Other Repeating Search:: Operating on all matches for some regexp.
337 * Unconditional Replace:: Replacing all matches for a string.
338 * Regexp Replace:: Replacing all matches for a regexp.
339 * Replacement and Case:: How replacements preserve case of letters.
340 * Query Replace:: How to use querying.
342 Commands for Fixing Typos
344 * Undo:: Full details of Emacs undo commands.
345 * Kill Errors:: Commands to kill a batch of recently entered text.
346 * Transpose:: Exchanging two characters, words, lines, lists...
347 * Fixing Case:: Correcting case of last word entered.
348 * Spelling:: Apply spelling checker to a word or a whole buffer.
352 * Basic Keyboard Macro:: Defining and running keyboard macros.
353 * Keyboard Macro Ring:: Where previous keyboard macros are saved.
354 * Keyboard Macro Counter:: Inserting incrementing numbers in macros.
355 * Keyboard Macro Query:: Making keyboard macros do different things each time.
356 * Save Keyboard Macro:: Giving keyboard macros names; saving them in files.
357 * Edit Keyboard Macro:: Editing keyboard macros.
358 * Keyboard Macro Step-Edit:: Interactively executing and editing a keyboard
363 * File Names:: How to type and edit file-name arguments.
364 * Visiting:: Visiting a file prepares Emacs to edit the file.
365 * Saving:: Saving makes your changes permanent.
366 * Reverting:: Reverting cancels all the changes not saved.
367 * Auto Save:: Auto Save periodically protects against loss of data.
368 * File Aliases:: Handling multiple names for one file.
369 * Version Control:: Version control systems (RCS, CVS and SCCS).
370 * Directories:: Creating, deleting, and listing file directories.
371 * Comparing Files:: Finding where two files differ.
372 * Misc File Ops:: Other things you can do on files.
373 * Compressed Files:: Accessing compressed files.
374 * File Archives:: Operating on tar, zip, jar etc. archive files.
375 * Remote Files:: Accessing files on other sites.
376 * Quoted File Names:: Quoting special characters in file names.
377 * File Name Cache:: Completion against a list of files you often use.
378 * File Conveniences:: Convenience Features for Finding Files.
379 * Filesets:: Handling sets of files.
383 * Save Commands:: Commands for saving files.
384 * Backup:: How Emacs saves the old version of your file.
385 * Customize Save:: Customizing the saving of files.
386 * Interlocking:: How Emacs protects against simultaneous editing
387 of one file by two users.
388 * File Shadowing:: Copying files to "shadows" automatically.
389 * Time Stamps:: Emacs can update time stamps on saved files.
393 * Introduction to VC:: How version control works in general.
394 * VC Mode Line:: How the mode line shows version control status.
395 * Basic VC Editing:: How to edit a file under version control.
396 * Old Versions:: Examining and comparing old versions.
397 * Secondary VC Commands:: The commands used a little less frequently.
398 * Branches:: Multiple lines of development.
399 * Remote Repositories:: Efficient access to remote CVS servers.
400 * Snapshots:: Sets of file versions treated as a unit.
401 * Miscellaneous VC:: Various other commands and features of VC.
402 * Customizing VC:: Variables that change VC's behavior.
404 Using Multiple Buffers
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
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.
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.
452 International Character Set Support
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 * Single-Byte Character Support:: You can pick one European character set
473 to use without multibyte characters.
474 * Charsets:: How Emacs groups its internal character codes.
478 * Choosing Modes:: How major modes are specified or chosen.
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.
487 Commands for Human Languages
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.
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.
515 * Program Modes:: Major modes for editing programs.
516 * Defuns:: Commands to operate on major top-level parts
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 * Fortran:: Fortran mode and its special features.
529 * Asm Mode:: Asm mode and its special features.
531 Top-Level Definitions, or Defuns
533 * Left Margin Paren:: An open-paren or similar opening delimiter
534 starts a defun if it is at the left margin.
535 * Moving by Defuns:: Commands to move over or mark a major definition.
536 * Imenu:: Making buffer indexes as menus.
537 * Which Function:: Which Function mode shows which function you are in.
539 Indentation for Programs
541 * Basic Indent:: Indenting a single line.
542 * Multi-line Indent:: Commands to reindent many lines at once.
543 * Lisp Indent:: Specifying how each Lisp function should be indented.
544 * C Indent:: Extra features for indenting C and related modes.
545 * Custom C Indent:: Controlling indentation style for C and related modes.
547 Commands for Editing with Parentheses
549 * Expressions:: Expressions with balanced parentheses.
550 * Moving by Parens:: Commands for moving up, down and across
551 in the structure of parentheses.
552 * Matching:: Insertion of a close-delimiter flashes matching open.
554 Manipulating Comments
556 * Comment Commands:: Inserting, killing, and indenting comments.
557 * Multi-Line Comments:: Commands for adding and editing multi-line comments.
558 * Options for Comments::Customizing the comment features.
562 * Info Lookup:: Looking up library functions and commands
564 * Man Page:: Looking up man pages of library functions and commands.
565 * Lisp Doc:: Looking up Emacs Lisp functions, etc.
569 * Motion in C:: Commands to move by C statements, etc.
570 * Electric C:: Colon and other chars can automatically reindent.
571 * Hungry Delete:: A more powerful DEL command.
572 * Other C Commands:: Filling comments, viewing expansion of macros,
573 and other neat features.
577 * Fortran Motion:: Moving point by statements or subprograms.
578 * Fortran Indent:: Indentation commands for Fortran.
579 * Fortran Comments:: Inserting and aligning comments.
580 * Fortran Autofill:: Auto fill minor mode for Fortran.
581 * Fortran Columns:: Measuring columns for valid Fortran.
582 * Fortran Abbrev:: Built-in abbrevs for Fortran keywords.
584 Compiling and Testing Programs
586 * Compilation:: Compiling programs in languages other
587 than Lisp (C, Pascal, etc.).
588 * Compilation Mode:: The mode for visiting compiler errors.
589 * Compilation Shell:: Customizing your shell properly
590 for use in the compilation buffer.
591 * Grep Searching:: Searching with grep.
592 * Flymake:: Finding syntax errors on the fly.
593 * Debuggers:: Running symbolic debuggers for non-Lisp programs.
594 * Executing Lisp:: Various modes for editing Lisp programs,
595 with different facilities for running
597 * Lisp Libraries:: Creating Lisp programs to run in Emacs.
598 * Lisp Eval:: Executing a single Lisp expression in Emacs.
599 * Lisp Interaction:: Executing Lisp in an Emacs buffer.
600 * External Lisp:: Communicating through Emacs with a separate Lisp.
602 Running Debuggers Under Emacs
604 * Starting GUD:: How to start a debugger subprocess.
605 * Debugger Operation:: Connection between the debugger and source buffers.
606 * Commands of GUD:: Key bindings for common commands.
607 * GUD Customization:: Defining your own commands for GUD.
608 * GDB Graphical Interface:: An enhanced mode that uses GDB features to
609 implement a graphical debugging environment through
614 * Change Log:: Maintaining a change history for your program.
616 * Authors:: Maintaining the Emacs @file{AUTHORS} file.
618 * Tags:: Go direct to any function in your program in one
619 command. Tags remembers which file it is in.
620 * Emerge:: A convenient way of merging two versions of a program.
624 * Tag Syntax:: Tag syntax for various types of code and text files.
625 * Create Tags Table:: Creating a tags table with @code{etags}.
626 * Etags Regexps:: Create arbitrary tags using regular expressions.
627 * Select Tags Table:: How to visit a tags table.
628 * Find Tag:: Commands to find the definition of a specific tag.
629 * Tags Search:: Using a tags table for searching and replacing.
630 * List Tags:: Listing and finding tags defined in a file.
632 Merging Files with Emerge
634 * Overview of Emerge:: How to start Emerge. Basic concepts.
635 * Submodes of Emerge:: Fast mode vs. Edit mode.
636 Skip Prefers mode and Auto Advance mode.
637 * State of Difference:: You do the merge by specifying state A or B
639 * Merge Commands:: Commands for selecting a difference,
640 changing states of differences, etc.
641 * Exiting Emerge:: What to do when you've finished the merge.
642 * Combining in Emerge:: How to keep both alternatives for a difference.
643 * Fine Points of Emerge:: Misc.
647 * Abbrev Concepts:: Fundamentals of defined abbrevs.
648 * Defining Abbrevs:: Defining an abbrev, so it will expand when typed.
649 * Expanding Abbrevs:: Controlling expansion: prefixes, canceling expansion.
650 * Editing Abbrevs:: Viewing or editing the entire list of defined abbrevs.
651 * Saving Abbrevs:: Saving the entire list of abbrevs for another session.
652 * Dynamic Abbrevs:: Abbreviations for words already in the buffer.
653 * Dabbrev Customization:: What is a word, for dynamic abbrevs. Case handling.
657 * Basic Picture:: Basic concepts and simple commands of Picture Mode.
658 * Insert in Picture:: Controlling direction of cursor motion
659 after "self-inserting" characters.
660 * Tabs in Picture:: Various features for tab stops and indentation.
661 * Rectangles in Picture:: Clearing and superimposing rectangles.
665 * Mail Format:: Format of the mail being composed.
666 * Mail Headers:: Details of permitted mail header fields.
667 * Mail Aliases:: Abbreviating and grouping mail addresses.
668 * Mail Mode:: Special commands for editing mail being composed.
669 * Mail Amusements:: Distract the NSA's attention; add a fortune to a msg.
670 * Mail Methods:: Using alternative mail-composition methods.
672 Reading Mail with Rmail
674 * Rmail Basics:: Basic concepts of Rmail, and simple use.
675 * Rmail Scrolling:: Scrolling through a message.
676 * Rmail Motion:: Moving to another message.
677 * Rmail Deletion:: Deleting and expunging messages.
678 * Rmail Inbox:: How mail gets into the Rmail file.
679 * Rmail Files:: Using multiple Rmail files.
680 * Rmail Output:: Copying message out to files.
681 * Rmail Labels:: Classifying messages by labeling them.
682 * Rmail Attributes:: Certain standard labels, called attributes.
683 * Rmail Reply:: Sending replies to messages you are viewing.
684 * Rmail Summary:: Summaries show brief info on many messages.
685 * Rmail Sorting:: Sorting messages in Rmail.
686 * Rmail Display:: How Rmail displays a message; customization.
687 * Rmail Coding:: How Rmail handles decoding character sets.
688 * Rmail Editing:: Editing message text and headers in Rmail.
689 * Rmail Digest:: Extracting the messages from a digest message.
690 * Out of Rmail:: Converting an Rmail file to mailbox format.
691 * Rmail Rot13:: Reading messages encoded in the rot13 code.
692 * Movemail:: More details of fetching new mail.
693 * Remote Mailboxes:: Retrieving Mail from Remote Mailboxes.
694 * Other Mailbox Formats:: Retrieving Mail from Local Mailboxes in
697 Dired, the Directory Editor
699 * Dired Enter:: How to invoke Dired.
700 * Dired Navigation:: How to move in the Dired buffer.
701 * Dired Deletion:: Deleting files with Dired.
702 * Flagging Many Files:: Flagging files based on their names.
703 * Dired Visiting:: Other file operations through Dired.
704 * Marks vs Flags:: Flagging for deletion vs marking.
705 * Operating on Files:: How to copy, rename, print, compress, etc.
706 either one file or several files.
707 * Shell Commands in Dired:: Running a shell command on the marked files.
708 * Transforming File Names:: Using patterns to rename multiple files.
709 * Comparison in Dired:: Running `diff' by way of Dired.
710 * Subdirectories in Dired:: Adding subdirectories to the Dired buffer.
711 * Subdirectory Motion:: Moving across subdirectories, and up and down.
712 * Hiding Subdirectories:: Making subdirectories visible or invisible.
713 * Dired Updating:: Discarding lines for files of no interest.
714 * Dired and Find:: Using `find' to choose the files for Dired.
715 * Wdired:: Operating on files by editing the Dired buffer.
716 * Misc Dired Features:: Various other features.
718 The Calendar and the Diary
720 * Calendar Motion:: Moving through the calendar; selecting a date.
721 * Scroll Calendar:: Bringing earlier or later months onto the screen.
722 * Counting Days:: How many days are there between two dates?
723 * General Calendar:: Exiting or recomputing the calendar.
724 * LaTeX Calendar:: Print a calendar using LaTeX.
725 * Holidays:: Displaying dates of holidays.
726 * Sunrise/Sunset:: Displaying local times of sunrise and sunset.
727 * Lunar Phases:: Displaying phases of the moon.
728 * Other Calendars:: Converting dates to other calendar systems.
729 * Diary:: Displaying events from your diary.
730 * Appointments:: Reminders when it's time to do something.
731 * Importing Diary:: Converting diary events to/from other formats.
732 * Daylight Savings:: How to specify when daylight savings time is active.
733 * Time Intervals:: Keeping track of time intervals.
735 Movement in the Calendar
737 * Calendar Unit Motion:: Moving by days, weeks, months, and years.
738 * Move to Beginning or End:: Moving to start/end of weeks, months, and years.
739 * Specified Dates:: Moving to the current date or another
742 Conversion To and From Other Calendars
744 * Calendar Systems:: The calendars Emacs understands
745 (aside from Gregorian).
746 * To Other Calendar:: Converting the selected date to various calendars.
747 * From Other Calendar:: Moving to a date specified in another calendar.
748 * Mayan Calendar:: Moving to a date specified in a Mayan calendar.
752 * Displaying the Diary:: Viewing diary entries and associated calendar dates.
753 * Format of Diary File:: Entering events in your diary.
754 * Date Formats:: Various ways you can specify dates.
755 * Adding to Diary:: Commands to create diary entries.
756 * Special Diary Entries:: Anniversaries, blocks of dates, cyclic entries, etc.
760 * Buffers of Gnus:: The group, summary, and article buffers.
761 * Gnus Startup:: What you should know about starting Gnus.
762 * Summary of Gnus:: A short description of the basic Gnus commands.
764 Running Shell Commands from Emacs
766 * Single Shell:: How to run one shell command and return.
767 * Interactive Shell:: Permanent shell taking input via Emacs.
768 * Shell Mode:: Special Emacs commands used with permanent shell.
769 * Shell Prompts:: Two ways to recognize shell prompts.
770 * Shell History:: Repeating previous commands in a shell buffer.
771 * Directory Tracking:: Keeping track when the subshell changes directory.
772 * Shell Options:: Options for customizing Shell mode.
773 * Terminal emulator:: An Emacs window as a terminal emulator.
774 * Term Mode:: Special Emacs commands used in Term mode.
775 * Paging in Term:: Paging in the terminal emulator.
776 * Remote Host:: Connecting to another computer.
778 Using Emacs as a Server
780 * Invoking emacsclient:: Emacs client startup options.
782 Hyperlinking and Navigation Features
784 * Browse-URL:: Following URLs.
785 * Goto-address:: Activating URLs.
786 * FFAP:: Finding files etc. at point.
790 * Minor Modes:: Each minor mode is one feature you can turn on
791 independently of any others.
792 * Easy Customization:: Convenient way to browse and change user options.
793 * Variables:: Many Emacs commands examine Emacs variables
794 to decide what to do; by setting variables,
795 you can control their functioning.
796 * Key Bindings:: The keymaps say what command each key runs.
797 By changing them, you can "redefine keys".
798 * Syntax:: The syntax table controls how words and
799 expressions are parsed.
800 * Init File:: How to write common customizations in the
805 * Examining:: Examining or setting one variable's value.
806 * Hooks:: Hook variables let you specify programs for parts
807 of Emacs to run on particular occasions.
808 * Locals:: Per-buffer values of variables.
809 * File Variables:: How files can specify variable values.
811 Customizing Key Bindings
813 * Keymaps:: Generalities. The global keymap.
814 * Prefix Keymaps:: Keymaps for prefix keys.
815 * Local Keymaps:: Major and minor modes have their own keymaps.
816 * Minibuffer Maps:: The minibuffer uses its own local keymaps.
817 * Rebinding:: How to redefine one key's meaning conveniently.
818 * Init Rebinding:: Rebinding keys with your init file, @file{.emacs}.
819 * Function Keys:: Rebinding terminal function keys.
820 * Named ASCII Chars:: Distinguishing @key{TAB} from @kbd{C-i}, and so on.
821 * Non-ASCII Rebinding:: Rebinding non-@acronym{ASCII} characters such as Latin-1.
822 * Mouse Buttons:: Rebinding mouse buttons in Emacs.
823 * Disabling:: Disabling a command means confirmation is required
824 before it can be executed. This is done to protect
825 beginners from surprises.
827 The Init File, @file{~/.emacs}
829 * Init Syntax:: Syntax of constants in Emacs Lisp.
830 * Init Examples:: How to do some things with an init file.
831 * Terminal Init:: Each terminal type can have an init file.
832 * Find Init:: How Emacs finds the init file.
834 Dealing with Emacs Trouble
836 * DEL Does Not Delete:: What to do if @key{DEL} doesn't delete.
837 * Stuck Recursive:: `[...]' in mode line around the parentheses.
838 * Screen Garbled:: Garbage on the screen.
839 * Text Garbled:: Garbage in the text.
840 * Unasked-for Search:: Spontaneous entry to incremental search.
841 * Memory Full:: How to cope when you run out of memory.
842 * After a Crash:: Recovering editing in an Emacs session that crashed.
843 * Emergency Escape:: Emergency escape---
844 What to do if Emacs stops responding.
845 * Total Frustration:: When you are at your wits' end.
849 * Bug Criteria:: Have you really found a bug?
850 * Understanding Bug Reporting:: How to report a bug effectively.
851 * Checklist:: Steps to follow for a good bug report.
852 * Sending Patches:: How to send a patch for GNU Emacs.
854 Command Line Arguments for Emacs Invocation
856 * Action Arguments:: Arguments to visit files, load libraries,
858 * Initial Options:: Arguments that take effect while starting Emacs.
859 * Command Example:: Examples of using command line arguments.
860 * Resume Arguments:: Specifying arguments when you resume a running Emacs.
861 * Environment:: Environment variables that Emacs uses.
862 * Display X:: Changing the default display and using remote login.
863 * Font X:: Choosing a font for text, under X.
864 * Colors:: Choosing display colors.
865 * Window Size X:: Start-up window size, under X.
866 * Borders X:: Internal and external borders, under X.
867 * Title X:: Specifying the initial frame's title.
868 * Icons X:: Choosing what sort of icon to use, under X.
869 * Misc X:: Other display options.
871 Environment Variables
873 * General Variables:: Environment variables that all versions of Emacs use.
874 * Misc Variables:: Certain system specific variables.
875 * MS-Windows Registry:: An alternative to the environment on MS-Windows.
877 X Options and Resources
879 * Resources:: Using X resources with Emacs (in general).
880 * Table of Resources:: Table of specific X resources that affect Emacs.
881 * Face Resources:: X resources for customizing faces.
882 * Lucid Resources:: X resources for Lucid menus.
883 * LessTif Resources:: X resources for LessTif and Motif menus.
884 * GTK resources:: Resources for GTK widgets.
888 * Mac Input:: Keyboard and mouse input on Mac.
889 * Mac International:: International character sets on Mac.
890 * Mac Environment Variables:: Setting environment variables for Emacs.
891 * Mac Directories:: Volumes and directories on Mac.
892 * Mac Font Specs:: Specifying fonts on Mac.
893 * Mac Functions:: Mac-specific Lisp functions.
895 MS-DOS and Windows 95/98/NT
897 * MS-DOS Keyboard:: Keyboard usage on MS-DOS.
898 * MS-DOS Mouse:: Mouse usage on MS-DOS.
899 * MS-DOS Display:: Fonts, frames and display size on MS-DOS.
900 * MS-DOS File Names:: File-name conventions on MS-DOS.
901 * Text and Binary:: Text files on MS-DOS use CRLF to separate lines.
902 * MS-DOS Printing:: How to specify the printer on MS-DOS.
903 * MS-DOS and MULE:: Support for internationalization on MS-DOS.
904 * MS-DOS Processes:: Running subprocesses on MS-DOS.
905 * Windows Processes:: Running subprocesses on Windows.
906 * Windows System Menu:: Controlling what the ALT key does.
912 This manual documents the use and simple customization of the Emacs
913 editor. The reader is not expected to be a programmer; simple
914 customizations do not require programming skill. The user who is not
915 interested in customizing can ignore the scattered customization hints.
917 This is primarily a reference manual, but can also be used as a
918 primer. For complete beginners, it is a good idea to start with the
919 on-line, learn-by-doing tutorial, before reading the manual. To run the
920 tutorial, start Emacs and type @kbd{C-h t}. This way you can learn
921 Emacs by using Emacs on a specially designed file which describes
922 commands, tells you when to try them, and then explains the results you
925 On first reading, just skim chapters 1 and 2, which describe the
926 notational conventions of the manual and the general appearance of the
927 Emacs display screen. Note which questions are answered in these
928 chapters, so you can refer back later. After reading chapter 4, you
929 should practice the commands there. The next few chapters describe
930 fundamental techniques and concepts that are used constantly. You need
931 to understand them thoroughly, experimenting with them if necessary.
933 Chapters 14 through 19 describe intermediate-level features that are
934 useful for all kinds of editing. Chapter 20 and following chapters
935 describe features that you may or may not want to use; read those
936 chapters when you need them.
938 Read the Trouble chapter if Emacs does not seem to be working
939 properly. It explains how to cope with some common problems
940 (@pxref{Lossage}), as well as when and how to report Emacs bugs
943 To find the documentation on a particular command, look in the index.
944 Keys (character commands) and command names have separate indexes. There
945 is also a glossary, with a cross reference for each term.
947 This manual is available as a printed book and also as an Info file.
948 The Info file is for on-line perusal with the Info program, which will
949 be the principal way of viewing documentation on-line in the GNU system.
950 Both the Info file and the Info program itself are distributed along
951 with GNU Emacs. The Info file and the printed book contain
952 substantially the same text and are generated from the same source
953 files, which are also distributed along with GNU Emacs.
955 GNU Emacs is a member of the Emacs editor family. There are many Emacs
956 editors, all sharing common principles of organization. For information on
957 the underlying philosophy of Emacs and the lessons learned from its
958 development, write for a copy of AI memo 519a, @cite{Emacs, the Extensible,
959 Customizable Self-Documenting Display Editor}, to Publications Department,
960 Artificial Intelligence Lab, 545 Tech Square, Cambridge, MA 02139, USA@. At
961 last report they charge $2.25 per copy. Another useful publication is LCS
962 TM-165, @cite{A Cookbook for an Emacs}, by Craig Finseth, available from
963 Publications Department, Laboratory for Computer Science, 545 Tech Square,
964 Cambridge, MA 02139, USA@. The price today is $3.
966 This edition of the manual is intended for use with GNU Emacs
967 installed on GNU and Unix systems. GNU Emacs can also be used on VMS,
968 MS-DOS (also called MS-DOG), Microsoft Windows, and Macintosh systems.
969 Those systems use different file name syntax; in addition, VMS and
970 MS-DOS do not support all GNU Emacs features. @xref{MS-DOS}, for
971 information about using Emacs on MS-DOS and Windows. @xref{Mac OS},
972 for information about using Emacs on Macintosh. We don't try to
973 describe VMS usage in this manual.
976 @node Distrib, Intro, Top, Top
977 @unnumbered Distribution
979 GNU Emacs is @dfn{free software}; this means that everyone is free to
980 use it and free to redistribute it on certain conditions. GNU Emacs
981 is not in the public domain; it is copyrighted and there are
982 restrictions on its distribution, but these restrictions are designed
983 to permit everything that a good cooperating citizen would want to do.
984 What is not allowed is to try to prevent others from further sharing
985 any version of GNU Emacs that they might get from you. The precise
986 conditions are found in the GNU General Public License that comes with
987 Emacs and also appears in this manual@footnote{This manual is itself
988 covered by the GNU Free Documentation License. This license is
989 similar in spirit to the General Public License, but is more suitable
990 for documentation. @xref{GNU Free Documentation License}.}.
993 One way to get a copy of GNU Emacs is from someone else who has it.
994 You need not ask for our permission to do so, or tell any one else;
995 just copy it. If you have access to the Internet, you can get the
996 latest distribution version of GNU Emacs by anonymous FTP; see
997 @url{http://www.gnu.org/software/emacs} on our website for more
1000 You may also receive GNU Emacs when you buy a computer. Computer
1001 manufacturers are free to distribute copies on the same terms that apply to
1002 everyone else. These terms require them to give you the full sources,
1003 including whatever changes they may have made, and to permit you to
1004 redistribute the GNU Emacs received from them under the usual terms of the
1005 General Public License. In other words, the program must be free for you
1006 when you get it, not just free for the manufacturer.
1008 You can also order copies of GNU Emacs from the Free Software
1009 Foundation. This is a convenient and reliable way to get a copy; it is
1010 also a good way to help fund our work. We also sell hardcopy versions
1011 of this manual and @cite{An Introduction to Programming in Emacs Lisp},
1012 by Robert J. Chassell. You can find an order form on our web site at
1013 @url{http://www.gnu.org/order/order.html}. For further information,
1017 Free Software Foundation
1018 51 Franklin Street, Fifth Floor
1019 Boston, MA 02110-1301
1023 The income from distribution fees goes to support the foundation's
1024 purpose: the development of new free software, and improvements to our
1025 existing programs including GNU Emacs.
1027 If you find GNU Emacs useful, please @strong{send a donation} to the
1028 Free Software Foundation to support our work. Donations to the Free
1029 Software Foundation are tax deductible in the US. If you use GNU Emacs
1030 at your workplace, please suggest that the company make a donation. If
1031 company policy is unsympathetic to the idea of donating to charity, you
1032 might instead suggest ordering a CD-ROM from the Foundation
1033 occasionally, or subscribing to periodic updates.
1036 @node Acknowledgments, Intro, Distrib, Top
1037 @unnumberedsec Acknowledgments
1039 Contributors to GNU Emacs include Per Abrahamsen, Tomas Abrahamsson,
1040 Jay K.@: Adams, Joe Arceneaux, Miles Bader, David Bakhash, Eli
1041 Barzilay, Steven L.@: Baur, Boaz Ben-Zvi, Ray Blaak, Jim Blandy, Per
1042 Bothner, Terrence Brannon, Frank Bresz, Peter Breton, Emmanuel Briot,
1043 Kevin Broadey, Vincent Broman, David M.@: Brown, Georges Brun-Cottan,
1044 W@l{}odek Bzyl, Bill Carpenter, Per Cederqvist, Hans Chalupsky, Chris
1045 Chase, Bob Chassell, Andrew Choi, James Clark, Mike Clarkson, Glynn
1046 Clements, Andrew Csillag, Doug Cutting, Michael DeCorte, Gary Delp,
1047 Matthieu Devin, Eri Ding, Jan Dj@"{a}rv, Carsten Dominik, Scott
1048 Draves, Benjamin Drieu, Viktor Dukhovni, John Eaton, Rolf Ebert,
1049 Stephen Eglen, Torbj@"orn Einarsson, Tsugutomo Enami, Hans Henrik
1050 Eriksen, Michael Ernst, Ata Etemadi, Frederick Farnbach, Oscar
1051 Figueiredo, Fred Fish, Karl Fogel, Gary Foster, Noah Friedman,
1052 Hallvard Furuseth, Keith Gabryelski, Kevin Gallagher, Kevin Gallo,
1053 Juan Le@'{o}n Lahoz Garc@'{i}a, Howard Gayle, Stephen Gildea, Julien
1054 Gilles, David Gillespie, Bob Glickstein, Boris Goldowsky, Michelangelo
1055 Grigni, Odd Gripenstam, Kai Gro@ss{}johann, Michael Gschwind, Henry
1056 Guillaume, Doug Gwyn, Ken'ichi Handa, Chris Hanson, K. Shane Hartman,
1057 John Heidemann, Jon K.@: Hellan, Markus Heritsch, Karl Heuer, Manabu
1058 Higashida, Anders Holst, Kurt Hornik, Tom Houlder, Denis Howe, Lars
1059 Ingebrigtsen, Andrew Innes, Seiichiro Inoue, Ulf Jasper, Michael
1060 K. Johnson, Kyle Jones, Terry Jones, Simon Josefsson, Tomoji Kagatani,
1061 Brewster Kahle, David Kaufman, Henry Kautz, Taichi Kawabata, Howard
1062 Kaye, Michael Kifer, Richard King, Peter Kleiweg, Larry K.@: Kolodney,
1063 Pavel Kobiakov, Larry K.@: Kolodney, David M.@: Koppelman, Koseki
1064 Yoshinori, Robert Krawitz, Sebastian Kremer, Ryszard Kubiak, Geoff
1065 Kuenning, David K@aa{}gedal, Daniel LaLiberte, Aaron Larson, James
1066 R.@: Larus, Vinicius Jose Latorre, Frederic Lepied, Peter Liljenberg,
1067 Lars Lindberg, Chris Lindblad, Anders Lindgren, Thomas Link, Dave
1068 Love, Eric Ludlam, Alan Mackenzie, Christopher J.@: Madsen,
1069 Neil M.@: Mager, Ken Manheimer, Bill Mann, Brian Marick, Simon
1070 Marshall, Bengt Martensson, Charlie Martin, Thomas May, Roland McGrath,
1071 Will Mengarini, David Megginson, Wayne Mesard, Brad Miller, Richard
1072 Mlynarik, Gerd Moellmann, Stefan Monnier, Morioka Tomohiko, Keith
1073 Moore, Sen Nagata, Erik Naggum, Thomas Neumann, Thien-Thi Nguyen, Mike
1074 Newton, Jurgen Nickelsen, Dan Nicolaescu, Jeff Norden, Andrew Norman,
1075 Alexandre Oliva, Bob Olson, Takaaki Ota, Pieter E.@: J.@: Pareit,
1076 David Pearson, Jeff Peck, Damon Anton Permezel, Tom Perrine, William
1077 M.@: Perry, Per Persson, Jens Petersen, Daniel Pfeiffer, Richard
1078 L.@: Pieri, Fred Pierresteguy, Christian Plaunt, David Ponce, Francesco
1079 A. Potorti, Michael D. Prange, Mukesh Prasad, Marko Rahamaa, Ashwin
1080 Ram, Eric S. Raymond, Paul Reilly, Edward M. Reingold, Alex Rezinsky,
1081 Rob Riepel, Nick Roberts, Roland B.@: Roberts, John Robinson, Danny
1082 Roozendaal, William Rosenblatt, Guillermo J.@: Rozas, Ivar Rummelhoff,
1083 Jason Rumney, Wolfgang Rupprecht, Kevin Ryde, James B. Salem, Masahiko
1084 Sato, Holger Schauer, William Schelter, Ralph Schleicher, Gregor
1085 Schmid, Michael Schmidt, Ronald S. Schnell, Philippe Schnoebelen, Jan
1086 Schormann, Alex Schroeder, Stephen Schoef, Randal Schwartz, Oliver
1087 Seidel, Manuel Serrano, Hovav Shacham, Stanislav Shalunov, Mark
1088 Shapiro, Richard Sharman, Olin Shivers, Espen Skoglund, Rick Sladkey,
1089 Lynn Slater, Chris Smith, David Smith, Paul D.@: Smith, Andre Spiegel,
1090 Michael Staats, William Sommerfeld, Michael Staats, Sam Steingold, Ake
1091 Stenhoff, Peter Stephenson, Ken Stevens, Jonathan Stigelman, Martin
1092 Stjernholm, Kim F.@: Storm, Steve Strassman, Olaf Sylvester, Naoto
1093 Takahashi, Jean-Philippe Theberge, Jens T.@: Berger Thielemann,
1094 Spencer Thomas, Jim Thompson, Tom Tromey, Daiki Ueno, Masanobu Umeda,
1095 Rajesh Vaidheeswarran, Neil W.@: Van Dyke, Didier Verna, Ulrik Vieth,
1096 Geoffrey Voelker, Johan Vromans, Inge Wallin, Colin Walters, Barry
1097 Warsaw, Morten Welinder, Joseph Brian Wells, Rodney Whitby, John
1098 Wiegley, Ed Wilkinson, Mike Williams, Bill Wohler, Steven A. Wood,
1099 Dale R.@: Worley, Francis J.@: Wright, Felix S. T. Wu, Tom Wurgler,
1100 Masatake Yamato, Jonathan Yavner, Ilya Zakharevich, Milan Zamazal,
1101 Victor Zandy, Eli Zaretskii, Jamie Zawinski, Shenghuo Zhu, Ian
1102 T.@: Zimmermann, Reto Zimmermann, Neal Ziring, and Detlev Zundel.
1105 @node Intro, Glossary, Distrib, Top
1106 @unnumbered Introduction
1108 You are reading about GNU Emacs, the GNU incarnation of the advanced,
1109 self-documenting, customizable, extensible real-time display editor Emacs.
1110 (The `G' in `GNU' is not silent.)
1112 We say that Emacs is a @dfn{display} editor because normally the text
1113 being edited is visible on the screen and is updated automatically as you
1114 type your commands. @xref{Screen,Display}.
1116 We call it a @dfn{real-time} editor because the display is updated very
1117 frequently, usually after each character or pair of characters you
1118 type. This minimizes the amount of information you must keep in your
1119 head as you edit. @xref{Basic,Real-time,Basic Editing}.
1121 We call Emacs advanced because it provides facilities that go beyond
1122 simple insertion and deletion: controlling subprocesses; automatic
1123 indentation of programs; viewing two or more files at once; editing
1124 formatted text; and dealing in terms of characters, words, lines,
1125 sentences, paragraphs, and pages, as well as expressions and comments in
1126 several different programming languages.
1128 @dfn{Self-documenting} means that at any time you can type a special
1129 character, @kbd{Control-h}, to find out what your options are. You can
1130 also use it to find out what any command does, or to find all the commands
1131 that pertain to a topic. @xref{Help}.
1133 @dfn{Customizable} means that you can change the definitions of Emacs
1134 commands in little ways. For example, if you use a programming language in
1135 which comments start with @samp{<**} and end with @samp{**>}, you can tell
1136 the Emacs comment manipulation commands to use those strings
1137 (@pxref{Comments}). Another sort of customization is rearrangement of the
1138 command set. For example, if you prefer the four basic cursor motion
1139 commands (up, down, left and right) on keys in a diamond pattern on the
1140 keyboard, you can rebind the keys that way. @xref{Customization}.
1142 @dfn{Extensible} means that you can go beyond simple customization and
1143 write entirely new commands, programs in the Lisp language to be run by
1144 Emacs's own Lisp interpreter. Emacs is an ``on-line extensible''
1145 system, which means that it is divided into many functions that call
1146 each other, any of which can be redefined in the middle of an editing
1147 session. Almost any part of Emacs can be replaced without making a
1148 separate copy of all of Emacs. Most of the editing commands of Emacs
1149 are written in Lisp; the few exceptions could have been written
1150 in Lisp but are written in C for efficiency. Although only a programmer
1151 can write an extension, anybody can use it afterward. @xref{Top,
1152 Emacs Lisp Intro, Preface, eintr, An Introduction to Programming in
1153 Emacs Lisp}, if you want to learn Emacs Lisp programming.
1155 When running on a graphics terminal, Emacs provides its own menus
1156 and convenient handling of mouse buttons. But Emacs provides many of
1157 the benefits of a window system even on a text-only terminal. For
1158 instance, you can look at or edit several files at once, move text
1159 between files, and edit files while running shell commands.
1161 @include screen.texi
1162 @include commands.texi
1163 @include entering.texi
1169 @include killing.texi
1171 @include display.texi
1172 @include search.texi
1174 @include kmacro.texi
1176 @include buffers.texi
1177 @include windows.texi
1178 @include frames.texi
1181 @include indent.texi
1183 @include programs.texi
1184 @include building.texi
1185 @include maintaining.texi
1186 @include abbrevs.texi
1187 @include picture.texi
1188 @include sending.texi
1191 @include calendar.texi
1193 @include custom.texi
1194 @include trouble.texi
1196 @node Copying, GNU Free Documentation License, Service, Top
1197 @appendix GNU GENERAL PUBLIC LICENSE
1198 @center Version 2, June 1991
1201 Copyright @copyright{} 1989, 1991 Free Software Foundation, Inc.
1202 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
1204 Everyone is permitted to copy and distribute verbatim copies
1205 of this license document, but changing it is not allowed.
1208 @unnumberedsec Preamble
1210 The licenses for most software are designed to take away your
1211 freedom to share and change it. By contrast, the GNU General Public
1212 License is intended to guarantee your freedom to share and change free
1213 software---to make sure the software is free for all its users. This
1214 General Public License applies to most of the Free Software
1215 Foundation's software and to any other program whose authors commit to
1216 using it. (Some other Free Software Foundation software is covered by
1217 the GNU Library General Public License instead.) You can apply it to
1220 When we speak of free software, we are referring to freedom, not
1221 price. Our General Public Licenses are designed to make sure that you
1222 have the freedom to distribute copies of free software (and charge for
1223 this service if you wish), that you receive source code or can get it
1224 if you want it, that you can change the software or use pieces of it
1225 in new free programs; and that you know you can do these things.
1227 To protect your rights, we need to make restrictions that forbid
1228 anyone to deny you these rights or to ask you to surrender the rights.
1229 These restrictions translate to certain responsibilities for you if you
1230 distribute copies of the software, or if you modify it.
1232 For example, if you distribute copies of such a program, whether
1233 gratis or for a fee, you must give the recipients all the rights that
1234 you have. You must make sure that they, too, receive or can get the
1235 source code. And you must show them these terms so they know their
1238 We protect your rights with two steps: (1) copyright the software, and
1239 (2) offer you this license which gives you legal permission to copy,
1240 distribute and/or modify the software.
1242 Also, for each author's protection and ours, we want to make certain
1243 that everyone understands that there is no warranty for this free
1244 software. If the software is modified by someone else and passed on, we
1245 want its recipients to know that what they have is not the original, so
1246 that any problems introduced by others will not reflect on the original
1247 authors' reputations.
1249 Finally, any free program is threatened constantly by software
1250 patents. We wish to avoid the danger that redistributors of a free
1251 program will individually obtain patent licenses, in effect making the
1252 program proprietary. To prevent this, we have made it clear that any
1253 patent must be licensed for everyone's free use or not licensed at all.
1255 The precise terms and conditions for copying, distribution and
1256 modification follow.
1259 @unnumberedsec TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
1262 @center TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
1267 This License applies to any program or other work which contains
1268 a notice placed by the copyright holder saying it may be distributed
1269 under the terms of this General Public License. The ``Program,'' below,
1270 refers to any such program or work, and a ``work based on the Program''
1271 means either the Program or any derivative work under copyright law:
1272 that is to say, a work containing the Program or a portion of it,
1273 either verbatim or with modifications and/or translated into another
1274 language. (Hereinafter, translation is included without limitation in
1275 the term ``modification.'') Each licensee is addressed as ``you.''
1277 Activities other than copying, distribution and modification are not
1278 covered by this License; they are outside its scope. The act of
1279 running the Program is not restricted, and the output from the Program
1280 is covered only if its contents constitute a work based on the
1281 Program (independent of having been made by running the Program).
1282 Whether that is true depends on what the Program does.
1285 You may copy and distribute verbatim copies of the Program's
1286 source code as you receive it, in any medium, provided that you
1287 conspicuously and appropriately publish on each copy an appropriate
1288 copyright notice and disclaimer of warranty; keep intact all the
1289 notices that refer to this License and to the absence of any warranty;
1290 and give any other recipients of the Program a copy of this License
1291 along with the Program.
1293 You may charge a fee for the physical act of transferring a copy, and
1294 you may at your option offer warranty protection in exchange for a fee.
1297 You may modify your copy or copies of the Program or any portion
1298 of it, thus forming a work based on the Program, and copy and
1299 distribute such modifications or work under the terms of Section 1
1300 above, provided that you also meet all of these conditions:
1304 You must cause the modified files to carry prominent notices
1305 stating that you changed the files and the date of any change.
1308 You must cause any work that you distribute or publish, that in
1309 whole or in part contains or is derived from the Program or any
1310 part thereof, to be licensed as a whole at no charge to all third
1311 parties under the terms of this License.
1314 If the modified program normally reads commands interactively
1315 when run, you must cause it, when started running for such
1316 interactive use in the most ordinary way, to print or display an
1317 announcement including an appropriate copyright notice and a
1318 notice that there is no warranty (or else, saying that you provide
1319 a warranty) and that users may redistribute the program under
1320 these conditions, and telling the user how to view a copy of this
1321 License. (Exception: if the Program itself is interactive but
1322 does not normally print such an announcement, your work based on
1323 the Program is not required to print an announcement.)
1326 These requirements apply to the modified work as a whole. If
1327 identifiable sections of that work are not derived from the Program,
1328 and can be reasonably considered independent and separate works in
1329 themselves, then this License, and its terms, do not apply to those
1330 sections when you distribute them as separate works. But when you
1331 distribute the same sections as part of a whole which is a work based
1332 on the Program, the distribution of the whole must be on the terms of
1333 this License, whose permissions for other licensees extend to the
1334 entire whole, and thus to each and every part regardless of who wrote it.
1336 Thus, it is not the intent of this section to claim rights or contest
1337 your rights to work written entirely by you; rather, the intent is to
1338 exercise the right to control the distribution of derivative or
1339 collective works based on the Program.
1341 In addition, mere aggregation of another work not based on the Program
1342 with the Program (or with a work based on the Program) on a volume of
1343 a storage or distribution medium does not bring the other work under
1344 the scope of this License.
1347 You may copy and distribute the Program (or a work based on it,
1348 under Section 2) in object code or executable form under the terms of
1349 Sections 1 and 2 above provided that you also do one of the following:
1353 Accompany it with the complete corresponding machine-readable
1354 source code, which must be distributed under the terms of Sections
1355 1 and 2 above on a medium customarily used for software interchange; or,
1358 Accompany it with a written offer, valid for at least three
1359 years, to give any third party, for a charge no more than your
1360 cost of physically performing source distribution, a complete
1361 machine-readable copy of the corresponding source code, to be
1362 distributed under the terms of Sections 1 and 2 above on a medium
1363 customarily used for software interchange; or,
1366 Accompany it with the information you received as to the offer
1367 to distribute corresponding source code. (This alternative is
1368 allowed only for noncommercial distribution and only if you
1369 received the program in object code or executable form with such
1370 an offer, in accord with Subsection b above.)
1373 The source code for a work means the preferred form of the work for
1374 making modifications to it. For an executable work, complete source
1375 code means all the source code for all modules it contains, plus any
1376 associated interface definition files, plus the scripts used to
1377 control compilation and installation of the executable. However, as a
1378 special exception, the source code distributed need not include
1379 anything that is normally distributed (in either source or binary
1380 form) with the major components (compiler, kernel, and so on) of the
1381 operating system on which the executable runs, unless that component
1382 itself accompanies the executable.
1384 If distribution of executable or object code is made by offering
1385 access to copy from a designated place, then offering equivalent
1386 access to copy the source code from the same place counts as
1387 distribution of the source code, even though third parties are not
1388 compelled to copy the source along with the object code.
1391 You may not copy, modify, sublicense, or distribute the Program
1392 except as expressly provided under this License. Any attempt
1393 otherwise to copy, modify, sublicense or distribute the Program is
1394 void, and will automatically terminate your rights under this License.
1395 However, parties who have received copies, or rights, from you under
1396 this License will not have their licenses terminated so long as such
1397 parties remain in full compliance.
1400 You are not required to accept this License, since you have not
1401 signed it. However, nothing else grants you permission to modify or
1402 distribute the Program or its derivative works. These actions are
1403 prohibited by law if you do not accept this License. Therefore, by
1404 modifying or distributing the Program (or any work based on the
1405 Program), you indicate your acceptance of this License to do so, and
1406 all its terms and conditions for copying, distributing or modifying
1407 the Program or works based on it.
1410 Each time you redistribute the Program (or any work based on the
1411 Program), the recipient automatically receives a license from the
1412 original licensor to copy, distribute or modify the Program subject to
1413 these terms and conditions. You may not impose any further
1414 restrictions on the recipients' exercise of the rights granted herein.
1415 You are not responsible for enforcing compliance by third parties to
1419 If, as a consequence of a court judgment or allegation of patent
1420 infringement or for any other reason (not limited to patent issues),
1421 conditions are imposed on you (whether by court order, agreement or
1422 otherwise) that contradict the conditions of this License, they do not
1423 excuse you from the conditions of this License. If you cannot
1424 distribute so as to satisfy simultaneously your obligations under this
1425 License and any other pertinent obligations, then as a consequence you
1426 may not distribute the Program at all. For example, if a patent
1427 license would not permit royalty-free redistribution of the Program by
1428 all those who receive copies directly or indirectly through you, then
1429 the only way you could satisfy both it and this License would be to
1430 refrain entirely from distribution of the Program.
1432 If any portion of this section is held invalid or unenforceable under
1433 any particular circumstance, the balance of the section is intended to
1434 apply and the section as a whole is intended to apply in other
1437 It is not the purpose of this section to induce you to infringe any
1438 patents or other property right claims or to contest validity of any
1439 such claims; this section has the sole purpose of protecting the
1440 integrity of the free software distribution system, which is
1441 implemented by public license practices. Many people have made
1442 generous contributions to the wide range of software distributed
1443 through that system in reliance on consistent application of that
1444 system; it is up to the author/donor to decide if he or she is willing
1445 to distribute software through any other system and a licensee cannot
1448 This section is intended to make thoroughly clear what is believed to
1449 be a consequence of the rest of this License.
1452 If the distribution and/or use of the Program is restricted in
1453 certain countries either by patents or by copyrighted interfaces, the
1454 original copyright holder who places the Program under this License
1455 may add an explicit geographical distribution limitation excluding
1456 those countries, so that distribution is permitted only in or among
1457 countries not thus excluded. In such case, this License incorporates
1458 the limitation as if written in the body of this License.
1461 The Free Software Foundation may publish revised and/or new versions
1462 of the General Public License from time to time. Such new versions will
1463 be similar in spirit to the present version, but may differ in detail to
1464 address new problems or concerns.
1466 Each version is given a distinguishing version number. If the Program
1467 specifies a version number of this License which applies to it and ``any
1468 later version,'' you have the option of following the terms and conditions
1469 either of that version or of any later version published by the Free
1470 Software Foundation. If the Program does not specify a version number of
1471 this License, you may choose any version ever published by the Free Software
1475 If you wish to incorporate parts of the Program into other free
1476 programs whose distribution conditions are different, write to the author
1477 to ask for permission. For software which is copyrighted by the Free
1478 Software Foundation, write to the Free Software Foundation; we sometimes
1479 make exceptions for this. Our decision will be guided by the two goals
1480 of preserving the free status of all derivatives of our free software and
1481 of promoting the sharing and reuse of software generally.
1484 @heading NO WARRANTY
1491 BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
1492 FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW@. EXCEPT WHEN
1493 OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
1494 PROVIDE THE PROGRAM ``AS IS'' WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
1495 OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
1496 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE@. THE ENTIRE RISK AS
1497 TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU@. SHOULD THE
1498 PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
1499 REPAIR OR CORRECTION.
1502 IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
1503 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
1504 REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
1505 INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
1506 OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
1507 TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
1508 YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
1509 PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
1510 POSSIBILITY OF SUCH DAMAGES.
1514 @heading END OF TERMS AND CONDITIONS
1517 @center END OF TERMS AND CONDITIONS
1521 @unnumberedsec How to Apply These Terms to Your New Programs
1523 If you develop a new program, and you want it to be of the greatest
1524 possible use to the public, the best way to achieve this is to make it
1525 free software which everyone can redistribute and change under these terms.
1527 To do so, attach the following notices to the program. It is safest
1528 to attach them to the start of each source file to most effectively
1529 convey the exclusion of warranty; and each file should have at least
1530 the ``copyright'' line and a pointer to where the full notice is found.
1533 @var{one line to give the program's name and an idea of what it does.}
1534 Copyright (C) 19@var{yy} @var{name of author}
1536 This program is free software; you can redistribute it and/or
1537 modify it under the terms of the GNU General Public License
1538 as published by the Free Software Foundation; either version 2
1539 of the License, or (at your option) any later version.
1541 This program is distributed in the hope that it will be useful,
1542 but WITHOUT ANY WARRANTY; without even the implied warranty of
1543 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE@. See the
1544 GNU General Public License for more details.
1546 You should have received a copy of the GNU General Public License along
1547 with this program; if not, write to the Free Software Foundation, Inc.,
1548 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
1551 Also add information on how to contact you by electronic and paper mail.
1553 If the program is interactive, make it output a short notice like this
1554 when it starts in an interactive mode:
1557 Gnomovision version 69, Copyright (C) 20@var{yy} @var{name of author}
1558 Gnomovision comes with ABSOLUTELY NO WARRANTY; for details
1559 type `show w'. This is free software, and you are welcome
1560 to redistribute it under certain conditions; type `show c'
1564 The hypothetical commands @samp{show w} and @samp{show c} should show
1565 the appropriate parts of the General Public License. Of course, the
1566 commands you use may be called something other than @samp{show w} and
1567 @samp{show c}; they could even be mouse-clicks or menu items---whatever
1570 You should also get your employer (if you work as a programmer) or your
1571 school, if any, to sign a ``copyright disclaimer'' for the program, if
1572 necessary. Here is a sample; alter the names:
1576 Yoyodyne, Inc., hereby disclaims all copyright
1577 interest in the program `Gnomovision'
1578 (which makes passes at compilers) written
1581 @var{signature of Ty Coon}, 1 April 1989
1582 Ty Coon, President of Vice
1586 This General Public License does not permit incorporating your program into
1587 proprietary programs. If your program is a subroutine library, you may
1588 consider it more useful to permit linking proprietary applications with the
1589 library. If this is what you want to do, use the GNU Library General
1590 Public License instead of this License.
1592 @include doclicense.texi
1593 @include cmdargs.texi
1594 @include xresources.texi
1600 @include glossary.texi
1605 @c The Option Index is produced only in the on-line version,
1606 @c because the index entries related to command-line options
1607 @c tend to point to the same pages and all begin with a dash.
1608 @c This, and the need to keep the node links consistent, are
1609 @c the reasons for the funky @iftex/@ifnottex dance below.
1610 @c The Option Index is _not_ before Key Index, because that
1611 @c would require changes in the glossary.texi's @node line.
1612 @c It is not after Concept Index for similar reasons.
1615 @node Key Index, Command Index, Glossary, Top
1616 @unnumbered Key (Character) Index
1621 @node Key Index, Option Index, Glossary, Top
1622 @unnumbered Key (Character) Index
1625 @node Option Index, Command Index, Key Index, Top
1626 @unnumbered Command-Line Options Index
1629 @node Command Index, Variable Index, Option Index, Top
1630 @unnumbered Command and Function Index
1635 @node Command Index, Variable Index, Key Index, Top
1636 @unnumbered Command and Function Index
1640 @node Variable Index, Concept Index, Command Index, Top
1641 @unnumbered Variable Index
1644 @node Concept Index, Acknowledgments, Variable Index, Top
1645 @unnumbered Concept Index
1653 arch-tag: ed48740a-410b-46ea-9387-c9a9252a3392