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