aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRichard M. Stallman2001-09-10 05:34:15 +0000
committerRichard M. Stallman2001-09-10 05:34:15 +0000
commitcaae20c74105a60dd36d9b4c382e4f1d37db5997 (patch)
tree03c74f3c98044ee8d2e8c5daea633d5143ed208b
parentac7ed6424ca09e406251602fb77a02776cab0175 (diff)
downloademacs-caae20c74105a60dd36d9b4c382e4f1d37db5997.tar.gz
emacs-caae20c74105a60dd36d9b4c382e4f1d37db5997.zip
Clarify recent changes.
-rw-r--r--lispref/commands.texi20
-rw-r--r--lispref/display.texi8
-rw-r--r--lispref/frames.texi19
-rw-r--r--lispref/help.texi52
-rw-r--r--lispref/nonascii.texi2
-rw-r--r--lispref/os.texi2
6 files changed, 56 insertions, 47 deletions
diff --git a/lispref/commands.texi b/lispref/commands.texi
index 5882f261615..343617c6169 100644
--- a/lispref/commands.texi
+++ b/lispref/commands.texi
@@ -115,7 +115,7 @@ controls the reading of arguments for an interactive call.
115 115
116 This section describes how to write the @code{interactive} form that 116 This section describes how to write the @code{interactive} form that
117makes a Lisp function an interactively-callable command, and how to 117makes a Lisp function an interactively-callable command, and how to
118obtain the interactive form of a command. 118examine a commands's @code{interactive} form.
119 119
120@defspec interactive arg-descriptor 120@defspec interactive arg-descriptor
121@cindex argument descriptors 121@cindex argument descriptors
@@ -211,12 +211,12 @@ give to that buffer:
211@end group 211@end group
212@end smallexample 212@end smallexample
213 213
214@cindex @samp{*} in interactive 214@cindex @samp{*} in @code{interactive}
215@cindex read-only buffers in interactive 215@cindex read-only buffers in interactive
216If the first character in the string is @samp{*}, then an error is 216If the first character in the string is @samp{*}, then an error is
217signaled if the buffer is read-only. 217signaled if the buffer is read-only.
218 218
219@cindex @samp{@@} in interactive 219@cindex @samp{@@} in @code{interactive}
220@c Emacs 19 feature 220@c Emacs 19 feature
221If the first character in the string is @samp{@@}, and if the key 221If the first character in the string is @samp{@@}, and if the key
222sequence used to invoke the command includes any mouse events, then 222sequence used to invoke the command includes any mouse events, then
@@ -229,9 +229,9 @@ string (starting with the first character that is not @samp{*} or
229@samp{@@}). 229@samp{@@}).
230@end itemize 230@end itemize
231 231
232@cindex obtaining interactive form of a function 232@cindex examining the @code{interactive} form
233@defun interactive-form function 233@defun interactive-form function
234This function returns the interactive form of @var{function}. If 234This function returns the @code{interactive} form of @var{function}. If
235@var{function} is a command (@pxref{Interactive Call}), the value is a 235@var{function} is a command (@pxref{Interactive Call}), the value is a
236list of the form @code{(interactive @var{spec})}, where @var{spec} is 236list of the form @code{(interactive @var{spec})}, where @var{spec} is
237the descriptor specification used by the command's @code{interactive} 237the descriptor specification used by the command's @code{interactive}
@@ -747,11 +747,11 @@ input events in a string (@pxref{Strings of Events}).
747@tindex clear-this-command-keys 747@tindex clear-this-command-keys
748@defun clear-this-command-keys 748@defun clear-this-command-keys
749This function empties out the table of events for 749This function empties out the table of events for
750@code{this-command-keys} to return, and also cause the function 750@code{this-command-keys} to return, and also empties the records that
751@code{recent-keys} (@pxref{Recording Input}) to return an empty 751the function @code{recent-keys} (@pxref{Recording Input}) will
752vector. This is useful after reading a password, to prevent the 752subsequently return. This is useful after reading a password, to
753password from echoing inadvertently as part of the next command in 753prevent the password from echoing inadvertently as part of the next
754certain cases. 754command in certain cases.
755@end defun 755@end defun
756 756
757@defvar last-nonmenu-event 757@defvar last-nonmenu-event
diff --git a/lispref/display.texi b/lispref/display.texi
index 5198657c273..b6d5a54ae62 100644
--- a/lispref/display.texi
+++ b/lispref/display.texi
@@ -199,10 +199,10 @@ its normal size. If the minibuffer is active, this brings the
199minibuffer contents back onto the screen immediately. 199minibuffer contents back onto the screen immediately.
200 200
201@vindex message-truncate-lines 201@vindex message-truncate-lines
202Normally, displaying a message that is longer than one line resizes 202Normally, displaying a long message resizes the echo area to display
203the echo area to display the entire message. But if the variable 203the entire message. But if the variable @code{message-truncate-lines}
204@code{message-truncate-lines} is non-@code{nil}, the echo area does 204is non-@code{nil}, the echo area does not resize, and the message is
205not resize, and the message is truncated, as in Emacs 20 and before. 205truncated to fit it, as in Emacs 20 and before.
206 206
207@example 207@example
208@group 208@group
diff --git a/lispref/frames.texi b/lispref/frames.texi
index 3a769695f49..0e78b88aa8a 100644
--- a/lispref/frames.texi
+++ b/lispref/frames.texi
@@ -491,7 +491,6 @@ This parameter describes the range of possible colors that can be used
491in this frame. Its value is @code{color}, @code{grayscale} or 491in this frame. Its value is @code{color}, @code{grayscale} or
492@code{mono}. 492@code{mono}.
493 493
494@vindex cursor-type
495@item cursor-type 494@item cursor-type
496The way to display the cursor. The legitimate values are @code{bar}, 495The way to display the cursor. The legitimate values are @code{bar},
497@code{box}, and @code{(bar . @var{width})}. The symbol @code{box} 496@code{box}, and @code{(bar . @var{width})}. The symbol @code{box}
@@ -500,6 +499,7 @@ that is the default. The symbol @code{bar} specifies a vertical bar
500between characters as the cursor. @code{(bar . @var{width})} specifies 499between characters as the cursor. @code{(bar . @var{width})} specifies
501a bar @var{width} pixels wide. 500a bar @var{width} pixels wide.
502 501
502@vindex cursor-type
503The buffer-local variable @code{cursor-type} overrides the value of 503The buffer-local variable @code{cursor-type} overrides the value of
504the @code{cursor-type} frame parameter, and can in addition have 504the @code{cursor-type} frame parameter, and can in addition have
505values @code{t} (use the cursor specified for the frame) and 505values @code{t} (use the cursor specified for the frame) and
@@ -1148,10 +1148,13 @@ the top left corner of the inside of @var{frame}.
1148@end defun 1148@end defun
1149 1149
1150@defvar mouse-position-function 1150@defvar mouse-position-function
1151If non-nil, the value of this variable is a function applied to the 1151If non-@code{nil}, the value of this variable is a function for
1152normal result of @code{mouse-position}. This abnormal hook exists for 1152@code{mouse-position} to call. @code{mouse-position} calls this
1153the benefit of packages like XTerm-mouse which need to do mouse 1153function just before returning, with its normal return value as the
1154handling at the Lisp level. 1154sole argument, and it returns whatever this function returns to it.
1155
1156This abnormal hook exists for the benefit of packages like
1157@file{xt-mouse.el} that need to do mouse handling at the Lisp level.
1155@end defvar 1158@end defvar
1156 1159
1157@defun set-mouse-position frame x y 1160@defun set-mouse-position frame x y
@@ -1663,9 +1666,9 @@ supported in some other cases.
1663 1666
1664@defun display-images-p &optional display 1667@defun display-images-p &optional display
1665This function returns @code{t} if @var{display} can display images. 1668This function returns @code{t} if @var{display} can display images.
1666Windowed displays normally can display images, but some systems can 1669Windowed displays ought in principle to handle images, but some
1667lack the necessary support for that. If images aren't supported, the 1670systems lack the support for that. On a display that does not support
1668tool bar cannot be displayed. 1671images, Emacs cannot display a tool bar.
1669@end defun 1672@end defun
1670 1673
1671@defun display-screens &optional display 1674@defun display-screens &optional display
diff --git a/lispref/help.texi b/lispref/help.texi
index a601825d053..eb9dc0a75d7 100644
--- a/lispref/help.texi
+++ b/lispref/help.texi
@@ -107,13 +107,15 @@ use to print nice-looking hardcopy for the file
107@section Access to Documentation Strings 107@section Access to Documentation Strings
108 108
109@defun documentation-property symbol property &optional verbatim 109@defun documentation-property symbol property &optional verbatim
110This function returns the documentation string that is recorded 110This function returns the documentation string that is recorded in
111in @var{symbol}'s property list under property @var{property}. It 111@var{symbol}'s property list under property @var{property}. It
112retrieves the text from a file if necessary, and runs 112retrieves the text from a file if the value calls for that. If the
113@code{substitute-command-keys} to substitute actual key bindings. (This 113property value isn't @code{nil}, isn't a string, and doesn't refer to
114substitution is not done if @var{verbatim} is non-@code{nil}.) If 114text in a file, then it is evaluated to obtain a string.
115@var{property} isn't a string and doesn't refer to the documentation 115
116file @file{etc/DOC}, it is evaluated to obtain a string. 116Finally, @code{documentation-property} passes the string through
117@code{substitute-command-keys} to substitute actual key bindings,
118unless @var{verbatim} is non-@code{nil}.
117 119
118@smallexample 120@smallexample
119@group 121@group
@@ -129,14 +131,18 @@ file @file{etc/DOC}, it is evaluated to obtain a string.
129@end defun 131@end defun
130 132
131@defun documentation function &optional verbatim 133@defun documentation function &optional verbatim
132This function returns the documentation string of @var{function}. If 134This function returns the documentation string of @var{function}.
133@var{function} is a symbol, this function looks for a 135
134@code{function-documentation'} property of that symbol; if it has a 136If @var{function} is a symbol, this function first looks for the
135non-@code{nil} value, the documentation is taken from that value (if 137@code{function-documentation} property of that symbol; if that has a
136the value is not a string, it is evaluated). Alternatively, 138non-@code{nil} value, the documentation comes from that value (if the
137@code{documentation} reads the text from a file if necessary. Then 139value is not a string, it is evaluated). If @var{function} is not a
138(unless @var{verbatim} is non-@code{nil}) it calls 140symbol, or if it has no @code{function-documentation} property, then
139@code{substitute-command-keys}, to return a value containing the 141@code{documentation} extracts the documentation string from the actual
142function definition, reading it from a file if called for.
143
144Finally, unless @var{verbatim} is non-@code{nil}, it calls
145@code{substitute-command-keys} so as to return a value containing the
140actual (current) key bindings. 146actual (current) key bindings.
141 147
142The function @code{documentation} signals a @code{void-function} error 148The function @code{documentation} signals a @code{void-function} error
@@ -382,17 +388,17 @@ about valid events. See also the examples for
382@cindex control character printing 388@cindex control character printing
383@cindex meta character printing 389@cindex meta character printing
384This function returns a string describing @var{event} in the standard 390This function returns a string describing @var{event} in the standard
385Emacs notation for keyboard input. A normal printing character appears 391Emacs notation for keyboard input. A normal printing character
386as itself, but a control character turns into a string starting with 392appears as itself, but a control character turns into a string
387@samp{C-}, a meta character turns into a string starting with @samp{M-}, 393starting with @samp{C-}, a meta character turns into a string starting
388and space, tab, etc.@: appear as @samp{SPC}, @samp{TAB}, etc. A 394with @samp{M-}, and space, tab, etc.@: appear as @samp{SPC},
389function key symbol appears as itsels, but inside angle brackets 395@samp{TAB}, etc. A function key symbol appears inside angle brackets
390@samp{<>}. An event that is a list appears as the name of the symbol 396@samp{<@dots{}>}. An event that is a list appears as the name of the
391in the @sc{car} of the list, inside angle brackets. 397symbol in the @sc{car} of the list, inside angle brackets.
392 398
393If the optional argument @var{no-angles} is non-@code{nil}, the angle 399If the optional argument @var{no-angles} is non-@code{nil}, the angle
394brackets around function keys and event symbols are omitted; this is 400brackets around function keys and event symbols are omitted; this is
395for compatibility with old versions of Emacs which didn't print the 401for compatibility with old versions of Emacs which didn't use the
396brackets. 402brackets.
397 403
398@smallexample 404@smallexample
diff --git a/lispref/nonascii.texi b/lispref/nonascii.texi
index d412555eef4..0e67bcb0c4e 100644
--- a/lispref/nonascii.texi
+++ b/lispref/nonascii.texi
@@ -744,7 +744,7 @@ This function selects a coding system for encoding specified text,
744asking the user to choose if necessary. Normally the specified text 744asking the user to choose if necessary. Normally the specified text
745is the text in the current buffer between @var{from} and @var{to}, 745is the text in the current buffer between @var{from} and @var{to},
746defaulting to the whole buffer if they are @code{nil}. If @var{from} 746defaulting to the whole buffer if they are @code{nil}. If @var{from}
747is a string, the string is the target text, and @var{to} is ignored. 747is a string, the string is the specified text, and @var{to} is ignored.
748 748
749If @var{default-coding-system} is non-@code{nil}, that is the first 749If @var{default-coding-system} is non-@code{nil}, that is the first
750coding system to try; if that can handle the text, 750coding system to try; if that can handle the text,
diff --git a/lispref/os.texi b/lispref/os.texi
index fcab89e72ef..6c4a86e3bbe 100644
--- a/lispref/os.texi
+++ b/lispref/os.texi
@@ -1633,7 +1633,7 @@ they were used as parts of key sequences. Thus, you always get the last
1633should be enough to see the events that invoked the macros.) 1633should be enough to see the events that invoked the macros.)
1634 1634
1635A call to @code{clear-this-command-keys} (@pxref{Command Loop Info}) 1635A call to @code{clear-this-command-keys} (@pxref{Command Loop Info})
1636causes this function to return an empty vector. 1636causes this function to return an empty vector immediately afterward.
1637@end defun 1637@end defun
1638 1638
1639@deffn Command open-dribble-file filename 1639@deffn Command open-dribble-file filename