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