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