InfoMagic Source Code 1993 July/THE_SOURCE_CODE_CD_ROM.iso/gnu/elisp/elisp-37

GNU Info File | 1993-05-11 | 25.6 KB | 575 lines

This is Info file elisp, produced by Makeinfo-1.52 from the input file
elisp.texi.

   This file documents GNU Emacs Lisp.

   This is edition 2.0 of the GNU Emacs Lisp Reference Manual, for
Emacs Version 19.

   Published by the Free Software Foundation, 675 Massachusetts Avenue,
Cambridge, MA 02139 USA

   Copyright (C) 1990, 1991, 1992 Free Software Foundation, Inc.

   Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice are
preserved on all copies.

   Permission is granted to copy and distribute modified versions of
this manual under the conditions for verbatim copying, provided that
the entire resulting derived work is distributed under the terms of a
permission notice identical to this one.

   Permission is granted to copy and distribute translations of this
manual into another language, under the above conditions for modified
versions, except that this permission notice may be stated in a
translation approved by the Foundation.


File: elisp,  Node: Process Internals,  Prev: Window Internals,  Up: Object Internals

Process Internals
-----------------

                                      The fields of a process are:

                                  `name'
                                        A string, the name of the
                                        process.

                                  `command'
                                        A list containing the command
                                        arguments that were used to
                                        start this process.

                                  `filter'
                                        A function used to accept
                                        output from the process instead
                                        of a buffer, or `nil'.

                                  `sentinel'
                                        A function called whenever the
                                        process receives a signal, or
                                        `nil'.

                                  `buffer'
                                        The associated buffer of the
                                        process.

                                  `pid'
                                        An integer, the Unix process ID.

                                  `childp'
                                        A flag, non-`nil' if this is
                                        really a child process.  It is
                                        `nil' for a network connection.

                                  `flags'
                                        A symbol indicating the state
                                        of the process.  Possible
                                        values include `run', `stop',
                                        `closed', etc.

                                  `reason'
                                        An integer, the Unix signal
                                        number that the process
                                        received that caused the
                                        process to terminate or stop.
                                        If the process has exited, then
                                        this is the exit code it
                                        specified.

                                  `mark'
                                        A marker indicating the
                                        position of end of last output
                                        from this process inserted into
                                        the buffer.  This is usually
                                        the end of the buffer.

                                  `kill_without_query'
                                        A flag, non-`nil' meaning this
                                        process should not cause
                                        confirmation to be needed if
                                        Emacs is killed.


File: elisp,  Node: Standard Errors,  Next: Standard Buffer-Local Variables,  Prev: GNU Emacs Internals,  Up: Top

Standard Errors
***************

                                      Here is the complete list of the
error symbols in standard Emacs, grouped by concept.  The list includes
each symbol's message (on the `error-message' property of the symbol),
and a cross reference to a description of how the error can occur.

                                      Each error symbol has an
`error-conditions' property which is a list of symbols.  Normally, this
list includes the error symbol itself, and the symbol `error'.
Occasionally it includes additional symbols, which are intermediate
classifications, narrower than `error' but broader than a single error
symbol.  For example, all the errors in accessing files have the
condition `file-error'.

                                      As a special exception, the error
symbol `quit' does not have the condition `error', because quitting is
not considered an error.

                                      *Note Errors::, for an
explanation of how errors are generated and handled.

                                  `SYMBOL'
                                        STRING; REFERENCE.

                                  `error'
                                        `"error"'
                                        *Note Errors::.

                                  `quit'
                                        `"Quit"'
                                        *Note Quitting::.

                                  `args-out-of-range'
                                        `"Args out of range"'
                                        *Note Sequences Arrays
                                        Vectors::.

                                  `arith-error'
                                        `"Arithmetic error"'
                                        See `/' and `%' in *Note
                                        Numbers::.

                                  `beginning-of-buffer'
                                        `"Beginning of buffer"'
                                        *Note Motion::.

                                  `buffer-read-only'
                                        `"Buffer is read-only"'
                                        *Note Read Only Buffers::.

                                  `end-of-buffer'
                                        `"End of buffer"'
                                        *Note Motion::.

                                  `end-of-file'
                                        `"End of file during parsing"'
                                        This is not a `file-error'.
                                        *Note Input Functions::.

                                  `file-error'
                                        This error, and its
                                        subcategories, do not have
                                        error-strings, because the
                                        error message is constructed
                                        from the data items alone when
                                        the error condition
                                        `file-error' is present.
                                        *Note Files::.

                                  `file-locked'
                                        This is a `file-error'.
                                        *Note File Locks::.

                                  `file-already-exists'
                                        This is a `file-error'.
                                        *Note Writing to Files::.

                                  `file-supersession'
                                        This is a `file-error'.
                                        *Note Buffer Modification::.

                                  `invalid-function'
                                        `"Invalid function"'
                                        *Note Classifying Lists::.

                                  `invalid-read-syntax'
                                        `"Invalid read syntax"'
                                        *Note Input Functions::.

                                  `invalid-regexp'
                                        `"Invalid regexp"'
                                        *Note Regular Expressions::.

                                  `no-catch'
                                        `"No catch for tag"'
                                        *Note Catch and Throw::.

                                  `search-failed'
                                        `"Search failed"'
                                        *Note Searching and Matching::.

                                  `setting-constant'
                                        `"Attempt to set a constant
                                        symbol"'
                                        The values of the symbols `nil'
                                        and `t' may not be changed.
                                        *Note Variables that Never
                                        Change: Constant Variables.

                                  `void-function'
                                        `"Symbol's function definition
                                        is void"'
                                        *Note Function Cells::.

                                  `void-variable'
                                        `"Symbol's value as variable is
                                        void"'
                                        *Note Accessing Variables::.

                                  `wrong-number-of-arguments'
                                        `"Wrong number of arguments"'
                                        *Note Classifying Lists::.

                                  `wrong-type-argument'
                                        `"Wrong type argument"'
                                        *Note Type Predicates::.


File: elisp,  Node: Standard Buffer-Local Variables,  Next: Standard Keymaps,  Prev: Standard Errors,  Up: Top

Buffer-Local Variables
**********************

                                      The table below shows all of the
variables that are automatically local (when set) in each buffer in
Emacs Version 18 with the common packages loaded.

                                  `abbrev-mode'
                                        *note Abbrevs::.

                                  `auto-fill-function'
                                        *note Auto Filling::.

                                  `buffer-auto-save-file-name'
                                        *note Auto-Saving::.

                                  `buffer-backed-up'
                                        *note Backup Files::.

                                  `buffer-display-table'
                                        *note Display Tables::.

                                  `buffer-file-name'
                                        *note Buffer File Name::.

                                  `buffer-file-number'
                                        *note Buffer File Name::.

                                  `buffer-file-truename'
                                        *note Buffer File Name::.

                                  `buffer-offer-save'
                                        *note Saving Buffers::.

                                  `buffer-read-only'
                                        *note Read Only Buffers::.

                                  `buffer-saved-size'
                                        *note Point::.

                                  `buffer-undo-list'
                                        *note Undo::.

                                  `case-fold-search'
                                        *note Searching and Case::.

                                  `ctl-arrow'
                                        *note Usual Display::.

                                  `default-directory'
                                        *note System Environment::.

                                  `fill-column'
                                        *note Auto Filling::.

                                  `left-margin'
                                        *note Indentation::.

                                  `local-abbrev-table'
                                        *note Abbrevs::.

                                  `local-write-file-hooks'
                                        *note Saving Buffers::.

                                  `major-mode'
                                        *note Mode Help::.

                                  `mark-active'
                                        *note The Mark::.

                                  `mark-ring'
                                        *note The Mark::.

                                  `minor-modes'
                                        *note Minor Modes::.

                                  `mode-line-format'
                                        *note Mode Line Data::.

                                  `mode-name'
                                        *note Mode Line Variables::.

                                  `overwrite-mode'
                                        *note Insertion::.

                                  `paragraph-separate'
                                        *note Standard Regexps::.

                                  `paragraph-start'
                                        *note Standard Regexps::.

                                  `require-final-newline'
                                        *note Insertion::.

                                  `selective-display'
                                        *note Selective Display::.

                                  `selective-display-ellipses'
                                        *note Selective Display::.

                                  `tab-width'
                                        *note Usual Display::.

                                  `truncate-lines'
                                        *note Truncation::.


File: elisp,  Node: Standard Keymaps,  Next: Standard Hooks,  Prev: Standard Buffer-Local Variables,  Up: Top

Standard Keymaps
****************

                                      The following symbols are used as
the names for various keymaps.  Some of these exist when Emacs is first
started, others are only loaded when their respective mode is used.
This is not an exhaustive list.

                                      Almost all of these maps are used
as local maps.  Indeed, of the modes that presently exist, only Vip
mode and Terminal mode ever change the global keymap.

                                  `Buffer-menu-mode-map'
                                        A full keymap used by Buffer
                                        Menu mode.

                                  `c-mode-map'
                                        A sparse keymap used in C mode
                                        as a local map.

                                  `command-history-map'
                                        A full keymap used by Command
                                        History mode.

                                  `ctl-x-4-map'
                                        A sparse keymap for subcommands
                                        of the prefix `C-x 4'.

                                  `ctl-x-map'
                                        A full keymap for `C-x'
                                        commands.

                                  `debugger-mode-map'
                                        A full keymap used by Debugger
                                        mode.

                                  `dired-mode-map'
                                        A full keymap for `dired-mode'
                                        buffers.

                                  `doctor-mode-map'
                                        A sparse keymap used by Doctor
                                        mode.

                                  `edit-abbrevs-map'
                                        A sparse keymap used in
                                        `edit-abbrevs'.

                                  `edit-tab-stops-map'
                                        A sparse keymap used in
                                        `edit-tab-stops'.

                                  `electric-buffer-menu-mode-map'
                                        A full keymap used by Electric
                                        Buffer Menu mode.

                                  `electric-history-map'
                                        A full keymap used by Electric
                                        Command History mode.

                                  `emacs-lisp-mode-map'
                                        A sparse keymap used in Emacs
                                        Lisp mode.

                                  `function-keymap'
                                        The keymap for the definitions
                                        of keypad and function keys.
                                        If there are none, then it
                                        contains an empty sparse keymap.

                                  `fundamental-mode-map'
                                        The local keymap for
                                        Fundamental mode.
                                        It is empty and should not be
                                        changed.

                                  `Helper-help-map'
                                        A full keymap used by the help
                                        utility package.
                                        It has the same keymap in its
                                        value cell and in its function
                                        cell.

                                  `Info-edit-map'
                                        A sparse keymap used by the `e'
                                        command of Info.

                                  `Info-mode-map'
                                        A sparse keymap containing Info
                                        commands.

                                  `isearch-mode-map'
                                        A keymap that defines the
                                        characters you can type within
                                        incremental search.

                                  `lisp-interaction-mode-map'
                                        A sparse keymap used in Lisp
                                        mode.

                                  `lisp-mode-map'
                                        A sparse keymap used in Lisp
                                        mode.

                                  `mode-specific-map'
                                        The keymap for characters
                                        following `C-c'.  Note, this is
                                        in the global map.  This map is
                                        not actually mode specific: its
                                        name was chosen to be
                                        informative for the user in
                                        `C-h b' (`display-bindings'),
                                        where it describes the main use
                                        of the `C-c' prefix key.

                                  `occur-mode-map'
                                        A local keymap used in Occur
                                        mode.

                                  `query-replace-map'
                                        A local keymap used for
                                        responses in `query-replace'
                                        and related commands; also for
                                        `y-or-n-p' and `map-y-or-n-p'.
                                        The functions that use this map
                                        do not support prefix keys;
                                        they look up one event at a
                                        time.

                                  `text-mode-map'
                                        A sparse keymap used by Text
                                        mode.

                                  `view-mode-map'
                                        A full keymap used by View mode.


File: elisp,  Node: Standard Hooks,  Next: Index,  Prev: Standard Keymaps,  Up: Top

Standard Hooks
**************

                                      The following is a list of hook
variables which let you provide functions to be called from within
Emacs on suitable occasions.

                                      Most of these variables have
names ending with `-hook' are "normal hooks", that are run with
`run-hooks'.  The value of such a hook is a list of functions.  The
recommended way to put a new function on such a hook is to call
`add-hook'.  *Note Hooks::, for more information about using hooks.

                                      The variables whose names end in
`-function' have single functions as their values.  Usually there is a
specific reason why the variable is not a normal hook, such as, the
need to pass an argument to the function.  (In older Emacs versions,
some of these variables had names ending in `-hook' even though they
were not normal hooks.)

                                      The variables whose names end in
`-hooks' have lists of functions as their values, but these functions
are called in a special way (they are passed arguments, or else their
values are used).

                                  `activate-mark-hook'
                                  `after-change-function'
                                  `after-init-hook'
                                  `auto-fill-function'
                                  `auto-save-hook'
                                  `before-change-function'
                                  `before-init-hook'
                                  `blink-paren-function'
                                  `c-mode-hook'
                                  `command-history-hook'
                                  `comment-indent-function'
                                  `deactivate-mark-hook'
                                  `dired-mode-hook'
                                  `disabled-command-hook'
                                  `edit-picture-hook'
                                  `electric-buffer-menu-mode-hook'
                                  `electric-command-history-hook'
                                  `electric-help-mode-hook'
                                  `emacs-lisp-mode-hook'
                                  `find-file-hooks'
                                  `find-file-not-found-hooks'
                                  `first-change-hook'
                                  `fortran-comment-hook'
                                  `fortran-mode-hook'
                                  `ftp-setup-write-file-hooks'
                                  `ftp-write-file-hook'
                                  `indent-mim-hook'
                                  `LaTeX-mode-hook'
                                  `ledit-mode-hook'
                                  `lisp-indent-function'
                                  `lisp-interaction-mode-hook'
                                  `lisp-mode-hook'
                                  `m2-mode-hook'
                                  `mail-mode-hook'
                                  `mail-setup-hook'
                                  `medit-mode-hook'
                                  `mh-compose-letter-hook'
                                  `mh-folder-mode-hook'
                                  `mh-letter-mode-hook'
                                  `mim-mode-hook'
                                  `news-mode-hook'
                                  `news-reply-mode-hook'
                                  `news-setup-hook'
                                  `nroff-mode-hook'
                                  `outline-mode-hook'
                                  `plain-TeX-mode-hook'
                                  `pre-abbrev-expand-hook'
                                  `pre-command-hook'
                                  `post-command-hook'
                                  `prolog-mode-hook'
                                  `protect-innocence-hook'
                                  `rmail-edit-mode-hook'
                                  `rmail-mode-hook'
                                  `rmail-summary-mode-hook'
                                  `scheme-indent-hook'
                                  `scheme-mode-hook'
                                  `scribe-mode-hook'
                                  `shell-mode-hook'
                                  `shell-set-directory-error-hook'
                                  `suspend-hook'
                                  `suspend-resume-hook'
                                  `temp-buffer-show-function'
                                  `term-setup-hook'
                                  `terminal-mode-hook'
                                  `terminal-mode-break-hook'
                                  `TeX-mode-hook'
                                  `text-mode-hook'
                                  `vi-mode-hook'
                                  `view-hook'
                                  `window-setup-hook'
                                  `write-contents-hooks'
                                  `write-file-hooks'