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