Mercurial > emacs
comparison doc/lispref/minibuf.texi @ 94530:61f7b39f5e96
(Text from Minibuffer): Document a list of default values for `read-from-minibuffer'.
author | Juri Linkov <juri@jurta.org> |
---|---|
date | Fri, 02 May 2008 01:03:21 +0000 |
parents | 114d8f4904d0 |
children | 9cbd69c7bb9d |
comparison
equal
deleted
inserted
replaced
94529:1a15fe275e93 | 94530:61f7b39f5e96 |
---|---|
131 The argument @var{default} specifies default values to make available | 131 The argument @var{default} specifies default values to make available |
132 through the history commands. It should be a string, a list of | 132 through the history commands. It should be a string, a list of |
133 strings, or @code{nil}. The string or strings become the minibuffer's | 133 strings, or @code{nil}. The string or strings become the minibuffer's |
134 ``future history,'' available to the user with @kbd{M-n}. | 134 ``future history,'' available to the user with @kbd{M-n}. |
135 | 135 |
136 If @var{read} is non-@code{nil}, then @var{default} is also used as | 136 If @var{read} is non-@code{nil}, then @var{default} is also used |
137 the input to @code{read}, if the user enters empty input. (If | 137 as the input to @code{read}, if the user enters empty input. |
138 @var{read} is non-@code{nil} and @var{default} is @code{nil}, empty | 138 If @var{default} is a list of strings, the first string is used as the input. |
139 input results in an @code{end-of-file} error.) However, in the usual | 139 If @var{default} is @code{nil}, empty input results in an @code{end-of-file} error. |
140 case (where @var{read} is @code{nil}), @code{read-from-minibuffer} | 140 However, in the usual case (where @var{read} is @code{nil}), |
141 ignores @var{default} when the user enters empty input and returns an | 141 @code{read-from-minibuffer} ignores @var{default} when the user enters |
142 empty string, @code{""}. In this respect, it differs from all the | 142 empty input and returns an empty string, @code{""}. In this respect, |
143 other minibuffer input functions in this chapter. | 143 it differs from all the other minibuffer input functions in this chapter. |
144 | 144 |
145 If @var{keymap} is non-@code{nil}, that keymap is the local keymap to | 145 If @var{keymap} is non-@code{nil}, that keymap is the local keymap to |
146 use in the minibuffer. If @var{keymap} is omitted or @code{nil}, the | 146 use in the minibuffer. If @var{keymap} is omitted or @code{nil}, the |
147 value of @code{minibuffer-local-map} is used as the keymap. Specifying | 147 value of @code{minibuffer-local-map} is used as the keymap. Specifying |
148 a keymap is the most important way to customize the minibuffer for | 148 a keymap is the most important way to customize the minibuffer for |