Bump version to 23.3.90.
[emacs.git] / doc / lispref / vol2.texi
blob3975f0c1a3172d33544bf1cf01166be274466d3f
1 \input texinfo  @c -*-texinfo-*-
2 @c This file is used for printing the GNU Emacs Lisp Reference Manual
3 @c in two volumes.  It is a modified version of elisp.texi.
4 @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998, 1999, 2001,
5 @c   2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012
6 @c   Free Software Foundation, Inc.
7 @c %**start of header
8 @setfilename elisp
9 @settitle GNU Emacs Lisp Reference Manual: Volume 2
10 @c %**end of header
12 @c See two-volume-cross-refs.txt.
13 @tex
14 \message{Formatting for two volume edition...Volume 2...}
16 % Read special toc file, set up in two-volume.make.
17 \gdef\tocreadfilename{elisp2-toc-ready.toc}
19 % Don't make outlines, they're not needed and \readdatafile can't pay
20 % attention to the special definition above.
21 \global\let\pdfmakeoutlines=\relax
23 % Start volume 2 chapter numbering at 27; this must be listed as chapno26
24 \global\chapno=26
25 @end tex
27 @c Version of the manual and of Emacs.
28 @c Please remember to update the edition number in README as well.
29 @set VERSION  3.0
30 @set EMACSVER 23.3.90
31 @set DATE July 2009
33 @dircategory Emacs
34 @direntry
35 * Elisp: (elisp).       The Emacs Lisp Reference Manual.
36 @end direntry
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.
41 @set smallbook
43 @ifset smallbook
44 @smallbook
45 @end ifset
47 @c per rms and peterb, use 10pt fonts for the main text, mostly to
48 @c save on paper cost.
49 @c Do this inside @tex for now, so current makeinfo does not complain.
50 @tex
51 @ifset smallbook
52 @fonttextsize 10
53 \global\let\urlcolor=\Black % don't print links in grayscale
54 \global\let\linkcolor=\Black
55 @end ifset
56 \global\hbadness=6666 % don't worry about not-too-underfull boxes
57 @end tex
59 @c Combine indices.
60 @synindex cp fn
61 @syncodeindex vr fn
62 @syncodeindex ky fn
63 @syncodeindex pg fn
64 @c We use the "type index" to index new functions and variables.
65 @c @syncodeindex tp fn
67 @copying
68 This is edition @value{VERSION} of the GNU Emacs Lisp Reference Manual,@*
69 corresponding to Emacs version @value{EMACSVER}.
71 Copyright @copyright{} 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1998,
72 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012  Free Software
73 Foundation, Inc.
75 @quotation
76 Permission is granted to copy, distribute and/or modify this document
77 under the terms of the GNU Free Documentation License, Version 1.3 or
78 any later version published by the Free Software Foundation; with the
79 Invariant Sections being ``GNU General Public License,'' with the
80 Front-Cover texts being ``A GNU Manual,'' and with the Back-Cover
81 Texts as in (a) below.  A copy of the license is included in the
82 section entitled ``GNU Free Documentation License.''
84 (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
85 modify this GNU manual.  Buying copies from the FSF supports it in
86 developing GNU and promoting software freedom.''
87 @end quotation
88 @end copying
90 @titlepage
91 @title GNU Emacs Lisp Reference Manual
92 @subtitle Volume 2
93 @subtitle For Emacs Version @value{EMACSVER}
94 @subtitle Revision @value{VERSION}, @value{DATE}
96 @author by Bil Lewis, Dan LaLiberte, Richard Stallman
97 @author and the GNU Manual Group
98 @page
99 @vskip 0pt plus 1filll
100 @insertcopying
102 @sp 2
103 Published by the Free Software Foundation @*
104 51 Franklin St, Fifth Floor @*
105 Boston, MA 02110-1301 @*
106 USA @*
107 ISBN 1-882114-74-4
109 @sp 2
110 Cover art by Etienne Suvasa.
111 @end titlepage
114 @c Print the tables of contents
115 @summarycontents
116 @contents
119 @ifnottex
120 @node Top, Introduction, (dir), (dir)
121 @top Emacs Lisp
123 This Info file contains edition @value{VERSION} of the GNU Emacs Lisp
124 Reference Manual, corresponding to GNU Emacs version @value{EMACSVER}.
125 @end ifnottex
127 @menu
128 * Introduction::            Introduction and conventions used.
130 * Lisp Data Types::         Data types of objects in Emacs Lisp.
131 * Numbers::                 Numbers and arithmetic functions.
132 * Strings and Characters::  Strings, and functions that work on them.
133 * Lists::                   Lists, cons cells, and related functions.
134 * Sequences Arrays Vectors::  Lists, strings and vectors are called sequences.
135                                 Certain functions act on any kind of sequence.
136                                 The description of vectors is here as well.
137 * Hash Tables::             Very fast lookup-tables.
138 * Symbols::                 Symbols represent names, uniquely.
140 * Evaluation::              How Lisp expressions are evaluated.
141 * Control Structures::      Conditionals, loops, nonlocal exits.
142 * Variables::               Using symbols in programs to stand for values.
143 * Functions::               A function is a Lisp program
144                               that can be invoked from other functions.
145 * Macros::                  Macros are a way to extend the Lisp language.
146 * Customization::           Writing customization declarations.
148 * Loading::                 Reading files of Lisp code into Lisp.
149 * Byte Compilation::        Compilation makes programs run faster.
150 * Advising Functions::      Adding to the definition of a function.
151 * Debugging::               Tools and tips for debugging Lisp programs.
153 * Read and Print::          Converting Lisp objects to text and back.
154 * Minibuffers::             Using the minibuffer to read input.
155 * Command Loop::            How the editor command loop works,
156                               and how you can call its subroutines.
157 * Keymaps::                 Defining the bindings from keys to commands.
158 * Modes::                   Defining major and minor modes.
159 * Documentation::           Writing and using documentation strings.
161 * Files::                   Accessing files.
162 * Backups and Auto-Saving:: Controlling how backups and auto-save
163                               files are made.
164 * Buffers::                 Creating and using buffer objects.
165 * Windows::                 Manipulating windows and displaying buffers.
166 * Frames::                  Making multiple system-level windows.
167 * Positions::               Buffer positions and motion functions.
168 * Markers::                 Markers represent positions and update
169                               automatically when the text is changed.
171 * Text::                    Examining and changing text in buffers.
172 * Non-ASCII Characters::    Non-ASCII text in buffers and strings.
173 * Searching and Matching::  Searching buffers for strings or regexps.
174 * Syntax Tables::           The syntax table controls word and list parsing.
175 * Abbrevs::                 How Abbrev mode works, and its data structures.
177 * Processes::               Running and communicating with subprocesses.
178 * Display::                 Features for controlling the screen display.
179 * System Interface::        Getting the user id, system type, environment
180                               variables, and other such things.
182 Appendices
184 * Antinews::                Info for users downgrading to Emacs 22.
185 * GNU Free Documentation License:: The license for this documentation.
186 * GPL::                     Conditions for copying and changing GNU Emacs.
187 * Tips::                    Advice and coding conventions for Emacs Lisp.
188 * GNU Emacs Internals::     Building and dumping Emacs;
189                               internal data structures.
190 * Standard Errors::         List of all error symbols.
191 * Standard Buffer-Local Variables::
192                             List of variables buffer-local in all buffers.
193 * Standard Keymaps::        List of standard keymaps.
194 * Standard Hooks::          List of standard hook variables.
196 * Index::                   Index including concepts, functions, variables,
197                               and other terms.
199 @ignore
200 * New Symbols::             New functions and variables in Emacs @value{EMACSVER}.
201 @end ignore
203 @c Do NOT modify the following 3 lines!  They must have this form to
204 @c be correctly identified by `texinfo-multiple-files-update'.  In
205 @c particular, the detailed menu header line MUST be identical to the
206 @c value of `texinfo-master-menu-header'.  See texnfo-upd.el.
208 @detailmenu
209  --- The Detailed Node Listing ---
210  ---------------------------------
212 Here are other nodes that are inferiors of those already listed,
213 mentioned here so you can get to them in one step:
215 Introduction
217 * Caveats::                 Flaws and a request for help.
218 * Lisp History::            Emacs Lisp is descended from Maclisp.
219 * Conventions::             How the manual is formatted.
220 * Version Info::            Which Emacs version is running?
221 * Acknowledgements::        The authors, editors, and sponsors of this manual.
223 Conventions
225 * Some Terms::              Explanation of terms we use in this manual.
226 * nil and t::               How the symbols @code{nil} and @code{t} are used.
227 * Evaluation Notation::     The format we use for examples of evaluation.
228 * Printing Notation::       The format we use when examples print text.
229 * Error Messages::          The format we use for examples of errors.
230 * Buffer Text Notation::    The format we use for buffer contents in examples.
231 * Format of Descriptions::  Notation for describing functions, variables, etc.
233 Format of Descriptions
235 * A Sample Function Description::  A description of an imaginary
236                                      function, @code{foo}.
237 * A Sample Variable Description::  A description of an imaginary
238                                      variable, @code{electric-future-map}.
240 Lisp Data Types
242 * Printed Representation::  How Lisp objects are represented as text.
243 * Comments::                Comments and their formatting conventions.
244 * Programming Types::       Types found in all Lisp systems.
245 * Editing Types::           Types specific to Emacs.
246 * Circular Objects::            Read syntax for circular structure.
247 * Type Predicates::         Tests related to types.
248 * Equality Predicates::     Tests of equality between any two objects.
250 Programming Types
252 * Integer Type::        Numbers without fractional parts.
253 * Floating Point Type:: Numbers with fractional parts and with a large range.
254 * Character Type::      The representation of letters, numbers and
255                           control characters.
256 * Symbol Type::         A multi-use object that refers to a function,
257                         variable, or property list, and has a unique identity.
258 * Sequence Type::       Both lists and arrays are classified as sequences.
259 * Cons Cell Type::      Cons cells, and lists (which are made from cons cells).
260 * Array Type::          Arrays include strings and vectors.
261 * String Type::         An (efficient) array of characters.
262 * Vector Type::         One-dimensional arrays.
263 * Char-Table Type::     One-dimensional sparse arrays indexed by characters.
264 * Bool-Vector Type::    One-dimensional arrays of @code{t} or @code{nil}.
265 * Hash Table Type::     Super-fast lookup tables.
266 * Function Type::       A piece of executable code you can call from elsewhere.
267 * Macro Type::          A method of expanding an expression into another
268                           expression, more fundamental but less pretty.
269 * Primitive Function Type::     A function written in C, callable from Lisp.
270 * Byte-Code Type::      A function written in Lisp, then compiled.
271 * Autoload Type::       A type used for automatically loading seldom-used
272                           functions.
274 Character Type
276 * Basic Char Syntax::       Syntax for regular characters.
277 * General Escape Syntax::   How to specify characters by their codes.
278 * Ctl-Char Syntax::         Syntax for control characters.
279 * Meta-Char Syntax::        Syntax for meta-characters.
280 * Other Char Bits::         Syntax for hyper-, super-, and alt-characters.
282 Cons Cell and List Types
284 * Box Diagrams::            Drawing pictures of lists.
285 * Dotted Pair Notation::    A general syntax for cons cells.
286 * Association List Type::   A specially constructed list.
288 String Type
290 * Syntax for Strings::      How to specify Lisp strings.
291 * Non-ASCII in Strings::    International characters in strings.
292 * Nonprinting Characters::  Literal unprintable characters in strings.
293 * Text Props and Strings::  Strings with text properties.
295 Editing Types
297 * Buffer Type::             The basic object of editing.
298 * Marker Type::             A position in a buffer.
299 * Window Type::             Buffers are displayed in windows.
300 * Frame Type::              Windows subdivide frames.
301 * Terminal Type::           A terminal device displays frames.
302 * Window Configuration Type::  Recording the way a frame is subdivided.
303 * Frame Configuration Type::   Recording the status of all frames.
304 * Process Type::            A subprocess of Emacs running on the underlying OS.
305 * Stream Type::             Receive or send characters.
306 * Keymap Type::             What function a keystroke invokes.
307 * Overlay Type::            How an overlay is represented.
308 * Font Type::               Fonts for displaying text.
310 Numbers
312 * Integer Basics::          Representation and range of integers.
313 * Float Basics::            Representation and range of floating point.
314 * Predicates on Numbers::   Testing for numbers.
315 * Comparison of Numbers::   Equality and inequality predicates.
316 * Numeric Conversions::     Converting float to integer and vice versa.
317 * Arithmetic Operations::   How to add, subtract, multiply and divide.
318 * Rounding Operations::     Explicitly rounding floating point numbers.
319 * Bitwise Operations::      Logical and, or, not, shifting.
320 * Math Functions::          Trig, exponential and logarithmic functions.
321 * Random Numbers::          Obtaining random integers, predictable or not.
323 Strings and Characters
325 * String Basics::           Basic properties of strings and characters.
326 * Predicates for Strings::  Testing whether an object is a string or char.
327 * Creating Strings::        Functions to allocate new strings.
328 * Modifying Strings::         Altering the contents of an existing string.
329 * Text Comparison::         Comparing characters or strings.
330 * String Conversion::       Converting to and from characters and strings.
331 * Formatting Strings::      @code{format}: Emacs's analogue of @code{printf}.
332 * Case Conversion::         Case conversion functions.
333 * Case Tables::             Customizing case conversion.
335 Lists
337 * Cons Cells::              How lists are made out of cons cells.
338 * List-related Predicates:: Is this object a list?  Comparing two lists.
339 * List Elements::           Extracting the pieces of a list.
340 * Building Lists::          Creating list structure.
341 * List Variables::          Modifying lists stored in variables.
342 * Modifying Lists::         Storing new pieces into an existing list.
343 * Sets And Lists::          A list can represent a finite mathematical set.
344 * Association Lists::       A list can represent a finite relation or mapping.
345 * Rings::                   Managing a fixed-size ring of objects.
347 Modifying Existing List Structure
349 * Setcar::                  Replacing an element in a list.
350 * Setcdr::                  Replacing part of the list backbone.
351                               This can be used to remove or add elements.
352 * Rearrangement::           Reordering the elements in a list; combining lists.
354 Sequences, Arrays, and Vectors
356 * Sequence Functions::      Functions that accept any kind of sequence.
357 * Arrays::                  Characteristics of arrays in Emacs Lisp.
358 * Array Functions::         Functions specifically for arrays.
359 * Vectors::                 Special characteristics of Emacs Lisp vectors.
360 * Vector Functions::        Functions specifically for vectors.
361 * Char-Tables::             How to work with char-tables.
362 * Bool-Vectors::            How to work with bool-vectors.
364 Hash Tables
366 * Creating Hash::           Functions to create hash tables.
367 * Hash Access::             Reading and writing the hash table contents.
368 * Defining Hash::           Defining new comparison methods.
369 * Other Hash::              Miscellaneous.
371 Symbols
373 * Symbol Components::       Symbols have names, values, function definitions
374                               and property lists.
375 * Definitions::             A definition says how a symbol will be used.
376 * Creating Symbols::        How symbols are kept unique.
377 * Property Lists::          Each symbol has a property list
378                               for recording miscellaneous information.
380 Property Lists
382 * Plists and Alists::       Comparison of the advantages of property
383                               lists and association lists.
384 * Symbol Plists::           Functions to access symbols' property lists.
385 * Other Plists::            Accessing property lists stored elsewhere.
387 Evaluation
389 * Intro Eval::              Evaluation in the scheme of things.
390 * Forms::                   How various sorts of objects are evaluated.
391 * Quoting::                 Avoiding evaluation (to put constants in
392                               the program).
393 * Eval::                    How to invoke the Lisp interpreter explicitly.
395 Kinds of Forms
397 * Self-Evaluating Forms::   Forms that evaluate to themselves.
398 * Symbol Forms::            Symbols evaluate as variables.
399 * Classifying Lists::       How to distinguish various sorts of list forms.
400 * Function Indirection::    When a symbol appears as the car of a list,
401                               we find the real function via the symbol.
402 * Function Forms::          Forms that call functions.
403 * Macro Forms::             Forms that call macros.
404 * Special Forms::           "Special forms" are idiosyncratic primitives,
405                               most of them extremely important.
406 * Autoloading::             Functions set up to load files
407                               containing their real definitions.
409 Control Structures
411 * Sequencing::              Evaluation in textual order.
412 * Conditionals::            @code{if}, @code{cond}, @code{when}, @code{unless}.
413 * Combining Conditions::    @code{and}, @code{or}, @code{not}.
414 * Iteration::               @code{while} loops.
415 * Nonlocal Exits::          Jumping out of a sequence.
417 Nonlocal Exits
419 * Catch and Throw::         Nonlocal exits for the program's own purposes.
420 * Examples of Catch::       Showing how such nonlocal exits can be written.
421 * Errors::                  How errors are signaled and handled.
422 * Cleanups::                Arranging to run a cleanup form if an
423                               error happens.
425 Errors
427 * Signaling Errors::        How to report an error.
428 * Processing of Errors::    What Emacs does when you report an error.
429 * Handling Errors::         How you can trap errors and continue execution.
430 * Error Symbols::           How errors are classified for trapping them.
432 Variables
434 * Global Variables::        Variable values that exist permanently, everywhere.
435 * Constant Variables::      Certain "variables" have values that never change.
436 * Local Variables::         Variable values that exist only temporarily.
437 * Void Variables::          Symbols that lack values.
438 * Defining Variables::      A definition says a symbol is used as a variable.
439 * Tips for Defining::       Things you should think about when you
440                               define a variable.
441 * Accessing Variables::     Examining values of variables whose names
442                               are known only at run time.
443 * Setting Variables::       Storing new values in variables.
444 * Variable Scoping::        How Lisp chooses among local and global values.
445 * Buffer-Local Variables::  Variable values in effect only in one buffer.
446 * File Local Variables::    Handling local variable lists in files.
447 * Directory Local Variables:: Local variables common to all files in a
448                                 directory.
449 * Frame-Local Variables::   Frame-local bindings for variables.
450 * Variable Aliases::        Variables that are aliases for other variables.
451 * Variables with Restricted Values::  Non-constant variables whose value can
452                                         @emph{not} be an arbitrary Lisp object.
454 Scoping Rules for Variable Bindings
456 * Scope::                   Scope means where in the program a value
457                               is visible.  Comparison with other languages.
458 * Extent::                  Extent means how long in time a value exists.
459 * Impl of Scope::           Two ways to implement dynamic scoping.
460 * Using Scoping::           How to use dynamic scoping carefully and
461                               avoid problems.
463 Buffer-Local Variables
465 * Intro to Buffer-Local::   Introduction and concepts.
466 * Creating Buffer-Local::   Creating and destroying buffer-local bindings.
467 * Default Value::           The default value is seen in buffers
468                               that don't have their own buffer-local values.
470 Functions
472 * What Is a Function::      Lisp functions vs. primitives; terminology.
473 * Lambda Expressions::      How functions are expressed as Lisp objects.
474 * Function Names::          A symbol can serve as the name of a function.
475 * Defining Functions::      Lisp expressions for defining functions.
476 * Calling Functions::       How to use an existing function.
477 * Mapping Functions::       Applying a function to each element of a list, etc.
478 * Anonymous Functions::     Lambda expressions are functions with no names.
479 * Function Cells::          Accessing or setting the function definition
480                               of a symbol.
481 * Obsolete Functions::      Declaring functions obsolete.
482 * Inline Functions::        Defining functions that the compiler
483                               will open code.
484 * Declaring Functions::     Telling the compiler that a function is defined.
485 * Function Safety::         Determining whether a function is safe to call.
486 * Related Topics::          Cross-references to specific Lisp primitives
487                               that have a special bearing on how
488                               functions work.
490 Lambda Expressions
492 * Lambda Components::       The parts of a lambda expression.
493 * Simple Lambda::           A simple example.
494 * Argument List::           Details and special features of argument lists.
495 * Function Documentation::  How to put documentation in a function.
497 Macros
499 * Simple Macro::            A basic example.
500 * Expansion::               How, when and why macros are expanded.
501 * Compiling Macros::        How macros are expanded by the compiler.
502 * Defining Macros::         How to write a macro definition.
503 * Backquote::               Easier construction of list structure.
504 * Problems with Macros::    Don't evaluate the macro arguments too many times.
505                               Don't hide the user's variables.
506 * Indenting Macros::        Specifying how to indent macro calls.
508 Common Problems Using Macros
510 * Wrong Time::             Do the work in the expansion, not in the macro.
511 * Argument Evaluation::    The expansion should evaluate each macro arg once.
512 * Surprising Local Vars::  Local variable bindings in the expansion
513                               require special care.
514 * Eval During Expansion::  Don't evaluate them; put them in the expansion.
515 * Repeated Expansion::     Avoid depending on how many times expansion is done.
517 Writing Customization Definitions
519 * Common Keywords::         Common keyword arguments for all kinds of
520                               customization declarations.
521 * Group Definitions::       Writing customization group definitions.
522 * Variable Definitions::    Declaring user options.
523 * Customization Types::     Specifying the type of a user option.
525 Customization Types
527 * Simple Types::            Simple customization types: sexp, integer, number,
528                               string, file, directory, alist.
529 * Composite Types::         Build new types from other types or data.
530 * Splicing into Lists::     Splice elements into list with @code{:inline}.
531 * Type Keywords::           Keyword-argument pairs in a customization type.
532 * Defining New Types::      Give your type a name.
534 Loading
536 * How Programs Do Loading:: The @code{load} function and others.
537 * Load Suffixes::           Details about the suffixes that @code{load} tries.
538 * Library Search::          Finding a library to load.
539 * Loading Non-ASCII::       Non-@acronym{ASCII} characters in Emacs Lisp files.
540 * Autoload::                Setting up a function to autoload.
541 * Repeated Loading::        Precautions about loading a file twice.
542 * Named Features::          Loading a library if it isn't already loaded.
543 * Where Defined::           Finding which file defined a certain symbol.
544 * Unloading::               How to "unload" a library that was loaded.
545 * Hooks for Loading::       Providing code to be run when
546                               particular libraries are loaded.
548 Byte Compilation
550 * Speed of Byte-Code::      An example of speedup from byte compilation.
551 * Compilation Functions::   Byte compilation functions.
552 * Docs and Compilation::    Dynamic loading of documentation strings.
553 * Dynamic Loading::         Dynamic loading of individual functions.
554 * Eval During Compile::     Code to be evaluated when you compile.
555 * Compiler Errors::         Handling compiler error messages.
556 * Byte-Code Objects::       The data type used for byte-compiled functions.
557 * Disassembly::             Disassembling byte-code; how to read byte-code.
559 Advising Emacs Lisp Functions
561 * Simple Advice::           A simple example to explain the basics of advice.
562 * Defining Advice::         Detailed description of @code{defadvice}.
563 * Around-Advice::           Wrapping advice around a function's definition.
564 * Computed Advice::         ...is to @code{defadvice} as @code{fset} is to @code{defun}.
565 * Activation of Advice::    Advice doesn't do anything until you activate it.
566 * Enabling Advice::         You can enable or disable each piece of advice.
567 * Preactivation::           Preactivation is a way of speeding up the
568                               loading of compiled advice.
569 * Argument Access in Advice:: How advice can access the function's arguments.
570 * Advising Primitives::     Accessing arguments when advising a primitive.
571 * Combined Definition::     How advice is implemented.
573 Debugging Lisp Programs
575 * Debugger::                How the Emacs Lisp debugger is implemented.
576 * Edebug::                  A source-level Emacs Lisp debugger.
577 * Syntax Errors::           How to find syntax errors.
578 * Test Coverage::           Ensuring you have tested all branches in your code.
579 * Compilation Errors::      How to find errors that show up in
580                               byte compilation.
582 The Lisp Debugger
584 * Error Debugging::         Entering the debugger when an error happens.
585 * Infinite Loops::          Stopping and debugging a program that doesn't exit.
586 * Function Debugging::      Entering it when a certain function is called.
587 * Explicit Debug::          Entering it at a certain point in the program.
588 * Using Debugger::          What the debugger does; what you see while in it.
589 * Debugger Commands::       Commands used while in the debugger.
590 * Invoking the Debugger::   How to call the function @code{debug}.
591 * Internals of Debugger::   Subroutines of the debugger, and global variables.
593 Edebug
595 * Using Edebug::            Introduction to use of Edebug.
596 * Instrumenting::           You must instrument your code
597                               in order to debug it with Edebug.
598 * Edebug Execution Modes::  Execution modes, stopping more or less often.
599 * Jumping::                 Commands to jump to a specified place.
600 * Edebug Misc::             Miscellaneous commands.
601 * Breaks::                  Setting breakpoints to make the program stop.
602 * Trapping Errors::         Trapping errors with Edebug.
603 * Edebug Views::            Views inside and outside of Edebug.
604 * Edebug Eval::             Evaluating expressions within Edebug.
605 * Eval List::               Expressions whose values are displayed
606                               each time you enter Edebug.
607 * Printing in Edebug::      Customization of printing.
608 * Trace Buffer::            How to produce trace output in a buffer.
609 * Coverage Testing::        How to test evaluation coverage.
610 * The Outside Context::     Data that Edebug saves and restores.
611 * Edebug and Macros::       Specifying how to handle macro calls.
612 * Edebug Options::          Option variables for customizing Edebug.
614 Breaks
616 * Breakpoints::             Breakpoints at stop points.
617 * Global Break Condition::  Breaking on an event.
618 * Source Breakpoints::      Embedding breakpoints in source code.
620 The Outside Context
622 * Checking Whether to Stop::When Edebug decides what to do.
623 * Edebug Display Update::   When Edebug updates the display.
624 * Edebug Recursive Edit::   When Edebug stops execution.
626 Edebug and Macros
628 * Instrumenting Macro Calls::The basic problem.
629 * Specification List::      How to specify complex patterns of evaluation.
630 * Backtracking::            What Edebug does when matching fails.
631 * Specification Examples::  To help understand specifications.
633 Debugging Invalid Lisp Syntax
635 * Excess Open::             How to find a spurious open paren or missing close.
636 * Excess Close::            How to find a spurious close paren or missing open.
638 Reading and Printing Lisp Objects
640 * Streams Intro::           Overview of streams, reading and printing.
641 * Input Streams::           Various data types that can be used as
642                               input streams.
643 * Input Functions::         Functions to read Lisp objects from text.
644 * Output Streams::          Various data types that can be used as
645                               output streams.
646 * Output Functions::        Functions to print Lisp objects as text.
647 * Output Variables::        Variables that control what the printing
648                               functions do.
650 Minibuffers
652 * Intro to Minibuffers::    Basic information about minibuffers.
653 * Text from Minibuffer::    How to read a straight text string.
654 * Object from Minibuffer::  How to read a Lisp object or expression.
655 * Minibuffer History::      Recording previous minibuffer inputs
656                               so the user can reuse them.
657 * Initial Input::           Specifying initial contents for the minibuffer.
658 * Completion::              How to invoke and customize completion.
659 * Yes-or-No Queries::       Asking a question with a simple answer.
660 * Multiple Queries::        Asking a series of similar questions.
661 * Reading a Password::      Reading a password from the terminal.
662 * Minibuffer Commands::     Commands used as key bindings in minibuffers.
663 * Minibuffer Contents::     How such commands access the minibuffer text.
664 * Minibuffer Windows::      Operating on the special minibuffer windows.
665 * Recursive Mini::          Whether recursive entry to minibuffer is allowed.
666 * Minibuffer Misc::         Various customization hooks and variables.
668 Completion
670 * Basic Completion::        Low-level functions for completing strings.
671                               (These are too low level to use the minibuffer.)
672 * Minibuffer Completion::   Invoking the minibuffer with completion.
673 * Completion Commands::     Minibuffer commands that do completion.
674 * High-Level Completion::   Convenient special cases of completion
675                               (reading buffer name, file name, etc.).
676 * Reading File Names::      Using completion to read file names and
677                               shell commands.
678 * Completion Styles::       Specifying rules for performing completion.
679 * Programmed Completion::   Writing your own completion-function.
681 Command Loop
683 * Command Overview::    How the command loop reads commands.
684 * Defining Commands::   Specifying how a function should read arguments.
685 * Interactive Call::    Calling a command, so that it will read arguments.
686 * Distinguish Interactive::     Making a command distinguish interactive calls.
687 * Command Loop Info::   Variables set by the command loop for you to examine.
688 * Adjusting Point::     Adjustment of point after a command.
689 * Input Events::        What input looks like when you read it.
690 * Reading Input::       How to read input events from the keyboard or mouse.
691 * Special Events::      Events processed immediately and individually.
692 * Waiting::             Waiting for user input or elapsed time.
693 * Quitting::            How @kbd{C-g} works.  How to catch or defer quitting.
694 * Prefix Command Arguments::    How the commands to set prefix args work.
695 * Recursive Editing::   Entering a recursive edit,
696                           and why you usually shouldn't.
697 * Disabling Commands::  How the command loop handles disabled commands.
698 * Command History::     How the command history is set up, and how accessed.
699 * Keyboard Macros::     How keyboard macros are implemented.
701 Defining Commands
703 * Using Interactive::       General rules for @code{interactive}.
704 * Interactive Codes::       The standard letter-codes for reading arguments
705                               in various ways.
706 * Interactive Examples::    Examples of how to read interactive arguments.
708 Input Events
710 * Keyboard Events::         Ordinary characters--keys with symbols on them.
711 * Function Keys::           Function keys--keys with names, not symbols.
712 * Mouse Events::            Overview of mouse events.
713 * Click Events::            Pushing and releasing a mouse button.
714 * Drag Events::             Moving the mouse before releasing the button.
715 * Button-Down Events::      A button was pushed and not yet released.
716 * Repeat Events::           Double and triple click (or drag, or down).
717 * Motion Events::           Just moving the mouse, not pushing a button.
718 * Focus Events::            Moving the mouse between frames.
719 * Misc Events::             Other events the system can generate.
720 * Event Examples::          Examples of the lists for mouse events.
721 * Classifying Events::      Finding the modifier keys in an event symbol.
722                               Event types.
723 * Accessing Mouse::         Functions to extract info from mouse events.
724 * Accessing Scroll::        Functions to get info from scroll bar events.
725 * Strings of Events::       Special considerations for putting
726                               keyboard character events in a string.
728 Reading Input
730 * Key Sequence Input::      How to read one key sequence.
731 * Reading One Event::       How to read just one event.
732 * Event Mod::               How Emacs modifies events as they are read.
733 * Invoking the Input Method::   How reading an event uses the input method.
734 * Quoted Character Input::  Asking the user to specify a character.
735 * Event Input Misc::        How to reread or throw away input events.
737 Keymaps
739 * Key Sequences::           Key sequences as Lisp objects.
740 * Keymap Basics::           Basic concepts of keymaps.
741 * Format of Keymaps::       What a keymap looks like as a Lisp object.
742 * Creating Keymaps::        Functions to create and copy keymaps.
743 * Inheritance and Keymaps:: How one keymap can inherit the bindings
744                               of another keymap.
745 * Prefix Keys::             Defining a key with a keymap as its definition.
746 * Active Keymaps::          How Emacs searches the active keymaps
747                               for a key binding.
748 * Searching Keymaps::       A pseudo-Lisp summary of searching active maps.
749 * Controlling Active Maps:: Each buffer has a local keymap
750                                to override the standard (global) bindings.
751                                A minor mode can also override them.
752 * Key Lookup::              Finding a key's binding in one keymap.
753 * Functions for Key Lookup::    How to request key lookup.
754 * Changing Key Bindings::   Redefining a key in a keymap.
755 * Remapping Commands::      A keymap can translate one command to another.
756 * Translation Keymaps::     Keymaps for translating sequences of events.
757 * Key Binding Commands::    Interactive interfaces for redefining keys.
758 * Scanning Keymaps::        Looking through all keymaps, for printing help.
759 * Menu Keymaps::            Defining a menu as a keymap.
761 Menu Keymaps
763 * Defining Menus::          How to make a keymap that defines a menu.
764 * Mouse Menus::             How users actuate the menu with the mouse.
765 * Keyboard Menus::          How users actuate the menu with the keyboard.
766 * Menu Example::            Making a simple menu.
767 * Menu Bar::                How to customize the menu bar.
768 * Tool Bar::                A tool bar is a row of images.
769 * Modifying Menus::         How to add new items to a menu.
771 Defining Menus
773 * Simple Menu Items::       A simple kind of menu key binding,
774                               limited in capabilities.
775 * Extended Menu Items::     More powerful menu item definitions
776                               let you specify keywords to enable
777                               various features.
778 * Menu Separators::         Drawing a horizontal line through a menu.
779 * Alias Menu Items::        Using command aliases in menu items.
781 Major and Minor Modes
783 * Hooks::              How to use hooks; how to write code that provides hooks.
784 * Major Modes::        Defining major modes.
785 * Minor Modes::        Defining minor modes.
786 * Mode Line Format::   Customizing the text that appears in the mode line.
787 * Imenu::              How a mode can provide a menu
788                          of definitions in the buffer.
789 * Font Lock Mode::     How modes can highlight text according to syntax.
790 * Desktop Save Mode::  How modes can have buffer state saved between
791                          Emacs sessions.
793 Hooks
795 * Running Hooks::      How to run a hook.
796 * Setting Hooks::      How to put functions on a hook, or remove them.
798 Major Modes
800 * Major Mode Basics::
801 * Major Mode Conventions::  Coding conventions for keymaps, etc.
802 * Auto Major Mode::         How Emacs chooses the major mode automatically.
803 * Mode Help::               Finding out how to use a mode.
804 * Derived Modes::           Defining a new major mode based on another major
805                               mode.
806 * Generic Modes::           Defining a simple major mode that supports
807                               comment syntax and Font Lock mode.
808 * Mode Hooks::              Hooks run at the end of major mode functions.
809 * Example Major Modes::     Text mode and Lisp modes.
811 Minor Modes
813 * Minor Mode Conventions::  Tips for writing a minor mode.
814 * Keymaps and Minor Modes:: How a minor mode can have its own keymap.
815 * Defining Minor Modes::    A convenient facility for defining minor modes.
817 Mode Line Format
819 * Mode Line Basics::        Basic ideas of mode line control.
820 * Mode Line Data::          The data structure that controls the mode line.
821 * Mode Line Top::           The top level variable, mode-line-format.
822 * Mode Line Variables::     Variables used in that data structure.
823 * %-Constructs::            Putting information into a mode line.
824 * Properties in Mode::      Using text properties in the mode line.
825 * Header Lines::            Like a mode line, but at the top.
826 * Emulating Mode Line::     Formatting text as the mode line would.
828 Font Lock Mode
830 * Font Lock Basics::        Overview of customizing Font Lock.
831 * Search-based Fontification::  Fontification based on regexps.
832 * Customizing Keywords::    Customizing search-based fontification.
833 * Other Font Lock Variables::   Additional customization facilities.
834 * Levels of Font Lock::     Each mode can define alternative levels
835                               so that the user can select more or less.
836 * Precalculated Fontification:: How Lisp programs that produce the buffer
837                                   contents can also specify how to fontify it.
838 * Faces for Font Lock::     Special faces specifically for Font Lock.
839 * Syntactic Font Lock::     Fontification based on syntax tables.
840 * Setting Syntax Properties::   Defining character syntax based on context
841                                   using the Font Lock mechanism.
842 * Multiline Font Lock::     How to coerce Font Lock into properly
843                               highlighting multiline constructs.
845 Multiline Font Lock Constructs
847 * Font Lock Multiline::     Marking multiline chunks with a text property.
848 * Region to Refontify::     Controlling which region gets refontified
849                               after a buffer change.
851 Documentation
853 * Documentation Basics::    Good style for doc strings.
854                               Where to put them.  How Emacs stores them.
855 * Accessing Documentation:: How Lisp programs can access doc strings.
856 * Keys in Documentation::   Substituting current key bindings.
857 * Describing Characters::   Making printable descriptions of
858                               non-printing characters and key sequences.
859 * Help Functions::          Subroutines used by Emacs help facilities.
861 Files
863 * Visiting Files::          Reading files into Emacs buffers for editing.
864 * Saving Buffers::          Writing changed buffers back into files.
865 * Reading from Files::      Reading files into buffers without visiting.
866 * Writing to Files::        Writing new files from parts of buffers.
867 * File Locks::              Locking and unlocking files, to prevent
868                               simultaneous editing by two people.
869 * Information about Files:: Testing existence, accessibility, size of files.
870 * Changing Files::          Renaming files, changing protection, etc.
871 * File Names::              Decomposing and expanding file names.
872 * Contents of Directories:: Getting a list of the files in a directory.
873 * Create/Delete Dirs::      Creating and Deleting Directories.
874 * Magic File Names::        Defining "magic" special handling
875                               for certain file names.
876 * Format Conversion::       Conversion to and from various file formats.
878 Visiting Files
880 * Visiting Functions::      The usual interface functions for visiting.
881 * Subroutines of Visiting:: Lower-level subroutines that they use.
883 Information about Files
885 * Testing Accessibility::   Is a given file readable?  Writable?
886 * Kinds of Files::          Is it a directory?  A symbolic link?
887 * Truenames::               Eliminating symbolic links from a file name.
888 * File Attributes::         How large is it?  Any other names?  Etc.
889 * Locating Files::          How to find a file in standard places.
891 File Names
893 * File Name Components::    The directory part of a file name, and the rest.
894 * Relative File Names::     Some file names are relative to a current directory.
895 * Directory Names::         A directory's name as a directory
896                               is different from its name as a file.
897 * File Name Expansion::     Converting relative file names to absolute ones.
898 * Unique File Names::       Generating names for temporary files.
899 * File Name Completion::    Finding the completions for a given file name.
900 * Standard File Names::     If your package uses a fixed file name,
901                               how to handle various operating systems simply.
903 File Format Conversion
905 * Format Conversion Overview::   @code{insert-file-contents} and @code{write-region}.
906 * Format Conversion Round-Trip:: Using @code{format-alist}.
907 * Format Conversion Piecemeal::  Specifying non-paired conversion.
909 Backups and Auto-Saving
911 * Backup Files::            How backup files are made; how their names
912                               are chosen.
913 * Auto-Saving::             How auto-save files are made; how their
914                               names are chosen.
915 * Reverting::               @code{revert-buffer}, and how to customize
916                               what it does.
918 Backup Files
920 * Making Backups::          How Emacs makes backup files, and when.
921 * Rename or Copy::          Two alternatives: renaming the old file
922                               or copying it.
923 * Numbered Backups::        Keeping multiple backups for each source file.
924 * Backup Names::            How backup file names are computed; customization.
926 Buffers
928 * Buffer Basics::           What is a buffer?
929 * Current Buffer::          Designating a buffer as current
930                               so that primitives will access its contents.
931 * Buffer Names::            Accessing and changing buffer names.
932 * Buffer File Name::        The buffer file name indicates which file
933                               is visited.
934 * Buffer Modification::     A buffer is @dfn{modified} if it needs to be saved.
935 * Modification Time::       Determining whether the visited file was changed
936                               ``behind Emacs's back''.
937 * Read Only Buffers::       Modifying text is not allowed in a
938                               read-only buffer.
939 * The Buffer List::         How to look at all the existing buffers.
940 * Creating Buffers::        Functions that create buffers.
941 * Killing Buffers::         Buffers exist until explicitly killed.
942 * Indirect Buffers::        An indirect buffer shares text with some
943                               other buffer.
944 * Swapping Text::           Swapping text between two buffers.
945 * Buffer Gap::              The gap in the buffer.
947 Windows
949 * Basic Windows::           Basic information on using windows.
950 * Splitting Windows::       Splitting one window into two windows.
951 * Deleting Windows::        Deleting a window gives its space to other windows.
952 * Selecting Windows::       The selected window is the one that you edit in.
953 * Cyclic Window Ordering::  Moving around the existing windows.
954 * Buffers and Windows::     Each window displays the contents of a buffer.
955 * Displaying Buffers::      Higher-level functions for displaying a buffer
956                               and choosing a window for it.
957 * Choosing Window::         How to choose a window for displaying a buffer.
958 * Dedicated Windows::       How to avoid displaying another buffer in
959                               a specific window.          
960 * Window Point::            Each window has its own location of point.
961 * Window Start and End::    Buffer positions indicating which text is
962                               on-screen in a window.
963 * Textual Scrolling::       Moving text up and down through the window.
964 * Vertical Scrolling::      Moving the contents up and down on the window.
965 * Horizontal Scrolling::    Moving the contents sideways on the window.
966 * Size of Window::          Accessing the size of a window.
967 * Resizing Windows::        Changing the size of a window.
968 * Coordinates and Windows:: Converting coordinates to windows.
969 * Window Tree::             The layout and sizes of all windows in a frame.
970 * Window Configurations::   Saving and restoring the state of the screen.
971 * Window Parameters::       Associating additional information with windows.
972 * Window Hooks::            Hooks for scrolling, window size changes,
973                               redisplay going past a certain point,
974                               or window configuration changes.
976 Frames
978 * Creating Frames::         Creating additional frames.
979 * Multiple Terminals::      Displaying on several different devices.
980 * Frame Parameters::        Controlling frame size, position, font, etc.
981 * Terminal Parameters::     Parameters common for all frames on terminal.
982 * Frame Titles::            Automatic updating of frame titles.
983 * Deleting Frames::         Frames last until explicitly deleted.
984 * Finding All Frames::      How to examine all existing frames.
985 * Frames and Windows::      A frame contains windows;
986                               display of text always works through windows.
987 * Minibuffers and Frames::  How a frame finds the minibuffer to use.
988 * Input Focus::             Specifying the selected frame.
989 * Visibility of Frames::    Frames may be visible or invisible, or icons.
990 * Raising and Lowering::    Raising a frame makes it hide other windows;
991                               lowering it makes the others hide it.
992 * Frame Configurations::    Saving the state of all frames.
993 * Mouse Tracking::          Getting events that say when the mouse moves.
994 * Mouse Position::          Asking where the mouse is, or moving it.
995 * Pop-Up Menus::            Displaying a menu for the user to select from.
996 * Dialog Boxes::            Displaying a box to ask yes or no.
997 * Pointer Shape::           Specifying the shape of the mouse pointer.
998 * Window System Selections::Transferring text to and from other X clients.
999 * Drag and Drop::               Internals of Drag-and-Drop implementation.
1000 * Color Names::             Getting the definitions of color names.
1001 * Text Terminal Colors::    Defining colors for text-only terminals.
1002 * Resources::               Getting resource values from the server.
1003 * Display Feature Testing:: Determining the features of a terminal.
1005 Frame Parameters
1007 * Parameter Access::        How to change a frame's parameters.
1008 * Initial Parameters::      Specifying frame parameters when you make a frame.
1009 * Window Frame Parameters:: List of frame parameters for window systems.
1010 * Size and Position::       Changing the size and position of a frame.
1011 * Geometry::                Parsing geometry specifications.
1013 Window Frame Parameters
1015 * Basic Parameters::        Parameters that are fundamental.
1016 * Position Parameters::     The position of the frame on the screen.
1017 * Size Parameters::         Frame's size.
1018 * Layout Parameters::       Size of parts of the frame, and
1019                               enabling or disabling some parts.
1020 * Buffer Parameters::       Which buffers have been or should be shown.
1021 * Management Parameters::   Communicating with the window manager.
1022 * Cursor Parameters::       Controlling the cursor appearance.
1023 * Font and Color Parameters:: Fonts and colors for the frame text.
1025 Positions
1027 * Point::                   The special position where editing takes place.
1028 * Motion::                  Changing point.
1029 * Excursions::              Temporary motion and buffer changes.
1030 * Narrowing::               Restricting editing to a portion of the buffer.
1032 Motion
1034 * Character Motion::        Moving in terms of characters.
1035 * Word Motion::             Moving in terms of words.
1036 * Buffer End Motion::       Moving to the beginning or end of the buffer.
1037 * Text Lines::              Moving in terms of lines of text.
1038 * Screen Lines::            Moving in terms of lines as displayed.
1039 * List Motion::             Moving by parsing lists and sexps.
1040 * Skipping Characters::     Skipping characters belonging to a certain set.
1042 Markers
1044 * Overview of Markers::     The components of a marker, and how it relocates.
1045 * Predicates on Markers::   Testing whether an object is a marker.
1046 * Creating Markers::        Making empty markers or markers at certain places.
1047 * Information from Markers::Finding the marker's buffer or character position.
1048 * Marker Insertion Types::  Two ways a marker can relocate when you
1049                               insert where it points.
1050 * Moving Markers::          Moving the marker to a new buffer or position.
1051 * The Mark::                How "the mark" is implemented with a marker.
1052 * The Region::              How to access "the region".
1054 Text
1056 * Near Point::              Examining text in the vicinity of point.
1057 * Buffer Contents::         Examining text in a general fashion.
1058 * Comparing Text::          Comparing substrings of buffers.
1059 * Insertion::               Adding new text to a buffer.
1060 * Commands for Insertion::  User-level commands to insert text.
1061 * Deletion::                Removing text from a buffer.
1062 * User-Level Deletion::     User-level commands to delete text.
1063 * The Kill Ring::           Where removed text sometimes is saved for
1064                               later use.
1065 * Undo::                    Undoing changes to the text of a buffer.
1066 * Maintaining Undo::        How to enable and disable undo information.
1067                               How to control how much information is kept.
1068 * Filling::                 Functions for explicit filling.
1069 * Margins::                 How to specify margins for filling commands.
1070 * Adaptive Fill::           Adaptive Fill mode chooses a fill prefix
1071                               from context.
1072 * Auto Filling::            How auto-fill mode is implemented to break lines.
1073 * Sorting::                 Functions for sorting parts of the buffer.
1074 * Columns::                 Computing horizontal positions, and using them.
1075 * Indentation::             Functions to insert or adjust indentation.
1076 * Case Changes::            Case conversion of parts of the buffer.
1077 * Text Properties::         Assigning Lisp property lists to text characters.
1078 * Substitution::            Replacing a given character wherever it appears.
1079 * Transposition::           Swapping two portions of a buffer.
1080 * Registers::               How registers are implemented.  Accessing
1081                               the text or position stored in a register.
1082 * Base 64::                 Conversion to or from base 64 encoding.
1083 * MD5 Checksum::            Compute the MD5 "message digest"/"checksum".
1084 * Atomic Changes::          Installing several buffer changes "atomically".
1085 * Change Hooks::            Supplying functions to be run when text is changed.
1087 The Kill Ring
1089 * Kill Ring Concepts::      What text looks like in the kill ring.
1090 * Kill Functions::          Functions that kill text.
1091 * Yanking::                 How yanking is done.
1092 * Yank Commands::           Commands that access the kill ring.
1093 * Low-Level Kill Ring::     Functions and variables for kill ring access.
1094 * Internals of Kill Ring::  Variables that hold kill ring data.
1096 Indentation
1098 * Primitive Indent::        Functions used to count and insert indentation.
1099 * Mode-Specific Indent::    Customize indentation for different modes.
1100 * Region Indent::           Indent all the lines in a region.
1101 * Relative Indent::         Indent the current line based on previous lines.
1102 * Indent Tabs::             Adjustable, typewriter-like tab stops.
1103 * Motion by Indent::        Move to first non-blank character.
1105 Text Properties
1107 * Examining Properties::    Looking at the properties of one character.
1108 * Changing Properties::     Setting the properties of a range of text.
1109 * Property Search::         Searching for where a property changes value.
1110 * Special Properties::      Particular properties with special meanings.
1111 * Format Properties::       Properties for representing formatting of text.
1112 * Sticky Properties::       How inserted text gets properties from
1113                               neighboring text.
1114 * Lazy Properties::         Computing text properties in a lazy fashion
1115                               only when text is examined.
1116 * Clickable Text::          Using text properties to make regions of text
1117                               do something when you click on them.
1118 * Fields::                  The @code{field} property defines
1119                               fields within the buffer.
1120 * Not Intervals::           Why text properties do not use
1121                               Lisp-visible text intervals.
1123 Non-@acronym{ASCII} Characters
1125 * Text Representations::    How Emacs represents text.
1126 * Converting Representations::  Converting unibyte to multibyte and vice versa.
1127 * Selecting a Representation::  Treating a byte sequence as unibyte or multi.
1128 * Character Codes::         How unibyte and multibyte relate to
1129                                 codes of individual characters.
1130 * Character Properties::    Character attributes that define their
1131                                 behavior and handling.
1132 * Character Sets::          The space of possible character codes
1133                                 is divided into various character sets.
1134 * Scanning Charsets::       Which character sets are used in a buffer?
1135 * Translation of Characters::   Translation tables are used for conversion.
1136 * Coding Systems::          Coding systems are conversions for saving files.
1137 * Input Methods::           Input methods allow users to enter various
1138                                 non-ASCII characters without special keyboards.
1139 * Locales::                 Interacting with the POSIX locale.
1141 Coding Systems
1143 * Coding System Basics::    Basic concepts.
1144 * Encoding and I/O::        How file I/O functions handle coding systems.
1145 * Lisp and Coding Systems:: Functions to operate on coding system names.
1146 * User-Chosen Coding Systems::  Asking the user to choose a coding system.
1147 * Default Coding Systems::  Controlling the default choices.
1148 * Specifying Coding Systems::   Requesting a particular coding system
1149                                     for a single file operation.
1150 * Explicit Encoding::       Encoding or decoding text without doing I/O.
1151 * Terminal I/O Encoding::   Use of encoding for terminal I/O.
1152 * MS-DOS File Types::       How DOS "text" and "binary" files
1153                                 relate to coding systems.
1155 Searching and Matching
1157 * String Search::           Search for an exact match.
1158 * Searching and Case::      Case-independent or case-significant searching.
1159 * Regular Expressions::     Describing classes of strings.
1160 * Regexp Search::           Searching for a match for a regexp.
1161 * POSIX Regexps::           Searching POSIX-style for the longest match.
1162 * Match Data::              Finding out which part of the text matched,
1163                               after a string or regexp search.
1164 * Search and Replace::      Commands that loop, searching and replacing.
1165 * Standard Regexps::        Useful regexps for finding sentences, pages,...
1167 Regular Expressions
1169 * Syntax of Regexps::       Rules for writing regular expressions.
1170 * Regexp Example::          Illustrates regular expression syntax.
1171 * Regexp Functions::        Functions for operating on regular expressions.
1173 Syntax of Regular Expressions
1175 * Regexp Special::          Special characters in regular expressions.
1176 * Char Classes::            Character classes used in regular expressions.
1177 * Regexp Backslash::        Backslash-sequences in regular expressions.
1179 The Match Data
1181 * Replacing Match::         Replacing a substring that was matched.
1182 * Simple Match Data::       Accessing single items of match data,
1183                               such as where a particular subexpression started.
1184 * Entire Match Data::       Accessing the entire match data at once, as a list.
1185 * Saving Match Data::       Saving and restoring the match data.
1187 Syntax Tables
1189 * Syntax Basics::           Basic concepts of syntax tables.
1190 * Syntax Descriptors::      How characters are classified.
1191 * Syntax Table Functions::  How to create, examine and alter syntax tables.
1192 * Syntax Properties::       Overriding syntax with text properties.
1193 * Motion and Syntax::       Moving over characters with certain syntaxes.
1194 * Parsing Expressions::     Parsing balanced expressions
1195                               using the syntax table.
1196 * Standard Syntax Tables::  Syntax tables used by various major modes.
1197 * Syntax Table Internals::  How syntax table information is stored.
1198 * Categories::              Another way of classifying character syntax.
1200 Syntax Descriptors
1202 * Syntax Class Table::      Table of syntax classes.
1203 * Syntax Flags::            Additional flags each character can have.
1205 Parsing Expressions
1207 * Motion via Parsing::      Motion functions that work by parsing.
1208 * Position Parse::          Determining the syntactic state of a position.
1209 * Parser State::            How Emacs represents a syntactic state.
1210 * Low-Level Parsing::       Parsing across a specified region.
1211 * Control Parsing::         Parameters that affect parsing.
1213 Abbrevs and Abbrev Expansion
1215 * Abbrev Mode::             Setting up Emacs for abbreviation.
1216 * Abbrev Tables::           Creating and working with abbrev tables.
1217 * Defining Abbrevs::        Specifying abbreviations and their expansions.
1218 * Abbrev Files::            Saving abbrevs in files.
1219 * Abbrev Expansion::        Controlling expansion; expansion subroutines.
1220 * Standard Abbrev Tables::  Abbrev tables used by various major modes.
1221 * Abbrev Properties::       How to read and set abbrev properties.
1222                             Which properties have which effect.
1223 * Abbrev Table Properties:: How to read and set abbrev table properties.
1224                             Which properties have which effect.
1226 Processes
1228 * Subprocess Creation::     Functions that start subprocesses.
1229 * Shell Arguments::         Quoting an argument to pass it to a shell.
1230 * Synchronous Processes::   Details of using synchronous subprocesses.
1231 * Asynchronous Processes::  Starting up an asynchronous subprocess.
1232 * Deleting Processes::      Eliminating an asynchronous subprocess.
1233 * Process Information::     Accessing run-status and other attributes.
1234 * Input to Processes::      Sending input to an asynchronous subprocess.
1235 * Signals to Processes::    Stopping, continuing or interrupting
1236                               an asynchronous subprocess.
1237 * Output from Processes::   Collecting output from an asynchronous subprocess.
1238 * Sentinels::               Sentinels run when process run-status changes.
1239 * Query Before Exit::       Whether to query if exiting will kill a process.
1240 * System Processes::        Accessing other processes running on your system.
1241 * Transaction Queues::      Transaction-based communication with subprocesses.
1242 * Network::                 Opening network connections.
1243 * Network Servers::         Network servers let Emacs accept net connections.
1244 * Datagrams::               UDP network connections.
1245 * Low-Level Network::       Lower-level but more general function
1246                               to create connections and servers.
1247 * Misc Network::            Additional relevant functions for
1248                               network connections.
1249 * Serial Ports::            Communicating with serial ports.
1250 * Byte Packing::            Using bindat to pack and unpack binary data.
1252 Receiving Output from Processes
1254 * Process Buffers::         If no filter, output is put in a buffer.
1255 * Filter Functions::        Filter functions accept output from the process.
1256 * Decoding Output::         Filters can get unibyte or multibyte strings.
1257 * Accepting Output::        How to wait until process output arrives.
1259 Low-Level Network Access
1261 * Network Processes::       Using @code{make-network-process}.
1262 * Network Options::         Further control over network connections.
1263 * Network Feature Testing:: Determining which network features work on
1264                               the machine you are using.
1266 Packing and Unpacking Byte Arrays
1268 * Bindat Spec::             Describing data layout.
1269 * Bindat Functions::        Doing the unpacking and packing.
1270 * Bindat Examples::         Samples of what bindat.el can do for you!
1272 Emacs Display
1274 * Refresh Screen::          Clearing the screen and redrawing everything on it.
1275 * Forcing Redisplay::       Forcing redisplay.
1276 * Truncation::              Folding or wrapping long text lines.
1277 * The Echo Area::           Displaying messages at the bottom of the screen.
1278 * Warnings::                Displaying warning messages for the user.
1279 * Invisible Text::          Hiding part of the buffer text.
1280 * Selective Display::       Hiding part of the buffer text (the old way).
1281 * Temporary Displays::      Displays that go away automatically.
1282 * Overlays::                Use overlays to highlight parts of the buffer.
1283 * Width::                   How wide a character or string is on the screen.
1284 * Line Height::             Controlling the height of lines.
1285 * Faces::                   A face defines a graphics style
1286                               for text characters: font, colors, etc.
1287 * Fringes::                 Controlling window fringes.
1288 * Scroll Bars::             Controlling vertical scroll bars.
1289 * Display Property::        Enabling special display features.
1290 * Images::                  Displaying images in Emacs buffers.
1291 * Buttons::                 Adding clickable buttons to Emacs buffers.
1292 * Abstract Display::        Emacs' Widget for Object Collections.
1293 * Blinking::                How Emacs shows the matching open parenthesis.
1294 * Usual Display::           The usual conventions for displaying
1295                               nonprinting chars.
1296 * Display Tables::          How to specify other conventions.
1297 * Beeping::                 Audible signal to the user.
1298 * Window Systems::          Which window system is being used.
1300 The Echo Area
1302 * Displaying Messages::     Explicitly displaying text in the echo area.
1303 * Progress::                Informing user about progress of a long operation.
1304 * Logging Messages::        Echo area messages are logged for the user.
1305 * Echo Area Customization:: Controlling the echo area.
1307 Reporting Warnings
1309 * Warning Basics::          Warnings concepts and functions to report them.
1310 * Warning Variables::       Variables programs bind to customize
1311                               their warnings.
1312 * Warning Options::         Variables users set to control display of warnings.
1314 Overlays
1316 * Managing Overlays::       Creating and moving overlays.
1317 * Overlay Properties::      How to read and set properties.
1318                             What properties do to the screen display.
1319 * Finding Overlays::        Searching for overlays.
1321 Faces
1323 * Defining Faces::          How to define a face with @code{defface}.
1324 * Face Attributes::         What is in a face?
1325 * Attribute Functions::     Functions to examine and set face attributes.
1326 * Displaying Faces::        How Emacs combines the faces specified for
1327                               a character.
1328 * Face Remapping::         Remapping faces to alternative definitions.
1329 * Face Functions::          How to define and examine faces.
1330 * Auto Faces::              Hook for automatic face assignment.
1331 * Font Selection::          Finding the best available font for a face.
1332 * Font Lookup::             Looking up the names of available fonts
1333                               and information about them.
1334 * Fontsets::                A fontset is a collection of fonts
1335                               that handle a range of character sets.
1336 * Low-Level Font::          Lisp representation for character display fonts.
1338 Fringes
1340 * Fringe Size/Pos::         Specifying where to put the window fringes.
1341 * Fringe Indicators::       Displaying indicator icons in the window fringes.
1342 * Fringe Cursors::          Displaying cursors in the right fringe.
1343 * Fringe Bitmaps::          Specifying bitmaps for fringe indicators.
1344 * Customizing Bitmaps::     Specifying your own bitmaps to use in the fringes.
1345 * Overlay Arrow::           Display of an arrow to indicate position.
1347 The @code{display} Property
1349 * Replacing Specs::         Display specs that replace the text.
1350 * Specified Space::         Displaying one space with a specified width.
1351 * Pixel Specification::     Specifying space width or height in pixels.
1352 * Other Display Specs::     Displaying an image; adjusting the height,
1353                               spacing, and other properties of text.
1354 * Display Margins::         Displaying text or images to the side of
1355                               the main text.
1357 Images
1359 * Image Formats::           Supported image formats.
1360 * Image Descriptors::       How to specify an image for use in @code{:display}.
1361 * XBM Images::              Special features for XBM format.
1362 * XPM Images::              Special features for XPM format.
1363 * GIF Images::              Special features for GIF format.
1364 * TIFF Images::             Special features for TIFF format.
1365 * PostScript Images::       Special features for PostScript format.
1366 * Other Image Types::       Various other formats are supported.
1367 * Defining Images::         Convenient ways to define an image for later use.
1368 * Showing Images::          Convenient ways to display an image once
1369                               it is defined.
1370 * Image Cache::             Internal mechanisms of image display.
1372 Buttons
1374 * Button Properties::       Button properties with special meanings.
1375 * Button Types::            Defining common properties for classes of buttons.
1376 * Making Buttons::          Adding buttons to Emacs buffers.
1377 * Manipulating Buttons::    Getting and setting properties of buttons.
1378 * Button Buffer Commands::  Buffer-wide commands and bindings for buttons.
1380 Abstract Display
1382 * Abstract Display Functions::  Functions in the Ewoc package.
1383 * Abstract Display Example::    Example of using Ewoc.
1385 Display Tables
1387 * Display Table Format::    What a display table consists of.
1388 * Active Display Table::    How Emacs selects a display table to use.
1389 * Glyphs::                  How to define a glyph, and what glyphs mean.
1391 Operating System Interface
1393 * Starting Up::             Customizing Emacs startup processing.
1394 * Getting Out::             How exiting works (permanent or temporary).
1395 * System Environment::      Distinguish the name and kind of system.
1396 * User Identification::     Finding the name and user id of the user.
1397 * Time of Day::             Getting the current time.
1398 * Time Conversion::         Converting a time from numeric form to 
1399                               calendrical data and vice versa.
1400 * Time Parsing::            Converting a time from numeric form to text
1401                               and vice versa.
1402 * Processor Run Time::      Getting the run time used by Emacs.
1403 * Time Calculations::       Adding, subtracting, comparing times, etc.
1404 * Timers::                  Setting a timer to call a function at a
1405                               certain time.
1406 * Idle Timers::             Setting a timer to call a function when Emacs has
1407                               been idle for a certain length of time.
1408 * Terminal Input::          Accessing and recording terminal input.
1409 * Terminal Output::         Controlling and recording terminal output.
1410 * Sound Output::            Playing sounds on the computer's speaker.
1411 * X11 Keysyms::             Operating on key symbols for X Windows.
1412 * Batch Mode::              Running Emacs without terminal interaction.
1413 * Session Management::      Saving and restoring state with
1414                               X Session Management.
1416 Starting Up Emacs
1418 * Startup Summary::         Sequence of actions Emacs performs at startup.
1419 * Init File::               Details on reading the init file.
1420 * Terminal-Specific::       How the terminal-specific Lisp file is read.
1421 * Command-Line Arguments::  How command-line arguments are processed,
1422                               and how you can customize them.
1424 Getting Out of Emacs
1426 * Killing Emacs::           Exiting Emacs irreversibly.
1427 * Suspending Emacs::        Exiting Emacs reversibly.
1429 Terminal Input
1431 * Input Modes::             Options for how input is processed.
1432 * Recording Input::         Saving histories of recent or all input events.
1434 Tips and Conventions
1436 * Coding Conventions::      Conventions for clean and robust programs.
1437 * Key Binding Conventions:: Which keys should be bound by which programs.
1438 * Programming Tips::        Making Emacs code fit smoothly in Emacs.
1439 * Compilation Tips::        Making compiled code run fast.
1440 * Warning Tips::            Turning off compiler warnings.
1441 * Documentation Tips::      Writing readable documentation strings.
1442 * Comment Tips::            Conventions for writing comments.
1443 * Library Headers::         Standard headers for library packages.
1445 GNU Emacs Internals
1447 * Building Emacs::          How the dumped Emacs is made.
1448 * Pure Storage::            A kludge to make preloaded Lisp functions sharable.
1449 * Garbage Collection::      Reclaiming space for Lisp objects no longer used.
1450 * Memory Usage::            Info about total size of Lisp objects made so far.
1451 * Writing Emacs Primitives::  Writing C code for Emacs.
1452 * Object Internals::        Data formats of buffers, windows, processes.
1454 Object Internals
1456 * Buffer Internals::        Components of a buffer structure.
1457 * Window Internals::        Components of a window structure.
1458 * Process Internals::       Components of a process structure.
1459 @end detailmenu
1460 @end menu
1462 @c include intro.texi
1463 @c include objects.texi
1464 @c include numbers.texi
1465 @c include strings.texi
1467 @c include lists.texi
1468 @c include sequences.texi
1469 @c include hash.texi
1470 @c include symbols.texi
1471 @c include eval.texi
1473 @c include control.texi
1474 @c include variables.texi
1475 @c include functions.texi
1476 @c include macros.texi
1478 @c include customize.texi
1479 @c include loading.texi
1480 @c include compile.texi
1481 @c include advice.texi
1483 @c This includes edebug.texi.
1484 @c include debugging.texi
1485 @c include streams.texi
1486 @c include minibuf.texi
1487 @c include commands.texi
1489 @c include keymaps.texi
1490 @c include modes.texi
1491 @c include help.texi
1492 @c include files.texi
1494 @c include backups.texi
1496 @c ================ Beginning of Volume 2 ================
1497 @include buffers.texi
1498 @include windows.texi
1499 @include frames.texi
1501 @include positions.texi
1502 @include markers.texi
1503 @include text.texi
1504 @include nonascii.texi
1506 @include searching.texi
1507 @include syntax.texi
1508 @include abbrevs.texi
1509 @include processes.texi
1511 @include display.texi
1512 @include os.texi
1514 @c MOVE to Emacs Manual:  include misc-modes.texi
1516 @c appendices
1518 @c  REMOVE this:  include non-hacker.texi
1520 @include anti.texi
1521 @include doclicense.texi
1522 @include gpl.texi
1523 @include tips.texi
1524 @include internals.texi
1525 @include errors.texi
1526 @include locals.texi
1527 @include maps.texi
1528 @include hooks.texi
1530 @include index.texi
1532 @ignore
1533 @node New Symbols, , Index, Top
1534 @unnumbered New Symbols Since the Previous Edition
1536 @printindex tp
1537 @end ignore
1539 @bye
1542 These words prevent "local variables" above from confusing Emacs.
1544 @ignore
1545    arch-tag: dfdbecf8-fec2-49c1-8427-3e8ac8b0b849
1546 @end ignore