aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorXue Fuqiao2013-08-10 12:58:31 +0800
committerXue Fuqiao2013-08-10 12:58:31 +0800
commit33a9f380e516da3090fd7370a11c7cb5b35c8751 (patch)
treedea308629459ec4a2eba904c3dd9a4271ab3b526 /doc
parent5c5dee787e1443947c58a55e12ffc505b144c1fc (diff)
downloademacs-33a9f380e516da3090fd7370a11c7cb5b35c8751.tar.gz
emacs-33a9f380e516da3090fd7370a11c7cb5b35c8751.zip
* doc/misc/ido.texi (Working Directories):
(Flexible Matching, Regexp Matching, Find File At Point) (Ignoring, Misc Customization): Use @defopt for user options.
Diffstat (limited to 'doc')
-rw-r--r--doc/lispref/frames.texi2
-rw-r--r--doc/misc/ChangeLog6
-rw-r--r--doc/misc/ido.texi164
3 files changed, 89 insertions, 83 deletions
diff --git a/doc/lispref/frames.texi b/doc/lispref/frames.texi
index 01d2d1d6c45..37b48cdb6a9 100644
--- a/doc/lispref/frames.texi
+++ b/doc/lispref/frames.texi
@@ -446,7 +446,7 @@ default parameters by supplying their own parameters.
446If you invoke Emacs with command-line options that specify frame 446If you invoke Emacs with command-line options that specify frame
447appearance, those options take effect by adding elements to either 447appearance, those options take effect by adding elements to either
448@code{initial-frame-alist} or @code{default-frame-alist}. Options 448@code{initial-frame-alist} or @code{default-frame-alist}. Options
449which affect just the initial frame, such as @samp{-geometry} and 449which affect just the initial frame, such as @samp{--geometry} and
450@samp{--maximized}, add to @code{initial-frame-alist}; the others add 450@samp{--maximized}, add to @code{initial-frame-alist}; the others add
451to @code{default-frame-alist}. @pxref{Emacs Invocation,, Command Line 451to @code{default-frame-alist}. @pxref{Emacs Invocation,, Command Line
452Arguments for Emacs Invocation, emacs, The GNU Emacs Manual}. 452Arguments for Emacs Invocation, emacs, The GNU Emacs Manual}.
diff --git a/doc/misc/ChangeLog b/doc/misc/ChangeLog
index cc0756e0d64..c24ef309bf7 100644
--- a/doc/misc/ChangeLog
+++ b/doc/misc/ChangeLog
@@ -1,3 +1,9 @@
12013-08-10 Xue Fuqiao <xfq.free@gmail.com>
2
3 * ido.texi (Working Directories):
4 (Flexible Matching, Regexp Matching, Find File At Point)
5 (Ignoring, Misc Customization): Use @defopt for user options.
6
12013-08-09 Xue Fuqiao <xfq.free@gmail.com> 72013-08-09 Xue Fuqiao <xfq.free@gmail.com>
2 8
3 * htmlfontify.texi (Customization): Remove documentation of 9 * htmlfontify.texi (Customization): Remove documentation of
diff --git a/doc/misc/ido.texi b/doc/misc/ido.texi
index 5688b7a922b..623fb4bfa79 100644
--- a/doc/misc/ido.texi
+++ b/doc/misc/ido.texi
@@ -168,13 +168,13 @@ of this @code{ido-work-directory-list} whenever a file is opened with
168@c @defvar ido-try-merged-list 168@c @defvar ido-try-merged-list
169@c @defvar ido-pre-merge-state 169@c @defvar ido-pre-merge-state
170 170
171@defvr {User Option} ido-max-work-directory-list 171@defopt ido-max-work-directory-list
172This user option specifies maximum number of working directories to 172This user option specifies maximum number of working directories to
173record. 173record.
174@end defvr 174@end defopt
175 175
176@c see (info "(elisp) File Name Completion") 176@c see (info "(elisp) File Name Completion")
177@defvr {User Option} ido-max-dir-file-cache 177@defopt ido-max-dir-file-cache
178This user option specifies maximum number of working directories to be 178This user option specifies maximum number of working directories to be
179cached. This is the size of the cache of 179cached. This is the size of the cache of
180@code{file-name-all-completions} results. Each cache entry is time 180@code{file-name-all-completions} results. Each cache entry is time
@@ -183,7 +183,7 @@ like MS-Windows, have unreliable directory modification times, so you
183may choose to disable caching on such systems, or explicitly refresh 183may choose to disable caching on such systems, or explicitly refresh
184the cache contents using the command @code{ido-reread-directory} 184the cache contents using the command @code{ido-reread-directory}
185(usually @kbd{C-l}) in the minibuffer. 185(usually @kbd{C-l}) in the minibuffer.
186@end defvr 186@end defopt
187 187
188@node Matching 188@node Matching
189@chapter Matching 189@chapter Matching
@@ -320,11 +320,11 @@ directory, enter @samp{~/}. To enter Dired for this directory, use
320@cindex ftp hosts 320@cindex ftp hosts
321You can also visit files on other hosts using the ange-ftp 321You can also visit files on other hosts using the ange-ftp
322notations @samp{/host:} and @samp{/user@@host:}. 322notations @samp{/host:} and @samp{/user@@host:}.
323@c @defvr {User Option} ido-record-ftp-work-directories 323@c @defopt ido-record-ftp-work-directories
324@c @defvr {User Option} ido-merge-ftp-work-directories 324@c @defopt ido-merge-ftp-work-directories
325@c @defvr {User Option} ido-cache-ftp-work-directory-time 325@c @defopt ido-cache-ftp-work-directory-time
326@c @defvr {User Option} ido-slow-ftp-hosts 326@c @defopt ido-slow-ftp-hosts
327@c @defvr {User Option} ido-slow-ftp-host-regexps 327@c @defopt ido-slow-ftp-host-regexps
328 328
329You can type @kbd{M-p} and @kbd{M-n} to change to previous/next 329You can type @kbd{M-p} and @kbd{M-n} to change to previous/next
330directories from the history, @kbd{M-s} to search for a file matching 330directories from the history, @kbd{M-s} to search for a file matching
@@ -377,12 +377,12 @@ of the buffer names.
377@section Flexible Matching 377@section Flexible Matching
378@cindex flexible matching 378@cindex flexible matching
379 379
380@defvr {User Option} ido-enable-flex-matching 380@defopt ido-enable-flex-matching
381If non-@code{nil}, Ido will do flexible string matching. Flexible 381If non-@code{nil}, Ido will do flexible string matching. Flexible
382matching means that if the entered string does not match any item, any 382matching means that if the entered string does not match any item, any
383item containing the entered characters in the given sequence will 383item containing the entered characters in the given sequence will
384match. 384match.
385@end defvr 385@end defopt
386 386
387@noindent 387@noindent
388If @code{ido-enable-flex-matching} is non-@code{nil}, Ido will do a 388If @code{ido-enable-flex-matching} is non-@code{nil}, Ido will do a
@@ -410,11 +410,11 @@ through @code{ido-enable-regexp} (toggle with @kbd{C-t}). This allows
410you to type @samp{[ch]$} for example and see all file names ending in 410you to type @samp{[ch]$} for example and see all file names ending in
411@samp{c} or @samp{h}. 411@samp{c} or @samp{h}.
412 412
413@defvr {User Option} ido-enable-regexp 413@defopt ido-enable-regexp
414If the value of this user option is non-@code{nil}, Ido will do regexp 414If the value of this user option is non-@code{nil}, Ido will do regexp
415matching. The value of this user option can be toggled within 415matching. The value of this user option can be toggled within
416ido-mode using @code{ido-toggle-regexp}. 416ido-mode using @code{ido-toggle-regexp}.
417@end defvr 417@end defopt
418 418
419@strong{Please notice:} Ido-style completion is inhibited when you 419@strong{Please notice:} Ido-style completion is inhibited when you
420enable regexp matching. 420enable regexp matching.
@@ -474,7 +474,7 @@ To modify the keybindings, use the @code{ido-setup-hook}. For example:
474 (define-key ido-completion-map " " 'ido-next-match)) 474 (define-key ido-completion-map " " 'ido-next-match))
475@end example 475@end example
476 476
477@c @defvr {User Option} ido-setup-hook 477@c @defopt ido-setup-hook
478@c a new node for Ido hooks? 478@c a new node for Ido hooks?
479 479
480@menu 480@menu
@@ -521,17 +521,17 @@ The following expression will make Ido guess the context:
521(setq ido-use-filename-at-point 'guess) 521(setq ido-use-filename-at-point 'guess)
522@end example 522@end example
523 523
524@c @defvr {User Option} ido-use-filename-at-point 524@c @defopt ido-use-filename-at-point
525@c If the value of this user option is non-@code{nil}, ... 525@c If the value of this user option is non-@code{nil}, ...
526@c @end defvr 526@c @end defopt
527 527
528You can disable URL ffap support by toggling 528You can disable URL ffap support by toggling
529@code{ido-use-url-at-point}. 529@code{ido-use-url-at-point}.
530 530
531@defvr {User Option} ido-use-url-at-point 531@defopt ido-use-url-at-point
532If the value of this user option is non-@code{nil}, Ido will look for 532If the value of this user option is non-@code{nil}, Ido will look for
533a URL at point. If found, call @code{find-file-at-point} to visit it. 533a URL at point. If found, call @code{find-file-at-point} to visit it.
534@end defvr 534@end defopt
535 535
536@node Ignoring 536@node Ignoring
537@section Ignoring Buffers and Files 537@section Ignoring Buffers and Files
@@ -542,29 +542,29 @@ a URL at point. If found, call @code{find-file-at-point} to visit it.
542Ido is capable of ignoring buffers, directories, files and extensions 542Ido is capable of ignoring buffers, directories, files and extensions
543using regular expression. 543using regular expression.
544 544
545@defvr {User Option} ido-ignore-buffers 545@defopt ido-ignore-buffers
546This variable takes a list of regular expressions for buffers to 546This variable takes a list of regular expressions for buffers to
547ignore in @code{ido-switch-buffer}. 547ignore in @code{ido-switch-buffer}.
548@end defvr 548@end defopt
549 549
550@defvr {User Option} ido-ignore-directories 550@defopt ido-ignore-directories
551This variable takes a list of regular expressions for (sub)directories 551This variable takes a list of regular expressions for (sub)directories
552names to ignore in @code{ido-dired} and @code{ido-find-file}. 552names to ignore in @code{ido-dired} and @code{ido-find-file}.
553@end defvr 553@end defopt
554 554
555@defvr {User Option} ido-ignore-files 555@defopt ido-ignore-files
556This variable takes a list of regular expressions for files to ignore 556This variable takes a list of regular expressions for files to ignore
557in @code{ido-find-file}. 557in @code{ido-find-file}.
558@end defvr 558@end defopt
559 559
560@defvr {User Option} ido-ignore-unc-host-regexps 560@defopt ido-ignore-unc-host-regexps
561This variable takes a list of regular expressions matching UNC hosts 561This variable takes a list of regular expressions matching UNC hosts
562to ignore. The letter case will be ignored if 562to ignore. The letter case will be ignored if
563@code{ido-downcase-unc-hosts} is non-@code{nil}. 563@code{ido-downcase-unc-hosts} is non-@code{nil}.
564@end defvr 564@end defopt
565 565
566@c FIXME: Where to add this variable? This node or ``working directory''? 566@c FIXME: Where to add this variable? This node or ``working directory''?
567@c @defvr {User Option} ido-work-directory-list-ignore-regexps 567@c @defopt ido-work-directory-list-ignore-regexps
568 568
569To make Ido use @code{completion-ignored-extensions} you need to 569To make Ido use @code{completion-ignored-extensions} you need to
570enable it: 570enable it:
@@ -588,114 +588,114 @@ the name of an ignored file, Ido will still let you open it just fine.
588@c Variables described in this sections may be moved to new nodes in 588@c Variables described in this sections may be moved to new nodes in
589@c the future. 589@c the future.
590 590
591@defvr {User Option} ido-mode 591@defopt ido-mode
592This user option determines for which functional group (buffer and 592This user option determines for which functional group (buffer and
593files) Ido behavior should be enabled. 593files) Ido behavior should be enabled.
594@end defvr 594@end defopt
595 595
596@defvr {User Option} ido-case-fold 596@defopt ido-case-fold
597If the value of this user option is non-@code{nil}, searching of 597If the value of this user option is non-@code{nil}, searching of
598buffer and file names should ignore case. 598buffer and file names should ignore case.
599@end defvr 599@end defopt
600 600
601@defvr {User Option} ido-show-dot-for-dired 601@defopt ido-show-dot-for-dired
602If the value of this user option is non-@code{nil}, always put 602If the value of this user option is non-@code{nil}, always put
603@samp{.} as the first item in file name lists. This allows the 603@samp{.} as the first item in file name lists. This allows the
604current directory to be opened immediately with Dired 604current directory to be opened immediately with Dired
605@end defvr 605@end defopt
606 606
607@defvr {User Option} ido-enable-dot-prefix 607@defopt ido-enable-dot-prefix
608If the value of this user option is non-@code{nil}, Ido will match 608If the value of this user option is non-@code{nil}, Ido will match
609leading dot as prefix. I.e., hidden files and buffers will match only 609leading dot as prefix. I.e., hidden files and buffers will match only
610if you type a dot as first char (even if @code{ido-enable-prefix} is 610if you type a dot as first char (even if @code{ido-enable-prefix} is
611@code{nil}). 611@code{nil}).
612@end defvr 612@end defopt
613 613
614@defvr {User Option} ido-confirm-unique-completion 614@defopt ido-confirm-unique-completion
615If the value of this user option is non-@code{nil}, even a unique 615If the value of this user option is non-@code{nil}, even a unique
616completion must be confirmed. This means that @code{ido-complete} 616completion must be confirmed. This means that @code{ido-complete}
617(@key{TAB}) must always be followed by @code{ido-exit-minibuffer} 617(@key{TAB}) must always be followed by @code{ido-exit-minibuffer}
618(@key{RET}) even when there is only one unique completion. 618(@key{RET}) even when there is only one unique completion.
619@end defvr 619@end defopt
620 620
621@defvr {User Option} ido-cannot-complete-command 621@defopt ido-cannot-complete-command
622When @code{ido-complete} can't complete any more, it will run the 622When @code{ido-complete} can't complete any more, it will run the
623command specified by this user option. The most useful values are 623command specified by this user option. The most useful values are
624@code{ido-completion-help}, which pops up a window with completion 624@code{ido-completion-help}, which pops up a window with completion
625alternatives, or @code{ido-next-match} or @code{ido-prev-match}, which 625alternatives, or @code{ido-next-match} or @code{ido-prev-match}, which
626cycle the buffer list. 626cycle the buffer list.
627@end defvr 627@end defopt
628 628
629@defvr {User Option} ido-max-file-prompt-width 629@defopt ido-max-file-prompt-width
630This user option specifies the upper limit of the prompt string. If 630This user option specifies the upper limit of the prompt string. If
631its value is an integer, it specifies the number of characters of the 631its value is an integer, it specifies the number of characters of the
632string. If its value is a floating point number, it specifies a 632string. If its value is a floating point number, it specifies a
633fraction of the frame width. 633fraction of the frame width.
634@end defvr 634@end defopt
635 635
636@defvr {User Option} ido-max-window-height 636@defopt ido-max-window-height
637If the value of this user option is non-@code{nil}, its value will 637If the value of this user option is non-@code{nil}, its value will
638override the variable @code{max-mini-window-height}, which is the 638override the variable @code{max-mini-window-height}, which is the
639maximum height for resizing mini-windows (the minibuffer and the echo 639maximum height for resizing mini-windows (the minibuffer and the echo
640area). If it's a floating point number, it specifies a fraction of 640area). If it's a floating point number, it specifies a fraction of
641the mini-window frame's height. If it's an integer, it specifies the 641the mini-window frame's height. If it's an integer, it specifies the
642number of lines. 642number of lines.
643@end defvr 643@end defopt
644 644
645@defvr {User Option} ido-record-commands 645@defopt ido-record-commands
646If the value of this user option is non-@code{nil}, Ido will record 646If the value of this user option is non-@code{nil}, Ido will record
647commands in the variable @code{command-history}. Note that non-Ido 647commands in the variable @code{command-history}. Note that non-Ido
648equivalent is recorded. 648equivalent is recorded.
649@end defvr 649@end defopt
650 650
651@defvr {User Option} ido-all-frames 651@defopt ido-all-frames
652This user option will be passed to @code{walk-windows} as its 652This user option will be passed to @code{walk-windows} as its
653@var{all-frames} argument when Ido is finding buffers. @xref{Cyclic 653@var{all-frames} argument when Ido is finding buffers. @xref{Cyclic
654Window Ordering, , Cyclic Ordering of Windows, elisp, GNU Emacs Lisp 654Window Ordering, , Cyclic Ordering of Windows, elisp, GNU Emacs Lisp
655Reference Manual}. 655Reference Manual}.
656@end defvr 656@end defopt
657 657
658@defvr {User Option} ido-minibuffer-setup-hook 658@defopt ido-minibuffer-setup-hook
659This hook variable contains Ido-specific customization of minibuffer 659This hook variable contains Ido-specific customization of minibuffer
660setup. It is run during minibuffer setup if Ido is active, and is 660setup. It is run during minibuffer setup if Ido is active, and is
661intended for use in customizing ido for interoperation with other 661intended for use in customizing ido for interoperation with other
662packages. 662packages.
663@end defvr 663@end defopt
664 664
665@c @defvr {User Option} ido-enable-tramp-completion 665@c @defopt ido-enable-tramp-completion
666@c cross-reference to tramp.texi 666@c cross-reference to tramp.texi
667 667
668@c @cindex UNC host names, completion 668@c @cindex UNC host names, completion
669@c @defvr {User Option} ido-unc-hosts 669@c @defopt ido-unc-hosts
670@c @defvr {User Option} ido-downcase-unc-hosts 670@c @defopt ido-downcase-unc-hosts
671@c @defvr {User Option} ido-cache-unc-host-shares-time 671@c @defopt ido-cache-unc-host-shares-time
672 672
673@c @defvr {User Option} ido-enable-last-directory-history 673@c @defopt ido-enable-last-directory-history
674@c @defvr {User Option} ido-max-work-file-list 674@c @defopt ido-max-work-file-list
675@c @defvr {User Option} ido-work-directory-match-only 675@c @defopt ido-work-directory-match-only
676@c @defvr {User Option} ido-auto-merge-work-directories-length 676@c @defopt ido-auto-merge-work-directories-length
677@c @defvr {User Option} ido-auto-merge-delay-time 677@c @defopt ido-auto-merge-delay-time
678@c @defvr {User Option} ido-auto-merge-inhibit-characters-regexp 678@c @defopt ido-auto-merge-inhibit-characters-regexp
679@c @defvr {User Option} ido-merged-indicator 679@c @defopt ido-merged-indicator
680@c @defvr {User Option} ido-max-directory-size 680@c @defopt ido-max-directory-size
681@c @defvr {User Option} ido-rotate-file-list-default 681@c @defopt ido-rotate-file-list-default
682@c @defvr {User Option} ido-enter-matching-directory 682@c @defopt ido-enter-matching-directory
683@c @defvr {User Option} ido-create-new-buffer 683@c @defopt ido-create-new-buffer
684@c @defvr {User Option} ido-separator 684@c @defopt ido-separator
685@c @defvr {User Option} ido-decorations 685@c @defopt ido-decorations
686@c @defvr {User Option} ido-use-virtual-buffers 686@c @defopt ido-use-virtual-buffers
687@c @defvr {User Option} ido-use-faces 687@c @defopt ido-use-faces
688@c @defvr {User Option} ido-make-file-list-hook 688@c @defopt ido-make-file-list-hook
689@c @defvr {User Option} ido-make-dir-list-hook 689@c @defopt ido-make-dir-list-hook
690@c @defvr {User Option} ido-make-buffer-list-hook 690@c @defopt ido-make-buffer-list-hook
691@c @defvr {User Option} ido-rewrite-file-prompt-functions 691@c @defopt ido-rewrite-file-prompt-functions
692@c @defvr {User Option} ido-completion-buffer 692@c @defopt ido-completion-buffer
693@c @defvr {User Option} ido-completion-buffer-all-completions 693@c @defopt ido-completion-buffer-all-completions
694@c @defvr {User Option} ido-save-directory-list-file 694@c @defopt ido-save-directory-list-file
695@c @defvr {User Option} ido-read-file-name-as-directory-commands 695@c @defopt ido-read-file-name-as-directory-commands
696@c @defvr {User Option} ido-read-file-name-non-ido 696@c @defopt ido-read-file-name-non-ido
697@c @defvr {User Option} ido-before-fallback-functions 697@c @defopt ido-before-fallback-functions
698@c @defvr {User Option} ido-buffer-disable-smart-matches 698@c @defopt ido-buffer-disable-smart-matches
699 699
700@node Misc 700@node Misc
701@chapter Miscellaneous 701@chapter Miscellaneous
@@ -748,7 +748,7 @@ Also, to improve the responsiveness of Ido, the maximum number of
748matching items is limited to 12, but you can increase or removed this 748matching items is limited to 12, but you can increase or removed this
749limit via the @code{ido-max-prospects} user option. 749limit via the @code{ido-max-prospects} user option.
750 750
751@c @defvr {User Option} ido-max-prospects 751@c @defopt ido-max-prospects
752 752
753To see a full list of all matching buffers in a separate buffer, hit 753To see a full list of all matching buffers in a separate buffer, hit
754@kbd{?} or press @key{TAB} when there are no further completions to 754@kbd{?} or press @key{TAB} when there are no further completions to
@@ -767,7 +767,7 @@ To use ido for all buffer and file selections in Emacs, customize the
767variable @code{ido-everywhere}. 767variable @code{ido-everywhere}.
768 768
769@c @deffn Command ido-everywhere 769@c @deffn Command ido-everywhere
770@c @defvr {User Option} ido-everywhere 770@c @defopt ido-everywhere
771 771
772@node Other Packages 772@node Other Packages
773@section Other Packages 773@section Other Packages