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