diff options
| author | Eli Zaretskii | 2001-11-17 14:47:50 +0000 |
|---|---|---|
| committer | Eli Zaretskii | 2001-11-17 14:47:50 +0000 |
| commit | ec641de95c4d2204260a3c9dc71a133955dbc2fb (patch) | |
| tree | ed4cbb90d93fb83c98ea12fbe6d7eca6acc37b90 | |
| parent | c689a8fb8b8fdad97dfa619f90e2c648eb240f04 (diff) | |
| download | emacs-ec641de95c4d2204260a3c9dc71a133955dbc2fb.tar.gz emacs-ec641de95c4d2204260a3c9dc71a133955dbc2fb.zip | |
Renamed to vol1.texi and vol2.texi.
| -rw-r--r-- | lispref/elisp-vol1.texi | 1047 | ||||
| -rw-r--r-- | lispref/elisp-vol2.texi | 1046 |
2 files changed, 0 insertions, 2093 deletions
diff --git a/lispref/elisp-vol1.texi b/lispref/elisp-vol1.texi deleted file mode 100644 index ddd4f776013..00000000000 --- a/lispref/elisp-vol1.texi +++ /dev/null | |||
| @@ -1,1047 +0,0 @@ | |||
| 1 | \input texinfo @c -*-texinfo-*- | ||
| 2 | @c %**start of header | ||
| 3 | @setfilename elisp | ||
| 4 | @settitle GNU Emacs Lisp Reference Manual: Volume 1 | ||
| 5 | @smallbook | ||
| 6 | @c %**end of header | ||
| 7 | |||
| 8 | |||
| 9 | @tex | ||
| 10 | %%%% Experiment with smaller skip before sections and subsections. | ||
| 11 | %%%% --rjc 30mar92 | ||
| 12 | |||
| 13 | \global\secheadingskip = 17pt plus 6pt minus 3pt | ||
| 14 | \global\subsecheadingskip = 14pt plus 6pt minus 3pt | ||
| 15 | |||
| 16 | % The defaults are: | ||
| 17 | % \secheadingskip = 21pt plus 8pt minus 4pt | ||
| 18 | % \subsecheadingskip = 17pt plus 8pt minus 4pt | ||
| 19 | @end tex | ||
| 20 | |||
| 21 | @finalout | ||
| 22 | @c tex | ||
| 23 | @c \overfullrule=0pt | ||
| 24 | @c end tex | ||
| 25 | |||
| 26 | @c Start volume 1 chapter numbering on chapter 1; | ||
| 27 | @c this must be listed as chapno 0. | ||
| 28 | @tex | ||
| 29 | \global\chapno=0 | ||
| 30 | @end tex | ||
| 31 | |||
| 32 | @c ================================================================ | ||
| 33 | @c Note: I was unable to figure out how to get .aux files copied | ||
| 34 | @c properly in the time I had. Hence need to copy .aux file before | ||
| 35 | @c running Tex. --rjc | ||
| 36 | |||
| 37 | @tex | ||
| 38 | |||
| 39 | \message{} | ||
| 40 | \message{Redefining contents commands...} | ||
| 41 | \message{} | ||
| 42 | |||
| 43 | % Special @contents command | ||
| 44 | |||
| 45 | % This inputs fixed up table of contents file rather than create new one. | ||
| 46 | \global\def\contents{% | ||
| 47 | \startcontents{Table of Contents}% | ||
| 48 | \input elisp1-toc-ready.toc | ||
| 49 | \endgroup | ||
| 50 | \vfill \eject | ||
| 51 | } | ||
| 52 | |||
| 53 | % Special @summarycontents command | ||
| 54 | % This inputs fixed up table of contents file rather than create new one. | ||
| 55 | \global\def\summarycontents{% | ||
| 56 | \startcontents{Short Contents}% | ||
| 57 | % | ||
| 58 | \let\chapentry = \shortchapentry | ||
| 59 | \let\unnumbchapentry = \shortunnumberedentry | ||
| 60 | % We want a true roman here for the page numbers. | ||
| 61 | \secfonts | ||
| 62 | \let\rm=\shortcontrm \let\bf=\shortcontbf \let\sl=\shortcontsl | ||
| 63 | \rm | ||
| 64 | \advance\baselineskip by 1pt % Open it up a little. | ||
| 65 | \def\secentry ##1##2##3##4{} | ||
| 66 | \def\unnumbsecentry ##1##2{} | ||
| 67 | \def\subsecentry ##1##2##3##4##5{} | ||
| 68 | \def\unnumbsubsecentry ##1##2{} | ||
| 69 | \def\subsubsecentry ##1##2##3##4##5##6{} | ||
| 70 | \def\unnumbsubsubsecentry ##1##2{} | ||
| 71 | \input elisp1-toc-ready.toc | ||
| 72 | \endgroup | ||
| 73 | \vfill \eject | ||
| 74 | } | ||
| 75 | |||
| 76 | \message{} | ||
| 77 | \message{Formatting special two volume edition...Volume 1...} | ||
| 78 | \message{} | ||
| 79 | @end tex | ||
| 80 | @c ================================================================ | ||
| 81 | |||
| 82 | |||
| 83 | @c ==> This `elisp-small.texi' is a `smallbook' version of the manual. | ||
| 84 | |||
| 85 | @c ==== Following are acceptable over and underfull hboxes in TeX ==== | ||
| 86 | |||
| 87 | @c ----- | ||
| 88 | @c [163] [164] [165] [166]) (loading.texi Chapter 13 [167] [168] [169] | ||
| 89 | @c Overfull \hbox (20.5428pt too wide) in paragraph at lines 131--131 | ||
| 90 | @c []@ninett | ||
| 91 | @c setenv EMAC-SLOAD-PATH .:/user/bil/emacs:/usr/local/lib/emacs/lisp[] | ||
| 92 | @c ----- | ||
| 93 | @c (minibuf.texi Chapter 17 [206] [207] [208] [209] [210] [211] [212] [213] | ||
| 94 | @c [214] [215] | ||
| 95 | @c Overfull \hbox (2.09094pt too wide) in paragraph at lines 550--560 | ||
| 96 | @c @texttt map[] @textrm if @textsl require-match @textrm is | ||
| 97 | @c @texttt nil[]@textrm , or else with the keymap @texttt minibuffer- | ||
| 98 | @c ----- | ||
| 99 | @c (locals.texi Appendix @char 68 [533] [534] | ||
| 100 | @c Underfull \hbox (badness 2512) in paragraph at lines 4--4 | ||
| 101 | @c []@chaprm Appendix DStandard Buffer-Local | ||
| 102 | |||
| 103 | @c ------------------------------------------------------------------- | ||
| 104 | |||
| 105 | @c | ||
| 106 | @c Combine indices. | ||
| 107 | @synindex cp fn | ||
| 108 | @syncodeindex vr fn | ||
| 109 | @syncodeindex ky fn | ||
| 110 | @syncodeindex pg fn | ||
| 111 | @syncodeindex tp fn | ||
| 112 | @c oops: texinfo-format-buffer ignores synindex | ||
| 113 | @c | ||
| 114 | |||
| 115 | @ifinfo | ||
| 116 | This file documents GNU Emacs Lisp. | ||
| 117 | |||
| 118 | @c The edition number appears in several places in this file | ||
| 119 | @c and also in the file intro.texi. | ||
| 120 | This is edition 2.4 of the GNU Emacs Lisp Reference | ||
| 121 | Manual. It corresponds to Emacs Version 19.29. | ||
| 122 | @c Please REMEMBER to update edition number in *four* places in this file | ||
| 123 | @c and also in *one* place in ==> intro.texi <== | ||
| 124 | @c huh? i only found three real places where the edition is stated, and | ||
| 125 | @c one place where it is not stated explicitly ("this info file is newer | ||
| 126 | @c than the foobar edition"). --mew 13sep93 | ||
| 127 | |||
| 128 | Published by the Free Software Foundation | ||
| 129 | 59 Temple Place, Suite 330 | ||
| 130 | Boston, MA 02111-1307 USA | ||
| 131 | |||
| 132 | Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995 Free Software Foundation, Inc. | ||
| 133 | |||
| 134 | Permission is granted to make and distribute verbatim copies of this | ||
| 135 | manual provided the copyright notice and this permission notice are | ||
| 136 | preserved on all copies. | ||
| 137 | |||
| 138 | @ignore | ||
| 139 | Permission is granted to process this file through TeX and print the | ||
| 140 | results, provided the printed document carries copying permission notice | ||
| 141 | identical to this one except for the removal of this paragraph (this | ||
| 142 | paragraph not being relevant to the printed manual). | ||
| 143 | |||
| 144 | @end ignore | ||
| 145 | Permission is granted to copy and distribute modified versions of this | ||
| 146 | manual under the conditions for verbatim copying, provided that the | ||
| 147 | entire resulting derived work is distributed under the terms of a | ||
| 148 | permission notice identical to this one. | ||
| 149 | |||
| 150 | Permission is granted to copy and distribute translations of this manual | ||
| 151 | into another language, under the above conditions for modified versions, | ||
| 152 | except that this permission notice may be stated in a translation | ||
| 153 | approved by the Foundation. | ||
| 154 | |||
| 155 | Permission is granted to copy and distribute modified versions of this | ||
| 156 | manual under the conditions for verbatim copying, provided also that the | ||
| 157 | section entitled ``GNU General Public License'' is included exactly as | ||
| 158 | in the original, and provided that the entire resulting derived work is | ||
| 159 | distributed under the terms of a permission notice identical to this | ||
| 160 | one. | ||
| 161 | |||
| 162 | Permission is granted to copy and distribute translations of this manual | ||
| 163 | into another language, under the above conditions for modified versions, | ||
| 164 | except that the section entitled ``GNU General Public License'' may be | ||
| 165 | included in a translation approved by the Free Software Foundation | ||
| 166 | instead of in the original English. | ||
| 167 | @end ifinfo | ||
| 168 | |||
| 169 | @setchapternewpage odd | ||
| 170 | |||
| 171 | @iftex | ||
| 172 | @shorttitlepage The GNU Emacs Lisp Reference Manual: Volume 1 | ||
| 173 | @end iftex | ||
| 174 | @titlepage | ||
| 175 | @sp 1 | ||
| 176 | @center @titlefont{The} | ||
| 177 | @sp 1 | ||
| 178 | @center @titlefont{GNU Emacs Lisp} | ||
| 179 | @sp 1 | ||
| 180 | @center @titlefont{Reference Manual} | ||
| 181 | @sp 2 | ||
| 182 | @center GNU Emacs Version 19.29 | ||
| 183 | @center for Unix Users | ||
| 184 | @sp 1 | ||
| 185 | @center Edition 2.4, June 1995 | ||
| 186 | @sp 2 | ||
| 187 | @center @titlefont{Volume 1} | ||
| 188 | @sp 3 | ||
| 189 | @center by Bil Lewis, Dan LaLiberte, | ||
| 190 | @center and the GNU Manual Group | ||
| 191 | @page | ||
| 192 | @vskip 0pt plus 1filll | ||
| 193 | Copyright @copyright{} 1990, 1991, 1992, 1993, 1994, 1995 Free Software Foundation, Inc. | ||
| 194 | |||
| 195 | @sp 2 | ||
| 196 | Edition 2.4 @* | ||
| 197 | Revised for Emacs Version 19.29,@* | ||
| 198 | June, 1995.@* | ||
| 199 | @sp 2 | ||
| 200 | ISBN 1-882114-71-X | ||
| 201 | |||
| 202 | @sp 2 | ||
| 203 | Published by the Free Software Foundation @* | ||
| 204 | 59 Temple Place, Suite 330 @* | ||
| 205 | Boston, MA 02111-1307 USA | ||
| 206 | |||
| 207 | @sp 1 | ||
| 208 | Permission is granted to make and distribute verbatim copies of this | ||
| 209 | manual provided the copyright notice and this permission notice are | ||
| 210 | preserved on all copies. | ||
| 211 | |||
| 212 | Permission is granted to copy and distribute modified versions of this | ||
| 213 | manual under the conditions for verbatim copying, provided also that the | ||
| 214 | section entitled ``GNU General Public License'' is included | ||
| 215 | exactly as in the original, and provided that the entire resulting | ||
| 216 | derived work is distributed under the terms of a permission notice | ||
| 217 | identical to this one. | ||
| 218 | |||
| 219 | Permission is granted to copy and distribute translations of this manual | ||
| 220 | into another language, under the above conditions for modified versions, | ||
| 221 | except that the section entitled ``GNU General Public License'' may be | ||
| 222 | included in a translation approved by the Free Software Foundation | ||
| 223 | instead of in the original English. | ||
| 224 | |||
| 225 | @sp 2 | ||
| 226 | Cover art by Etienne Suvasa. | ||
| 227 | @end titlepage | ||
| 228 | @page | ||
| 229 | |||
| 230 | @node Top, Copying, (dir), (dir) | ||
| 231 | |||
| 232 | @ifinfo | ||
| 233 | This Info file contains edition 2.4 of the GNU Emacs Lisp Reference | ||
| 234 | Manual, corresponding to GNU Emacs version 19.29. | ||
| 235 | @end ifinfo | ||
| 236 | |||
| 237 | @menu | ||
| 238 | * Copying:: Conditions for copying and changing GNU Emacs. | ||
| 239 | * Introduction:: Introduction and conventions used. | ||
| 240 | |||
| 241 | * Lisp Data Types:: Data types of objects in Emacs Lisp. | ||
| 242 | * Numbers:: Numbers and arithmetic functions. | ||
| 243 | * Strings and Characters:: Strings, and functions that work on them. | ||
| 244 | * Lists:: Lists, cons cells, and related functions. | ||
| 245 | * Sequences Arrays Vectors:: Lists, strings and vectors are called sequences. | ||
| 246 | Certain functions act on any kind of sequence. | ||
| 247 | The description of vectors is here as well. | ||
| 248 | * Symbols:: Symbols represent names, uniquely. | ||
| 249 | |||
| 250 | * Evaluation:: How Lisp expressions are evaluated. | ||
| 251 | * Control Structures:: Conditionals, loops, nonlocal exits. | ||
| 252 | * Variables:: Using symbols in programs to stand for values. | ||
| 253 | * Functions:: A function is a Lisp program | ||
| 254 | that can be invoked from other functions. | ||
| 255 | * Macros:: Macros are a way to extend the Lisp language. | ||
| 256 | |||
| 257 | * Loading:: Reading files of Lisp code into Lisp. | ||
| 258 | * Byte Compilation:: Compilation makes programs run faster. | ||
| 259 | * Debugging:: Tools and tips for debugging Lisp programs. | ||
| 260 | |||
| 261 | * Read and Print:: Converting Lisp objects to text and back. | ||
| 262 | * Minibuffers:: Using the minibuffer to read input. | ||
| 263 | * Command Loop:: How the editor command loop works, | ||
| 264 | and how you can call its subroutines. | ||
| 265 | * Keymaps:: Defining the bindings from keys to commands. | ||
| 266 | * Modes:: Defining major and minor modes. | ||
| 267 | * Documentation:: Writing and using documentation strings. | ||
| 268 | |||
| 269 | * Files:: Accessing files. | ||
| 270 | * Backups and Auto-Saving:: Controlling how backups and auto-save | ||
| 271 | files are made. | ||
| 272 | * Buffers:: Creating and using buffer objects. | ||
| 273 | * Windows:: Manipulating windows and displaying buffers. | ||
| 274 | * Frames:: Making multiple X windows. | ||
| 275 | * Positions:: Buffer positions and motion functions. | ||
| 276 | * Markers:: Markers represent positions and update | ||
| 277 | automatically when the text is changed. | ||
| 278 | |||
| 279 | * Text:: Examining and changing text in buffers. | ||
| 280 | * Searching and Matching:: Searching buffers for strings or regexps. | ||
| 281 | * Syntax Tables:: The syntax table controls word and list parsing. | ||
| 282 | * Abbrevs:: How Abbrev mode works, and its data structures. | ||
| 283 | |||
| 284 | * Processes:: Running and communicating with subprocesses. | ||
| 285 | * System Interface:: Getting the user id, system type, environment | ||
| 286 | variables, and other such things. | ||
| 287 | * Display:: Parameters controlling screen usage. | ||
| 288 | The bell. Waiting for input. | ||
| 289 | * Calendar:: Customizing the calendar and diary. | ||
| 290 | |||
| 291 | Appendices | ||
| 292 | |||
| 293 | * Tips:: Advice for writing Lisp programs. | ||
| 294 | * GNU Emacs Internals:: Building and dumping Emacs; | ||
| 295 | internal data structures. | ||
| 296 | * Standard Errors:: List of all error symbols. | ||
| 297 | * Standard Buffer-Local Variables:: List of variables local in all buffers. | ||
| 298 | * Standard Keymaps:: List of standard keymaps. | ||
| 299 | * Standard Hooks:: List of standard hook variables. | ||
| 300 | |||
| 301 | * Index:: Index including concepts, functions, variables, | ||
| 302 | and other terms. | ||
| 303 | |||
| 304 | --- The Detailed Node Listing --- | ||
| 305 | |||
| 306 | Here are other nodes that are inferiors of those already listed, | ||
| 307 | mentioned here so you can get to them in one step: | ||
| 308 | |||
| 309 | Introduction | ||
| 310 | |||
| 311 | * Caveats:: Flaws and a request for help. | ||
| 312 | * Lisp History:: Emacs Lisp is descended from Maclisp. | ||
| 313 | * Conventions:: How the manual is formatted. | ||
| 314 | * Acknowledgements:: The authors, editors, and sponsors of this manual. | ||
| 315 | |||
| 316 | Conventions | ||
| 317 | |||
| 318 | * Some Terms:: Explanation of terms we use in this manual. | ||
| 319 | * nil and t:: How the symbols @code{nil} and @code{t} are used. | ||
| 320 | * Evaluation Notation:: The format we use for examples of evaluation. | ||
| 321 | * Printing Notation:: The format we use for examples that print output. | ||
| 322 | * Error Messages:: The format we use for examples of errors. | ||
| 323 | * Buffer Text Notation:: The format we use for buffer contents in examples. | ||
| 324 | * Format of Descriptions:: Notation for describing functions, variables, etc. | ||
| 325 | |||
| 326 | Format of Descriptions | ||
| 327 | |||
| 328 | * A Sample Function Description:: | ||
| 329 | * A Sample Variable Description:: | ||
| 330 | |||
| 331 | Lisp Data Types | ||
| 332 | |||
| 333 | * Printed Representation:: How Lisp objects are represented as text. | ||
| 334 | * Comments:: Comments and their formatting conventions. | ||
| 335 | * Programming Types:: Types found in all Lisp systems. | ||
| 336 | * Editing Types:: Types specific to Emacs. | ||
| 337 | * Type Predicates:: Tests related to types. | ||
| 338 | * Equality Predicates:: Tests of equality between any two objects. | ||
| 339 | |||
| 340 | Programming Types | ||
| 341 | |||
| 342 | * Integer Type:: Numbers without fractional parts. | ||
| 343 | * Floating Point Type:: Numbers with fractional parts and with a large range. | ||
| 344 | * Character Type:: The representation of letters, numbers and | ||
| 345 | control characters. | ||
| 346 | * Sequence Type:: Both lists and arrays are classified as sequences. | ||
| 347 | * Cons Cell Type:: Cons cells, and lists (which are made from cons cells). | ||
| 348 | * Array Type:: Arrays include strings and vectors. | ||
| 349 | * String Type:: An (efficient) array of characters. | ||
| 350 | * Vector Type:: One-dimensional arrays. | ||
| 351 | * Symbol Type:: A multi-use object that refers to a function, | ||
| 352 | variable, property list, or itself. | ||
| 353 | * Function Type:: A piece of executable code you can call from elsewhere. | ||
| 354 | * Macro Type:: A method of expanding an expression into another | ||
| 355 | expression, more fundamental but less pretty. | ||
| 356 | * Primitive Function Type:: A function written in C, callable from Lisp. | ||
| 357 | * Byte-Code Type:: A function written in Lisp, then compiled. | ||
| 358 | * Autoload Type:: A type used for automatically loading seldom-used | ||
| 359 | functions. | ||
| 360 | |||
| 361 | List Type | ||
| 362 | |||
| 363 | * Dotted Pair Notation:: An alternative syntax for lists. | ||
| 364 | * Association List Type:: A specially constructed list. | ||
| 365 | |||
| 366 | Editing Types | ||
| 367 | |||
| 368 | * Buffer Type:: The basic object of editing. | ||
| 369 | * Window Type:: What makes buffers visible. | ||
| 370 | * Window Configuration Type::Save what the screen looks like. | ||
| 371 | * Marker Type:: A position in a buffer. | ||
| 372 | * Process Type:: A process running on the underlying OS. | ||
| 373 | * Stream Type:: Receive or send characters. | ||
| 374 | * Keymap Type:: What function a keystroke invokes. | ||
| 375 | * Syntax Table Type:: What a character means. | ||
| 376 | |||
| 377 | Numbers | ||
| 378 | |||
| 379 | * Integer Basics:: Representation and range of integers. | ||
| 380 | * Float Basics:: Representation and range of floating point. | ||
| 381 | * Predicates on Numbers:: Testing for numbers. | ||
| 382 | * Comparison of Numbers:: Equality and inequality predicates. | ||
| 383 | * Arithmetic Operations:: How to add, subtract, multiply and divide. | ||
| 384 | * Bitwise Operations:: Logical and, or, not, shifting. | ||
| 385 | * Numeric Conversions:: Converting float to integer and vice versa. | ||
| 386 | * Math Functions:: Trig, exponential and logarithmic functions. | ||
| 387 | * Random Numbers:: Obtaining random integers, predictable or not. | ||
| 388 | |||
| 389 | Strings and Characters | ||
| 390 | |||
| 391 | * String Basics:: Basic properties of strings and characters. | ||
| 392 | * Predicates for Strings:: Testing whether an object is a string or char. | ||
| 393 | * Creating Strings:: Functions to allocate new strings. | ||
| 394 | * Text Comparison:: Comparing characters or strings. | ||
| 395 | * String Conversion:: Converting characters or strings and vice versa. | ||
| 396 | * Formatting Strings:: @code{format}: Emacs's analog of @code{printf}. | ||
| 397 | * Character Case:: Case conversion functions. | ||
| 398 | |||
| 399 | Lists | ||
| 400 | |||
| 401 | * Cons Cells:: How lists are made out of cons cells. | ||
| 402 | * Lists as Boxes:: Graphical notation to explain lists. | ||
| 403 | * List-related Predicates:: Is this object a list? Comparing two lists. | ||
| 404 | * List Elements:: Extracting the pieces of a list. | ||
| 405 | * Building Lists:: Creating list structure. | ||
| 406 | * Modifying Lists:: Storing new pieces into an existing list. | ||
| 407 | * Sets And Lists:: A list can represent a finite mathematical set. | ||
| 408 | * Association Lists:: A list can represent a finite relation or mapping. | ||
| 409 | |||
| 410 | Modifying Existing List Structure | ||
| 411 | |||
| 412 | * Setcar:: Replacing an element in a list. | ||
| 413 | * Setcdr:: Replacing part of the list backbone. | ||
| 414 | This can be used to remove or add elements. | ||
| 415 | * Rearrangement:: Reordering the elements in a list; combining lists. | ||
| 416 | |||
| 417 | Sequences, Arrays, and Vectors | ||
| 418 | |||
| 419 | * Sequence Functions:: Functions that accept any kind of sequence. | ||
| 420 | * Arrays:: Characteristics of arrays in Emacs Lisp. | ||
| 421 | * Array Functions:: Functions specifically for arrays. | ||
| 422 | * Vectors:: Functions specifically for vectors. | ||
| 423 | |||
| 424 | Symbols | ||
| 425 | |||
| 426 | * Symbol Components:: Symbols have names, values, function definitions | ||
| 427 | and property lists. | ||
| 428 | * Definitions:: A definition says how a symbol will be used. | ||
| 429 | * Creating Symbols:: How symbols are kept unique. | ||
| 430 | * Property Lists:: Each symbol has a property list | ||
| 431 | for recording miscellaneous information. | ||
| 432 | |||
| 433 | Evaluation | ||
| 434 | |||
| 435 | * Intro Eval:: Evaluation in the scheme of things. | ||
| 436 | * Eval:: How to invoke the Lisp interpreter explicitly. | ||
| 437 | * Forms:: How various sorts of objects are evaluated. | ||
| 438 | * Quoting:: Avoiding evaluation (to put constants in | ||
| 439 | the program). | ||
| 440 | |||
| 441 | Kinds of Forms | ||
| 442 | |||
| 443 | * Self-Evaluating Forms:: Forms that evaluate to themselves. | ||
| 444 | * Symbol Forms:: Symbols evaluate as variables. | ||
| 445 | * Classifying Lists:: How to distinguish various sorts of list forms. | ||
| 446 | * Function Forms:: Forms that call functions. | ||
| 447 | * Macro Forms:: Forms that call macros. | ||
| 448 | * Special Forms:: ``Special forms'' are idiosyncratic primitives, | ||
| 449 | most of them extremely important. | ||
| 450 | * Autoloading:: Functions set up to load files | ||
| 451 | containing their real definitions. | ||
| 452 | |||
| 453 | Control Structures | ||
| 454 | |||
| 455 | * Sequencing:: Evaluation in textual order. | ||
| 456 | * Conditionals:: @code{if}, @code{cond}. | ||
| 457 | * Combining Conditions:: @code{and}, @code{or}, @code{not}. | ||
| 458 | * Iteration:: @code{while} loops. | ||
| 459 | * Nonlocal Exits:: Jumping out of a sequence. | ||
| 460 | |||
| 461 | Nonlocal Exits | ||
| 462 | |||
| 463 | * Catch and Throw:: Nonlocal exits for the program's own purposes. | ||
| 464 | * Examples of Catch:: Showing how such nonlocal exits can be written. | ||
| 465 | * Errors:: How errors are signaled and handled. | ||
| 466 | * Cleanups:: Arranging to run a cleanup form if an | ||
| 467 | error happens. | ||
| 468 | |||
| 469 | Errors | ||
| 470 | |||
| 471 | * Signaling Errors:: How to report an error. | ||
| 472 | * Processing of Errors:: What Emacs does when you report an error. | ||
| 473 | * Handling Errors:: How you can trap errors and continue execution. | ||
| 474 | * Error Symbols:: How errors are classified for trapping them. | ||
| 475 | |||
| 476 | Variables | ||
| 477 | |||
| 478 | * Global Variables:: Variable values that exist permanently, everywhere. | ||
| 479 | * Constant Variables:: Certain "variables" have values that never change. | ||
| 480 | * Local Variables:: Variable values that exist only temporarily. | ||
| 481 | * Void Variables:: Symbols that lack values. | ||
| 482 | * Defining Variables:: A definition says a symbol is used as a variable. | ||
| 483 | * Accessing Variables:: Examining values of variables whose names | ||
| 484 | are known only at run time. | ||
| 485 | * Setting Variables:: Storing new values in variables. | ||
| 486 | * Variable Scoping:: How Lisp chooses among local and global values. | ||
| 487 | * Buffer-Local Variables:: Variable values in effect only in one buffer. | ||
| 488 | |||
| 489 | Scoping Rules for Variable Bindings | ||
| 490 | |||
| 491 | * Scope:: Scope means where in the program a value | ||
| 492 | is visible. Comparison with other languages. | ||
| 493 | * Extent:: Extent means how long in time a value exists. | ||
| 494 | * Impl of Scope:: Two ways to implement dynamic scoping. | ||
| 495 | * Using Scoping:: How to use dynamic scoping carefully and | ||
| 496 | avoid problems. | ||
| 497 | |||
| 498 | Buffer-Local Variables | ||
| 499 | |||
| 500 | * Intro to Buffer-Local:: Introduction and concepts. | ||
| 501 | * Creating Buffer-Local:: Creating and destroying buffer-local bindings. | ||
| 502 | * Default Value:: The default value is seen in buffers | ||
| 503 | that don't have their own local values. | ||
| 504 | |||
| 505 | Functions | ||
| 506 | |||
| 507 | * What Is a Function:: Lisp functions vs primitives; terminology. | ||
| 508 | * Lambda Expressions:: How functions are expressed as Lisp objects. | ||
| 509 | * Function Names:: A symbol can serve as the name of a function. | ||
| 510 | * Defining Functions:: Lisp expressions for defining functions. | ||
| 511 | * Calling Functions:: How to use an existing function. | ||
| 512 | * Mapping Functions:: Applying a function to each element of a list, etc. | ||
| 513 | * Anonymous Functions:: Lambda-expressions are functions with no names. | ||
| 514 | * Function Cells:: Accessing or setting the function definition | ||
| 515 | of a symbol. | ||
| 516 | * Related Topics:: Cross-references to specific Lisp primitives | ||
| 517 | that have a special bearing on how | ||
| 518 | functions work. | ||
| 519 | |||
| 520 | Lambda Expressions | ||
| 521 | |||
| 522 | * Lambda Components:: The parts of a lambda expression. | ||
| 523 | * Simple Lambda:: A simple example. | ||
| 524 | * Argument List:: Details and special features of argument lists. | ||
| 525 | * Function Documentation:: How to put documentation in a function. | ||
| 526 | |||
| 527 | Macros | ||
| 528 | |||
| 529 | * Simple Macro:: A basic example. | ||
| 530 | * Expansion:: How, when and why macros are expanded. | ||
| 531 | * Compiling Macros:: How macros are expanded by the compiler. | ||
| 532 | * Defining Macros:: How to write a macro definition. | ||
| 533 | * Backquote:: Easier construction of list structure. | ||
| 534 | * Problems with Macros:: Don't evaluate the macro arguments too many times. | ||
| 535 | Don't hide the user's variables. | ||
| 536 | |||
| 537 | Loading | ||
| 538 | |||
| 539 | * How Programs Do Loading:: The @code{load} function and others. | ||
| 540 | * Autoload:: Setting up a function to autoload. | ||
| 541 | * Named Features:: Loading a library if it isn't already loaded. | ||
| 542 | * Repeated Loading:: Precautions about loading a file twice. | ||
| 543 | |||
| 544 | Byte Compilation | ||
| 545 | |||
| 546 | * Compilation Functions:: Byte compilation functions. | ||
| 547 | * Disassembly:: Disassembling byte-code; how to read byte-code. | ||
| 548 | |||
| 549 | Debugging Lisp Programs | ||
| 550 | |||
| 551 | * Debugger:: How the Emacs Lisp debugger is implemented. | ||
| 552 | * Syntax Errors:: How to find syntax errors. | ||
| 553 | * Compilation Errors:: How to find errors that show up in | ||
| 554 | byte compilation. | ||
| 555 | * Edebug:: A source-level Emacs Lisp debugger. | ||
| 556 | |||
| 557 | The Lisp Debugger | ||
| 558 | |||
| 559 | * Error Debugging:: Entering the debugger when an error happens. | ||
| 560 | * Function Debugging:: Entering it when a certain function is called. | ||
| 561 | * Explicit Debug:: Entering it at a certain point in the program. | ||
| 562 | * Using Debugger:: What the debugger does; what you see while in it. | ||
| 563 | * Debugger Commands:: Commands used while in the debugger. | ||
| 564 | * Invoking the Debugger:: How to call the function @code{debug}. | ||
| 565 | * Internals of Debugger:: Subroutines of the debugger, and global variables. | ||
| 566 | |||
| 567 | Debugging Invalid Lisp Syntax | ||
| 568 | |||
| 569 | * Excess Open:: How to find a spurious open paren or missing close. | ||
| 570 | * Excess Close:: How to find a spurious close paren or missing open. | ||
| 571 | |||
| 572 | Reading and Printing Lisp Objects | ||
| 573 | |||
| 574 | * Streams Intro:: Overview of streams, reading and printing. | ||
| 575 | * Input Streams:: Various data types that can be used as | ||
| 576 | input streams. | ||
| 577 | * Input Functions:: Functions to read Lisp objects from text. | ||
| 578 | * Output Streams:: Various data types that can be used as | ||
| 579 | output streams. | ||
| 580 | * Output Functions:: Functions to print Lisp objects as text. | ||
| 581 | |||
| 582 | Minibuffers | ||
| 583 | |||
| 584 | * Intro to Minibuffers:: Basic information about minibuffers. | ||
| 585 | * Text from Minibuffer:: How to read a straight text string. | ||
| 586 | * Object from Minibuffer:: How to read a Lisp object or expression. | ||
| 587 | * Completion:: How to invoke and customize completion. | ||
| 588 | * Yes-or-No Queries:: Asking a question with a simple answer. | ||
| 589 | * Minibuffer Misc:: Various customization hooks and variables. | ||
| 590 | |||
| 591 | Completion | ||
| 592 | |||
| 593 | * Basic Completion:: Low-level functions for completing strings. | ||
| 594 | (These are too low level to use the minibuffer.) | ||
| 595 | * Minibuffer Completion:: Invoking the minibuffer with completion. | ||
| 596 | * Completion Commands:: Minibuffer commands that do completion. | ||
| 597 | * High-Level Completion:: Convenient special cases of completion | ||
| 598 | (reading buffer name, file name, etc.) | ||
| 599 | * Reading File Names:: Using completion to read file names. | ||
| 600 | * Programmed Completion:: Finding the completions for a given file name. | ||
| 601 | |||
| 602 | Command Loop | ||
| 603 | |||
| 604 | * Command Overview:: How the command loop reads commands. | ||
| 605 | * Defining Commands:: Specifying how a function should read arguments. | ||
| 606 | * Interactive Call:: Calling a command, so that it will read arguments. | ||
| 607 | * Command Loop Info:: Variables set by the command loop for you to examine. | ||
| 608 | * Input Events:: What input looks like when you read it. | ||
| 609 | * Reading Input:: How to read input events from the keyboard or mouse. | ||
| 610 | * Waiting:: Waiting for user input or elapsed time. | ||
| 611 | * Quitting:: How @kbd{C-g} works. How to catch or defer quitting. | ||
| 612 | * Prefix Command Arguments:: How the commands to set prefix args work. | ||
| 613 | * Recursive Editing:: Entering a recursive edit, | ||
| 614 | and why you usually shouldn't. | ||
| 615 | * Disabling Commands:: How the command loop handles disabled commands. | ||
| 616 | * Command History:: How the command history is set up, and how accessed. | ||
| 617 | * Keyboard Macros:: How keyboard macros are implemented. | ||
| 618 | |||
| 619 | Defining Commands | ||
| 620 | |||
| 621 | * Using Interactive:: General rules for @code{interactive}. | ||
| 622 | * Interactive Codes:: The standard letter-codes for reading arguments | ||
| 623 | in various ways. | ||
| 624 | * Interactive Examples:: Examples of how to read interactive arguments. | ||
| 625 | |||
| 626 | Keymaps | ||
| 627 | |||
| 628 | * Keymap Terminology:: Definitions of terms pertaining to keymaps. | ||
| 629 | * Format of Keymaps:: What a keymap looks like as a Lisp object. | ||
| 630 | * Creating Keymaps:: Functions to create and copy keymaps. | ||
| 631 | * Inheritance and Keymaps:: How one keymap can inherit the bindings | ||
| 632 | of another keymap. | ||
| 633 | * Prefix Keys:: Defining a key with a keymap as its definition. | ||
| 634 | * Menu Keymaps:: A keymap can define a menu for X | ||
| 635 | or for use from the terminal. | ||
| 636 | * Active Keymaps:: Each buffer has a local keymap | ||
| 637 | to override the standard (global) bindings. | ||
| 638 | Each minor mode can also override them. | ||
| 639 | * Key Lookup:: How extracting elements from keymaps works. | ||
| 640 | * Functions for Key Lookup:: How to request key lookup. | ||
| 641 | * Changing Key Bindings:: Redefining a key in a keymap. | ||
| 642 | * Key Binding Commands:: Interactive interfaces for redefining keys. | ||
| 643 | * Scanning Keymaps:: Looking through all keymaps, for printing help. | ||
| 644 | |||
| 645 | Major and Minor Modes | ||
| 646 | |||
| 647 | * Major Modes:: Defining major modes. | ||
| 648 | * Minor Modes:: Defining minor modes. | ||
| 649 | * Mode Line Format:: Customizing the text that appears in the mode line. | ||
| 650 | * Hooks:: How to use hooks; how to write code that | ||
| 651 | provides hooks. | ||
| 652 | |||
| 653 | Major Modes | ||
| 654 | |||
| 655 | * Major Mode Conventions:: Coding conventions for keymaps, etc. | ||
| 656 | * Example Major Modes:: Text mode and Lisp modes. | ||
| 657 | * Auto Major Mode:: How Emacs chooses the major mode automatically. | ||
| 658 | * Mode Help:: Finding out how to use a mode. | ||
| 659 | |||
| 660 | Minor Modes | ||
| 661 | |||
| 662 | * Minor Mode Conventions:: Tips for writing a minor mode. | ||
| 663 | * Keymaps and Minor Modes:: How a minor mode can have its own keymap. | ||
| 664 | |||
| 665 | Mode Line Format | ||
| 666 | |||
| 667 | * Mode Line Data:: The data structure that controls the mode line. | ||
| 668 | * Mode Line Variables:: Variables used in that data structure. | ||
| 669 | * %-Constructs:: Putting information into a mode line. | ||
| 670 | |||
| 671 | Documentation | ||
| 672 | |||
| 673 | * Documentation Basics:: Good style for doc strings. | ||
| 674 | Where to put them. How Emacs stores them. | ||
| 675 | * Accessing Documentation:: How Lisp programs can access doc strings. | ||
| 676 | * Keys in Documentation:: Substituting current key bindings. | ||
| 677 | * Describing Characters:: Making printable descriptions of | ||
| 678 | non-printing characters and key sequences. | ||
| 679 | * Help Functions:: Subroutines used by Emacs help facilities. | ||
| 680 | |||
| 681 | Files | ||
| 682 | |||
| 683 | * Visiting Files:: Reading files into Emacs buffers for editing. | ||
| 684 | * Saving Buffers:: Writing changed buffers back into files. | ||
| 685 | * Reading from Files:: Reading files into other buffers. | ||
| 686 | * Writing to Files:: Writing new files from parts of buffers. | ||
| 687 | * File Locks:: Locking and unlocking files, to prevent | ||
| 688 | simultaneous editing by two people. | ||
| 689 | * Information about Files:: Testing existence, accessibility, size of files. | ||
| 690 | * Contents of Directories:: Getting a list of the files in a directory. | ||
| 691 | * Changing File Attributes:: Renaming files, changing protection, etc. | ||
| 692 | * File Names:: Decomposing and expanding file names. | ||
| 693 | |||
| 694 | Visiting Files | ||
| 695 | |||
| 696 | * Visiting Functions:: The usual interface functions for visiting. | ||
| 697 | * Subroutines of Visiting:: Lower-level subroutines that they use. | ||
| 698 | |||
| 699 | Information about Files | ||
| 700 | |||
| 701 | * Testing Accessibility:: Is a given file readable? Writable? | ||
| 702 | * Kinds of Files:: Is it a directory? A link? | ||
| 703 | * File Attributes:: How large is it? Any other names? Etc. | ||
| 704 | |||
| 705 | File Names | ||
| 706 | |||
| 707 | * File Name Components:: The directory part of a file name, and the rest. | ||
| 708 | * Directory Names:: A directory's name as a directory | ||
| 709 | is different from its name as a file. | ||
| 710 | * Relative File Names:: Some file names are relative to a | ||
| 711 | current directory. | ||
| 712 | * File Name Expansion:: Converting relative file names to absolute ones. | ||
| 713 | * Unique File Names:: Generating names for temporary files. | ||
| 714 | * File Name Completion:: Finding the completions for a given file name. | ||
| 715 | |||
| 716 | Backups and Auto-Saving | ||
| 717 | |||
| 718 | * Backup Files:: How backup files are made; how their names | ||
| 719 | are chosen. | ||
| 720 | * Auto-Saving:: How auto-save files are made; how their | ||
| 721 | names are chosen. | ||
| 722 | * Reverting:: @code{revert-buffer}, and how to customize | ||
| 723 | what it does. | ||
| 724 | |||
| 725 | Backup Files | ||
| 726 | |||
| 727 | * Making Backups:: How Emacs makes backup files, and when. | ||
| 728 | * Rename or Copy:: Two alternatives: renaming the old file | ||
| 729 | or copying it. | ||
| 730 | * Numbered Backups:: Keeping multiple backups for each source file. | ||
| 731 | * Backup Names:: How backup file names are computed; customization. | ||
| 732 | |||
| 733 | Buffers | ||
| 734 | |||
| 735 | * Buffer Basics:: What is a buffer? | ||
| 736 | * Buffer Names:: Accessing and changing buffer names. | ||
| 737 | * Buffer File Name:: The buffer file name indicates which file | ||
| 738 | is visited. | ||
| 739 | * Buffer Modification:: A buffer is @dfn{modified} if it needs to be saved. | ||
| 740 | * Modification Time:: Determining whether the visited file was changed | ||
| 741 | ``behind Emacs's back''. | ||
| 742 | * Read Only Buffers:: Modifying text is not allowed in a | ||
| 743 | read-only buffer. | ||
| 744 | * The Buffer List:: How to look at all the existing buffers. | ||
| 745 | * Creating Buffers:: Functions that create buffers. | ||
| 746 | * Killing Buffers:: Buffers exist until explicitly killed. | ||
| 747 | * Current Buffer:: Designating a buffer as current | ||
| 748 | so primitives will access its contents. | ||
| 749 | |||
| 750 | Windows | ||
| 751 | |||
| 752 | * Basic Windows:: Basic information on using windows. | ||
| 753 | * Splitting Windows:: Splitting one window into two windows. | ||
| 754 | * Deleting Windows:: Deleting a window gives its space to other windows. | ||
| 755 | * Selecting Windows:: The selected window is the one that you edit in. | ||
| 756 | * Cyclic Window Ordering:: Moving around the existing windows. | ||
| 757 | * Buffers and Windows:: Each window displays the contents of a buffer. | ||
| 758 | * Displaying Buffers:: Higher-lever functions for displaying a buffer | ||
| 759 | and choosing a window for it. | ||
| 760 | * Window Point:: Each window has its own location of point. | ||
| 761 | * Window Start:: The display-start position controls which text | ||
| 762 | is on-screen in the window. | ||
| 763 | * Vertical Scrolling:: Moving text up and down in the window. | ||
| 764 | * Horizontal Scrolling:: Moving text sideways on the window. | ||
| 765 | * Size of Window:: Accessing the size of a window. | ||
| 766 | * Resizing Windows:: Changing the size of a window. | ||
| 767 | * Window Configurations:: Saving and restoring the state of the screen. | ||
| 768 | |||
| 769 | Frames | ||
| 770 | |||
| 771 | * Creating Frames:: Creating additional frames. | ||
| 772 | * Multiple Displays:: Creating frames on other X displays. | ||
| 773 | * Frame Parameters:: Controlling frame size, position, font, etc. | ||
| 774 | * Frame Titles:: Automatic updating of frame titles. | ||
| 775 | * Deleting Frames:: Frames last until explicitly deleted. | ||
| 776 | * Finding All Frames:: How to examine all existing frames. | ||
| 777 | * Frames and Windows:: A frame contains windows; | ||
| 778 | display of text always works through windows. | ||
| 779 | * Minibuffers and Frames:: How a frame finds the minibuffer to use. | ||
| 780 | * Input Focus:: Specifying the selected frame. | ||
| 781 | * Visibility of Frames:: Frames may be visible or invisible, or icons. | ||
| 782 | * Raising and Lowering:: Raising a frame makes it hide other X windows; | ||
| 783 | lowering it makes the others hide them. | ||
| 784 | * Frame Configurations:: Saving the state of all frames. | ||
| 785 | * Mouse Tracking:: Getting events that say when the mouse moves. | ||
| 786 | * Mouse Position:: Asking where the mouse is, or moving it. | ||
| 787 | * Pop-Up Menus:: Displaying a menu for the user to select from. | ||
| 788 | * Dialog Boxes:: Displaying a box to ask yes or no. | ||
| 789 | * Pointer Shapes:: Specifying the shape of the mouse pointer. | ||
| 790 | * X Selections:: Transferring text to and from other X clients. | ||
| 791 | * Color Names:: Getting the definitions of color names. | ||
| 792 | * Resources:: Getting resource values from the server. | ||
| 793 | * Server Data:: Getting info about the X server. | ||
| 794 | |||
| 795 | Positions | ||
| 796 | |||
| 797 | * Point:: The special position where editing takes place. | ||
| 798 | * Motion:: Changing point. | ||
| 799 | * Excursions:: Temporary motion and buffer changes. | ||
| 800 | * Narrowing:: Restricting editing to a portion of the buffer. | ||
| 801 | |||
| 802 | Motion | ||
| 803 | |||
| 804 | * Character Motion:: Moving in terms of characters. | ||
| 805 | * Word Motion:: Moving in terms of words. | ||
| 806 | * Buffer End Motion:: Moving to the beginning or end of the buffer. | ||
| 807 | * Text Lines:: Moving in terms of lines of text. | ||
| 808 | * Screen Lines:: Moving in terms of lines as displayed. | ||
| 809 | * List Motion:: Moving by parsing lists and sexps. | ||
| 810 | * Skipping Characters:: Skipping characters belonging to a certain set. | ||
| 811 | |||
| 812 | Markers | ||
| 813 | |||
| 814 | * Overview of Markers:: The components of a marker, and how it relocates. | ||
| 815 | * Predicates on Markers:: Testing whether an object is a marker. | ||
| 816 | * Creating Markers:: Making empty markers or markers at certain places. | ||
| 817 | * Information from Markers:: Finding the marker's buffer or character | ||
| 818 | position. | ||
| 819 | * Changing Markers:: Moving the marker to a new buffer or position. | ||
| 820 | * The Mark:: How ``the mark'' is implemented with a marker. | ||
| 821 | * The Region:: How to access ``the region''. | ||
| 822 | |||
| 823 | Text | ||
| 824 | |||
| 825 | * Near Point:: Examining text in the vicinity of point. | ||
| 826 | * Buffer Contents:: Examining text in a general fashion. | ||
| 827 | * Insertion:: Adding new text to a buffer. | ||
| 828 | * Commands for Insertion:: User-level commands to insert text. | ||
| 829 | * Deletion:: Removing text from a buffer. | ||
| 830 | * User-Level Deletion:: User-level commands to delete text. | ||
| 831 | * The Kill Ring:: Where removed text sometimes is saved for | ||
| 832 | later use. | ||
| 833 | * Undo:: Undoing changes to the text of a buffer. | ||
| 834 | * Auto Filling:: How auto-fill mode is implemented to break lines. | ||
| 835 | * Filling:: Functions for explicit filling. | ||
| 836 | * Margins:: How to specify margins for filling commands. | ||
| 837 | * Sorting:: Functions for sorting parts of the buffer. | ||
| 838 | * Indentation:: Functions to insert or adjust indentation. | ||
| 839 | * Columns:: Computing horizontal positions, and using them. | ||
| 840 | * Case Changes:: Case conversion of parts of the buffer. | ||
| 841 | * Substitution:: Replacing a given character wherever it appears. | ||
| 842 | * Registers:: How registers are implemented. Accessing | ||
| 843 | the text or position stored in a register. | ||
| 844 | |||
| 845 | The Kill Ring | ||
| 846 | |||
| 847 | * Kill Ring Concepts:: What text looks like in the kill ring. | ||
| 848 | * Kill Functions:: Functions that kill text. | ||
| 849 | * Yank Commands:: Commands that access the kill ring. | ||
| 850 | * Low-Level Kill Ring:: Functions and variables for kill ring access. | ||
| 851 | * Internals of Kill Ring:: Variables that hold kill-ring data. | ||
| 852 | |||
| 853 | Indentation | ||
| 854 | |||
| 855 | * Primitive Indent:: Functions used to count and insert indentation. | ||
| 856 | * Mode-Specific Indent:: Customize indentation for different modes. | ||
| 857 | * Region Indent:: Indent all the lines in a region. | ||
| 858 | * Relative Indent:: Indent the current line based on previous lines. | ||
| 859 | * Indent Tabs:: Adjustable, typewriter-like tab stops. | ||
| 860 | * Motion by Indent:: Move to first non-blank character. | ||
| 861 | |||
| 862 | Searching and Matching | ||
| 863 | |||
| 864 | * String Search:: Search for an exact match. | ||
| 865 | * Regular Expressions:: Describing classes of strings. | ||
| 866 | * Regexp Search:: Searching for a match for a regexp. | ||
| 867 | * Match Data:: Finding out which part of the text matched | ||
| 868 | various parts of a regexp, after regexp search. | ||
| 869 | * Saving Match Data:: Saving and restoring this information. | ||
| 870 | * Standard Regexps:: Useful regexps for finding sentences, pages,... | ||
| 871 | * Searching and Case:: Case-independent or case-significant searching. | ||
| 872 | |||
| 873 | Regular Expressions | ||
| 874 | |||
| 875 | * Syntax of Regexps:: Rules for writing regular expressions. | ||
| 876 | * Regexp Example:: Illustrates regular expression syntax. | ||
| 877 | |||
| 878 | Syntax Tables | ||
| 879 | |||
| 880 | * Syntax Descriptors:: How characters are classified. | ||
| 881 | * Syntax Table Functions:: How to create, examine and alter syntax tables. | ||
| 882 | * Parsing Expressions:: Parsing balanced expressions | ||
| 883 | using the syntax table. | ||
| 884 | * Standard Syntax Tables:: Syntax tables used by various major modes. | ||
| 885 | * Syntax Table Internals:: How syntax table information is stored. | ||
| 886 | |||
| 887 | Syntax Descriptors | ||
| 888 | |||
| 889 | * Syntax Class Table:: Table of syntax classes. | ||
| 890 | * Syntax Flags:: Additional flags each character can have. | ||
| 891 | |||
| 892 | Abbrevs And Abbrev Expansion | ||
| 893 | |||
| 894 | * Abbrev Mode:: Setting up Emacs for abbreviation. | ||
| 895 | * Tables: Abbrev Tables. Creating and working with abbrev tables. | ||
| 896 | * Defining Abbrevs:: Specifying abbreviations and their expansions. | ||
| 897 | * Files: Abbrev Files. Saving abbrevs in files. | ||
| 898 | * Expansion: Abbrev Expansion. Controlling expansion; expansion subroutines. | ||
| 899 | * Standard Abbrev Tables:: Abbrev tables used by various major modes. | ||
| 900 | |||
| 901 | Processes | ||
| 902 | |||
| 903 | * Subprocess Creation:: Functions that start subprocesses. | ||
| 904 | * Synchronous Processes:: Details of using synchronous subprocesses. | ||
| 905 | * Asynchronous Processes:: Starting up an asynchronous subprocess. | ||
| 906 | * Deleting Processes:: Eliminating an asynchronous subprocess. | ||
| 907 | * Process Information:: Accessing run-status and other attributes. | ||
| 908 | * Input to Processes:: Sending input to an asynchronous subprocess. | ||
| 909 | * Signals to Processes:: Stopping, continuing or interrupting | ||
| 910 | an asynchronous subprocess. | ||
| 911 | * Output from Processes:: Collecting output from an asynchronous subprocess. | ||
| 912 | * Sentinels:: Sentinels run when process run-status changes. | ||
| 913 | * Network:: Opening network connections. | ||
| 914 | |||
| 915 | Receiving Output from Processes | ||
| 916 | |||
| 917 | * Process Buffers:: If no filter, output is put in a buffer. | ||
| 918 | * Filter Functions:: Filter functions accept output from the process. | ||
| 919 | * Accepting Output:: How to wait until process output arrives. | ||
| 920 | |||
| 921 | Operating System Interface | ||
| 922 | |||
| 923 | * Starting Up:: Customizing Emacs start-up processing. | ||
| 924 | * Getting Out:: How exiting works (permanent or temporary). | ||
| 925 | * System Environment:: Distinguish the name and kind of system. | ||
| 926 | * Terminal Input:: Recording terminal input for debugging. | ||
| 927 | * Terminal Output:: Recording terminal output for debugging. | ||
| 928 | * Flow Control:: How to turn output flow control on or off. | ||
| 929 | * Batch Mode:: Running Emacs without terminal interaction. | ||
| 930 | |||
| 931 | Starting Up Emacs | ||
| 932 | |||
| 933 | * Start-up Summary:: Sequence of actions Emacs performs at start-up. | ||
| 934 | * Init File:: Details on reading the init file (@file{.emacs}). | ||
| 935 | * Terminal-Specific:: How the terminal-specific Lisp file is read. | ||
| 936 | * Command Line Arguments:: How command line arguments are processed, | ||
| 937 | and how you can customize them. | ||
| 938 | |||
| 939 | Getting out of Emacs | ||
| 940 | |||
| 941 | * Killing Emacs:: Exiting Emacs irreversibly. | ||
| 942 | * Suspending Emacs:: Exiting Emacs reversibly. | ||
| 943 | |||
| 944 | Emacs Display | ||
| 945 | |||
| 946 | * Refresh Screen:: Clearing the screen and redrawing everything on it. | ||
| 947 | * Truncation:: Folding or wrapping long text lines. | ||
| 948 | * The Echo Area:: Where messages are displayed. | ||
| 949 | * Selective Display:: Hiding part of the buffer text. | ||
| 950 | * Overlay Arrow:: Display of an arrow to indicate position. | ||
| 951 | * Temporary Displays:: Displays that go away automatically. | ||
| 952 | * Waiting:: Forcing display update and waiting for user. | ||
| 953 | * Blinking:: How Emacs shows the matching open parenthesis. | ||
| 954 | * Usual Display:: How control characters are displayed. | ||
| 955 | * Beeping:: Audible signal to the user. | ||
| 956 | * Window Systems:: Which window system is being used. | ||
| 957 | |||
| 958 | GNU Emacs Internals | ||
| 959 | |||
| 960 | * Building Emacs:: How to preload Lisp libraries into Emacs. | ||
| 961 | * Pure Storage:: A kludge to make preloaded Lisp functions sharable. | ||
| 962 | * Garbage Collection:: Reclaiming space for Lisp objects no longer used. | ||
| 963 | * Object Internals:: Data formats of buffers, windows, processes. | ||
| 964 | * Writing Emacs Primitives:: Writing C code for Emacs. | ||
| 965 | |||
| 966 | Object Internals | ||
| 967 | |||
| 968 | * Buffer Internals:: Components of a buffer structure. | ||
| 969 | * Window Internals:: Components of a window structure. | ||
| 970 | * Process Internals:: Components of a process structure. | ||
| 971 | @end menu | ||
| 972 | |||
| 973 | @c ================ Volume 1 ================ | ||
| 974 | |||
| 975 | @include intro.texi | ||
| 976 | @include objects.texi | ||
| 977 | @include numbers.texi | ||
| 978 | @include strings.texi | ||
| 979 | |||
| 980 | @include lists.texi | ||
| 981 | @include sequences.texi | ||
| 982 | @include symbols.texi | ||
| 983 | @include eval.texi | ||
| 984 | |||
| 985 | @include control.texi | ||
| 986 | @include variables.texi | ||
| 987 | @include functions.texi | ||
| 988 | @include macros.texi | ||
| 989 | |||
| 990 | @include loading.texi | ||
| 991 | @include compile.texi | ||
| 992 | @include debugging.texi | ||
| 993 | @include streams.texi | ||
| 994 | |||
| 995 | @include minibuf.texi | ||
| 996 | @include commands.texi | ||
| 997 | @include keymaps.texi | ||
| 998 | @include modes.texi | ||
| 999 | |||
| 1000 | @c ================ Beginning of Volume 2 ================ | ||
| 1001 | |||
| 1002 | @c include help.texi | ||
| 1003 | @c include files.texi | ||
| 1004 | @c include backups.texi | ||
| 1005 | @c include buffers.texi | ||
| 1006 | |||
| 1007 | @c include windows.texi | ||
| 1008 | @c include frames.texi | ||
| 1009 | @c include positions.texi | ||
| 1010 | @c include markers.texi | ||
| 1011 | @c include text.texi | ||
| 1012 | |||
| 1013 | @c include searching.texi | ||
| 1014 | @c include syntax.texi | ||
| 1015 | @c include abbrevs.texi | ||
| 1016 | |||
| 1017 | @c include processes.texi | ||
| 1018 | @c include os.texi | ||
| 1019 | @c include display.texi | ||
| 1020 | @c include calendar.texi | ||
| 1021 | |||
| 1022 | @c MOVE to Emacs Manual: include misc-modes.texi | ||
| 1023 | |||
| 1024 | @c appendices | ||
| 1025 | |||
| 1026 | @c REMOVE this: include non-hacker.texi | ||
| 1027 | |||
| 1028 | @c include tips.texi | ||
| 1029 | @c include internals.texi | ||
| 1030 | @c include errors.texi | ||
| 1031 | @c include locals.texi | ||
| 1032 | @c include maps.texi | ||
| 1033 | @c include hooks.texi | ||
| 1034 | @c include anti.texi | ||
| 1035 | |||
| 1036 | @include index-vol1.texi | ||
| 1037 | |||
| 1038 | @page | ||
| 1039 | @c Print the tables of contents | ||
| 1040 | @summarycontents | ||
| 1041 | @contents | ||
| 1042 | @c That's all | ||
| 1043 | |||
| 1044 | @bye | ||
| 1045 | |||
| 1046 | |||
| 1047 | These words prevent "local variables" above from confusing Emacs. | ||
diff --git a/lispref/elisp-vol2.texi b/lispref/elisp-vol2.texi deleted file mode 100644 index 93e677ced58..00000000000 --- a/lispref/elisp-vol2.texi +++ /dev/null | |||
| @@ -1,1046 +0,0 @@ | |||
| 1 | \input texinfo @c -*-texinfo-*- | ||
| 2 | @c %**start of header | ||
| 3 | @setfilename elisp | ||
| 4 | @settitle GNU Emacs Lisp Reference Manual: Volume 2 | ||
| 5 | @smallbook | ||
| 6 | @c %**end of header | ||
| 7 | |||
| 8 | |||
| 9 | @tex | ||
| 10 | %%%% Experiment with smaller skip before sections and subsections. | ||
| 11 | %%%% --rjc 30mar92 | ||
| 12 | |||
| 13 | \global\secheadingskip = 17pt plus 6pt minus 3pt | ||
| 14 | \global\subsecheadingskip = 14pt plus 6pt minus 3pt | ||
| 15 | |||
| 16 | % The defaults are: | ||
| 17 | % \secheadingskip = 21pt plus 8pt minus 4pt | ||
| 18 | % \subsecheadingskip = 17pt plus 8pt minus 4pt | ||
| 19 | @end tex | ||
| 20 | |||
| 21 | @finalout | ||
| 22 | @c tex | ||
| 23 | @c \overfullrule=0pt | ||
| 24 | @c end tex | ||
| 25 | |||
| 26 | @c Start volume 2 chapter numbering on chapter 21; | ||
| 27 | @c this must be listed as chapno 20. | ||
| 28 | @tex | ||
| 29 | \global\chapno=20 | ||
| 30 | @end tex | ||
| 31 | |||
| 32 | @c ================================================================ | ||
| 33 | @c Note: I was unable to figure out how to get .aux files copied | ||
| 34 | @c properly in the time I had. Hence need to copy .aux file before | ||
| 35 | @c running Tex. --rjc | ||
| 36 | |||
| 37 | @tex | ||
| 38 | |||
| 39 | \message{} | ||
| 40 | \message{Redefining contents commands...} | ||
| 41 | \message{} | ||
| 42 | |||
| 43 | % Special @contents command | ||
| 44 | |||
| 45 | % This inputs fixed up table of contents file rather than create new one. | ||
| 46 | \global\def\contents{% | ||
| 47 | \startcontents{Table of Contents}% | ||
| 48 | \input elisp2-toc-ready.toc | ||
| 49 | \endgroup | ||
| 50 | \vfill \eject | ||
| 51 | } | ||
| 52 | |||
| 53 | % Special @summarycontents command | ||
| 54 | % This inputs fixed up table of contents file rather than create new one. | ||
| 55 | \global\def\summarycontents{% | ||
| 56 | \startcontents{Short Contents}% | ||
| 57 | % | ||
| 58 | \let\chapentry = \shortchapentry | ||
| 59 | \let\unnumbchapentry = \shortunnumberedentry | ||
| 60 | % We want a true roman here for the page numbers. | ||
| 61 | \secfonts | ||
| 62 | \let\rm=\shortcontrm \let\bf=\shortcontbf \let\sl=\shortcontsl | ||
| 63 | \rm | ||
| 64 | \advance\baselineskip by 1pt % Open it up a little. | ||
| 65 | \def\secentry ##1##2##3##4{} | ||
| 66 | \def\unnumbsecentry ##1##2{} | ||
| 67 | \def\subsecentry ##1##2##3##4##5{} | ||
| 68 | \def\unnumbsubsecentry ##1##2{} | ||
| 69 | \def\subsubsecentry ##1##2##3##4##5##6{} | ||
| 70 | \def\unnumbsubsubsecentry ##1##2{} | ||
| 71 | \input elisp2-toc-ready.toc | ||
| 72 | \endgroup | ||
| 73 | \vfill \eject | ||
| 74 | } | ||
| 75 | |||
| 76 | \message{} | ||
| 77 | \message{Formatting special two volume edition...Volume 2...} | ||
| 78 | \message{} | ||
| 79 | @end tex | ||
| 80 | @c ================================================================ | ||
| 81 | |||
| 82 | |||
| 83 | @c ==> This `elisp-small.texi' is a `smallbook' version of the manual. | ||
| 84 | |||
| 85 | @c ==== Following are acceptable over and underfull hboxes in TeX ==== | ||
| 86 | |||
| 87 | @c ----- | ||
| 88 | @c [163] [164] [165] [166]) (loading.texi Chapter 13 [167] [168] [169] | ||
| 89 | @c Overfull \hbox (20.5428pt too wide) in paragraph at lines 131--131 | ||
| 90 | @c []@ninett | ||
| 91 | @c setenv EMAC-SLOAD-PATH .:/user/bil/emacs:/usr/local/lib/emacs/lisp[] | ||
| 92 | @c ----- | ||
| 93 | @c (minibuf.texi Chapter 17 [206] [207] [208] [209] [210] [211] [212] [213] | ||
| 94 | @c [214] [215] | ||
| 95 | @c Overfull \hbox (2.09094pt too wide) in paragraph at lines 550--560 | ||
| 96 | @c @texttt map[] @textrm if @textsl require-match @textrm is | ||
| 97 | @c @texttt nil[]@textrm , or else with the keymap @texttt minibuffer- | ||
| 98 | @c ----- | ||
| 99 | @c (locals.texi Appendix @char 68 [533] [534] | ||
| 100 | @c Underfull \hbox (badness 2512) in paragraph at lines 4--4 | ||
| 101 | @c []@chaprm Appendix DStandard Buffer-Local | ||
| 102 | |||
| 103 | @c ------------------------------------------------------------------- | ||
| 104 | |||
| 105 | @c | ||
| 106 | @c Combine indices. | ||
| 107 | @synindex cp fn | ||
| 108 | @syncodeindex vr fn | ||
| 109 | @syncodeindex ky fn | ||
| 110 | @syncodeindex pg fn | ||
| 111 | @syncodeindex tp fn | ||
| 112 | @c oops: texinfo-format-buffer ignores synindex | ||
| 113 | @c | ||
| 114 | |||
| 115 | @ifinfo | ||
| 116 | This file documents GNU Emacs Lisp. | ||
| 117 | |||
| 118 | @c The edition number appears in several places in this file | ||
| 119 | @c and also in the file intro.texi. | ||
| 120 | This is edition 2.4 of the GNU Emacs Lisp Reference | ||
| 121 | Manual. It corresponds to Emacs Version 19.29. | ||
| 122 | @c Please REMEMBER to update edition number in *four* places in this file | ||
| 123 | @c and also in *one* place in ==> intro.texi <== | ||
| 124 | @c huh? i only found three real places where the edition is stated, and | ||
| 125 | @c one place where it is not stated explicitly ("this info file is newer | ||
| 126 | @c than the foobar edition"). --mew 13sep93 | ||
| 127 | |||
| 128 | Published by the Free Software Foundation | ||
| 129 | 59 Temple Place, Suite 330 | ||
| 130 | Boston, MA 02111-1307 USA | ||
| 131 | |||
| 132 | Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995 Free Software Foundation, Inc. | ||
| 133 | |||
| 134 | Permission is granted to make and distribute verbatim copies of this | ||
| 135 | manual provided the copyright notice and this permission notice are | ||
| 136 | preserved on all copies. | ||
| 137 | |||
| 138 | @ignore | ||
| 139 | Permission is granted to process this file through TeX and print the | ||
| 140 | results, provided the printed document carries copying permission notice | ||
| 141 | identical to this one except for the removal of this paragraph (this | ||
| 142 | paragraph not being relevant to the printed manual). | ||
| 143 | |||
| 144 | @end ignore | ||
| 145 | Permission is granted to copy and distribute modified versions of this | ||
| 146 | manual under the conditions for verbatim copying, provided that the | ||
| 147 | entire resulting derived work is distributed under the terms of a | ||
| 148 | permission notice identical to this one. | ||
| 149 | |||
| 150 | Permission is granted to copy and distribute translations of this manual | ||
| 151 | into another language, under the above conditions for modified versions, | ||
| 152 | except that this permission notice may be stated in a translation | ||
| 153 | approved by the Foundation. | ||
| 154 | |||
| 155 | Permission is granted to copy and distribute modified versions of this | ||
| 156 | manual under the conditions for verbatim copying, provided also that the | ||
| 157 | section entitled ``GNU General Public License'' is included exactly as | ||
| 158 | in the original, and provided that the entire resulting derived work is | ||
| 159 | distributed under the terms of a permission notice identical to this | ||
| 160 | one. | ||
| 161 | |||
| 162 | Permission is granted to copy and distribute translations of this manual | ||
| 163 | into another language, under the above conditions for modified versions, | ||
| 164 | except that the section entitled ``GNU General Public License'' may be | ||
| 165 | included in a translation approved by the Free Software Foundation | ||
| 166 | instead of in the original English. | ||
| 167 | @end ifinfo | ||
| 168 | |||
| 169 | @setchapternewpage odd | ||
| 170 | |||
| 171 | @iftex | ||
| 172 | @shorttitlepage The GNU Emacs Lisp Reference Manual: Volume 2 | ||
| 173 | @end iftex | ||
| 174 | @titlepage | ||
| 175 | @sp 1 | ||
| 176 | @center @titlefont{The} | ||
| 177 | @sp 1 | ||
| 178 | @center @titlefont{GNU Emacs Lisp} | ||
| 179 | @sp 1 | ||
| 180 | @center @titlefont{Reference Manual} | ||
| 181 | @sp 2 | ||
| 182 | @center GNU Emacs Version 19.29 | ||
| 183 | @center for Unix Users | ||
| 184 | @sp 1 | ||
| 185 | @center Edition 2.4, June 1995 | ||
| 186 | @sp 2 | ||
| 187 | @center @titlefont{Volume 2} | ||
| 188 | @sp 3 | ||
| 189 | @center by Bil Lewis, Dan LaLiberte, | ||
| 190 | @center and the GNU Manual Group | ||
| 191 | @page | ||
| 192 | @vskip 0pt plus 1filll | ||
| 193 | Copyright @copyright{} 1990, 1991, 1992, 1993, 1994, 1995 Free Software Foundation, Inc. | ||
| 194 | |||
| 195 | @sp 2 | ||
| 196 | Edition 2.4 @* | ||
| 197 | Revised for Emacs Version 19.29,@* | ||
| 198 | June, 1995.@* | ||
| 199 | @sp 2 | ||
| 200 | ISBN 1-882114-71-X | ||
| 201 | |||
| 202 | @sp 2 | ||
| 203 | Published by the Free Software Foundation @* | ||
| 204 | 59 Temple Place, Suite 330 @* | ||
| 205 | Boston, MA 02111-1307 USA | ||
| 206 | |||
| 207 | @sp 1 | ||
| 208 | Permission is granted to make and distribute verbatim copies of this | ||
| 209 | manual provided the copyright notice and this permission notice are | ||
| 210 | preserved on all copies. | ||
| 211 | |||
| 212 | Permission is granted to copy and distribute modified versions of this | ||
| 213 | manual under the conditions for verbatim copying, provided also that the | ||
| 214 | section entitled ``GNU General Public License'' is included | ||
| 215 | exactly as in the original, and provided that the entire resulting | ||
| 216 | derived work is distributed under the terms of a permission notice | ||
| 217 | identical to this one. | ||
| 218 | |||
| 219 | Permission is granted to copy and distribute translations of this manual | ||
| 220 | into another language, under the above conditions for modified versions, | ||
| 221 | except that the section entitled ``GNU General Public License'' may be | ||
| 222 | included in a translation approved by the Free Software Foundation | ||
| 223 | instead of in the original English. | ||
| 224 | |||
| 225 | @sp 2 | ||
| 226 | Cover art by Etienne Suvasa. | ||
| 227 | @end titlepage | ||
| 228 | @page | ||
| 229 | |||
| 230 | @node Top, Copying, (dir), (dir) | ||
| 231 | |||
| 232 | @ifinfo | ||
| 233 | This Info file contains edition 2.4 of the GNU Emacs Lisp Reference | ||
| 234 | Manual, corresponding to GNU Emacs version 19.29. | ||
| 235 | @end ifinfo | ||
| 236 | |||
| 237 | @menu | ||
| 238 | * Copying:: Conditions for copying and changing GNU Emacs. | ||
| 239 | * Introduction:: Introduction and conventions used. | ||
| 240 | |||
| 241 | * Lisp Data Types:: Data types of objects in Emacs Lisp. | ||
| 242 | * Numbers:: Numbers and arithmetic functions. | ||
| 243 | * Strings and Characters:: Strings, and functions that work on them. | ||
| 244 | * Lists:: Lists, cons cells, and related functions. | ||
| 245 | * Sequences Arrays Vectors:: Lists, strings and vectors are called sequences. | ||
| 246 | Certain functions act on any kind of sequence. | ||
| 247 | The description of vectors is here as well. | ||
| 248 | * Symbols:: Symbols represent names, uniquely. | ||
| 249 | |||
| 250 | * Evaluation:: How Lisp expressions are evaluated. | ||
| 251 | * Control Structures:: Conditionals, loops, nonlocal exits. | ||
| 252 | * Variables:: Using symbols in programs to stand for values. | ||
| 253 | * Functions:: A function is a Lisp program | ||
| 254 | that can be invoked from other functions. | ||
| 255 | * Macros:: Macros are a way to extend the Lisp language. | ||
| 256 | |||
| 257 | * Loading:: Reading files of Lisp code into Lisp. | ||
| 258 | * Byte Compilation:: Compilation makes programs run faster. | ||
| 259 | * Debugging:: Tools and tips for debugging Lisp programs. | ||
| 260 | |||
| 261 | * Read and Print:: Converting Lisp objects to text and back. | ||
| 262 | * Minibuffers:: Using the minibuffer to read input. | ||
| 263 | * Command Loop:: How the editor command loop works, | ||
| 264 | and how you can call its subroutines. | ||
| 265 | * Keymaps:: Defining the bindings from keys to commands. | ||
| 266 | * Modes:: Defining major and minor modes. | ||
| 267 | * Documentation:: Writing and using documentation strings. | ||
| 268 | |||
| 269 | * Files:: Accessing files. | ||
| 270 | * Backups and Auto-Saving:: Controlling how backups and auto-save | ||
| 271 | files are made. | ||
| 272 | * Buffers:: Creating and using buffer objects. | ||
| 273 | * Windows:: Manipulating windows and displaying buffers. | ||
| 274 | * Frames:: Making multiple X windows. | ||
| 275 | * Positions:: Buffer positions and motion functions. | ||
| 276 | * Markers:: Markers represent positions and update | ||
| 277 | automatically when the text is changed. | ||
| 278 | |||
| 279 | * Text:: Examining and changing text in buffers. | ||
| 280 | * Searching and Matching:: Searching buffers for strings or regexps. | ||
| 281 | * Syntax Tables:: The syntax table controls word and list parsing. | ||
| 282 | * Abbrevs:: How Abbrev mode works, and its data structures. | ||
| 283 | |||
| 284 | * Processes:: Running and communicating with subprocesses. | ||
| 285 | * System Interface:: Getting the user id, system type, environment | ||
| 286 | variables, and other such things. | ||
| 287 | * Display:: Parameters controlling screen usage. | ||
| 288 | The bell. Waiting for input. | ||
| 289 | * Calendar:: Customizing the calendar and diary. | ||
| 290 | |||
| 291 | Appendices | ||
| 292 | |||
| 293 | * Tips:: Advice for writing Lisp programs. | ||
| 294 | * GNU Emacs Internals:: Building and dumping Emacs; | ||
| 295 | internal data structures. | ||
| 296 | * Standard Errors:: List of all error symbols. | ||
| 297 | * Standard Buffer-Local Variables:: List of variables local in all buffers. | ||
| 298 | * Standard Keymaps:: List of standard keymaps. | ||
| 299 | * Standard Hooks:: List of standard hook variables. | ||
| 300 | |||
| 301 | * Index:: Index including concepts, functions, variables, | ||
| 302 | and other terms. | ||
| 303 | |||
| 304 | --- The Detailed Node Listing --- | ||
| 305 | |||
| 306 | Here are other nodes that are inferiors of those already listed, | ||
| 307 | mentioned here so you can get to them in one step: | ||
| 308 | |||
| 309 | Introduction | ||
| 310 | |||
| 311 | * Caveats:: Flaws and a request for help. | ||
| 312 | * Lisp History:: Emacs Lisp is descended from Maclisp. | ||
| 313 | * Conventions:: How the manual is formatted. | ||
| 314 | * Acknowledgements:: The authors, editors, and sponsors of this manual. | ||
| 315 | |||
| 316 | Conventions | ||
| 317 | |||
| 318 | * Some Terms:: Explanation of terms we use in this manual. | ||
| 319 | * nil and t:: How the symbols @code{nil} and @code{t} are used. | ||
| 320 | * Evaluation Notation:: The format we use for examples of evaluation. | ||
| 321 | * Printing Notation:: The format we use for examples that print output. | ||
| 322 | * Error Messages:: The format we use for examples of errors. | ||
| 323 | * Buffer Text Notation:: The format we use for buffer contents in examples. | ||
| 324 | * Format of Descriptions:: Notation for describing functions, variables, etc. | ||
| 325 | |||
| 326 | Format of Descriptions | ||
| 327 | |||
| 328 | * A Sample Function Description:: | ||
| 329 | * A Sample Variable Description:: | ||
| 330 | |||
| 331 | Lisp Data Types | ||
| 332 | |||
| 333 | * Printed Representation:: How Lisp objects are represented as text. | ||
| 334 | * Comments:: Comments and their formatting conventions. | ||
| 335 | * Programming Types:: Types found in all Lisp systems. | ||
| 336 | * Editing Types:: Types specific to Emacs. | ||
| 337 | * Type Predicates:: Tests related to types. | ||
| 338 | * Equality Predicates:: Tests of equality between any two objects. | ||
| 339 | |||
| 340 | Programming Types | ||
| 341 | |||
| 342 | * Integer Type:: Numbers without fractional parts. | ||
| 343 | * Floating Point Type:: Numbers with fractional parts and with a large range. | ||
| 344 | * Character Type:: The representation of letters, numbers and | ||
| 345 | control characters. | ||
| 346 | * Sequence Type:: Both lists and arrays are classified as sequences. | ||
| 347 | * Cons Cell Type:: Cons cells, and lists (which are made from cons cells). | ||
| 348 | * Array Type:: Arrays include strings and vectors. | ||
| 349 | * String Type:: An (efficient) array of characters. | ||
| 350 | * Vector Type:: One-dimensional arrays. | ||
| 351 | * Symbol Type:: A multi-use object that refers to a function, | ||
| 352 | variable, property list, or itself. | ||
| 353 | * Function Type:: A piece of executable code you can call from elsewhere. | ||
| 354 | * Macro Type:: A method of expanding an expression into another | ||
| 355 | expression, more fundamental but less pretty. | ||
| 356 | * Primitive Function Type:: A function written in C, callable from Lisp. | ||
| 357 | * Byte-Code Type:: A function written in Lisp, then compiled. | ||
| 358 | * Autoload Type:: A type used for automatically loading seldom-used | ||
| 359 | functions. | ||
| 360 | |||
| 361 | List Type | ||
| 362 | |||
| 363 | * Dotted Pair Notation:: An alternative syntax for lists. | ||
| 364 | * Association List Type:: A specially constructed list. | ||
| 365 | |||
| 366 | Editing Types | ||
| 367 | |||
| 368 | * Buffer Type:: The basic object of editing. | ||
| 369 | * Window Type:: What makes buffers visible. | ||
| 370 | * Window Configuration Type::Save what the screen looks like. | ||
| 371 | * Marker Type:: A position in a buffer. | ||
| 372 | * Process Type:: A process running on the underlying OS. | ||
| 373 | * Stream Type:: Receive or send characters. | ||
| 374 | * Keymap Type:: What function a keystroke invokes. | ||
| 375 | * Syntax Table Type:: What a character means. | ||
| 376 | |||
| 377 | Numbers | ||
| 378 | |||
| 379 | * Integer Basics:: Representation and range of integers. | ||
| 380 | * Float Basics:: Representation and range of floating point. | ||
| 381 | * Predicates on Numbers:: Testing for numbers. | ||
| 382 | * Comparison of Numbers:: Equality and inequality predicates. | ||
| 383 | * Arithmetic Operations:: How to add, subtract, multiply and divide. | ||
| 384 | * Bitwise Operations:: Logical and, or, not, shifting. | ||
| 385 | * Numeric Conversions:: Converting float to integer and vice versa. | ||
| 386 | * Math Functions:: Trig, exponential and logarithmic functions. | ||
| 387 | * Random Numbers:: Obtaining random integers, predictable or not. | ||
| 388 | |||
| 389 | Strings and Characters | ||
| 390 | |||
| 391 | * String Basics:: Basic properties of strings and characters. | ||
| 392 | * Predicates for Strings:: Testing whether an object is a string or char. | ||
| 393 | * Creating Strings:: Functions to allocate new strings. | ||
| 394 | * Text Comparison:: Comparing characters or strings. | ||
| 395 | * String Conversion:: Converting characters or strings and vice versa. | ||
| 396 | * Formatting Strings:: @code{format}: Emacs's analog of @code{printf}. | ||
| 397 | * Character Case:: Case conversion functions. | ||
| 398 | |||
| 399 | Lists | ||
| 400 | |||
| 401 | * Cons Cells:: How lists are made out of cons cells. | ||
| 402 | * Lists as Boxes:: Graphical notation to explain lists. | ||
| 403 | * List-related Predicates:: Is this object a list? Comparing two lists. | ||
| 404 | * List Elements:: Extracting the pieces of a list. | ||
| 405 | * Building Lists:: Creating list structure. | ||
| 406 | * Modifying Lists:: Storing new pieces into an existing list. | ||
| 407 | * Sets And Lists:: A list can represent a finite mathematical set. | ||
| 408 | * Association Lists:: A list can represent a finite relation or mapping. | ||
| 409 | |||
| 410 | Modifying Existing List Structure | ||
| 411 | |||
| 412 | * Setcar:: Replacing an element in a list. | ||
| 413 | * Setcdr:: Replacing part of the list backbone. | ||
| 414 | This can be used to remove or add elements. | ||
| 415 | * Rearrangement:: Reordering the elements in a list; combining lists. | ||
| 416 | |||
| 417 | Sequences, Arrays, and Vectors | ||
| 418 | |||
| 419 | * Sequence Functions:: Functions that accept any kind of sequence. | ||
| 420 | * Arrays:: Characteristics of arrays in Emacs Lisp. | ||
| 421 | * Array Functions:: Functions specifically for arrays. | ||
| 422 | * Vectors:: Functions specifically for vectors. | ||
| 423 | |||
| 424 | Symbols | ||
| 425 | |||
| 426 | * Symbol Components:: Symbols have names, values, function definitions | ||
| 427 | and property lists. | ||
| 428 | * Definitions:: A definition says how a symbol will be used. | ||
| 429 | * Creating Symbols:: How symbols are kept unique. | ||
| 430 | * Property Lists:: Each symbol has a property list | ||
| 431 | for recording miscellaneous information. | ||
| 432 | |||
| 433 | Evaluation | ||
| 434 | |||
| 435 | * Intro Eval:: Evaluation in the scheme of things. | ||
| 436 | * Eval:: How to invoke the Lisp interpreter explicitly. | ||
| 437 | * Forms:: How various sorts of objects are evaluated. | ||
| 438 | * Quoting:: Avoiding evaluation (to put constants in | ||
| 439 | the program). | ||
| 440 | |||
| 441 | Kinds of Forms | ||
| 442 | |||
| 443 | * Self-Evaluating Forms:: Forms that evaluate to themselves. | ||
| 444 | * Symbol Forms:: Symbols evaluate as variables. | ||
| 445 | * Classifying Lists:: How to distinguish various sorts of list forms. | ||
| 446 | * Function Forms:: Forms that call functions. | ||
| 447 | * Macro Forms:: Forms that call macros. | ||
| 448 | * Special Forms:: ``Special forms'' are idiosyncratic primitives, | ||
| 449 | most of them extremely important. | ||
| 450 | * Autoloading:: Functions set up to load files | ||
| 451 | containing their real definitions. | ||
| 452 | |||
| 453 | Control Structures | ||
| 454 | |||
| 455 | * Sequencing:: Evaluation in textual order. | ||
| 456 | * Conditionals:: @code{if}, @code{cond}. | ||
| 457 | * Combining Conditions:: @code{and}, @code{or}, @code{not}. | ||
| 458 | * Iteration:: @code{while} loops. | ||
| 459 | * Nonlocal Exits:: Jumping out of a sequence. | ||
| 460 | |||
| 461 | Nonlocal Exits | ||
| 462 | |||
| 463 | * Catch and Throw:: Nonlocal exits for the program's own purposes. | ||
| 464 | * Examples of Catch:: Showing how such nonlocal exits can be written. | ||
| 465 | * Errors:: How errors are signaled and handled. | ||
| 466 | * Cleanups:: Arranging to run a cleanup form if an | ||
| 467 | error happens. | ||
| 468 | |||
| 469 | Errors | ||
| 470 | |||
| 471 | * Signaling Errors:: How to report an error. | ||
| 472 | * Processing of Errors:: What Emacs does when you report an error. | ||
| 473 | * Handling Errors:: How you can trap errors and continue execution. | ||
| 474 | * Error Symbols:: How errors are classified for trapping them. | ||
| 475 | |||
| 476 | Variables | ||
| 477 | |||
| 478 | * Global Variables:: Variable values that exist permanently, everywhere. | ||
| 479 | * Constant Variables:: Certain "variables" have values that never change. | ||
| 480 | * Local Variables:: Variable values that exist only temporarily. | ||
| 481 | * Void Variables:: Symbols that lack values. | ||
| 482 | * Defining Variables:: A definition says a symbol is used as a variable. | ||
| 483 | * Accessing Variables:: Examining values of variables whose names | ||
| 484 | are known only at run time. | ||
| 485 | * Setting Variables:: Storing new values in variables. | ||
| 486 | * Variable Scoping:: How Lisp chooses among local and global values. | ||
| 487 | * Buffer-Local Variables:: Variable values in effect only in one buffer. | ||
| 488 | |||
| 489 | Scoping Rules for Variable Bindings | ||
| 490 | |||
| 491 | * Scope:: Scope means where in the program a value | ||
| 492 | is visible. Comparison with other languages. | ||
| 493 | * Extent:: Extent means how long in time a value exists. | ||
| 494 | * Impl of Scope:: Two ways to implement dynamic scoping. | ||
| 495 | * Using Scoping:: How to use dynamic scoping carefully and | ||
| 496 | avoid problems. | ||
| 497 | |||
| 498 | Buffer-Local Variables | ||
| 499 | |||
| 500 | * Intro to Buffer-Local:: Introduction and concepts. | ||
| 501 | * Creating Buffer-Local:: Creating and destroying buffer-local bindings. | ||
| 502 | * Default Value:: The default value is seen in buffers | ||
| 503 | that don't have their own local values. | ||
| 504 | |||
| 505 | Functions | ||
| 506 | |||
| 507 | * What Is a Function:: Lisp functions vs primitives; terminology. | ||
| 508 | * Lambda Expressions:: How functions are expressed as Lisp objects. | ||
| 509 | * Function Names:: A symbol can serve as the name of a function. | ||
| 510 | * Defining Functions:: Lisp expressions for defining functions. | ||
| 511 | * Calling Functions:: How to use an existing function. | ||
| 512 | * Mapping Functions:: Applying a function to each element of a list, etc. | ||
| 513 | * Anonymous Functions:: Lambda-expressions are functions with no names. | ||
| 514 | * Function Cells:: Accessing or setting the function definition | ||
| 515 | of a symbol. | ||
| 516 | * Related Topics:: Cross-references to specific Lisp primitives | ||
| 517 | that have a special bearing on how | ||
| 518 | functions work. | ||
| 519 | |||
| 520 | Lambda Expressions | ||
| 521 | |||
| 522 | * Lambda Components:: The parts of a lambda expression. | ||
| 523 | * Simple Lambda:: A simple example. | ||
| 524 | * Argument List:: Details and special features of argument lists. | ||
| 525 | * Function Documentation:: How to put documentation in a function. | ||
| 526 | |||
| 527 | Macros | ||
| 528 | |||
| 529 | * Simple Macro:: A basic example. | ||
| 530 | * Expansion:: How, when and why macros are expanded. | ||
| 531 | * Compiling Macros:: How macros are expanded by the compiler. | ||
| 532 | * Defining Macros:: How to write a macro definition. | ||
| 533 | * Backquote:: Easier construction of list structure. | ||
| 534 | * Problems with Macros:: Don't evaluate the macro arguments too many times. | ||
| 535 | Don't hide the user's variables. | ||
| 536 | |||
| 537 | Loading | ||
| 538 | |||
| 539 | * How Programs Do Loading:: The @code{load} function and others. | ||
| 540 | * Autoload:: Setting up a function to autoload. | ||
| 541 | * Named Features:: Loading a library if it isn't already loaded. | ||
| 542 | * Repeated Loading:: Precautions about loading a file twice. | ||
| 543 | |||
| 544 | Byte Compilation | ||
| 545 | |||
| 546 | * Compilation Functions:: Byte compilation functions. | ||
| 547 | * Disassembly:: Disassembling byte-code; how to read byte-code. | ||
| 548 | |||
| 549 | Debugging Lisp Programs | ||
| 550 | |||
| 551 | * Debugger:: How the Emacs Lisp debugger is implemented. | ||
| 552 | * Syntax Errors:: How to find syntax errors. | ||
| 553 | * Compilation Errors:: How to find errors that show up in | ||
| 554 | byte compilation. | ||
| 555 | * Edebug:: A source-level Emacs Lisp debugger. | ||
| 556 | |||
| 557 | The Lisp Debugger | ||
| 558 | |||
| 559 | * Error Debugging:: Entering the debugger when an error happens. | ||
| 560 | * Function Debugging:: Entering it when a certain function is called. | ||
| 561 | * Explicit Debug:: Entering it at a certain point in the program. | ||
| 562 | * Using Debugger:: What the debugger does; what you see while in it. | ||
| 563 | * Debugger Commands:: Commands used while in the debugger. | ||
| 564 | * Invoking the Debugger:: How to call the function @code{debug}. | ||
| 565 | * Internals of Debugger:: Subroutines of the debugger, and global variables. | ||
| 566 | |||
| 567 | Debugging Invalid Lisp Syntax | ||
| 568 | |||
| 569 | * Excess Open:: How to find a spurious open paren or missing close. | ||
| 570 | * Excess Close:: How to find a spurious close paren or missing open. | ||
| 571 | |||
| 572 | Reading and Printing Lisp Objects | ||
| 573 | |||
| 574 | * Streams Intro:: Overview of streams, reading and printing. | ||
| 575 | * Input Streams:: Various data types that can be used as | ||
| 576 | input streams. | ||
| 577 | * Input Functions:: Functions to read Lisp objects from text. | ||
| 578 | * Output Streams:: Various data types that can be used as | ||
| 579 | output streams. | ||
| 580 | * Output Functions:: Functions to print Lisp objects as text. | ||
| 581 | |||
| 582 | Minibuffers | ||
| 583 | |||
| 584 | * Intro to Minibuffers:: Basic information about minibuffers. | ||
| 585 | * Text from Minibuffer:: How to read a straight text string. | ||
| 586 | * Object from Minibuffer:: How to read a Lisp object or expression. | ||
| 587 | * Completion:: How to invoke and customize completion. | ||
| 588 | * Yes-or-No Queries:: Asking a question with a simple answer. | ||
| 589 | * Minibuffer Misc:: Various customization hooks and variables. | ||
| 590 | |||
| 591 | Completion | ||
| 592 | |||
| 593 | * Basic Completion:: Low-level functions for completing strings. | ||
| 594 | (These are too low level to use the minibuffer.) | ||
| 595 | * Minibuffer Completion:: Invoking the minibuffer with completion. | ||
| 596 | * Completion Commands:: Minibuffer commands that do completion. | ||
| 597 | * High-Level Completion:: Convenient special cases of completion | ||
| 598 | (reading buffer name, file name, etc.) | ||
| 599 | * Reading File Names:: Using completion to read file names. | ||
| 600 | * Programmed Completion:: Finding the completions for a given file name. | ||
| 601 | |||
| 602 | Command Loop | ||
| 603 | |||
| 604 | * Command Overview:: How the command loop reads commands. | ||
| 605 | * Defining Commands:: Specifying how a function should read arguments. | ||
| 606 | * Interactive Call:: Calling a command, so that it will read arguments. | ||
| 607 | * Command Loop Info:: Variables set by the command loop for you to examine. | ||
| 608 | * Input Events:: What input looks like when you read it. | ||
| 609 | * Reading Input:: How to read input events from the keyboard or mouse. | ||
| 610 | * Waiting:: Waiting for user input or elapsed time. | ||
| 611 | * Quitting:: How @kbd{C-g} works. How to catch or defer quitting. | ||
| 612 | * Prefix Command Arguments:: How the commands to set prefix args work. | ||
| 613 | * Recursive Editing:: Entering a recursive edit, | ||
| 614 | and why you usually shouldn't. | ||
| 615 | * Disabling Commands:: How the command loop handles disabled commands. | ||
| 616 | * Command History:: How the command history is set up, and how accessed. | ||
| 617 | * Keyboard Macros:: How keyboard macros are implemented. | ||
| 618 | |||
| 619 | Defining Commands | ||
| 620 | |||
| 621 | * Using Interactive:: General rules for @code{interactive}. | ||
| 622 | * Interactive Codes:: The standard letter-codes for reading arguments | ||
| 623 | in various ways. | ||
| 624 | * Interactive Examples:: Examples of how to read interactive arguments. | ||
| 625 | |||
| 626 | Keymaps | ||
| 627 | |||
| 628 | * Keymap Terminology:: Definitions of terms pertaining to keymaps. | ||
| 629 | * Format of Keymaps:: What a keymap looks like as a Lisp object. | ||
| 630 | * Creating Keymaps:: Functions to create and copy keymaps. | ||
| 631 | * Inheritance and Keymaps:: How one keymap can inherit the bindings | ||
| 632 | of another keymap. | ||
| 633 | * Prefix Keys:: Defining a key with a keymap as its definition. | ||
| 634 | * Menu Keymaps:: A keymap can define a menu for X | ||
| 635 | or for use from the terminal. | ||
| 636 | * Active Keymaps:: Each buffer has a local keymap | ||
| 637 | to override the standard (global) bindings. | ||
| 638 | Each minor mode can also override them. | ||
| 639 | * Key Lookup:: How extracting elements from keymaps works. | ||
| 640 | * Functions for Key Lookup:: How to request key lookup. | ||
| 641 | * Changing Key Bindings:: Redefining a key in a keymap. | ||
| 642 | * Key Binding Commands:: Interactive interfaces for redefining keys. | ||
| 643 | * Scanning Keymaps:: Looking through all keymaps, for printing help. | ||
| 644 | |||
| 645 | Major and Minor Modes | ||
| 646 | |||
| 647 | * Major Modes:: Defining major modes. | ||
| 648 | * Minor Modes:: Defining minor modes. | ||
| 649 | * Mode Line Format:: Customizing the text that appears in the mode line. | ||
| 650 | * Hooks:: How to use hooks; how to write code that | ||
| 651 | provides hooks. | ||
| 652 | |||
| 653 | Major Modes | ||
| 654 | |||
| 655 | * Major Mode Conventions:: Coding conventions for keymaps, etc. | ||
| 656 | * Example Major Modes:: Text mode and Lisp modes. | ||
| 657 | * Auto Major Mode:: How Emacs chooses the major mode automatically. | ||
| 658 | * Mode Help:: Finding out how to use a mode. | ||
| 659 | |||
| 660 | Minor Modes | ||
| 661 | |||
| 662 | * Minor Mode Conventions:: Tips for writing a minor mode. | ||
| 663 | * Keymaps and Minor Modes:: How a minor mode can have its own keymap. | ||
| 664 | |||
| 665 | Mode Line Format | ||
| 666 | |||
| 667 | * Mode Line Data:: The data structure that controls the mode line. | ||
| 668 | * Mode Line Variables:: Variables used in that data structure. | ||
| 669 | * %-Constructs:: Putting information into a mode line. | ||
| 670 | |||
| 671 | Documentation | ||
| 672 | |||
| 673 | * Documentation Basics:: Good style for doc strings. | ||
| 674 | Where to put them. How Emacs stores them. | ||
| 675 | * Accessing Documentation:: How Lisp programs can access doc strings. | ||
| 676 | * Keys in Documentation:: Substituting current key bindings. | ||
| 677 | * Describing Characters:: Making printable descriptions of | ||
| 678 | non-printing characters and key sequences. | ||
| 679 | * Help Functions:: Subroutines used by Emacs help facilities. | ||
| 680 | |||
| 681 | Files | ||
| 682 | |||
| 683 | * Visiting Files:: Reading files into Emacs buffers for editing. | ||
| 684 | * Saving Buffers:: Writing changed buffers back into files. | ||
| 685 | * Reading from Files:: Reading files into other buffers. | ||
| 686 | * Writing to Files:: Writing new files from parts of buffers. | ||
| 687 | * File Locks:: Locking and unlocking files, to prevent | ||
| 688 | simultaneous editing by two people. | ||
| 689 | * Information about Files:: Testing existence, accessibility, size of files. | ||
| 690 | * Contents of Directories:: Getting a list of the files in a directory. | ||
| 691 | * Changing File Attributes:: Renaming files, changing protection, etc. | ||
| 692 | * File Names:: Decomposing and expanding file names. | ||
| 693 | |||
| 694 | Visiting Files | ||
| 695 | |||
| 696 | * Visiting Functions:: The usual interface functions for visiting. | ||
| 697 | * Subroutines of Visiting:: Lower-level subroutines that they use. | ||
| 698 | |||
| 699 | Information about Files | ||
| 700 | |||
| 701 | * Testing Accessibility:: Is a given file readable? Writable? | ||
| 702 | * Kinds of Files:: Is it a directory? A link? | ||
| 703 | * File Attributes:: How large is it? Any other names? Etc. | ||
| 704 | |||
| 705 | File Names | ||
| 706 | |||
| 707 | * File Name Components:: The directory part of a file name, and the rest. | ||
| 708 | * Directory Names:: A directory's name as a directory | ||
| 709 | is different from its name as a file. | ||
| 710 | * Relative File Names:: Some file names are relative to a | ||
| 711 | current directory. | ||
| 712 | * File Name Expansion:: Converting relative file names to absolute ones. | ||
| 713 | * Unique File Names:: Generating names for temporary files. | ||
| 714 | * File Name Completion:: Finding the completions for a given file name. | ||
| 715 | |||
| 716 | Backups and Auto-Saving | ||
| 717 | |||
| 718 | * Backup Files:: How backup files are made; how their names | ||
| 719 | are chosen. | ||
| 720 | * Auto-Saving:: How auto-save files are made; how their | ||
| 721 | names are chosen. | ||
| 722 | * Reverting:: @code{revert-buffer}, and how to customize | ||
| 723 | what it does. | ||
| 724 | |||
| 725 | Backup Files | ||
| 726 | |||
| 727 | * Making Backups:: How Emacs makes backup files, and when. | ||
| 728 | * Rename or Copy:: Two alternatives: renaming the old file | ||
| 729 | or copying it. | ||
| 730 | * Numbered Backups:: Keeping multiple backups for each source file. | ||
| 731 | * Backup Names:: How backup file names are computed; customization. | ||
| 732 | |||
| 733 | Buffers | ||
| 734 | |||
| 735 | * Buffer Basics:: What is a buffer? | ||
| 736 | * Buffer Names:: Accessing and changing buffer names. | ||
| 737 | * Buffer File Name:: The buffer file name indicates which file | ||
| 738 | is visited. | ||
| 739 | * Buffer Modification:: A buffer is @dfn{modified} if it needs to be saved. | ||
| 740 | * Modification Time:: Determining whether the visited file was changed | ||
| 741 | ``behind Emacs's back''. | ||
| 742 | * Read Only Buffers:: Modifying text is not allowed in a | ||
| 743 | read-only buffer. | ||
| 744 | * The Buffer List:: How to look at all the existing buffers. | ||
| 745 | * Creating Buffers:: Functions that create buffers. | ||
| 746 | * Killing Buffers:: Buffers exist until explicitly killed. | ||
| 747 | * Current Buffer:: Designating a buffer as current | ||
| 748 | so primitives will access its contents. | ||
| 749 | |||
| 750 | Windows | ||
| 751 | |||
| 752 | * Basic Windows:: Basic information on using windows. | ||
| 753 | * Splitting Windows:: Splitting one window into two windows. | ||
| 754 | * Deleting Windows:: Deleting a window gives its space to other windows. | ||
| 755 | * Selecting Windows:: The selected window is the one that you edit in. | ||
| 756 | * Cyclic Window Ordering:: Moving around the existing windows. | ||
| 757 | * Buffers and Windows:: Each window displays the contents of a buffer. | ||
| 758 | * Displaying Buffers:: Higher-lever functions for displaying a buffer | ||
| 759 | and choosing a window for it. | ||
| 760 | * Window Point:: Each window has its own location of point. | ||
| 761 | * Window Start:: The display-start position controls which text | ||
| 762 | is on-screen in the window. | ||
| 763 | * Vertical Scrolling:: Moving text up and down in the window. | ||
| 764 | * Horizontal Scrolling:: Moving text sideways on the window. | ||
| 765 | * Size of Window:: Accessing the size of a window. | ||
| 766 | * Resizing Windows:: Changing the size of a window. | ||
| 767 | * Window Configurations:: Saving and restoring the state of the screen. | ||
| 768 | |||
| 769 | Frames | ||
| 770 | |||
| 771 | * Creating Frames:: Creating additional frames. | ||
| 772 | * Multiple Displays:: Creating frames on other X displays. | ||
| 773 | * Frame Parameters:: Controlling frame size, position, font, etc. | ||
| 774 | * Frame Titles:: Automatic updating of frame titles. | ||
| 775 | * Deleting Frames:: Frames last until explicitly deleted. | ||
| 776 | * Finding All Frames:: How to examine all existing frames. | ||
| 777 | * Frames and Windows:: A frame contains windows; | ||
| 778 | display of text always works through windows. | ||
| 779 | * Minibuffers and Frames:: How a frame finds the minibuffer to use. | ||
| 780 | * Input Focus:: Specifying the selected frame. | ||
| 781 | * Visibility of Frames:: Frames may be visible or invisible, or icons. | ||
| 782 | * Raising and Lowering:: Raising a frame makes it hide other X windows; | ||
| 783 | lowering it makes the others hide them. | ||
| 784 | * Frame Configurations:: Saving the state of all frames. | ||
| 785 | * Mouse Tracking:: Getting events that say when the mouse moves. | ||
| 786 | * Mouse Position:: Asking where the mouse is, or moving it. | ||
| 787 | * Pop-Up Menus:: Displaying a menu for the user to select from. | ||
| 788 | * Dialog Boxes:: Displaying a box to ask yes or no. | ||
| 789 | * Pointer Shapes:: Specifying the shape of the mouse pointer. | ||
| 790 | * X Selections:: Transferring text to and from other X clients. | ||
| 791 | * Color Names:: Getting the definitions of color names. | ||
| 792 | * Resources:: Getting resource values from the server. | ||
| 793 | * Server Data:: Getting info about the X server. | ||
| 794 | |||
| 795 | Positions | ||
| 796 | |||
| 797 | * Point:: The special position where editing takes place. | ||
| 798 | * Motion:: Changing point. | ||
| 799 | * Excursions:: Temporary motion and buffer changes. | ||
| 800 | * Narrowing:: Restricting editing to a portion of the buffer. | ||
| 801 | |||
| 802 | Motion | ||
| 803 | |||
| 804 | * Character Motion:: Moving in terms of characters. | ||
| 805 | * Word Motion:: Moving in terms of words. | ||
| 806 | * Buffer End Motion:: Moving to the beginning or end of the buffer. | ||
| 807 | * Text Lines:: Moving in terms of lines of text. | ||
| 808 | * Screen Lines:: Moving in terms of lines as displayed. | ||
| 809 | * List Motion:: Moving by parsing lists and sexps. | ||
| 810 | * Skipping Characters:: Skipping characters belonging to a certain set. | ||
| 811 | |||
| 812 | Markers | ||
| 813 | |||
| 814 | * Overview of Markers:: The components of a marker, and how it relocates. | ||
| 815 | * Predicates on Markers:: Testing whether an object is a marker. | ||
| 816 | * Creating Markers:: Making empty markers or markers at certain places. | ||
| 817 | * Information from Markers:: Finding the marker's buffer or character | ||
| 818 | position. | ||
| 819 | * Changing Markers:: Moving the marker to a new buffer or position. | ||
| 820 | * The Mark:: How ``the mark'' is implemented with a marker. | ||
| 821 | * The Region:: How to access ``the region''. | ||
| 822 | |||
| 823 | Text | ||
| 824 | |||
| 825 | * Near Point:: Examining text in the vicinity of point. | ||
| 826 | * Buffer Contents:: Examining text in a general fashion. | ||
| 827 | * Insertion:: Adding new text to a buffer. | ||
| 828 | * Commands for Insertion:: User-level commands to insert text. | ||
| 829 | * Deletion:: Removing text from a buffer. | ||
| 830 | * User-Level Deletion:: User-level commands to delete text. | ||
| 831 | * The Kill Ring:: Where removed text sometimes is saved for | ||
| 832 | later use. | ||
| 833 | * Undo:: Undoing changes to the text of a buffer. | ||
| 834 | * Auto Filling:: How auto-fill mode is implemented to break lines. | ||
| 835 | * Filling:: Functions for explicit filling. | ||
| 836 | * Margins:: How to specify margins for filling commands. | ||
| 837 | * Sorting:: Functions for sorting parts of the buffer. | ||
| 838 | * Indentation:: Functions to insert or adjust indentation. | ||
| 839 | * Columns:: Computing horizontal positions, and using them. | ||
| 840 | * Case Changes:: Case conversion of parts of the buffer. | ||
| 841 | * Substitution:: Replacing a given character wherever it appears. | ||
| 842 | * Registers:: How registers are implemented. Accessing | ||
| 843 | the text or position stored in a register. | ||
| 844 | |||
| 845 | The Kill Ring | ||
| 846 | |||
| 847 | * Kill Ring Concepts:: What text looks like in the kill ring. | ||
| 848 | * Kill Functions:: Functions that kill text. | ||
| 849 | * Yank Commands:: Commands that access the kill ring. | ||
| 850 | * Low-Level Kill Ring:: Functions and variables for kill ring access. | ||
| 851 | * Internals of Kill Ring:: Variables that hold kill-ring data. | ||
| 852 | |||
| 853 | Indentation | ||
| 854 | |||
| 855 | * Primitive Indent:: Functions used to count and insert indentation. | ||
| 856 | * Mode-Specific Indent:: Customize indentation for different modes. | ||
| 857 | * Region Indent:: Indent all the lines in a region. | ||
| 858 | * Relative Indent:: Indent the current line based on previous lines. | ||
| 859 | * Indent Tabs:: Adjustable, typewriter-like tab stops. | ||
| 860 | * Motion by Indent:: Move to first non-blank character. | ||
| 861 | |||
| 862 | Searching and Matching | ||
| 863 | |||
| 864 | * String Search:: Search for an exact match. | ||
| 865 | * Regular Expressions:: Describing classes of strings. | ||
| 866 | * Regexp Search:: Searching for a match for a regexp. | ||
| 867 | * Match Data:: Finding out which part of the text matched | ||
| 868 | various parts of a regexp, after regexp search. | ||
| 869 | * Saving Match Data:: Saving and restoring this information. | ||
| 870 | * Standard Regexps:: Useful regexps for finding sentences, pages,... | ||
| 871 | * Searching and Case:: Case-independent or case-significant searching. | ||
| 872 | |||
| 873 | Regular Expressions | ||
| 874 | |||
| 875 | * Syntax of Regexps:: Rules for writing regular expressions. | ||
| 876 | * Regexp Example:: Illustrates regular expression syntax. | ||
| 877 | |||
| 878 | Syntax Tables | ||
| 879 | |||
| 880 | * Syntax Descriptors:: How characters are classified. | ||
| 881 | * Syntax Table Functions:: How to create, examine and alter syntax tables. | ||
| 882 | * Parsing Expressions:: Parsing balanced expressions | ||
| 883 | using the syntax table. | ||
| 884 | * Standard Syntax Tables:: Syntax tables used by various major modes. | ||
| 885 | * Syntax Table Internals:: How syntax table information is stored. | ||
| 886 | |||
| 887 | Syntax Descriptors | ||
| 888 | |||
| 889 | * Syntax Class Table:: Table of syntax classes. | ||
| 890 | * Syntax Flags:: Additional flags each character can have. | ||
| 891 | |||
| 892 | Abbrevs And Abbrev Expansion | ||
| 893 | |||
| 894 | * Abbrev Mode:: Setting up Emacs for abbreviation. | ||
| 895 | * Tables: Abbrev Tables. Creating and working with abbrev tables. | ||
| 896 | * Defining Abbrevs:: Specifying abbreviations and their expansions. | ||
| 897 | * Files: Abbrev Files. Saving abbrevs in files. | ||
| 898 | * Expansion: Abbrev Expansion. Controlling expansion; expansion subroutines. | ||
| 899 | * Standard Abbrev Tables:: Abbrev tables used by various major modes. | ||
| 900 | |||
| 901 | Processes | ||
| 902 | |||
| 903 | * Subprocess Creation:: Functions that start subprocesses. | ||
| 904 | * Synchronous Processes:: Details of using synchronous subprocesses. | ||
| 905 | * Asynchronous Processes:: Starting up an asynchronous subprocess. | ||
| 906 | * Deleting Processes:: Eliminating an asynchronous subprocess. | ||
| 907 | * Process Information:: Accessing run-status and other attributes. | ||
| 908 | * Input to Processes:: Sending input to an asynchronous subprocess. | ||
| 909 | * Signals to Processes:: Stopping, continuing or interrupting | ||
| 910 | an asynchronous subprocess. | ||
| 911 | * Output from Processes:: Collecting output from an asynchronous subprocess. | ||
| 912 | * Sentinels:: Sentinels run when process run-status changes. | ||
| 913 | * Network:: Opening network connections. | ||
| 914 | |||
| 915 | Receiving Output from Processes | ||
| 916 | |||
| 917 | * Process Buffers:: If no filter, output is put in a buffer. | ||
| 918 | * Filter Functions:: Filter functions accept output from the process. | ||
| 919 | * Accepting Output:: How to wait until process output arrives. | ||
| 920 | |||
| 921 | Operating System Interface | ||
| 922 | |||
| 923 | * Starting Up:: Customizing Emacs start-up processing. | ||
| 924 | * Getting Out:: How exiting works (permanent or temporary). | ||
| 925 | * System Environment:: Distinguish the name and kind of system. | ||
| 926 | * Terminal Input:: Recording terminal input for debugging. | ||
| 927 | * Terminal Output:: Recording terminal output for debugging. | ||
| 928 | * Flow Control:: How to turn output flow control on or off. | ||
| 929 | * Batch Mode:: Running Emacs without terminal interaction. | ||
| 930 | |||
| 931 | Starting Up Emacs | ||
| 932 | |||
| 933 | * Start-up Summary:: Sequence of actions Emacs performs at start-up. | ||
| 934 | * Init File:: Details on reading the init file (@file{.emacs}). | ||
| 935 | * Terminal-Specific:: How the terminal-specific Lisp file is read. | ||
| 936 | * Command Line Arguments:: How command line arguments are processed, | ||
| 937 | and how you can customize them. | ||
| 938 | |||
| 939 | Getting out of Emacs | ||
| 940 | |||
| 941 | * Killing Emacs:: Exiting Emacs irreversibly. | ||
| 942 | * Suspending Emacs:: Exiting Emacs reversibly. | ||
| 943 | |||
| 944 | Emacs Display | ||
| 945 | |||
| 946 | * Refresh Screen:: Clearing the screen and redrawing everything on it. | ||
| 947 | * Truncation:: Folding or wrapping long text lines. | ||
| 948 | * The Echo Area:: Where messages are displayed. | ||
| 949 | * Selective Display:: Hiding part of the buffer text. | ||
| 950 | * Overlay Arrow:: Display of an arrow to indicate position. | ||
| 951 | * Temporary Displays:: Displays that go away automatically. | ||
| 952 | * Waiting:: Forcing display update and waiting for user. | ||
| 953 | * Blinking:: How Emacs shows the matching open parenthesis. | ||
| 954 | * Usual Display:: How control characters are displayed. | ||
| 955 | * Beeping:: Audible signal to the user. | ||
| 956 | * Window Systems:: Which window system is being used. | ||
| 957 | |||
| 958 | GNU Emacs Internals | ||
| 959 | |||
| 960 | * Building Emacs:: How to preload Lisp libraries into Emacs. | ||
| 961 | * Pure Storage:: A kludge to make preloaded Lisp functions sharable. | ||
| 962 | * Garbage Collection:: Reclaiming space for Lisp objects no longer used. | ||
| 963 | * Object Internals:: Data formats of buffers, windows, processes. | ||
| 964 | * Writing Emacs Primitives:: Writing C code for Emacs. | ||
| 965 | |||
| 966 | Object Internals | ||
| 967 | |||
| 968 | * Buffer Internals:: Components of a buffer structure. | ||
| 969 | * Window Internals:: Components of a window structure. | ||
| 970 | * Process Internals:: Components of a process structure. | ||
| 971 | @end menu | ||
| 972 | |||
| 973 | @c ================ Volume 1 ================ | ||
| 974 | |||
| 975 | @c include intro.texi | ||
| 976 | @c include objects.texi | ||
| 977 | @c include numbers.texi | ||
| 978 | @c include strings.texi | ||
| 979 | |||
| 980 | @c include lists.texi | ||
| 981 | @c include sequences.texi | ||
| 982 | @c include symbols.texi | ||
| 983 | @c include eval.texi | ||
| 984 | |||
| 985 | @c include control.texi | ||
| 986 | @c include variables.texi | ||
| 987 | @c include functions.texi | ||
| 988 | @c include macros.texi | ||
| 989 | |||
| 990 | @c include loading.texi | ||
| 991 | @c include compile.texi | ||
| 992 | @c include debugging.texi | ||
| 993 | @c include streams.texi | ||
| 994 | |||
| 995 | @c include minibuf.texi | ||
| 996 | @c include commands.texi | ||
| 997 | @c include keymaps.texi | ||
| 998 | @c include modes.texi | ||
| 999 | |||
| 1000 | @c ================ Beginning of Volume 2 ================ | ||
| 1001 | |||
| 1002 | @include help.texi | ||
| 1003 | @include files.texi | ||
| 1004 | @include backups.texi | ||
| 1005 | @include buffers.texi | ||
| 1006 | |||
| 1007 | @include windows.texi | ||
| 1008 | @include frames.texi | ||
| 1009 | @include positions.texi | ||
| 1010 | @include markers.texi | ||
| 1011 | @include text.texi | ||
| 1012 | |||
| 1013 | @include searching.texi | ||
| 1014 | @include syntax.texi | ||
| 1015 | @include abbrevs.texi | ||
| 1016 | |||
| 1017 | @include processes.texi | ||
| 1018 | @include os.texi | ||
| 1019 | @include display.texi | ||
| 1020 | @include calendar.texi | ||
| 1021 | |||
| 1022 | @c MOVE to Emacs Manual: include misc-modes.texi | ||
| 1023 | |||
| 1024 | @c appendices | ||
| 1025 | |||
| 1026 | @c REMOVE this: include non-hacker.texi | ||
| 1027 | |||
| 1028 | @include tips.texi | ||
| 1029 | @include internals.texi | ||
| 1030 | @include errors.texi | ||
| 1031 | @include locals.texi | ||
| 1032 | @include maps.texi | ||
| 1033 | @include hooks.texi | ||
| 1034 | |||
| 1035 | @include index-vol2.texi | ||
| 1036 | |||
| 1037 | @page | ||
| 1038 | @c Print the tables of contents | ||
| 1039 | @summarycontents | ||
| 1040 | @contents | ||
| 1041 | @c That's all | ||
| 1042 | |||
| 1043 | @bye | ||
| 1044 | |||
| 1045 | |||
| 1046 | These words prevent "local variables" above from confusing Emacs. | ||