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