aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorXue Fuqiao2013-08-08 20:31:38 +0800
committerXue Fuqiao2013-08-08 20:31:38 +0800
commit03300a14a08d3eb0afc85f2e4e7b123481ac7fcf (patch)
tree5d7a0f2670a4b4286656aec81282a35490e06de1
parentf9dbf1cbb89b503e1d02cd5ba9052c05c0fb81ac (diff)
downloademacs-03300a14a08d3eb0afc85f2e4e7b123481ac7fcf.tar.gz
emacs-03300a14a08d3eb0afc85f2e4e7b123481ac7fcf.zip
Add documentation for working directory in Ido.
* doc/misc/ido.texi (Top): Insert node "Working Directories" in menu. (Working Directories): New node. doc/misc/sc.texi: (What Supercite Does): Typo fix.
-rw-r--r--doc/misc/ChangeLog6
-rw-r--r--doc/misc/ido.texi108
-rw-r--r--doc/misc/sc.texi2
3 files changed, 85 insertions, 31 deletions
diff --git a/doc/misc/ChangeLog b/doc/misc/ChangeLog
index 4ced6e2e97b..aa8cb3fa39c 100644
--- a/doc/misc/ChangeLog
+++ b/doc/misc/ChangeLog
@@ -1,3 +1,8 @@
12013-08-08 Xue Fuqiao <xfq.free@gmail.com>
2
3 * ido.texi (Top): Insert node "Working Directories" in menu.
4 (Working Directories): New node.
5
12013-08-07 Eli Zaretskii <eliz@gnu.org> 62013-08-07 Eli Zaretskii <eliz@gnu.org>
2 7
3 * todo-mode.texi: Update @dircategory. 8 * todo-mode.texi: Update @dircategory.
@@ -21,6 +26,7 @@
21 (Mail Field Commands) 26 (Mail Field Commands)
22 (Hints to MUA Authors, Thanks and History): Change from one space 27 (Hints to MUA Authors, Thanks and History): Change from one space
23 between sentences to two. 28 between sentences to two.
29 (What Supercite Does): Typo fix.
24 30
25 * newsticker.texi (Usage): Use @key for RET. 31 * newsticker.texi (Usage): Use @key for RET.
26 32
diff --git a/doc/misc/ido.texi b/doc/misc/ido.texi
index dbc35b09bb8..bf0db3f28f2 100644
--- a/doc/misc/ido.texi
+++ b/doc/misc/ido.texi
@@ -53,45 +53,46 @@ modify this GNU manual.''
53@end ifnottex 53@end ifnottex
54 54
55@menu 55@menu
56* Overview:: Basics, activation. 56* Overview:: Basics, activation.
57* Matching:: Interactivity, matching, scrolling. 57* Matching:: Interactivity, matching, scrolling.
58* Highlighting:: Highlighting of matching items. 58* Highlighting:: Highlighting of matching items.
59* Hidden Buffers and Files:: Hidden buffers, files, and directories. 59* Hidden Buffers and Files:: Hidden buffers, files, and directories.
60* Customization:: Change the Ido functionality. 60* Customization:: Change the Ido functionality.
61* Misc:: Various other features. 61* Misc:: Various other features.
62 62
63Appendices 63Appendices
64* GNU Free Documentation License:: The license for this documentation. 64* GNU Free Documentation License:: The license for this documentation.
65 65
66Indexes 66Indexes
67* Variable Index:: An entry for each documented variable. 67* Variable Index:: An entry for each documented variable.
68 68
69@detailmenu 69@detailmenu
70 --- The Detailed Node Listing --- 70 --- The Detailed Node Listing ---
71 71
72Overview 72Overview
73 73
74* Activation:: How to use this package. 74* Activation:: How to use this package.
75* Working Directories:: Where files have most recently been opened.
75 76
76Matching 77Matching
77 78
78* Interactive Substring Matching:: Interactivity, matching, scrolling. 79* Interactive Substring Matching:: Interactivity, matching, scrolling.
79* Prefix Matching:: Standard completion. 80* Prefix Matching:: Standard completion.
80* Flexible Matching:: More flexible matching. 81* Flexible Matching:: More flexible matching.
81* Regexp Matching:: Matching using regular expression. 82* Regexp Matching:: Matching using regular expression.
82 83
83Customization 84Customization
84 85
85* Changing List Order:: Changing the list of files. 86* Changing List Order:: Changing the list of files.
86* Find File At Point:: Make Ido guess the context. 87* Find File At Point:: Make Ido guess the context.
87* Ignoring:: Ignorance is bliss. 88* Ignoring:: Ignorance is bliss.
88* Misc Customization:: Miscellaneous customization for Ido. 89* Misc Customization:: Miscellaneous customization for Ido.
89 90
90Miscellaneous 91Miscellaneous
91 92
92* All Matching:: Seeing all the matching buffers or files. 93* All Matching:: Seeing all the matching buffers or files.
93* Replacement:: Replacement for @code{read-buffer} and @code{read-file-name}. 94* Replacement:: Replacement for @code{read-buffer} and @code{read-file-name}.
94* Other Packages:: Don't want to depend on @code{ido-everywhere}? 95* Other Packages:: Don't want to depend on @code{ido-everywhere}?
95 96
96@end detailmenu 97@end detailmenu
97@end menu 98@end menu
@@ -116,7 +117,8 @@ This package was originally written by Kim F. Storm, based on the
116 @file{iswitchb.el} package by Stephen Eglen. 117 @file{iswitchb.el} package by Stephen Eglen.
117 118
118@menu 119@menu
119* Activation:: How to use this package. 120* Activation:: How to use this package.
121* Working Directories:: Where files have most recently been opened.
120@end menu 122@end menu
121 123
122@node Activation 124@node Activation
@@ -140,9 +142,56 @@ package.
140(ido-mode t) 142(ido-mode t)
141@end example 143@end example
142 144
143@c @node Working Directories 145@node Working Directories
144@c @section Working Directories 146@section Working Directories
145@c @cindex working directories 147@cindex working directories
148
149@vindex ido-work-directory-list
150@noindent
151@dfn{Working directories} are directories where files have most
152recently been opened. The current directory is inserted at the front
153of this @code{ido-work-directory-list} whenever a file is opened with
154@code{ido-find-file} and other file-related functions.
155
156@c @cindex merge
157@c or maybe a new node for ``merge''
158
159@c @findex ido-merge-work-directories
160@c @defun ido-merge-work-directories
161@c @end defun
162
163@c @findex ido-prev-work-directory
164@c @defun ido-prev-work-directory
165@c @end defun
166
167@c @findex ido-next-work-directory
168@c @defun ido-next-work-directory
169@c @end defun
170
171@c @findex ido-forget-work-directory
172@c @defun ido-forget-work-directory
173@c @end defun
174
175@c @vindex ido-use-merged-list
176@c @vindex ido-try-merged-list
177@c @vindex ido-pre-merge-state
178
179@defvr {User Option} ido-max-work-directory-list
180This user option specifies maximum number of working directories to
181record.
182@end defvr
183
184@c see (info "(elisp) File Name Completion")
185@defvr {User Option} ido-max-dir-file-cache
186This user option specifies maximum number of working directories to be
187cached. This is the size of the cache of
188@code{file-name-all-completions} results. Each cache entry is time
189stamped with the modification time of the directory. Some systems,
190like MS-Windows, have unreliable directory modification times, so you
191may choose to disable caching on such systems, or explicitly refresh
192the cache contents using the command @code{ido-reread-directory}
193(usually @kbd{C-l}) in the minibuffer.
194@end defvr
146 195
147@node Matching 196@node Matching
148@chapter Matching 197@chapter Matching
@@ -153,10 +202,10 @@ This section describes features of this package that have to
153do with various kinds of @emph{matching}: among buffers, files, and directories. 202do with various kinds of @emph{matching}: among buffers, files, and directories.
154 203
155@menu 204@menu
156* Interactive Substring Matching:: Interactivity, matching, scrolling. 205* Interactive Substring Matching:: Interactivity, matching, scrolling.
157* Prefix Matching:: Standard completion. 206* Prefix Matching:: Standard completion.
158* Flexible Matching:: More flexible matching. 207* Flexible Matching:: More flexible matching.
159* Regexp Matching:: Matching using regular expression. 208* Regexp Matching:: Matching using regular expression.
160@end menu 209@end menu
161 210
162@node Interactive Substring Matching 211@node Interactive Substring Matching
@@ -521,6 +570,7 @@ to ignore. The letter case will be ignored if
521@code{ido-downcase-unc-hosts} is non-@code{nil}. 570@code{ido-downcase-unc-hosts} is non-@code{nil}.
522@end defvr 571@end defvr
523 572
573@c FIXME: Where to add this variable? This node or ``working directory''?
524@c @defvr {User Option} ido-work-directory-list-ignore-regexps 574@c @defvr {User Option} ido-work-directory-list-ignore-regexps
525 575
526To make Ido use @code{completion-ignored-extensions} you need to 576To make Ido use @code{completion-ignored-extensions} you need to
@@ -571,7 +621,6 @@ if you type a dot as first char (even if @code{ido-enable-prefix} is
571@c @defvr {User Option} ido-max-file-prompt-width 621@c @defvr {User Option} ido-max-file-prompt-width
572@c @defvr {User Option} ido-max-window-height 622@c @defvr {User Option} ido-max-window-height
573@c @defvr {User Option} ido-enable-last-directory-history 623@c @defvr {User Option} ido-enable-last-directory-history
574@c @defvr {User Option} ido-max-work-directory-list
575@c @defvr {User Option} ido-enable-tramp-completion 624@c @defvr {User Option} ido-enable-tramp-completion
576@c @defvr {User Option} ido-unc-hosts 625@c @defvr {User Option} ido-unc-hosts
577@c @defvr {User Option} ido-downcase-unc-hosts 626@c @defvr {User Option} ido-downcase-unc-hosts
@@ -582,7 +631,6 @@ if you type a dot as first char (even if @code{ido-enable-prefix} is
582@c @defvr {User Option} ido-auto-merge-delay-time 631@c @defvr {User Option} ido-auto-merge-delay-time
583@c @defvr {User Option} ido-auto-merge-inhibit-characters-regexp 632@c @defvr {User Option} ido-auto-merge-inhibit-characters-regexp
584@c @defvr {User Option} ido-merged-indicator 633@c @defvr {User Option} ido-merged-indicator
585@c @defvr {User Option} ido-max-dir-file-cache
586@c @defvr {User Option} ido-max-directory-size 634@c @defvr {User Option} ido-max-directory-size
587@c @defvr {User Option} ido-rotate-file-list-default 635@c @defvr {User Option} ido-rotate-file-list-default
588@c @defvr {User Option} ido-enter-matching-directory 636@c @defvr {User Option} ido-enter-matching-directory
diff --git a/doc/misc/sc.texi b/doc/misc/sc.texi
index 7d7ef07ed61..aa0752c80cd 100644
--- a/doc/misc/sc.texi
+++ b/doc/misc/sc.texi
@@ -186,7 +186,7 @@ string carrying details about the citation it is about to perform.
186 186
187@cindex modeline 187@cindex modeline
188Next, Supercite visits each line in the reply, transforming the line 188Next, Supercite visits each line in the reply, transforming the line
189according to a customizable ``script.'' Lines which were not previously 189according to a customizable ``script''. Lines which were not previously
190cited in the original message are given a citation, while already cited 190cited in the original message are given a citation, while already cited
191lines remain untouched, or are coerced to your preferred style. 191lines remain untouched, or are coerced to your preferred style.
192Finally, Supercite installs a keymap into the reply buffer so that you 192Finally, Supercite installs a keymap into the reply buffer so that you