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