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