vol1.texi 70.5 KB
Newer Older
1 2 3
\input texinfo  @c -*-texinfo-*-
@c This file is used for printing the GNU Emacs Lisp Reference Manual
@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,
Glenn Morris's avatar
Glenn Morris committed
5
@c   2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
Glenn Morris's avatar
Glenn Morris committed
6
@c   Free Software Foundation, Inc.
7 8 9 10 11
@c %**start of header
@setfilename elisp
@settitle GNU Emacs Lisp Reference Manual: Volume 1
@c %**end of header

12
@c See two-volume-cross-refs.txt.
13
@tex
14 15 16 17 18 19 20 21 22 23
\message{Formatting for two volume edition...Volume 1...}
%
% Read special toc file, set up in two-volume.make.
\gdef\tocreadfilename{elisp1-toc-ready.toc}
%
% Don't make outlines, they're not needed and \readdatafile can't pay
% attention to the special definition above.
\global\let\pdfmakeoutlines=\relax
%
% Start volume 1 chapter numbering at 1; this must be listed as chapno0.
24 25 26
\global\chapno=0
@end tex

27 28
@c Version of the manual and of Emacs.
@c Please remember to update the edition number in README as well.
29
@set VERSION  3.0
Chong Yidong's avatar
Chong Yidong committed
30
@set EMACSVER 23.2.50
31
@set DATE July 2009
32

33 34 35 36
@dircategory Emacs
@direntry
* Elisp: (elisp).       The Emacs Lisp Reference Manual.
@end direntry
37

38 39 40 41
@c in general, keep the following line commented out, unless doing a
@c copy of this manual that will be published.  the manual should go
@c onto the distribution in the full, 8.5 x 11" size.
@set smallbook
42

43 44 45
@ifset smallbook
@smallbook
@end ifset
46

47 48 49 50 51 52 53 54 55 56 57
@c per rms and peterb, use 10pt fonts for the main text, mostly to
@c save on paper cost.  
@c Do this inside @tex for now, so current makeinfo does not complain.
@tex
@ifset smallbook
@fonttextsize 10
\global\let\urlcolor=\Black % don't print links in grayscale
\global\let\linkcolor=\Black
@end ifset
\global\hbadness=6666 % don't worry about not-too-underfull boxes
@end tex
58 59 60 61 62 63

@c Combine indices.
@synindex cp fn
@syncodeindex vr fn
@syncodeindex ky fn
@syncodeindex pg fn
64 65 66 67 68 69 70 71
@c We use the "type index" to index new functions and variables.
@c @syncodeindex tp fn

@copying
This is edition @value{VERSION} of the GNU Emacs Lisp Reference Manual,@*
corresponding to Emacs version @value{EMACSVER}.

Copyright @copyright{} 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1998,
Glenn Morris's avatar
Glenn Morris committed
72
1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010  Free Software
73 74 75 76
Foundation, Inc.

@quotation
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 79 80 81 82 83
any later version published by the Free Software Foundation; with the
Invariant Sections being ``GNU General Public License,'' with the
Front-Cover texts being ``A GNU Manual,'' and with the Back-Cover
Texts as in (a) below.  A copy of the license is included in the
section entitled ``GNU Free Documentation License.''

Glenn Morris's avatar
Glenn Morris committed
84 85
(a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
modify this GNU manual.  Buying copies from the FSF supports it in
Karl Berry's avatar
Karl Berry committed
86
developing GNU and promoting software freedom.''
87 88 89
@end quotation
@end copying

90
@titlepage
91 92 93
@title GNU Emacs Lisp Reference Manual
@subtitle Volume 1
@subtitle For Emacs Version @value{EMACSVER}
94
@subtitle Revision @value{VERSION}, @value{DATE}
95 96 97

@author by Bil Lewis, Dan LaLiberte, Richard Stallman
@author and the GNU Manual Group
98 99
@page
@vskip 0pt plus 1filll
100
@insertcopying
101 102 103 104

@sp 2

Published by the Free Software Foundation @*
105 106 107 108
51 Franklin St, Fifth Floor @*
Boston, MA 02110-1301 @*
USA @*
ISBN 1-882114-74-4
109 110 111 112 113 114

@sp 2
Cover art by Etienne Suvasa.
@end titlepage


115 116 117 118 119 120 121 122 123 124 125 126
@c Print the tables of contents
@summarycontents
@contents


@ifnottex
@node Top, Introduction, (dir), (dir)
@top Emacs Lisp

This Info file contains edition @value{VERSION} of the GNU Emacs Lisp
Reference Manual, corresponding to GNU Emacs version @value{EMACSVER}.
@end ifnottex
127 128 129 130 131 132 133 134 135 136 137

@menu
* Introduction::            Introduction and conventions used.

* Lisp Data Types::         Data types of objects in Emacs Lisp.
* Numbers::                 Numbers and arithmetic functions.
* Strings and Characters::  Strings, and functions that work on them.
* Lists::                   Lists, cons cells, and related functions.
* Sequences Arrays Vectors::  Lists, strings and vectors are called sequences.
                                Certain functions act on any kind of sequence.
                                The description of vectors is here as well.
138
* Hash Tables::             Very fast lookup-tables.
139 140 141 142 143 144 145 146
* Symbols::                 Symbols represent names, uniquely.

* Evaluation::              How Lisp expressions are evaluated.
* Control Structures::      Conditionals, loops, nonlocal exits.
* Variables::               Using symbols in programs to stand for values.
* Functions::               A function is a Lisp program
                              that can be invoked from other functions.
* Macros::                  Macros are a way to extend the Lisp language.
147
* Customization::           Writing customization declarations.
148 149 150

* Loading::                 Reading files of Lisp code into Lisp.
* Byte Compilation::        Compilation makes programs run faster.
151
* Advising Functions::      Adding to the definition of a function.
152 153 154 155 156 157 158 159 160 161 162 163 164 165 166
* Debugging::               Tools and tips for debugging Lisp programs.

* Read and Print::          Converting Lisp objects to text and back.
* Minibuffers::             Using the minibuffer to read input.
* Command Loop::            How the editor command loop works,
                              and how you can call its subroutines.
* Keymaps::                 Defining the bindings from keys to commands.
* Modes::                   Defining major and minor modes.
* Documentation::           Writing and using documentation strings.

* Files::                   Accessing files.
* Backups and Auto-Saving:: Controlling how backups and auto-save
                              files are made.
* Buffers::                 Creating and using buffer objects.
* Windows::                 Manipulating windows and displaying buffers.
167
* Frames::		    Making multiple system-level windows.
168 169 170 171 172
* Positions::               Buffer positions and motion functions.
* Markers::                 Markers represent positions and update
                              automatically when the text is changed.

* Text::                    Examining and changing text in buffers.
173
* Non-ASCII Characters::    Non-ASCII text in buffers and strings.
174 175 176 177 178
* Searching and Matching::  Searching buffers for strings or regexps.
* Syntax Tables::           The syntax table controls word and list parsing.
* Abbrevs::                 How Abbrev mode works, and its data structures.

* Processes::               Running and communicating with subprocesses.
179
* Display::	            Features for controlling the screen display.
180 181 182 183 184
* System Interface::        Getting the user id, system type, environment
                              variables, and other such things.

Appendices

185
* Antinews::                Info for users downgrading to Emacs 22.
Glenn Morris's avatar
Glenn Morris committed
186
* GNU Free Documentation License:: The license for this documentation.
187 188
* GPL::                     Conditions for copying and changing GNU Emacs.
* Tips::                    Advice and coding conventions for Emacs Lisp.
189 190 191
* GNU Emacs Internals::     Building and dumping Emacs;
                              internal data structures.
* Standard Errors::         List of all error symbols.
192 193
* Standard Buffer-Local Variables::
                            List of variables buffer-local in all buffers.
194 195 196 197 198 199
* Standard Keymaps::        List of standard keymaps.
* Standard Hooks::          List of standard hook variables.

* Index::                   Index including concepts, functions, variables,
                              and other terms.

200 201 202 203 204 205 206 207 208 209 210 211
@ignore
* New Symbols::             New functions and variables in Emacs @value{EMACSVER}.
@end ignore

@c Do NOT modify the following 3 lines!  They must have this form to
@c be correctly identified by `texinfo-multiple-files-update'.  In
@c particular, the detailed menu header line MUST be identical to the
@c value of `texinfo-master-menu-header'.  See texnfo-upd.el.

@detailmenu
 --- The Detailed Node Listing ---
 ---------------------------------
212 213 214 215 216 217 218 219 220

Here are other nodes that are inferiors of those already listed,
mentioned here so you can get to them in one step:

Introduction

* Caveats::                 Flaws and a request for help.
* Lisp History::            Emacs Lisp is descended from Maclisp.
* Conventions::             How the manual is formatted.
221
* Version Info::            Which Emacs version is running?
222 223 224 225 226 227 228
* Acknowledgements::        The authors, editors, and sponsors of this manual.

Conventions

* Some Terms::              Explanation of terms we use in this manual.
* nil and t::               How the symbols @code{nil} and @code{t} are used.
* Evaluation Notation::     The format we use for examples of evaluation.
Glenn Morris's avatar
Glenn Morris committed
229
* Printing Notation::       The format we use when examples print text.
230 231 232 233 234 235
* Error Messages::          The format we use for examples of errors.
* Buffer Text Notation::    The format we use for buffer contents in examples.
* Format of Descriptions::  Notation for describing functions, variables, etc.

Format of Descriptions

236 237 238 239
* A Sample Function Description::  A description of an imaginary
                                     function, @code{foo}.
* A Sample Variable Description::  A description of an imaginary
                                     variable, @code{electric-future-map}.
240 241 242 243 244 245 246

Lisp Data Types

* Printed Representation::  How Lisp objects are represented as text.
* Comments::                Comments and their formatting conventions.
* Programming Types::       Types found in all Lisp systems.
* Editing Types::           Types specific to Emacs.
247
* Circular Objects::            Read syntax for circular structure.
248 249 250 251 252 253 254 255
* Type Predicates::         Tests related to types.
* Equality Predicates::     Tests of equality between any two objects.

Programming Types

* Integer Type::        Numbers without fractional parts.
* Floating Point Type:: Numbers with fractional parts and with a large range.
* Character Type::      The representation of letters, numbers and
256 257
                          control characters.
* Symbol Type::         A multi-use object that refers to a function,
Glenn Morris's avatar
Glenn Morris committed
258
                        variable, or property list, and has a unique identity.
259 260 261 262 263
* Sequence Type::       Both lists and arrays are classified as sequences.
* Cons Cell Type::      Cons cells, and lists (which are made from cons cells).
* Array Type::          Arrays include strings and vectors.
* String Type::         An (efficient) array of characters.
* Vector Type::         One-dimensional arrays.
264 265 266
* Char-Table Type::     One-dimensional sparse arrays indexed by characters.
* Bool-Vector Type::    One-dimensional arrays of @code{t} or @code{nil}.
* Hash Table Type::     Super-fast lookup tables.
267 268 269 270 271 272
* Function Type::       A piece of executable code you can call from elsewhere.
* Macro Type::          A method of expanding an expression into another
                          expression, more fundamental but less pretty.
* Primitive Function Type::     A function written in C, callable from Lisp.
* Byte-Code Type::      A function written in Lisp, then compiled.
* Autoload Type::       A type used for automatically loading seldom-used
273 274 275
                          functions.

Character Type
276

277 278 279 280 281
* Basic Char Syntax::       Syntax for regular characters.
* General Escape Syntax::   How to specify characters by their codes.
* Ctl-Char Syntax::         Syntax for control characters.
* Meta-Char Syntax::        Syntax for meta-characters.
* Other Char Bits::         Syntax for hyper-, super-, and alt-characters.
282

283 284 285
Cons Cell and List Types

* Box Diagrams::            Drawing pictures of lists.
Glenn Morris's avatar
Glenn Morris committed
286
* Dotted Pair Notation::    A general syntax for cons cells.
287 288
* Association List Type::   A specially constructed list.

289 290 291 292 293 294 295
String Type

* Syntax for Strings::      How to specify Lisp strings.
* Non-ASCII in Strings::    International characters in strings.
* Nonprinting Characters::  Literal unprintable characters in strings.
* Text Props and Strings::  Strings with text properties.

296 297 298 299
Editing Types

* Buffer Type::             The basic object of editing.
* Marker Type::             A position in a buffer.
Glenn Morris's avatar
Glenn Morris committed
300
* Window Type::             Buffers are displayed in windows.
301 302
* Frame Type::              Windows subdivide frames.
* Terminal Type::           A terminal device displays frames.
303 304
* Window Configuration Type::  Recording the way a frame is subdivided.
* Frame Configuration Type::   Recording the status of all frames.
305
* Process Type::            A subprocess of Emacs running on the underlying OS.
306 307
* Stream Type::             Receive or send characters.
* Keymap Type::             What function a keystroke invokes.
308
* Overlay Type::            How an overlay is represented.
309
* Font Type::               Fonts for displaying text.
310 311 312

Numbers

313 314 315 316 317 318 319 320 321 322
* Integer Basics::          Representation and range of integers.
* Float Basics::	    Representation and range of floating point.
* Predicates on Numbers::   Testing for numbers.
* Comparison of Numbers::   Equality and inequality predicates.
* Numeric Conversions::	    Converting float to integer and vice versa.
* Arithmetic Operations::   How to add, subtract, multiply and divide.
* Rounding Operations::     Explicitly rounding floating point numbers.
* Bitwise Operations::      Logical and, or, not, shifting.
* Math Functions::          Trig, exponential and logarithmic functions.
* Random Numbers::          Obtaining random integers, predictable or not.
323 324 325 326 327 328

Strings and Characters

* String Basics::           Basic properties of strings and characters.
* Predicates for Strings::  Testing whether an object is a string or char.
* Creating Strings::        Functions to allocate new strings.
329
* Modifying Strings::         Altering the contents of an existing string.
330
* Text Comparison::         Comparing characters or strings.
Glenn Morris's avatar
Glenn Morris committed
331
* String Conversion::       Converting to and from characters and strings.
332 333 334
* Formatting Strings::      @code{format}: Emacs's analogue of @code{printf}.
* Case Conversion::         Case conversion functions.
* Case Tables::		    Customizing case conversion.
335 336 337 338 339 340 341

Lists

* Cons Cells::              How lists are made out of cons cells.
* List-related Predicates:: Is this object a list?  Comparing two lists.
* List Elements::           Extracting the pieces of a list.
* Building Lists::          Creating list structure.
342
* List Variables::          Modifying lists stored in variables.
343 344 345
* Modifying Lists::         Storing new pieces into an existing list.
* Sets And Lists::          A list can represent a finite mathematical set.
* Association Lists::       A list can represent a finite relation or mapping.
346
* Rings::                   Managing a fixed-size ring of objects.
347 348 349 350 351 352 353 354 355 356 357 358 359

Modifying Existing List Structure

* Setcar::                  Replacing an element in a list.
* Setcdr::                  Replacing part of the list backbone.
                              This can be used to remove or add elements.
* Rearrangement::           Reordering the elements in a list; combining lists.

Sequences, Arrays, and Vectors

* Sequence Functions::      Functions that accept any kind of sequence.
* Arrays::                  Characteristics of arrays in Emacs Lisp.
* Array Functions::         Functions specifically for arrays.
360 361 362 363 364 365 366 367 368
* Vectors::                 Special characteristics of Emacs Lisp vectors.
* Vector Functions::        Functions specifically for vectors.
* Char-Tables::             How to work with char-tables.
* Bool-Vectors::            How to work with bool-vectors.

Hash Tables

* Creating Hash::           Functions to create hash tables.
* Hash Access::             Reading and writing the hash table contents.
Glenn Morris's avatar
Glenn Morris committed
369
* Defining Hash::           Defining new comparison methods.
370
* Other Hash::              Miscellaneous.
371 372 373 374 375 376 377 378 379 380

Symbols

* Symbol Components::       Symbols have names, values, function definitions
                              and property lists.
* Definitions::             A definition says how a symbol will be used.
* Creating Symbols::        How symbols are kept unique.
* Property Lists::          Each symbol has a property list
                              for recording miscellaneous information.

381 382 383 384 385 386 387
Property Lists

* Plists and Alists::       Comparison of the advantages of property
                              lists and association lists.
* Symbol Plists::           Functions to access symbols' property lists.
* Other Plists::            Accessing property lists stored elsewhere.

388 389 390 391
Evaluation

* Intro Eval::              Evaluation in the scheme of things.
* 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.
395 396 397 398 399 400

Kinds of Forms

* Self-Evaluating Forms::   Forms that evaluate to themselves.
* Symbol Forms::            Symbols evaluate as variables.
* Classifying Lists::       How to distinguish various sorts of list forms.
401 402
* Function Indirection::    When a symbol appears as the car of a list,
			      we find the real function via the symbol.
403 404
* Function Forms::          Forms that call functions.
* Macro Forms::             Forms that call macros.
405
* Special Forms::           "Special forms" are idiosyncratic primitives,
406 407 408 409 410 411 412
                              most of them extremely important.
* Autoloading::             Functions set up to load files
                              containing their real definitions.

Control Structures

* Sequencing::              Evaluation in textual order.
413
* Conditionals::            @code{if}, @code{cond}, @code{when}, @code{unless}.
414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439
* Combining Conditions::    @code{and}, @code{or}, @code{not}.
* Iteration::               @code{while} loops.
* Nonlocal Exits::          Jumping out of a sequence.

Nonlocal Exits

* Catch and Throw::         Nonlocal exits for the program's own purposes.
* Examples of Catch::       Showing how such nonlocal exits can be written.
* Errors::                  How errors are signaled and handled.
* Cleanups::                Arranging to run a cleanup form if an
                              error happens.

Errors

* Signaling Errors::        How to report an error.
* Processing of Errors::    What Emacs does when you report an error.
* Handling Errors::         How you can trap errors and continue execution.
* Error Symbols::           How errors are classified for trapping them.

Variables

* Global Variables::        Variable values that exist permanently, everywhere.
* Constant Variables::      Certain "variables" have values that never change.
* Local Variables::         Variable values that exist only temporarily.
* Void Variables::          Symbols that lack values.
* Defining Variables::      A definition says a symbol is used as a variable.
440 441
* Tips for Defining::       Things you should think about when you
                              define a variable.
442 443 444 445 446
* Accessing Variables::     Examining values of variables whose names
                              are known only at run time.
* Setting Variables::       Storing new values in variables.
* Variable Scoping::        How Lisp chooses among local and global values.
* Buffer-Local Variables::  Variable values in effect only in one buffer.
447
* File Local Variables::    Handling local variable lists in files.
Glenn Morris's avatar
Glenn Morris committed
448 449
* Directory Local Variables:: Local variables common to all files in a
                                directory.
450
* Frame-Local Variables::   Frame-local bindings for variables.
451 452 453
* Variable Aliases::        Variables that are aliases for other variables.
* Variables with Restricted Values::  Non-constant variables whose value can
                                        @emph{not} be an arbitrary Lisp object.
454 455 456

Scoping Rules for Variable Bindings

457
* Scope::                   Scope means where in the program a value
458 459 460
                              is visible.  Comparison with other languages.
* Extent::                  Extent means how long in time a value exists.
* Impl of Scope::           Two ways to implement dynamic scoping.
461
* Using Scoping::           How to use dynamic scoping carefully and
462 463 464 465 466 467 468
                              avoid problems.

Buffer-Local Variables

* Intro to Buffer-Local::   Introduction and concepts.
* Creating Buffer-Local::   Creating and destroying buffer-local bindings.
* Default Value::           The default value is seen in buffers
469
                              that don't have their own buffer-local values.
470 471 472

Functions

Glenn Morris's avatar
Glenn Morris committed
473
* What Is a Function::      Lisp functions vs. primitives; terminology.
474 475 476 477 478
* Lambda Expressions::      How functions are expressed as Lisp objects.
* Function Names::          A symbol can serve as the name of a function.
* Defining Functions::      Lisp expressions for defining functions.
* Calling Functions::       How to use an existing function.
* Mapping Functions::       Applying a function to each element of a list, etc.
Glenn Morris's avatar
Glenn Morris committed
479
* Anonymous Functions::     Lambda expressions are functions with no names.
480 481
* Function Cells::          Accessing or setting the function definition
                              of a symbol.
482
* Obsolete Functions::      Declaring functions obsolete.
Glenn Morris's avatar
Glenn Morris committed
483 484 485
* Inline Functions::	    Defining functions that the compiler
                              will open code.
* 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 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506
                              functions work.

Lambda Expressions

* Lambda Components::       The parts of a lambda expression.
* Simple Lambda::           A simple example.
* Argument List::           Details and special features of argument lists.
* Function Documentation::  How to put documentation in a function.

Macros

* Simple Macro::            A basic example.
* Expansion::               How, when and why macros are expanded.
* Compiling Macros::        How macros are expanded by the compiler.
* Defining Macros::         How to write a macro definition.
* Backquote::               Easier construction of list structure.
* Problems with Macros::    Don't evaluate the macro arguments too many times.
                              Don't hide the user's variables.
507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533
* Indenting Macros::        Specifying how to indent macro calls.

Common Problems Using Macros

* Wrong Time::             Do the work in the expansion, not in the macro.
* Argument Evaluation::    The expansion should evaluate each macro arg once.
* Surprising Local Vars::  Local variable bindings in the expansion
                              require special care.
* Eval During Expansion::  Don't evaluate them; put them in the expansion.
* Repeated Expansion::     Avoid depending on how many times expansion is done.

Writing Customization Definitions

* Common Keywords::         Common keyword arguments for all kinds of
                              customization declarations.
* Group Definitions::       Writing customization group definitions.
* Variable Definitions::    Declaring user options.
* Customization Types::     Specifying the type of a user option.

Customization Types

* Simple Types::            Simple customization types: sexp, integer, number,
                              string, file, directory, alist.
* Composite Types::         Build new types from other types or data.
* Splicing into Lists::     Splice elements into list with @code{:inline}.
* Type Keywords::           Keyword-argument pairs in a customization type.
* Defining New Types::      Give your type a name.
534 535 536 537

Loading

* How Programs Do Loading:: The @code{load} function and others.
538 539 540
* Load Suffixes::           Details about the suffixes that @code{load} tries.
* Library Search::          Finding a library to load.
* Loading Non-ASCII::       Non-@acronym{ASCII} characters in Emacs Lisp files.
541 542
* Autoload::                Setting up a function to autoload.
* Repeated Loading::        Precautions about loading a file twice.
543 544 545 546 547
* Named Features::          Loading a library if it isn't already loaded.
* Where Defined::           Finding which file defined a certain symbol.
* Unloading::		    How to "unload" a library that was loaded.
* Hooks for Loading::	    Providing code to be run when
			      particular libraries are loaded.
548 549 550

Byte Compilation

551
* Speed of Byte-Code::      An example of speedup from byte compilation.
552
* Compilation Functions::   Byte compilation functions.
553 554 555 556 557
* Docs and Compilation::    Dynamic loading of documentation strings.
* Dynamic Loading::         Dynamic loading of individual functions.
* Eval During Compile::     Code to be evaluated when you compile.
* Compiler Errors::         Handling compiler error messages.
* Byte-Code Objects::	    The data type used for byte-compiled functions.
558 559
* Disassembly::             Disassembling byte-code; how to read byte-code.

560 561 562 563 564 565 566 567 568 569 570 571 572 573
Advising Emacs Lisp Functions

* Simple Advice::           A simple example to explain the basics of advice.
* Defining Advice::         Detailed description of @code{defadvice}.
* Around-Advice::           Wrapping advice around a function's definition.
* Computed Advice::         ...is to @code{defadvice} as @code{fset} is to @code{defun}.
* Activation of Advice::    Advice doesn't do anything until you activate it.
* Enabling Advice::         You can enable or disable each piece of advice.
* Preactivation::           Preactivation is a way of speeding up the
                              loading of compiled advice.
* Argument Access in Advice:: How advice can access the function's arguments.
* Advising Primitives::     Accessing arguments when advising a primitive.
* Combined Definition::     How advice is implemented.

574 575 576
Debugging Lisp Programs

* 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.
582

583 584 585
The Lisp Debugger

* Error Debugging::         Entering the debugger when an error happens.
586
* Infinite Loops::	    Stopping and debugging a program that doesn't exit.
587 588 589 590 591 592 593
* Function Debugging::      Entering it when a certain function is called.
* Explicit Debug::          Entering it at a certain point in the program.
* Using Debugger::          What the debugger does; what you see while in it.
* Debugger Commands::       Commands used while in the debugger.
* Invoking the Debugger::   How to call the function @code{debug}.
* Internals of Debugger::   Subroutines of the debugger, and global variables.

594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614
Edebug

* Using Edebug::	    Introduction to use of Edebug.
* Instrumenting::	    You must instrument your code
			      in order to debug it with Edebug.
* Edebug Execution Modes::  Execution modes, stopping more or less often.
* Jumping::		    Commands to jump to a specified place.
* Edebug Misc::		    Miscellaneous commands.
* Breaks::		    Setting breakpoints to make the program stop.
* Trapping Errors::	    Trapping errors with Edebug.
* Edebug Views::	    Views inside and outside of Edebug.
* Edebug Eval::		    Evaluating expressions within Edebug.
* Eval List::		    Expressions whose values are displayed
			      each time you enter Edebug.
* Printing in Edebug::	    Customization of printing.
* Trace Buffer::	    How to produce trace output in a buffer.
* Coverage Testing::	    How to test evaluation coverage.
* The Outside Context::	    Data that Edebug saves and restores.
* Edebug and Macros::       Specifying how to handle macro calls.
* Edebug Options::	    Option variables for customizing Edebug.

Glenn Morris's avatar
Glenn Morris committed
615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633
Breaks

* Breakpoints::             Breakpoints at stop points.
* Global Break Condition::  Breaking on an event.
* Source Breakpoints::      Embedding breakpoints in source code.

The Outside Context

* Checking Whether to Stop::When Edebug decides what to do.
* Edebug Display Update::   When Edebug updates the display.
* Edebug Recursive Edit::   When Edebug stops execution.

Edebug and Macros

* Instrumenting Macro Calls::The basic problem.
* Specification List::	    How to specify complex patterns of evaluation.
* Backtracking::	    What Edebug does when matching fails.
* Specification Examples::  To help understand specifications.

634 635 636 637 638 639 640 641
Debugging Invalid Lisp Syntax

* Excess Open::             How to find a spurious open paren or missing close.
* Excess Close::            How to find a spurious close paren or missing open.

Reading and Printing Lisp Objects

* Streams Intro::           Overview of streams, reading and printing.
642
* Input Streams::           Various data types that can be used as
643 644
                              input streams.
* Input Functions::         Functions to read Lisp objects from text.
645
* Output Streams::          Various data types that can be used as
646 647
                              output streams.
* Output Functions::        Functions to print Lisp objects as text.
648 649
* Output Variables::        Variables that control what the printing
                              functions do.
650 651 652 653 654 655

Minibuffers

* Intro to Minibuffers::    Basic information about minibuffers.
* Text from Minibuffer::    How to read a straight text string.
* Object from Minibuffer::  How to read a Lisp object or expression.
656 657 658
* Minibuffer History::	    Recording previous minibuffer inputs
			      so the user can reuse them.
* Initial Input::           Specifying initial contents for the minibuffer.
659 660
* Completion::              How to invoke and customize completion.
* Yes-or-No Queries::       Asking a question with a simple answer.
661 662 663 664 665 666
* Multiple Queries::	    Asking a series of similar questions.
* Reading a Password::	    Reading a password from the terminal.
* Minibuffer Commands::     Commands used as key bindings in minibuffers.
* Minibuffer Contents::     How such commands access the minibuffer text.
* Minibuffer Windows::      Operating on the special minibuffer windows.
* Recursive Mini::          Whether recursive entry to minibuffer is allowed.
667 668 669 670 671 672 673 674 675
* Minibuffer Misc::         Various customization hooks and variables.

Completion

* Basic Completion::        Low-level functions for completing strings.
                              (These are too low level to use the minibuffer.)
* Minibuffer Completion::   Invoking the minibuffer with completion.
* Completion Commands::     Minibuffer commands that do completion.
* High-Level Completion::   Convenient special cases of completion
676
                              (reading buffer name, file name, etc.).
677 678 679
* Reading File Names::      Using completion to read file names and
                              shell commands.
* Completion Styles::       Specifying rules for performing completion.
Glenn Morris's avatar
Glenn Morris committed
680
* Programmed Completion::   Writing your own completion-function.
681 682 683 684 685 686

Command Loop

* Command Overview::    How the command loop reads commands.
* Defining Commands::   Specifying how a function should read arguments.
* 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 691
* Input Events::	What input looks like when you read it.
* Reading Input::       How to read input events from the keyboard or mouse.
692
* Special Events::      Events processed immediately and individually.
693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708
* Waiting::             Waiting for user input or elapsed time.
* Quitting::            How @kbd{C-g} works.  How to catch or defer quitting.
* Prefix Command Arguments::    How the commands to set prefix args work.
* Recursive Editing::   Entering a recursive edit,
                          and why you usually shouldn't.
* Disabling Commands::  How the command loop handles disabled commands.
* Command History::     How the command history is set up, and how accessed.
* Keyboard Macros::     How keyboard macros are implemented.

Defining Commands

* Using Interactive::       General rules for @code{interactive}.
* Interactive Codes::       The standard letter-codes for reading arguments
                              in various ways.
* Interactive Examples::    Examples of how to read interactive arguments.

709 710 711 712 713 714 715 716 717 718 719 720 721 722
Input Events

* Keyboard Events::         Ordinary characters--keys with symbols on them.
* Function Keys::           Function keys--keys with names, not symbols.
* Mouse Events::            Overview of mouse events.
* Click Events::            Pushing and releasing a mouse button.
* Drag Events::             Moving the mouse before releasing the button.
* Button-Down Events::      A button was pushed and not yet released.
* Repeat Events::           Double and triple click (or drag, or down).
* Motion Events::           Just moving the mouse, not pushing a button.
* Focus Events::            Moving the mouse between frames.
* Misc Events::             Other events the system can generate.
* Event Examples::          Examples of the lists for mouse events.
* Classifying Events::      Finding the modifier keys in an event symbol.
Glenn Morris's avatar
Glenn Morris committed
723
                              Event types.
724 725
* Accessing Mouse::	    Functions to extract info from mouse events.
* Accessing Scroll::        Functions to get info from scroll bar events.
726 727 728 729 730 731 732 733 734 735 736 737
* Strings of Events::       Special considerations for putting
                              keyboard character events in a string.

Reading Input

* Key Sequence Input::      How to read one key sequence.
* Reading One Event::       How to read just one event.
* Event Mod::               How Emacs modifies events as they are read.
* Invoking the Input Method::   How reading an event uses the input method.
* Quoted Character Input::  Asking the user to specify a character.
* Event Input Misc::        How to reread or throw away input events.

738 739
Keymaps

740 741 742 743 744 745 746 747 748 749 750 751 752
* Key Sequences::           Key sequences as Lisp objects.
* Keymap Basics::           Basic concepts of keymaps.
* Format of Keymaps::       What a keymap looks like as a Lisp object.
* Creating Keymaps::        Functions to create and copy keymaps.
* Inheritance and Keymaps:: How one keymap can inherit the bindings
                              of another keymap.
* Prefix Keys::             Defining a key with a keymap as its definition.
* Active Keymaps::          How Emacs searches the active keymaps
                              for a key binding.
* Searching Keymaps::       A pseudo-Lisp summary of searching active maps.
* Controlling Active Maps:: Each buffer has a local keymap
                               to override the standard (global) bindings.
                               A minor mode can also override them.
Glenn Morris's avatar
Glenn Morris committed
753
* Key Lookup::              Finding a key's binding in one keymap.
754
* Functions for Key Lookup::    How to request key lookup.
755 756 757 758 759
* Changing Key Bindings::   Redefining a key in a keymap.
* Remapping Commands::      A keymap can translate one command to another.
* Translation Keymaps::     Keymaps for translating sequences of events.
* Key Binding Commands::    Interactive interfaces for redefining keys.
* Scanning Keymaps::        Looking through all keymaps, for printing help.
Glenn Morris's avatar
Glenn Morris committed
760
* Menu Keymaps::            Defining a menu as a keymap.
761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792

Menu Keymaps

* Defining Menus::          How to make a keymap that defines a menu.
* Mouse Menus::             How users actuate the menu with the mouse.
* Keyboard Menus::          How users actuate the menu with the keyboard.
* Menu Example::            Making a simple menu.
* Menu Bar::                How to customize the menu bar.
* Tool Bar::                A tool bar is a row of images.
* Modifying Menus::         How to add new items to a menu.

Defining Menus

* Simple Menu Items::       A simple kind of menu key binding,
                              limited in capabilities.
* Extended Menu Items::     More powerful menu item definitions
                              let you specify keywords to enable
                              various features.
* Menu Separators::         Drawing a horizontal line through a menu.
* Alias Menu Items::        Using command aliases in menu items.

Major and Minor Modes

* Hooks::              How to use hooks; how to write code that provides hooks.
* Major Modes::        Defining major modes.
* Minor Modes::        Defining minor modes.
* Mode Line Format::   Customizing the text that appears in the mode line.
* Imenu::              How a mode can provide a menu
                         of definitions in the buffer.
* Font Lock Mode::     How modes can highlight text according to syntax.
* Desktop Save Mode::  How modes can have buffer state saved between
                         Emacs sessions.
793

Glenn Morris's avatar
Glenn Morris committed
794 795 796 797 798
Hooks

* Running Hooks::      How to run a hook.
* Setting Hooks::      How to put functions on a hook, or remove them.

799 800
Major Modes

801
* Major Mode Basics::
802 803 804
* Major Mode Conventions::  Coding conventions for keymaps, etc.
* Auto Major Mode::         How Emacs chooses the major mode automatically.
* Mode Help::               Finding out how to use a mode.
805 806 807 808 809
* Derived Modes::           Defining a new major mode based on another major
                              mode.
* Generic Modes::           Defining a simple major mode that supports
                              comment syntax and Font Lock mode.
* Mode Hooks::              Hooks run at the end of major mode functions.
Glenn Morris's avatar
Glenn Morris committed
810
* Example Major Modes::     Text mode and Lisp modes.
811 812 813 814 815

Minor Modes

* Minor Mode Conventions::  Tips for writing a minor mode.
* Keymaps and Minor Modes:: How a minor mode can have its own keymap.
816
* Defining Minor Modes::    A convenient facility for defining minor modes.
817 818 819

Mode Line Format

Glenn Morris's avatar
Glenn Morris committed
820
* Mode Line Basics::        Basic ideas of mode line control.
821
* Mode Line Data::          The data structure that controls the mode line.
Glenn Morris's avatar
Glenn Morris committed
822
* Mode Line Top::           The top level variable, mode-line-format.
823 824
* Mode Line Variables::     Variables used in that data structure.
* %-Constructs::            Putting information into a mode line.
825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847
* Properties in Mode::      Using text properties in the mode line.
* Header Lines::            Like a mode line, but at the top.
* Emulating Mode Line::     Formatting text as the mode line would.

Font Lock Mode

* Font Lock Basics::        Overview of customizing Font Lock.
* Search-based Fontification::  Fontification based on regexps.
* Customizing Keywords::    Customizing search-based fontification.
* Other Font Lock Variables::   Additional customization facilities.
* Levels of Font Lock::     Each mode can define alternative levels
                              so that the user can select more or less.
* Precalculated Fontification:: How Lisp programs that produce the buffer
                                  contents can also specify how to fontify it.
* Faces for Font Lock::     Special faces specifically for Font Lock.
* Syntactic Font Lock::     Fontification based on syntax tables.
* Setting Syntax Properties::   Defining character syntax based on context
                                  using the Font Lock mechanism.
* Multiline Font Lock::     How to coerce Font Lock into properly
                              highlighting multiline constructs.

Multiline Font Lock Constructs

Glenn Morris's avatar
Glenn Morris committed
848
* Font Lock Multiline::     Marking multiline chunks with a text property.
849 850
* Region to Fontify::       Controlling which region gets refontified
                              after a buffer change.
851 852 853 854 855 856 857 858 859 860 861 862 863 864 865

Documentation

* Documentation Basics::    Good style for doc strings.
                              Where to put them.  How Emacs stores them.
* Accessing Documentation:: How Lisp programs can access doc strings.
* Keys in Documentation::   Substituting current key bindings.
* Describing Characters::   Making printable descriptions of
                              non-printing characters and key sequences.
* Help Functions::          Subroutines used by Emacs help facilities.

Files

* Visiting Files::          Reading files into Emacs buffers for editing.
* Saving Buffers::          Writing changed buffers back into files.
Glenn Morris's avatar
Glenn Morris committed
866
* Reading from Files::      Reading files into buffers without visiting.
867 868
* Writing to Files::        Writing new files from parts of buffers.
* File Locks::              Locking and unlocking files, to prevent
869 870 871 872 873 874 875 876 877
                              simultaneous editing by two people.
* Information about Files:: Testing existence, accessibility, size of files.
* Changing Files::          Renaming files, changing protection, etc.
* File Names::              Decomposing and expanding file names.
* Contents of Directories:: Getting a list of the files in a directory.
* Create/Delete Dirs::	    Creating and Deleting Directories.
* Magic File Names::	    Defining "magic" special handling
			      for certain file names.
* Format Conversion::       Conversion to and from various file formats.
878 879 880 881 882 883 884 885 886

Visiting Files

* Visiting Functions::      The usual interface functions for visiting.
* Subroutines of Visiting:: Lower-level subroutines that they use.

Information about Files

* Testing Accessibility::   Is a given file readable?  Writable?
887 888
* Kinds of Files::          Is it a directory?  A symbolic link?
* 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.
891 892 893 894

File Names

* File Name Components::    The directory part of a file name, and the rest.
Glenn Morris's avatar
Glenn Morris committed
895
* Relative File Names::     Some file names are relative to a current directory.
896 897
* Directory Names::         A directory's name as a directory
                              is different from its name as a file.
898 899 900
* File Name Expansion::     Converting relative file names to absolute ones.
* Unique File Names::       Generating names for temporary files.
* File Name Completion::    Finding the completions for a given file name.
901 902
* Standard File Names::     If your package uses a fixed file name,
                              how to handle various operating systems simply.
903

Glenn Morris's avatar
Glenn Morris committed
904 905
File Format Conversion

906
* Format Conversion Overview::   @code{insert-file-contents} and @code{write-region}.
Glenn Morris's avatar
Glenn Morris committed
907 908 909
* Format Conversion Round-Trip:: Using @code{format-alist}.
* Format Conversion Piecemeal::  Specifying non-paired conversion.

910 911
Backups and Auto-Saving

912
* Backup Files::            How backup files are made; how their names
913 914 915
                              are chosen.
* Auto-Saving::             How auto-save files are made; how their
                              names are chosen.
916
* Reverting::               @code{revert-buffer}, and how to customize
917 918 919 920 921
                              what it does.

Backup Files

* Making Backups::          How Emacs makes backup files, and when.
922
* Rename or Copy::          Two alternatives: renaming the old file
923 924 925 926 927 928 929
                              or copying it.
* Numbered Backups::        Keeping multiple backups for each source file.
* Backup Names::            How backup file names are computed; customization.

Buffers

* Buffer Basics::           What is a buffer?
930
* Current Buffer::          Designating a buffer as current
Glenn Morris's avatar
Glenn Morris committed
931
                              so that primitives will access its contents.
932 933 934 935 936
* Buffer Names::            Accessing and changing buffer names.
* Buffer File Name::        The buffer file name indicates which file
                              is visited.
* Buffer Modification::     A buffer is @dfn{modified} if it needs to be saved.
* Modification Time::       Determining whether the visited file was changed
937
                              ``behind Emacs's back''.
938 939 940 941 942
* Read Only Buffers::       Modifying text is not allowed in a
                              read-only buffer.
* The Buffer List::         How to look at all the existing buffers.
* Creating Buffers::        Functions that create buffers.
* Killing Buffers::         Buffers exist until explicitly killed.
943 944
* Indirect Buffers::        An indirect buffer shares text with some
                              other buffer.
945
* Swapping Text::           Swapping text between two buffers.
946
* Buffer Gap::              The gap in the buffer.
947 948 949 950 951 952 953 954 955

Windows

* Basic Windows::           Basic information on using windows.
* Splitting Windows::       Splitting one window into two windows.
* Deleting Windows::        Deleting a window gives its space to other windows.
* Selecting Windows::       The selected window is the one that you edit in.
* Cyclic Window Ordering::  Moving around the existing windows.
* 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 960
* Dedicated Windows::	    How to avoid displaying another buffer in
                              a specific window.          
961
* Window Point::            Each window has its own location of point.
962 963
* Window Start and End::    Buffer positions indicating which text is
                              on-screen in a window.
964 965 966
* Textual Scrolling::       Moving text up and down through the window.
* Vertical Scrolling::      Moving the contents up and down on the window.
* Horizontal Scrolling::    Moving the contents sideways on the window.
967 968
* Size of Window::          Accessing the size of a window.
* Resizing Windows::        Changing the size of a window.
969 970
* Coordinates and Windows:: Converting coordinates to windows.
* 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 974 975
* Window Hooks::            Hooks for scrolling, window size changes,
                              redisplay going past a certain point,
                              or window configuration changes.
976 977 978 979

Frames

* 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 984 985 986 987 988 989 990
* Frame Titles::            Automatic updating of frame titles.
* Deleting Frames::	    Frames last until explicitly deleted.
* Finding All Frames::	    How to examine all existing frames.
* Frames and Windows::	    A frame contains windows;
			      display of text always works through windows.
* Minibuffers and Frames::  How a frame finds the minibuffer to use.
* Input Focus::		    Specifying the selected frame.
* Visibility of Frames::    Frames may be visible or invisible, or icons.
991
* Raising and Lowering::    Raising a frame makes it hide other windows;
Glenn Morris's avatar
Glenn Morris committed
992
			      lowering it makes the others hide it.
993 994 995 996 997
* Frame Configurations::    Saving the state of all frames.
* Mouse Tracking::	    Getting events that say when the mouse moves.
* Mouse Position::	    Asking where the mouse is, or moving it.
* Pop-Up Menus::	    Displaying a menu for the user to select from.
* Dialog Boxes::            Displaying a box to ask yes or no.
998
* Pointer Shape::           Specifying the shape of the mouse pointer.
Glenn Morris's avatar
Glenn Morris committed
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 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023
* Display Feature Testing:: Determining the features of a terminal.

Frame Parameters

* Parameter Access::        How to change a frame's parameters.
* Initial Parameters::	    Specifying frame parameters when you make a frame.
* Window Frame Parameters:: List of frame parameters for window systems.
* Size and Position::       Changing the size and position of a frame.
* Geometry::                Parsing geometry specifications.

Window Frame Parameters

* Basic Parameters::        Parameters that are fundamental.
* Position Parameters::     The position of the frame on the screen.
* Size Parameters::         Frame's size.
* Layout Parameters::       Size of parts of the frame, and
                              enabling or disabling some parts.
* Buffer Parameters::       Which buffers have been or should be shown.
* Management Parameters::   Communicating with the window manager.
* Cursor Parameters::       Controlling the cursor appearance.
Glenn Morris's avatar
Glenn Morris committed
1024
* Font and Color Parameters:: Fonts and colors for the frame text.
1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047

Positions

* Point::                   The special position where editing takes place.
* Motion::                  Changing point.
* Excursions::              Temporary motion and buffer changes.
* Narrowing::               Restricting editing to a portion of the buffer.

Motion

* Character Motion::        Moving in terms of characters.
* Word Motion::             Moving in terms of words.
* Buffer End Motion::       Moving to the beginning or end of the buffer.
* Text Lines::              Moving in terms of lines of text.
* Screen Lines::            Moving in terms of lines as displayed.
* List Motion::             Moving by parsing lists and sexps.
* Skipping Characters::     Skipping characters belonging to a certain set.

Markers

* Overview of Markers::     The components of a marker, and how it relocates.
* Predicates on Markers::   Testing whether an object is a marker.
* Creating Markers::        Making empty markers or markers at certain places.
Glenn Morris's avatar
Glenn Morris committed
1048
* Information from Markers::Finding the marker's buffer or character position.
1049 1050 1051
* Marker Insertion Types::  Two ways a marker can relocate when you
                              insert where it points.
* Moving Markers::          Moving the marker to a new buffer or position.
1052 1053
* The Mark::                How "the mark" is implemented with a marker.
* The Region::              How to access "the region".
1054 1055 1056 1057 1058

Text

* Near Point::              Examining text in the vicinity of point.
* Buffer Contents::         Examining text in a general fashion.
1059
* Comparing Text::          Comparing substrings of buffers.
1060 1061 1062 1063 1064 1065 1066
* Insertion::               Adding new text to a buffer.
* Commands for Insertion::  User-level commands to insert text.
* Deletion::                Removing text from a buffer.
* User-Level Deletion::     User-level commands to delete text.
* The Kill Ring::           Where removed text sometimes is saved for
                              later use.
* Undo::                    Undoing changes to the text of a buffer.
1067 1068
* Maintaining Undo::        How to enable and disable undo information.
			      How to control how much information is kept.
1069 1070
* Filling::                 Functions for explicit filling.
* Margins::                 How to specify margins for filling commands.
1071 1072 1073
* Adaptive Fill::           Adaptive Fill mode chooses a fill prefix
                              from context.
* Auto Filling::            How auto-fill mode is implemented to break lines.
1074 1075
* Sorting::                 Functions for sorting parts of the buffer.
* 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 1082
* Registers::               How registers are implemented.  Accessing
                              the text or position stored in a register.
1083 1084 1085 1086
* Base 64::                 Conversion to or from base 64 encoding.
* MD5 Checksum::            Compute the MD5 "message digest"/"checksum".
* Atomic Changes::          Installing several buffer changes "atomically".
* Change Hooks::            Supplying functions to be run when text is changed.
1087

1088 1089 1090 1091
The Kill Ring

* Kill Ring Concepts::      What text looks like in the kill ring.
* Kill Functions::          Functions that kill text.
1092
* Yanking::                 How yanking is done.
1093 1094
* Yank Commands::           Commands that access the kill ring.
* Low-Level Kill Ring::	    Functions and variables for kill ring access.
Glenn Morris's avatar
Glenn Morris committed
1095
* Internals of Kill Ring::  Variables that hold kill ring data.
1096 1097 1098 1099 1100 1101 1102 1103 1104 1105

Indentation

* Primitive Indent::        Functions used to count and insert indentation.
* Mode-Specific Indent::    Customize indentation for different modes.
* Region Indent::           Indent all the lines in a region.
* Relative Indent::         Indent the current line based on previous lines.
* Indent Tabs::             Adjustable, typewriter-like tab stops.
* Motion by Indent::        Move to first non-blank character.

1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123
Text Properties

* Examining Properties::    Looking at the properties of one character.
* Changing Properties::	    Setting the properties of a range of text.
* Property Search::	    Searching for where a property changes value.
* Special Properties::	    Particular properties with special meanings.
* Format Properties::       Properties for representing formatting of text.
* Sticky Properties::       How inserted text gets properties from
                              neighboring text.
* Lazy Properties::         Computing text properties in a lazy fashion
                              only when text is examined.
* Clickable Text::          Using text properties to make regions of text
                              do something when you click on them.
* Fields::                  The @code{field} property defines
                              fields within the buffer.
* Not Intervals::	    Why text properties do not use
			      Lisp-visible text intervals.

Glenn Morris's avatar
Glenn Morris committed
1124
Non-@acronym{ASCII} Characters
1125

Glenn Morris's avatar
Glenn Morris committed
1126
* Text Representations::    How Emacs represents text.
1127 1128 1129 1130
* Converting Representations::  Converting unibyte to multibyte and vice versa.
* Selecting a Representation::  Treating a byte sequence as unibyte or multi.
* Character Codes::         How unibyte and multibyte relate to
                                codes of individual characters.
1131 1132
* Character Properties::    Character attributes that define their
                                behavior and handling.
1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155
* Character Sets::          The space of possible character codes
                                is divided into various character sets.
* Scanning Charsets::       Which character sets are used in a buffer?
* Translation of Characters::   Translation tables are used for conversion.
* Coding Systems::          Coding systems are conversions for saving files.
* Input Methods::           Input methods allow users to enter various
                                non-ASCII characters without special keyboards.
* Locales::                 Interacting with the POSIX locale.

Coding Systems

* Coding System Basics::    Basic concepts.
* Encoding and I/O::        How file I/O functions handle coding systems.
* Lisp and Coding Systems:: Functions to operate on coding system names.
* User-Chosen Coding Systems::  Asking the user to choose a coding system.
* Default Coding Systems::  Controlling the default choices.
* Specifying Coding Systems::   Requesting a particular coding system
                                    for a single file operation.
* Explicit Encoding::       Encoding or decoding text without doing I/O.
* Terminal I/O Encoding::   Use of encoding for terminal I/O.
* MS-DOS File Types::       How DOS "text" and "binary" files
                                relate to coding systems.

1156 1157 1158
Searching and Matching

* String Search::           Search for an exact match.
1159
* Searching and Case::      Case-independent or case-significant searching.
1160 1161
* Regular Expressions::     Describing classes of strings.
* Regexp Search::           Searching for a match for a regexp.
1162 1163 1164 1165
* POSIX Regexps::           Searching POSIX-style for the longest match.
* Match Data::              Finding out which part of the text matched,
                              after a string or regexp search.
* Search and Replace::	    Commands that loop, searching and replacing.
1166 1167 1168 1169 1170 1171
* Standard Regexps::        Useful regexps for finding sentences, pages,...

Regular Expressions

* Syntax of Regexps::       Rules for writing regular expressions.
* Regexp Example::          Illustrates regular expression syntax.
1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186
* Regexp Functions::        Functions for operating on regular expressions.

Syntax of Regular Expressions

* Regexp Special::          Special characters in regular expressions.
* Char Classes::            Character classes used in regular expressions.
* Regexp Backslash::        Backslash-sequences in regular expressions.

The Match Data

* Replacing Match::	    Replacing a substring that was matched.
* Simple Match Data::       Accessing single items of match data,
			      such as where a particular subexpression started.
* Entire Match Data::       Accessing the entire match data at once, as a list.
* Saving Match Data::       Saving and restoring the match data.
1187 1188 1189

Syntax Tables

1190
* Syntax Basics::           Basic concepts of syntax tables.
1191 1192
* Syntax Descriptors::      How characters are classified.
* Syntax Table Functions::  How to create, examine and alter syntax tables.
1193 1194
* Syntax Properties::       Overriding syntax with text properties.
* Motion and Syntax::	    Moving over characters with certain syntaxes.
1195 1196 1197 1198
* Parsing Expressions::     Parsing balanced expressions
                              using the syntax table.
* Standard Syntax Tables::  Syntax tables used by various major modes.
* Syntax Table Internals::  How syntax table information is stored.
1199
* Categories::              Another way of classifying character syntax.
1200 1201 1202 1203 1204 1205

Syntax Descriptors

* Syntax Class Table::      Table of syntax classes.
* Syntax Flags::            Additional flags each character can have.

1206 1207 1208 1209 1210 1211 1212 1213
Parsing Expressions

* Motion via Parsing::      Motion functions that work by parsing.
* Position Parse::          Determining the syntactic state of a position.
* Parser State::            How Emacs represents a syntactic state.
* Low-Level Parsing::       Parsing across a specified region.
* Control Parsing::         Parameters that affect parsing.

Glenn Morris's avatar
Glenn Morris committed
1214
Abbrevs and Abbrev Expansion
1215 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 1220
* Abbrev Files::            Saving abbrevs in files.
* Abbrev Expansion::        Controlling expansion; expansion subroutines.
1221
* Standard Abbrev Tables::  Abbrev tables used by various major modes.
Glenn Morris's avatar
Glenn Morris committed
1222 1223 1224 1225
* Abbrev Properties::       How to read and set abbrev properties.
                            Which properties have which effect.
* Abbrev Table Properties:: How to read and set abbrev table properties.
                            Which properties have which effect.
1226 1227 1228 1229

Processes

* Subprocess Creation::     Functions that start subprocesses.
1230
* Shell Arguments::         Quoting an argument to pass it to a shell.
1231 1232 1233 1234 1235 1236 1237 1238 1239
* Synchronous Processes::   Details of using synchronous subprocesses.
* Asynchronous Processes::  Starting up an asynchronous subprocess.
* Deleting Processes::      Eliminating an asynchronous subprocess.
* Process Information::     Accessing run-status and other attributes.
* Input to Processes::      Sending input to an asynchronous subprocess.
* Signals to Processes::    Stopping, continuing or interrupting
                              an asynchronous subprocess.
* Output from Processes::   Collecting output from an asynchronous subprocess.
* 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 1245 1246 1247
* Network Servers::         Network servers let Emacs accept net connections.
* Datagrams::               UDP network connections.
* Low-Level Network::       Lower-level but more general function
                              to create connections and servers.
Glenn Morris's avatar
Glenn Morris committed
1248 1249
* Misc Network::            Additional relevant functions for
                              network connections.
1250
* Serial Ports::            Communicating with serial ports.
1251
* Byte Packing::            Using bindat to pack and unpack binary data.
1252 1253 1254 1255 1256

Receiving Output from Processes

* Process Buffers::         If no filter, output is put in a buffer.
* Filter Functions::        Filter functions accept output from the process.
1257
* Decoding Output::         Filters can get unibyte or multibyte strings.
1258 1259
* Accepting Output::        How to wait until process output arrives.

1260 1261
Low-Level Network Access

Glenn Morris's avatar
Glenn Morris committed
1262 1263 1264
* Network Processes::       Using @code{make-network-process}.
* Network Options::         Further control over network connections.
* Network Feature Testing:: Determining which network features work on