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