summaryrefslogtreecommitdiff
path: root/lispref
diff options
context:
space:
mode:
authorEli Zaretskii <eliz@gnu.org>2001-09-08 17:54:25 +0000
committerEli Zaretskii <eliz@gnu.org>2001-09-08 17:54:25 +0000
commit2842de3068a4077c4041026641ff24dc28691342 (patch)
tree071f69424db303797543505440c7835cf7e31a79 /lispref
parent42703598b1e08b0ba34b744f0e8db8459ad278fa (diff)
downloademacs-2842de3068a4077c4041026641ff24dc28691342.tar.gz
(Using Interactive): Document interactive-form.
(Keyboard Macros): Document kbd-macro-termination-hook. (Command Loop Info): Document that clear-this-command-keys clears the vector to be returned by recent-keys.
Diffstat (limited to 'lispref')
-rw-r--r--lispref/ChangeLog59
-rw-r--r--lispref/commands.texi27
2 files changed, 82 insertions, 4 deletions
diff --git a/lispref/ChangeLog b/lispref/ChangeLog
index 6d77cc9507b..9bc13838a5c 100644
--- a/lispref/ChangeLog
+++ b/lispref/ChangeLog
@@ -1,3 +1,62 @@
+2001-09-08 Eli Zaretskii <eliz@is.elta.co.il>
+
+ * strings.texi (String Conversion) <string-to-number>: Document
+ that a float is returned for integers that are too large.
+
+ * frames.texi (Mouse Position): Document mouse-position-function.
+ (Display Feature Testing): Document display-images-p.
+ (Window Frame Parameters): Document the cursor-type variable.
+
+ * numbers.texi (Integer Basics): Document CL style read syntax for
+ integers in bases other than 10.
+
+ * positions.texi (List Motion): Document
+ open-paren-in-column-0-is-defun-start.
+
+ * lists.texi (Sets And Lists): Document member-ignore-case.
+
+ * internals.texi (Garbage Collection): Document the used and free
+ strings report.
+ (Memory Usage): Document strings-consed.
+
+ * os.texi (Time of Day): Document float-time.
+ (Recording Input): Document that clear-this-command-keys clears
+ the vector to be returned by recent-keys.
+
+ * keymaps.texi (Scanning Keymaps) <where-is-internal>: The
+ argument keymap can be a list.
+
+ * nonascii.texi (User-Chosen Coding Systems)
+ <select-safe-coding-system>: Document the new argument
+ accept-default-p and the variable
+ select-safe-coding-system-accept-default-p. Tell what happens if
+ buffer-file-coding-system is undecided.
+ (Default Coding Systems): Document auto-coding-regexp-alist.
+
+ * display.texi (The Echo Area) <message>: Document
+ message-truncate-lines.
+ (Glyphs): Document that the glyph table is unused on windowed
+ displays.
+
+ * help.texi (Describing Characters) <single-key-description>:
+ Document the new argument no-angles.
+ (Accessing Documentation) <documentation-property>: Document that
+ a non-string property is evaluated.
+ <documentation>: Document that the function-documentation property
+ is looked for.
+
+ * windows.texi (Selecting Windows): Document some-window.
+
+ * text.texi (MD5 Checksum): New node, documents the md5 primitive.
+
+ * hooks.texi (Standard Hooks): Add kbd-macro-termination-hook and
+ apropos-mode-hook.
+
+ * commands.texi (Using Interactive): Document interactive-form.
+ (Keyboard Macros): Document kbd-macro-termination-hook.
+ (Command Loop Info): Document that clear-this-command-keys clears
+ the vector to be returned by recent-keys.
+
2001-09-04 Werner LEMBERG <wl@gnu.org>
* Makefile.in (srcdir, texinputdir): New variables.
diff --git a/lispref/commands.texi b/lispref/commands.texi
index 4a204f5f6e7..5882f261615 100644
--- a/lispref/commands.texi
+++ b/lispref/commands.texi
@@ -114,7 +114,8 @@ controls the reading of arguments for an interactive call.
@subsection Using @code{interactive}
This section describes how to write the @code{interactive} form that
-makes a Lisp function an interactively-callable command.
+makes a Lisp function an interactively-callable command, and how to
+obtain the interactive form of a command.
@defspec interactive arg-descriptor
@cindex argument descriptors
@@ -228,6 +229,17 @@ string (starting with the first character that is not @samp{*} or
@samp{@@}).
@end itemize
+@cindex obtaining interactive form of a function
+@defun interactive-form function
+This function returns the interactive form of @var{function}. If
+@var{function} is a command (@pxref{Interactive Call}), the value is a
+list of the form @code{(interactive @var{spec})}, where @var{spec} is
+the descriptor specification used by the command's @code{interactive}
+form to compute the function's arguments (@pxref{Using Interactive}).
+If @var{function} is not a command, @code{interactive-form} returns
+@code{nil}.
+@end defun
+
@node Interactive Codes
@comment node-name, next, previous, up
@subsection Code Characters for @code{interactive}
@@ -735,9 +747,11 @@ input events in a string (@pxref{Strings of Events}).
@tindex clear-this-command-keys
@defun clear-this-command-keys
This function empties out the table of events for
-@code{this-command-keys} to return. This is useful after reading a
-password, to prevent the password from echoing inadvertently as part of
-the next command in certain cases.
+@code{this-command-keys} to return, and also cause the function
+@code{recent-keys} (@pxref{Recording Input}) to return an empty
+vector. This is useful after reading a password, to prevent the
+password from echoing inadvertently as part of the next command in
+certain cases.
@end defun
@defvar last-nonmenu-event
@@ -2776,3 +2790,8 @@ The variable is always local to the current terminal and cannot be
buffer-local. @xref{Multiple Displays}.
@end defvar
+@defvar kbd-macro-termination-hook
+This normal hook (@pxref{Standard Hooks}) is run when a keyboard
+macro terminates, regardless of what caused it to terminate (reaching
+the macro end or an error which ended the macro prematurely).
+@end defvar