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