From: Chong Yidong <cyd@stupidchicken.com>
Date: Mon, 2 Nov 2009 02:30:04 +0000 (+0000)
Subject: * minibuf.texi (Reading File Names): Note that read-file-name may
X-Git-Url: http://git.hcoop.net/bpt/emacs.git/commitdiff_plain/0f063651e220bcb450d760e9e365a05acf1aed30

* minibuf.texi (Reading File Names): Note that read-file-name may
use a graphical file dialog.
---

diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog
index 31b4f7fc25..e455d15edc 100644
--- a/doc/lispref/ChangeLog
+++ b/doc/lispref/ChangeLog
@@ -1,3 +1,8 @@
+2009-11-02  Chong Yidong  <cyd@stupidchicken.com>
+
+	* minibuf.texi (Reading File Names): Note that read-file-name may
+	use a graphical file dialog.
+
 2009-10-31  Glenn Morris  <rgm@gnu.org>
 
 	* nonascii.texi (User-Chosen Coding Systems): Minor reword.  (Bug#4817)
diff --git a/doc/lispref/minibuf.texi b/doc/lispref/minibuf.texi
index c28ab70e2d..2702cf7916 100644
--- a/doc/lispref/minibuf.texi
+++ b/doc/lispref/minibuf.texi
@@ -1337,8 +1337,19 @@ They provide special features, including automatic insertion of the
 default directory.
 
 @defun read-file-name prompt &optional directory default require-match initial predicate
-This function reads a file name in the minibuffer, prompting with
-@var{prompt} and providing completion.
+This function reads a file name, prompting with @var{prompt} and
+providing completion.
+
+As an exception, this function reads a file name using a graphical
+file dialog instead of the minibuffer, if (i) it is invoked via a
+mouse command, and (ii) the selected frame is on a graphical display
+supporting such dialogs, and (iii) the variable @code{use-dialog-box}
+is non-@code{nil} (@pxref{Dialog Boxes,, Dialog Boxes, emacs, The GNU
+Emacs Manual}), and (iv) the @var{directory} argument, described
+below, does not specify a remote file (@pxref{Remote Files,, Remote
+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}.
@@ -1355,7 +1366,6 @@ 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}.
 
-@c Emacs 19 feature
 If you specify @var{initial}, that is an initial file name to insert
 in the buffer (after @var{directory}, if that is inserted).  In this
 case, point goes at the beginning of @var{initial}.  The default for