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