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