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