1
0
mirror of https://git.savannah.gnu.org/git/emacs.git synced 2024-11-24 07:20:37 +00:00

Improve index entries. Remove redundant/useless ones.

This commit is contained in:
Richard M. Stallman 2007-04-07 02:06:21 +00:00
parent 73f9ed9ac4
commit 77bf576c22
7 changed files with 40 additions and 68 deletions

View File

@ -116,13 +116,13 @@ controls the reading of arguments for an interactive call.
@node Using Interactive
@subsection Using @code{interactive}
@cindex arguments, interactive entry
This section describes how to write the @code{interactive} form that
makes a Lisp function an interactively-callable command, and how to
examine a command's @code{interactive} form.
@defspec interactive arg-descriptor
@cindex argument descriptors
This special form declares that the function in which it appears is a
command, and that it may therefore be called interactively (via
@kbd{M-x} or by entering a key sequence bound to it). The argument
@ -151,7 +151,6 @@ arguments. This leads quickly to an error if the command requires one
or more arguments.
@item
@cindex argument prompt
It may be a string; then its contents should consist of a code character
followed by a prompt (which some code characters use and some ignore).
The prompt ends either with the end of the string or with a newline.
@ -207,7 +206,6 @@ form that is evaluated to get a list of arguments to pass to the
command. Usually this form will call various functions to read input
from the user, most often through the minibuffer (@pxref{Minibuffers})
or directly from the keyboard (@pxref{Reading Input}).
@cindex argument evaluation form
Providing point or the mark as an argument value is also common, but
if you do this @emph{and} read input (whether using the minibuffer or
@ -865,8 +863,8 @@ If the last event came from a keyboard macro, the value is @code{macro}.
@node Adjusting Point
@section Adjusting Point After Commands
@cindex adjust point
@cindex invisible or intangible text, and point display
@cindex adjusting point
@cindex invisible/intangible text, and point
@cindex @code{display} property, and point display
@cindex @code{composition} property, and point display
@ -1781,8 +1779,7 @@ must be the last element of the list. For example,
@node Accessing Events
@subsection Accessing Events
@cindex mouse events, accessing the data
@cindex accessing data of mouse events
@cindex mouse events, data in
This section describes convenient functions for accessing the data in
a mouse button or motion event.
@ -1897,7 +1894,6 @@ cons cell @code{(@var{width} . @var{height})}. If the @var{position}
is a buffer position, return the size of the character at that position.
@end defun
@cindex mouse event, timestamp
@cindex timestamp of a mouse event
@defun posn-timestamp position
Return the timestamp in @var{position}. This is the time at which the
@ -2113,7 +2109,6 @@ debugging terminal input.
for example, @code{describe-key} uses it to read the key to describe.
@defun read-key-sequence prompt &optional continue-echo dont-downcase-last switch-frame-ok command-loop
@cindex key sequence
This function reads a key sequence and returns it as a string or
vector. It keeps reading events until it has accumulated a complete key
sequence; that is, enough to specify a non-prefix command using the
@ -2546,7 +2541,6 @@ command's key sequence (as returned by e.g. @code{this-command-keys}),
as the events will already have been added once as they were read for
the first time. An element of the form @code{(@code{t} . @var{event})}
forces @var{event} to be added to the current command's key sequence.
@end defvar
@defun listify-key-sequence key
@ -2620,9 +2614,9 @@ like this:
@end defmac
@defun discard-input
@cindex flush input
@cindex discard input
@cindex terminate keyboard macro
@cindex flushing input
@cindex discarding input
@cindex keyboard macro, terminating
This function discards the contents of the terminal input buffer and
cancels any keyboard macro that might be in the process of definition.
It returns @code{nil}.
@ -2668,7 +2662,6 @@ in the variable @code{special-event-map} (@pxref{Active Keymaps}).
@node Waiting
@section Waiting for Elapsed Time or Input
@cindex pausing
@cindex waiting
The wait functions are designed to wait for a certain amount of time
@ -2775,7 +2768,7 @@ about the special behavior of @kbd{C-g} in the command loop. In the
case of @code{read-quoted-char}, this is so that @kbd{C-q} can be used
to quote a @kbd{C-g}.
@cindex prevent quitting
@cindex preventing quitting
You can prevent quitting for a portion of a Lisp function by binding
the variable @code{inhibit-quit} to a non-@code{nil} value. Then,
although @kbd{C-g} still sets @code{quit-flag} to @code{t} as usual, the

View File

@ -6,7 +6,6 @@
@setfilename ../info/customize
@node Customization, Loading, Macros, Top
@chapter Writing Customization Definitions
@cindex customize
@cindex customization definitions
This chapter describes how to declare user options for customization,
@ -187,10 +186,10 @@ choice is the official name of the package, such as MH-E or Gnus.
@end defvar
@node Group Definitions
@section Defining Custom Groups
@cindex define custom group
@section Defining Customization Groups
@cindex define customization group
@cindex customization groups, defining
@cindex custom groups, how to define
Each Emacs Lisp package should have one main customization group which
contains all the options, faces and other groups in the package. If the
package has a small number of options and faces, use just one group and
@ -262,10 +261,9 @@ turn this feature back on, if someone would like to do the work.
@node Variable Definitions
@section Defining Customization Variables
@cindex define customization options
@cindex customization variables, how to define
@cindex declare user-editable variables
Use @code{defcustom} to declare user-editable variables.
Use @code{defcustom} to declare user-customizable variables.
@defmac defcustom option standard doc [keyword value]@dots{}
This construct declares @var{option} as a customizable user option
@ -704,7 +702,7 @@ The value must be a valid color name, and you can do completion with
@node Composite Types
@subsection Composite Types
@cindex arguments (of composite type)
@cindex Composite Types (customization)
When none of the simple types is appropriate, you can use composite
types, which build new types from other types or from specified data.

View File

@ -12,9 +12,8 @@
@node Edebug, Syntax Errors, Debugger, Debugging
@section Edebug
@cindex Edebug mode
@cindex Edebug debugging facility
@cindex Edebug
Edebug is a source-level debugger for Emacs Lisp programs with which
you can:
@ -195,12 +194,6 @@ evaluates, even if not instrumenting it. See also the @kbd{i} command
(@pxref{Jumping}), which steps into the call after instrumenting the
function.
@cindex special forms (Edebug)
@cindex interactive commands (Edebug)
@cindex anonymous lambda expressions (Edebug)
@cindex Common Lisp (Edebug)
@pindex cl.el @r{(Edebug)}
@pindex cl-specs.el
Edebug knows how to instrument all the standard special forms,
@code{interactive} forms with an expression argument, anonymous lambda
expressions, and other defining forms. However, Edebug cannot determine
@ -441,9 +434,9 @@ breakpoints, the global break condition, and source breakpoints.
@end menu
@node Breakpoints
@subsubsection Breakpoints
@subsubsection Edebug Breakpoints
@cindex breakpoints
@cindex breakpoints (Edebug)
While using Edebug, you can specify @dfn{breakpoints} in the program you
are testing: these are places where execution should stop. You can set a
breakpoint at any stop point, as defined in @ref{Using Edebug}. For
@ -867,10 +860,10 @@ lines inserted.
@node Coverage Testing
@subsection Coverage Testing
@cindex coverage testing
@cindex coverage testing (Edebug)
@cindex frequency counts
@cindex performance analysis
Edebug provides rudimentary coverage testing and display of execution
Edebug provides rudimentary coverage testing and display of execution
frequency.
Coverage testing works by comparing the result of each expression with

View File

@ -740,7 +740,6 @@ for its usual definition is in @file{userlock.el}.
@node Information about Files
@section Information about Files
@cindex information about files
@cindex file, information about
The functions described in this section all operate on strings that
@ -1178,6 +1177,7 @@ value of @code{current-time}; see @ref{Time of Day}.)
@item
The time of last modification as a list of two integers (as above).
@cindex modification time of file
@item
The time of last status change as a list of two integers (as above).
@ -1268,13 +1268,13 @@ is on file system number -32252.
@node Locating Files
@subsection How to Locate Files in Standard Places
@cindex locate files
@cindex find files
@cindex locate file in path
@cindex find file in path
This section explains how to search for a file in a list of
directories. One example is when you need to look for a program's
executable file, e.g., to find out whether a given program is
installed on the user's system. Another example is the search for
directories (a @dfn{path}). One example is when you need to look for
a program's executable file, e.g., to find out whether a given program
is installed on the user's system. Another example is the search for
Lisp libraries (@pxref{Library Search}). Such searches generally need
to try various possible file name extensions, in addition to various
possible directories. Emacs provides a function for such a
@ -1317,7 +1317,6 @@ For compatibility, @var{predicate} can also be one of the symbols
a list of one or more of these symbols.
@end defun
@cindex find executable program
@defun executable-find program
This function searches for the executable file of the named
@var{program} and returns the full absolute name of the executable,
@ -1329,7 +1328,7 @@ in @code{exec-path} and tries all the file-name extensions in
@node Changing Files
@section Changing File Names and Attributes
@cindex renaming files
@c @cindex renaming files Duplicates rename-file
@cindex copying files
@cindex deleting files
@cindex linking files

View File

@ -927,7 +927,7 @@ while processing @code{frame-title-format} or
@node Deleting Frames
@section Deleting Frames
@cindex deletion of frames
@cindex deleting frames
Frames remain potentially visible until you explicitly @dfn{delete}
them. A deleted frame cannot appear on the screen, but continues to
@ -959,7 +959,7 @@ calls the function @code{delete-frame}. @xref{Misc Events}.
@node Finding All Frames
@section Finding All Frames
@cindex finding all frames
@cindex frames, scanning all
@defun frame-list
The function @code{frame-list} returns a list of all the frames that
@ -1081,7 +1081,7 @@ Displays}.
@node Input Focus
@section Input Focus
@cindex input focus
@cindex selected frame
@c @cindex selected frame Duplicates selected-frame
At any time, one frame in Emacs is the @dfn{selected frame}. The selected
window always resides on the selected frame.
@ -1264,7 +1264,7 @@ to ``lowest.'' Where two windows overlap, the one higher up covers
the one underneath. Even a window at the bottom of the stack can be
seen if no other window overlaps it.
@cindex raising a frame
@c @cindex raising a frame redundant with raise-frame
@cindex lowering a frame
A window's place in this ordering is not fixed; in fact, users tend
to change the order frequently. @dfn{Raising} a window means moving
@ -1319,14 +1319,14 @@ unwanted frames are iconified instead.
@node Mouse Tracking
@section Mouse Tracking
@cindex mouse tracking
@cindex tracking the mouse
@c @cindex tracking the mouse Duplicates track-mouse
Sometimes it is useful to @dfn{track} the mouse, which means to display
Sometimes it is useful to @dfn{track} the mouse, which means to display
something to indicate where the mouse is and move the indicator as the
mouse moves. For efficient mouse tracking, you need a way to wait until
the mouse actually moves.
The convenient way to track the mouse is to ask for events to represent
The convenient way to track the mouse is to ask for events to represent
mouse motion. Then you can wait for motion by waiting for an event. In
addition, you can easily handle any other sorts of events that may
occur. That is useful, because normally you don't want to track the
@ -2019,8 +2019,6 @@ a mouse.
@end defun
@defun display-graphic-p &optional display
@cindex frames, more than one on display
@cindex fonts, more than one on display
This function returns @code{t} if @var{display} is a graphic display
capable of displaying several frames and several different fonts at
once. This is true for displays that use a window system such as X, and

View File

@ -6,7 +6,7 @@
@setfilename ../info/lists
@node Lists, Sequences Arrays Vectors, Strings and Characters, Top
@chapter Lists
@cindex list
@cindex lists
@cindex element (of list)
A @dfn{list} represents a sequence of zero or more elements (which may
@ -30,7 +30,6 @@ the whole list.
@node Cons Cells
@section Lists and Cons Cells
@cindex lists and cons cells
@cindex @code{nil} and lists
Lists in Lisp are not a primitive data type; they are built up from
@dfn{cons cells}. A cons cell is a data object that represents an
@ -104,7 +103,6 @@ otherwise. @code{nil} is not a cons cell, although it @emph{is} a list.
@end defun
@defun atom object
@cindex atoms
This function returns @code{t} if @var{object} is an atom, @code{nil}
otherwise. All objects except cons cells are atoms. The symbol
@code{nil} is an atom and is also a list; it is the only Lisp object
@ -1305,7 +1303,7 @@ compare @var{object} against the elements of the list. For example:
@end defun
@defun delq object list
@cindex deletion of elements
@cindex deleting list elements
This function destructively removes all elements @code{eq} to
@var{object} from @var{list}. The letter @samp{q} in @code{delq} says
that it uses @code{eq} to compare @var{object} against the elements of

View File

@ -268,9 +268,8 @@ if so, @code{nil} otherwise. The argument must be a number.
@node Comparison of Numbers
@section Comparison of Numbers
@cindex number equality
@cindex number comparison
@cindex compare numbers
@cindex comparing numbers
To test numbers for numerical equality, you should normally use
@code{=}, not @code{eq}. There can be many distinct floating point
@ -391,8 +390,8 @@ This function returns the absolute value of @var{number}.
@node Numeric Conversions
@section Numeric Conversions
@cindex rounding in conversions
@cindex numeric conversions
@cindex convert number
@cindex number conversions
@cindex converting numbers
To convert an integer to floating point, use the function @code{float}.
@ -738,6 +737,8 @@ and returns that value as a floating point number.
@node Bitwise Operations
@section Bitwise Operations on Integers
@cindex bitwise arithmetic
@cindex logical arithmetic
In a computer, an integer is represented as a binary number, a
sequence of @dfn{bits} (digits which are either zero or one). A bitwise
@ -919,8 +920,6 @@ Here are other examples:
@end defun
@defun logand &rest ints-or-markers
@cindex logical and
@cindex bitwise and
This function returns the ``logical and'' of the arguments: the
@var{n}th bit is set in the result if, and only if, the @var{n}th bit is
set in all the arguments. (``Set'' means that the value of the bit is 1
@ -972,8 +971,6 @@ because its binary representation consists entirely of ones. If
@end defun
@defun logior &rest ints-or-markers
@cindex logical inclusive or
@cindex bitwise or
This function returns the ``inclusive or'' of its arguments: the @var{n}th bit
is set in the result if, and only if, the @var{n}th bit is set in at least
one of the arguments. If there are no arguments, the result is zero,
@ -999,8 +996,6 @@ passed just one argument, it returns that argument.
@end defun
@defun logxor &rest ints-or-markers
@cindex bitwise exclusive or
@cindex logical exclusive or
This function returns the ``exclusive or'' of its arguments: the
@var{n}th bit is set in the result if, and only if, the @var{n}th bit is
set in an odd number of the arguments. If there are no arguments, the
@ -1026,8 +1021,6 @@ result is 0, which is an identity element for this operation. If
@end defun
@defun lognot integer
@cindex logical not
@cindex bitwise not
This function returns the logical complement of its argument: the @var{n}th
bit is one in the result if, and only if, the @var{n}th bit is zero in
@var{integer}, and vice-versa.