]> git.eshelyaron.com Git - emacs.git/commitdiff
doc/lispref/buffers.texi: Add documentation of some user options for Ido.
authorXue Fuqiao <xfq.free@gmail.com>
Thu, 8 Aug 2013 13:53:30 +0000 (21:53 +0800)
committerXue Fuqiao <xfq.free@gmail.com>
Thu, 8 Aug 2013 13:53:30 +0000 (21:53 +0800)
doc/misc/ChangeLog
doc/misc/ido.texi

index d33c4512505eb8e619f9da54b96d6478b190d4fd..4134895073fa5bc4a3892f4f85edd50335653ee5 100644 (file)
@@ -2,7 +2,8 @@
 
        * ido.texi (Top): Insert node "Working Directories" in menu.
        (Working Directories): New node.
-       (Misc Customization): Add documentation of `ido-confirm-unique-completion'.
+       (Misc Customization): Add documentation of
+       `ido-confirm-unique-completion' and some other user options.
 
 2013-08-07  Eli Zaretskii  <eliz@gnu.org>
 
index a31db26fc27822dbccaa8ea40b5038b122721beb..48636a9fb92ceec5379e56618d8316da038371b5 100644 (file)
@@ -582,6 +582,9 @@ the name of an ignored file, Ido will still let you open it just fine.
 @section Miscellaneous Customization
 @cindex miscellaneous customization for Ido
 
+@c Variables described in this sections may be moved to new nodes in
+@c the future.
+
 @defvr {User Option} ido-mode
 This user option determines for which functional group (buffer and
 files) Ido behavior should be enabled.
@@ -606,16 +609,37 @@ if you type a dot as first char (even if @code{ido-enable-prefix} is
 @end defvr
 
 @defvr {User Option} ido-confirm-unique-completion
-If the value of this user option is non-@code{nil} , even a unique
+If the value of this user option is non-@code{nil}, even a unique
 completion must be confirmed.  This means that @code{ido-complete}
 (@key{TAB}) must always be followed by @code{ido-exit-minibuffer}
 (@key{RET}) even when there is only one unique completion.
 @end defvr
 
-@c @defvr {User Option} ido-cannot-complete-command
+@defvr {User Option} ido-cannot-complete-command
+When @code{ido-complete} can't complete any more, it will run the
+command specified by this user option.  The most useful values are
+@code{ido-completion-help}, which pops up a window with completion
+alternatives, or @code{ido-next-match} or @code{ido-prev-match}, which
+cycle the buffer list.
+@end defvr
+
+@defvr {User Option} ido-max-file-prompt-width
+This user option specifies the upper limit of the prompt string.  If
+its value is an integer, it specifies the number of characters of the
+string.  If its value is a floating point number, it specifies a
+fraction of the frame width.
+@end defvr
+
+@defvr {User Option} ido-max-window-height
+If the value of this user option is non@code{nil}, its value will
+override the variable @code{max-mini-window-height}, which is the
+maximum height for resizing mini-windows (the minibuffer and the echo
+area).  If it's a floating point number, it specifies a fraction of
+the mini-window frame's height.  If it's an integer, it specifies the
+number of lines.
+@end defvr
+
 @c @defvr {User Option} ido-record-commands
-@c @defvr {User Option} ido-max-file-prompt-width
-@c @defvr {User Option} ido-max-window-height
 @c @defvr {User Option} ido-enable-last-directory-history
 @c @defvr {User Option} ido-enable-tramp-completion
 @c @defvr {User Option} ido-unc-hosts