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