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