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