| blob | b48b46bafd7448f2126d80592d837077c3bdafd2 |
1 \input texinfo @c -*-texinfo-*-
2 @c %**start of header
3 @setfilename elisp
4 @settitle GNU Emacs Lisp Reference Manual
5 @c %**end of header
7 @dircategory Editors
8 @direntry
9 * Elisp: (elisp). The Emacs Lisp Reference Manual.
10 @end direntry
12 @smallbook
13 @setchapternewpage odd
14 @finalout
16 @c Combine indices.
17 @synindex cp fn
18 @syncodeindex vr fn
19 @syncodeindex ky fn
20 @syncodeindex pg fn
21 @c We use the "type index" to index new functions and variables.
22 @c @syncodeindex tp fn
24 @ifnottex
25 This Info file contains edition 2.8 of the GNU Emacs Lisp
26 Reference Manual, corresponding to Emacs version 21.2.
27 @c Please REMEMBER to update edition number in *four* places in this file
28 @c and also in *one* place in intro.texi
30 Published by the Free Software Foundation
31 59 Temple Place, Suite 330
32 Boston, MA 02111-1307 USA
34 Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1998, 1999,
35 2000, 2001, 2002 Free Software Foundation, Inc.
37 Permission is granted to copy, distribute and/or modify this document
38 under the terms of the GNU Free Documentation License, Version 1.1 or
39 any later version published by the Free Software Foundation; with the
40 Invariant Sections being ``Copying'', with the Front-Cover texts being
41 ``A GNU Manual'', and with the Back-Cover Texts as in (a) below. A copy
42 of the license is included in the section entitled ``GNU Free
43 Documentation License''.
45 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
46 this GNU Manual, like GNU software. Copies published by the Free
47 Software Foundation raise funds for GNU development.''
48 @end ifnottex
50 @titlepage
51 @title GNU Emacs Lisp Reference Manual
52 @subtitle For Emacs Version 21
53 @c The edition number appears in several places in this file
54 @c and also in the file intro.texi.
55 @subtitle Revision 2.8, January 2002
57 @author by Bil Lewis, Dan LaLiberte, Richard Stallman
58 @author and the GNU Manual Group
59 @page
60 @vskip 0pt plus 1filll
61 Copyright @copyright{} 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1998,
62 1999, 2000, 2001, 2002 Free Software Foundation, Inc.
64 @sp 2
65 Edition 2.8 @*
66 Revised for Emacs Version 21.2,@*
67 January 2002.@*
68 @sp 2
69 ISBN 1-882114-73-6
71 @sp 2
72 Published by the Free Software Foundation @*
73 59 Temple Place, Suite 330@*
74 Boston, MA 02111-1307 USA
76 Permission is granted to copy, distribute and/or modify this document
77 under the terms of the GNU Free Documentation License, Version 1.1 or
78 any later version published by the Free Software Foundation; with the
79 Invariant Sections being ``Copying'', with the Front-Cover texts being
80 ``A GNU Manual'', and with the Back-Cover Texts as in (a) below. A copy
81 of the license is included in the section entitled ``GNU Free
82 Documentation License''.
84 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
85 this GNU Manual, like GNU software. Copies published by the Free
86 Software Foundation raise funds for GNU development.''
88 Cover art by Etienne Suvasa.
89 @end titlepage
90 @page
92 @node Top, Introduction, (dir), (dir)
94 @ifnottex
95 This Info file contains edition 2.8 of the GNU Emacs Lisp
96 Reference Manual, corresponding to GNU Emacs version 21.2.
97 @end ifnottex
99 @menu
100 * Introduction:: Introduction and conventions used.
101 * Standards: Coding Conventions. Coding conventions for Emacs Lisp.
103 * Lisp Data Types:: Data types of objects in Emacs Lisp.
104 * Numbers:: Numbers and arithmetic functions.
105 * Strings and Characters:: Strings, and functions that work on them.
106 * Lists:: Lists, cons cells, and related functions.
107 * Sequences Arrays Vectors:: Lists, strings and vectors are called sequences.
108 Certain functions act on any kind of sequence.
109 The description of vectors is here as well.
110 * Hash Tables:: Very fast lookup-tables.
111 * Symbols:: Symbols represent names, uniquely.
113 * Evaluation:: How Lisp expressions are evaluated.
114 * Control Structures:: Conditionals, loops, nonlocal exits.
115 * Variables:: Using symbols in programs to stand for values.
116 * Functions:: A function is a Lisp program
117 that can be invoked from other functions.
118 * Macros:: Macros are a way to extend the Lisp language.
119 * Customization:: Writing customization declarations.
121 * Loading:: Reading files of Lisp code into Lisp.
122 * Byte Compilation:: Compilation makes programs run faster.
123 * Advising Functions:: Adding to the definition of a function.
124 * Debugging:: Tools and tips for debugging Lisp programs.
126 * Read and Print:: Converting Lisp objects to text and back.
127 * Minibuffers:: Using the minibuffer to read input.
128 * Command Loop:: How the editor command loop works,
129 and how you can call its subroutines.
130 * Keymaps:: Defining the bindings from keys to commands.
131 * Modes:: Defining major and minor modes.
132 * Documentation:: Writing and using documentation strings.
134 * Files:: Accessing files.
135 * Backups and Auto-Saving:: Controlling how backups and auto-save
136 files are made.
137 * Buffers:: Creating and using buffer objects.
138 * Windows:: Manipulating windows and displaying buffers.
139 * Frames:: Making multiple X windows.
140 * Positions:: Buffer positions and motion functions.
141 * Markers:: Markers represent positions and update
142 automatically when the text is changed.
144 * Text:: Examining and changing text in buffers.
145 * Non-ASCII Characters:: Non-ASCII text in buffers and strings.
146 * Searching and Matching:: Searching buffers for strings or regexps.
147 * Syntax Tables:: The syntax table controls word and list parsing.
148 * Abbrevs:: How Abbrev mode works, and its data structures.
150 * Processes:: Running and communicating with subprocesses.
151 * Display:: Features for controlling the screen display.
152 * Calendar:: Customizing the calendar and diary.
153 * System Interface:: Getting the user id, system type, environment
154 variables, and other such things.
156 Appendices
158 * Antinews:: Info for users downgrading to Emacs 20.
159 * GNU Free Documentation License:: The license for this documentation
160 * GPL:: Conditions for copying and changing GNU Emacs.
161 * Tips:: Advice and coding conventions for Emacs Lisp.
162 * GNU Emacs Internals:: Building and dumping Emacs;
163 internal data structures.
164 * Standard Errors:: List of all error symbols.
165 * Standard Buffer-Local Variables::
166 List of variables buffer-local in all buffers.
167 * Standard Keymaps:: List of standard keymaps.
168 * Standard Hooks:: List of standard hook variables.
170 * Index:: Index including concepts, functions, variables,
171 and other terms.
173 * New Symbols:: New functions and variables in Emacs 21.
175 --- The Detailed Node Listing ---
177 Here are other nodes that are inferiors of those already listed,
178 mentioned here so you can get to them in one step:
180 Introduction
182 * Caveats:: Flaws and a request for help.
183 * Lisp History:: Emacs Lisp is descended from Maclisp.
184 * Conventions:: How the manual is formatted.
185 * Acknowledgements:: The authors, editors, and sponsors of this manual.
187 Conventions
189 * Some Terms:: Explanation of terms we use in this manual.
190 * nil and t:: How the symbols @code{nil} and @code{t} are used.
191 * Evaluation Notation:: The format we use for examples of evaluation.
192 * Printing Notation:: The format we use for examples that print output.
193 * Error Messages:: The format we use for examples of errors.
194 * Buffer Text Notation:: The format we use for buffer contents in examples.
195 * Format of Descriptions:: Notation for describing functions, variables, etc.
197 Tips and Conventions
199 * Coding Conventions:: Conventions for clean and robust programs.
200 * Compilation Tips:: Making compiled code run fast.
201 * Documentation Tips:: Writing readable documentation strings.
202 * Comment Tips:: Conventions for writing comments.
203 * Library Headers:: Standard headers for library packages.
205 Format of Descriptions
207 * A Sample Function Description::
208 * A Sample Variable Description::
210 Lisp Data Types
212 * Printed Representation:: How Lisp objects are represented as text.
213 * Comments:: Comments and their formatting conventions.
214 * Programming Types:: Types found in all Lisp systems.
215 * Editing Types:: Types specific to Emacs.
216 * Type Predicates:: Tests related to types.
217 * Equality Predicates:: Tests of equality between any two objects.
219 Programming Types
221 * Integer Type:: Numbers without fractional parts.
222 * Floating Point Type:: Numbers with fractional parts and with a large range.
223 * Character Type:: The representation of letters, numbers and
224 control characters.
225 * Sequence Type:: Both lists and arrays are classified as sequences.
226 * Cons Cell Type:: Cons cells, and lists (which are made from cons cells).
227 * Array Type:: Arrays include strings and vectors.
228 * String Type:: An (efficient) array of characters.
229 * Vector Type:: One-dimensional arrays.
230 * Symbol Type:: A multi-use object that refers to a function,
231 variable, property list, or itself.
232 * Function Type:: A piece of executable code you can call from elsewhere.
233 * Macro Type:: A method of expanding an expression into another
234 expression, more fundamental but less pretty.
235 * Primitive Function Type:: A function written in C, callable from Lisp.
236 * Byte-Code Type:: A function written in Lisp, then compiled.
237 * Autoload Type:: A type used for automatically loading seldom-used
238 functions.
240 List Type
242 * Dotted Pair Notation:: An alternative syntax for lists.
243 * Association List Type:: A specially constructed list.
245 Editing Types
247 * Buffer Type:: The basic object of editing.
248 * Window Type:: What makes buffers visible.
249 * Window Configuration Type::Save what the screen looks like.
250 * Marker Type:: A position in a buffer.
251 * Process Type:: A process running on the underlying OS.
252 * Stream Type:: Receive or send characters.
253 * Keymap Type:: What function a keystroke invokes.
254 * Overlay Type:: How an overlay is represented.
256 Numbers
258 * Integer Basics:: Representation and range of integers.
259 * Float Basics:: Representation and range of floating point.
260 * Predicates on Numbers:: Testing for numbers.
261 * Comparison of Numbers:: Equality and inequality predicates.
262 * Arithmetic Operations:: How to add, subtract, multiply and divide.
263 * Bitwise Operations:: Logical and, or, not, shifting.
264 * Numeric Conversions:: Converting float to integer and vice versa.
265 * Math Functions:: Trig, exponential and logarithmic functions.
266 * Random Numbers:: Obtaining random integers, predictable or not.
268 Strings and Characters
270 * String Basics:: Basic properties of strings and characters.
271 * Predicates for Strings:: Testing whether an object is a string or char.
272 * Creating Strings:: Functions to allocate new strings.
273 * Text Comparison:: Comparing characters or strings.
274 * String Conversion:: Converting characters or strings and vice versa.
275 * Formatting Strings:: @code{format}: Emacs's analogue of @code{printf}.
276 * Case Conversion:: Case conversion functions.
278 Lists
280 * Cons Cells:: How lists are made out of cons cells.
281 * Lists as Boxes:: Graphical notation to explain lists.
282 * List-related Predicates:: Is this object a list? Comparing two lists.
283 * List Elements:: Extracting the pieces of a list.
284 * Building Lists:: Creating list structure.
285 * Modifying Lists:: Storing new pieces into an existing list.
286 * Sets And Lists:: A list can represent a finite mathematical set.
287 * Association Lists:: A list can represent a finite relation or mapping.
289 Modifying Existing List Structure
291 * Setcar:: Replacing an element in a list.
292 * Setcdr:: Replacing part of the list backbone.
293 This can be used to remove or add elements.
294 * Rearrangement:: Reordering the elements in a list; combining lists.
296 Sequences, Arrays, and Vectors
298 * Sequence Functions:: Functions that accept any kind of sequence.
299 * Arrays:: Characteristics of arrays in Emacs Lisp.
300 * Array Functions:: Functions specifically for arrays.
301 * Vectors:: Functions specifically for vectors.
303 Symbols
305 * Symbol Components:: Symbols have names, values, function definitions
306 and property lists.
307 * Definitions:: A definition says how a symbol will be used.
308 * Creating Symbols:: How symbols are kept unique.
309 * Property Lists:: Each symbol has a property list
310 for recording miscellaneous information.
312 Evaluation
314 * Intro Eval:: Evaluation in the scheme of things.
315 * Eval:: How to invoke the Lisp interpreter explicitly.
316 * Forms:: How various sorts of objects are evaluated.
317 * Quoting:: Avoiding evaluation (to put constants in
318 the program).
320 Kinds of Forms
322 * Self-Evaluating Forms:: Forms that evaluate to themselves.
323 * Symbol Forms:: Symbols evaluate as variables.
324 * Classifying Lists:: How to distinguish various sorts of list forms.
325 * Function Forms:: Forms that call functions.
326 * Macro Forms:: Forms that call macros.
327 * Special Forms:: ``Special forms'' are idiosyncratic primitives,
328 most of them extremely important.
329 * Autoloading:: Functions set up to load files
330 containing their real definitions.
332 Control Structures
334 * Sequencing:: Evaluation in textual order.
335 * Conditionals:: @code{if}, @code{cond}.
336 * Combining Conditions:: @code{and}, @code{or}, @code{not}.
337 * Iteration:: @code{while} loops.
338 * Nonlocal Exits:: Jumping out of a sequence.
340 Nonlocal Exits
342 * Catch and Throw:: Nonlocal exits for the program's own purposes.
343 * Examples of Catch:: Showing how such nonlocal exits can be written.
344 * Errors:: How errors are signaled and handled.
345 * Cleanups:: Arranging to run a cleanup form if an
346 error happens.
348 Errors
350 * Signaling Errors:: How to report an error.
351 * Processing of Errors:: What Emacs does when you report an error.
352 * Handling Errors:: How you can trap errors and continue execution.
353 * Error Symbols:: How errors are classified for trapping them.
355 Variables
357 * Global Variables:: Variable values that exist permanently, everywhere.
358 * Constant Variables:: Certain "variables" have values that never change.
359 * Local Variables:: Variable values that exist only temporarily.
360 * Void Variables:: Symbols that lack values.
361 * Defining Variables:: A definition says a symbol is used as a variable.
362 * Accessing Variables:: Examining values of variables whose names
363 are known only at run time.
364 * Setting Variables:: Storing new values in variables.
365 * Variable Scoping:: How Lisp chooses among local and global values.
366 * Buffer-Local Variables:: Variable values in effect only in one buffer.
368 Scoping Rules for Variable Bindings
370 * Scope:: Scope means where in the program a value
371 is visible. Comparison with other languages.
372 * Extent:: Extent means how long in time a value exists.
373 * Impl of Scope:: Two ways to implement dynamic scoping.
374 * Using Scoping:: How to use dynamic scoping carefully and
375 avoid problems.
377 Buffer-Local Variables
379 * Intro to Buffer-Local:: Introduction and concepts.
380 * Creating Buffer-Local:: Creating and destroying buffer-local bindings.
381 * Default Value:: The default value is seen in buffers
382 that don't have their own buffer-local values.
384 Functions
386 * What Is a Function:: Lisp functions vs primitives; terminology.
387 * Lambda Expressions:: How functions are expressed as Lisp objects.
388 * Function Names:: A symbol can serve as the name of a function.
389 * Defining Functions:: Lisp expressions for defining functions.
390 * Calling Functions:: How to use an existing function.
391 * Mapping Functions:: Applying a function to each element of a list, etc.
392 * Anonymous Functions:: Lambda-expressions are functions with no names.
393 * Function Cells:: Accessing or setting the function definition
394 of a symbol.
395 * Related Topics:: Cross-references to specific Lisp primitives
396 that have a special bearing on how
397 functions work.
399 Lambda Expressions
401 * Lambda Components:: The parts of a lambda expression.
402 * Simple Lambda:: A simple example.
403 * Argument List:: Details and special features of argument lists.
404 * Function Documentation:: How to put documentation in a function.
406 Macros
408 * Simple Macro:: A basic example.
409 * Expansion:: How, when and why macros are expanded.
410 * Compiling Macros:: How macros are expanded by the compiler.
411 * Defining Macros:: How to write a macro definition.
412 * Backquote:: Easier construction of list structure.
413 * Problems with Macros:: Don't evaluate the macro arguments too many times.
414 Don't hide the user's variables.
416 Loading
418 * How Programs Do Loading:: The @code{load} function and others.
419 * Autoload:: Setting up a function to autoload.
420 * Named Features:: Loading a library if it isn't already loaded.
421 * Repeated Loading:: Precautions about loading a file twice.
423 Byte Compilation
425 * Compilation Functions:: Byte compilation functions.
426 * Disassembly:: Disassembling byte-code; how to read byte-code.
428 Advising Functions
430 * Simple Advice:: A simple example to explain the basics of advice.
431 * Defining Advice:: Detailed description of @code{defadvice}.
432 * Computed Advice:: ...is to @code{defadvice} as @code{fset} is to @code{defun}.
433 * Activation of Advice:: Advice doesn't do anything until you activate it.
434 * Enabling Advice:: You can enable or disable each piece of advice.
435 * Preactivation:: Preactivation is a way of speeding up the
436 loading of compiled advice.
437 * Argument Access in Advice:: How advice can access the function's arguments.
438 * Subr Arguments:: Accessing arguments when advising a primitive.
439 * Combined Definition:: How advice is implemented.
441 Debugging Lisp Programs
443 * Debugger:: How the Emacs Lisp debugger is implemented.
444 * Syntax Errors:: How to find syntax errors.
445 * Compilation Errors:: How to find errors that show up in
446 byte compilation.
447 * Edebug:: A source-level Emacs Lisp debugger.
449 The Lisp Debugger
451 * Error Debugging:: Entering the debugger when an error happens.
452 * Function Debugging:: Entering it when a certain function is called.
453 * Explicit Debug:: Entering it at a certain point in the program.
454 * Using Debugger:: What the debugger does; what you see while in it.
455 * Debugger Commands:: Commands used while in the debugger.
456 * Invoking the Debugger:: How to call the function @code{debug}.
457 * Internals of Debugger:: Subroutines of the debugger, and global variables.
459 Debugging Invalid Lisp Syntax
461 * Excess Open:: How to find a spurious open paren or missing close.
462 * Excess Close:: How to find a spurious close paren or missing open.
464 Reading and Printing Lisp Objects
466 * Streams Intro:: Overview of streams, reading and printing.
467 * Input Streams:: Various data types that can be used as
468 input streams.
469 * Input Functions:: Functions to read Lisp objects from text.
470 * Output Streams:: Various data types that can be used as
471 output streams.
472 * Output Functions:: Functions to print Lisp objects as text.
474 Minibuffers
476 * Intro to Minibuffers:: Basic information about minibuffers.
477 * Text from Minibuffer:: How to read a straight text string.
478 * Object from Minibuffer:: How to read a Lisp object or expression.
479 * Completion:: How to invoke and customize completion.
480 * Yes-or-No Queries:: Asking a question with a simple answer.
481 * Minibuffer Misc:: Various customization hooks and variables.
483 Completion
485 * Basic Completion:: Low-level functions for completing strings.
486 (These are too low level to use the minibuffer.)
487 * Minibuffer Completion:: Invoking the minibuffer with completion.
488 * Completion Commands:: Minibuffer commands that do completion.
489 * High-Level Completion:: Convenient special cases of completion
490 (reading buffer name, file name, etc.)
491 * Reading File Names:: Using completion to read file names.
492 * Programmed Completion:: Finding the completions for a given file name.
494 Command Loop
496 * Command Overview:: How the command loop reads commands.
497 * Defining Commands:: Specifying how a function should read arguments.
498 * Interactive Call:: Calling a command, so that it will read arguments.
499 * Command Loop Info:: Variables set by the command loop for you to examine.
500 * Input Events:: What input looks like when you read it.
501 * Reading Input:: How to read input events from the keyboard or mouse.
502 * Waiting:: Waiting for user input or elapsed time.
503 * Quitting:: How @kbd{C-g} works. How to catch or defer quitting.
504 * Prefix Command Arguments:: How the commands to set prefix args work.
505 * Recursive Editing:: Entering a recursive edit,
506 and why you usually shouldn't.
507 * Disabling Commands:: How the command loop handles disabled commands.
508 * Command History:: How the command history is set up, and how accessed.
509 * Keyboard Macros:: How keyboard macros are implemented.
511 Defining Commands
513 * Using Interactive:: General rules for @code{interactive}.
514 * Interactive Codes:: The standard letter-codes for reading arguments
515 in various ways.
516 * Interactive Examples:: Examples of how to read interactive arguments.
518 Keymaps
520 * Keymap Terminology:: Definitions of terms pertaining to keymaps.
521 * Format of Keymaps:: What a keymap looks like as a Lisp object.
522 * Creating Keymaps:: Functions to create and copy keymaps.
523 * Inheritance and Keymaps:: How one keymap can inherit the bindings
524 of another keymap.
525 * Prefix Keys:: Defining a key with a keymap as its definition.
526 * Menu Keymaps:: A keymap can define a menu for X
527 or for use from the terminal.
528 * Active Keymaps:: Each buffer has a local keymap
529 to override the standard (global) bindings.
530 Each minor mode can also override them.
531 * Key Lookup:: How extracting elements from keymaps works.
532 * Functions for Key Lookup:: How to request key lookup.
533 * Changing Key Bindings:: Redefining a key in a keymap.
534 * Key Binding Commands:: Interactive interfaces for redefining keys.
535 * Scanning Keymaps:: Looking through all keymaps, for printing help.
537 Major and Minor Modes
539 * Major Modes:: Defining major modes.
540 * Minor Modes:: Defining minor modes.
541 * Mode Line Format:: Customizing the text that appears in the mode line.
542 * Hooks:: How to use hooks; how to write code that
543 provides hooks.
545 Major Modes
547 * Major Mode Conventions:: Coding conventions for keymaps, etc.
548 * Example Major Modes:: Text mode and Lisp modes.
549 * Auto Major Mode:: How Emacs chooses the major mode automatically.
550 * Mode Help:: Finding out how to use a mode.
552 Minor Modes
554 * Minor Mode Conventions:: Tips for writing a minor mode.
555 * Keymaps and Minor Modes:: How a minor mode can have its own keymap.
557 Mode Line Format
559 * Mode Line Data:: The data structure that controls the mode line.
560 * Mode Line Variables:: Variables used in that data structure.
561 * %-Constructs:: Putting information into a mode line.
563 Documentation
565 * Documentation Basics:: Good style for doc strings.
566 Where to put them. How Emacs stores them.
567 * Accessing Documentation:: How Lisp programs can access doc strings.
568 * Keys in Documentation:: Substituting current key bindings.
569 * Describing Characters:: Making printable descriptions of
570 non-printing characters and key sequences.
571 * Help Functions:: Subroutines used by Emacs help facilities.
573 Files
575 * Visiting Files:: Reading files into Emacs buffers for editing.
576 * Saving Buffers:: Writing changed buffers back into files.
577 * Reading from Files:: Reading files into other buffers.
578 * Writing to Files:: Writing new files from parts of buffers.
579 * File Locks:: Locking and unlocking files, to prevent
580 simultaneous editing by two people.
581 * Information about Files:: Testing existence, accessibility, size of files.
582 * Contents of Directories:: Getting a list of the files in a directory.
583 * Changing Files:: Renaming files, changing protection, etc.
584 * File Names:: Decomposing and expanding file names.
586 Visiting Files
588 * Visiting Functions:: The usual interface functions for visiting.
589 * Subroutines of Visiting:: Lower-level subroutines that they use.
591 Information about Files
593 * Testing Accessibility:: Is a given file readable? Writable?
594 * Kinds of Files:: Is it a directory? A link?
595 * File Attributes:: How large is it? Any other names? Etc.
597 File Names
599 * File Name Components:: The directory part of a file name, and the rest.
600 * Directory Names:: A directory's name as a directory
601 is different from its name as a file.
602 * Relative File Names:: Some file names are relative to a
603 current directory.
604 * File Name Expansion:: Converting relative file names to absolute ones.
605 * Unique File Names:: Generating names for temporary files.
606 * File Name Completion:: Finding the completions for a given file name.
608 Backups and Auto-Saving
610 * Backup Files:: How backup files are made; how their names
611 are chosen.
612 * Auto-Saving:: How auto-save files are made; how their
613 names are chosen.
614 * Reverting:: @code{revert-buffer}, and how to customize
615 what it does.
617 Backup Files
619 * Making Backups:: How Emacs makes backup files, and when.
620 * Rename or Copy:: Two alternatives: renaming the old file
621 or copying it.
622 * Numbered Backups:: Keeping multiple backups for each source file.
623 * Backup Names:: How backup file names are computed; customization.
625 Buffers
627 * Buffer Basics:: What is a buffer?
628 * Buffer Names:: Accessing and changing buffer names.
629 * Buffer File Name:: The buffer file name indicates which file
630 is visited.
631 * Buffer Modification:: A buffer is @dfn{modified} if it needs to be saved.
632 * Modification Time:: Determining whether the visited file was changed
633 ``behind Emacs's back''.
634 * Read Only Buffers:: Modifying text is not allowed in a
635 read-only buffer.
636 * The Buffer List:: How to look at all the existing buffers.
637 * Creating Buffers:: Functions that create buffers.
638 * Killing Buffers:: Buffers exist until explicitly killed.
639 * Current Buffer:: Designating a buffer as current
640 so primitives will access its contents.
642 Windows
644 * Basic Windows:: Basic information on using windows.
645 * Splitting Windows:: Splitting one window into two windows.
646 * Deleting Windows:: Deleting a window gives its space to other windows.
647 * Selecting Windows:: The selected window is the one that you edit in.
648 * Cyclic Window Ordering:: Moving around the existing windows.
649 * Buffers and Windows:: Each window displays the contents of a buffer.
650 * Displaying Buffers:: Higher-lever functions for displaying a buffer
651 and choosing a window for it.
652 * Window Point:: Each window has its own location of point.
653 * Window Start:: The display-start position controls which text
654 is on-screen in the window.
655 * Vertical Scrolling:: Moving text up and down in the window.
656 * Horizontal Scrolling:: Moving text sideways on the window.
657 * Size of Window:: Accessing the size of a window.
658 * Resizing Windows:: Changing the size of a window.
659 * Window Configurations:: Saving and restoring the state of the screen.
661 Frames
663 * Creating Frames:: Creating additional frames.
664 * Multiple Displays:: Creating frames on other X displays.
665 * Frame Parameters:: Controlling frame size, position, font, etc.
666 * Frame Titles:: Automatic updating of frame titles.
667 * Deleting Frames:: Frames last until explicitly deleted.
668 * Finding All Frames:: How to examine all existing frames.
669 * Frames and Windows:: A frame contains windows;
670 display of text always works through windows.
671 * Minibuffers and Frames:: How a frame finds the minibuffer to use.
672 * Input Focus:: Specifying the selected frame.
673 * Visibility of Frames:: Frames may be visible or invisible, or icons.
674 * Raising and Lowering:: Raising a frame makes it hide other X windows;
675 lowering it puts it underneath the others.
676 * Frame Configurations:: Saving the state of all frames.
677 * Mouse Tracking:: Getting events that say when the mouse moves.
678 * Mouse Position:: Asking where the mouse is, or moving it.
679 * Pop-Up Menus:: Displaying a menu for the user to select from.
680 * Dialog Boxes:: Displaying a box to ask yes or no.
681 * Pointer Shapes:: Specifying the shape of the mouse pointer.
682 * Window System Selections::Transferring text to and from other windows.
683 * Color Names:: Getting the definitions of color names.
684 * Resources:: Getting resource values from the server.
685 * Display Feature Testing:: Determining the features of a terminal.
687 Positions
689 * Point:: The special position where editing takes place.
690 * Motion:: Changing point.
691 * Excursions:: Temporary motion and buffer changes.
692 * Narrowing:: Restricting editing to a portion of the buffer.
694 Motion
696 * Character Motion:: Moving in terms of characters.
697 * Word Motion:: Moving in terms of words.
698 * Buffer End Motion:: Moving to the beginning or end of the buffer.
699 * Text Lines:: Moving in terms of lines of text.
700 * Screen Lines:: Moving in terms of lines as displayed.
701 * List Motion:: Moving by parsing lists and sexps.
702 * Skipping Characters:: Skipping characters belonging to a certain set.
704 Markers
706 * Overview of Markers:: The components of a marker, and how it relocates.
707 * Predicates on Markers:: Testing whether an object is a marker.
708 * Creating Markers:: Making empty markers or markers at certain places.
709 * Information from Markers:: Finding the marker's buffer or character
710 position.
711 * Moving Markers:: Moving the marker to a new buffer or position.
712 * The Mark:: How ``the mark'' is implemented with a marker.
713 * The Region:: How to access ``the region''.
715 Text
717 * Near Point:: Examining text in the vicinity of point.
718 * Buffer Contents:: Examining text in a general fashion.
719 * Insertion:: Adding new text to a buffer.
720 * Commands for Insertion:: User-level commands to insert text.
721 * Deletion:: Removing text from a buffer.
722 * User-Level Deletion:: User-level commands to delete text.
723 * The Kill Ring:: Where removed text sometimes is saved for
724 later use.
725 * Undo:: Undoing changes to the text of a buffer.
726 * Auto Filling:: How auto-fill mode is implemented to break lines.
727 * Filling:: Functions for explicit filling.
728 * Margins:: How to specify margins for filling commands.
729 * Sorting:: Functions for sorting parts of the buffer.
730 * Indentation:: Functions to insert or adjust indentation.
731 * Columns:: Computing horizontal positions, and using them.
732 * Case Changes:: Case conversion of parts of the buffer.
733 * Text Properties:: Assigning Lisp property lists to text characters.
734 * Substitution:: Replacing a given character wherever it appears.
735 * Transposition:: Swapping two portions of a buffer.
736 * Registers:: How registers are implemented. Accessing
737 the text or position stored in a register.
738 * Change Hooks:: Supplying functions to be run when text is changed.
740 The Kill Ring
742 * Kill Ring Concepts:: What text looks like in the kill ring.
743 * Kill Functions:: Functions that kill text.
744 * Yank Commands:: Commands that access the kill ring.
745 * Low-Level Kill Ring:: Functions and variables for kill ring access.
746 * Internals of Kill Ring:: Variables that hold kill-ring data.
748 Indentation
750 * Primitive Indent:: Functions used to count and insert indentation.
751 * Mode-Specific Indent:: Customize indentation for different modes.
752 * Region Indent:: Indent all the lines in a region.
753 * Relative Indent:: Indent the current line based on previous lines.
754 * Indent Tabs:: Adjustable, typewriter-like tab stops.
755 * Motion by Indent:: Move to first non-blank character.
757 Text Properties
759 * Examining Properties:: Looking at the properties of one character.
760 * Changing Properties:: Setting the properties of a range of text.
761 * Property Search:: Searching for where a property changes value.
762 * Special Properties:: Particular properties with special meanings.
763 * Format Properties:: Properties for representing formatting of text.
764 * Sticky Properties:: How inserted text gets properties from
765 neighboring text.
766 * Saving Properties:: Saving text properties in files, and reading
767 them back.
768 * Lazy Properties:: Computing text properties in a lazy fashion
769 only when text is examined.
770 * Clickable Text:: Using text properties to make regions of text
771 do something when you click on them.
772 * Fields:: The @code{field} property defines
773 fields within the buffer.
774 * Not Intervals:: Why text properties do not use
775 Lisp-visible text intervals.
777 Non-ASCII Characters
779 * Text Representations:: Unibyte and multibyte representations
780 * Converting Representations:: Converting unibyte to multibyte and vice versa.
781 * Selecting a Representation:: Treating a byte sequence as unibyte or multi.
782 * Character Codes:: How unibyte and multibyte relate to
783 codes of individual characters.
784 * Character Sets:: The space of possible characters codes
785 is divided into various character sets.
786 * Chars and Bytes:: More information about multibyte encodings.
787 * Splitting Characters:: Converting a character to its byte sequence.
788 * Scanning Charsets:: Which character sets are used in a buffer?
789 * Translation of Characters:: Translation tables are used for conversion.
790 * Coding Systems:: Coding systems are conversions for saving files.
791 * Input Methods:: Input methods allow users to enter various
792 non-ASCII characters without special keyboards.
793 * Locales:: Interacting with the POSIX locale.
795 Searching and Matching
797 * String Search:: Search for an exact match.
798 * Regular Expressions:: Describing classes of strings.
799 * Regexp Search:: Searching for a match for a regexp.
800 * Match Data:: Finding out which part of the text matched
801 various parts of a regexp, after regexp search.
802 * Saving Match Data:: Saving and restoring this information.
803 * Standard Regexps:: Useful regexps for finding sentences, pages,...
804 * Searching and Case:: Case-independent or case-significant searching.
806 Regular Expressions
808 * Syntax of Regexps:: Rules for writing regular expressions.
809 * Regexp Example:: Illustrates regular expression syntax.
811 Syntax Tables
813 * Syntax Descriptors:: How characters are classified.
814 * Syntax Table Functions:: How to create, examine and alter syntax tables.
815 * Parsing Expressions:: Parsing balanced expressions
816 using the syntax table.
817 * Standard Syntax Tables:: Syntax tables used by various major modes.
818 * Syntax Table Internals:: How syntax table information is stored.
820 Syntax Descriptors
822 * Syntax Class Table:: Table of syntax classes.
823 * Syntax Flags:: Additional flags each character can have.
825 Abbrevs And Abbrev Expansion
827 * Abbrev Mode:: Setting up Emacs for abbreviation.
828 * Tables: Abbrev Tables. Creating and working with abbrev tables.
829 * Defining Abbrevs:: Specifying abbreviations and their expansions.
830 * Files: Abbrev Files. Saving abbrevs in files.
831 * Expansion: Abbrev Expansion. Controlling expansion; expansion subroutines.
832 * Standard Abbrev Tables:: Abbrev tables used by various major modes.
834 Processes
836 * Subprocess Creation:: Functions that start subprocesses.
837 * Synchronous Processes:: Details of using synchronous subprocesses.
838 * Asynchronous Processes:: Starting up an asynchronous subprocess.
839 * Deleting Processes:: Eliminating an asynchronous subprocess.
840 * Process Information:: Accessing run-status and other attributes.
841 * Input to Processes:: Sending input to an asynchronous subprocess.
842 * Signals to Processes:: Stopping, continuing or interrupting
843 an asynchronous subprocess.
844 * Output from Processes:: Collecting output from an asynchronous subprocess.
845 * Sentinels:: Sentinels run when process run-status changes.
846 * Network:: Opening network connections.
848 Receiving Output from Processes
850 * Process Buffers:: If no filter, output is put in a buffer.
851 * Filter Functions:: Filter functions accept output from the process.
852 * Accepting Output:: How to wait until process output arrives.
854 Operating System Interface
856 * Starting Up:: Customizing Emacs start-up processing.
857 * Getting Out:: How exiting works (permanent or temporary).
858 * System Environment:: Distinguish the name and kind of system.
859 * Terminal Input:: Recording terminal input for debugging.
860 * Terminal Output:: Recording terminal output for debugging.
861 * Flow Control:: How to turn output flow control on or off.
862 * Batch Mode:: Running Emacs without terminal interaction.
864 Starting Up Emacs
866 * Startup Summary:: Sequence of actions Emacs performs at start-up.
867 * Init File:: Details on reading the init file (@file{.emacs}).
868 * Terminal-Specific:: How the terminal-specific Lisp file is read.
869 * Command-Line Arguments:: How command line arguments are processed,
870 and how you can customize them.
872 Getting out of Emacs
874 * Killing Emacs:: Exiting Emacs irreversibly.
875 * Suspending Emacs:: Exiting Emacs reversibly.
877 Emacs Display
879 * Refresh Screen:: Clearing the screen and redrawing everything on it.
880 * Truncation:: Folding or wrapping long text lines.
881 * The Echo Area:: Where messages are displayed.
882 * Selective Display:: Hiding part of the buffer text.
883 * Overlay Arrow:: Display of an arrow to indicate position.
884 * Temporary Displays:: Displays that go away automatically.
885 * Waiting:: Forcing display update and waiting for user.
886 * Blinking:: How Emacs shows the matching open parenthesis.
887 * Usual Display:: How control characters are displayed.
888 * Beeping:: Audible signal to the user.
889 * Window Systems:: Which window system is being used.
891 GNU Emacs Internals
893 * Building Emacs:: How to preload Lisp libraries into Emacs.
894 * Pure Storage:: A kludge to make preloaded Lisp functions sharable.
895 * Garbage Collection:: Reclaiming space for Lisp objects no longer used.
896 * Object Internals:: Data formats of buffers, windows, processes.
897 * Writing Emacs Primitives:: Writing C code for Emacs.
899 Object Internals
901 * Buffer Internals:: Components of a buffer structure.
902 * Window Internals:: Components of a window structure.
903 * Process Internals:: Components of a process structure.
904 @end menu
906 @include intro.texi
907 @include objects.texi
908 @include numbers.texi
909 @include strings.texi
911 @include lists.texi
912 @include sequences.texi
913 @include hash.texi
914 @include symbols.texi
915 @include eval.texi
917 @include control.texi
918 @include variables.texi
919 @include functions.texi
920 @include macros.texi
922 @include customize.texi
923 @include loading.texi
924 @include compile.texi
925 @include advice.texi
927 @include debugging.texi
928 @include streams.texi
929 @include minibuf.texi
930 @include commands.texi
932 @include keymaps.texi
933 @include modes.texi
934 @include help.texi
935 @include files.texi
937 @include backups.texi
938 @include buffers.texi
939 @include windows.texi
940 @include frames.texi
942 @include positions.texi
943 @include markers.texi
944 @include text.texi
945 @include nonascii.texi
947 @include searching.texi
948 @include syntax.texi
949 @include abbrevs.texi
950 @include processes.texi
952 @include display.texi
953 @include calendar.texi
954 @include os.texi
956 @c MOVE to Emacs Manual: include misc-modes.texi
958 @c appendices
960 @c REMOVE this: include non-hacker.texi
962 @include anti.texi
963 @include doclicense.texi
964 @include gpl.texi
965 @include tips.texi
966 @include internals.texi
967 @include errors.texi
968 @include locals.texi
969 @include maps.texi
970 @include hooks.texi
972 @include index.texi
974 @node New Symbols, , Index, Top
975 @unnumbered New Symbols Since the Previous Edition
977 @printindex tp
979 @c Print the tables of contents
980 @summarycontents
981 @contents
982 @c That's all
984 @bye
986 \f
987 These words prevent "local variables" above from confusing Emacs.