aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEli Zaretskii2008-10-18 19:31:15 +0000
committerEli Zaretskii2008-10-18 19:31:15 +0000
commit2ee797be40149143d64cb3f8637798c99e07129a (patch)
treecf24baac96b9f10da0842381c32a19695fbeec5f
parent1586be929ea7d305875d8793552d4607f0e11694 (diff)
downloademacs-2ee797be40149143d64cb3f8637798c99e07129a.tar.gz
emacs-2ee797be40149143d64cb3f8637798c99e07129a.zip
(Text from Minibuffer): Fix description of `read-regexp'.
-rw-r--r--doc/lispref/minibuf.texi22
1 files changed, 10 insertions, 12 deletions
diff --git a/doc/lispref/minibuf.texi b/doc/lispref/minibuf.texi
index f341613494f..8140e143a71 100644
--- a/doc/lispref/minibuf.texi
+++ b/doc/lispref/minibuf.texi
@@ -203,24 +203,22 @@ This function works by calling the
203@end smallexample 203@end smallexample
204@end defun 204@end defun
205 205
206@defun read-regexp prompt &optional default 206@defun read-regexp prompt &optional default-value
207This function reads a regular expression as a string from the 207This function reads a regular expression as a string from the
208minibuffer and returns it. The argument @var{prompt} is used as in 208minibuffer and returns it. The argument @var{prompt} is used as in
209@code{read-from-minibuffer}. The keymap used is 209@code{read-from-minibuffer}. The keymap used is
210@code{minibuffer-local-map}, and @code{regexp-history} is used as the 210@code{minibuffer-local-map}, and @code{regexp-history} is used as the
211history list (@pxref{Minibuffer History, regexp-history}). 211history list (@pxref{Minibuffer History, regexp-history}).
212 212
213The optional argument @var{default}, if non-@code{nil}, specifies a 213The optional argument @var{default-value} specifies a default value to
214default value to return if the user enters null input. As 214return if the user enters null input; it should be a string, or
215in @code{read-from-minibuffer} it should be a string, a list of 215@code{nil} which is equivalent to an empty string.
216strings, or @code{nil} which is equivalent to an empty string. When 216
217@var{default} is a string, that string is the default value. When it 217In addition, @code{read-regexp} collects a few useful candidates for
218is a list of strings, the first string is the default value. To this 218input and passes them to @code{read-from-minibuffer}, to make them
219default @code{read-regexp} adds a few other useful candidates, and 219available to the user as the ``future minibuffer history list''
220passes them to @code{read-from-minibuffer} to make them available to 220(@pxref{Minibuffer History, future list,, emacs, The GNU Emacs
221the user as the ``future minibuffer history list'' (@pxref{Minibuffer 221Manual}). These candidates are:
222History, future list,, emacs, The GNU Emacs Manual}). These
223candidates are:
224 222
225@itemize @minus 223@itemize @minus
226@item 224@item