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