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