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