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