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