diff options
Diffstat (limited to 'doc/lispref/minibuf.texi')
| -rw-r--r-- | doc/lispref/minibuf.texi | 52 |
1 files changed, 22 insertions, 30 deletions
diff --git a/doc/lispref/minibuf.texi b/doc/lispref/minibuf.texi index b2ffc5fede..aa22e6c92f 100644 --- a/doc/lispref/minibuf.texi +++ b/doc/lispref/minibuf.texi @@ -1,7 +1,6 @@ @c -*-texinfo-*- @c This is part of the GNU Emacs Lisp Reference Manual. -@c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998, 1999, 2001, 2002, -@c 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011 +@c Copyright (C) 1990-1995, 1998-1999, 2001-2011 @c Free Software Foundation, Inc. @c See the file elisp.texi for copying conditions. @setfilename ../../info/minibuf @@ -434,18 +433,17 @@ expression, thus moving point forward one word. @cindex minibuffer history @cindex history list - A @dfn{minibuffer history list} records previous minibuffer inputs so -the user can reuse them conveniently. A history list is actually a -symbol, not a list; it is a variable whose value is a list of strings -(previous inputs), most recent first. + A @dfn{minibuffer history list} records previous minibuffer inputs +so the user can reuse them conveniently. It is a variable whose value +is a list of strings (previous inputs), most recent first. - There are many separate history lists, used for different kinds of -inputs. It's the Lisp programmer's job to specify the right history -list for each use of the minibuffer. + There are many separate minibuffer history lists, used for different +kinds of inputs. It's the Lisp programmer's job to specify the right +history list for each use of the minibuffer. - You specify the history list with the optional @var{hist} argument -to either @code{read-from-minibuffer} or @code{completing-read}. Here -are the possible values for it: + You specify a minibuffer history list with the optional @var{hist} +argument to @code{read-from-minibuffer} or @code{completing-read}. +Here are the possible values for it: @table @asis @item @var{variable} @@ -1386,17 +1384,19 @@ Files, emacs, The GNU Emacs Manual}). The exact behavior when using a graphical file dialog is platform-dependent. Here, we simply document the behavior when using the minibuffer. -The optional argument @var{require-match} has the same meaning as in -@code{completing-read}. @xref{Minibuffer Completion}. +@code{read-file-name} does not automatically expand the returned file +name. You must call @code{expand-file-name} yourself if an absolute +file name is required. -@code{read-file-name} uses -@code{minibuffer-local-filename-completion-map} as the keymap if -@var{require-match} is @code{nil}, and uses -@code{minibuffer-local-filename-must-match-map} if @var{require-match} -is non-@code{nil}. @xref{Completion Commands}. +The optional argument @var{require-match} has the same meaning as in +@code{completing-read}. @xref{Minibuffer Completion}. If +@var{require-match} is @code{nil}, the local keymap in the minibuffer +is @code{minibuffer-local-filename-completion-map}; otherwise, it is +@code{minibuffer-local-filename-must-match-map}. @xref{Completion +Commands}. The argument @var{directory} specifies the directory to use for -completion of relative file names. It should be an absolute directory +completing relative file names. It should be an absolute directory name. If @code{insert-default-directory} is non-@code{nil}, @var{directory} is also inserted in the minibuffer as initial input. It defaults to the current buffer's value of @code{default-directory}. @@ -1444,11 +1444,7 @@ argument that decides which file names are acceptable completion possibilities. A file name is an acceptable value if @var{predicate} returns non-@code{nil} for it. -@code{read-file-name} does not automatically expand file names. You -must call @code{expand-file-name} yourself if an absolute file name is -required. - -Here is an example: +Here is an example of using @code{read-file-name}: @example @group @@ -1694,7 +1690,7 @@ match for some possibility; @code{nil} otherwise. @item @code{(boundaries . SUFFIX)} specifies @code{completion-boundaries}. The function should return a value of the form @code{(boundaries -START . END)} where START is the position of the beginning boundary in +START . END)} where START is the position of the beginning boundary in the string to complete, and END is the position of the end boundary in SUFFIX. @end itemize @@ -2195,7 +2191,3 @@ arrives, whichever comes first. If @var{args} is non-@code{nil}, the actual message is obtained by passing @var{string} and @var{args} through @code{format}. @xref{Formatting Strings}. @end defun - -@ignore - arch-tag: bba7f945-9078-477f-a2ce-18818a6e1218 -@end ignore |