Mercurial > emacs
comparison doc/lispref/minibuf.texi @ 98842:0cd40c64e0f2
(Text from Minibuffer): Fix description of `read-regexp'.
author | Eli Zaretskii <eliz@gnu.org> |
---|---|
date | Sat, 18 Oct 2008 19:31:15 +0000 |
parents | 387eae245c1e |
children | 3bc1332e6140 |
comparison
equal
deleted
inserted
replaced
98841:b7164f9c80bc | 98842:0cd40c64e0f2 |
---|---|
201 value)) | 201 value)) |
202 @end group | 202 @end group |
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 |
207 This function reads a regular expression as a string from the | 207 This function reads a regular expression as a string from the |
208 minibuffer and returns it. The argument @var{prompt} is used as in | 208 minibuffer 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 |
211 history list (@pxref{Minibuffer History, regexp-history}). | 211 history list (@pxref{Minibuffer History, regexp-history}). |
212 | 212 |
213 The optional argument @var{default}, if non-@code{nil}, specifies a | 213 The optional argument @var{default-value} specifies a default value to |
214 default value to return if the user enters null input. As | 214 return if the user enters null input; it should be a string, or |
215 in @code{read-from-minibuffer} it should be a string, a list of | 215 @code{nil} which is equivalent to an empty string. |
216 strings, 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 | 217 In addition, @code{read-regexp} collects a few useful candidates for |
218 is a list of strings, the first string is the default value. To this | 218 input and passes them to @code{read-from-minibuffer}, to make them |
219 default @code{read-regexp} adds a few other useful candidates, and | 219 available to the user as the ``future minibuffer history list'' |
220 passes them to @code{read-from-minibuffer} to make them available to | 220 (@pxref{Minibuffer History, future list,, emacs, The GNU Emacs |
221 the user as the ``future minibuffer history list'' (@pxref{Minibuffer | 221 Manual}). These candidates are: |
222 History, future list,, emacs, The GNU Emacs Manual}). These | |
223 candidates are: | |
224 | 222 |
225 @itemize @minus | 223 @itemize @minus |
226 @item | 224 @item |
227 The Word or symbol at point. | 225 The Word or symbol at point. |
228 @item | 226 @item |