diff options
| -rw-r--r-- | lisp/minibuffer.el | 24 |
1 files changed, 19 insertions, 5 deletions
diff --git a/lisp/minibuffer.el b/lisp/minibuffer.el index 62282be696f..c7e3376e531 100644 --- a/lisp/minibuffer.el +++ b/lisp/minibuffer.el | |||
| @@ -1105,17 +1105,31 @@ the same non-empty string that was inserted by this function. | |||
| 1105 | If the user exits with an empty minibuffer, this function returns | 1105 | If the user exits with an empty minibuffer, this function returns |
| 1106 | an empty string. (This can only happen if the user erased the | 1106 | an empty string. (This can only happen if the user erased the |
| 1107 | pre-inserted contents or if `insert-default-directory' is nil.) | 1107 | pre-inserted contents or if `insert-default-directory' is nil.) |
| 1108 | Fourth arg MUSTMATCH non-nil means require existing file's name. | 1108 | |
| 1109 | Non-nil and non-t means also require confirmation after completion. | 1109 | Fourth arg MUSTMATCH can take the following values: |
| 1110 | - nil means that the user can exit with any input. | ||
| 1111 | - t means that the user is not allowed to exit unless | ||
| 1112 | the input is (or completes to) an existing file. | ||
| 1113 | - `confirm' means that the user can exit with any input, but she needs | ||
| 1114 | to confirm her choice if the input is not an existing file. | ||
| 1115 | - `confirm-after-completion' means that the user can exit with any | ||
| 1116 | input, but she needs to confirm her choice if she called | ||
| 1117 | `minibuffer-complete' right before `minibuffer-complete-and-exit' | ||
| 1118 | and the input is not an existing file. | ||
| 1119 | - anything else behaves like t except that typing RET does not exit if it | ||
| 1120 | does non-null completion. | ||
| 1121 | |||
| 1110 | Fifth arg INITIAL specifies text to start with. | 1122 | Fifth arg INITIAL specifies text to start with. |
| 1123 | |||
| 1111 | If optional sixth arg PREDICATE is non-nil, possible completions and | 1124 | If optional sixth arg PREDICATE is non-nil, possible completions and |
| 1112 | the resulting file name must satisfy (funcall PREDICATE NAME). | 1125 | the resulting file name must satisfy (funcall PREDICATE NAME). |
| 1113 | DIR should be an absolute directory name. It defaults to the value of | 1126 | DIR should be an absolute directory name. It defaults to the value of |
| 1114 | `default-directory'. | 1127 | `default-directory'. |
| 1115 | 1128 | ||
| 1116 | If this command was invoked with the mouse, use a file dialog box if | 1129 | If this command was invoked with the mouse, use a graphical file |
| 1117 | `use-dialog-box' is non-nil, and the window system or X toolkit in use | 1130 | dialog if `use-dialog-box' is non-nil, and the window system or X |
| 1118 | provides a file dialog box. | 1131 | toolkit in use provides a file dialog box. For graphical file |
| 1132 | dialogs, any non-nil value of MUSTMATCH is equivalent to t. | ||
| 1119 | 1133 | ||
| 1120 | See also `read-file-name-completion-ignore-case' | 1134 | See also `read-file-name-completion-ignore-case' |
| 1121 | and `read-file-name-function'." | 1135 | and `read-file-name-function'." |