Spelling fixes.
[bpt/emacs.git] / 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-1995, 1998-1999, 2001-2011
5 @c 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 3.0
29 @include emacsver.texi
30 @set DATE July 2009
31
32 @dircategory Emacs
33 @direntry
34 * Elisp: (elisp). The Emacs Lisp Reference Manual.
35 @end direntry
36
37 @c in general, keep the following line commented out, unless doing a
38 @c copy of this manual that will be published. the manual should go
39 @c onto the distribution in the full, 8.5 x 11" size.
40 @set smallbook
41
42 @ifset smallbook
43 @smallbook
44 @end ifset
45
46 @c per rms and peterb, use 10pt fonts for the main text, mostly to
47 @c save on paper cost.
48 @c Do this inside @tex for now, so current makeinfo does not complain.
49 @tex
50 @ifset smallbook
51 @fonttextsize 10
52 \global\let\urlcolor=\Black % don't print links in grayscale
53 \global\let\linkcolor=\Black
54 @end ifset
55 \global\hbadness=6666 % don't worry about not-too-underfull boxes
56 @end tex
57
58 @c Combine indices.
59 @synindex cp fn
60 @syncodeindex vr fn
61 @syncodeindex ky fn
62 @syncodeindex pg fn
63 @c We use the "type index" to index new functions and variables.
64 @c @syncodeindex tp fn
65
66 @copying
67 This is edition @value{VERSION} of the GNU Emacs Lisp Reference Manual,@*
68 corresponding to Emacs version @value{EMACSVER}.
69
70 Copyright @copyright{} 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1998,
71 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011 Free Software
72 Foundation, Inc.
73
74 @quotation
75 Permission is granted to copy, distribute and/or modify this document
76 under the terms of the GNU Free Documentation License, Version 1.3 or
77 any later version published by the Free Software Foundation; with the
78 Invariant Sections being ``GNU General Public License,'' with the
79 Front-Cover texts being ``A GNU Manual,'' and with the Back-Cover
80 Texts as in (a) below. A copy of the license is included in the
81 section entitled ``GNU Free Documentation License.''
82
83 (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
84 modify this GNU manual. Buying copies from the FSF supports it in
85 developing GNU and promoting software freedom.''
86 @end quotation
87 @end copying
88
89 @titlepage
90 @title GNU Emacs Lisp Reference Manual
91 @subtitle Volume 2
92 @subtitle For Emacs Version @value{EMACSVER}
93 @subtitle Revision @value{VERSION}, @value{DATE}
94
95 @author by Bil Lewis, Dan LaLiberte, Richard Stallman
96 @author and the GNU Manual Group
97 @page
98 @vskip 0pt plus 1filll
99 @insertcopying
100
101 @sp 2
102 Published by the Free Software Foundation @*
103 51 Franklin St, Fifth Floor @*
104 Boston, MA 02110-1301 @*
105 USA @*
106 ISBN 1-882114-74-4
107
108 @sp 2
109 Cover art by Etienne Suvasa.
110 @end titlepage
111
112
113 @c Print the tables of contents
114 @summarycontents
115 @contents
116
117
118 @ifnottex
119 @node Top, Introduction, (dir), (dir)
120 @top Emacs Lisp
121
122 This Info file contains edition @value{VERSION} of the GNU Emacs Lisp
123 Reference Manual, corresponding to GNU Emacs version @value{EMACSVER}.
124 @end ifnottex
125
126 @menu
127 * Introduction:: Introduction and conventions used.
128
129 * Lisp Data Types:: Data types of objects in Emacs Lisp.
130 * Numbers:: Numbers and arithmetic functions.
131 * Strings and Characters:: Strings, and functions that work on them.
132 * Lists:: Lists, cons cells, and related functions.
133 * Sequences Arrays Vectors:: Lists, strings and vectors are called sequences.
134 Certain functions act on any kind of sequence.
135 The description of vectors is here as well.
136 * Hash Tables:: Very fast lookup-tables.
137 * Symbols:: Symbols represent names, uniquely.
138
139 * Evaluation:: How Lisp expressions are evaluated.
140 * Control Structures:: Conditionals, loops, nonlocal exits.
141 * Variables:: Using symbols in programs to stand for values.
142 * Functions:: A function is a Lisp program
143 that can be invoked from other functions.
144 * Macros:: Macros are a way to extend the Lisp language.
145 * Customization:: Writing customization declarations.
146
147 * Loading:: Reading files of Lisp code into Lisp.
148 * Byte Compilation:: Compilation makes programs run faster.
149 * Advising Functions:: Adding to the definition of a function.
150 * Debugging:: Tools and tips for debugging Lisp programs.
151
152 * Read and Print:: Converting Lisp objects to text and back.
153 * Minibuffers:: Using the minibuffer to read input.
154 * Command Loop:: How the editor command loop works,
155 and how you can call its subroutines.
156 * Keymaps:: Defining the bindings from keys to commands.
157 * Modes:: Defining major and minor modes.
158 * Documentation:: Writing and using documentation strings.
159
160 * Files:: Accessing files.
161 * Backups and Auto-Saving:: Controlling how backups and auto-save
162 files are made.
163 * Buffers:: Creating and using buffer objects.
164 * Windows:: Manipulating windows and displaying buffers.
165 * Frames:: Making multiple system-level windows.
166 * Positions:: Buffer positions and motion functions.
167 * Markers:: Markers represent positions and update
168 automatically when the text is changed.
169
170 * Text:: Examining and changing text in buffers.
171 * Non-ASCII Characters:: Non-ASCII text in buffers and strings.
172 * Searching and Matching:: Searching buffers for strings or regexps.
173 * Syntax Tables:: The syntax table controls word and list parsing.
174 * Abbrevs:: How Abbrev mode works, and its data structures.
175
176 * Processes:: Running and communicating with subprocesses.
177 * Display:: Features for controlling the screen display.
178 * System Interface:: Getting the user id, system type, environment
179 variables, and other such things.
180
181 * Packaging:: Preparing Lisp code for distribution.
182
183 Appendices
184
185 * Antinews:: Info for users downgrading to Emacs 22.
186 * GNU Free Documentation License:: The license for this documentation.
187 * GPL:: Conditions for copying and changing GNU Emacs.
188 * Tips:: Advice and coding conventions for Emacs Lisp.
189 * GNU Emacs Internals:: Building and dumping Emacs;
190 internal data structures.
191 * Standard Errors:: List of all error symbols.
192 * Standard Buffer-Local Variables::
193 List of variables buffer-local in all buffers.
194 * Standard Keymaps:: List of standard keymaps.
195 * Standard Hooks:: List of standard hook variables.
196
197 * Index:: Index including concepts, functions, variables,
198 and other terms.
199
200 @ignore
201 * New Symbols:: New functions and variables in Emacs @value{EMACSVER}.
202 @end ignore
203
204 @c Do NOT modify the following 3 lines! They must have this form to
205 @c be correctly identified by `texinfo-multiple-files-update'. In
206 @c particular, the detailed menu header line MUST be identical to the
207 @c value of `texinfo-master-menu-header'. See texnfo-upd.el.
208
209 @detailmenu
210 --- The Detailed Node Listing ---
211 ---------------------------------
212
213 Here are other nodes that are subnodes of those already listed,
214 mentioned here so you can get to them in one step:
215
216 Introduction
217
218 * Caveats:: Flaws and a request for help.
219 * Lisp History:: Emacs Lisp is descended from Maclisp.
220 * Conventions:: How the manual is formatted.
221 * Version Info:: Which Emacs version is running?
222 * Acknowledgements:: The authors, editors, and sponsors of this manual.
223
224 Conventions
225
226 * Some Terms:: Explanation of terms we use in this manual.
227 * nil and t:: How the symbols @code{nil} and @code{t} are used.
228 * Evaluation Notation:: The format we use for examples of evaluation.
229 * Printing Notation:: The format we use when examples print text.
230 * Error Messages:: The format we use for examples of errors.
231 * Buffer Text Notation:: The format we use for buffer contents in examples.
232 * Format of Descriptions:: Notation for describing functions, variables, etc.
233
234 Format of Descriptions
235
236 * A Sample Function Description:: A description of an imaginary
237 function, @code{foo}.
238 * A Sample Variable Description:: A description of an imaginary
239 variable, @code{electric-future-map}.
240
241 Lisp Data Types
242
243 * Printed Representation:: How Lisp objects are represented as text.
244 * Comments:: Comments and their formatting conventions.
245 * Programming Types:: Types found in all Lisp systems.
246 * Editing Types:: Types specific to Emacs.
247 * Circular Objects:: Read syntax for circular structure.
248 * Type Predicates:: Tests related to types.
249 * Equality Predicates:: Tests of equality between any two objects.
250
251 Programming Types
252
253 * Integer Type:: Numbers without fractional parts.
254 * Floating Point Type:: Numbers with fractional parts and with a large range.
255 * Character Type:: The representation of letters, numbers and
256 control characters.
257 * Symbol Type:: A multi-use object that refers to a function,
258 variable, or property list, and has a unique identity.
259 * Sequence Type:: Both lists and arrays are classified as sequences.
260 * Cons Cell Type:: Cons cells, and lists (which are made from cons cells).
261 * Array Type:: Arrays include strings and vectors.
262 * String Type:: An (efficient) array of characters.
263 * Vector Type:: One-dimensional arrays.
264 * Char-Table Type:: One-dimensional sparse arrays indexed by characters.
265 * Bool-Vector Type:: One-dimensional arrays of @code{t} or @code{nil}.
266 * Hash Table Type:: Super-fast lookup tables.
267 * Function Type:: A piece of executable code you can call from elsewhere.
268 * Macro Type:: A method of expanding an expression into another
269 expression, more fundamental but less pretty.
270 * Primitive Function Type:: A function written in C, callable from Lisp.
271 * Byte-Code Type:: A function written in Lisp, then compiled.
272 * Autoload Type:: A type used for automatically loading seldom-used
273 functions.
274
275 Character Type
276
277 * Basic Char Syntax:: Syntax for regular characters.
278 * General Escape Syntax:: How to specify characters by their codes.
279 * Ctl-Char Syntax:: Syntax for control characters.
280 * Meta-Char Syntax:: Syntax for meta-characters.
281 * Other Char Bits:: Syntax for hyper-, super-, and alt-characters.
282
283 Cons Cell and List Types
284
285 * Box Diagrams:: Drawing pictures of lists.
286 * Dotted Pair Notation:: A general syntax for cons cells.
287 * Association List Type:: A specially constructed list.
288
289 String Type
290
291 * Syntax for Strings:: How to specify Lisp strings.
292 * Non-ASCII in Strings:: International characters in strings.
293 * Nonprinting Characters:: Literal unprintable characters in strings.
294 * Text Props and Strings:: Strings with text properties.
295
296 Editing Types
297
298 * Buffer Type:: The basic object of editing.
299 * Marker Type:: A position in a buffer.
300 * Window Type:: Buffers are displayed in windows.
301 * Frame Type:: Windows subdivide frames.
302 * Terminal Type:: A terminal device displays frames.
303 * Window Configuration Type:: Recording the way a frame is subdivided.
304 * Frame Configuration Type:: Recording the status of all frames.
305 * Process Type:: A subprocess of Emacs running on the underlying OS.
306 * Stream Type:: Receive or send characters.
307 * Keymap Type:: What function a keystroke invokes.
308 * Overlay Type:: How an overlay is represented.
309 * Font Type:: Fonts for displaying text.
310
311 Numbers
312
313 * Integer Basics:: Representation and range of integers.
314 * Float Basics:: Representation and range of floating point.
315 * Predicates on Numbers:: Testing for numbers.
316 * Comparison of Numbers:: Equality and inequality predicates.
317 * Numeric Conversions:: Converting float to integer and vice versa.
318 * Arithmetic Operations:: How to add, subtract, multiply and divide.
319 * Rounding Operations:: Explicitly rounding floating point numbers.
320 * Bitwise Operations:: Logical and, or, not, shifting.
321 * Math Functions:: Trig, exponential and logarithmic functions.
322 * Random Numbers:: Obtaining random integers, predictable or not.
323
324 Strings and Characters
325
326 * String Basics:: Basic properties of strings and characters.
327 * Predicates for Strings:: Testing whether an object is a string or char.
328 * Creating Strings:: Functions to allocate new strings.
329 * Modifying Strings:: Altering the contents of an existing string.
330 * Text Comparison:: Comparing characters or strings.
331 * String Conversion:: Converting to and from characters and strings.
332 * Formatting Strings:: @code{format}: Emacs's analogue of @code{printf}.
333 * Case Conversion:: Case conversion functions.
334 * Case Tables:: Customizing case conversion.
335
336 Lists
337
338 * Cons Cells:: How lists are made out of cons cells.
339 * List-related Predicates:: Is this object a list? Comparing two lists.
340 * List Elements:: Extracting the pieces of a list.
341 * Building Lists:: Creating list structure.
342 * List Variables:: Modifying lists stored in variables.
343 * Modifying Lists:: Storing new pieces into an existing list.
344 * Sets And Lists:: A list can represent a finite mathematical set.
345 * Association Lists:: A list can represent a finite relation or mapping.
346 * Rings:: Managing a fixed-size ring of objects.
347
348 Modifying Existing List Structure
349
350 * Setcar:: Replacing an element in a list.
351 * Setcdr:: Replacing part of the list backbone.
352 This can be used to remove or add elements.
353 * Rearrangement:: Reordering the elements in a list; combining lists.
354
355 Sequences, Arrays, and Vectors
356
357 * Sequence Functions:: Functions that accept any kind of sequence.
358 * Arrays:: Characteristics of arrays in Emacs Lisp.
359 * Array Functions:: Functions specifically for arrays.
360 * Vectors:: Special characteristics of Emacs Lisp vectors.
361 * Vector Functions:: Functions specifically for vectors.
362 * Char-Tables:: How to work with char-tables.
363 * Bool-Vectors:: How to work with bool-vectors.
364
365 Hash Tables
366
367 * Creating Hash:: Functions to create hash tables.
368 * Hash Access:: Reading and writing the hash table contents.
369 * Defining Hash:: Defining new comparison methods.
370 * Other Hash:: Miscellaneous.
371
372 Symbols
373
374 * Symbol Components:: Symbols have names, values, function definitions
375 and property lists.
376 * Definitions:: A definition says how a symbol will be used.
377 * Creating Symbols:: How symbols are kept unique.
378 * Property Lists:: Each symbol has a property list
379 for recording miscellaneous information.
380
381 Property Lists
382
383 * Plists and Alists:: Comparison of the advantages of property
384 lists and association lists.
385 * Symbol Plists:: Functions to access symbols' property lists.
386 * Other Plists:: Accessing property lists stored elsewhere.
387
388 Evaluation
389
390 * Intro Eval:: Evaluation in the scheme of things.
391 * Forms:: How various sorts of objects are evaluated.
392 * Quoting:: Avoiding evaluation (to put constants in
393 the program).
394 * Eval:: How to invoke the Lisp interpreter explicitly.
395
396 Kinds of Forms
397
398 * Self-Evaluating Forms:: Forms that evaluate to themselves.
399 * Symbol Forms:: Symbols evaluate as variables.
400 * Classifying Lists:: How to distinguish various sorts of list forms.
401 * Function Indirection:: When a symbol appears as the car of a list,
402 we find the real function via the symbol.
403 * Function Forms:: Forms that call functions.
404 * Macro Forms:: Forms that call macros.
405 * Special Forms:: "Special forms" are idiosyncratic primitives,
406 most of them extremely important.
407 * Autoloading:: Functions set up to load files
408 containing their real definitions.
409
410 Control Structures
411
412 * Sequencing:: Evaluation in textual order.
413 * Conditionals:: @code{if}, @code{cond}, @code{when}, @code{unless}.
414 * Combining Conditions:: @code{and}, @code{or}, @code{not}.
415 * Iteration:: @code{while} loops.
416 * Nonlocal Exits:: Jumping out of a sequence.
417
418 Nonlocal Exits
419
420 * Catch and Throw:: Nonlocal exits for the program's own purposes.
421 * Examples of Catch:: Showing how such nonlocal exits can be written.
422 * Errors:: How errors are signaled and handled.
423 * Cleanups:: Arranging to run a cleanup form if an
424 error happens.
425
426 Errors
427
428 * Signaling Errors:: How to report an error.
429 * Processing of Errors:: What Emacs does when you report an error.
430 * Handling Errors:: How you can trap errors and continue execution.
431 * Error Symbols:: How errors are classified for trapping them.
432
433 Variables
434
435 * Global Variables:: Variable values that exist permanently, everywhere.
436 * Constant Variables:: Certain "variables" have values that never change.
437 * Local Variables:: Variable values that exist only temporarily.
438 * Void Variables:: Symbols that lack values.
439 * Defining Variables:: A definition says a symbol is used as a variable.
440 * Tips for Defining:: Things you should think about when you
441 define a variable.
442 * Accessing Variables:: Examining values of variables whose names
443 are known only at run time.
444 * Setting Variables:: Storing new values in variables.
445 * Variable Scoping:: How Lisp chooses among local and global values.
446 * Buffer-Local Variables:: Variable values in effect only in one buffer.
447 * File Local Variables:: Handling local variable lists in files.
448 * Directory Local Variables:: Local variables common to all files in a
449 directory.
450 * Frame-Local Variables:: Frame-local bindings for variables.
451 * Variable Aliases:: Variables that are aliases for other variables.
452 * Variables with Restricted Values:: Non-constant variables whose value can
453 @emph{not} be an arbitrary Lisp object.
454
455 Scoping Rules for Variable Bindings
456
457 * Scope:: Scope means where in the program a value
458 is visible. Comparison with other languages.
459 * Extent:: Extent means how long in time a value exists.
460 * Impl of Scope:: Two ways to implement dynamic scoping.
461 * Using Scoping:: How to use dynamic scoping carefully and
462 avoid problems.
463
464 Buffer-Local Variables
465
466 * Intro to Buffer-Local:: Introduction and concepts.
467 * Creating Buffer-Local:: Creating and destroying buffer-local bindings.
468 * Default Value:: The default value is seen in buffers
469 that don't have their own buffer-local values.
470
471 Functions
472
473 * What Is a Function:: Lisp functions vs. primitives; terminology.
474 * Lambda Expressions:: How functions are expressed as Lisp objects.
475 * Function Names:: A symbol can serve as the name of a function.
476 * Defining Functions:: Lisp expressions for defining functions.
477 * Calling Functions:: How to use an existing function.
478 * Mapping Functions:: Applying a function to each element of a list, etc.
479 * Anonymous Functions:: Lambda expressions are functions with no names.
480 * Function Cells:: Accessing or setting the function definition
481 of a symbol.
482 * Obsolete Functions:: Declaring functions obsolete.
483 * Inline Functions:: Defining functions that the compiler
484 will open code.
485 * Declaring Functions:: Telling the compiler that a function is defined.
486 * Function Safety:: Determining whether a function is safe to call.
487 * Related Topics:: Cross-references to specific Lisp primitives
488 that have a special bearing on how
489 functions work.
490
491 Lambda Expressions
492
493 * Lambda Components:: The parts of a lambda expression.
494 * Simple Lambda:: A simple example.
495 * Argument List:: Details and special features of argument lists.
496 * Function Documentation:: How to put documentation in a function.
497
498 Macros
499
500 * Simple Macro:: A basic example.
501 * Expansion:: How, when and why macros are expanded.
502 * Compiling Macros:: How macros are expanded by the compiler.
503 * Defining Macros:: How to write a macro definition.
504 * Backquote:: Easier construction of list structure.
505 * Problems with Macros:: Don't evaluate the macro arguments too many times.
506 Don't hide the user's variables.
507 * Indenting Macros:: Specifying how to indent macro calls.
508
509 Common Problems Using Macros
510
511 * Wrong Time:: Do the work in the expansion, not in the macro.
512 * Argument Evaluation:: The expansion should evaluate each macro arg once.
513 * Surprising Local Vars:: Local variable bindings in the expansion
514 require special care.
515 * Eval During Expansion:: Don't evaluate them; put them in the expansion.
516 * Repeated Expansion:: Avoid depending on how many times expansion is done.
517
518 Writing Customization Definitions
519
520 * Common Keywords:: Common keyword arguments for all kinds of
521 customization declarations.
522 * Group Definitions:: Writing customization group definitions.
523 * Variable Definitions:: Declaring user options.
524 * Customization Types:: Specifying the type of a user option.
525
526 Customization Types
527
528 * Simple Types:: Simple customization types: sexp, integer, number,
529 string, file, directory, alist.
530 * Composite Types:: Build new types from other types or data.
531 * Splicing into Lists:: Splice elements into list with @code{:inline}.
532 * Type Keywords:: Keyword-argument pairs in a customization type.
533 * Defining New Types:: Give your type a name.
534
535 Loading
536
537 * How Programs Do Loading:: The @code{load} function and others.
538 * Load Suffixes:: Details about the suffixes that @code{load} tries.
539 * Library Search:: Finding a library to load.
540 * Loading Non-ASCII:: Non-@acronym{ASCII} characters in Emacs Lisp files.
541 * Autoload:: Setting up a function to autoload.
542 * Repeated Loading:: Precautions about loading a file twice.
543 * Named Features:: Loading a library if it isn't already loaded.
544 * Where Defined:: Finding which file defined a certain symbol.
545 * Unloading:: How to "unload" a library that was loaded.
546 * Hooks for Loading:: Providing code to be run when
547 particular libraries are loaded.
548
549 Byte Compilation
550
551 * Speed of Byte-Code:: An example of speedup from byte compilation.
552 * Compilation Functions:: Byte compilation functions.
553 * Docs and Compilation:: Dynamic loading of documentation strings.
554 * Dynamic Loading:: Dynamic loading of individual functions.
555 * Eval During Compile:: Code to be evaluated when you compile.
556 * Compiler Errors:: Handling compiler error messages.
557 * Byte-Code Objects:: The data type used for byte-compiled functions.
558 * Disassembly:: Disassembling byte-code; how to read byte-code.
559
560 Advising Emacs Lisp Functions
561
562 * Simple Advice:: A simple example to explain the basics of advice.
563 * Defining Advice:: Detailed description of @code{defadvice}.
564 * Around-Advice:: Wrapping advice around a function's definition.
565 * Computed Advice:: ...is to @code{defadvice} as @code{fset} is to @code{defun}.
566 * Activation of Advice:: Advice doesn't do anything until you activate it.
567 * Enabling Advice:: You can enable or disable each piece of advice.
568 * Preactivation:: Preactivation is a way of speeding up the
569 loading of compiled advice.
570 * Argument Access in Advice:: How advice can access the function's arguments.
571 * Advising Primitives:: Accessing arguments when advising a primitive.
572 * Combined Definition:: How advice is implemented.
573
574 Debugging Lisp Programs
575
576 * Debugger:: How the Emacs Lisp debugger is implemented.
577 * Edebug:: A source-level Emacs Lisp debugger.
578 * Syntax Errors:: How to find syntax errors.
579 * Test Coverage:: Ensuring you have tested all branches in your code.
580 * Compilation Errors:: How to find errors that show up in
581 byte compilation.
582
583 The Lisp Debugger
584
585 * Error Debugging:: Entering the debugger when an error happens.
586 * Infinite Loops:: Stopping and debugging a program that doesn't exit.
587 * Function Debugging:: Entering it when a certain function is called.
588 * Explicit Debug:: Entering it at a certain point in the program.
589 * Using Debugger:: What the debugger does; what you see while in it.
590 * Debugger Commands:: Commands used while in the debugger.
591 * Invoking the Debugger:: How to call the function @code{debug}.
592 * Internals of Debugger:: Subroutines of the debugger, and global variables.
593
594 Edebug
595
596 * Using Edebug:: Introduction to use of Edebug.
597 * Instrumenting:: You must instrument your code
598 in order to debug it with Edebug.
599 * Edebug Execution Modes:: Execution modes, stopping more or less often.
600 * Jumping:: Commands to jump to a specified place.
601 * Edebug Misc:: Miscellaneous commands.
602 * Breaks:: Setting breakpoints to make the program stop.
603 * Trapping Errors:: Trapping errors with Edebug.
604 * Edebug Views:: Views inside and outside of Edebug.
605 * Edebug Eval:: Evaluating expressions within Edebug.
606 * Eval List:: Expressions whose values are displayed
607 each time you enter Edebug.
608 * Printing in Edebug:: Customization of printing.
609 * Trace Buffer:: How to produce trace output in a buffer.
610 * Coverage Testing:: How to test evaluation coverage.
611 * The Outside Context:: Data that Edebug saves and restores.
612 * Edebug and Macros:: Specifying how to handle macro calls.
613 * Edebug Options:: Option variables for customizing Edebug.
614
615 Breaks
616
617 * Breakpoints:: Breakpoints at stop points.
618 * Global Break Condition:: Breaking on an event.
619 * Source Breakpoints:: Embedding breakpoints in source code.
620
621 The Outside Context
622
623 * Checking Whether to Stop::When Edebug decides what to do.
624 * Edebug Display Update:: When Edebug updates the display.
625 * Edebug Recursive Edit:: When Edebug stops execution.
626
627 Edebug and Macros
628
629 * Instrumenting Macro Calls::The basic problem.
630 * Specification List:: How to specify complex patterns of evaluation.
631 * Backtracking:: What Edebug does when matching fails.
632 * Specification Examples:: To help understand specifications.
633
634 Debugging Invalid Lisp Syntax
635
636 * Excess Open:: How to find a spurious open paren or missing close.
637 * Excess Close:: How to find a spurious close paren or missing open.
638
639 Reading and Printing Lisp Objects
640
641 * Streams Intro:: Overview of streams, reading and printing.
642 * Input Streams:: Various data types that can be used as
643 input streams.
644 * Input Functions:: Functions to read Lisp objects from text.
645 * Output Streams:: Various data types that can be used as
646 output streams.
647 * Output Functions:: Functions to print Lisp objects as text.
648 * Output Variables:: Variables that control what the printing
649 functions do.
650
651 Minibuffers
652
653 * Intro to Minibuffers:: Basic information about minibuffers.
654 * Text from Minibuffer:: How to read a straight text string.
655 * Object from Minibuffer:: How to read a Lisp object or expression.
656 * Minibuffer History:: Recording previous minibuffer inputs
657 so the user can reuse them.
658 * Initial Input:: Specifying initial contents for the minibuffer.
659 * Completion:: How to invoke and customize completion.
660 * Yes-or-No Queries:: Asking a question with a simple answer.
661 * Multiple Queries:: Asking a series of similar questions.
662 * Reading a Password:: Reading a password from the terminal.
663 * Minibuffer Commands:: Commands used as key bindings in minibuffers.
664 * Minibuffer Contents:: How such commands access the minibuffer text.
665 * Minibuffer Windows:: Operating on the special minibuffer windows.
666 * Recursive Mini:: Whether recursive entry to minibuffer is allowed.
667 * Minibuffer Misc:: Various customization hooks and variables.
668
669 Completion
670
671 * Basic Completion:: Low-level functions for completing strings.
672 (These are too low level to use the minibuffer.)
673 * Minibuffer Completion:: Invoking the minibuffer with completion.
674 * Completion Commands:: Minibuffer commands that do completion.
675 * High-Level Completion:: Convenient special cases of completion
676 (reading buffer name, file name, etc.).
677 * Reading File Names:: Using completion to read file names and
678 shell commands.
679 * Completion Styles:: Specifying rules for performing completion.
680 * Programmed Completion:: Writing your own completion-function.
681
682 Command Loop
683
684 * Command Overview:: How the command loop reads commands.
685 * Defining Commands:: Specifying how a function should read arguments.
686 * Interactive Call:: Calling a command, so that it will read arguments.
687 * Distinguish Interactive:: Making a command distinguish interactive calls.
688 * Command Loop Info:: Variables set by the command loop for you to examine.
689 * Adjusting Point:: Adjustment of point after a command.
690 * Input Events:: What input looks like when you read it.
691 * Reading Input:: How to read input events from the keyboard or mouse.
692 * Special Events:: Events processed immediately and individually.
693 * Waiting:: Waiting for user input or elapsed time.
694 * Quitting:: How @kbd{C-g} works. How to catch or defer quitting.
695 * Prefix Command Arguments:: How the commands to set prefix args work.
696 * Recursive Editing:: Entering a recursive edit,
697 and why you usually shouldn't.
698 * Disabling Commands:: How the command loop handles disabled commands.
699 * Command History:: How the command history is set up, and how accessed.
700 * Keyboard Macros:: How keyboard macros are implemented.
701
702 Defining Commands
703
704 * Using Interactive:: General rules for @code{interactive}.
705 * Interactive Codes:: The standard letter-codes for reading arguments
706 in various ways.
707 * Interactive Examples:: Examples of how to read interactive arguments.
708
709 Input Events
710
711 * Keyboard Events:: Ordinary characters--keys with symbols on them.
712 * Function Keys:: Function keys--keys with names, not symbols.
713 * Mouse Events:: Overview of mouse events.
714 * Click Events:: Pushing and releasing a mouse button.
715 * Drag Events:: Moving the mouse before releasing the button.
716 * Button-Down Events:: A button was pushed and not yet released.
717 * Repeat Events:: Double and triple click (or drag, or down).
718 * Motion Events:: Just moving the mouse, not pushing a button.
719 * Focus Events:: Moving the mouse between frames.
720 * Misc Events:: Other events the system can generate.
721 * Event Examples:: Examples of the lists for mouse events.
722 * Classifying Events:: Finding the modifier keys in an event symbol.
723 Event types.
724 * Accessing Mouse:: Functions to extract info from mouse events.
725 * Accessing Scroll:: Functions to get info from scroll bar events.
726 * Strings of Events:: Special considerations for putting
727 keyboard character events in a string.
728
729 Reading Input
730
731 * Key Sequence Input:: How to read one key sequence.
732 * Reading One Event:: How to read just one event.
733 * Event Mod:: How Emacs modifies events as they are read.
734 * Invoking the Input Method:: How reading an event uses the input method.
735 * Quoted Character Input:: Asking the user to specify a character.
736 * Event Input Misc:: How to reread or throw away input events.
737
738 Keymaps
739
740 * Key Sequences:: Key sequences as Lisp objects.
741 * Keymap Basics:: Basic concepts of keymaps.
742 * Format of Keymaps:: What a keymap looks like as a Lisp object.
743 * Creating Keymaps:: Functions to create and copy keymaps.
744 * Inheritance and Keymaps:: How one keymap can inherit the bindings
745 of another keymap.
746 * Prefix Keys:: Defining a key with a keymap as its definition.
747 * Active Keymaps:: How Emacs searches the active keymaps
748 for a key binding.
749 * Searching Keymaps:: A pseudo-Lisp summary of searching active maps.
750 * Controlling Active Maps:: Each buffer has a local keymap
751 to override the standard (global) bindings.
752 A minor mode can also override them.
753 * Key Lookup:: Finding a key's binding in one keymap.
754 * Functions for Key Lookup:: How to request key lookup.
755 * Changing Key Bindings:: Redefining a key in a keymap.
756 * Remapping Commands:: A keymap can translate one command to another.
757 * Translation Keymaps:: Keymaps for translating sequences of events.
758 * Key Binding Commands:: Interactive interfaces for redefining keys.
759 * Scanning Keymaps:: Looking through all keymaps, for printing help.
760 * Menu Keymaps:: Defining a menu as a keymap.
761
762 Menu Keymaps
763
764 * Defining Menus:: How to make a keymap that defines a menu.
765 * Mouse Menus:: How users actuate the menu with the mouse.
766 * Keyboard Menus:: How users actuate the menu with the keyboard.
767 * Menu Example:: Making a simple menu.
768 * Menu Bar:: How to customize the menu bar.
769 * Tool Bar:: A tool bar is a row of images.
770 * Modifying Menus:: How to add new items to a menu.
771
772 Defining Menus
773
774 * Simple Menu Items:: A simple kind of menu key binding,
775 limited in capabilities.
776 * Extended Menu Items:: More powerful menu item definitions
777 let you specify keywords to enable
778 various features.
779 * Menu Separators:: Drawing a horizontal line through a menu.
780 * Alias Menu Items:: Using command aliases in menu items.
781
782 Major and Minor Modes
783
784 * Hooks:: How to use hooks; how to write code that provides hooks.
785 * Major Modes:: Defining major modes.
786 * Minor Modes:: Defining minor modes.
787 * Mode Line Format:: Customizing the text that appears in the mode line.
788 * Imenu:: Providing a menu of definitions made in a buffer.
789 * Font Lock Mode:: How modes can highlight text according to syntax.
790 * Desktop Save Mode:: How modes can have buffer state saved between
791 Emacs sessions.
792
793 Hooks
794
795 * Running Hooks:: How to run a hook.
796 * Setting Hooks:: How to put functions on a hook, or remove them.
797
798 Major Modes
799
800 * Major Mode Conventions:: Coding conventions for keymaps, etc.
801 * Auto Major Mode:: How Emacs chooses the major mode automatically.
802 * Mode Help:: Finding out how to use a mode.
803 * Derived Modes:: Defining a new major mode based on another major
804 mode.
805 * Basic Major Modes:: Modes that other modes are often derived from.
806 * Generic Modes:: Defining a simple major mode that supports
807 comment syntax and Font Lock mode.
808 * Mode Hooks:: Hooks run at the end of major mode commands.
809 * Example Major Modes:: Text mode and Lisp modes.
810
811 Minor Modes
812
813 * Minor Mode Conventions:: Tips for writing a minor mode.
814 * Keymaps and Minor Modes:: How a minor mode can have its own keymap.
815 * Defining Minor Modes:: A convenient facility for defining minor modes.
816
817 Mode Line Format
818
819 * Mode Line Basics:: Basic ideas of mode line control.
820 * Mode Line Data:: The data structure that controls the mode line.
821 * Mode Line Top:: The top level variable, mode-line-format.
822 * Mode Line Variables:: Variables used in that data structure.
823 * %-Constructs:: Putting information into a mode line.
824 * Properties in Mode:: Using text properties in the mode line.
825 * Header Lines:: Like a mode line, but at the top.
826 * Emulating Mode Line:: Formatting text as the mode line would.
827
828 Font Lock Mode
829
830 * Font Lock Basics:: Overview of customizing Font Lock.
831 * Search-based Fontification:: Fontification based on regexps.
832 * Customizing Keywords:: Customizing search-based fontification.
833 * Other Font Lock Variables:: Additional customization facilities.
834 * Levels of Font Lock:: Each mode can define alternative levels
835 so that the user can select more or less.
836 * Precalculated Fontification:: How Lisp programs that produce the buffer
837 contents can also specify how to fontify it.
838 * Faces for Font Lock:: Special faces specifically for Font Lock.
839 * Syntactic Font Lock:: Fontification based on syntax tables.
840 * Setting Syntax Properties:: Defining character syntax based on context
841 using the Font Lock mechanism.
842 * Multiline Font Lock:: How to coerce Font Lock into properly
843 highlighting multiline constructs.
844
845 Multiline Font Lock Constructs
846
847 * Font Lock Multiline:: Marking multiline chunks with a text property.
848 * Region to Refontify:: Controlling which region gets refontified
849 after a buffer change.
850
851 Documentation
852
853 * Documentation Basics:: Good style for doc strings.
854 Where to put them. How Emacs stores them.
855 * Accessing Documentation:: How Lisp programs can access doc strings.
856 * Keys in Documentation:: Substituting current key bindings.
857 * Describing Characters:: Making printable descriptions of
858 non-printing characters and key sequences.
859 * Help Functions:: Subroutines used by Emacs help facilities.
860
861 Files
862
863 * Visiting Files:: Reading files into Emacs buffers for editing.
864 * Saving Buffers:: Writing changed buffers back into files.
865 * Reading from Files:: Reading files into buffers without visiting.
866 * Writing to Files:: Writing new files from parts of buffers.
867 * File Locks:: Locking and unlocking files, to prevent
868 simultaneous editing by two people.
869 * Information about Files:: Testing existence, accessibility, size of files.
870 * Changing Files:: Renaming files, changing protection, etc.
871 * File Names:: Decomposing and expanding file names.
872 * Contents of Directories:: Getting a list of the files in a directory.
873 * Create/Delete Dirs:: Creating and Deleting Directories.
874 * Magic File Names:: Defining "magic" special handling
875 for certain file names.
876 * Format Conversion:: Conversion to and from various file formats.
877
878 Visiting Files
879
880 * Visiting Functions:: The usual interface functions for visiting.
881 * Subroutines of Visiting:: Lower-level subroutines that they use.
882
883 Information about Files
884
885 * Testing Accessibility:: Is a given file readable? Writable?
886 * Kinds of Files:: Is it a directory? A symbolic link?
887 * Truenames:: Eliminating symbolic links from a file name.
888 * File Attributes:: How large is it? Any other names? Etc.
889 * Locating Files:: How to find a file in standard places.
890
891 File Names
892
893 * File Name Components:: The directory part of a file name, and the rest.
894 * Relative File Names:: Some file names are relative to a current directory.
895 * Directory Names:: A directory's name as a directory
896 is different from its name as a file.
897 * File Name Expansion:: Converting relative file names to absolute ones.
898 * Unique File Names:: Generating names for temporary files.
899 * File Name Completion:: Finding the completions for a given file name.
900 * Standard File Names:: If your package uses a fixed file name,
901 how to handle various operating systems simply.
902
903 File Format Conversion
904
905 * Format Conversion Overview:: @code{insert-file-contents} and @code{write-region}.
906 * Format Conversion Round-Trip:: Using @code{format-alist}.
907 * Format Conversion Piecemeal:: Specifying non-paired conversion.
908
909 Backups and Auto-Saving
910
911 * Backup Files:: How backup files are made; how their names
912 are chosen.
913 * Auto-Saving:: How auto-save files are made; how their
914 names are chosen.
915 * Reverting:: @code{revert-buffer}, and how to customize
916 what it does.
917
918 Backup Files
919
920 * Making Backups:: How Emacs makes backup files, and when.
921 * Rename or Copy:: Two alternatives: renaming the old file
922 or copying it.
923 * Numbered Backups:: Keeping multiple backups for each source file.
924 * Backup Names:: How backup file names are computed; customization.
925
926 Buffers
927
928 * Buffer Basics:: What is a buffer?
929 * Current Buffer:: Designating a buffer as current
930 so that primitives will access its contents.
931 * Buffer Names:: Accessing and changing buffer names.
932 * Buffer File Name:: The buffer file name indicates which file
933 is visited.
934 * Buffer Modification:: A buffer is @dfn{modified} if it needs to be saved.
935 * Modification Time:: Determining whether the visited file was changed
936 ``behind Emacs's back''.
937 * Read Only Buffers:: Modifying text is not allowed in a
938 read-only buffer.
939 * The Buffer List:: How to look at all the existing buffers.
940 * Creating Buffers:: Functions that create buffers.
941 * Killing Buffers:: Buffers exist until explicitly killed.
942 * Indirect Buffers:: An indirect buffer shares text with some
943 other buffer.
944 * Swapping Text:: Swapping text between two buffers.
945 * Buffer Gap:: The gap in the buffer.
946
947 Windows
948
949 * Basic Windows:: Basic information on using windows.
950 * Splitting Windows:: Splitting one window into two windows.
951 * Deleting Windows:: Deleting a window gives its space to other windows.
952 * Selecting Windows:: The selected window is the one that you edit in.
953 * Cyclic Window Ordering:: Moving around the existing windows.
954 * Buffers and Windows:: Each window displays the contents of a buffer.
955 * Switching Buffers:: Higher-level functions for switching to a buffer.
956 * Choosing Window:: How to choose a window for displaying a buffer.
957 * Display Action Functions:: Subroutines for @code{display-buffer}.
958 * Choosing Window Options:: Extra options affecting how buffers are displayed.
959 * Window History:: Each window remembers the buffers displayed in it.
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 * Bidirectional Display:: Display of bidirectional scripts, such as
1302 Arabic and Farsi.
1303 * Glyphless Chars:: How glyphless characters are drawn.
1304
1305 The Echo Area
1306
1307 * Displaying Messages:: Explicitly displaying text in the echo area.
1308 * Progress:: Informing user about progress of a long operation.
1309 * Logging Messages:: Echo area messages are logged for the user.
1310 * Echo Area Customization:: Controlling the echo area.
1311
1312 Reporting Warnings
1313
1314 * Warning Basics:: Warnings concepts and functions to report them.
1315 * Warning Variables:: Variables programs bind to customize
1316 their warnings.
1317 * Warning Options:: Variables users set to control display of warnings.
1318
1319 Overlays
1320
1321 * Managing Overlays:: Creating and moving overlays.
1322 * Overlay Properties:: How to read and set properties.
1323 What properties do to the screen display.
1324 * Finding Overlays:: Searching for overlays.
1325
1326 Faces
1327
1328 * Defining Faces:: How to define a face with @code{defface}.
1329 * Face Attributes:: What is in a face?
1330 * Attribute Functions:: Functions to examine and set face attributes.
1331 * Displaying Faces:: How Emacs combines the faces specified for
1332 a character.
1333 * Face Remapping:: Remapping faces to alternative definitions.
1334 * Face Functions:: How to define and examine faces.
1335 * Auto Faces:: Hook for automatic face assignment.
1336 * Basic Faces:: Faces that are defined by default.
1337 * Font Selection:: Finding the best available font for a face.
1338 * Font Lookup:: Looking up the names of available fonts
1339 and information about them.
1340 * Fontsets:: A fontset is a collection of fonts
1341 that handle a range of character sets.
1342 * Low-Level Font:: Lisp representation for character display fonts.
1343
1344 Fringes
1345
1346 * Fringe Size/Pos:: Specifying where to put the window fringes.
1347 * Fringe Indicators:: Displaying indicator icons in the window fringes.
1348 * Fringe Cursors:: Displaying cursors in the right fringe.
1349 * Fringe Bitmaps:: Specifying bitmaps for fringe indicators.
1350 * Customizing Bitmaps:: Specifying your own bitmaps to use in the fringes.
1351 * Overlay Arrow:: Display of an arrow to indicate position.
1352
1353 The @code{display} Property
1354
1355 * Replacing Specs:: Display specs that replace the text.
1356 * Specified Space:: Displaying one space with a specified width.
1357 * Pixel Specification:: Specifying space width or height in pixels.
1358 * Other Display Specs:: Displaying an image; adjusting the height,
1359 spacing, and other properties of text.
1360 * Display Margins:: Displaying text or images to the side of
1361 the main text.
1362
1363 Images
1364
1365 * Image Formats:: Supported image formats.
1366 * Image Descriptors:: How to specify an image for use in @code{:display}.
1367 * XBM Images:: Special features for XBM format.
1368 * XPM Images:: Special features for XPM format.
1369 * GIF Images:: Special features for GIF format.
1370 * TIFF Images:: Special features for TIFF format.
1371 * PostScript Images:: Special features for PostScript format.
1372 * Other Image Types:: Various other formats are supported.
1373 * Defining Images:: Convenient ways to define an image for later use.
1374 * Showing Images:: Convenient ways to display an image once
1375 it is defined.
1376 * Image Cache:: Internal mechanisms of image display.
1377
1378 Buttons
1379
1380 * Button Properties:: Button properties with special meanings.
1381 * Button Types:: Defining common properties for classes of buttons.
1382 * Making Buttons:: Adding buttons to Emacs buffers.
1383 * Manipulating Buttons:: Getting and setting properties of buttons.
1384 * Button Buffer Commands:: Buffer-wide commands and bindings for buttons.
1385
1386 Abstract Display
1387
1388 * Abstract Display Functions:: Functions in the Ewoc package.
1389 * Abstract Display Example:: Example of using Ewoc.
1390
1391 Display Tables
1392
1393 * Display Table Format:: What a display table consists of.
1394 * Active Display Table:: How Emacs selects a display table to use.
1395 * Glyphs:: How to define a glyph, and what glyphs mean.
1396
1397 Operating System Interface
1398
1399 * Starting Up:: Customizing Emacs startup processing.
1400 * Getting Out:: How exiting works (permanent or temporary).
1401 * System Environment:: Distinguish the name and kind of system.
1402 * User Identification:: Finding the name and user id of the user.
1403 * Time of Day:: Getting the current time.
1404 * Time Conversion:: Converting a time from numeric form to
1405 calendrical data and vice versa.
1406 * Time Parsing:: Converting a time from numeric form to text
1407 and vice versa.
1408 * Processor Run Time:: Getting the run time used by Emacs.
1409 * Time Calculations:: Adding, subtracting, comparing times, etc.
1410 * Timers:: Setting a timer to call a function at a
1411 certain time.
1412 * Idle Timers:: Setting a timer to call a function when Emacs has
1413 been idle for a certain length of time.
1414 * Terminal Input:: Accessing and recording terminal input.
1415 * Terminal Output:: Controlling and recording terminal output.
1416 * Sound Output:: Playing sounds on the computer's speaker.
1417 * X11 Keysyms:: Operating on key symbols for X Windows.
1418 * Batch Mode:: Running Emacs without terminal interaction.
1419 * Session Management:: Saving and restoring state with
1420 X Session Management.
1421
1422 Preparing Lisp code for distribution
1423
1424 * Packaging Basics:: The basic concepts of Emacs Lisp packages.
1425 * Simple Packages:: How to package a single .el file.
1426 * Multi-file Packages:: How to package multiple files.
1427
1428 Starting Up Emacs
1429
1430 * Startup Summary:: Sequence of actions Emacs performs at startup.
1431 * Init File:: Details on reading the init file.
1432 * Terminal-Specific:: How the terminal-specific Lisp file is read.
1433 * Command-Line Arguments:: How command-line arguments are processed,
1434 and how you can customize them.
1435
1436 Getting Out of Emacs
1437
1438 * Killing Emacs:: Exiting Emacs irreversibly.
1439 * Suspending Emacs:: Exiting Emacs reversibly.
1440
1441 Terminal Input
1442
1443 * Input Modes:: Options for how input is processed.
1444 * Recording Input:: Saving histories of recent or all input events.
1445
1446 Tips and Conventions
1447
1448 * Coding Conventions:: Conventions for clean and robust programs.
1449 * Key Binding Conventions:: Which keys should be bound by which programs.
1450 * Programming Tips:: Making Emacs code fit smoothly in Emacs.
1451 * Compilation Tips:: Making compiled code run fast.
1452 * Warning Tips:: Turning off compiler warnings.
1453 * Documentation Tips:: Writing readable documentation strings.
1454 * Comment Tips:: Conventions for writing comments.
1455 * Library Headers:: Standard headers for library packages.
1456
1457 GNU Emacs Internals
1458
1459 * Building Emacs:: How the dumped Emacs is made.
1460 * Pure Storage:: Kludge to make preloaded Lisp functions shareable.
1461 * Garbage Collection:: Reclaiming space for Lisp objects no longer used.
1462 * Memory Usage:: Info about total size of Lisp objects made so far.
1463 * Writing Emacs Primitives:: Writing C code for Emacs.
1464 * Object Internals:: Data formats of buffers, windows, processes.
1465
1466 Object Internals
1467
1468 * Buffer Internals:: Components of a buffer structure.
1469 * Window Internals:: Components of a window structure.
1470 * Process Internals:: Components of a process structure.
1471 @end detailmenu
1472 @end menu
1473
1474 @c include intro.texi
1475 @c include objects.texi
1476 @c include numbers.texi
1477 @c include strings.texi
1478
1479 @c include lists.texi
1480 @c include sequences.texi
1481 @c include hash.texi
1482 @c include symbols.texi
1483 @c include eval.texi
1484
1485 @c include control.texi
1486 @c include variables.texi
1487 @c include functions.texi
1488 @c include macros.texi
1489
1490 @c include customize.texi
1491 @c include loading.texi
1492 @c include compile.texi
1493 @c include advice.texi
1494
1495 @c This includes edebug.texi.
1496 @c include debugging.texi
1497 @c include streams.texi
1498 @c include minibuf.texi
1499 @c include commands.texi
1500
1501 @c include keymaps.texi
1502 @c include modes.texi
1503 @c include help.texi
1504 @c include files.texi
1505
1506 @c include backups.texi
1507
1508 @c ================ Beginning of Volume 2 ================
1509 @include buffers.texi
1510 @include windows.texi
1511 @include frames.texi
1512
1513 @include positions.texi
1514 @include markers.texi
1515 @include text.texi
1516 @include nonascii.texi
1517
1518 @include searching.texi
1519 @include syntax.texi
1520 @include abbrevs.texi
1521 @include processes.texi
1522
1523 @include display.texi
1524 @include os.texi
1525
1526 @c MOVE to Emacs Manual: include misc-modes.texi
1527
1528 @c appendices
1529
1530 @c REMOVE this: include non-hacker.texi
1531
1532 @include anti.texi
1533 @include doclicense.texi
1534 @include gpl.texi
1535 @include tips.texi
1536 @include internals.texi
1537 @include errors.texi
1538 @include locals.texi
1539 @include maps.texi
1540 @include hooks.texi
1541
1542 @include index.texi
1543
1544 @ignore
1545 @node New Symbols, , Index, Top
1546 @unnumbered New Symbols Since the Previous Edition
1547
1548 @printindex tp
1549 @end ignore
1550
1551 @bye
1552
1553 \f
1554 These words prevent "local variables" above from confusing Emacs.