Mercurial > emacs
comparison lispref/minibuf.texi @ 58360:0e8e74522f85
(Text from Minibuffer): Document KEEP-ALL arg in read-from-minibuffer.
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Sat, 20 Nov 2004 22:08:39 +0000 |
parents | 08330213d737 |
children | 114da1fc3775 f2ebccfa87d4 |
comparison
equal
deleted
inserted
replaced
58359:81431dd5f1db | 58360:0e8e74522f85 |
---|---|
116 In most cases, you should not call minibuffer input functions in the | 116 In most cases, you should not call minibuffer input functions in the |
117 middle of a Lisp function. Instead, do all minibuffer input as part of | 117 middle of a Lisp function. Instead, do all minibuffer input as part of |
118 reading the arguments for a command, in the @code{interactive} | 118 reading the arguments for a command, in the @code{interactive} |
119 specification. @xref{Defining Commands}. | 119 specification. @xref{Defining Commands}. |
120 | 120 |
121 @defun read-from-minibuffer prompt-string &optional initial-contents keymap read hist default inherit-input-method | 121 @defun read-from-minibuffer prompt-string &optional initial-contents keymap read hist default inherit-input-method keep-all |
122 This function is the most general way to get input through the | 122 This function is the most general way to get input through the |
123 minibuffer. By default, it accepts arbitrary text and returns it as a | 123 minibuffer. By default, it accepts arbitrary text and returns it as a |
124 string; however, if @var{read} is non-@code{nil}, then it uses | 124 string; however, if @var{read} is non-@code{nil}, then it uses |
125 @code{read} to convert the text into a Lisp object (@pxref{Input | 125 @code{read} to convert the text into a Lisp object (@pxref{Input |
126 Functions}). | 126 Functions}). |
168 minibuffer inherits the current input method (@pxref{Input Methods}) and | 168 minibuffer inherits the current input method (@pxref{Input Methods}) and |
169 the setting of @code{enable-multibyte-characters} (@pxref{Text | 169 the setting of @code{enable-multibyte-characters} (@pxref{Text |
170 Representations}) from whichever buffer was current before entering the | 170 Representations}) from whichever buffer was current before entering the |
171 minibuffer. | 171 minibuffer. |
172 | 172 |
173 If @var{keep-all} is non-@code{nil}, even empty and duplicate inputs | |
174 are added to the history list. | |
175 | |
173 Use of @var{initial-contents} is mostly deprecated; we recommend using | 176 Use of @var{initial-contents} is mostly deprecated; we recommend using |
174 a non-@code{nil} value only in conjunction with specifying a cons cell | 177 a non-@code{nil} value only in conjunction with specifying a cons cell |
175 for @var{hist}. @xref{Initial Input}. | 178 for @var{hist}. @xref{Initial Input}. |
176 @end defun | 179 @end defun |
177 | 180 |