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