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