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