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