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