Mercurial > hg > xemacs-beta

comparison man/lispref/minibuf.texi @ 5791:9fae6227ede5

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Silence texinfo 5.2 warnings, primarily by adding next, prev, and up pointers to all nodes. See xemacs-patches message with ID <5315f7bf.sHpFD7lXYR05GH6E%james@xemacs.org>.
author Jerry James <james@xemacs.org>
date Thu, 27 Mar 2014 08:59:03 -0600
parents 576fb035e263
children
comparison
equal deleted inserted replaced
5790:dcf9067f26bb 5791:9fae6227ede5
27 * Multiple Queries:: Asking a series of similar questions. 27 * Multiple Queries:: Asking a series of similar questions.
28 * Reading a Password:: Reading a password from the terminal. 28 * Reading a Password:: Reading a password from the terminal.
29 * Minibuffer Misc:: Various customization hooks and variables. 29 * Minibuffer Misc:: Various customization hooks and variables.
30 @end menu 30 @end menu
31 31
32 @node Intro to Minibuffers 32 @node Intro to Minibuffers, Text from Minibuffer, Minibuffers, Minibuffers
33 @section Introduction to Minibuffers 33 @section Introduction to Minibuffers
34 34
35 In most ways, a minibuffer is a normal XEmacs buffer. Most operations 35 In most ways, a minibuffer is a normal XEmacs buffer. Most operations
36 @emph{within} a buffer, such as editing commands, work normally in a 36 @emph{within} a buffer, such as editing commands, work normally in a
37 minibuffer. However, many operations for managing buffers do not apply 37 minibuffer. However, many operations for managing buffers do not apply
73 @item 73 @item
74 @code{minibuffer-local-must-match-map} is for strict completion and 74 @code{minibuffer-local-must-match-map} is for strict completion and
75 for cautious completion. 75 for cautious completion.
76 @end itemize 76 @end itemize
77 77
78 @node Text from Minibuffer 78 @node Text from Minibuffer, Object from Minibuffer, Intro to Minibuffers, Minibuffers
79 @section Reading Text Strings with the Minibuffer 79 @section Reading Text Strings with the Minibuffer
80 80
81 Most often, the minibuffer is used to read text as a string. It can 81 Most often, the minibuffer is used to read text as a string. It can
82 also be used to read a Lisp object in textual form. The most basic 82 also be used to read a Lisp object in textual form. The most basic
83 primitive for minibuffer input is @code{read-from-minibuffer}; it can do 83 primitive for minibuffer input is @code{read-from-minibuffer}; it can do
200 @item @kbd{M-s} 200 @item @kbd{M-s}
201 @code{previous-matching-history-element} 201 @code{previous-matching-history-element}
202 @end table 202 @end table
203 @end defvar 203 @end defvar
204 204
205 @node Object from Minibuffer 205 @node Object from Minibuffer, Minibuffer History, Text from Minibuffer, Minibuffers
206 @section Reading Lisp Objects with the Minibuffer 206 @section Reading Lisp Objects with the Minibuffer
207 207
208 This section describes functions for reading Lisp objects with the 208 This section describes functions for reading Lisp objects with the
209 minibuffer. 209 minibuffer.
210 210
319 Typing @key{RET} right away would exit the minibuffer and evaluate the 319 Typing @key{RET} right away would exit the minibuffer and evaluate the
320 expression, thus moving point forward one word. 320 expression, thus moving point forward one word.
321 @code{edit-and-eval-command} returns @code{t} in this example. 321 @code{edit-and-eval-command} returns @code{t} in this example.
322 @end defun 322 @end defun
323 323
324 @node Minibuffer History 324 @node Minibuffer History, Completion, Object from Minibuffer, Minibuffers
325 @section Minibuffer History 325 @section Minibuffer History
326 @cindex minibuffer history 326 @cindex minibuffer history
327 @cindex history list 327 @cindex history list
328 328
329 A @dfn{minibuffer history list} records previous minibuffer inputs so 329 A @dfn{minibuffer history list} records previous minibuffer inputs so
406 406
407 There are many other minibuffer history lists, defined by various 407 There are many other minibuffer history lists, defined by various
408 libraries. An @kbd{M-x apropos} search for @samp{history} should prove 408 libraries. An @kbd{M-x apropos} search for @samp{history} should prove
409 fruitful in discovering them. 409 fruitful in discovering them.
410 410
411 @node Completion 411 @node Completion, Yes-or-No Queries, Minibuffer History, Minibuffers
412 @section Completion 412 @section Completion
413 @cindex completion 413 @cindex completion
414 414
415 @dfn{Completion} is a feature that fills in the rest of a name 415 @dfn{Completion} is a feature that fills in the rest of a name
416 starting from an abbreviation for it. Completion works by comparing the 416 starting from an abbreviation for it. Completion works by comparing the
445 (reading buffer name, file name, etc.) 445 (reading buffer name, file name, etc.)
446 * Reading File Names:: Using completion to read file names. 446 * Reading File Names:: Using completion to read file names.
447 * Programmed Completion:: Finding the completions for a given file name. 447 * Programmed Completion:: Finding the completions for a given file name.
448 @end menu 448 @end menu
449 449
450 @node Basic Completion 450 @node Basic Completion, Minibuffer Completion, Completion, Completion
451 @subsection Basic Completion Functions 451 @subsection Basic Completion Functions
452 452
453 The two functions @code{try-completion} and @code{all-completions} 453 The two functions @code{try-completion} and @code{all-completions}
454 have nothing in themselves to do with minibuffers. We describe them in 454 have nothing in themselves to do with minibuffers. We describe them in
455 this chapter so as to keep them near the higher-level completion 455 this chapter so as to keep them near the higher-level completion
581 @defvar completion-ignore-case 581 @defvar completion-ignore-case
582 If the value of this variable is 582 If the value of this variable is
583 non-@code{nil}, XEmacs does not consider case significant in completion. 583 non-@code{nil}, XEmacs does not consider case significant in completion.
584 @end defvar 584 @end defvar
585 585
586 @node Minibuffer Completion 586 @node Minibuffer Completion, Completion Commands, Basic Completion, Completion
587 @subsection Completion and the Minibuffer 587 @subsection Completion and the Minibuffer
588 588
589 This section describes the basic interface for reading from the 589 This section describes the basic interface for reading from the
590 minibuffer with completion. 590 minibuffer with completion.
591 591
664 @code{minibuffer-completion-predicate} and 664 @code{minibuffer-completion-predicate} and
665 @code{minibuffer-completion-confirm}. For more information about them, 665 @code{minibuffer-completion-confirm}. For more information about them,
666 see @ref{Completion Commands}. 666 see @ref{Completion Commands}.
667 @end defun 667 @end defun
668 668
669 @node Completion Commands 669 @node Completion Commands, High-Level Completion, Minibuffer Completion, Completion
670 @subsection Minibuffer Commands That Do Completion 670 @subsection Minibuffer Commands That Do Completion
671 671
672 This section describes the keymaps, commands and user options used in 672 This section describes the keymaps, commands and user options used in
673 the minibuffer to do completion. 673 the minibuffer to do completion.
674 674
795 If this variable is non-@code{nil}, the completion commands 795 If this variable is non-@code{nil}, the completion commands
796 automatically display a list of possible completions whenever nothing 796 automatically display a list of possible completions whenever nothing
797 can be completed because the next character is not uniquely determined. 797 can be completed because the next character is not uniquely determined.
798 @end defopt 798 @end defopt
799 799
800 @node High-Level Completion 800 @node High-Level Completion, Reading File Names, Completion Commands, Completion
801 @subsection High-Level Completion Functions 801 @subsection High-Level Completion Functions
802 802
803 This section describes the higher-level convenient functions for 803 This section describes the higher-level convenient functions for
804 reading certain sorts of names with completion. 804 reading certain sorts of names with completion.
805 805
939 'user-variable-p t nil)) 939 'user-variable-p t nil))
940 @end group 940 @end group
941 @end example 941 @end example
942 @end defun 942 @end defun
943 943
944 @node Reading File Names 944 @node Reading File Names, Programmed Completion, High-Level Completion, Completion
945 @subsection Reading File Names 945 @subsection Reading File Names
946 946
947 Here is another high-level completion function, designed for reading a 947 Here is another high-level completion function, designed for reading a
948 file name. It provides special features including automatic insertion 948 file name. It provides special features including automatic insertion
949 of the default directory. 949 of the default directory.
1048 ---------- Buffer: Minibuffer ---------- 1048 ---------- Buffer: Minibuffer ----------
1049 @end group 1049 @end group
1050 @end example 1050 @end example
1051 @end defopt 1051 @end defopt
1052 1052
1053 @node Programmed Completion 1053 @node Programmed Completion, , Reading File Names, Completion
1054 @subsection Programmed Completion 1054 @subsection Programmed Completion
1055 @cindex programmed completion 1055 @cindex programmed completion
1056 1056
1057 Sometimes it is not possible to create an alist or an obarray 1057 Sometimes it is not possible to create an alist or an obarray
1058 containing all the intended possible completions. In such a case, you 1058 containing all the intended possible completions. In such a case, you
1113 to use for completion to be encapsulated in a symbol. 1113 to use for completion to be encapsulated in a symbol.
1114 1114
1115 Emacs uses programmed completion when completing file names. 1115 Emacs uses programmed completion when completing file names.
1116 @xref{File Name Completion}. 1116 @xref{File Name Completion}.
1117 1117
1118 @node Yes-or-No Queries 1118 @node Yes-or-No Queries, Multiple Queries, Completion, Minibuffers
1119 @section Yes-or-No Queries 1119 @section Yes-or-No Queries
1120 @cindex asking the user questions 1120 @cindex asking the user questions
1121 @cindex querying the user 1121 @cindex querying the user
1122 @cindex yes-or-no questions 1122 @cindex yes-or-no questions
1123 1123
1270 @defun yes-or-no-p-maybe-dialog-box prompt 1270 @defun yes-or-no-p-maybe-dialog-box prompt
1271 This function asks user a ``yes or no'' question, using either a dialog 1271 This function asks user a ``yes or no'' question, using either a dialog
1272 box or the minibuffer, as appropriate. 1272 box or the minibuffer, as appropriate.
1273 @end defun 1273 @end defun
1274 1274
1275 @node Multiple Queries 1275 @node Multiple Queries, Reading a Password, Yes-or-No Queries, Minibuffers
1276 @section Asking Multiple Y-or-N Questions 1276 @section Asking Multiple Y-or-N Questions
1277 1277
1278 When you have a series of similar questions to ask, such as ``Do you 1278 When you have a series of similar questions to ask, such as ``Do you
1279 want to save this buffer'' for each buffer in turn, you should use 1279 want to save this buffer'' for each buffer in turn, you should use
1280 @code{map-y-or-n-p} to ask the collection of questions, rather than 1280 @code{map-y-or-n-p} to ask the collection of questions, rather than
1360 value around the call. 1360 value around the call.
1361 1361
1362 The return value of @code{map-y-or-n-p} is the number of objects acted on. 1362 The return value of @code{map-y-or-n-p} is the number of objects acted on.
1363 @end defun 1363 @end defun
1364 1364
1365 @node Reading a Password 1365 @node Reading a Password, Minibuffer Misc, Multiple Queries, Minibuffers
1366 @section Reading a Password 1366 @section Reading a Password
1367 @cindex passwords, reading 1367 @cindex passwords, reading
1368 1368
1369 To read a password to pass to another program, you can use the 1369 To read a password to pass to another program, you can use the
1370 function @code{read-passwd}. 1370 function @code{read-passwd}.
1394 @defopt passwd-echo 1394 @defopt passwd-echo
1395 This specifies the character echoed when typing a password. When @code{nil}, 1395 This specifies the character echoed when typing a password. When @code{nil},
1396 nothing is echoed. 1396 nothing is echoed.
1397 @end defopt 1397 @end defopt
1398 1398
1399 @node Minibuffer Misc 1399 @node Minibuffer Misc, , Reading a Password, Minibuffers
1400 @section Minibuffer Miscellany 1400 @section Minibuffer Miscellany
1401 1401
1402 This section describes some basic functions and variables related to 1402 This section describes some basic functions and variables related to
1403 minibuffers. 1403 minibuffers.
1404 1404