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