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