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