elisp.texi 72.4 KB
Newer Older
Glenn Morris's avatar
Glenn Morris committed
1 2
\input texinfo  @c -*-texinfo-*-
@c %**start of header
3
@setfilename ../../info/elisp.info
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18

@ifset VOL1
@set volflag
@set voltitle Volume 1
@end ifset

@ifset VOL2
@set volflag
@set voltitle Volume 2
@end ifset

@ifset volflag
@settitle GNU Emacs Lisp Reference Manual: @value{voltitle}
@end ifset
@ifclear volflag
Glenn Morris's avatar
Glenn Morris committed
19
@settitle GNU Emacs Lisp Reference Manual
20 21
@end ifclear

Glenn Morris's avatar
Glenn Morris committed
22 23
@c %**end of header

24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54
@c See two-volume-cross-refs.txt.
@tex
@ifset VOL1
\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.
\global\chapno=0
@end ifset
@ifset VOL2
\message{Formatting for two volume edition...Volume 2...}
%
% Read special toc file, set up in two-volume.make.
\gdef\tocreadfilename{elisp2-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 2 chapter numbering at 27; this must be listed as chapno26
\global\chapno=26
@end ifset
@end tex


Glenn Morris's avatar
Glenn Morris committed
55
@c Version of the manual and of Emacs.
56
@c (See comments for EDITION in emacs.texi)
Glenn Morris's avatar
Glenn Morris committed
57
@set VERSION  3.1
58
@include emacsver.texi
59
@set DATE October 2014
Glenn Morris's avatar
Glenn Morris committed
60 61 62 63

@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.
64
@c @set smallbook
Glenn Morris's avatar
Glenn Morris committed
65

66 67 68 69
@ifset volflag
@smallbook
@end ifset

Glenn Morris's avatar
Glenn Morris committed
70 71 72 73 74
@ifset smallbook
@smallbook
@end ifset

@c per rms and peterb, use 10pt fonts for the main text, mostly to
75
@c save on paper cost.
Glenn Morris's avatar
Glenn Morris committed
76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92
@c Do this inside @tex for now, so current makeinfo does not complain.
@tex
@ifset smallbook
@fonttextsize 10
@end ifset
\global\hbadness=6666 % don't worry about not-too-underfull boxes
@end tex

@c Combine indices.
@synindex cp fn
@syncodeindex vr fn
@syncodeindex ky fn
@syncodeindex pg fn
@c We use the "type index" to index new functions and variables.
@c @syncodeindex tp fn

@copying
93 94 95 96 97 98
@iftex
This is edition @value{VERSION} of the @cite{GNU Emacs Lisp Reference Manual},@*
@end iftex
@ifnottex
This is the @cite{GNU Emacs Lisp Reference Manual}
@end ifnottex
Glenn Morris's avatar
Glenn Morris committed
99 100
corresponding to Emacs version @value{EMACSVER}.

Paul Eggert's avatar
Paul Eggert committed
101
Copyright @copyright{} 1990--1996, 1998--2014 Free Software Foundation, Inc.
Glenn Morris's avatar
Glenn Morris committed
102 103 104

@quotation
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
Glenn Morris's avatar
Glenn Morris committed
106 107
any later version published by the Free Software Foundation; with the
Invariant Sections being ``GNU General Public License,'' with the
108
Front-Cover Texts being ``A GNU Manual,'' and with the Back-Cover
Glenn Morris's avatar
Glenn Morris committed
109 110 111
Texts as in (a) below.  A copy of the license is included in the
section entitled ``GNU Free Documentation License.''

112 113
(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
Glenn Morris's avatar
Glenn Morris committed
114 115 116 117
developing GNU and promoting software freedom.''
@end quotation
@end copying

Paul Eggert's avatar
Paul Eggert committed
118
@documentencoding UTF-8
119

120
@dircategory Emacs lisp
121
@direntry
122
* Elisp: (elisp).               The Emacs Lisp Reference Manual.
123 124
@end direntry

Glenn Morris's avatar
Glenn Morris committed
125 126
@titlepage
@title GNU Emacs Lisp Reference Manual
127 128 129
@ifset volflag
@subtitle @value{voltitle}
@end ifset
Glenn Morris's avatar
Glenn Morris committed
130
@subtitle For Emacs Version @value{EMACSVER}
131
@subtitle Revision @value{VERSION}, @value{DATE}
Glenn Morris's avatar
Glenn Morris committed
132

133 134
@author by Bil Lewis, Dan LaLiberte, Richard Stallman,
@author the GNU Manual Group, et al.
Glenn Morris's avatar
Glenn Morris committed
135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156
@page
@vskip 0pt plus 1filll
@insertcopying

@sp 2
Published by the Free Software Foundation @*
51 Franklin St, Fifth Floor @*
Boston, MA 02110-1301 @*
USA @*
ISBN 1-882114-74-4

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


@c Print the tables of contents
@summarycontents
@contents


@ifnottex
157
@node Top
Glenn Morris's avatar
Glenn Morris committed
158 159
@top Emacs Lisp

Glenn Morris's avatar
Glenn Morris committed
160 161 162 163 164 165 166 167 168 169 170
@ifset WWW_GNU_ORG
@html
<p>The homepage for GNU Emacs is at
<a href="/software/emacs/">http://www.gnu.org/software/emacs/</a>.<br>
For information on using Emacs, refer to the
<a href="/software/emacs/manual/emacs.html">Emacs Manual</a>.<br>
To view this manual in other formats, click
<a href="/software/emacs/manual/elisp.html">here</a>.
@end html
@end ifset

171
@insertcopying
Glenn Morris's avatar
Glenn Morris committed
172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192
@end ifnottex

@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.
* Hash Tables::             Very fast lookup-tables.
* 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.
193
* Customization::           Making variables and faces customizable.
Glenn Morris's avatar
Glenn Morris committed
194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211

* Loading::                 Reading files of Lisp code into Lisp.
* Byte Compilation::        Compilation makes programs run faster.
* 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.
Glenn Morris's avatar
Glenn Morris committed
212
* Frames::                  Making multiple system-level windows.
Glenn Morris's avatar
Glenn Morris committed
213 214 215 216 217 218 219 220 221 222 223
* 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.
* Non-ASCII Characters::    Non-ASCII text in buffers and strings.
* 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.
Glenn Morris's avatar
Glenn Morris committed
224
* Display::                 Features for controlling the screen display.
Glenn Morris's avatar
Glenn Morris committed
225 226 227
* System Interface::        Getting the user id, system type, environment
                              variables, and other such things.

Tom Tromey's avatar
Tom Tromey committed
228 229
* Packaging::               Preparing Lisp code for distribution.

Glenn Morris's avatar
Glenn Morris committed
230 231
Appendices

232
* Antinews::                Info for users downgrading to Emacs 23.
Glenn Morris's avatar
Glenn Morris committed
233
* GNU Free Documentation License:: The license for this documentation.
Glenn Morris's avatar
Glenn Morris committed
234 235 236 237
* GPL::                     Conditions for copying and changing GNU Emacs.
* Tips::                    Advice and coding conventions for Emacs Lisp.
* GNU Emacs Internals::     Building and dumping Emacs;
                              internal data structures.
238 239 240
* Standard Errors::         List of some standard error symbols.
* Standard Keymaps::        List of some standard keymaps.
* Standard Hooks::          List of some standard hook variables.
Glenn Morris's avatar
Glenn Morris committed
241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257

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

@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 ---
 ---------------------------------

258
Here are other nodes that are subnodes of those already listed,
Glenn Morris's avatar
Glenn Morris committed
259 260 261 262 263 264 265 266
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.
* Version Info::            Which Emacs version is running?
267
* Acknowledgments::         The authors, editors, and sponsors of this manual.
Glenn Morris's avatar
Glenn Morris committed
268 269 270 271 272 273

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
274
* Printing Notation::       The format we use when examples print text.
Glenn Morris's avatar
Glenn Morris committed
275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291
* 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

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

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.
292
* Circular Objects::        Read syntax for circular structure.
Glenn Morris's avatar
Glenn Morris committed
293 294 295 296 297 298
* Type Predicates::         Tests related to types.
* Equality Predicates::     Tests of equality between any two objects.

Programming Types

* Integer Type::        Numbers without fractional parts.
299
* Floating-Point Type:: Numbers with fractional parts and with a large range.
Glenn Morris's avatar
Glenn Morris committed
300 301 302
* Character Type::      The representation of letters, numbers and
                          control characters.
* Symbol Type::         A multi-use object that refers to a function,
Glenn Morris's avatar
Glenn Morris committed
303
                        variable, or property list, and has a unique identity.
Glenn Morris's avatar
Glenn Morris committed
304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330
* 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.
* 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.
* 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
                          functions.

Character Type

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

Cons Cell and List Types

* Box Diagrams::            Drawing pictures of lists.
Glenn Morris's avatar
Glenn Morris committed
331
* Dotted Pair Notation::    A general syntax for cons cells.
Glenn Morris's avatar
Glenn Morris committed
332 333 334 335 336 337 338 339 340 341 342 343 344
* Association List Type::   A specially constructed list.

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.

Editing Types

* Buffer Type::             The basic object of editing.
* Marker Type::             A position in a buffer.
Glenn Morris's avatar
Glenn Morris committed
345
* Window Type::             Buffers are displayed in windows.
346 347
* Frame Type::              Windows subdivide frames.
* Terminal Type::           A terminal device displays frames.
Glenn Morris's avatar
Glenn Morris committed
348 349
* Window Configuration Type::  Recording the way a frame is subdivided.
* Frame Configuration Type::   Recording the status of all frames.
350
* Process Type::            A subprocess of Emacs running on the underlying OS.
Glenn Morris's avatar
Glenn Morris committed
351 352 353
* Stream Type::             Receive or send characters.
* Keymap Type::             What function a keystroke invokes.
* Overlay Type::            How an overlay is represented.
Chong Yidong's avatar
Chong Yidong committed
354
* Font Type::               Fonts for displaying text.
Glenn Morris's avatar
Glenn Morris committed
355 356 357 358

Numbers

* Integer Basics::          Representation and range of integers.
Glenn Morris's avatar
Glenn Morris committed
359
* Float Basics::            Representation and range of floating point.
Glenn Morris's avatar
Glenn Morris committed
360 361
* Predicates on Numbers::   Testing for numbers.
* Comparison of Numbers::   Equality and inequality predicates.
Glenn Morris's avatar
Glenn Morris committed
362
* Numeric Conversions::     Converting float to integer and vice versa.
Glenn Morris's avatar
Glenn Morris committed
363
* Arithmetic Operations::   How to add, subtract, multiply and divide.
364
* Rounding Operations::     Explicitly rounding floating-point numbers.
Glenn Morris's avatar
Glenn Morris committed
365 366 367 368 369 370 371 372 373
* Bitwise Operations::      Logical and, or, not, shifting.
* Math Functions::          Trig, exponential and logarithmic functions.
* Random Numbers::          Obtaining random integers, predictable or not.

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.
374
* Modifying Strings::       Altering the contents of an existing string.
Glenn Morris's avatar
Glenn Morris committed
375
* Text Comparison::         Comparing characters or strings.
Glenn Morris's avatar
Glenn Morris committed
376
* String Conversion::       Converting to and from characters and strings.
Glenn Morris's avatar
Glenn Morris committed
377 378
* Formatting Strings::      @code{format}: Emacs's analogue of @code{printf}.
* Case Conversion::         Case conversion functions.
Glenn Morris's avatar
Glenn Morris committed
379
* Case Tables::             Customizing case conversion.
Glenn Morris's avatar
Glenn Morris committed
380 381 382 383 384 385 386 387 388 389 390

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.
* List Variables::          Modifying lists stored in variables.
* 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.
391
* Property Lists::          A list of paired elements.
Glenn Morris's avatar
Glenn Morris committed
392 393 394 395 396 397 398 399

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.

400 401 402 403 404 405
Property Lists

* Plists and Alists::       Comparison of the advantages of property
                              lists and association lists.
* Plist Access::            Accessing property lists stored elsewhere.

Glenn Morris's avatar
Glenn Morris committed
406 407 408 409 410 411 412 413 414
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.
* 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.
415
* Rings::                   Managing a fixed-size ring of objects.
Glenn Morris's avatar
Glenn Morris committed
416 417 418 419 420

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
421
* Defining Hash::           Defining new comparison methods.
Glenn Morris's avatar
Glenn Morris committed
422 423 424 425 426 427 428 429
* Other Hash::              Miscellaneous.

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.
430
* Symbol Properties::       Each symbol has a property list
Glenn Morris's avatar
Glenn Morris committed
431 432
                              for recording miscellaneous information.

433
Symbol Properties
Glenn Morris's avatar
Glenn Morris committed
434

435 436
* Symbol Plists::           Accessing symbol properties.
* Standard Properties::     Standard meanings of symbol properties.
Glenn Morris's avatar
Glenn Morris committed
437 438 439 440 441 442 443

Evaluation

* Intro Eval::              Evaluation in the scheme of things.
* Forms::                   How various sorts of objects are evaluated.
* Quoting::                 Avoiding evaluation (to put constants in
                              the program).
444
* Backquote::               Easier construction of list structure.
Glenn Morris's avatar
Glenn Morris committed
445 446 447 448 449 450 451 452
* Eval::                    How to invoke the Lisp interpreter explicitly.

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.
* Function Indirection::    When a symbol appears as the car of a list,
Glenn Morris's avatar
Glenn Morris committed
453
                              we find the real function via the symbol.
Glenn Morris's avatar
Glenn Morris committed
454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498
* Function Forms::          Forms that call functions.
* Macro Forms::             Forms that call macros.
* Special Forms::           "Special forms" are idiosyncratic primitives,
                              most of them extremely important.
* Autoloading::             Functions set up to load files
                              containing their real definitions.

Control Structures

* Sequencing::              Evaluation in textual order.
* Conditionals::            @code{if}, @code{cond}, @code{when}, @code{unless}.
* 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.
* Tips for Defining::       Things you should think about when you
                              define a variable.
* 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.
* File Local Variables::    Handling local variable lists in files.
Glenn Morris's avatar
Glenn Morris committed
499 500
* Directory Local Variables:: Local variables common to all files in a
                                directory.
Glenn Morris's avatar
Glenn Morris committed
501 502 503
* 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.
504
* Generalized Variables::   Extending the concept of variables.
Glenn Morris's avatar
Glenn Morris committed
505 506 507

Scoping Rules for Variable Bindings

508 509 510 511
* Dynamic Binding::         The default for binding local variables in Emacs.
* Dynamic Binding Tips::    Avoiding problems with dynamic binding.
* Lexical Binding::         A different type of local variable binding.
* Using Lexical Binding::   How to enable lexical binding.
Glenn Morris's avatar
Glenn Morris committed
512 513 514 515 516 517 518 519

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
                              that don't have their own buffer-local values.

520 521 522 523 524
Generalized Variables

* Setting Generalized Variables::   The @code{setf} macro.
* Adding Generalized Variables::    Defining new @code{setf} forms.

Glenn Morris's avatar
Glenn Morris committed
525 526
Functions

Glenn Morris's avatar
Glenn Morris committed
527
* What Is a Function::      Lisp functions vs. primitives; terminology.
Glenn Morris's avatar
Glenn Morris committed
528 529 530 531 532
* 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
533
* Anonymous Functions::     Lambda expressions are functions with no names.
Glenn Morris's avatar
Glenn Morris committed
534 535
* Function Cells::          Accessing or setting the function definition
                              of a symbol.
536
* Closures::                Functions that enclose a lexical environment.
Glenn Morris's avatar
Glenn Morris committed
537
* Obsolete Functions::      Declaring functions obsolete.
Glenn Morris's avatar
Glenn Morris committed
538
* Inline Functions::        Defining functions that the compiler
Glenn Morris's avatar
Glenn Morris committed
539
                              will expand inline.
540
* Declare Form::          Adding additional information about a function.
Glenn Morris's avatar
Glenn Morris committed
541
* Declaring Functions::     Telling the compiler that a function is defined.
Glenn Morris's avatar
Glenn Morris committed
542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572
* Function Safety::         Determining whether a function is safe to call.
* Related Topics::          Cross-references to specific Lisp primitives
                              that have a special bearing on how
                              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.
* Problems with Macros::    Don't evaluate the macro arguments too many times.
                              Don't hide the user's variables.
* 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.

Glenn Morris's avatar
Glenn Morris committed
573
Customization Settings
Glenn Morris's avatar
Glenn Morris committed
574 575 576 577 578 579

* 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.
580 581
* Applying Customizations:: Functions to apply customization settings.
* Custom Themes::           Writing Custom themes.
Glenn Morris's avatar
Glenn Morris committed
582 583 584

Customization Types

585
* Simple Types::            Simple customization types: sexp, integer, etc.
Glenn Morris's avatar
Glenn Morris committed
586 587 588 589 590 591 592 593 594 595 596 597 598 599 600
* 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.

Loading

* How Programs Do Loading:: The @code{load} function and others.
* 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.
* Autoload::                Setting up a function to autoload.
* Repeated Loading::        Precautions about loading a file twice.
* Named Features::          Loading a library if it isn't already loaded.
* Where Defined::           Finding which file defined a certain symbol.
Glenn Morris's avatar
Glenn Morris committed
601 602 603
* Unloading::               How to "unload" a library that was loaded.
* Hooks for Loading::       Providing code to be run when
                              particular libraries are loaded.
Glenn Morris's avatar
Glenn Morris committed
604 605 606 607 608 609 610 611 612

Byte Compilation

* Speed of Byte-Code::      An example of speedup from byte compilation.
* Compilation Functions::   Byte compilation functions.
* 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.
Glenn Morris's avatar
Glenn Morris committed
613
* Byte-Code Objects::       The data type used for byte-compiled functions.
Glenn Morris's avatar
Glenn Morris committed
614 615 616 617
* Disassembly::             Disassembling byte-code; how to read byte-code.

Debugging Lisp Programs

618
* Debugger::                A debugger for the Emacs Lisp evaluator.
Glenn Morris's avatar
Glenn Morris committed
619 620 621
* Edebug::                  A source-level Emacs Lisp debugger.
* Syntax Errors::           How to find syntax errors.
* Test Coverage::           Ensuring you have tested all branches in your code.
622
* Profiling::               Measuring the resources that your code uses.
Glenn Morris's avatar
Glenn Morris committed
623 624 625 626

The Lisp Debugger

* Error Debugging::         Entering the debugger when an error happens.
Glenn Morris's avatar
Glenn Morris committed
627
* Infinite Loops::          Stopping and debugging a program that doesn't exit.
Glenn Morris's avatar
Glenn Morris committed
628 629 630 631 632 633 634 635 636
* 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.

Edebug

Glenn Morris's avatar
Glenn Morris committed
637 638 639
* Using Edebug::            Introduction to use of Edebug.
* Instrumenting::           You must instrument your code
                              in order to debug it with Edebug.
Glenn Morris's avatar
Glenn Morris committed
640
* Edebug Execution Modes::  Execution modes, stopping more or less often.
Glenn Morris's avatar
Glenn Morris committed
641 642 643 644 645 646 647 648 649 650 651 652
* 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.
Glenn Morris's avatar
Glenn Morris committed
653
* Edebug and Macros::       Specifying how to handle macro calls.
Glenn Morris's avatar
Glenn Morris committed
654
* Edebug Options::          Option variables for customizing Edebug.
Glenn Morris's avatar
Glenn Morris committed
655

Glenn Morris's avatar
Glenn Morris committed
656 657 658 659 660 661 662 663 664 665 666 667 668 669 670
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.
Glenn Morris's avatar
Glenn Morris committed
671 672
* Specification List::      How to specify complex patterns of evaluation.
* Backtracking::            What Edebug does when matching fails.
Glenn Morris's avatar
Glenn Morris committed
673 674
* Specification Examples::  To help understand specifications.

Glenn Morris's avatar
Glenn Morris committed
675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696
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.
* Input Streams::           Various data types that can be used as
                              input streams.
* Input Functions::         Functions to read Lisp objects from text.
* Output Streams::          Various data types that can be used as
                              output streams.
* Output Functions::        Functions to print Lisp objects as text.
* Output Variables::        Variables that control what the printing
                              functions do.

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.
Glenn Morris's avatar
Glenn Morris committed
697 698
* Minibuffer History::      Recording previous minibuffer inputs
                              so the user can reuse them.
Glenn Morris's avatar
Glenn Morris committed
699 700 701
* Initial Input::           Specifying initial contents for the minibuffer.
* Completion::              How to invoke and customize completion.
* Yes-or-No Queries::       Asking a question with a simple answer.
Glenn Morris's avatar
Glenn Morris committed
702 703
* Multiple Queries::        Asking a series of similar questions.
* Reading a Password::      Reading a password from the terminal.
Glenn Morris's avatar
Glenn Morris committed
704 705
* Minibuffer Commands::     Commands used as key bindings in minibuffers.
* Minibuffer Windows::      Operating on the special minibuffer windows.
706
* Minibuffer Contents::     How such commands access the minibuffer text.
Glenn Morris's avatar
Glenn Morris committed
707 708 709 710 711 712 713 714 715
* Recursive Mini::          Whether recursive entry to minibuffer is allowed.
* Minibuffer Misc::         Various customization hooks and variables.

Completion

* Basic Completion::        Low-level functions for completing strings.
* Minibuffer Completion::   Invoking the minibuffer with completion.
* Completion Commands::     Minibuffer commands that do completion.
* High-Level Completion::   Convenient special cases of completion
716
                              (reading buffer names, variable names, etc.).
717 718
* Reading File Names::      Using completion to read file names and
                              shell commands.
719 720
* Completion Variables::    Variables controlling completion behavior.
* Programmed Completion::   Writing your own completion function.
721
* Completion in Buffers::   Completing text in ordinary buffers.
Glenn Morris's avatar
Glenn Morris committed
722 723 724 725 726 727

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.
728
* Distinguish Interactive::     Making a command distinguish interactive calls.
Glenn Morris's avatar
Glenn Morris committed
729 730
* Command Loop Info::   Variables set by the command loop for you to examine.
* Adjusting Point::     Adjustment of point after a command.
Glenn Morris's avatar
Glenn Morris committed
731
* Input Events::        What input looks like when you read it.
Glenn Morris's avatar
Glenn Morris committed
732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748
* Reading Input::       How to read input events from the keyboard or mouse.
* Special Events::      Events processed immediately and individually.
* 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.
Xue Fuqiao's avatar
Xue Fuqiao committed
749 750
* Generic Commands::        Select among command alternatives.

Glenn Morris's avatar
Glenn Morris committed
751 752 753 754 755 756 757 758 759 760 761 762 763 764 765

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
766
                              Event types.
Glenn Morris's avatar
Glenn Morris committed
767
* Accessing Mouse::         Functions to extract info from mouse events.
768
* Accessing Scroll::        Functions to get info from scroll bar events.
Glenn Morris's avatar
Glenn Morris committed
769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795
* 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.

Keymaps

* 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
796
* Key Lookup::              Finding a key's binding in one keymap.
Glenn Morris's avatar
Glenn Morris committed
797 798 799 800 801 802
* Functions for Key Lookup::    How to request key lookup.
* 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
803
* Menu Keymaps::            Defining a menu as a keymap.
Glenn Morris's avatar
Glenn Morris committed
804 805 806 807 808 809 810 811 812 813

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.
814
* Easy Menu::               A convenience macro for defining menus.
Glenn Morris's avatar
Glenn Morris committed
815 816 817

Defining Menus

818 819
* Simple Menu Items::       A simple kind of menu key binding.
* Extended Menu Items::     More complex menu item definitions.
Glenn Morris's avatar
Glenn Morris committed
820 821 822 823 824 825 826 827 828
* 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.
829
* Imenu::              Providing a menu of definitions made in a buffer.
Glenn Morris's avatar
Glenn Morris committed
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.
Glenn Morris's avatar
Glenn Morris committed
832 833 834
* Desktop Save Mode::  How modes can have buffer state saved between
                         Emacs sessions.

Glenn Morris's avatar
Glenn Morris committed
835 836 837 838 839
Hooks

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

Glenn Morris's avatar
Glenn Morris committed
840 841 842 843 844 845 846
Major Modes

* 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.
* Derived Modes::           Defining a new major mode based on another major
                              mode.
847
* Basic Major Modes::       Modes that other modes are often derived from.
848 849
* Mode Hooks::              Hooks run at the end of major mode functions.
* Tabulated List Mode::     Parent mode for buffers containing tabulated data.
Glenn Morris's avatar
Glenn Morris committed
850 851
* Generic Modes::           Defining a simple major mode that supports
                              comment syntax and Font Lock mode.
Glenn Morris's avatar
Glenn Morris committed
852
* Example Major Modes::     Text mode and Lisp modes.
Glenn Morris's avatar
Glenn Morris committed
853 854 855 856 857 858 859 860 861

Minor Modes

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

Mode Line Format

Glenn Morris's avatar
Glenn Morris committed
862
* Mode Line Basics::        Basic ideas of mode line control.
Glenn Morris's avatar
Glenn Morris committed
863
* Mode Line Data::          The data structure that controls the mode line.
Glenn Morris's avatar
Glenn Morris committed
864
* Mode Line Top::           The top level variable, mode-line-format.
Glenn Morris's avatar
Glenn Morris committed
865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887
* Mode Line Variables::     Variables used in that data structure.
* %-Constructs::            Putting information into a mode line.
* 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.
* Multiline Font Lock::     How to coerce Font Lock into properly
                              highlighting multiline constructs.

Multiline Font Lock Constructs

Glenn Morris's avatar
Glenn Morris committed
888
* Font Lock Multiline::     Marking multiline chunks with a text property.
889
* Region to Refontify::     Controlling which region gets refontified
Glenn Morris's avatar
Glenn Morris committed
890 891
                              after a buffer change.

Glenn Morris's avatar
Glenn Morris committed
892 893 894 895 896 897 898 899 900 901 902 903 904 905
Automatic Indentation of code

* SMIE::                    A simple minded indentation engine.

Simple Minded Indentation Engine

* SMIE setup::              SMIE setup and features.
* Operator Precedence Grammars:: A very simple parsing technique.
* SMIE Grammar::            Defining the grammar of a language.
* SMIE Lexer::              Defining tokens.
* SMIE Tricks::             Working around the parser's limitations.
* SMIE Indentation::        Specifying indentation rules.
* SMIE Indentation Helpers:: Helper functions for indentation rules.
* SMIE Indentation Example:: Sample indentation rules.
906
* SMIE Customization::      Customizing indentation.
Glenn Morris's avatar
Glenn Morris committed
907

Glenn Morris's avatar
Glenn Morris committed
908 909
Documentation

910
* Documentation Basics::    Where doc strings are defined and stored.
Glenn Morris's avatar
Glenn Morris committed
911 912 913 914 915 916 917 918 919 920
* 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
921
* Reading from Files::      Reading files into buffers without visiting.
Glenn Morris's avatar
Glenn Morris committed
922 923 924 925
* Writing to Files::        Writing new files from parts of buffers.
* File Locks::              Locking and unlocking files, to prevent
                              simultaneous editing by two people.
* Information about Files:: Testing existence, accessibility, size of files.
926
* Changing Files::          Renaming files, changing permissions, etc.
Glenn Morris's avatar
Glenn Morris committed
927 928
* File Names::              Decomposing and expanding file names.
* Contents of Directories:: Getting a list of the files in a directory.
Glenn Morris's avatar
Glenn Morris committed
929
* Create/Delete Dirs::      Creating and Deleting Directories.
930
* Magic File Names::        Special handling for certain file names.
Glenn Morris's avatar
Glenn Morris committed
931 932 933 934 935 936 937 938 939 940 941
* Format Conversion::       Conversion to and from various file formats.

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?
* Kinds of Files::          Is it a directory?  A symbolic link?
Glenn Morris's avatar
Glenn Morris committed
942
* Truenames::               Eliminating symbolic links from a file name.
Chong Yidong's avatar
Chong Yidong committed
943 944
* File Attributes::         File sizes, modification times, etc.
* Extended Attributes::     Extended file attributes for access control.
Glenn Morris's avatar
Glenn Morris committed
945 946 947 948 949
* Locating Files::          How to find a file in standard places.

File Names

* File Name Components::    The directory part of a file name, and the rest.
Glenn Morris's avatar
Glenn Morris committed
950
* Relative File Names::     Some file names are relative to a current directory.
Glenn Morris's avatar
Glenn Morris committed
951 952 953 954 955 956 957 958
* Directory Names::         A directory's name as a directory
                              is different from its name as a file.
* 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.
* Standard File Names::     If your package uses a fixed file name,
                              how to handle various operating systems simply.

Glenn Morris's avatar
Glenn Morris committed
959 960
File Format Conversion

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

Glenn Morris's avatar
Glenn Morris committed
965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985
Backups and Auto-Saving

* Backup Files::            How backup files are made; how their names
                              are chosen.
* Auto-Saving::             How auto-save files are made; how their
                              names are chosen.
* Reverting::               @code{revert-buffer}, and how to customize
                              what it does.

Backup Files

* Making Backups::          How Emacs makes backup files, and when.
* Rename or Copy::          Two alternatives: renaming the old file
                              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?
* Current Buffer::          Designating a buffer as current
Glenn Morris's avatar
Glenn Morris committed
986
                              so that primitives will access its contents.
Glenn Morris's avatar
Glenn Morris committed
987 988 989 990 991
* 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
Glenn Morris's avatar
Glenn Morris committed
992
                              "behind Emacs's back".
Glenn Morris's avatar
Glenn Morris committed
993 994
* Read Only Buffers::       Modifying text is not allowed in a
                              read-only buffer.
995
* Buffer List::             How to look at all the existing buffers.
Glenn Morris's avatar
Glenn Morris committed
996 997 998 999
* Creating Buffers::        Functions that create buffers.
* Killing Buffers::         Buffers exist until explicitly killed.
* Indirect Buffers::        An indirect buffer shares text with some
                              other buffer.
1000
* Swapping Text::           Swapping text between two buffers.
Glenn Morris's avatar
Glenn Morris committed
1001 1002 1003 1004 1005
* Buffer Gap::              The gap in the buffer.

Windows

* Basic Windows::           Basic information on using windows.
1006 1007 1008
* Windows and Frames::      Relating windows to the frame they appear on.
* Window Sizes::            Accessing a window's size.
* Resizing Windows::        Changing the sizes of windows.
Glenn Morris's avatar
Glenn Morris committed
1009 1010
* Splitting Windows::       Splitting one window into two windows.
* Deleting Windows::        Deleting a window gives its space to other windows.
1011 1012
* Recombining Windows::     Preserving the frame layout when splitting and
                              deleting windows.
Glenn Morris's avatar
Glenn Morris committed
1013 1014 1015
* 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.
1016
* Switching Buffers::       Higher-level functions for switching to a buffer.
Glenn Morris's avatar
Glenn Morris committed
1017
* Choosing Window::         How to choose a window for displaying a buffer.
1018 1019
* Display Action Functions:: Subroutines for @code{display-buffer}.
* Choosing Window Options:: Extra options affecting how buffers are displayed.
1020
* Window History::          Each window remembers the buffers displayed in it.
Glenn Morris's avatar
Glenn Morris committed
1021
* Dedicated Windows::       How to avoid displaying another buffer in
1022
                              a specific window.
1023 1024
* Quitting Windows::        How to restore the state prior to displaying a
                              buffer.
Glenn Morris's avatar
Glenn Morris committed
1025
* Window Point::            Each window has its own location of point.
1026 1027
* Window Start and End::    Buffer positions indicating which text is
                              on-screen in a window.
Glenn Morris's avatar
Glenn Morris committed
1028 1029 1030 1031 1032
* 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.
* Coordinates and Windows:: Converting coordinates to windows.
* Window Configurations::   Saving and restoring the state of the screen.
1033
* Window Parameters::       Associating additional information with windows.
Glenn Morris's avatar
Glenn Morris committed
1034 1035 1036 1037 1038 1039
* Window Hooks::            Hooks for scrolling, window size changes,
                              redisplay going past a certain point,
                              or window configuration changes.

Frames

Glenn Morris's avatar
Glenn Morris committed
1040
* Creating Frames::         Creating additional frames.
1041
* Multiple Terminals::      Displaying on several different devices.
Glenn Morris's avatar
Glenn Morris committed
1042
* Frame Parameters::        Controlling frame size, position, font, etc.
1043
* Terminal Parameters::     Parameters common for all frames on terminal.
Glenn Morris's avatar
Glenn Morris committed
1044
* Frame Titles::            Automatic updating of frame titles.
Glenn Morris's avatar
Glenn Morris committed
1045 1046
* Deleting Frames::         Frames last until explicitly deleted.
* Finding All Frames::      How to examine all existing frames.
Glenn Morris's avatar
Glenn Morris committed
1047
* Minibuffers and Frames::  How a frame finds the minibuffer to use.
Glenn Morris's avatar
Glenn Morris committed
1048
* Input Focus::             Specifying the selected frame.
Glenn Morris's avatar
Glenn Morris committed
1049 1050
* Visibility of Frames::    Frames may be visible or invisible, or icons.
* Raising and Lowering::    Raising a frame makes it hide other windows;
Glenn Morris's avatar
Glenn Morris committed
1051
                              lowering it makes the others hide it.
Glenn Morris's avatar
Glenn Morris committed
1052
* Frame Configurations::    Saving the state of all frames.
Glenn Morris's avatar
Glenn Morris committed
1053 1054 1055
* 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.
Glenn Morris's avatar
Glenn Morris committed
1056 1057
* Dialog Boxes::            Displaying a box to ask yes or no.
* Pointer Shape::           Specifying the shape of the mouse pointer.
Glenn Morris's avatar
Glenn Morris committed
1058
* Window System Selections::Transferring text to and from other X clients.
Glenn Morris's avatar
Glenn Morris committed
1059
* Drag and Drop::               Internals of Drag-and-Drop implementation.
Glenn Morris's avatar
Glenn Morris committed
1060
* Color Names::             Getting the definitions of color names.
1061
* Text Terminal Colors::    Defining colors for text terminals.
Glenn Morris's avatar
Glenn Morris committed
1062
* Resources::               Getting resource values from the server.
Glenn Morris's avatar
Glenn Morris committed
1063 1064 1065 1066 1067
* Display Feature Testing:: Determining the features of a terminal.

Frame Parameters

* Parameter Access::        How to change a frame's parameters.
Glenn Morris's avatar
Glenn Morris committed
1068
* Initial Parameters::      Specifying frame parameters when you make a frame.
Glenn Morris's avatar
Glenn Morris committed
1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082
* 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
1083
* Font and Color Parameters:: Fonts and colors for the frame text.
Glenn Morris's avatar
Glenn Morris committed
1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106

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
1107
* Information from Markers::Finding the marker's buffer or character position.
Glenn Morris's avatar
Glenn Morris committed
1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126
* 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.
* The Mark::                How "the mark" is implemented with a marker.
* The Region::              How to access "the region".

Text

* Near Point::              Examining text in the vicinity of point.
* Buffer Contents::         Examining text in a general fashion.
* Comparing Text::          Comparing substrings of buffers.
* 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.
* Maintaining Undo::        How to enable and disable undo information.
Glenn Morris's avatar
Glenn Morris committed
1127
                              How to control how much information is kept.
Glenn Morris's avatar
Glenn Morris committed
1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140
* Filling::                 Functions for explicit filling.
* Margins::                 How to specify margins for filling commands.
* Adaptive Fill::           Adaptive Fill mode chooses a fill prefix
                              from context.
* Auto Filling::            How auto-fill mode is implemented to break lines.
* Sorting::                 Functions for sorting parts of the buffer.
* Columns::                 Computing horizontal positions, and using them.
* Indentation::             Functions to insert or adjust indentation.
* Case Changes::            Case conversion of parts of the buffer.
* Text Properties::         Assigning Lisp property lists to text characters.
* Substitution::            Replacing a given character wherever it appears.
* Registers::               How registers are implemented.  Accessing
                              the text or position stored in a register.
Chong Yidong's avatar
Chong Yidong committed
1141
* Transposition::           Swapping two portions of a buffer.
Glenn Morris's avatar
Glenn Morris committed
1142
* Decompression::           Dealing with compressed data.
Glenn Morris's avatar
Glenn Morris committed
1143
* Base 64::                 Conversion to or from base 64 encoding.
1144 1145
* Checksum/Hash::           Computing cryptographic hashes.
* Parsing HTML/XML::        Parsing HTML and XML.
Glenn Morris's avatar
Glenn Morris committed
1146 1147 1148 1149 1150 1151 1152 1153 1154
* Atomic Changes::          Installing several buffer changes "atomically".
* Change Hooks::            Supplying functions to be run when text is changed.

The Kill Ring

* Kill Ring Concepts::      What text looks like in the kill ring.
* Kill Functions::          Functions that kill text.
* Yanking::                 How yanking is done.
* Yank Commands::           Commands that access the kill ring.
Glenn Morris's avatar
Glenn Morris committed
1155
* Low-Level Kill Ring::     Functions and variables for kill ring access.
Glenn Morris's avatar
Glenn Morris committed
1156
* Internals of Kill Ring::  Variables that hold kill ring data.
Glenn Morris's avatar
Glenn Morris committed
1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169

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.

Text Properties

* Examining Properties::    Looking at the properties of one character.
Glenn Morris's avatar
Glenn Morris committed
1170 1171 1172
* 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.
Glenn Morris's avatar
Glenn Morris committed
1173 1174 1175 1176 1177 1178 1179 1180 1181
* 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.
Glenn Morris's avatar
Glenn Morris committed
1182 1183
* Not Intervals::           Why text properties do not use
                              Lisp-visible text intervals.
Glenn Morris's avatar
Glenn Morris committed
1184

Glenn Morris's avatar
Glenn Morris committed
1185
Non-@acronym{ASCII} Characters
Glenn Morris's avatar
Glenn Morris committed
1186

Glenn Morris's avatar
Glenn Morris committed
1187
* Text Representations::    How Emacs represents text.
Xue Fuqiao's avatar
Xue Fuqiao committed
1188
* Disabling Multibyte::     Controlling whether to use multibyte characters.
Glenn Morris's avatar
Glenn Morris committed
1189 1190 1191 1192
* 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.
1193 1194
* Character Properties::    Character attributes that define their
                                behavior and handling.
Glenn Morris's avatar
Glenn Morris committed
1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224
* 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.

Searching and Matching

* String Search::           Search for an exact match.
* Searching and Case::      Case-independent or case-significant searching.
* Regular Expressions::     Describing classes of strings.
* Regexp Search::           Searching for a match for a regexp.
* 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.
Glenn Morris's avatar
Glenn Morris committed
1225
* Search and Replace::      Commands that loop, searching and replacing.
Glenn Morris's avatar
Glenn Morris committed
1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241
* Standard Regexps::        Useful regexps for finding sentences, pages,...

Regular Expressions

* Syntax of Regexps::       Rules for writing regular expressions.
* Regexp Example::          Illustrates regular expression syntax.
* 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

Glenn Morris's avatar
Glenn Morris committed
1242
* Replacing Match::         Replacing a substring that was matched.
Glenn Morris's avatar
Glenn Morris committed
1243
* Simple Match Data::       Accessing single items of match data,
Glenn Morris's avatar
Glenn Morris committed
1244
                              such as where a particular subexpression started.
Glenn Morris's avatar
Glenn Morris committed
1245 1246 1247 1248 1249 1250 1251 1252 1253
* Entire Match Data::       Accessing the entire match data at once, as a list.
* Saving Match Data::       Saving and restoring the match data.

Syntax Tables

* Syntax Basics::           Basic concepts of syntax tables.
* Syntax Descriptors::      How characters are classified.
* Syntax Table Functions::  How to create, examine and alter syntax tables.
* Syntax Properties::       Overriding syntax with text properties.
Glenn Morris's avatar
Glenn Morris committed
1254
* Motion and Syntax::       Moving over characters with certain syntaxes.
Glenn Morris's avatar
Glenn Morris committed
1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272
* Parsing Expressions::     Parsing balanced expressions
                              using the syntax table.
* Syntax Table Internals::  How syntax table information is stored.
* Categories::              Another way of classifying character syntax.

Syntax Descriptors

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

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
1273
Abbrevs and Abbrev Expansion
Glenn Morris's avatar
Glenn Morris committed
1274 1275 1276 1277 1278 1279

* Abbrev Tables::           Creating and working with abbrev tables.
* Defining Abbrevs::        Specifying abbreviations and their expansions.
* Abbrev Files::            Saving abbrevs in files.
* Abbrev Expansion::        Controlling expansion; expansion subroutines.
* Standard Abbrev Tables::  Abbrev tables used by various major modes.
Glenn Morris's avatar
Glenn Morris committed
1280 1281 1282 1283
* 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.
Glenn Morris's avatar
Glenn Morris committed
1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298

Processes

* Subprocess Creation::     Functions that start subprocesses.
* Shell Arguments::         Quoting an argument to pass it to a shell.
* 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.
* Query Before Exit::       Whether to query if exiting will kill a process.
1299
* System Processes::        Accessing other processes running on your system.
Glenn Morris's avatar
Glenn Morris committed
1300 1301 1302 1303 1304 1305
* Transaction Queues::      Transaction-based communication with subprocesses.
* Network::                 Opening network connections.
* 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
1306
* Misc Network::            Additional relevant functions for net connections.
1307
* Serial Ports::            Communicating with serial ports.
Glenn Morris's avatar
Glenn Morris committed
1308 1309 1310 1311
* Byte Packing::            Using bindat to pack and unpack binary data.

Receiving Output from Processes

1312
* Process Buffers::         By default, output is put in a buffer.
Glenn Morris's avatar
Glenn Morris committed
1313 1314 1315 1316 1317 1318
* Filter Functions::        Filter functions accept output from the process.
* Decoding Output::         Filters can get unibyte or multibyte strings.
* Accepting Output::        How to wait until process output arrives.

Low-Level Network Access

Glenn Morris's avatar
Glenn Morris committed
1319 1320 1321
* Network Processes::       Using @code{make-network-process}.
* Network Options::         Further control over network connections.
* Network Feature Testing:: Determining which network features work on
Glenn Morris's avatar
Glenn Morris committed
1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339
                              the machine you are using.

Packing and Unpacking Byte Arrays

* Bindat Spec::             Describing data layout.
* Bindat Functions::        Doing the unpacking and packing.
* Bindat Examples::         Samples of what bindat.el can do for you!

Emacs Display

* Refresh Screen::          Clearing the screen and redrawing everything on it.
* Forcing Redisplay::       Forcing redisplay.
* Truncation::              Folding or wrapping long text lines.
* The Echo Area::           Displaying messages at the bottom of the screen.
* Warnings::                Displaying warning messages for the user.
* Invisible Text::          Hiding part of the buffer text.
* Selective Display::       Hiding part of the buffer text (the old way).
* Temporary Displays::      Displays that go away automatically.
Glenn Morris's avatar
Glenn Morris committed
1340
* Overlays::                Use overlays to highlight parts of the buffer.
1341
* Size of Displayed Text::  How large displayed text is.
Glenn Morris's avatar
Glenn Morris committed
1342
* Line Height::             Controlling the height of lines.
Glenn Morris's avatar
Glenn Morris committed
1343
* Faces::                   A face defines a graphics style
Glenn Morris's avatar
Glenn Morris committed
1344 1345
                              for text characters: font, colors, etc.
* Fringes::                 Controlling window fringes.