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