1 \input texinfo @c -*- coding: iso-latin-1 -*-
3 @setfilename ../../info/emacs
4 @settitle GNU Emacs Manual
6 @c The edition number appears in several places in this file
11 This is the @value{EDITION} edition of the @cite{GNU Emacs Manual},@*
12 updated for Emacs version @value{EMACSVER}.
14 Copyright @copyright{} 1985-1987, 1993-2011 Free Software Foundation, Inc.
17 Permission is granted to copy, distribute and/or modify this document
18 under the terms of the GNU Free Documentation License, Version 1.3 or
19 any later version published by the Free Software Foundation; with the
20 Invariant Sections being ``The GNU Manifesto,'' ``Distribution'' and
21 ``GNU GENERAL PUBLIC LICENSE,'' with the Front-Cover texts being ``A GNU
22 Manual,'' and with the Back-Cover Texts as in (a) below. A copy of the
23 license is included in the section entitled ``GNU Free Documentation
26 (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
27 modify this GNU manual. Buying copies from the FSF supports it in
28 developing GNU and promoting software freedom.''
32 @documentencoding ISO-8859-1
36 * Emacs: (emacs). The extensible self-documenting text editor.
39 @c in general, keep the following line commented out, unless doing a
40 @c copy of this manual that will be published. The manual should go
41 @c onto the distribution in the full, 8.5 x 11" size.
48 @c per rms and peterb, use 10pt fonts for the main text, mostly to
49 @c save on paper cost.
50 @c Do this inside @tex for now, so current makeinfo does not complain.
54 \global\let\urlcolor=\Black % don't print links in grayscale
55 \global\let\linkcolor=\Black
57 \global\hbadness=6666 % don't worry about not-too-underfull boxes
66 @shorttitlepage GNU Emacs Manual
71 @center @titlefont{GNU Emacs Manual}
73 @center @value{EDITION} Edition, Updated for Emacs Version @value{EMACSVER}.
75 @center Richard Stallman
77 @vskip 0pt plus 1filll
81 Published by the Free Software Foundation @*
82 51 Franklin Street, Fifth Floor @*
83 Boston, MA 02110-1301 USA @*
87 Cover art by Etienne Suvasa.
97 @node Top, Distrib, (dir), (dir)
100 Emacs is the extensible, customizable, self-documenting real-time
101 display editor. This Info file describes how to edit with Emacs and
102 some of how to customize it; it corresponds to GNU Emacs version
106 To learn more about the Info documentation system, type @kbd{h},
107 to visit a programmed instruction sequence for the Info commands.
110 For information on extending Emacs, see @ref{Top, Emacs Lisp,, elisp, The
111 Emacs Lisp Reference Manual}.
117 * Distrib:: How to get the latest Emacs distribution.
118 * Intro:: An introduction to Emacs concepts.
119 @c Note that in the printed manual, the glossary and indices come last.
120 * Glossary:: Terms used in this manual.
122 Indexes (each index contains a large menu)
123 * Key Index:: An item for each standard Emacs key sequence.
124 * Option Index:: An item for every command-line option.
125 * Command Index:: An item for each command name.
126 * Variable Index:: An item for each documented variable.
127 * Concept Index:: An item for each concept.
129 * Acknowledgments:: Major contributors to GNU Emacs.
131 Important General Concepts
132 * Screen:: How to interpret what you see on the screen.
133 * User Input:: Kinds of input events (characters, buttons,
135 * Keys:: Key sequences: what you type to request one
137 * Commands:: Named functions run by key sequences to do editing.
138 * Entering Emacs:: Starting Emacs from the shell.
139 * Exiting:: Stopping or killing Emacs.
141 Fundamental Editing Commands
142 * Basic:: The most basic editing commands.
143 * Minibuffer:: Entering arguments that are prompted for.
144 * M-x:: Invoking commands by their names.
145 * Help:: Commands for asking Emacs about its commands.
147 Important Text-Changing Commands
148 * Mark:: The mark: how to delimit a "region" of text.
149 * Killing:: Killing (cutting) text.
150 * Yanking:: Recovering killed text. Moving text. (Pasting.)
151 * Cut and Paste:: Clipboard and selections on graphical displays.
152 * Accumulating Text:: Other ways of copying text.
153 * Rectangles:: Operating on text in rectangular areas.
154 * CUA Bindings:: Using @kbd{C-x}, @kbd{C-c}, @kbd{C-v} to kill and yank.
155 * Registers:: Saving a text string or a location in the buffer.
156 * Display:: Controlling what text is displayed.
157 * Search:: Finding or replacing occurrences of a string.
158 * Fixit:: Commands especially useful for fixing typos.
159 * Keyboard Macros:: Recording a sequence of keystrokes to be replayed.
161 Major Structures of Emacs
162 * Files:: All about handling files.
163 * Buffers:: Multiple buffers; editing several files at once.
164 * Windows:: Viewing two pieces of text at once.
165 * Frames:: Running the same Emacs session in multiple X windows.
166 * International:: Using non-@acronym{ASCII} character sets.
169 * Modes:: Major and minor modes alter Emacs' basic behavior.
170 * Indentation:: Editing the white space at the beginnings of lines.
171 * Text:: Commands and modes for editing human languages.
172 * Programs:: Commands and modes for editing programs.
173 * Building:: Compiling, running and debugging programs.
174 * Maintaining:: Features for maintaining large programs.
175 * Abbrevs:: Defining text abbreviations to reduce
176 the number of characters you must type.
177 * Dired:: Directory and file manager.
178 * Calendar/Diary:: Calendar and diary facilities.
179 * Sending Mail:: Sending mail in Emacs.
180 * Rmail:: Reading mail in Emacs.
181 * Gnus:: A flexible mail and news reader.
182 * Document View:: Viewing PDF, PS and DVI files.
183 * Shell:: Executing shell commands from Emacs.
184 * Emacs Server:: Using Emacs as an editing server.
185 * Printing:: Printing hardcopies of buffers or regions.
186 * Sorting:: Sorting lines, paragraphs or pages within Emacs.
188 * Picture Mode:: Editing pictures made up of text characters.
190 * Editing Binary Files:: Editing binary files with Hexl mode.
191 * Saving Emacs Sessions:: Saving Emacs state from one session to the next.
192 * Recursive Edit:: Performing edits while "within another command".
193 * Emulation:: Emulating some other editors with Emacs.
194 * Hyperlinking:: Following links in buffers.
195 * Amusements:: Various games and hacks.
196 * Packages:: Installing additional features.
197 * Customization:: Modifying the behavior of Emacs.
199 Recovery from Problems
200 * Quitting:: Quitting and aborting.
201 * Lossage:: What to do if Emacs is hung or malfunctioning.
202 * Bugs:: How and when to report a bug.
203 * Contributing:: How to contribute improvements to Emacs.
204 * Service:: How to get help for your own Emacs needs.
207 * Copying:: The GNU General Public License gives you permission
208 to redistribute GNU Emacs on certain terms;
209 it also explains that there is no warranty.
210 * GNU Free Documentation License:: The license for this documentation.
211 * Emacs Invocation:: Hairy startup options.
212 * X Resources:: X resources for customizing Emacs.
213 * Antinews:: Information about Emacs version 22.
214 * Mac OS / GNUstep:: Using Emacs under Mac OS and GNUstep.
215 * Microsoft Windows:: Using Emacs on Microsoft Windows and MS-DOS.
216 * Manifesto:: What's GNU? Gnu's Not Unix!
218 @c Do NOT modify the following 3 lines! They must have this form to
219 @c be correctly identified by `texinfo-multiple-files-update'. In
220 @c particular, the detailed menu header line MUST be identical to the
221 @c value of `texinfo-master-menu-header'. See texnfo-upd.el.
224 --- The Detailed Node Listing ---
225 ---------------------------------
227 Here are some other nodes which are really subnodes of the ones
228 already listed, mentioned here so you can get to them in one step:
230 The Organization of the Screen
232 * Point:: The place in the text where editing commands operate.
233 * Echo Area:: Short messages appear at the bottom of the screen.
234 * Mode Line:: Interpreting the mode line.
235 * Menu Bar:: How to use the menu bar.
237 Basic Editing Commands
239 * Inserting Text:: Inserting text by simply typing it.
240 * Moving Point:: Moving the cursor to the place where you want to
242 * Erasing:: Deleting and killing text.
243 * Basic Undo:: Undoing recent changes in the text.
244 * Basic Files:: Visiting, creating, and saving files.
245 * Basic Help:: Asking what a character does.
246 * Blank Lines:: Making and deleting blank lines.
247 * Continuation Lines:: How Emacs displays lines too wide for the screen.
248 * Position Info:: What line, row, or column is point on?
249 * Arguments:: Numeric arguments for repeating a command N times.
250 * Repeating:: Repeating the previous command quickly.
254 * Minibuffer File:: Entering file names with the minibuffer.
255 * Minibuffer Edit:: How to edit in the minibuffer.
256 * Completion:: An abbreviation facility for minibuffer input.
257 * Minibuffer History:: Reusing recent minibuffer arguments.
258 * Repetition:: Re-executing commands that used the minibuffer.
259 * Passwords:: Entering passwords in the echo area.
263 * Completion Example:: Examples of using completion.
264 * Completion Commands:: A list of completion commands.
265 * Completion Exit:: Completion and minibuffer text submission.
266 * Completion Styles:: How completion matches are chosen.
267 * Completion Options:: Options for completion.
271 * Help Summary:: Brief list of all Help commands.
272 * Key Help:: Asking what a key does in Emacs.
273 * Name Help:: Asking about a command, variable or function name.
274 * Apropos:: Asking what pertains to a given topic.
275 * Help Mode:: Special features of Help mode and Help buffers.
276 * Package Keywords:: Finding Lisp libraries by keywords (topics).
277 * Language Help:: Help relating to international language support.
278 * Misc Help:: Other help commands.
279 * Help Files:: Commands to display auxiliary help files.
280 * Help Echo:: Help on active text and tooltips (`balloon help').
282 The Mark and the Region
284 * Setting Mark:: Commands to set the mark.
285 * Marking Objects:: Commands to put region around textual units.
286 * Using Region:: Summary of ways to operate on contents of the region.
287 * Mark Ring:: Previous mark positions saved so you can go back there.
288 * Global Mark Ring:: Previous mark positions in various buffers.
289 * Shift Selection:: Using shifted cursor motion keys.
290 * Disabled Transient Mark:: Leaving regions unhighlighted by default.
292 Killing and Moving Text
294 * Deletion:: Commands for deleting small amounts of text and
296 * Killing by Lines:: How to kill entire lines of text at one time.
297 * Other Kill Commands:: Commands to kill large regions of text and
298 syntactic units such as words and sentences.
299 * Kill Options:: Options that affect killing.
303 * Kill Ring:: Where killed text is stored.
304 * Earlier Kills:: Yanking something killed some time ago.
305 * Appending Kills:: Several kills in a row all yank together.
307 Killing and Yanking on Graphical Displays
309 * Clipboard:: How Emacs interacts with the system clipboard.
310 * Primary Selection:: The temporarily selected text selection.
311 * Secondary Selection:: Cutting without altering point and mark.
315 * Position Registers:: Saving positions in registers.
316 * Text Registers:: Saving text in registers.
317 * Rectangle Registers:: Saving rectangles in registers.
318 * Configuration Registers:: Saving window configurations in registers.
319 * Number Registers:: Numbers in registers.
320 * File Registers:: File names in registers.
321 * Bookmarks:: Bookmarks are like registers, but persistent.
323 Controlling the Display
325 * Scrolling:: Commands to move text up and down in a window.
326 * Recentering:: A scrolling command that centers the current line.
327 * Auto Scrolling:: Redisplay scrolls text automatically when needed.
328 * Horizontal Scrolling:: Moving text left and right in a window.
329 * Narrowing:: Restricting display and editing to a portion
331 * View Mode:: Viewing read-only buffers.
332 * Follow Mode:: Follow mode lets two windows scroll as one.
333 * Faces:: How to change the display style using faces.
334 * Colors:: Specifying colors for faces.
335 * Standard Faces:: Emacs' predefined faces.
336 * Text Scale:: Increasing or decreasing text size in a buffer.
337 * Font Lock:: Minor mode for syntactic highlighting using faces.
338 * Highlight Interactively:: Tell Emacs what text to highlight.
339 * Fringes:: Enabling or disabling window fringes.
340 * Displaying Boundaries:: Displaying top and bottom of the buffer.
341 * Useless Whitespace:: Showing possibly-spurious trailing whitespace.
342 * Selective Display:: Hiding lines with lots of indentation.
343 * Optional Mode Line:: Optional mode line display features.
344 * Text Display:: How text characters are normally displayed.
345 * Cursor Display:: Features for displaying the cursor.
346 * Line Truncation:: Truncating lines to fit the screen width instead
347 of continuing them to multiple screen lines.
348 * Visual Line Mode:: Word wrap and screen line-based editing.
349 * Display Custom:: Information on variables for customizing display.
351 Searching and Replacement
353 * Incremental Search:: Search happens as you type the string.
354 * Nonincremental Search:: Specify entire string and then search.
355 * Word Search:: Search for sequence of words.
356 * Regexp Search:: Search for match for a regexp.
357 * Regexps:: Syntax of regular expressions.
358 * Regexp Backslash:: Regular expression constructs starting with `\'.
359 * Regexp Example:: A complex regular expression explained.
360 * Search Case:: To ignore case while searching, or not.
361 * Replace:: Search, and replace some or all matches.
362 * Other Repeating Search:: Operating on all matches for some regexp.
366 * Basic Isearch:: Basic incremental search commands.
367 * Repeat Isearch:: Searching for the same string again.
368 * Error in Isearch:: When your string is not found.
369 * Special Isearch:: Special input in incremental search.
370 * Isearch Yank:: Commands that grab text into the search string
371 or else edit the search string.
372 * Isearch Scroll:: Scrolling during an incremental search.
373 * Isearch Minibuffer:: Incremental search of the minibuffer history.
377 * Unconditional Replace:: Replacing all matches for a string.
378 * Regexp Replace:: Replacing all matches for a regexp.
379 * Replacement and Case:: How replacements preserve case of letters.
380 * Query Replace:: How to use querying.
382 Commands for Fixing Typos
384 * Undo:: The Undo commands.
385 * Transpose:: Exchanging two characters, words, lines, lists...
386 * Fixing Case:: Correcting case of last word entered.
387 * Spelling:: Apply spelling checker to a word, or a whole file.
391 * Basic Keyboard Macro:: Defining and running keyboard macros.
392 * Keyboard Macro Ring:: Where previous keyboard macros are saved.
393 * Keyboard Macro Counter:: Inserting incrementing numbers in macros.
394 * Keyboard Macro Query:: Making keyboard macros do different things each time.
395 * Save Keyboard Macro:: Giving keyboard macros names; saving them in files.
396 * Edit Keyboard Macro:: Editing keyboard macros.
397 * Keyboard Macro Step-Edit:: Interactively executing and editing a keyboard
402 * File Names:: How to type and edit file-name arguments.
403 * Visiting:: Visiting a file prepares Emacs to edit the file.
404 * Saving:: Saving makes your changes permanent.
405 * Reverting:: Reverting cancels all the changes not saved.
406 * Autorevert:: Auto Reverting non-file buffers.
407 * Auto Save:: Auto Save periodically protects against loss of data.
408 * File Aliases:: Handling multiple names for one file.
409 * Directories:: Creating, deleting, and listing file directories.
410 * Comparing Files:: Finding where two files differ.
411 * Diff Mode:: Mode for editing file differences.
412 * Misc File Ops:: Other things you can do on files.
413 * Compressed Files:: Accessing compressed files.
414 * File Archives:: Operating on tar, zip, jar etc. archive files.
415 * Remote Files:: Accessing files on other sites.
416 * Quoted File Names:: Quoting special characters in file names.
417 * File Name Cache:: Completion against a list of files you often use.
418 * File Conveniences:: Convenience Features for Finding Files.
419 * Filesets:: Handling sets of files.
423 * Save Commands:: Commands for saving files.
424 * Backup:: How Emacs saves the old version of your file.
425 * Customize Save:: Customizing the saving of files.
426 * Interlocking:: How Emacs protects against simultaneous editing
427 of one file by two users.
428 * File Shadowing:: Copying files to "shadows" automatically.
429 * Time Stamps:: Emacs can update time stamps on saved files.
433 * Backup Names:: How backup files are named.
434 * Backup Deletion:: Emacs deletes excess numbered backups.
435 * Backup Copying:: Backups can be made by copying or renaming.
437 Auto Reverting Non-File Buffers
439 * Auto Reverting the Buffer Menu:: Auto Revert of the Buffer Menu.
440 * Auto Reverting Dired:: Auto Revert of Dired buffers.
441 * Supporting additional buffers:: How to add more Auto Revert support.
443 Auto-Saving: Protection Against Disasters
445 * Auto Save Files:: The file where auto-saved changes are
446 actually made until you save the file.
447 * Auto Save Control:: Controlling when and how often to auto-save.
448 * Recover:: Recovering text from auto-save files.
450 Using Multiple Buffers
452 * Select Buffer:: Creating a new buffer or reselecting an old one.
453 * List Buffers:: Getting a list of buffers that exist.
454 * Misc Buffer:: Renaming; changing read-onlyness; copying text.
455 * Kill Buffer:: Killing buffers you no longer need.
456 * Several Buffers:: How to go through the list of all buffers
457 and operate variously on several of them.
458 * Indirect Buffers:: An indirect buffer shares the text of another buffer.
459 * Buffer Convenience:: Convenience and customization features for
462 Convenience Features and Customization of Buffer Handling
464 * Uniquify:: Making buffer names unique with directory parts.
465 * Iswitchb:: Switching between buffers with substrings.
466 * Buffer Menus:: Configurable buffer menu.
470 * Basic Window:: Introduction to Emacs windows.
471 * Split Window:: New windows are made by splitting existing windows.
472 * Other Window:: Moving to another window or doing something to it.
473 * Pop Up Window:: Finding a file or buffer in another window.
474 * Change Window:: Deleting windows and changing their sizes.
475 * Displaying Buffers:: How Emacs picks a window for displaying a buffer.
476 * Window Convenience:: Convenience functions for window handling.
478 Frames and Graphical Displays
480 * Mouse Commands:: Moving, cutting, and pasting, with the mouse.
481 * Word and Line Mouse:: Mouse commands for selecting whole words or lines.
482 * Mouse References:: Using the mouse to select an item from a list.
483 * Menu Mouse Clicks:: Mouse clicks that bring up menus.
484 * Mode Line Mouse:: Mouse clicks on the mode line.
485 * Creating Frames:: Creating additional Emacs frames with various contents.
486 * Frame Commands:: Iconifying, deleting, and switching frames.
487 * Fonts:: Changing the frame font.
488 * Speedbar:: How to make and use a speedbar frame.
489 * Multiple Displays:: How one Emacs job can talk to several displays.
490 * Frame Parameters:: Changing the colors and other modes of frames.
491 * Scroll Bars:: How to enable and disable scroll bars; how to use them.
492 * Drag and Drop:: Using drag and drop to open files and insert text.
493 * Menu Bars:: Enabling and disabling the menu bar.
494 * Tool Bars:: Enabling and disabling the tool bar.
495 * Dialog Boxes:: Controlling use of dialog boxes.
496 * Tooltips:: Displaying information at the current mouse position.
497 * Mouse Avoidance:: Moving the mouse pointer out of the way.
498 * Non-Window Terminals:: Multiple frames on terminals that show only one.
499 * Text-Only Mouse:: Using the mouse in text-only terminals.
501 International Character Set Support
503 * International Chars:: Basic concepts of multibyte characters.
504 * Enabling Multibyte:: Controlling whether to use multibyte characters.
505 * Language Environments:: Setting things up for the language you use.
506 * Input Methods:: Entering text characters not on your keyboard.
507 * Select Input Method:: Specifying your choice of input methods.
508 * Coding Systems:: Character set conversion when you read and
509 write files, and so on.
510 * Recognize Coding:: How Emacs figures out which conversion to use.
511 * Specify Coding:: Specifying a file's coding system explicitly.
512 * Output Coding:: Choosing coding systems for output.
513 * Text Coding:: Choosing conversion to use for file text.
514 * Communication Coding:: Coding systems for interprocess communication.
515 * File Name Coding:: Coding systems for file @emph{names}.
516 * Terminal Coding:: Specifying coding systems for converting
517 terminal input and output.
518 * Fontsets:: Fontsets are collections of fonts
519 that cover the whole spectrum of characters.
520 * Defining Fontsets:: Defining a new fontset.
521 * Modifying Fontsets:: Modifying an existing fontset.
522 * Undisplayable Characters::When characters don't display.
523 * Unibyte Mode:: You can pick one European character set
524 to use without multibyte characters.
525 * Charsets:: How Emacs groups its internal character codes.
529 * Major Modes:: Text mode vs. Lisp mode vs. C mode...
530 * Minor Modes:: Each minor mode is a feature you can turn on
531 independently of any others.
532 * Choosing Modes:: How modes are chosen when visiting files.
536 * Indentation Commands:: More commands for performing indentation.
537 * Tab Stops:: Stop points for indentation in Text modes.
538 * Just Spaces:: Using only space characters for indentation.
539 * Indent Convenience:: Optional indentation features.
541 Commands for Human Languages
543 * Words:: Moving over and killing words.
544 * Sentences:: Moving over and killing sentences.
545 * Paragraphs:: Moving over paragraphs.
546 * Pages:: Moving over pages.
547 * Filling:: Filling or justifying text.
548 * Case:: Changing the case of text.
549 * Text Mode:: The major modes for editing text files.
550 * Outline Mode:: Editing outlines.
551 * Org Mode:: The Emacs organizer.
552 * TeX Mode:: Editing input to the formatter TeX.
553 * HTML Mode:: Editing HTML and SGML files.
554 * Nroff Mode:: Editing input to the formatter nroff.
555 * Enriched Text:: Editing text ``enriched'' with fonts, colors, etc.
556 * Text Based Tables:: Commands for editing text-based tables.
557 * Two-Column:: Splitting text columns into separate windows.
561 * Auto Fill:: Auto Fill mode breaks long lines automatically.
562 * Fill Commands:: Commands to refill paragraphs and center lines.
563 * Fill Prefix:: Filling paragraphs that are indented
564 or in a comment, etc.
565 * Adaptive Fill:: How Emacs can determine the fill prefix automatically.
569 * Outline Format:: What the text of an outline looks like.
570 * Outline Motion:: Special commands for moving through
572 * Outline Visibility:: Commands to control what is visible.
573 * Outline Views:: Outlines and multiple views.
574 * Foldout:: Folding means zooming in on outlines.
578 * TeX Editing:: Special commands for editing in TeX mode.
579 * LaTeX Editing:: Additional commands for LaTeX input files.
580 * TeX Print:: Commands for printing part of a file with TeX.
581 * TeX Misc:: Customization of TeX mode, and related features.
583 Editing Enriched Text
585 * Enriched Mode:: Entering and exiting Enriched mode.
586 * Hard and Soft Newlines:: There are two different kinds of newlines.
587 * Editing Format Info:: How to edit text properties.
588 * Enriched Faces:: Bold, italic, underline, etc.
589 * Enriched Indentation:: Changing the left and right margins.
590 * Enriched Justification:: Centering, setting text flush with the
591 left or right margin, etc.
592 * Enriched Properties:: The "special" text properties submenu.
594 @c The automatic texinfo menu update inserts some duplicate items here
595 @c (faces, colors, indentation, justification, properties), because
596 @c they are listed in two menus. But we already have them above, no
597 @c need to list them twice.
599 Editing Text-based Tables
601 * Table Definition:: What is a text based table.
602 * Table Creation:: How to create a table.
603 * Table Recognition:: How to activate and deactivate tables.
604 * Cell Commands:: Cell-oriented commands in a table.
605 * Cell Justification:: Justifying cell contents.
606 * Table Rows and Columns:: Inserting and deleting rows and columns.
607 * Table Conversion:: Converting between plain text and tables.
608 * Table Misc:: Table miscellany.
612 * Program Modes:: Major modes for editing programs.
613 * Defuns:: Commands to operate on major top-level parts
615 * Program Indent:: Adjusting indentation to show the nesting.
616 * Parentheses:: Commands that operate on parentheses.
617 * Comments:: Inserting, killing, and aligning comments.
618 * Documentation:: Getting documentation of functions you plan to call.
619 * Hideshow:: Displaying blocks selectively.
620 * Symbol Completion:: Completion on symbol names of your program or language.
621 * Glasses:: Making identifiersLikeThis more readable.
622 * Semantic:: Suite of editing tools based on source code parsing.
623 * Misc for Programs:: Other Emacs features useful for editing programs.
624 * C Modes:: Special commands of C, C++, Objective-C,
625 Java, and Pike modes.
626 * Asm Mode:: Asm mode and its special features.
627 * Fortran:: Fortran mode and its special features.
629 Top-Level Definitions, or Defuns
631 * Left Margin Paren:: An open-paren or similar opening delimiter
632 starts a defun if it is at the left margin.
633 * Moving by Defuns:: Commands to move over or mark a major definition.
634 * Imenu:: Making buffer indexes as menus.
635 * Which Function:: Which Function mode shows which function you are in.
637 Indentation for Programs
639 * Basic Indent:: Indenting a single line.
640 * Multi-line Indent:: Commands to reindent many lines at once.
641 * Lisp Indent:: Specifying how each Lisp function should be indented.
642 * C Indent:: Extra features for indenting C and related modes.
643 * Custom C Indent:: Controlling indentation style for C and related modes.
645 Commands for Editing with Parentheses
647 * Expressions:: Expressions with balanced parentheses.
648 * Moving by Parens:: Commands for moving up, down and across
649 in the structure of parentheses.
650 * Matching:: Insertion of a close-delimiter flashes matching open.
652 Manipulating Comments
654 * Comment Commands:: Inserting, killing, and aligning comments.
655 * Multi-Line Comments:: Commands for adding and editing multi-line comments.
656 * Options for Comments::Customizing the comment features.
660 * Info Lookup:: Looking up library functions and commands
662 * Man Page:: Looking up man pages of library functions and commands.
663 * Lisp Doc:: Looking up Emacs Lisp functions, etc.
667 * Motion in C:: Commands to move by C statements, etc.
668 * Electric C:: Colon and other chars can automatically reindent.
669 * Hungry Delete:: A more powerful DEL command.
670 * Other C Commands:: Filling comments, viewing expansion of macros,
671 and other neat features.
675 * Fortran Motion:: Moving point by statements or subprograms.
676 * Fortran Indent:: Indentation commands for Fortran.
677 * Fortran Comments:: Inserting and aligning comments.
678 * Fortran Autofill:: Auto fill support for Fortran.
679 * Fortran Columns:: Measuring columns for valid Fortran.
680 * Fortran Abbrev:: Built-in abbrevs for Fortran keywords.
684 * ForIndent Commands:: Commands for indenting and filling Fortran.
685 * ForIndent Cont:: How continuation lines indent.
686 * ForIndent Num:: How line numbers auto-indent.
687 * ForIndent Conv:: Conventions you must obey to avoid trouble.
688 * ForIndent Vars:: Variables controlling Fortran indent style.
690 Compiling and Testing Programs
692 * Compilation:: Compiling programs in languages other
693 than Lisp (C, Pascal, etc.).
694 * Compilation Mode:: The mode for visiting compiler errors.
695 * Compilation Shell:: Customizing your shell properly
696 for use in the compilation buffer.
697 * Grep Searching:: Searching with grep.
698 * Flymake:: Finding syntax errors on the fly.
699 * Debuggers:: Running symbolic debuggers for non-Lisp programs.
700 * Executing Lisp:: Various modes for editing Lisp programs,
701 with different facilities for running
703 * Lisp Libraries:: How Lisp programs are loaded into Emacs.
704 * Lisp Eval:: Executing a single Lisp expression in Emacs.
705 * Lisp Interaction:: Executing Lisp in an Emacs buffer.
706 * External Lisp:: Communicating through Emacs with a separate Lisp.
708 Running Debuggers Under Emacs
710 * Starting GUD:: How to start a debugger subprocess.
711 * Debugger Operation:: Connection between the debugger and source buffers.
712 * Commands of GUD:: Key bindings for common commands.
713 * GUD Customization:: Defining your own commands for GUD.
714 * GDB Graphical Interface:: An enhanced mode that uses GDB features to
715 implement a graphical debugging environment through
718 GDB Graphical Interface
720 * GDB User Interface Layout:: Control the number of displayed buffers.
721 * Source Buffers:: Use the mouse in the fringe/margin to
722 control your program.
723 * Breakpoints Buffer:: A breakpoint control panel.
724 * Threads Buffer:: Displays your threads.
725 * Stack Buffer:: Select a frame from the call stack.
726 * Other GDB Buffers:: Other buffers for controlling the GDB state.
727 * Watch Expressions:: Monitor variable values in the speedbar.
728 * Multithreaded Debugging:: Debugging programs with several threads.
730 Maintaining Large Programs
732 * Version Control:: Using version control systems.
733 * Change Log:: Maintaining a change history for your program.
734 * Tags:: Go directly to any function in your program in one
735 command. Tags remembers which file it is in.
736 * EDE:: An integrated development environment for Emacs.
737 * Emerge:: A convenient way of merging two versions of a program.
741 * Introduction to VC:: How version control works in general.
742 * VC Mode Line:: How the mode line shows version control status.
743 * Basic VC Editing:: How to edit a file under version control.
744 * Log Buffer:: Features available in log entry buffers.
745 * Registering:: Putting a file under version control.
746 * Old Revisions:: Examining and comparing old versions.
747 * VC Change Log:: Viewing the VC Change Log.
748 * VC Undo:: Canceling changes before or after committing.
749 * VC Directory Mode:: Listing files managed by version control.
750 * Branches:: Multiple lines of development.
751 * Revision Tags:: Symbolic names for revisions.
752 * Miscellaneous VC:: Various other commands and features of VC.
753 * Customizing VC:: Variables that change VC's behavior.
755 Introduction to Version Control
757 * Why Version Control?:: Understanding the problems it addresses.
758 * Version Control Systems:: Supported version control back-end systems.
759 * VCS Concepts:: Words and concepts related to version control.
760 * VCS Merging:: How file conflicts are handled.
761 * VCS Changesets:: Changesets in version control.
762 * VCS Repositories:: Where version control repositories are stored.
763 * Types of Log File:: The VCS log in contrast to the ChangeLog.
765 Basic Editing under Version Control
767 * VC With A Merging VCS:: Without locking: default mode for CVS.
768 * VC With A Locking VCS:: RCS in its default mode, SCCS, and optionally CVS.
769 * Advanced C-x v v:: Advanced features available with a prefix argument.
773 * VC Directory Buffer:: What the buffer looks like and means.
774 * VC Directory Commands:: Commands to use in a VC directory buffer.
776 Multiple Branches of a File
778 * Switching Branches:: How to get to another existing branch.
779 * VC Pull:: Updating a branch from another branch.
780 * Merging:: Transferring changes between branches.
781 * Creating Branches:: How to start a new branch.
783 Miscellaneous Commands and Features of VC
785 * Change Logs and VC:: Generating a change log file from log entries.
786 * VC Delete/Rename:: Deleting and renaming version-controlled files.
787 * Revision Tags:: Symbolic names for revisions.
788 * Version Headers:: Inserting version control headers into working files.
792 * General VC Options:: Options that apply to multiple back ends.
793 * RCS and SCCS:: Options for RCS and SCCS.
794 * CVS Options:: Options for CVS.
798 * Change Log Commands:: Commands for editing change log files.
799 * Format of ChangeLog:: What the change log file looks like.
803 * Tag Syntax:: Tag syntax for various types of code and text files.
804 * Create Tags Table:: Creating a tags table with @code{etags}.
805 * Etags Regexps:: Create arbitrary tags using regular expressions.
806 * Select Tags Table:: How to visit a tags table.
807 * Find Tag:: Commands to find the definition of a specific tag.
808 * Tags Search:: Using a tags table for searching and replacing.
809 * List Tags:: Listing and finding tags defined in a file.
811 Merging Files with Emerge
813 * Overview of Emerge:: How to start Emerge. Basic concepts.
814 * Submodes of Emerge:: Fast mode vs. Edit mode.
815 Skip Prefers mode and Auto Advance mode.
816 * State of Difference:: You do the merge by specifying state A or B
818 * Merge Commands:: Commands for selecting a difference,
819 changing states of differences, etc.
820 * Exiting Emerge:: What to do when you've finished the merge.
821 * Combining in Emerge:: How to keep both alternatives for a difference.
822 * Fine Points of Emerge:: Miscellaneous issues.
826 * Abbrev Concepts:: Fundamentals of defined abbrevs.
827 * Defining Abbrevs:: Defining an abbrev, so it will expand when typed.
828 * Expanding Abbrevs:: Controlling expansion: prefixes, canceling expansion.
829 * Editing Abbrevs:: Viewing or editing the entire list of defined abbrevs.
830 * Saving Abbrevs:: Saving the entire list of abbrevs for another session.
831 * Dynamic Abbrevs:: Abbreviations for words already in the buffer.
832 * Dabbrev Customization:: What is a word, for dynamic abbrevs. Case handling.
837 * Basic Picture:: Basic concepts and simple commands of Picture Mode.
838 * Insert in Picture:: Controlling direction of cursor motion
839 after "self-inserting" characters.
840 * Tabs in Picture:: Various features for tab stops and indentation.
841 * Rectangles in Picture:: Clearing and superimposing rectangles.
844 Dired, the Directory Editor
846 * Dired Enter:: How to invoke Dired.
847 * Dired Navigation:: Special motion commands in the Dired buffer.
848 * Dired Deletion:: Deleting files with Dired.
849 * Flagging Many Files:: Flagging files based on their names.
850 * Dired Visiting:: Other file operations through Dired.
851 * Marks vs Flags:: Flagging for deletion vs marking.
852 * Operating on Files:: How to copy, rename, print, compress, etc.
853 either one file or several files.
854 * Shell Commands in Dired:: Running a shell command on the marked files.
855 * Transforming File Names:: Using patterns to rename multiple files.
856 * Comparison in Dired:: Running `diff' by way of Dired.
857 * Subdirectories in Dired:: Adding subdirectories to the Dired buffer.
858 * Subdir Switches:: Subdirectory switches in Dired.
859 * Subdirectory Motion:: Moving across subdirectories, and up and down.
860 * Hiding Subdirectories:: Making subdirectories visible or invisible.
861 * Dired Updating:: Discarding lines for files of no interest.
862 * Dired and Find:: Using `find' to choose the files for Dired.
863 * Wdired:: Operating on files by editing the Dired buffer.
864 * Image-Dired:: Viewing image thumbnails in Dired.
865 * Misc Dired Features:: Various other features.
867 The Calendar and the Diary
869 * Calendar Motion:: Moving through the calendar; selecting a date.
870 * Scroll Calendar:: Bringing earlier or later months onto the screen.
871 * Counting Days:: How many days are there between two dates?
872 * General Calendar:: Exiting or recomputing the calendar.
873 * Writing Calendar Files:: Writing calendars to files of various formats.
874 * Holidays:: Displaying dates of holidays.
875 * Sunrise/Sunset:: Displaying local times of sunrise and sunset.
876 * Lunar Phases:: Displaying phases of the moon.
877 * Other Calendars:: Converting dates to other calendar systems.
878 * Diary:: Displaying events from your diary.
879 * Appointments:: Reminders when it's time to do something.
880 * Importing Diary:: Converting diary events to/from other formats.
881 * Daylight Saving:: How to specify when daylight saving time is active.
882 * Time Intervals:: Keeping track of time intervals.
883 * Advanced Calendar/Diary Usage:: Advanced Calendar/Diary customization.
885 Movement in the Calendar
887 * Calendar Unit Motion:: Moving by days, weeks, months, and years.
888 * Move to Beginning or End:: Moving to start/end of weeks, months, and years.
889 * Specified Dates:: Moving to the current date or another
892 Conversion To and From Other Calendars
894 * Calendar Systems:: The calendars Emacs understands
895 (aside from Gregorian).
896 * To Other Calendar:: Converting the selected date to various calendars.
897 * From Other Calendar:: Moving to a date specified in another calendar.
898 * Mayan Calendar:: Moving to a date specified in a Mayan calendar.
902 * Displaying the Diary:: Viewing diary entries and associated calendar dates.
903 * Format of Diary File:: Entering events in your diary.
904 * Date Formats:: Various ways you can specify dates.
905 * Adding to Diary:: Commands to create diary entries.
906 * Special Diary Entries:: Anniversaries, blocks of dates, cyclic entries, etc.
908 Customizing the Calendar and Diary
910 * Calendar Customizing:: Calendar layout and hooks.
911 * Holiday Customizing:: Defining your own holidays.
912 * Date Display Format:: Changing the format.
913 * Time Display Format:: Changing the format.
914 * Diary Customizing:: Defaults you can set.
915 * Non-Gregorian Diary:: Diary entries based on other calendars.
916 * Diary Display:: A choice of ways to display the diary.
917 * Fancy Diary Display:: Sorting diary entries, using included diary files.
918 * Sexp Diary Entries:: More flexible diary entries.
922 * DocView Navigation:: Navigating DocView buffers.
923 * DocView Searching:: Searching inside documents.
924 * DocView Slicing:: Specifying which part of a page is displayed.
925 * DocView Conversion:: Influencing and triggering conversion.
929 * Mail Format:: Format of the mail being composed.
930 * Mail Headers:: Details of some standard mail header fields.
931 * Mail Aliases:: Abbreviating and grouping mail addresses.
932 * Mail Commands:: Special commands for editing mail being composed.
933 * Mail Signature:: Adding a signature to every message.
934 * Mail Amusements:: Distracting the NSA; adding fortune messages.
935 * Mail Methods:: Using alternative mail-composition methods.
939 * Mail Sending:: Commands to send the message.
940 * Header Editing:: Commands to move to header fields and edit them.
941 * Citing Mail:: Quoting a message you are replying to.
942 * Mail Misc:: Attachments, spell checking, etc.
944 Reading Mail with Rmail
946 * Rmail Basics:: Basic concepts of Rmail, and simple use.
947 * Rmail Scrolling:: Scrolling through a message.
948 * Rmail Motion:: Moving to another message.
949 * Rmail Deletion:: Deleting and expunging messages.
950 * Rmail Inbox:: How mail gets into the Rmail file.
951 * Rmail Files:: Using multiple Rmail files.
952 * Rmail Output:: Copying message out to files.
953 * Rmail Labels:: Classifying messages by labeling them.
954 * Rmail Attributes:: Certain standard labels, called attributes.
955 * Rmail Reply:: Sending replies to messages you are viewing.
956 * Rmail Summary:: Summaries show brief info on many messages.
957 * Rmail Sorting:: Sorting messages in Rmail.
958 * Rmail Display:: How Rmail displays a message; customization.
959 * Rmail Coding:: How Rmail handles decoding character sets.
960 * Rmail Editing:: Editing message text and headers in Rmail.
961 * Rmail Digest:: Extracting the messages from a digest message.
962 * Rmail Rot13:: Reading messages encoded in the rot13 code.
963 * Movemail:: More details of fetching new mail.
964 * Remote Mailboxes:: Retrieving mail from remote mailboxes.
965 * Other Mailbox Formats:: Retrieving mail from local mailboxes in
970 * Rmail Make Summary:: Making various sorts of summaries.
971 * Rmail Summary Edit:: Manipulating messages from the summary.
975 * Buffers of Gnus:: The group, summary, and article buffers.
976 * Gnus Startup:: What you should know about starting Gnus.
977 * Gnus Group Buffer:: A short description of Gnus group commands.
978 * Gnus Summary Buffer:: A short description of Gnus summary commands.
980 Running Shell Commands from Emacs
982 * Single Shell:: How to run one shell command and return.
983 * Interactive Shell:: Permanent shell taking input via Emacs.
984 * Shell Mode:: Special Emacs commands used with permanent shell.
985 * Shell Prompts:: Two ways to recognize shell prompts.
986 * Shell History:: Repeating previous commands in a shell buffer.
987 * Directory Tracking:: Keeping track when the subshell changes directory.
988 * Shell Options:: Options for customizing Shell mode.
989 * Terminal emulator:: An Emacs window as a terminal emulator.
990 * Term Mode:: Special Emacs commands used in Term mode.
991 * Remote Host:: Connecting to another computer.
992 * Serial Terminal:: Connecting to a serial port.
994 Shell Command History
996 * Shell Ring:: Fetching commands from the history list.
997 * Shell History Copying::Moving to a command and then copying it.
998 * History References:: Expanding @samp{!}-style history references.
1000 Using Emacs as a Server
1002 * Invoking emacsclient:: Connecting to the Emacs server.
1003 * emacsclient Options:: Emacs client startup options.
1005 Printing Hard Copies
1007 * PostScript:: Printing buffers or regions as PostScript.
1008 * PostScript Variables:: Customizing the PostScript printing commands.
1009 * Printing Package:: An optional advanced printing interface.
1011 Hyperlinking and Navigation Features
1013 * Browse-URL:: Following URLs.
1014 * Goto Address mode:: Activating URLs.
1015 * FFAP:: Finding files etc. at point.
1019 * Package Menu:: Buffer for viewing and managing packages.
1020 * Package Installation:: Options for package installation.
1021 * Package Files:: Where packages are installed.
1025 * Easy Customization:: Convenient way to browse and change settings.
1026 * Variables:: Many Emacs commands examine Emacs variables
1027 to decide what to do; by setting variables,
1028 you can control their functioning.
1029 * Key Bindings:: Keymaps say what command each key runs.
1030 By changing them, you can "redefine" keys.
1031 * Init File:: How to write common customizations in the
1034 Easy Customization Interface
1036 * Customization Groups:: How settings are classified in a structure.
1037 * Browsing Custom:: Browsing and searching for settings.
1038 * Changing a Variable:: How to edit an option's value and set the option.
1039 * Saving Customizations:: Specifying the file for saving customizations.
1040 * Face Customization:: How to edit the attributes of a face.
1041 * Specific Customization:: Making a customization buffer for specific
1042 variables, faces, or groups.
1043 * Custom Themes:: How to define collections of customized options
1044 that can be loaded and unloaded together.
1048 * Examining:: Examining or setting one variable's value.
1049 * Hooks:: Hook variables let you specify programs for parts
1050 of Emacs to run on particular occasions.
1051 * Locals:: Per-buffer values of variables.
1052 * File Variables:: How files can specify variable values.
1053 * Directory Variables:: How variable values can be specified by directory.
1055 Local Variables in Files
1057 * Specifying File Variables:: Specifying file local variables.
1058 * Safe File Variables:: Making sure file local variables are safe.
1060 Customizing Key Bindings
1062 * Keymaps:: Generalities. The global keymap.
1063 * Prefix Keymaps:: Keymaps for prefix keys.
1064 * Local Keymaps:: Major and minor modes have their own keymaps.
1065 * Minibuffer Maps:: The minibuffer uses its own local keymaps.
1066 * Rebinding:: How to redefine one key's meaning conveniently.
1067 * Init Rebinding:: Rebinding keys with your init file, @file{.emacs}.
1068 * Modifier Keys:: Using modifier keys in key bindings.
1069 * Function Keys:: Rebinding terminal function keys.
1070 * Named ASCII Chars:: Distinguishing @key{TAB} from @kbd{C-i}, and so on.
1071 * Mouse Buttons:: Rebinding mouse buttons in Emacs.
1072 * Disabling:: Disabling a command means confirmation is required
1073 before it can be executed. This is done to protect
1074 beginners from surprises.
1076 The Init File, @file{~/.emacs}
1078 * Init Syntax:: Syntax of constants in Emacs Lisp.
1079 * Init Examples:: How to do some things with an init file.
1080 * Terminal Init:: Each terminal type can have an init file.
1081 * Find Init:: How Emacs finds the init file.
1082 * Init Non-ASCII:: Using non-@acronym{ASCII} characters in an init file.
1084 Dealing with Emacs Trouble
1086 * DEL Does Not Delete:: What to do if @key{DEL} doesn't delete.
1087 * Stuck Recursive:: `[...]' in mode line around the parentheses.
1088 * Screen Garbled:: Garbage on the screen.
1089 * Text Garbled:: Garbage in the text.
1090 * Memory Full:: How to cope when you run out of memory.
1091 * After a Crash:: Recovering editing in an Emacs session that crashed.
1092 * Emergency Escape:: Emergency escape---
1093 What to do if Emacs stops responding.
1094 * Total Frustration:: When you are at your wits' end.
1098 * Known Problems:: How to read about known problems and bugs.
1099 * Bug Criteria:: Have you really found a bug?
1100 * Understanding Bug Reporting:: How to report a bug effectively.
1101 * Checklist:: Steps to follow for a good bug report.
1102 * Sending Patches:: How to send a patch for GNU Emacs.
1104 Command Line Arguments for Emacs Invocation
1106 * Action Arguments:: Arguments to visit files, load libraries,
1108 * Initial Options:: Arguments that take effect while starting Emacs.
1109 * Command Example:: Examples of using command line arguments.
1110 * Resume Arguments:: Specifying arguments when you resume a running Emacs.
1111 * Environment:: Environment variables that Emacs uses.
1112 * Display X:: Changing the default display and using remote login.
1113 * Font X:: Choosing a font for text, under X.
1114 * Colors X:: Choosing display colors.
1115 * Window Size X:: Start-up window size, under X.
1116 * Borders X:: Internal and external borders, under X.
1117 * Title X:: Specifying the initial frame's title.
1118 * Icons X:: Choosing what sort of icon to use, under X.
1119 * Misc X:: Other display options.
1121 Environment Variables
1123 * General Variables:: Environment variables that all versions of Emacs use.
1124 * Misc Variables:: Certain system-specific variables.
1125 * MS-Windows Registry:: An alternative to the environment on MS-Windows.
1127 X Options and Resources
1129 * Resources:: Using X resources with Emacs (in general).
1130 * Table of Resources:: Table of specific X resources that affect Emacs.
1131 * Face Resources:: X resources for customizing faces.
1132 * Lucid Resources:: X resources for Lucid menus.
1133 * LessTif Resources:: X resources for LessTif and Motif menus.
1134 * GTK resources:: Resources for GTK widgets.
1138 * GTK widget names:: How widgets in GTK are named in general.
1139 * GTK Names in Emacs:: GTK widget names in Emacs.
1140 * GTK styles:: What can be customized in a GTK widget.
1142 Emacs and Mac OS / GNUstep
1144 * Mac / GNUstep Basics:: Basic Emacs usage under GNUstep or Mac OS.
1145 * Mac / GNUstep Customization:: Customizations under GNUstep or Mac OS.
1146 * Mac / GNUstep Events:: How window system events are handled.
1147 * GNUstep Support:: Details on status of GNUstep support.
1149 Emacs and Microsoft Windows/MS-DOS
1151 * Windows Startup:: How to start Emacs on Windows.
1152 * Text and Binary:: Text files use CRLF to terminate lines.
1153 * Windows Files:: File-name conventions on Windows.
1154 * ls in Lisp:: Emulation of @code{ls} for Dired.
1155 * Windows HOME:: Where Emacs looks for your @file{.emacs}.
1156 * Windows Keyboard:: Windows-specific keyboard features.
1157 * Windows Mouse:: Windows-specific mouse features.
1158 * Windows Processes:: Running subprocesses on Windows.
1159 * Windows Printing:: How to specify the printer on MS-Windows.
1160 * Windows Fonts:: Specifying fonts on MS-Windows.
1161 * Windows Misc:: Miscellaneous Windows features.
1162 * MS-DOS:: Using Emacs on MS-DOS (otherwise known as @dfn{MS-DOG}).
1166 * MS-DOS Keyboard:: Keyboard conventions on MS-DOS.
1167 * MS-DOS Mouse:: Mouse conventions on MS-DOS.
1168 * MS-DOS Display:: Fonts, frames and display size on MS-DOS.
1169 * MS-DOS File Names:: File name conventions on MS-DOS.
1170 * MS-DOS Printing:: Printing specifics on MS-DOS.
1171 * MS-DOS and MULE:: Support for internationalization on MS-DOS.
1172 * MS-DOS Processes:: Running subprocesses on MS-DOS.
1180 This manual documents the use and simple customization of the Emacs
1181 editor. Simple Emacs customizations do not require you to be a
1182 programmer, but if you are not interested in customizing, you can
1183 ignore the customization hints.
1185 This is primarily a reference manual, but can also be used as a
1186 primer. If you are new to Emacs, we recommend you start with
1187 the integrated, learn-by-doing tutorial, before reading the manual. To
1188 run the tutorial, start Emacs and type @kbd{C-h t}. The tutorial
1189 describes commands, tells you when to try them, and explains the
1192 On first reading, just skim chapters 1 and 2, which describe the
1193 notational conventions of the manual and the general appearance of the
1194 Emacs display screen. Note which questions are answered in these
1195 chapters, so you can refer back later. After reading chapter 4, you
1196 should practice the commands shown there. The next few chapters
1197 describe fundamental techniques and concepts that are used constantly.
1198 You need to understand them thoroughly, so experiment with them
1199 until you are fluent.
1201 Chapters 14 through 19 describe intermediate-level features that are
1202 useful for many kinds of editing. Chapter 20 and following chapters
1203 describe optional but useful features; read those chapters when you
1206 Read the Common Problems chapter if Emacs does not seem to be
1207 working properly. It explains how to cope with several common
1208 problems (@pxref{Lossage}), as well as when and how to report Emacs
1209 bugs (@pxref{Bugs}).
1211 To find the documentation of a particular command, look in the index.
1212 Keys (character commands) and command names have separate indexes.
1213 There is also a glossary, with a cross reference for each term.
1215 This manual is available as a printed book and also as an Info file.
1216 The Info file is for use with the Info program, which is the principal
1217 means of accessing on-line documentation in the GNU system. Both the
1218 Emacs Info file and an Info reader are included with GNU Emacs. The
1219 Info file and the printed book contain substantially the same text and
1220 are generated from the same source files, which are also distributed
1223 GNU Emacs is a member of the Emacs editor family. There are many
1224 Emacs editors, all sharing common principles of organization. For
1225 information on the underlying philosophy of Emacs and the lessons
1226 learned from its development, see @cite{Emacs, the Extensible,
1227 Customizable Self-Documenting Display Editor}, available from
1228 @url{ftp://publications.ai.mit.edu/ai-publications/pdf/AIM-519A.pdf}.
1230 This edition of the manual is intended for use with GNU Emacs
1231 installed on GNU and Unix systems. GNU Emacs can also be used on
1232 MS-DOS (also called MS-DOG), Microsoft Windows, and Macintosh systems.
1233 Those systems use different file name syntax; in addition
1234 MS-DOS does not support all GNU Emacs features. @xref{Microsoft
1235 Windows}, for information about using Emacs on Windows.
1236 @xref{Mac OS / GNUstep}, for information about using Emacs on
1237 Macintosh (and GNUstep).
1240 @node Distrib, Intro, Top, Top
1241 @unnumbered Distribution
1243 GNU Emacs is @dfn{free software}; this means that everyone is free to
1244 use it and free to redistribute it on certain conditions. GNU Emacs
1245 is not in the public domain; it is copyrighted and there are
1246 restrictions on its distribution, but these restrictions are designed
1247 to permit everything that a good cooperating citizen would want to do.
1248 What is not allowed is to try to prevent others from further sharing
1249 any version of GNU Emacs that they might get from you. The precise
1250 conditions are found in the GNU General Public License that comes with
1251 Emacs and also appears in this manual@footnote{This manual is itself
1252 covered by the GNU Free Documentation License (see the reverse title
1253 page in the printed manual or view the full source for online formats
1254 to see the precise conditions). This license is similar in spirit to
1255 the General Public License, but is more suitable for documentation.
1256 @xref{GNU Free Documentation License}.}. @xref{Copying}.
1258 One way to get a copy of GNU Emacs is from someone else who has it.
1259 You need not ask for our permission to do so, or tell any one else;
1260 just copy it. If you have access to the Internet, you can get the
1261 latest distribution version of GNU Emacs by anonymous FTP; see
1262 @url{http://www.gnu.org/software/emacs} on our website for more
1265 You may also receive GNU Emacs when you buy a computer. Computer
1266 manufacturers are free to distribute copies on the same terms that apply to
1267 everyone else. These terms require them to give you the full sources,
1268 including whatever changes they may have made, and to permit you to
1269 redistribute the GNU Emacs received from them under the usual terms of the
1270 General Public License. In other words, the program must be free for you
1271 when you get it, not just free for the manufacturer.
1273 @c FIXME no longer true?
1274 You can also order copies of GNU Emacs from the Free Software
1275 Foundation. This is a convenient and reliable way to get a copy; it is
1276 also a good way to help fund our work. We also sell hardcopy versions
1277 of this manual and @cite{An Introduction to Programming in Emacs Lisp},
1278 by Robert J. Chassell. You can visit our online store at
1279 @url{http://shop.fsf.org/}. For further information,
1283 Free Software Foundation
1284 51 Franklin Street, Fifth Floor
1285 Boston, MA 02110-1301
1289 The income from sales goes to support the foundation's purpose: the
1290 development of new free software, and improvements to our existing
1291 programs including GNU Emacs.
1293 @c FIXME you can't order a CD any more.
1294 If you find GNU Emacs useful, please @strong{send a donation} to the
1295 Free Software Foundation to support our work. Donations to the Free
1296 Software Foundation are tax deductible in the US. If you use GNU Emacs
1297 at your workplace, please suggest that the company make a donation. If
1298 company policy is unsympathetic to the idea of donating to charity, you
1299 might instead suggest ordering a CD-ROM from the Foundation
1300 occasionally, or subscribing to periodic updates.
1303 @node Acknowledgments, Intro, Distrib, Top
1304 @unnumberedsec Acknowledgments
1306 Contributors to GNU Emacs include Jari Aalto, Per Abrahamsen, Tomas
1307 Abrahamsson, Jay K.@: Adams, Michael Albinus, Nagy Andras, Ralf Angeli,
1308 Joe Arceneaux, Miles Bader, David Bakhash, Juanma Barranquero, Eli
1309 Barzilay, Thomas Baumann, Steven L.@: Baur, Jay Belanger, Alexander L.@:
1310 Belikoff, Boaz Ben-Zvi, Karl Berry, Anna M.@: Bigatti, Ray Blaak, Jim
1311 Blandy, Johan Bockgård, Jan Böcker, Lennart Borgman, Per Bothner,
1312 Terrence Brannon, Frank Bresz, Peter Breton, Emmanuel Briot, Kevin
1313 Broadey, Vincent Broman, David M.@: Brown, Georges Brun-Cottan, Joe
1314 Buehler, W@l{}odek Bzyl, Bill Carpenter, Per Cederqvist, Hans Chalupsky,
1315 Chong Yidong, Chris Chase, Bob Chassell, Andrew Choi, Sacha Chua, James
1316 Clark, Mike Clarkson, Glynn Clements, Daniel Colascione, Andrew Csillag,
1317 Baoqiu Cui, Doug Cutting, Mathias Dahl, Julien Danjou, Satyaki Das,
1318 Vivek Dasmohapatra, Michael DeCorte, Gary Delp, Matthieu Devin, Eri
1319 Ding, Jan Djärv, Carsten Dominik, Scott Draves, Benjamin Drieu,
1320 Viktor Dukhovni, Dmitry Dzhus, John Eaton, Rolf Ebert, Paul Eggert,
1321 Stephen Eglen, Torbjörn Einarsson, Tsugutomo Enami, Hans Henrik
1322 Eriksen, Michael Ernst, Ata Etemadi, Frederick Farnbach, Oscar
1323 Figueiredo, Fred Fish, Karl Fogel, Gary Foster, Romain Francoise, Noah
1324 Friedman, Andreas Fuchs, Hallvard Furuseth, Keith Gabryelski, Peter S.@:
1325 Galbraith, Kevin Gallagher, Kevin Gallo, Juan León Lahoz
1326 García, Howard Gayle, Daniel German, Stephen Gildea,
1327 Julien Gilles, David Gillespie, Bob Glickstein, Deepak Goel, Boris
1328 Goldowsky, Michelangelo Grigni, Odd Gripenstam, Kai Großjohann,
1329 Michael Gschwind, Bastien Guerry, Henry Guillaume, Doug Gwyn, Ken'ichi
1330 Handa, Lars Hansen, Chris Hanson, K. Shane Hartman, John Heidemann, Jon
1331 K.@: Hellan, Jesper Harder, Magnus Henoch, Markus Heritsch, Karl Heuer,
1332 Manabu Higashida, Anders Holst, Jeffrey C.@: Honig, Tassilo Horn, Kurt
1333 Hornik, Tom Houlder, Joakim Hove, Denis Howe, Lars Ingebrigtsen, Andrew
1334 Innes, Seiichiro Inoue, Philip Jackson, Pavel Janik, Paul Jarc, Ulf
1335 Jasper, Michael K. Johnson, Kyle Jones, Terry Jones, Simon Josefsson,
1336 Arne Jørgensen, Tomoji Kagatani, Brewster Kahle, Tokuya Kameshima,
1337 Lute Kamstra, David Kastrup, David Kaufman, Henry Kautz, Taichi
1338 Kawabata, Howard Kaye, Michael Kifer, Richard King, Peter Kleiweg, Karel
1339 Klí@v{c}, Shuhei Kobayashi, Pavel Kobiakov, Larry K.@:
1340 Kolodney, David M.@: Koppelman, Koseki Yoshinori, Robert Krawitz,
1341 Sebastian Kremer, Ryszard Kubiak, David Kågedal, Daniel LaLiberte,
1342 Karl Landstrom, Mario Lang, Aaron Larson, James R.@: Larus, Vinicius
1343 Jose Latorre, Werner Lemberg, Frederic Lepied, Peter Liljenberg, Lars
1344 Lindberg, Chris Lindblad, Anders Lindgren, Thomas Link, Juri Linkov,
1345 Francis Litterio, Emilio C. Lopes, Károly L@H{o}rentey, Dave Love,
1346 Sascha Lüdecke, Eric Ludlam, Alan Mackenzie, Christopher J.@:
1347 Madsen, Neil M.@: Mager, Ken Manheimer, Bill Mann, Brian Marick, Simon
1348 Marshall, Bengt Martensson, Charlie Martin, Thomas May, Roland McGrath,
1349 Will Mengarini, David Megginson, Ben A. Mesander, Wayne Mesard, Brad
1350 Miller, Lawrence Mitchell, Richard Mlynarik, Gerd Moellmann, Stefan
1351 Monnier, Morioka Tomohiko, Keith Moore, Jan Moringen, Glenn Morris,
1352 Diane Murray, Sen Nagata, Erik Naggum, Thomas Neumann, Thien-Thi Nguyen,
1353 Mike Newton, Jurgen Nickelsen, Dan Nicolaescu, Hrvoje Niksic, Jeff
1354 Norden, Andrew Norman, Christian Ohler, Alexandre Oliva, Bob Olson,
1355 Michael Olson, Takaaki Ota, Pieter E.@: J.@: Pareit, Ross Patterson,
1356 David Pearson, Jeff Peck, Damon Anton Permezel, Tom Perrine, William
1357 M.@: Perry, Per Persson, Jens Petersen, Daniel Pfeiffer, Richard L.@:
1358 Pieri, Fred Pierresteguy, Christian Plaunt, David Ponce, Francesco A.@:
1359 Potorti, Michael D. Prange, Mukesh Prasad, Ken Raeburn, Marko Rahamaa,
1360 Ashwin Ram, Eric S. Raymond, Paul Reilly, Edward M. Reingold, Alex
1361 Rezinsky, Rob Riepel, David Reitter, Adrian Robert, Nick Roberts, Roland
1362 B.@: Roberts, John Robinson, Danny Roozendaal, Sebastian Rose, William
1363 Rosenblatt, Guillermo J.@: Rozas, Martin Rudalics, Ivar Rummelhoff,
1364 Jason Rumney, Wolfgang Rupprecht, Kevin Ryde, James B. Salem, Masahiko
1365 Sato, Jorgen Schaefer, Holger Schauer, William Schelter, Ralph
1366 Schleicher, Gregor Schmid, Michael Schmidt, Ronald S. Schnell, Philippe
1367 Schnoebelen, Jan Schormann, Alex Schroeder, Stephen Schoef, Raymond
1368 Scholz, Eric Schulte, Andreas Schwab, Randal Schwartz, Oliver Seidel,
1369 Manuel Serrano, Paul Sexton, Hovav Shacham, Stanislav Shalunov, Marc
1370 Shapiro, Richard Sharman, Olin Shivers, Espen Skoglund, Rick Sladkey,
1371 Lynn Slater, Chris Smith, David Smith, Paul D.@: Smith, William
1372 Sommerfeld, Andre Spiegel, Michael Staats, Ulf Stegemann, Reiner Steib,
1373 Sam Steingold, Ake Stenhoff, Peter Stephenson, Ken Stevens, Andy Stewart,
1374 Jonathan Stigelman, Martin Stjernholm, Kim F.@: Storm, Steve Strassmann,
1375 Olaf Sylvester, Naoto Takahashi, Steven Tamm, Jean-Philippe Theberge,
1376 Jens T.@: Berger Thielemann, Spencer Thomas, Jim Thompson, Luc
1377 Teirlinck, David O'Toole, Tom Tromey, Enami Tsugutomo, Eli Tziperman,
1378 Daiki Ueno, Masanobu Umeda, Rajesh Vaidheeswarran, Neil W.@: Van Dyke,
1379 Didier Verna, Joakim Verona, Ulrik Vieth, Geoffrey Voelker, Johan
1380 Vromans, Inge Wallin, John Paul Wallington, Colin Walters, Barry Warsaw,
1381 Morten Welinder, Joseph Brian Wells, Rodney Whitby, John Wiegley, Ed
1382 Wilkinson, Mike Williams, Bill Wohler, Steven A. Wood, Dale R.@: Worley,
1383 Francis J.@: Wright, Felix S. T. Wu, Tom Wurgler, Katsumi Yamaoka,
1384 Yamamoto Mitsuharu, Masatake Yamato, Jonathan Yavner, Ryan Yeske, Ilya
1385 Zakharevich, Milan Zamazal, Victor Zandy, Eli Zaretskii, Jamie Zawinski,
1386 Shenghuo Zhu, Piotr Zielinski, Ian T.@: Zimmermann, Reto Zimmermann,
1387 Neal Ziring, Teodor Zlatanov, and Detlev Zundel.
1390 @node Intro, Glossary, Distrib, Top
1391 @unnumbered Introduction
1393 You are reading about GNU Emacs, the GNU incarnation of the
1394 advanced, self-documenting, customizable, extensible editor Emacs.
1395 (The `G' in `GNU' is not silent.)
1397 We call Emacs @dfn{advanced} because it can do much more than simple
1398 insertion and deletion of text. It can control subprocesses, indent
1399 programs automatically, show multiple files at once, and more.
1400 Emacs editing commands operate in terms of characters, words, lines,
1401 sentences, paragraphs, and pages, as well as expressions and comments
1402 in various programming languages.
1404 @dfn{Self-documenting} means that at any time you can use special
1405 commands, known as @dfn{help commands}, to find out what your options
1406 are, or to find out what any command does, or to find all the
1407 commands that pertain to a given topic. @xref{Help}.
1409 @dfn{Customizable} means that you can easily alter the behavior of
1410 Emacs commands in simple ways. For instance, if you use a programming
1411 language in which comments start with @samp{<**} and end with
1412 @samp{**>}, you can tell the Emacs comment manipulation commands to
1413 use those strings (@pxref{Comments}). To take another example, you
1414 can rebind the basic cursor motion commands (up, down, left and right)
1415 to any keys on the keyboard that you find comfortable.
1416 @xref{Customization}.
1418 @dfn{Extensible} means that you can go beyond simple customization
1419 and create entirely new commands. New commands are simply programs
1420 written in the Lisp language, which are run by Emacs's own Lisp
1421 interpreter. Existing commands can even be redefined in the middle of
1422 an editing session, without having to restart Emacs. Most of the
1423 editing commands in Emacs are written in Lisp; the few exceptions
1424 could have been written in Lisp but use C instead for efficiency.
1425 Writing an extension is programming, but non-programmers can use it
1426 afterwards. @xref{Top, Emacs Lisp Intro, Preface, eintr, An
1427 Introduction to Programming in Emacs Lisp}, if you want to learn Emacs
1430 @include screen.texi
1431 @include commands.texi
1432 @include entering.texi
1438 @include killing.texi
1440 @include display.texi
1441 @include search.texi
1443 @include kmacro.texi
1444 @c Includes arevert-xtra.
1446 @include buffers.texi
1447 @include windows.texi
1448 @include frames.texi
1451 @include indent.texi
1453 @c Includes fortran-xtra.
1454 @include programs.texi
1455 @include building.texi
1456 @c Includes vc1-xtra, emerge-xtra.
1457 @include maintaining.texi
1458 @include abbrevs.texi
1459 @c Includes dired-xtra.
1461 @c Includes cal-xtra.
1462 @include calendar.texi
1463 @include sending.texi
1465 @c Includes picture-xtra.texi
1467 @include package.texi
1468 @include custom.texi
1469 @include trouble.texi
1471 @node Copying, GNU Free Documentation License, Service, Top
1472 @appendix GNU GENERAL PUBLIC LICENSE
1475 @node GNU Free Documentation License, Emacs Invocation, Copying, Top
1476 @appendix GNU Free Documentation License
1477 @include doclicense.texi
1479 @include cmdargs.texi
1480 @include xresources.texi
1484 @c Includes msdog-xtra.
1487 @include glossary.texi
1492 @c The Option Index is produced only in the on-line version,
1493 @c because the index entries related to command-line options
1494 @c tend to point to the same pages and all begin with a dash.
1495 @c This, and the need to keep the node links consistent, are
1496 @c the reasons for the funky @iftex/@ifnottex dance below.
1497 @c The Option Index is _not_ before Key Index, because that
1498 @c would require changes in the glossary.texi's @node line.
1499 @c It is not after Concept Index for similar reasons.
1502 @node Key Index, Command Index, Glossary, Top
1503 @unnumbered Key (Character) Index
1508 @node Key Index, Option Index, Glossary, Top
1509 @unnumbered Key (Character) Index
1512 @node Option Index, Command Index, Key Index, Top
1513 @unnumbered Command-Line Options Index
1516 @node Command Index, Variable Index, Option Index, Top
1517 @unnumbered Command and Function Index
1522 @node Command Index, Variable Index, Key Index, Top
1523 @unnumbered Command and Function Index
1527 @node Variable Index, Concept Index, Command Index, Top
1528 @unnumbered Variable Index
1531 @node Concept Index, Acknowledgments, Variable Index, Top
1532 @unnumbered Concept Index