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