emacs.texi 73.2 KB
Newer Older
Andrew Innes's avatar
Andrew Innes committed
1 2 3
\input texinfo

@setfilename ../info/emacs
Karl Berry's avatar
Karl Berry committed
@settitle GNU Emacs Manual
Andrew Innes's avatar
Andrew Innes committed
5 6

@c The edition number appears in several places in this file
@set EDITION   Fourteenth
@set EMACSVER  22.0.50

Karl Berry's avatar
Karl Berry committed
11 12
This is the @value{EDITION} edition of the @cite{GNU Emacs Manual},
updated for Emacs version @value{EMACSVER}.
Andrew Innes's avatar
Andrew Innes committed

14 15
Copyright (C) 1985, 1986, 1987, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
  2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
Andrew Innes's avatar
Andrew Innes committed

Karl Berry's avatar
Karl Berry committed
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.2 or
20 21 22
any later version published by the Free Software Foundation; with the
Invariant Sections being ``The GNU Manifesto'', ``Distribution'' and
``GNU GENERAL PUBLIC LICENSE'', with the Front-Cover texts being ``A GNU
Manual,'' and with the Back-Cover Texts as in (a) below.  A copy of the
license is included in the section entitled ``GNU Free Documentation
26 27 28 29

(a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
this GNU Manual, like GNU software.  Copies published by the Free
Software Foundation raise funds for GNU development.''
Karl Berry's avatar
Karl Berry committed
30 31 32 33 34 35 36
@end quotation
@end copying

@dircategory Emacs
* Emacs: (emacs).	The extensible self-documenting text editor.
@end direntry
Andrew Innes's avatar
Andrew Innes committed
37 38 39

@c in general, keep the following line commented out, unless doing a
@c copy of this manual that will be published.  the manual should go
@c onto the distribution in the full, 8.5 x 11" size.
Andrew Innes's avatar
Andrew Innes committed

Richard M. Stallman's avatar
Richard M. Stallman committed
@c @smallbook
Andrew Innes's avatar
Andrew Innes committed

Karl Berry's avatar
Karl Berry committed
44 45 46 47
@setchapternewpage odd
@defcodeindex op
@synindex pg cp

Andrew Innes's avatar
Andrew Innes committed
48 49 50 51 52
@kbdinputstyle code

@shorttitlepage GNU Emacs Manual
@end iftex
Karl Berry's avatar
Karl Berry committed

Andrew Innes's avatar
Andrew Innes committed
54 55 56 57
@sp 6
@center @titlefont{GNU Emacs Manual}
@sp 4
@center @value{EDITION} Edition, Updated for Emacs Version @value{EMACSVER}.
Andrew Innes's avatar
Andrew Innes committed
59 60 61 62
@sp 5
@center Richard Stallman
@vskip 0pt plus 1filll
Karl Berry's avatar
Karl Berry committed
Andrew Innes's avatar
Andrew Innes committed

Karl Berry's avatar
Karl Berry committed
65 66
@sp 2
ISBN 1-882114-06-X @*
Andrew Innes's avatar
Andrew Innes committed
Published by the Free Software Foundation @*
68 69
51 Franklin Street, Fifth Floor @*
Boston, MA 02110-1301 USA
Andrew Innes's avatar
Andrew Innes committed
70 71 72 73 74 75

@sp 2
Cover art by Etienne Suvasa.

@end titlepage
Dave Love's avatar
Dave Love committed
Andrew Innes's avatar
Andrew Innes committed
77 78 79 80 81
@node Top, Distrib, (dir), (dir)
@top The Emacs Editor

Emacs is the extensible, customizable, self-documenting real-time
display editor.  This Info file describes how to edit with Emacs and
82 83
some of how to customize it; it corresponds to GNU Emacs version
84 85 86

If you never before used the Info documentation system, type @kbd{h},
87 88
and Emacs will take you to a programmed instruction sequence for the
Info commands.
89 90
@end ifinfo

For information on extending Emacs, see @ref{Top, Emacs Lisp,, elisp, The
Andrew Innes's avatar
Andrew Innes committed
Emacs Lisp Reference Manual}.
Dave Love's avatar
Dave Love committed
@end ifnottex
Andrew Innes's avatar
Andrew Innes committed
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120

These subcategories have been deleted for simplicity
and to avoid conflicts.
Backup Files
Auto-Saving: Protection Against Disasters
Text Mode
Outline Mode
@TeX{} Mode
Formatted Text
Fortran Mode
Fortran Indentation
Shell Command History

The ones for Dired and Rmail have had the items turned into :: items
to avoid conflicts.
Also Running Shell Commands from Emacs
and Sending Mail and Registers and Minibuffer.
@end ignore

* Distrib::	        How to get the latest Emacs distribution.
* Copying::	        The GNU General Public License gives you permission
			  to redistribute GNU Emacs on certain terms;
			  it also explains that there is no warranty.
* GNU Free Documentation License:: The license for this documentation.
Andrew Innes's avatar
Andrew Innes committed
122 123
* Intro::	        An introduction to Emacs concepts.
* Glossary::	        The glossary.
Lute Kamstra's avatar
Lute Kamstra committed
* Antinews::	        Information about Emacs version 21.
Eli Zaretskii's avatar
Eli Zaretskii committed
* Mac OS::              Using Emacs in the Mac.
Andrew Innes's avatar
Andrew Innes committed
126 127
* MS-DOS::              Using Emacs on MS-DOS (otherwise known as "MS-DOG").
* Manifesto::	        What's GNU?  Gnu's Not Unix!
Luc Teirlinck's avatar
Luc Teirlinck committed
* Acknowledgments::     Major contributors to GNU Emacs.
Andrew Innes's avatar
Andrew Innes committed
129 130 131

Indexes (nodes containing large menus)
* Key Index::	        An item for each standard Emacs key sequence.
* Option Index::        An item for every command-line option.
Andrew Innes's avatar
Andrew Innes committed
133 134 135 136 137 138 139 140 141 142 143
* Command Index::       An item for each command name.
* Variable Index::      An item for each documented variable.
* Concept Index::       An item for each concept.

Important General Concepts
* Screen::	        How to interpret what you see on the screen.
* User Input::	        Kinds of input events (characters, buttons,
                          function keys).
* Keys::	        Key sequences: what you type to request one
                          editing action.
* Commands::	        Named functions run by key sequences to do editing.
* Text Characters::     Character set for text (the contents of buffers
Andrew Innes's avatar
Andrew Innes committed
145 146 147
			  and strings).
* Entering Emacs::      Starting Emacs from the shell.
* Exiting::	        Stopping or killing Emacs.
* Emacs Invocation::    Hairy startup options.
Andrew Innes's avatar
Andrew Innes committed
149 150 151 152 153 154 155 156 157

Fundamental Editing Commands
* Basic::	        The most basic editing commands.
* Minibuffer::	        Entering arguments that are prompted for.
* M-x::		        Invoking commands by their names.
* Help::	        Commands for asking Emacs about its commands.

Important Text-Changing Commands
* Mark::	        The mark: how to delimit a ``region'' of text.
158 159
* Killing::	        Killing (cutting) text.
* Yanking::	        Recovering killed text.  Moving text. (Pasting.)
Andrew Innes's avatar
Andrew Innes committed
160 161 162 163 164 165
* Accumulating Text::   Other ways of copying text.
* Rectangles::	        Operating on the text inside a rectangle on the screen.
* Registers::	        Saving a text string or a location in the buffer.
* Display::	        Controlling what text is displayed.
* Search::	        Finding or replacing occurrences of a string.
* Fixit::	        Commands especially useful for fixing typos.
166 167
* Keyboard Macros::	A keyboard macro records a sequence of
			  keystrokes to be replayed with a single command.
Andrew Innes's avatar
Andrew Innes committed
168 169 170 171 172 173

Major Structures of Emacs
* Files::	        All about handling files.
* Buffers::	        Multiple buffers; editing several files at once.
* Windows::	        Viewing two pieces of text at once.
* Frames::	        Running the same Emacs session in multiple X windows.
* International::       Using non-@acronym{ASCII} character sets (the MULE features).
Andrew Innes's avatar
Andrew Innes committed
175 176 177 178 179 180 181

Advanced Features
* Major Modes::	        Text mode vs. Lisp mode vs. C mode ...
* Indentation::	        Editing the white space at the beginnings of lines.
* Text::	        Commands and modes for editing English.
* Programs::	        Commands and modes for editing programs.
* Building::	        Compiling, running and debugging programs.
* Maintaining::         Features for maintaining large programs.
Andrew Innes's avatar
Andrew Innes committed
183 184 185 186 187 188 189 190 191 192 193
* Abbrevs::	        How to define text abbreviations to reduce
			  the number of characters you must type.
* Picture::	        Editing pictures made up of characters
			  using the quarter-plane screen model.
* Sending Mail::        Sending mail in Emacs.
* Rmail::	        Reading mail in Emacs.
* Dired::	        You can ``edit'' a directory to manage files in it.
* Calendar/Diary::      The calendar and diary facilities.
* Gnus::	        How to read netnews with Emacs.
* Shell::	        Executing shell commands from Emacs.
* Emacs Server::        Using Emacs as an editing server for @code{mail}, etc.
Eli Zaretskii's avatar
Eli Zaretskii committed
* Printing::	        Printing hardcopies of buffers or regions.
Andrew Innes's avatar
Andrew Innes committed
195 196 197 198 199
* Sorting::	        Sorting lines, paragraphs or pages within Emacs.
* Narrowing::	        Restricting display and editing to a portion
		          of the buffer.
* Two-Column::	        Splitting apart columns to edit them
		          in side-by-side windows.
200 201
* Editing Binary Files::Using Hexl mode to edit binary files.
* Saving Emacs Sessions:: Saving Emacs state from one session to the next.
Andrew Innes's avatar
Andrew Innes committed
202 203
* Recursive Edit::      A command can allow you to do editing
			  "within the command".  This is called a
Richard M. Stallman's avatar
Richard M. Stallman committed
			  "recursive editing level".
Andrew Innes's avatar
Andrew Innes committed
* Emulation::	        Emulating some other editors with Emacs.
Dave Love's avatar
Dave Love committed
* Hyperlinking::        Following links in buffers.
Andrew Innes's avatar
Andrew Innes committed
207 208 209
* Dissociated Press::   Dissociating text for fun.
* Amusements::	        Various games and hacks.
* Customization::       Modifying the behavior of Emacs.
* X Resources::         X resources for customizing Emacs.
Andrew Innes's avatar
Andrew Innes committed
211 212 213 214 215 216 217 218

Recovery from Problems
* Quitting::	        Quitting and aborting.
* Lossage::	        What to do if Emacs is hung or malfunctioning.
* Bugs::	        How and when to report a bug.
* Contributing::        How to contribute improvements to Emacs.
* Service::	        How to get help for your own Emacs needs.

219 220
Detailed Node Listing

222 223
Here are some other nodes which are really inferiors of the ones
already listed, mentioned here so you can get to them in one step:
Andrew Innes's avatar
Andrew Innes committed
224 225 226 227 228 229 230 231 232 233 234 235 236 237 238

The Organization of the Screen

* Point::	        The place in the text where editing commands operate.
* Echo Area::           Short messages appear at the bottom of the screen.
* Mode Line::	        Interpreting the mode line.
* Menu Bar::            How to use the menu bar.

Basic Editing Commands

* Inserting Text::      Inserting text by simply typing it.
* Moving Point::        How to move the cursor to the place where you want to
			  change something.
* Erasing::	        Deleting and killing text.
* Undo::	        Undoing recent changes in the text.
239 240
* Basic Files::         Visiting, creating, and saving files.
* Basic Help::          Asking what a character does.
Andrew Innes's avatar
Andrew Innes committed
241 242 243 244
* Blank Lines::	        Commands to make or delete blank lines.
* Continuation Lines::  Lines too wide for the screen.
* Position Info::       What page, line, row, or column is point on?
* Arguments::	        Numeric arguments for repeating a command.
* Repeating::           A short-cut for repeating the previous command.
Andrew Innes's avatar
Andrew Innes committed
246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262

The Minibuffer

* Minibuffer File::     Entering file names with the minibuffer.
* Minibuffer Edit::     How to edit in the minibuffer.
* Completion::		An abbreviation facility for minibuffer input.
* Minibuffer History::	Reusing recent minibuffer arguments.
* Repetition::		Re-executing commands that used the minibuffer.


* Help Summary::	Brief list of all Help commands.
* Key Help::		Asking what a key does in Emacs.
* Name Help::		Asking about a command, variable or function name.
* Apropos::		Asking what pertains to a given topic.
* Library Keywords::	Finding Lisp libraries by keywords (topics).
* Language Help::       Help relating to international language support.
* Help Mode::           Special features of Help mode and Help buffers.
Andrew Innes's avatar
Andrew Innes committed
* Misc Help::		Other help commands.
265 266
* Help Files::          Commands to display pre-written help files.
* Help Echo::           Help on active text and tooltips (`balloon help')
Andrew Innes's avatar
Andrew Innes committed
267 268 269 270 271 272

The Mark and the Region

* Setting Mark::	Commands to set the mark.
* Transient Mark::	How to make Emacs highlight the region--
			  when there is one.
* Momentary Mark::      Enabling Transient Mark mode momentarily.
Andrew Innes's avatar
Andrew Innes committed
274 275 276 277 278
* Using Region::	Summary of ways to operate on contents of the region.
* Marking Objects::	Commands to put region around textual units.
* Mark Ring::		Previous mark positions saved so you can go back there.
* Global Mark Ring::	Previous mark positions in various buffers.

Killing and Moving Text
Andrew Innes's avatar
Andrew Innes committed
280 281 282 283 284

* Deletion::		Commands for deleting small amounts of text and
			  blank areas.
* Killing by Lines::	How to kill entire lines of text at one time.
* Other Kill Commands:: Commands to kill large regions of text and
			  syntactic units such as words and sentences.
286 287
* Graphical Kill::      The kill ring on graphical terminals:
                          yanking between applications.
Andrew Innes's avatar
Andrew Innes committed
288 289 290 291 292 293 294 295 296 297 298 299 300


* Kill Ring::		Where killed text is stored.  Basic yanking.
* Appending Kills::	Several kills in a row all yank together.
* Earlier Kills::	Yanking something killed some time ago.


* RegPos::      	Saving positions in registers.
* RegText::     	Saving text in registers.
* RegRect::     	Saving rectangles in registers.
* RegConfig::           Saving window configurations in registers.
* RegNumbers::          Numbers in registers.
Andrew Innes's avatar
Andrew Innes committed
302 303 304 305 306
* RegFiles::    	File names in registers.
* Bookmarks::           Bookmarks are like registers, but persistent.

Controlling the Display

* Faces::	           How to change the display style using faces.
* Standard Faces::         Emacs' predefined faces.
309 310 311
* Font Lock::              Minor mode for syntactic highlighting using faces.
* Highlight Changes::      Using colors to show where you changed the buffer.
* Highlight Interactively:: Tell Emacs what text to highlight.
Andrew Innes's avatar
Andrew Innes committed
312 313
* Scrolling::	           Moving text up and down in a window.
* Horizontal Scrolling::   Moving text left and right in a window.
314 315
* Fringes::                Enabling or disabling window fringes.
* Useless Whitespace::     Showing possibly-spurious trailing whitespace.
Andrew Innes's avatar
Andrew Innes committed
316 317 318
* Follow Mode::            Follow mode lets two windows scroll as one.
* Selective Display::      Hiding lines with lots of indentation.
* Optional Mode Line::     Optional mode line display features.
319 320
* Text Display::           How text characters are normally displayed.
* Cursor Display::         Features for displaying the cursor.
Richard M. Stallman's avatar
Richard M. Stallman committed
* Display Custom::         Information on variables for customizing display.
Andrew Innes's avatar
Andrew Innes committed
322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347

Searching and Replacement

* Incremental Search::	   Search happens as you type the string.
* Nonincremental Search::  Specify entire string and then search.
* Word Search::		   Search for sequence of words.
* Regexp Search::	   Search for match for a regexp.
* Regexps::		   Syntax of regular expressions.
* Search Case::		   To ignore case while searching, or not.
* Replace::		   Search, and replace some or all matches.
* Other Repeating Search:: Operating on all matches for some regexp.

Replacement Commands

* Unconditional Replace::  Replacing all matches for a string.
* Regexp Replace::	   Replacing all matches for a regexp.
* Replacement and Case::   How replacements preserve case of letters.
* Query Replace::	   How to use querying.

Commands for Fixing Typos

* Kill Errors::         Commands to kill a batch of recently entered text.
* Transpose::	        Exchanging two characters, words, lines, lists...
* Fixing Case::         Correcting case of last word entered.
* Spelling::	        Apply spelling checker to a word or a whole buffer.

348 349 350 351 352 353 354 355
Keyboard Macros

* Basic Keyboard Macro::     Defining and running keyboard macros.
* Keyboard Macro Ring::      Where previous keyboard macros are saved.
* Keyboard Macro Counter::   Inserting incrementing numbers in macros.
* Keyboard Macro Query::     Making keyboard macros do different things each time.
* Save Keyboard Macro::      Giving keyboard macros names; saving them in files.
* Edit Keyboard Macro::      Editing keyboard macros.
356 357
* Keyboard Macro Step-Edit:: Interactively executing and editing a keyboard

Andrew Innes's avatar
Andrew Innes committed
359 360 361 362 363 364 365 366 367 368 369 370 371
File Handling

* File Names::          How to type and edit file-name arguments.
* Visiting::            Visiting a file prepares Emacs to edit the file.
* Saving::              Saving makes your changes permanent.
* Reverting::           Reverting cancels all the changes not saved.
* Auto Save::           Auto Save periodically protects against loss of data.
* File Aliases::        Handling multiple names for one file.
* Version Control::     Version control systems (RCS, CVS and SCCS).
* Directories::         Creating, deleting, and listing file directories.
* Comparing Files::     Finding where two files differ.
* Misc File Ops::       Other things you can do on files.
* Compressed Files::    Accessing compressed files.
* File Archives::       Operating on tar, zip, jar etc. archive files.
Andrew Innes's avatar
Andrew Innes committed
373 374
* Remote Files::        Accessing files on other sites.
* Quoted File Names::   Quoting special characters in file names.
375 376 377
* File Name Cache::     Completion against a list of files you often use.
* File Conveniences::   Convenience Features for Finding Files.
* Filesets::            Handling sets of files.
Andrew Innes's avatar
Andrew Innes committed
378 379 380

Saving Files

* Save Commands::       Commands for saving files.
Andrew Innes's avatar
Andrew Innes committed
* Backup::              How Emacs saves the old version of your file.
* Customize Save::      Customizing the saving of files.
Andrew Innes's avatar
Andrew Innes committed
384 385
* Interlocking::        How Emacs protects against simultaneous editing
                          of one file by two users.
* File Shadowing::      Copying files to "shadows" automatically.
* Time Stamps::         Emacs can update time stamps on saved files.
Andrew Innes's avatar
Andrew Innes committed
388 389 390 391

Version Control

* Introduction to VC::  How version control works in general.
* VC Mode Line::        How the mode line shows version control status.
Andrew Innes's avatar
Andrew Innes committed
393 394
* Basic VC Editing::    How to edit a file under version control.
* Old Versions::        Examining and comparing old versions.
* Secondary VC Commands:: The commands used a little less frequently.
Andrew Innes's avatar
Andrew Innes committed
* Branches::            Multiple lines of development.
* Remote Repositories:: Efficient access to remote CVS servers.
Andrew Innes's avatar
Andrew Innes committed
398 399 400 401 402 403 404 405
* Snapshots::           Sets of file versions treated as a unit.
* Miscellaneous VC::    Various other commands and features of VC.
* Customizing VC::      Variables that change VC's behavior.

Using Multiple Buffers

* Select Buffer::       Creating a new buffer or reselecting an old one.
* List Buffers::        Getting a list of buffers that exist.
Richard M. Stallman's avatar
Richard M. Stallman committed
* Misc Buffer::	        Renaming; changing read-onliness; copying text.
Andrew Innes's avatar
Andrew Innes committed
407 408 409
* Kill Buffer::	        Killing buffers you no longer need.
* Several Buffers::     How to go through the list of all buffers
			  and operate variously on several of them.
* Indirect Buffers::    An indirect buffer shares the text of another buffer.
411 412
* Buffer Convenience::  Convenience and customization features for
                          buffer handling.
Andrew Innes's avatar
Andrew Innes committed
413 414 415 416 417 418 419 420 421 422

Multiple Windows

* Basic Window::        Introduction to Emacs windows.
* Split Window::        New windows are made by splitting existing windows.
* Other Window::        Moving to another window or doing something to it.
* Pop Up Window::       Finding a file or buffer in another window.
* Force Same Window::   Forcing certain buffers to appear in the selected
                          window rather than in another window.
* Change Window::       Deleting windows and changing their sizes.
* Window Convenience::  Convenience functions for window handling.
Andrew Innes's avatar
Andrew Innes committed
424 425 426 427 428

Frames and X Windows

* Mouse Commands::      Moving, cutting, and pasting, with the mouse.
* Secondary Selection:: Cutting without altering point and mark.
Richard M. Stallman's avatar
Richard M. Stallman committed
* Clipboard::           Using the clipboard for selections.
Andrew Innes's avatar
Andrew Innes committed
430 431 432 433
* Mouse References::    Using the mouse to select an item from a list.
* Menu Mouse Clicks::   Mouse clicks that bring up menus.
* Mode Line Mouse::     Mouse clicks on the mode line.
* Creating Frames::     Creating additional Emacs frames with various contents.
Richard M. Stallman's avatar
Richard M. Stallman committed
434 435
* Frame Commands::      Iconifying, deleting, and switching frames.
* Speedbar::            How to make and use a speedbar frame.
Andrew Innes's avatar
Andrew Innes committed
436 437 438 439
* Multiple Displays::   How one Emacs job can talk to several displays.
* Special Buffer Frames::  You can make certain buffers have their own frames.
* Frame Parameters::    Changing the colors and other modes of frames.
* Scroll Bars::	        How to enable and disable scroll bars; how to use them.
Richard M. Stallman's avatar
Richard M. Stallman committed
* Wheeled Mice::        Using mouse wheels for scrolling.
* Drag and Drop::       Using drag and drop to open files and insert text.
Andrew Innes's avatar
Andrew Innes committed
* Menu Bars::	        Enabling and disabling the menu bar.
Richard M. Stallman's avatar
Richard M. Stallman committed
443 444
* Tool Bars::           Enabling and disabling the tool bar.
* Dialog Boxes::        Controlling use of dialog boxes.
* Tooltips::            Showing "tooltips", AKA "balloon help" for active text.
Richard M. Stallman's avatar
Richard M. Stallman committed
* Mouse Avoidance::     Moving the mouse pointer out of the way.
Andrew Innes's avatar
Andrew Innes committed
* Non-Window Terminals::  Multiple frames on terminals that show only one.
Richard M. Stallman's avatar
Richard M. Stallman committed
* XTerm Mouse::         Using the mouse in an XTerm terminal emulator.
Andrew Innes's avatar
Andrew Innes committed
449 450 451

International Character Set Support

* International Chars::     Basic concepts of multibyte characters.
Andrew Innes's avatar
Andrew Innes committed
453 454 455 456
* Enabling Multibyte::      Controlling whether to use multibyte characters.
* Language Environments::   Setting things up for the language you use.
* Input Methods::           Entering text characters not on your keyboard.
* Select Input Method::     Specifying your choice of input methods.
* Multibyte Conversion::    How single-byte characters convert to multibyte.
Andrew Innes's avatar
Andrew Innes committed
458 459 460 461 462 463 464
* Coding Systems::          Character set conversion when you read and
                              write files, and so on.
* Recognize Coding::        How Emacs figures out which conversion to use.
* Specify Coding::          Various ways to choose which conversion to use.
* Fontsets::                Fontsets are collections of fonts
                              that cover the whole spectrum of characters.
* Defining Fontsets::       Defining a new fontset.
465 466 467 468
* Undisplayable Characters::When characters don't display.
* Single-Byte Character Support:: You can pick one European character set
                              to use without multibyte characters.
* Charsets::                How Emacs groups its internal character codes.
Andrew Innes's avatar
Andrew Innes committed
469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491

Major Modes

* Choosing Modes::      How major modes are specified or chosen.


* Indentation Commands::  Various commands and techniques for indentation.
* Tab Stops::		  You can set arbitrary "tab stops" and then
			    indent to the next tab stop when you want to.
* Just Spaces::		  You can request indentation using just spaces.

Commands for Human Languages

* Words::	        Moving over and killing words.
* Sentences::	        Moving over and killing sentences.
* Paragraphs::	        Moving over paragraphs.
* Pages::	        Moving over pages.
* Filling::	        Filling or justifying text.
* Case::	        Changing the case of text.
* Text Mode::	        The major modes for editing text files.
* Outline Mode::        Editing outlines.
* TeX Mode::	        Editing input to the formatter TeX.
* HTML Mode::           Editing HTML, SGML, and XML files.
Andrew Innes's avatar
Andrew Innes committed
493 494
* Nroff Mode::	        Editing input to the formatter nroff.
* Formatted Text::      Editing formatted text directly in WYSIWYG fashion.
* Text Based Tables::   Editing text-based tables in WYSIWYG fashion.
Andrew Innes's avatar
Andrew Innes committed
496 497 498 499

Filling Text

* Auto Fill::	        Auto Fill mode breaks long lines automatically.
* Refill::              Keeping paragraphs filled.
Andrew Innes's avatar
Andrew Innes committed
501 502 503 504
* Fill Commands::       Commands to refill paragraphs and center lines.
* Fill Prefix::	        Filling paragraphs that are indented
                          or in a comment, etc.
* Adaptive Fill::       How Emacs can determine the fill prefix automatically.
* Longlines::           Editing text with very long lines.
Andrew Innes's avatar
Andrew Innes committed
506 507 508 509

Editing Programs

* Program Modes::       Major modes for editing programs.
510 511
* Defuns::              Commands to operate on major top-level parts
                          of a program.
Andrew Innes's avatar
Andrew Innes committed
* Program Indent::      Adjusting indentation to show the nesting.
* Parentheses::         Commands that operate on parentheses.
* Comments::	        Inserting, killing, and aligning comments.
Andrew Innes's avatar
Andrew Innes committed
* Documentation::       Getting documentation of functions you plan to call.
516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531
* Hideshow::            Displaying blocks selectively.
* Symbol Completion::   Completion on symbol names of your program or language.
* Glasses::             Making identifiersLikeThis more readable.
* Misc for Programs::   Other Emacs features useful for editing programs.
* C Modes::             Special commands of C, C++, Objective-C,
                          Java, and Pike modes.
* Fortran::             Fortran mode and its special features.
* Asm Mode::            Asm mode and its special features.

Top-Level Definitions, or Defuns

* Left Margin Paren::   An open-paren or similar opening delimiter
                          starts a defun if it is at the left margin.
* Moving by Defuns::    Commands to move over or mark a major definition.
* Imenu::               Making buffer indexes as menus.
* Which Function::      Which Function mode shows which function you are in.
Andrew Innes's avatar
Andrew Innes committed
532 533 534 535

Indentation for Programs

* Basic Indent::	Indenting a single line.
* Multi-line Indent::   Commands to reindent many lines at once.
Andrew Innes's avatar
Andrew Innes committed
* Lisp Indent::		Specifying how each Lisp function should be indented.
538 539
* C Indent::		Extra features for indenting C and related modes.
* Custom C Indent::	Controlling indentation style for C and related modes.
Andrew Innes's avatar
Andrew Innes committed

Commands for Editing with Parentheses
Andrew Innes's avatar
Andrew Innes committed

543 544 545 546
* Expressions::         Expressions with balanced parentheses.
* Moving by Parens::    Commands for moving up, down and across
                          in the structure of parentheses.
* Matching::	        Insertion of a close-delimiter flashes matching open.
Andrew Innes's avatar
Andrew Innes committed

Manipulating Comments
Andrew Innes's avatar
Andrew Innes committed

550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570
* Comment Commands::    Inserting, killing, and indenting comments.
* Multi-Line Comments:: Commands for adding and editing multi-line comments.
* Options for Comments::Customizing the comment features.

Documentation Lookup

* Info Lookup::         Looking up library functions and commands
                          in Info files.
* Man Page::            Looking up man pages of library functions and commands.
* Lisp Doc::            Looking up Emacs Lisp functions, etc.

C and Related Modes

* Motion in C::         Commands to move by C statements, etc.
* Electric C::          Colon and other chars can automatically reindent.
* Hungry Delete::       A more powerful DEL command.
* Other C Commands::    Filling comments, viewing expansion of macros,
                          and other neat features.

Fortran Mode

571 572 573 574 575 576
* Fortran Motion::	Moving point by statements or subprograms.
* Fortran Indent::	Indentation commands for Fortran.
* Fortran Comments::	Inserting and aligning comments.
* Fortran Autofill::	Auto fill minor mode for Fortran.
* Fortran Columns::	Measuring columns for valid Fortran.
* Fortran Abbrev::	Built-in abbrevs for Fortran keywords.
Andrew Innes's avatar
Andrew Innes committed
577 578 579 580 581 582 583 584

Compiling and Testing Programs

* Compilation::		Compiling programs in languages other
			  than Lisp (C, Pascal, etc.).
* Compilation Mode::    The mode for visiting compiler errors.
* Compilation Shell::   Customizing your shell properly
                          for use in the compilation buffer.
585 586
* Grep Searching::      Searching with grep.
* Flymake::             Finding syntax errors on the fly.
587 588
* Debuggers::		Running symbolic debuggers for non-Lisp programs.
* Executing Lisp::	Various modes for editing Lisp programs,
Andrew Innes's avatar
Andrew Innes committed
			  with different facilities for running
			  the Lisp programs.
Andrew Innes's avatar
Andrew Innes committed
591 592
* Lisp Libraries::      Creating Lisp programs to run in Emacs.
* Lisp Eval::		Executing a single Lisp expression in Emacs.
* Lisp Interaction::    Executing Lisp in an Emacs buffer.
* External Lisp::	Communicating through Emacs with a separate Lisp.
Andrew Innes's avatar
Andrew Innes committed
595 596 597 598 599 600 601

Running Debuggers Under Emacs

* Starting GUD::	How to start a debugger subprocess.
* Debugger Operation::	Connection between the debugger and source buffers.
* Commands of GUD::	Key bindings for common commands.
* GUD Customization::	Defining your own commands for GUD.
602 603 604
* GDB Graphical Interface::  An enhanced mode that uses GDB features to
                          implement a graphical debugging environment through
Andrew Innes's avatar
Andrew Innes committed

606 607 608
Maintaining Programs

* Change Log::	        Maintaining a change history for your program.
* Authors::             Maintaining the Emacs @file{AUTHORS} file.
@end ignore
612 613 614 615 616 617
* Tags::	        Go direct to any function in your program in one
			  command.  Tags remembers which file it is in.
* Emerge::	        A convenient way of merging two versions of a program.

Tags Tables

* Tag Syntax::		Tag syntax for various types of code and text files.
* Create Tags Table::	Creating a tags table with @code{etags}.
* Etags Regexps::       Create arbitrary tags using regular expressions.
* Select Tags Table::	How to visit a tags table.
* Find Tag::		Commands to find the definition of a specific tag.
623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638
* Tags Search::		Using a tags table for searching and replacing.
* List Tags::		Listing and finding tags defined in a file.

Merging Files with Emerge

* Overview of Emerge::	How to start Emerge.  Basic concepts.
* Submodes of Emerge::	Fast mode vs. Edit mode.
			  Skip Prefers mode and Auto Advance mode.
* State of Difference::	You do the merge by specifying state A or B
			  for each difference.
* Merge Commands::	Commands for selecting a difference,
			  changing states of differences, etc.
* Exiting Emerge::	What to do when you've finished the merge.
* Combining in Emerge::	    How to keep both alternatives for a difference.
* Fine Points of Emerge::   Misc.

Andrew Innes's avatar
Andrew Innes committed
639 640 641 642 643 644 645 646

* Abbrev Concepts::     Fundamentals of defined abbrevs.
* Defining Abbrevs::    Defining an abbrev, so it will expand when typed.
* Expanding Abbrevs::   Controlling expansion: prefixes, canceling expansion.
* Editing Abbrevs::     Viewing or editing the entire list of defined abbrevs.
* Saving Abbrevs::      Saving the entire list of abbrevs for another session.
* Dynamic Abbrevs::     Abbreviations for words already in the buffer.
* Dabbrev Customization:: What is a word, for dynamic abbrevs.  Case handling.
Andrew Innes's avatar
Andrew Innes committed
648 649 650 651 652 653 654 655 656 657 658 659 660 661 662

Editing Pictures

* Basic Picture::	Basic concepts and simple commands of Picture Mode.
* Insert in Picture::	Controlling direction of cursor motion
			  after "self-inserting" characters.
* Tabs in Picture::	Various features for tab stops and indentation.
* Rectangles in Picture:: Clearing and superimposing rectangles.

Sending Mail

* Mail Format:: 	Format of the mail being composed.
* Mail Headers::        Details of permitted mail header fields.
* Mail Aliases::        Abbreviating and grouping mail addresses.
* Mail Mode::   	Special commands for editing mail being composed.
* Mail Amusements::     Distract the NSA's attention; add a fortune to a msg.
Andrew Innes's avatar
Andrew Innes committed
664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680
* Mail Methods::        Using alternative mail-composition methods.

Reading Mail with Rmail

* Rmail Basics::        Basic concepts of Rmail, and simple use.
* Rmail Scrolling::     Scrolling through a message.
* Rmail Motion::        Moving to another message.
* Rmail Deletion::      Deleting and expunging messages.
* Rmail Inbox::         How mail gets into the Rmail file.
* Rmail Files::         Using multiple Rmail files.
* Rmail Output::        Copying message out to files.
* Rmail Labels::        Classifying messages by labeling them.
* Rmail Attributes::    Certain standard labels, called attributes.
* Rmail Reply::         Sending replies to messages you are viewing.
* Rmail Summary::       Summaries show brief info on many messages.
* Rmail Sorting::       Sorting messages in Rmail.
* Rmail Display::       How Rmail displays a message; customization.
* Rmail Coding::        How Rmail handles decoding character sets.
Andrew Innes's avatar
Andrew Innes committed
682 683 684 685 686
* Rmail Editing::       Editing message text and headers in Rmail.
* Rmail Digest::        Extracting the messages from a digest message.
* Out of Rmail::	Converting an Rmail file to mailbox format.
* Rmail Rot13::         Reading messages encoded in the rot13 code.
* Movemail::            More details of fetching new mail.
687 688 689
* Remote Mailboxes::    Retrieving Mail from Remote Mailboxes.
* Other Mailbox Formats:: Retrieving Mail from Local Mailboxes in
                          Various Formats
Andrew Innes's avatar
Andrew Innes committed
690 691 692 693

Dired, the Directory Editor

* Dired Enter:: 	     How to invoke Dired.
* Dired Navigation::         How to move in the Dired buffer.
Andrew Innes's avatar
Andrew Innes committed
695 696 697 698 699 700 701 702 703 704 705 706 707 708
* Dired Deletion::           Deleting files with Dired.
* Flagging Many Files::      Flagging files based on their names.
* Dired Visiting::           Other file operations through Dired.
* Marks vs Flags::	     Flagging for deletion vs marking.
* Operating on Files::	     How to copy, rename, print, compress, etc.
			       either one file or several files.
* Shell Commands in Dired::  Running a shell command on the marked files.
* Transforming File Names::  Using patterns to rename multiple files.
* Comparison in Dired::	     Running `diff' by way of Dired.
* Subdirectories in Dired::  Adding subdirectories to the Dired buffer.
* Subdirectory Motion::	     Moving across subdirectories, and up and down.
* Hiding Subdirectories::    Making subdirectories visible or invisible.
* Dired Updating::           Discarding lines for files of no interest.
* Dired and Find::	     Using `find' to choose the files for Dired.
709 710
* Wdired::                   Operating on files by editing the Dired buffer.
* Misc Dired Features::      Various other features.
Andrew Innes's avatar
Andrew Innes committed
711 712 713 714 715 716 717

The Calendar and the Diary

* Calendar Motion::     Moving through the calendar; selecting a date.
* Scroll Calendar::     Bringing earlier or later months onto the screen.
* Counting Days::       How many days are there between two dates?
* General Calendar::    Exiting or recomputing the calendar.
* LaTeX Calendar::      Print a calendar using LaTeX.
Andrew Innes's avatar
Andrew Innes committed
719 720 721 722 723 724
* Holidays::            Displaying dates of holidays.
* Sunrise/Sunset::      Displaying local times of sunrise and sunset.
* Lunar Phases::        Displaying phases of the moon.
* Other Calendars::     Converting dates to other calendar systems.
* Diary::               Displaying events from your diary.
* Appointments::	Reminders when it's time to do something.
* Importing Diary::     Converting diary events to/from other formats.
Andrew Innes's avatar
Andrew Innes committed
* Daylight Savings::    How to specify when daylight savings time is active.
* Time Intervals::      Keeping track of time intervals.
Andrew Innes's avatar
Andrew Innes committed
728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745

Movement in the Calendar

* Calendar Unit Motion::      Moving by days, weeks, months, and years.
* Move to Beginning or End::  Moving to start/end of weeks, months, and years.
* Specified Dates::	      Moving to the current date or another
				specific date.

Conversion To and From Other Calendars

* Calendar Systems::	   The calendars Emacs understands
			     (aside from Gregorian).
* To Other Calendar::	   Converting the selected date to various calendars.
* From Other Calendar::	   Moving to a date specified in another calendar.
* Mayan Calendar::	   Moving to a date specified in a Mayan calendar.

The Diary

* Displaying the Diary::   Viewing diary entries and associated calendar dates.
Andrew Innes's avatar
Andrew Innes committed
747 748 749 750 751
* Format of Diary File::   Entering events in your diary.
* Date Formats::	   Various ways you can specify dates.
* Adding to Diary::	   Commands to create diary entries.
* Special Diary Entries::  Anniversaries, blocks of dates, cyclic entries, etc.

Andrew Innes's avatar
Andrew Innes committed
753 754 755 756 757 758 759 760 761 762

* Buffers of Gnus::	The group, summary, and article buffers.
* Gnus Startup::	What you should know about starting Gnus.
* Summary of Gnus::	A short description of the basic Gnus commands.

Running Shell Commands from Emacs

* Single Shell::	How to run one shell command and return.
* Interactive Shell::	Permanent shell taking input via Emacs.
* Shell Mode::		Special Emacs commands used with permanent shell.
* Shell Prompts::       Two ways to recognize shell prompts.
Andrew Innes's avatar
Andrew Innes committed
* Shell History::       Repeating previous commands in a shell buffer.
* Directory Tracking::  Keeping track when the subshell changes directory.
Andrew Innes's avatar
Andrew Innes committed
* Shell Options::       Options for customizing Shell mode.
767 768 769
* Terminal emulator::   An Emacs window as a terminal emulator.
* Term Mode::           Special Emacs commands used in Term mode.
* Paging in Term::      Paging in the terminal emulator.
Andrew Innes's avatar
Andrew Innes committed
770 771
* Remote Host::		Connecting to another computer.

772 773 774 775 776 777 778 779 780 781
Using Emacs as a Server

* Invoking emacsclient:: Emacs client startup options.

Hyperlinking and Navigation Features

* Browse-URL::          Following URLs.
* Goto-address::        Activating URLs.
* FFAP::                Finding files etc. at point.

Andrew Innes's avatar
Andrew Innes committed
782 783 784 785

* Minor Modes::		Each minor mode is one feature you can turn on
			  independently of any others.
* Easy Customization::  Convenient way to browse and change user options.
Andrew Innes's avatar
Andrew Innes committed
787 788 789 790 791 792
* Variables::		Many Emacs commands examine Emacs variables
			  to decide what to do; by setting variables,
			  you can control their functioning.
* Key Bindings::	The keymaps say what command each key runs.
			  By changing them, you can "redefine keys".
* Syntax::		The syntax table controls how words and
			  expressions are parsed.
Andrew Innes's avatar
Andrew Innes committed
* Init File::		How to write common customizations in the
			  @file{.emacs} file.
Andrew Innes's avatar
Andrew Innes committed
796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814


* Examining::	        Examining or setting one variable's value.
* Hooks::	        Hook variables let you specify programs for parts
		          of Emacs to run on particular occasions.
* Locals::	        Per-buffer values of variables.
* File Variables::      How files can specify variable values.

Customizing Key Bindings

* Keymaps::             Generalities.  The global keymap.
* Prefix Keymaps::      Keymaps for prefix keys.
* Local Keymaps::       Major and minor modes have their own keymaps.
* Minibuffer Maps::     The minibuffer uses its own local keymaps.
* Rebinding::           How to redefine one key's meaning conveniently.
* Init Rebinding::      Rebinding keys with your init file, @file{.emacs}.
* Function Keys::       Rebinding terminal function keys.
* Named ASCII Chars::   Distinguishing @key{TAB} from @kbd{C-i}, and so on.
* Non-ASCII Rebinding:: Rebinding non-@acronym{ASCII} characters such as Latin-1.
Andrew Innes's avatar
Andrew Innes committed
816 817 818 819 820 821 822 823 824 825 826 827 828 829
* Mouse Buttons::       Rebinding mouse buttons in Emacs.
* Disabling::           Disabling a command means confirmation is required
                          before it can be executed.  This is done to protect
                          beginners from surprises.

The Init File, @file{~/.emacs}

* Init Syntax::	        Syntax of constants in Emacs Lisp.
* Init Examples::       How to do some things with an init file.
* Terminal Init::       Each terminal type can have an init file.
* Find Init::	        How Emacs finds the init file.

Dealing with Emacs Trouble

* DEL Does Not Delete:: What to do if @key{DEL} doesn't delete.
Andrew Innes's avatar
Andrew Innes committed
831 832 833 834 835
* Stuck Recursive::     `[...]' in mode line around the parentheses.
* Screen Garbled::      Garbage on the screen.
* Text Garbled::        Garbage in the text.
* Unasked-for Search::  Spontaneous entry to incremental search.
* Memory Full::         How to cope when you run out of memory.
* After a Crash::       Recovering editing in an Emacs session that crashed.
Andrew Innes's avatar
Andrew Innes committed
837 838 839 840 841 842
* Emergency Escape::    Emergency escape---
                          What to do if Emacs stops responding.
* Total Frustration::   When you are at your wits' end.

Reporting Bugs

843 844 845 846
* Bug Criteria::        Have you really found a bug?
* Understanding Bug Reporting::	How to report a bug effectively.
* Checklist::		Steps to follow for a good bug report.
* Sending Patches::	How to send a patch for GNU Emacs.
Andrew Innes's avatar
Andrew Innes committed

Command Line Arguments for Emacs Invocation
Andrew Innes's avatar
Andrew Innes committed
849 850 851 852 853 854 855 856 857

* Action Arguments::	Arguments to visit files, load libraries,
			  and call functions.
* Initial Options::     Arguments that take effect while starting Emacs.
* Command Example::     Examples of using command line arguments.
* Resume Arguments::	Specifying arguments when you resume a running Emacs.
* Environment::         Environment variables that Emacs uses.
* Display X::           Changing the default display and using remote login.
* Font X::	        Choosing a font for text, under X.
Pavel Janík's avatar
Pavel Janík committed
* Colors::	        Choosing display colors.
Andrew Innes's avatar
Andrew Innes committed
859 860 861 862
* Window Size X::       Start-up window size, under X.
* Borders X::	        Internal and external borders, under X.
* Title X::             Specifying the initial frame's title.
* Icons X::             Choosing what sort of icon to use, under X.
* Misc X::              Other display options.

865 866 867 868 869 870 871
Environment Variables

* General Variables::	Environment variables that all versions of Emacs use.
* Misc Variables::	Certain system specific variables.
* MS-Windows Registry:: An alternative to the environment on MS-Windows.

X Options and Resources
872 873 874 875

* Resources::           Using X resources with Emacs (in general).
* Table of Resources::  Table of specific X resources that affect Emacs.
* Face Resources::      X resources for customizing faces.
Andrew Innes's avatar
Andrew Innes committed
* Lucid Resources::     X resources for Lucid menus.
* LessTif Resources::   X resources for LessTif and Motif menus.
* GTK resources::       Resources for GTK widgets.
Andrew Innes's avatar
Andrew Innes committed

Emacs and Mac OS
Andrew Innes's avatar
Andrew Innes committed

882 883
* Mac Input::           Keyboard and mouse input on Mac.
* Mac International::   International character sets on Mac.
* Mac Environment Variables::  Setting environment variables for Emacs.
885 886
* Mac Directories::     Volumes and directories on Mac.
* Mac Font Specs::      Specifying fonts on Mac.
* Mac Functions::       Mac-specific Lisp functions.
Andrew Innes's avatar
Andrew Innes committed

MS-DOS and Windows 95/98/NT
Andrew Innes's avatar
Andrew Innes committed

891 892
* MS-DOS Keyboard::     Keyboard usage on MS-DOS.
* MS-DOS Mouse::        Mouse usage on MS-DOS.
Andrew Innes's avatar
Andrew Innes committed
893 894 895 896
* MS-DOS Display::      Fonts, frames and display size on MS-DOS.
* MS-DOS File Names::   File-name conventions on MS-DOS.
* Text and Binary::     Text files on MS-DOS use CRLF to separate lines.
* MS-DOS Printing::     How to specify the printer on MS-DOS.
* MS-DOS and MULE::     Support for internationalization on MS-DOS.
Andrew Innes's avatar
Andrew Innes committed
898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935
* MS-DOS Processes::    Running subprocesses on MS-DOS.
* Windows Processes::   Running subprocesses on Windows.
* Windows System Menu:: Controlling what the ALT key does.
@end menu

@unnumbered Preface

  This manual documents the use and simple customization of the Emacs
editor.  The reader is not expected to be a programmer; simple
customizations do not require programming skill.  But the user who is not
interested in customizing can ignore the scattered customization hints.

  This is primarily a reference manual, but can also be used as a
primer.  For complete beginners, it is a good idea to start with the
on-line, learn-by-doing tutorial, before reading the manual.  To run the
tutorial, start Emacs and type @kbd{C-h t}.  This way you can learn
Emacs by using Emacs on a specially designed file which describes
commands, tells you when to try them, and then explains the results you

  On first reading, just skim chapters 1 and 2, which describe the
notational conventions of the manual and the general appearance of the
Emacs display screen.  Note which questions are answered in these
chapters, so you can refer back later.  After reading chapter 4, you
should practice the commands there.  The next few chapters describe
fundamental techniques and concepts that are used constantly.  You need
to understand them thoroughly, experimenting with them if necessary.

  Chapters 14 through 19 describe intermediate-level features that are
useful for all kinds of editing.  Chapter 20 and following chapters
describe features that you may or may not want to use; read those
chapters when you need them.

  Read the Trouble chapter if Emacs does not seem to be working
properly.  It explains how to cope with some common problems
(@pxref{Lossage}), as well as when and how to report Emacs bugs

Andrew Innes's avatar
Andrew Innes committed
937 938 939 940 941 942 943 944 945 946 947 948 949 950 951
  To find the documentation on a particular command, look in the index.
Keys (character commands) and command names have separate indexes.  There
is also a glossary, with a cross reference for each term.

  This manual is available as a printed book and also as an Info file.
The Info file is for on-line perusal with the Info program, which will
be the principal way of viewing documentation on-line in the GNU system.
Both the Info file and the Info program itself are distributed along
with GNU Emacs.  The Info file and the printed book contain
substantially the same text and are generated from the same source
files, which are also distributed along with GNU Emacs.

  GNU Emacs is a member of the Emacs editor family.  There are many Emacs
editors, all sharing common principles of organization.  For information on
the underlying philosophy of Emacs and the lessons learned from its
952 953
development, write for a copy of AI memo 519a, @cite{Emacs, the Extensible,
Customizable Self-Documenting Display Editor}, to Publications Department,
Andrew Innes's avatar
Andrew Innes committed
954 955
Artificial Intelligence Lab, 545 Tech Square, Cambridge, MA 02139, USA@.  At
last report they charge $2.25 per copy.  Another useful publication is LCS
TM-165, @cite{A Cookbook for an Emacs}, by Craig Finseth, available from
Andrew Innes's avatar
Andrew Innes committed
957 958 959 960 961 962 963 964 965 966 967
Publications Department, Laboratory for Computer Science, 545 Tech Square,
Cambridge, MA 02139, USA@.  The price today is $3.

This edition of the manual is intended for use with GNU Emacs installed
on GNU and Unix systems.  GNU Emacs can also be used on VMS, MS-DOS
(also called MS-DOG), Windows NT, and Windows 95 systems.  Those systems use
different file name syntax; in addition, VMS and MS-DOS do not support
all GNU Emacs features.  We don't try to describe VMS usage in this
manual.  @xref{MS-DOS}, for information about using Emacs on MS-DOS.
@end iftex

@node Distrib, Intro, Top, Top
Andrew Innes's avatar
Andrew Innes committed
969 970 971
@unnumbered Distribution

GNU Emacs is @dfn{free software}; this means that everyone is free to
972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990
use it and free to redistribute it on certain conditions.  GNU Emacs
is not in the public domain; it is copyrighted and there are
restrictions on its distribution, but these restrictions are designed
to permit everything that a good cooperating citizen would want to do.
What is not allowed is to try to prevent others from further sharing
any version of GNU Emacs that they might get from you.  The precise
conditions are found in the GNU General Public License that comes with
Emacs and also appears in this manual@footnote{This manual is itself
covered by the GNU Free Documentation License.  This license is
similar in spirit to the General Public License, but is more suitable
for documentation.  @xref{GNU Free Documentation License}.}.

One way to get a copy of GNU Emacs is from someone else who has it.
You need not ask for our permission to do so, or tell any one else;
just copy it.  If you have access to the Internet, you can get the
latest distribution version of GNU Emacs by anonymous FTP; see
@url{http://www.gnu.org/software/emacs} on our website for more
Andrew Innes's avatar
Andrew Innes committed
991 992 993 994 995 996 997 998 999

You may also receive GNU Emacs when you buy a computer.  Computer
manufacturers are free to distribute copies on the same terms that apply to
everyone else.  These terms require them to give you the full sources,
including whatever changes they may have made, and to permit you to
redistribute the GNU Emacs received from them under the usual terms of the
General Public License.  In other words, the program must be free for you
when you get it, not just free for the manufacturer.

You can also order copies of GNU Emacs from the Free Software
1001 1002 1003 1004 1005 1006
Foundation.  This is a convenient and reliable way to get a copy; it is
also a good way to help fund our work.  We also sell hardcopy versions
of this manual and @cite{An Introduction to Programming in Emacs Lisp},
by Robert J. Chassell.  You can find an order form on our web site at
@url{http://www.gnu.org/order/order.html}.  For further information,
write to
Andrew Innes's avatar
Andrew Innes committed
1007 1008 1009

Free Software Foundation
1010 1011
51 Franklin Street, Fifth Floor
Boston, MA 02110-1301
Andrew Innes's avatar
Andrew Innes committed
1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026
@end display

The income from distribution fees goes to support the foundation's
purpose: the development of new free software, and improvements to our
existing programs including GNU Emacs.

If you find GNU Emacs useful, please @strong{send a donation} to the
Free Software Foundation to support our work.  Donations to the Free
Software Foundation are tax deductible in the US.  If you use GNU Emacs
at your workplace, please suggest that the company make a donation.  If
company policy is unsympathetic to the idea of donating to charity, you
might instead suggest ordering a CD-ROM from the Foundation
occasionally, or subscribing to periodic updates.

1028 1029
@node Acknowledgments, Intro, Distrib, Top
@unnumberedsec Acknowledgments

1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061
Contributors to GNU Emacs include Per Abrahamsen, Tomas Abrahamsson,
Jay K.@: Adams, Joe Arceneaux, Miles Bader, David Bakhash, Eli
Barzilay, Steven L.@: Baur, Boaz Ben-Zvi, Ray Blaak, Jim Blandy, Per
Bothner, Terrence Brannon, Frank Bresz, Peter Breton, Emmanuel Briot,
Kevin Broadey, Vincent Broman, David M.@: Brown, Georges Brun-Cottan,
W@l{}odek Bzyl, Bill Carpenter, Per Cederqvist, Hans Chalupsky, Chris
Chase, Bob Chassell, Andrew Choi, James Clark, Mike Clarkson, Glynn
Clements, Andrew Csillag, Doug Cutting, Michael DeCorte, Gary Delp,
Matthieu Devin, Eri Ding, Jan Dj@"{a}rv, Carsten Dominik, Scott
Draves, Benjamin Drieu, Viktor Dukhovni, John Eaton, Rolf Ebert,
Stephen Eglen, Torbj@"orn Einarsson, Tsugutomo Enami, Hans Henrik
Eriksen, Michael Ernst, Ata Etemadi, Frederick Farnbach, Oscar
Figueiredo, Fred Fish, Karl Fogel, Gary Foster, Noah Friedman,
Hallvard Furuseth, Keith Gabryelski, Kevin Gallagher, Kevin Gallo,
Juan Le@'{o}n Lahoz Garc@'{i}a, Howard Gayle, Stephen Gildea, Julien
Gilles, David Gillespie, Bob Glickstein, Boris Goldowsky, Michelangelo
Grigni, Odd Gripenstam, Kai Gro@ss{}johann, Michael Gschwind, Henry
Guillaume, Doug Gwyn, Ken'ichi Handa, Chris Hanson, K. Shane Hartman,
John Heidemann, Jon K.@: Hellan, Markus Heritsch, Karl Heuer, Manabu
Higashida, Anders Holst, Kurt Hornik, Tom Houlder, Denis Howe, Lars
Ingebrigtsen, Andrew Innes, Seiichiro Inoue, Ulf Jasper, Michael
K. Johnson, Kyle Jones, Terry Jones, Simon Josefsson, Tomoji Kagatani,
Brewster Kahle, David Kaufman, Henry Kautz, Taichi Kawabata, Howard
Kaye, Michael Kifer, Richard King, Peter Kleiweg, Larry K.@: Kolodney,
Pavel Kobiakov, Larry K.@: Kolodney, David M.@: Koppelman, Koseki
Yoshinori, Robert Krawitz, Sebastian Kremer, Ryszard Kubiak, Geoff
Kuenning, David K@aa{}gedal, Daniel LaLiberte, Aaron Larson, James
R.@: Larus, Vinicius Jose Latorre, Frederic Lepied, Peter Liljenberg,
Lars Lindberg, Chris Lindblad, Anders Lindgren, Thomas Link, Dave
Love, Eric Ludlam, Alan Mackenzie, Christopher J.@: Madsen,
Neil M.@: Mager, Ken Manheimer, Bill Mann, Brian Marick, Simon
Andrew Innes's avatar
Andrew Innes committed
Marshall, Bengt Martensson, Charlie Martin, Thomas May, Roland McGrath,
1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094
Will Mengarini, David Megginson, Wayne Mesard, Brad Miller, Richard
Mlynarik, Gerd Moellmann, Stefan Monnier, Morioka Tomohiko, Keith
Moore, Sen Nagata, Erik Naggum, Thomas Neumann, Thien-Thi Nguyen, Mike
Newton, Jurgen Nickelsen, Dan Nicolaescu, Jeff Norden, Andrew Norman,
Alexandre Oliva, Bob Olson, Takaaki Ota, Pieter E.@: J.@: Pareit,
David Pearson, Jeff Peck, Damon Anton Permezel, Tom Perrine, William
M.@: Perry, Per Persson, Jens Petersen, Daniel Pfeiffer, Richard
L.@: Pieri, Fred Pierresteguy, Christian Plaunt, David Ponce, Francesco
A. Potorti, Michael D. Prange, Mukesh Prasad, Marko Rahamaa, Ashwin
Ram, Eric S. Raymond, Paul Reilly, Edward M. Reingold, Alex Rezinsky,
Rob Riepel, Nick Roberts, Roland B.@: Roberts, John Robinson, Danny
Roozendaal, William Rosenblatt, Guillermo J.@: Rozas, Ivar Rummelhoff,
Jason Rumney, Wolfgang Rupprecht, Kevin Ryde, James B. Salem, Masahiko
Sato, Holger Schauer, William Schelter, Ralph Schleicher, Gregor
Schmid, Michael Schmidt, Ronald S. Schnell, Philippe Schnoebelen, Jan
Schormann, Alex Schroeder, Stephen Schoef, Randal Schwartz, Oliver
Seidel, Manuel Serrano, Hovav Shacham, Stanislav Shalunov, Mark
Shapiro, Richard Sharman, Olin Shivers, Espen Skoglund, Rick Sladkey,
Lynn Slater, Chris Smith, David Smith, Paul D.@: Smith, Andre Spiegel,
Michael Staats, William Sommerfeld, Michael Staats, Sam Steingold, Ake
Stenhoff, Peter Stephenson, Ken Stevens, Jonathan Stigelman, Martin
Stjernholm, Kim F.@: Storm, Steve Strassman, Olaf Sylvester, Naoto
Takahashi, Jean-Philippe Theberge, Jens T.@: Berger Thielemann,
Spencer Thomas, Jim Thompson, Tom Tromey, Daiki Ueno, Masanobu Umeda,
Rajesh Vaidheeswarran, Neil W.@: Van Dyke, Didier Verna, Ulrik Vieth,
Geoffrey Voelker, Johan Vromans, Inge Wallin, Colin Walters, Barry
Warsaw, Morten Welinder, Joseph Brian Wells, Rodney Whitby, John
Wiegley, Ed Wilkinson, Mike Williams, Bill Wohler, Steven A. Wood,
Dale R.@: Worley, Francis J.@: Wright, Felix S. T. Wu, Tom Wurgler,
Masatake Yamato, Jonathan Yavner, Ilya Zakharevich, Milan Zamazal,
Victor Zandy, Eli Zaretskii, Jamie Zawinski, Shenghuo Zhu, Ian
T.@: Zimmermann, Reto Zimmermann, Neal Ziring, and Detlev Zundel.
@end iftex
Andrew Innes's avatar
Andrew Innes committed

1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142
@node Intro, Glossary, Distrib, Top
@unnumbered Introduction

  You are reading about GNU Emacs, the GNU incarnation of the advanced,
self-documenting, customizable, extensible real-time display editor Emacs.
(The `G' in `GNU' is not silent.)

  We say that Emacs is a @dfn{display} editor because normally the text
being edited is visible on the screen and is updated automatically as you
type your commands.  @xref{Screen,Display}.

  We call it a @dfn{real-time} editor because the display is updated very
frequently, usually after each character or pair of characters you
type.  This minimizes the amount of information you must keep in your
head as you edit.  @xref{Basic,Real-time,Basic Editing}.

  We call Emacs advanced because it provides facilities that go beyond
simple insertion and deletion: controlling subprocesses; automatic
indentation of programs; viewing two or more files at once; editing
formatted text; and dealing in terms of characters, words, lines,
sentences, paragraphs, and pages, as well as expressions and comments in
several different programming languages.

  @dfn{Self-documenting} means that at any time you can type a special
character, @kbd{Control-h}, to find out what your options are.  You can
also use it to find out what any command does, or to find all the commands
that pertain to a topic.  @xref{Help}.

  @dfn{Customizable} means that you can change the definitions of Emacs
commands in little ways.  For example, if you use a programming language in
which comments start with @samp{<**} and end with @samp{**>}, you can tell
the Emacs comment manipulation commands to use those strings
(@pxref{Comments}).  Another sort of customization is rearrangement of the
command set.  For example, if you prefer the four basic cursor motion
commands (up, down, left and right) on keys in a diamond pattern on the
keyboard, you can rebind the keys that way.  @xref{Customization}.

  @dfn{Extensible} means that you can go beyond simple customization and
write entirely new commands, programs in the Lisp language to be run by
Emacs's own Lisp interpreter.  Emacs is an ``on-line extensible''
system, which means that it is divided into many functions that call
each other, any of which can be redefined in the middle of an editing
session.  Almost any part of Emacs can be replaced without making a
separate copy of all of Emacs.  Most of the editing commands of Emacs
are written in Lisp; the few exceptions could have been written
in Lisp but are written in C for efficiency.  Although only a programmer
1143 1144 1145
can write an extension, anybody can use it afterward.  @xref{Top,
Emacs Lisp Intro, Preface, eintr, An Introduction to Programming in
Emacs Lisp}, if you want to learn Emacs Lisp programming.
1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189

   When run under the X Window System, Emacs provides its own menus and
convenient bindings to mouse buttons.  But Emacs can provide many of the
benefits of a window system on a text-only terminal.  For instance, you
can look at or edit several files at once, move text between files, and
edit files while running shell commands.

@include screen.texi
@include commands.texi
@include entering.texi
@include basic.texi
@include mini.texi
@include m-x.texi
@include help.texi
@include mark.texi
@include killing.texi
@include regs.texi
@include display.texi
@include search.texi
@include fixit.texi
@include kmacro.texi
@include files.texi
@include buffers.texi
@include windows.texi
@include frames.texi
@include mule.texi
@include major.texi
@include indent.texi
@include text.texi
@include programs.texi
@include building.texi
@include maintaining.texi
@include abbrevs.texi
@include picture.texi
@include sending.texi
@include rmail.texi
@include dired.texi
@include calendar.texi
@include misc.texi
@include custom.texi
@include trouble.texi

@node Copying, GNU Free Documentation License, Service, Top
Andrew Innes's avatar
Andrew Innes committed
1190 1191 1192 1193
@center Version 2, June 1991

Copyright @copyright{} 1989, 1991 Free Software Foundation, Inc.
51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
Andrew Innes's avatar
Andrew Innes committed
1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208

Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
@end display

@unnumberedsec Preamble

  The licenses for most software are designed to take away your
freedom to share and change it.  By contrast, the GNU General Public
License is intended to guarantee your freedom to share and change free
software---to make sure the software is free for all its users.  This
General Public License applies to most of the Free Software
Foundation's software and to any other program whose authors commit to
using it.  (Some other Free Software Foundation software is covered by
the GNU Library General Public License instead.)  You can apply it to
Andrew Innes's avatar
Andrew Innes committed
1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260
your programs, too.

  When we speak of free software, we are referring to freedom, not
price.  Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
this service if you wish), that you receive source code or can get it
if you want it, that you can change the software or use pieces of it
in new free programs; and that you know you can do these things.

  To protect your rights, we need to make restrictions that forbid
anyone to deny you these rights or to ask you to surrender the rights.
These restrictions translate to certain responsibilities for you if you
distribute copies of the software, or if you modify it.

  For example, if you distribute copies of such a program, whether
gratis or for a fee, you must give the recipients all the rights that
you have.  You must make sure that they, too, receive or can get the
source code.  And you must show them these terms so they know their

  We protect your rights with two steps: (1) copyright the software, and
(2) offer you this license which gives you legal permission to copy,
distribute and/or modify the software.

  Also, for each author's protection and ours, we want to make certain
that everyone understands that there is no warranty for this free
software.  If the software is modified by someone else and passed on, we
want its recipients to know that what they have is not the original, so
that any problems introduced by others will not reflect on the original
authors' reputations.

  Finally, any free program is threatened constantly by software
patents.  We wish to avoid the danger that redistributors of a free
program will individually obtain patent licenses, in effect making the
program proprietary.  To prevent this, we have made it clear that any
patent must be licensed for everyone's free use or not licensed at all.

  The precise terms and conditions for copying, distribution and
modification follow.

@end iftex
@end ifinfo

@enumerate 0
This License applies to any program or other work which contains
a notice placed by the copyright holder saying it may be distributed
under the terms of this General Public License.  The ``Program,'' below,
Andrew Innes's avatar
Andrew Innes committed
1262 1263 1264 1265 1266
refers to any such program or work, and a ``work based on the Program''
means either the Program or any derivative work under copyright law:
that is to say, a work containing the Program or a portion of it,
either verbatim or with modifications and/or translated into another
language.  (Hereinafter, translation is included without limitation in
the term ``modification.'')  Each licensee is addressed as ``you.''
Andrew Innes's avatar
Andrew Innes committed
1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443