Mercurial > emacs
annotate man/dired-x.texi @ 38212:6b14cc47a4f2
Major rewrite. Sections Tags, Emerge, Change Log and Authors
moved to maintaining.texi. Some sections reordered.
Node Misc for Programs moved to just before the language-specific sections.
New node Defuns contains an intro plus the old
Defuns node (now renamed Moving by Defuns)
as well as Imenu, Which Function, and a node
Left Margin Paren to explain the convention about this.
New node Parentheses now documents M-x check-parens.
It contains subnodes Expressions, Moving by Parens, and Matching.
Expressions and Moving by Parens contain the material
formerly in Lists and List Commands, but divided up differently.
The section Balanced Editing has been deleted.
Most of the C indentation customization (all except c-set-style),
has been replaced with a reference to the C Modes manual.
Documentation now is divided into three subsections.
Some rewrites in the Program Indent section about
C-u TAB and C-M-q.
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Tue, 26 Jun 2001 13:43:32 +0000 |
parents | 04649657763c |
children | 0a70200bde27 |
rev | line source |
---|---|
25829 | 1 \input texinfo @comment -*-texinfo-*- |
2 | |
3 @c dired-x.texi --- Sebastian Kremer's Extra DIRED hacked up for GNU Emacs19 | |
4 @c | |
5 @c Author: Sebastian Kremer <sk@thp.uni-koeln.de> | |
6 @c Lawrence R. Dodd <dodd@roebling.poly.edu> | |
28669 | 7 @c [Dodd's address no longer valid.] |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
8 @c Version: 2.53 |
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
9 @c Date: 2001/02/25 14:05:46 |
25829 | 10 @c Keywords: dired extensions |
11 @c dired-x.el REVISION NUMBER: 2 | |
12 | |
13 @c State: Released | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
14 @c Ident: dired-x.texi,v 2.53 2001/02/25 14:05:46 dodd Released |
25829 | 15 |
16 @comment %**start of header (This is for running Texinfo on a region.) | |
17 @c FOR GNU EMACS USE ../info/dired-x BELOW | |
18 @setfilename ../info/dired-x | |
19 @c dired-x.el REVISION NUMBER | |
20 @settitle Dired Extra Version 2 User's Manual | |
21 | |
30009 | 22 @dircategory Emacs |
25829 | 23 @direntry |
24 * Dired-X: (dired-x). Dired Extra Features. | |
25 @end direntry | |
26 | |
27 @iftex | |
28 @finalout | |
29 @end iftex | |
30 @c @setchapternewpage odd % For book style double sided manual. | |
31 @comment %**end of header (This is for running Texinfo on a region.) | |
32 @c @smallbook | |
33 @tex | |
34 \overfullrule=0pt | |
35 %\global\baselineskip 30pt % For printing in double spaces | |
36 @end tex | |
37 | |
38 @ifinfo | |
39 @node Copyright, Top, (dir), (dir) | |
40 @comment node-name, next, previous, up | |
28669 | 41 This documents the ``extra'' features for Dired Mode for GNU Emacs found in |
25829 | 42 the file @file{dired-x.el}. |
43 | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
44 Copyright @copyright{} 1993, 1994, 2001 Free Software Foundation, Inc. |
25829 | 45 |
46 Permission is granted to make and distribute verbatim copies of this | |
47 manual provided the copyright notice and this permission notice are | |
48 preserved on all copies. | |
49 | |
50 Permission is granted to copy and distribute modified versions of | |
51 this manual under the conditions for verbatim copying, provided that | |
52 the entire resulting derived work is distributed under the terms of | |
53 a permission notice identical to this one. | |
54 | |
55 Permission is granted to copy and distribute translations of this | |
56 manual into another language, under the above conditions for | |
57 modified versions, except that this permission notice may be stated | |
58 in a translation approved by the Free Software Foundation. | |
59 | |
60 The file used to create this is called @file{dired-x.texi}, but the | |
61 original work that was altered to make that file was called | |
62 @file{dired.texi} written by Sebastian Kremer. | |
63 | |
64 @ignore | |
65 Permission is granted to process this file through TeX and print the | |
66 results, provided the printed document carries copying permission | |
67 notice identical to this one except for the removal of this paragraph | |
68 (this paragraph not being relevant to the printed manual). | |
69 | |
70 @end ignore | |
71 @end ifinfo | |
72 | |
73 @c | |
74 @titlepage | |
75 @sp 6 | |
76 @c dired-x.el REVISION NUMBER | |
77 @center @titlefont{Dired Extra Version 2} | |
78 @sp 2 | |
28669 | 79 @center @titlefont{For The GNU Emacs} |
25829 | 80 @sp 1 |
81 @center @titlefont{Directory Editor} | |
82 @sp 4 | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
83 @center Manual Revision: 2.53 |
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
84 @center 2001/02/25 14:05:46 |
25829 | 85 @sp 5 |
86 @center Lawrence R@. Dodd | |
28669 | 87 @c @center @t{dodd@@roebling.poly.edu} |
25829 | 88 @sp 5 |
89 @center (Based on @file{dired.texi} by Sebastian Kremer <sk@@thp.uni-koeln.de>) | |
90 @page | |
91 @vskip 0pt plus 1filll | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
92 Copyright @copyright{} 1993, 1994, 2001 Free Software Foundation |
25829 | 93 |
94 Permission is granted to make and distribute verbatim copies of | |
95 this manual provided the copyright notice and this permission notice | |
96 are preserved on all copies. | |
97 | |
98 Permission is granted to copy and distribute modified versions of | |
99 this manual under the conditions for verbatim copying, provided that | |
100 the entire resulting derived work is distributed under the terms of | |
101 a permission notice identical to this one. | |
102 | |
103 Permission is granted to copy and distribute translations of this | |
104 manual into another language, under the above conditions for | |
105 modified versions, except that this permission notice may be stated | |
106 in a translation approved by the Free Software Foundation. | |
107 | |
108 The file used to create this is called @file{dired-x.texi}, but the | |
109 original work that was altered to make that file was called | |
110 @file{dired.texi} written by Sebastian Kremer. | |
111 | |
112 @end titlepage | |
113 | |
114 @page | |
115 | |
116 @ifinfo | |
117 | |
118 @node Top, Introduction, Copyright, (dir) | |
119 @comment node-name, next, previous, up | |
120 | |
121 @noindent | |
28669 | 122 This documents the ``extra'' features for Dired Mode for GNU Emacs that are |
25829 | 123 provided by the file @file{dired-x.el}. |
124 | |
125 @itemize @bullet | |
126 | |
127 @item | |
128 Based on @file{dired.texi} by Sebastian Kremer <sk@@thp.uni-koeln.de> | |
129 | |
130 @c dired-x.el REVISION NUMBER | |
131 @item | |
132 For @file{dired-x.el} revision 2 | |
133 | |
28669 | 134 @c @item |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
135 @c Revision of this manual: 2.53 (2001/02/25 14:05:46) |
25829 | 136 |
28669 | 137 @c @item |
138 @c Bugs to Lawrence R. Dodd <dodd@@roebling.poly.edu>. @emph{Please} type | |
139 @c @kbd{M-x dired-x-submit-report} to submit a bug report (@pxref{Bugs}). | |
25829 | 140 |
28669 | 141 @c @item |
142 @c You can obtain a copy of this package via anonymous ftp in | |
143 @c @t{/roebling.poly.edu:/pub/packages/dired-x.tar.gz} | |
25829 | 144 |
145 @end itemize | |
146 | |
147 @menu | |
148 * Introduction:: | |
149 * Installation:: | |
150 * Omitting Files in Dired:: | |
151 * Local Variables:: | |
152 * Shell Command Guessing:: | |
153 * Virtual Dired:: | |
154 * Advanced Mark Commands:: | |
155 * Multiple Dired Directories:: | |
156 * Find File At Point:: | |
157 * Miscellaneous Commands:: | |
158 * Bugs:: | |
159 | |
160 * Concept Index:: | |
161 * Command Index:: | |
162 * Key Index:: | |
163 * Variable Index:: | |
164 | |
165 @end menu | |
166 | |
167 @end ifinfo | |
168 | |
37994
04649657763c
Fix Next and Prev pointers in @node directives, so
Eli Zaretskii <eliz@gnu.org>
parents:
36382
diff
changeset
|
169 @node Introduction, Installation, Top, Top |
25829 | 170 @comment node-name, next, previous, up |
171 @chapter Introduction | |
172 | |
28669 | 173 This documents the @emph{extra} features for Dired Mode for GNU Emacs. It |
174 is derived from version 1.191 of Sebastian Kremer's @file{dired-x.el}. | |
25829 | 175 |
176 In adopting this @file{dired-x.el} to GNU Emacs v19 some material that has | |
177 been incorporated into @file{dired.el} and @file{dired-aux.el} of the GNU Emacs | |
178 19 distribution has been removed and some material was modified for agreement | |
179 with the functions in @file{dired.el} and @file{dired-aux.el}. For example, | |
180 the code using @code{gmhist} history functions was replaced with code using | |
28669 | 181 the mini-buffer history now built into GNU Emacs. Finally, a few other |
25829 | 182 features have been added and a few more functions have been bound to keys. |
183 | |
184 @ifinfo | |
185 @menu | |
186 * Features:: | |
187 * Technical Details:: | |
188 @end menu | |
189 @end ifinfo | |
190 | |
37994
04649657763c
Fix Next and Prev pointers in @node directives, so
Eli Zaretskii <eliz@gnu.org>
parents:
36382
diff
changeset
|
191 @node Features, Technical Details, , Introduction |
25829 | 192 @comment node-name, next, previous, up |
193 @section Features | |
194 @cindex Features | |
195 | |
196 Some features provided by Dired Extra | |
197 | |
198 @enumerate | |
199 @item | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
200 Omitting uninteresting files from Dired listing. |
25829 | 201 @itemize @bullet |
26468 | 202 @xref{Omitting Files in Dired}. |
25829 | 203 @end itemize |
204 @item | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
205 Local variables for Dired directories. |
25829 | 206 @itemize @bullet |
26468 | 207 @xref{Local Variables}. |
25829 | 208 @end itemize |
209 @item | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
210 Guessing shell commands in Dired buffers. |
25829 | 211 @itemize @bullet |
26468 | 212 @xref{Shell Command Guessing}. |
25829 | 213 @end itemize |
214 @item | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
215 Running Dired command in non-Dired buffers. |
25829 | 216 @itemize @bullet |
26468 | 217 @xref{Virtual Dired}. |
25829 | 218 @end itemize |
219 @item | |
220 Finding a file mentioned in a buffer | |
221 @itemize @bullet | |
26468 | 222 @xref{Find File At Point}. |
25829 | 223 @end itemize |
224 @item | |
225 Commands using file marking. | |
226 @itemize @bullet | |
26468 | 227 @xref{Advanced Mark Commands}. |
25829 | 228 @end itemize |
229 @end enumerate | |
230 | |
231 @noindent | |
26468 | 232 @file{dired-x.el} binds some functions to keys in Dired Mode (@pxref{Key |
25829 | 233 Index}) and also binds @kbd{C-x C-j} and @kbd{C-x 4 C-j} @emph{globally} to |
26468 | 234 @code{dired-jump} (@pxref{Miscellaneous Commands}). It may also bind @kbd{C-x |
25829 | 235 C-f} and @kbd{C-x 4 C-f} to @code{dired-x-find-file} and |
26468 | 236 @code{dired-x-find-file-other-window}, respectively (@pxref{Find File At |
25829 | 237 Point}). |
238 | |
37994
04649657763c
Fix Next and Prev pointers in @node directives, so
Eli Zaretskii <eliz@gnu.org>
parents:
36382
diff
changeset
|
239 @node Technical Details, , Features, Introduction |
25829 | 240 @comment node-name, next, previous, up |
241 @section Technical Details | |
242 @cindex Redefined functions | |
243 @cindex @file{dired-aux.el} | |
244 | |
245 When loaded this code @emph{redefines} the following functions of GNU Emacs | |
246 from @file{dired.el} | |
247 | |
248 @itemize @bullet | |
249 @item | |
250 @code{dired-clean-up-after-deletion} | |
251 @item | |
252 @code{dired-find-buffer-nocreate} | |
253 @item | |
254 @code{dired-initial-position} | |
255 @item | |
256 @code{dired-up-directory} | |
257 @end itemize | |
258 | |
259 @noindent | |
260 and the following functions from @file{dired-aux.el} | |
261 | |
262 @itemize @bullet | |
263 @item | |
264 @code{dired-add-entry} | |
265 @item | |
266 @code{dired-read-shell-command} | |
267 @end itemize | |
268 | |
37994
04649657763c
Fix Next and Prev pointers in @node directives, so
Eli Zaretskii <eliz@gnu.org>
parents:
36382
diff
changeset
|
269 @node Installation, Omitting Files in Dired, Introduction, Top |
25829 | 270 @comment node-name, next, previous, up |
271 @chapter Installation | |
272 | |
273 @noindent | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
274 This manual describes the Dired features provided by the file |
25829 | 275 @file{dired-x.el}. To take advantage of these features, you must load the |
276 file and (optionally) set some variables. | |
277 | |
278 @noindent | |
279 In your @file{.emacs} file in your home directory, or in the system-wide | |
280 initialization file @file{default.el} in the @file{site-lisp} directory, put | |
281 | |
282 @example | |
283 (add-hook 'dired-load-hook | |
28344
54fda0e8528a
Weed out redundant uses of `function'
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
26468
diff
changeset
|
284 (lambda () |
54fda0e8528a
Weed out redundant uses of `function'
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
26468
diff
changeset
|
285 (load "dired-x") |
54fda0e8528a
Weed out redundant uses of `function'
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
26468
diff
changeset
|
286 ;; Set dired-x global variables here. For example: |
54fda0e8528a
Weed out redundant uses of `function'
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
26468
diff
changeset
|
287 ;; (setq dired-guess-shell-gnutar "gtar") |
54fda0e8528a
Weed out redundant uses of `function'
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
26468
diff
changeset
|
288 ;; (setq dired-x-hands-off-my-keys nil) |
54fda0e8528a
Weed out redundant uses of `function'
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
26468
diff
changeset
|
289 )) |
25829 | 290 (add-hook 'dired-mode-hook |
28344
54fda0e8528a
Weed out redundant uses of `function'
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
26468
diff
changeset
|
291 (lambda () |
54fda0e8528a
Weed out redundant uses of `function'
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
26468
diff
changeset
|
292 ;; Set dired-x buffer-local variables here. For example: |
54fda0e8528a
Weed out redundant uses of `function'
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
26468
diff
changeset
|
293 ;; (setq dired-omit-files-p t) |
54fda0e8528a
Weed out redundant uses of `function'
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
26468
diff
changeset
|
294 )) |
25829 | 295 @end example |
296 | |
297 @noindent | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
298 This will load @file{dired-x.el} when Dired is first invoked (for example, |
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
299 when you first type @kbd{C-x d}). |
25829 | 300 |
301 @ifinfo | |
302 @menu | |
303 * Optional Installation Dired Jump:: | |
304 * Optional Installation File At Point:: | |
305 @end menu | |
306 @end ifinfo | |
307 | |
37994
04649657763c
Fix Next and Prev pointers in @node directives, so
Eli Zaretskii <eliz@gnu.org>
parents:
36382
diff
changeset
|
308 @node Optional Installation Dired Jump, Optional Installation File At Point, , Installation |
25829 | 309 @comment node-name, next, previous, up |
310 @section Optional Installation Dired Jump | |
311 | |
312 @cindex Autoloading @code{dired-jump} and @code{dired-jump-other-window} | |
313 | |
314 In order to have @code{dired-jump} and @code{dired-jump-other-window} | |
26468 | 315 (@pxref{Miscellaneous Commands}) work @emph{before} @code{dired} and |
25829 | 316 @code{dired-x} have been properly loaded the user should set-up an autoload |
317 for these functions. In your @file{.emacs} file put | |
318 | |
319 @example | |
320 ;;; Autoload `dired-jump' and `dired-jump-other-window'. | |
321 ;;; We autoload from FILE dired.el. This will then load dired-x.el | |
322 ;;; and hence define `dired-jump' and `dired-jump-other-window'. | |
323 (define-key global-map "\C-x\C-j" 'dired-jump) | |
324 (define-key global-map "\C-x4\C-j" 'dired-jump-other-window) | |
325 | |
326 (autoload (quote dired-jump) "dired" "\ | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
327 Jump to Dired buffer corresponding to current buffer. |
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
328 If in a file, Dired the current directory and move to file's line. |
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
329 If in Dired already, pop up a level and goto old directory's line. |
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
330 In case the proper Dired file line cannot be found, refresh the Dired |
25829 | 331 buffer and try again." t nil) |
332 | |
333 (autoload (quote dired-jump-other-window) "dired" "\ | |
334 Like \\[dired-jump] (dired-jump) but in other window." t nil) | |
335 @end example | |
336 | |
337 Note that in recent releases of GNU Emacs 19 (i.e., 19.25 or later) the file | |
338 @file{../lisp/loaddefs.el} of the Emacs distribution already contains the | |
339 proper auto-loading for @code{dired-jump} so you need only put | |
340 | |
341 @example | |
342 (define-key global-map "\C-x\C-j" 'dired-jump) | |
343 @end example | |
344 | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
345 @noindent |
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
346 in your @file{.emacs} file in order to have @kbd{C-x C-j} work |
25829 | 347 before @code{dired} is loaded. |
348 | |
28669 | 349 @node Optional Installation File At Point, , Optional Installation Dired Jump, Installation |
25829 | 350 @comment node-name, next, previous, up |
351 @section Optional Installation File At Point | |
352 | |
353 @cindex Binding @code{dired-x-find-file} | |
354 If you choose to have @file{dired-x.el} bind @code{dired-x-find-file} over | |
26468 | 355 @code{find-file} (@pxref{Find File At Point}), then you will need to set |
25829 | 356 @code{dired-x-hands-off-my-keys} and make a call to the function |
357 @code{dired-x-bind-find-file} in the @code{dired-load-hook}: | |
358 | |
359 @example | |
360 (add-hook 'dired-load-hook | |
28344
54fda0e8528a
Weed out redundant uses of `function'
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
26468
diff
changeset
|
361 (lambda () |
54fda0e8528a
Weed out redundant uses of `function'
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
26468
diff
changeset
|
362 (load "dired-x") |
54fda0e8528a
Weed out redundant uses of `function'
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
26468
diff
changeset
|
363 ;; Bind dired-x-find-file. |
54fda0e8528a
Weed out redundant uses of `function'
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
26468
diff
changeset
|
364 (setq dired-x-hands-off-my-keys nil) |
54fda0e8528a
Weed out redundant uses of `function'
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
26468
diff
changeset
|
365 ;; Make sure our binding preference is invoked. |
54fda0e8528a
Weed out redundant uses of `function'
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
26468
diff
changeset
|
366 (dired-x-bind-find-file) |
54fda0e8528a
Weed out redundant uses of `function'
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
26468
diff
changeset
|
367 )) |
25829 | 368 @end example |
369 | |
370 Alternatively, you can set the variable @emph{before} @file{dired-x.el} is | |
371 loaded | |
372 | |
373 @example | |
374 (add-hook 'dired-load-hook | |
28344
54fda0e8528a
Weed out redundant uses of `function'
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
26468
diff
changeset
|
375 (lambda () |
54fda0e8528a
Weed out redundant uses of `function'
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
26468
diff
changeset
|
376 ;; Bind dired-x-find-file. |
54fda0e8528a
Weed out redundant uses of `function'
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
26468
diff
changeset
|
377 (setq dired-x-hands-off-my-keys nil) |
54fda0e8528a
Weed out redundant uses of `function'
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
26468
diff
changeset
|
378 (load "dired-x") |
54fda0e8528a
Weed out redundant uses of `function'
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
26468
diff
changeset
|
379 )) |
25829 | 380 @end example |
381 | |
37994
04649657763c
Fix Next and Prev pointers in @node directives, so
Eli Zaretskii <eliz@gnu.org>
parents:
36382
diff
changeset
|
382 @node Omitting Files in Dired, Local Variables, Installation, Top |
25829 | 383 @comment node-name, next, previous, up |
384 @chapter Omitting Files in Dired | |
385 | |
386 @cindex Omitting Files in Dired | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
387 @cindex Uninteresting files |
25829 | 388 @dfn{Omitting} a file means removing it from the directory listing. Omitting |
389 is useful for keeping Dired buffers free of ``uninteresting'' files (for | |
390 instance, auto-save, auxiliary, backup, and revision control files) so that | |
391 the user can concentrate on the interesting files. Like hidden files, omitted | |
392 files are never seen by Dired. Omitting differs from hiding in several | |
393 respects: | |
394 | |
395 @itemize @bullet | |
396 | |
397 @item | |
398 Omitting works on individual files, not on directories; an entire directory | |
399 cannot be omitted (though each of its files could be). | |
400 | |
401 @item | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
402 Omitting is wholesale; if omitting is turned on for a Dired buffer, then all |
25829 | 403 uninteresting files listed in that buffer are omitted. The user does not omit |
404 (or unomit) files one at a time. | |
405 | |
406 @item | |
407 Omitting can be automatic; uninteresting file lines in the buffer can be | |
408 removed before the user ever sees them. | |
409 | |
410 @item | |
411 Marked files are never omitted. | |
412 @end itemize | |
413 | |
414 @table @kbd | |
415 @item M-o | |
416 @kindex M-o | |
417 @findex dired-omit-toggle | |
418 (@code{dired-omit-toggle}) Toggle between displaying and omitting | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
419 ``uninteresting'' files. With a prefix argument, just mark |
25829 | 420 the files, but don't actually omit them. |
421 @end table | |
422 | |
423 @noindent | |
424 In order to make Dired Omit work you first need to load @file{dired-x.el} | |
26468 | 425 inside @code{dired-load-hook} (@pxref{Installation}) and then set |
426 @code{dired-omit-files-p} in some way (@pxref{Omitting Variables}). | |
25829 | 427 |
428 @ifinfo | |
429 @menu | |
430 * Omitting Variables:: | |
431 * Omitting Examples:: | |
432 * Omitting Technical:: | |
433 @end menu | |
434 @end ifinfo | |
435 | |
37994
04649657763c
Fix Next and Prev pointers in @node directives, so
Eli Zaretskii <eliz@gnu.org>
parents:
36382
diff
changeset
|
436 @node Omitting Variables, Omitting Examples, , Omitting Files in Dired |
25829 | 437 @comment node-name, next, previous, up |
438 | |
439 @section Omitting Variables | |
440 | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
441 @cindex Customizing file omitting |
25829 | 442 The following variables can be used to customize omitting. |
443 | |
444 @table @code | |
445 | |
446 @vindex dired-omit-files-p | |
447 @item dired-omit-files-p | |
448 | |
449 Default: @code{nil} | |
450 | |
451 @cindex How to make omitting the default in Dired | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
452 If non-@code{nil}, ``uninteresting'' files are not listed. |
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
453 Uninteresting files are those whose files whose names match regexp |
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
454 @code{dired-omit-files}, plus those ending with extensions in |
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
455 @code{dired-omit-extensions}. @kbd{M-o} (@code{dired-omit-toggle}) |
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
456 toggles its value, which is buffer-local. Put |
25829 | 457 |
458 @example | |
459 (setq dired-omit-files-p t) | |
460 @end example | |
461 | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
462 @noindent |
25829 | 463 inside your @code{dired-mode-hook} to have omitting initially turned on in |
26468 | 464 @emph{every} Dired buffer (@pxref{Installation}). You can then use @kbd{M-o} to |
25829 | 465 unomit in that buffer. |
466 | |
467 To enable omitting automatically only in certain directories one can use Dired | |
468 Local Variables and put | |
469 | |
470 @example | |
471 Local Variables: | |
472 dired-omit-files-p: t | |
473 End: | |
474 @end example | |
475 | |
476 @noindent | |
477 into a file @file{.dired} (the default value of | |
26468 | 478 @code{dired-local-variables-file}) in that directory (@pxref{Local Variables}). |
25829 | 479 |
480 @table @code | |
481 @findex dired-omit-here-always | |
482 @item dired-omit-here-always | |
483 | |
484 This is an interactive function that creates a local variables file exactly | |
485 like the example above (if it does not already exist) in the file | |
486 @code{dired-local-variables-file} in the current directory and then refreshes | |
26468 | 487 the directory listing (@pxref{Local Variables}). |
25829 | 488 @end table |
489 | |
490 @vindex dired-omit-files | |
491 @item dired-omit-files | |
492 | |
493 Default: @code{"^#\\|\\.$"} | |
494 | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
495 Files whose names match this buffer-local regexp will not be displayed. |
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
496 This only has effect when @code{dired-omit-files-p}'s value is @code{t}. |
25829 | 497 |
498 The default value omits the special directories @file{.} and @file{..} and | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
499 autosave files (plus other files ending in @file{.}) (@pxref{Omitting Examples}). |
25829 | 500 |
501 @vindex dired-omit-extensions | |
502 @item dired-omit-extensions | |
503 | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
504 Default: The elements of @code{completion-ignored-extensions}, |
25829 | 505 @code{dired-latex-unclean-extensions}, @code{dired-bibtex-unclean-extensions} |
506 and @code{dired-texinfo-unclean-extensions}. | |
507 | |
508 If non-@code{nil}, a list of extensions (strings) to omit from Dired listings. | |
509 Its format is the same as that of @code{completion-ignored-extensions}. | |
510 | |
511 @vindex dired-omit-localp | |
512 @item dired-omit-localp | |
513 | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
514 Default: @code{no-dir} |
25829 | 515 |
516 The @var{localp} argument @code{dired-omit-expunge} passes to | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
517 @code{dired-get-filename}. If it is @code{no-dir}, omitting is much faster, |
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
518 but you can only match against the non-directory part of the file name. Set it |
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
519 to @code{nil} if you need to match the whole file name or @code{t} to match the |
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
520 file name relative to the buffer's top-level directory. |
25829 | 521 |
522 @item dired-omit-marker-char | |
523 @vindex dired-omit-marker-char | |
524 @cindex Omitting additional files | |
525 Default: @kbd{C-o} | |
526 | |
36328
80404bf7aafe
(Omitting Variables): Remove doubled word.
Gerd Moellmann <gerd@gnu.org>
parents:
30009
diff
changeset
|
527 Temporary marker used by Dired to implement omitting. Should never be used |
25829 | 528 as marker by the user or other packages. There is one exception to this rule: |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
529 by adding |
25829 | 530 |
531 @example | |
532 (setq dired-mark-keys "\C-o") | |
533 ;; i.e., the value of dired-omit-marker-char | |
534 ;; (which is not defined yet) | |
535 @end example | |
536 | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
537 @noindent |
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
538 to your @file{~/.emacs}, you can bind the @kbd{C-o} key to insert a |
25829 | 539 @kbd{C-o} marker, thus causing these files to be omitted in addition to the |
540 usually omitted files. Unfortunately the files you omitted manually this way | |
541 will show up again after reverting the buffer, unlike the others. | |
542 | |
543 @end table | |
544 | |
545 @node Omitting Examples, Omitting Technical, Omitting Variables, Omitting Files in Dired | |
546 @comment node-name, next, previous, up | |
547 @section Examples of Omitting Various File Types | |
548 | |
549 @itemize @bullet | |
550 | |
551 @item | |
552 @cindex RCS files, how to omit them in Dired | |
553 @cindex Omitting RCS files in Dired | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
554 If you wish to avoid seeing RCS files and the @file{RCS} directory, then put |
25829 | 555 |
556 @example | |
557 (setq dired-omit-files | |
558 (concat dired-omit-files "\\|^RCS$\\|,v$")) | |
559 @end example | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
560 |
25829 | 561 @noindent |
26468 | 562 in the @code{dired-load-hook} (@pxref{Installation}). This assumes |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
563 @code{dired-omit-localp} has its default value of @code{no-dir} to make the |
25829 | 564 @code{^}-anchored matches work. As a slower alternative, with |
565 @code{dired-omit-localp} set to @code{nil}, you can use @code{/} instead of | |
566 @code{^} in the regexp. | |
567 | |
568 @item | |
569 @cindex Tib files, how to omit them in Dired | |
570 @cindex Omitting tib files in Dired | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
571 If you use @code{tib}, the bibliography program for use with @TeX{} and |
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
572 La@TeX{}, and you |
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
573 want to omit the @file{INDEX} and the @file{*-t.tex} files, then put |
25829 | 574 |
575 @example | |
576 (setq dired-omit-files | |
577 (concat dired-omit-files "\\|^INDEX$\\|-t\\.tex$")) | |
578 @end example | |
579 | |
580 @noindent | |
26468 | 581 in the @code{dired-load-hook} (@pxref{Installation}). |
25829 | 582 |
583 @item | |
584 @cindex Dot files, how to omit them in Dired | |
585 @cindex Omitting dot files in Dired | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
586 If you do not wish to see @samp{dot} files (files starting with a @file{.}), |
25829 | 587 then put |
588 | |
589 @example | |
590 (setq dired-omit-files | |
591 (concat dired-omit-files "\\|^\\..+$")) | |
592 @end example | |
593 | |
594 @noindent | |
26468 | 595 in the @code{dired-load-hook} (@pxref{Installation}). |
25829 | 596 |
597 @end itemize | |
598 | |
37994
04649657763c
Fix Next and Prev pointers in @node directives, so
Eli Zaretskii <eliz@gnu.org>
parents:
36382
diff
changeset
|
599 @node Omitting Technical, , Omitting Examples, Omitting Files in Dired |
25829 | 600 @comment node-name, next, previous, up |
601 @section Some Technical Details of Omitting | |
602 | |
603 Loading @file{dired-x.el} will install Dired Omit by putting | |
604 @code{dired-omit-expunge} on your @code{dired-after-readin-hook}, and will | |
605 call @code{dired-extra-startup}, which in turn calls @code{dired-omit-startup} | |
606 in your @code{dired-mode-hook}. | |
607 | |
37994
04649657763c
Fix Next and Prev pointers in @node directives, so
Eli Zaretskii <eliz@gnu.org>
parents:
36382
diff
changeset
|
608 @node Local Variables, Shell Command Guessing, Omitting Files in Dired, Top |
25829 | 609 @comment node-name, next, previous, up |
610 @chapter Local Variables for Dired Directories | |
611 | |
612 @cindex Local Variables for Dired Directories | |
613 @vindex dired-local-variables-file | |
614 @vindex dired-enable-local-variables | |
615 @noindent | |
616 When Dired visits a directory, it looks for a file whose name is the value of | |
617 variable @code{dired-local-variables-file} (default: @file{.dired}). If such | |
618 a file is found, Dired will temporarily insert it into the Dired buffer and | |
619 run @code{hack-local-variables}. | |
620 | |
621 @noindent | |
622 For example, if the user puts | |
623 | |
624 @example | |
625 Local Variables: | |
626 dired-actual-switches: "-lat" | |
627 dired-omit-files-p: t | |
628 End: | |
629 @end example | |
630 | |
631 @noindent | |
632 into a file called @file{.dired} in a directory then when that directory is | |
633 viewed it will be | |
634 | |
635 @enumerate | |
636 @item | |
637 sorted by date | |
638 @item | |
639 omitted automatically | |
640 @end enumerate | |
641 | |
642 @noindent | |
643 You can set @code{dired-local-variables-file} to @code{nil} to suppress this. | |
644 The value of @code{dired-enable-local-variables} controls if and how these | |
645 local variables are read. This variable exists so that if may override the | |
646 default value of @code{enable-local-variables}. | |
647 | |
648 @noindent | |
649 Please see the GNU Emacs Manual to learn more about local variables. | |
650 @xref{File Variables,Local Variables in Files,Local Variables in | |
651 Files,emacs,The GNU Emacs Manual}. | |
652 | |
653 @noindent | |
654 The following variables affect Dired Local Variables | |
655 | |
656 @table @code | |
657 @vindex dired-local-variables-file | |
658 @item dired-local-variables-file | |
659 Default: @code{".dired"} | |
660 | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
661 If non-@code{nil}, file name for local variables for Dired. If Dired finds a |
25829 | 662 file with that name in the current directory, it will temporarily insert it |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
663 into the Dired buffer and run @code{hack-local-variables}. |
25829 | 664 |
665 @vindex dired-enable-local-variables | |
666 @item dired-enable-local-variables | |
667 Default: @code{t} | |
668 | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
669 Controls the use of local-variables lists in Dired. The value can be @code{t}, |
25829 | 670 @code{nil}, or something else. A value of @code{t} means local-variables |
671 lists are obeyed in the @code{dired-local-variables-file}; @code{nil} means | |
672 they are ignored; anything else means query. This variable temporarily | |
673 overrides the value of @code{enable-local-variables} when the Dired Local | |
674 Variables are hacked. | |
675 @end table | |
676 | |
677 @node Shell Command Guessing, Virtual Dired, Local Variables, Top | |
678 @comment node-name, next, previous, up | |
679 @chapter Shell Command Guessing | |
680 @cindex Guessing shell commands for files. | |
681 | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
682 Based upon the name of a file, Dired tries to guess what shell |
25829 | 683 command you might want to apply to it. For example, if you have point |
684 on a file named @file{foo.tar} and you press @kbd{!}, Dired will guess | |
685 you want to @samp{tar xvf} it and suggest that as the default shell | |
686 command. | |
687 | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
688 The default is mentioned in brackets and you can type @kbd{M-p} to get |
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
689 the default into the minibuffer and then edit it, e.g., to change |
25829 | 690 @samp{tar xvf} to @samp{tar tvf}. If there are several commands for a given |
691 file, e.g., @samp{xtex} and @samp{dvips} for a @file{.dvi} file, you can type | |
692 @kbd{M-p} several times to see each of the matching commands. | |
693 | |
694 Dired only tries to guess a command for a single file, never for a list | |
695 of marked files. | |
696 | |
697 @table @code | |
698 @item dired-guess-shell-alist-default | |
699 @vindex dired-guess-shell-alist-default | |
700 Predefined rules for shell commands. Set this to @code{nil} to turn guessing off. | |
701 The elements of @code{dired-guess-shell-alist-user} (defined by the | |
702 user) will override these rules.@refill | |
703 | |
704 @item dired-guess-shell-alist-user | |
705 @vindex dired-guess-shell-alist-user | |
706 If non-@code{nil}, a user-defined alist of file regexps and their suggested | |
707 commands. These rules take precedence over the predefined rules in the | |
708 variable @code{dired-guess-shell-alist-default} (to which they are prepended) | |
709 when @code{dired-do-shell-command} is run). | |
710 @refill | |
711 | |
712 Each element of the alist looks like | |
713 | |
714 @example | |
715 (@var{regexp} @var{command}@dots{}) | |
716 @end example | |
717 | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
718 @noindent |
25829 | 719 where each @var{command} can either be a string or a lisp expression |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
720 that evaluates to a string. If several commands are given, all of |
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
721 them will temporarily be pushed onto the history. |
25829 | 722 |
723 You can set this variable in your @file{~/.emacs}. For example, | |
724 to add rules for @samp{.foo} and @samp{.bar} file extensions, write | |
725 | |
726 @example | |
727 (setq dired-guess-shell-alist-user | |
728 (list | |
729 (list "\\.foo$" "@var{foo-command}");; fixed rule | |
730 ;; possibly more rules... | |
731 (list "\\.bar$";; rule with condition test | |
732 '(if @var{condition} | |
733 "@var{bar-command-1}" | |
734 "@var{bar-command-2}")))) | |
735 @end example | |
736 | |
737 @noindent | |
738 This will override any predefined rules for the same extensions. | |
739 | |
740 @item dired-guess-shell-gnutar | |
741 @vindex dired-guess-shell-gnutar | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
742 @cindex Passing GNU Tar its @samp{z} switch. |
25829 | 743 Default: @code{nil} |
744 | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
745 If non-@code{nil}, this is the name of the GNU Tar executable (e.g., |
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
746 @samp{tar} or @samp{gnutar}). GNU Tar's @samp{z} switch is used for |
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
747 compressed tar files. |
25829 | 748 If you don't have GNU tar, set this to @code{nil}: a pipe using @samp{zcat} is |
749 then used. | |
750 | |
751 @item dired-guess-shell-gzip-quiet | |
752 @vindex dired-guess-shell-gzip-quiet | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
753 @cindex @code{gzip} |
25829 | 754 Default: @code{t} |
755 | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
756 A non-@code{nil} value means that @samp{-q} is passed to @code{gzip} |
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
757 overriding a verbose option in the @env{GZIP} environment variable. |
25829 | 758 |
759 @item dired-guess-shell-znew-switches nil | |
760 @vindex dired-guess-shell-znew-switches nil | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
761 @cindex @code{znew} |
25829 | 762 Default: @code{nil} |
763 | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
764 A string of switches passed to @code{znew}. An example is |
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
765 @samp{-K} which will make @code{znew} keep a @file{.Z} file when it is |
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
766 smaller than the @file{.gz} file. |
25829 | 767 |
768 @item dired-shell-command-history nil | |
769 @vindex dired-shell-command-history nil | |
770 | |
771 History list for commands that read dired-shell commands. | |
772 @end table | |
773 | |
774 @node Virtual Dired, Advanced Mark Commands, Shell Command Guessing, Top | |
775 @comment node-name, next, previous, up | |
776 @chapter Virtual Dired | |
777 | |
778 @cindex Virtual Dired | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
779 @cindex Perusing @code{ls} listings |
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
780 @cindex @code{ls} listings, how to peruse them in Dired |
25829 | 781 Using @dfn{Virtual Dired} means putting a buffer with Dired-like |
782 contents in Dired mode. The files described by the buffer contents need | |
783 not actually exist. This is useful if you want to peruse an @samp{ls -lR} | |
784 output file, for example one you got from an FTP server. You can use | |
785 all motion commands usually available in Dired. You can also use | |
786 it to save a Dired buffer in a file and resume it in a later session. | |
787 | |
788 @findex dired-virtual | |
789 @kindex g | |
790 @findex dired-virtual-revert | |
791 Type @kbd{M-x dired-virtual} to put the current buffer into virtual | |
792 Dired mode. You will be prompted for the top level directory of this | |
793 buffer, with a default value guessed from the buffer contents. To | |
794 convert the virtual to a real Dired buffer again, type @kbd{g} (which | |
795 calls @code{dired-virtual-revert}) in the virtual Dired buffer and | |
796 answer @samp{y}. You don't have to do this, though: you can relist | |
797 single subdirectories using @kbd{l} (@code{dired-do-redisplay}) on the subdirectory | |
798 headerline, leaving the buffer in virtual Dired mode all the time. | |
799 | |
800 @findex dired-virtual-mode | |
801 @vindex auto-mode-alist | |
802 The function @samp{dired-virtual-mode} is specially designed to turn on | |
803 virtual Dired mode from the @code{auto-mode-alist}. To edit all | |
804 @file{*.dired} files automatically in virtual Dired mode, put this into your | |
805 @file{~/.emacs}: | |
806 | |
807 @example | |
808 (setq auto-mode-alist (cons '("[^/]\\.dired$" . dired-virtual-mode) | |
809 auto-mode-alist)) | |
810 @end example | |
811 | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
812 @noindent |
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
813 The regexp is a bit more complicated than usual to exclude @file{.dired} |
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
814 local-variable files. |
25829 | 815 |
37994
04649657763c
Fix Next and Prev pointers in @node directives, so
Eli Zaretskii <eliz@gnu.org>
parents:
36382
diff
changeset
|
816 @node Advanced Mark Commands, Multiple Dired Directories, Virtual Dired, Top |
25829 | 817 @comment node-name, next, previous, up |
818 @chapter Advanced Mark Commands | |
819 | |
820 @table @kbd | |
821 @item F | |
822 @kindex F | |
823 @cindex Visiting several files at once | |
824 @cindex Simultaneous visiting of several files | |
825 @findex dired-do-find-marked-files | |
826 (@code{dired-do-find-marked-files}) Find all marked files at once displaying | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
827 them simultaneously. If optional @var{noselect} is non-@code{nil} then just |
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
828 find the |
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
829 files but do not select. If you want to keep the Dired buffer displayed, type |
25829 | 830 @kbd{C-x 2} first. If you want just the marked files displayed and nothing |
831 else, type @kbd{C-x 1} first. | |
832 | |
833 The current window is split across all files marked, as evenly as possible. | |
834 Remaining lines go to the bottom-most window. The number of files that can be | |
835 displayed this way is restricted by the height of the current window and the | |
836 variable @code{window-min-height}. | |
837 @end table | |
838 | |
839 @table @code | |
840 @item dired-mark-extension | |
841 @findex dired-mark-extension | |
842 Mark all files with a certain extension for use in later commands. A @samp{.} | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
843 is not automatically prepended to the string entered, you must type it |
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
844 explicitly. |
25829 | 845 |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
846 When called from Lisp, @var{extension} may also be a list of extensions |
25829 | 847 and an optional argument @var{marker-char} specifies the marker used. |
848 | |
849 @item dired-flag-extension | |
850 @findex dired-flag-extension | |
851 Flag all files with a certain extension for deletion. A @samp{.} is | |
852 @emph{not} automatically prepended to the string entered. | |
853 @end table | |
854 | |
855 @ifinfo | |
856 @menu | |
857 * Advanced Cleaning Functions:: | |
858 * Advanced Cleaning Variables:: | |
859 * Special Marking Function:: | |
860 @end menu | |
861 @end ifinfo | |
862 | |
37994
04649657763c
Fix Next and Prev pointers in @node directives, so
Eli Zaretskii <eliz@gnu.org>
parents:
36382
diff
changeset
|
863 @node Advanced Cleaning Functions, Advanced Cleaning Variables, , Advanced Mark Commands |
25829 | 864 @comment node-name, next, previous, up |
865 | |
866 @section Advanced Cleaning Functions | |
867 | |
868 @table @code | |
869 @item dired-clean-patch | |
870 @findex dired-clean-patch | |
871 Flag dispensable files created by the @samp{patch} program for deletion. See | |
872 variable @code{dired-patch-unclean-extensions}. | |
873 | |
874 @item dired-clean-tex | |
875 @findex dired-clean-tex | |
876 Flag dispensable files created by @TeX{}, La@TeX{}, and @samp{texinfo} for | |
26468 | 877 deletion. See the following variables (@pxref{Advanced Cleaning Variables}): |
25829 | 878 |
879 @itemize @bullet | |
880 @item | |
881 @code{dired-tex-unclean-extensions} | |
882 @item | |
883 @code{dired-texinfo-unclean-extensions} | |
884 @item | |
885 @code{dired-latex-unclean-extensions} | |
886 @item | |
887 @code{dired-bibtex-unclean-extensions} | |
888 @end itemize | |
889 | |
890 @item dired-very-clean-tex | |
891 @findex dired-very-clean-tex | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
892 Flag dispensable files created by @TeX{}, La@TeX{}, @samp{texinfo}, |
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
893 and @file{*.dvi} files for deletion. |
25829 | 894 @end table |
895 | |
896 @node Advanced Cleaning Variables, Special Marking Function, Advanced Cleaning Functions, Advanced Mark Commands | |
897 @comment node-name, next, previous, up | |
898 | |
899 @section Advanced Cleaning Variables | |
900 | |
901 @noindent Variables used by the above cleaning commands (and in the default value for | |
26468 | 902 variable @code{dired-omit-extensions}, @pxref{Omitting Variables}) |
25829 | 903 |
904 @table @code | |
905 @item dired-patch-unclean-extensions | |
906 @vindex dired-patch-unclean-extensions | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
907 Default: @code{(".rej" ".orig")} |
25829 | 908 |
909 List of extensions of dispensable files created by the @samp{patch} program. | |
910 | |
911 @item dired-tex-unclean-extensions | |
912 @vindex dired-tex-unclean-extensions | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
913 Default: @code{(".toc" ".log" ".aux")} |
25829 | 914 |
915 List of extensions of dispensable files created by @TeX{}. | |
916 | |
917 @item dired-texinfo-unclean-extensions | |
918 @vindex dired-texinfo-unclean-extensions | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
919 Default: @code{(".cp" ".cps" ".fn" ".fns" ".ky" ".kys"} |
25829 | 920 @code{".pg" ".pgs" ".tp" ".tps" ".vr" ".vrs")} |
921 | |
922 List of extensions of dispensable files created by @samp{texinfo}. | |
923 | |
924 @item dired-latex-unclean-extensions | |
925 @vindex dired-latex-unclean-extensions | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
926 Default: @code{(".idx" ".lof" ".lot" ".glo")} |
25829 | 927 |
928 List of extensions of dispensable files created by La@TeX{}. | |
929 | |
930 @item dired-bibtex-unclean-extensions | |
931 @vindex dired-bibtex-unclean-extensions | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
932 Default: @code{(".blg" ".bbl")} |
25829 | 933 |
934 List of extensions of dispensable files created by Bib@TeX{}. | |
935 @end table | |
936 | |
37994
04649657763c
Fix Next and Prev pointers in @node directives, so
Eli Zaretskii <eliz@gnu.org>
parents:
36382
diff
changeset
|
937 @node Special Marking Function, , Advanced Cleaning Variables, Advanced Mark Commands |
25829 | 938 @comment node-name, next, previous, up |
939 | |
940 @section Special Marking Function | |
941 | |
942 @table @kbd | |
943 @item M-( | |
944 @kindex M-( | |
945 @findex dired-mark-sexp | |
946 @cindex Lisp expression, marking files with in Dired | |
947 @cindex Mark file by lisp expression | |
948 (@code{dired-mark-sexp}) Mark files for which @var{predicate} returns | |
949 non-@code{nil}. With a prefix argument, unflag those files instead. | |
950 | |
951 The @var{predicate} is a lisp expression that can refer to the following | |
952 symbols: | |
953 @table @code | |
954 @item inode | |
955 [@i{integer}] the inode of the file (only for @samp{ls -i} output) | |
956 @item s | |
957 [@i{integer}] the size of the file for @samp{ls -s} output (usually in blocks or, | |
958 with @samp{-k}, in KBytes) | |
959 @item mode | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
960 [@i{string}] file permission bits, e.g., @samp{-rw-r--r--} |
25829 | 961 @item nlink |
962 [@i{integer}] number of links to file | |
963 @item uid | |
964 [@i{string}] owner | |
965 @item gid | |
966 [@i{string}] group (If the gid is not displayed by @samp{ls}, this | |
967 will still be set (to the same as uid)) | |
968 @item size | |
969 [@i{integer}] file size in bytes | |
970 @item time | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
971 [@i{string}] the time that @samp{ls} displays, e.g., @samp{Feb 12 14:17} |
25829 | 972 @item name |
973 [@i{string}] the name of the file | |
974 @item sym | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
975 [@i{string}] if file is a symbolic link, the linked-to name, else @code{""} |
25829 | 976 @end table |
977 | |
978 @noindent | |
979 For example, use | |
980 @example | |
981 (equal 0 size) | |
982 @end example | |
983 to mark all zero length files. | |
984 | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
985 To find out all not yet compiled Emacs lisp files in a directory, Dired |
25829 | 986 all @file{.el} files in the lisp directory using the wildcard |
987 @samp{*.el}. Then use @kbd{M-(} with | |
988 @example | |
989 (not (file-exists-p (concat name "c"))) | |
990 @end example | |
991 to mark all @file{.el} files without a corresponding @file{.elc} file. | |
992 | |
993 @end table | |
994 | |
37994
04649657763c
Fix Next and Prev pointers in @node directives, so
Eli Zaretskii <eliz@gnu.org>
parents:
36382
diff
changeset
|
995 @node Multiple Dired Directories, Find File At Point, Advanced Mark Commands, Top |
25829 | 996 @comment node-name, next, previous, up |
997 @chapter Multiple Dired Directories and Non-Dired Commands | |
998 | |
999 @cindex Multiple Dired directories | |
1000 @cindex Working directory | |
1001 An Emacs buffer can have but one working directory, stored in the | |
1002 buffer-local variable @code{default-directory}. A Dired buffer may have | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
1003 several subdirectories inserted, but it still has only one working |
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
1004 directory: that of the top-level Dired directory in that buffer. For |
25829 | 1005 some commands it is appropriate that they use the current Dired |
1006 directory instead of @code{default-directory}, e.g., @code{find-file} and | |
1007 @code{compile}. | |
1008 | |
1009 A general mechanism is provided for special handling of the working | |
1010 directory in special major modes: | |
1011 | |
1012 @table @code | |
1013 @item default-directory-alist | |
1014 @vindex default-directory-alist | |
1015 Default: @code{((dired-mode . (dired-current-directory)))} | |
1016 | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
1017 Alist of major modes and their notion of @code{default-directory}, as a |
25829 | 1018 lisp expression to evaluate. A resulting value of @code{nil} is ignored |
1019 in favor of @code{default-directory}. | |
1020 | |
1021 @item default-directory | |
1022 @findex default-directory | |
1023 Function with usage like variable @code{default-directory}, but knows about the | |
1024 special cases in variable @code{default-directory-alist}. | |
1025 @end table | |
1026 | |
1027 @node Find File At Point, Miscellaneous Commands, Multiple Dired Directories, Top | |
1028 @comment node-name, next, previous, up | |
1029 | |
1030 @section Find File At Point | |
1031 @cindex Visiting a file mentioned in a buffer | |
1032 @cindex Finding a file at point | |
1033 | |
1034 @file{dired-x} provides a method of visiting or editing a file mentioned in | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
1035 the buffer you are viewing (e.g., a mail buffer, a news article, a |
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
1036 @file{README} file, etc.) or to test if that file exists. You can then modify |
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
1037 this in the minibuffer after snatching the file name. |
25829 | 1038 |
1039 When installed @file{dired-x} will substitute @code{dired-x-find-file} for | |
1040 @code{find-file} (normally bound to @kbd{C-x C-f}) and | |
1041 @code{dired-x-find-file-other-window} for @code{find-file-other-window} | |
1042 (normally bound to @kbd{C-x 4 C-f}). | |
1043 | |
1044 In order to use this feature, you will need to set | |
1045 @code{dired-x-hands-off-my-keys} to @code{nil} inside @code{dired-load-hook} | |
26468 | 1046 (@pxref{Optional Installation File At Point}). |
25829 | 1047 |
1048 @table @code | |
1049 @item dired-x-find-file | |
1050 @findex dired-x-find-file | |
1051 @kindex C-x C-f | |
1052 | |
1053 @code{dired-x-find-file} behaves exactly like @code{find-file} (normally bound | |
1054 to @kbd{C-x C-f}) unless a prefix argument is passed to the function in which | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
1055 case it will use the file name at point as a guess for the file to visit. |
25829 | 1056 |
1057 For example, if the buffer you were reading contained the words | |
1058 | |
1059 @example | |
1060 Available via anonymous ftp in | |
1061 | |
1062 /roebling.poly.edu:/pub/lisp/crypt++.el.gz | |
1063 @end example | |
1064 | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
1065 @noindent |
25829 | 1066 then you could move your cursor to the line containing the ftp address and |
1067 type @kbd{C-u C-x C-f} (the @kbd{C-u} is a universal argument). The | |
1068 minibuffer would read | |
1069 | |
1070 @example | |
1071 Find file: /roebling.poly.edu:/pub/lisp/crypt++.el.gz | |
1072 @end example | |
1073 | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
1074 @noindent |
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
1075 with the point after the last @code{/}. If you hit @key{RET}, emacs will visit |
25829 | 1076 the file at that address. This also works with files on your own computer. |
1077 | |
1078 @item dired-x-find-file-other-window | |
1079 @findex dired-x-find-file-other-window | |
1080 @kindex C-x 4 C-f | |
1081 | |
1082 @code{dired-x-find-file-other-window} behaves exactly like | |
1083 @code{find-file-other-window} (normally bound to @kbd{C-x 4 C-f}) unless a | |
1084 prefix argument is used. See @code{dired-x-find-file} for more information. | |
1085 | |
1086 @item dired-x-hands-off-my-keys | |
1087 @vindex dired-x-hands-off-my-keys | |
1088 If set to @code{t}, then it means that @file{dired-x} should @emph{not} bind | |
1089 @code{dired-x-find-file} over @code{find-file} on keyboard. Similarly, it | |
1090 should not bind @code{dired-x-find-file-other-window} over | |
1091 @code{find-file-other-window}. If you change this variable after | |
1092 @file{dired-x.el} is loaded then do @kbd{M-x dired-x-bind-find-file}. The | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
1093 default value of this variable is @code{t}; by default, the binding is not |
25829 | 1094 done. See @xref{Optional Installation File At Point}. |
1095 | |
1096 @item dired-x-bind-find-file | |
1097 @findex dired-x-bind-find-file | |
1098 A function, which can be called interactively or in your @file{~/.emacs} file, | |
1099 that uses the value of @code{dired-x-hands-off-my-keys} to determine if | |
1100 @code{dired-x-find-file} should be bound over @code{find-file} and | |
1101 @code{dired-x-find-file-other-window} bound over | |
1102 @code{find-file-other-window}. See @xref{Optional Installation File At Point}. | |
1103 @end table | |
1104 | |
1105 @node Miscellaneous Commands, Bugs, Find File At Point, Top | |
1106 @comment node-name, next, previous, up | |
1107 @chapter Miscellaneous Commands | |
1108 | |
1109 Miscellaneous features not fitting anywhere else: | |
1110 | |
1111 @table @code | |
1112 @item dired-find-subdir | |
1113 @vindex dired-find-subdir | |
1114 Default: @code{nil} | |
1115 | |
1116 If non-@code{nil}, Dired does not make a new buffer for a directory if it can | |
1117 be found (perhaps as subdirectory) in some existing Dired buffer. | |
1118 | |
1119 If there are several Dired buffers for a directory, the most recently | |
1120 used is chosen. | |
1121 | |
1122 Dired avoids switching to the current buffer, so that if you have a | |
1123 normal and a wildcard buffer for the same directory, @kbd{C-x d RET} | |
1124 will toggle between those two. | |
1125 @end table | |
1126 | |
1127 @table @kbd | |
1128 @findex dired-goto-file | |
1129 @kindex M-g | |
1130 @item M-g | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
1131 (@code{dired-goto-file}) Go to the line of a file (or directory). |
25829 | 1132 |
1133 @findex dired-goto-subdir | |
1134 @kindex M-G | |
1135 @item M-G | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
1136 (@code{dired-goto-subdir}) Go to the header line of an inserted directory. |
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
1137 This command reads its argument, with completion derived from the names of the |
25829 | 1138 inserted subdirectories. |
1139 @end table | |
1140 | |
1141 @table @kbd | |
1142 @item w | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
1143 @cindex Adding to the kill ring in Dired. |
25829 | 1144 @kindex w |
1145 @findex dired-copy-filename-as-kill | |
1146 (@code{dired-copy-filename-as-kill}) The @kbd{w} command puts the names | |
1147 of the marked (or next @var{N}) files into the kill ring, as if you had | |
1148 killed them with @kbd{C-w}. With a zero prefix argument @var{N}=0, use the | |
1149 complete pathname of each file. With a raw (just @kbd{C-u}) prefix argument, | |
1150 use the relative pathname of each marked file. As a special case, if no | |
1151 prefix argument is given and point is on a directory headerline, it | |
1152 gives you the name of that directory, without looking for marked files. | |
1153 | |
1154 @vindex dired-marked-files | |
1155 The list of names is also stored onto the variable @code{dired-marked-files} | |
1156 for use, e.g., in the @kbd{M-:} (@code{eval-expression}) command. | |
1157 | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
1158 As this command also displays what was pushed onto the kill ring, you can |
25829 | 1159 use it to display the list of currently marked files in the |
1160 echo area (unless you happen to be on a subdirectory headerline). | |
1161 | |
1162 You can then feed the file name to other Emacs commands with @kbd{C-y}. | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
1163 For example, say you want to rename a file with a long name to a slightly |
25829 | 1164 different name. First type @kbd{w} to push the old name onto the kill |
1165 ring. Then type @kbd{R} to rename it and use @kbd{C-y} inside @kbd{R}'s | |
1166 minibuffer prompt to insert the old name at a convenient place. | |
1167 | |
1168 @item T | |
1169 @kindex T | |
1170 @cindex Toggling marks. | |
1171 @findex dired-do-toggle | |
1172 (@code{dired-do-toggle}) Toggle marks. That is, currently marked | |
1173 files become unmarked and vice versa. Files marked with other flags | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
1174 (such as @samp{D}) are not affected. The special directories @file{.} |
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
1175 and @file{..} are never toggled. |
25829 | 1176 @end table |
1177 | |
1178 @table @code | |
1179 @item dired-smart-shell-command | |
1180 @findex dired-smart-shell-command | |
1181 @findex shell-command | |
1182 @kindex M-! | |
1183 Like function @code{shell-command}, but in the current Dired directory. | |
1184 Bound to @kbd{M-!} in Dired buffers. | |
1185 | |
1186 @item dired-jump | |
1187 @findex dired-jump | |
1188 @kindex C-x C-j | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
1189 @cindex Jumping to Dired listing containing file. |
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
1190 Bound to @kbd{C-x C-j}. Jump back to Dired: If in a file, edit the current |
25829 | 1191 directory and move to file's line. If in Dired already, pop up a level and |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
1192 go to old directory's line. In case the proper Dired file line cannot be |
25829 | 1193 found, refresh the Dired buffer and try again. |
1194 | |
1195 @item dired-jump-other-window | |
1196 @findex dired-jump-other-window | |
1197 @kindex C-x 4 C-j | |
1198 Bound to @kbd{C-x 4 C-j}. Like @code{dired-jump}, but to other window. | |
1199 | |
1200 These functions can be autoloaded so they work even though @file{dired-x.el} | |
26468 | 1201 has not been loaded yet (@pxref{Optional Installation Dired Jump}). |
25829 | 1202 |
1203 @vindex dired-bind-jump | |
1204 If the variable @code{dired-bind-jump} is @code{nil}, @code{dired-jump} will not be | |
1205 bound to @kbd{C-x C-j} and @code{dired-jump-other-window} will not be bound to | |
1206 @kbd{C-x 4 C-j}. | |
1207 | |
1208 @item dired-vm | |
1209 @cindex Reading mail. | |
1210 @kindex V | |
1211 @findex dired-vm | |
1212 Bound to @kbd{V} if @code{dired-bind-vm} is t. Run VM on this file (assumed | |
1213 to be a UNIX mail folder). | |
1214 | |
1215 @vindex dired-vm-read-only-folders | |
1216 If you give this command a prefix argument, it will visit the folder | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
1217 read-only. This only works in VM 5, not VM 4. |
25829 | 1218 |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
1219 If the variable @code{dired-vm-read-only-folders} is @code{t}, |
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
1220 @code{dired-vm} will |
25829 | 1221 visit all folders read-only. If it is neither @code{nil} nor @code{t}, e.g., |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
1222 the symbol @code{if-file-read-only}, only files not writable by you are |
25829 | 1223 visited read-only. This is the recommended value if you run VM 5. |
1224 | |
1225 @vindex dired-bind-vm | |
1226 If the variable @code{dired-bind-vm} is t, @code{dired-vm} will be bound to | |
1227 @kbd{V}. Otherwise, @code{dired-bind-rmail} will be bound. | |
1228 | |
1229 @item dired-rmail | |
1230 @cindex Reading mail. | |
1231 @findex dired-rmail | |
1232 Bound to @kbd{V} if @code{dired-bind-vm} is @code{nil}. Run Rmail on this | |
1233 file (assumed to be mail folder in Rmail/BABYL format). | |
1234 | |
1235 @item dired-info | |
1236 @kindex I | |
1237 @cindex Running info. | |
1238 @findex dired-info | |
1239 Bound to @kbd{I}. Run Info on this file (assumed to be a file in Info | |
1240 format). | |
1241 | |
1242 @vindex dired-bind-info | |
1243 If the variable @code{dired-bind-info} is @code{nil}, @code{dired-info} will | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
1244 not be bound to @kbd{I}. |
25829 | 1245 |
1246 @item dired-man | |
1247 @cindex Running man. | |
1248 @kindex N | |
1249 @findex dired-man | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
1250 Bound to @kbd{N}. Run man on this file (assumed to be a file in @code{nroff} |
25829 | 1251 format). |
1252 | |
1253 @vindex dired-bind-man | |
1254 If the variable @code{dired-bind-man} is @code{nil}, @code{dired-man} will not | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
1255 be bound to @kbd{N}. |
25829 | 1256 |
1257 @item dired-do-relative-symlink | |
1258 @cindex Relative symbolic links. | |
1259 @kindex Y | |
1260 @findex dired-do-relative-symlink | |
1261 Bound to @kbd{Y}. Relative symlink all marked (or next ARG) files into a | |
1262 directory, or make a relative symbolic link to the current file. This creates | |
1263 relative symbolic links like | |
1264 | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
1265 @example |
25829 | 1266 foo -> ../bar/foo |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
1267 @end example |
25829 | 1268 |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
1269 @noindent |
25829 | 1270 not absolute ones like |
1271 | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
1272 @example |
25829 | 1273 foo -> /ugly/path/that/may/change/any/day/bar/foo |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
1274 @end example |
25829 | 1275 |
1276 @item dired-do-relative-symlink-regexp | |
1277 @kindex %Y | |
1278 @findex dired-do-relative-symlink-regexp | |
36382
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
1279 Bound to @kbd{%Y}. Relative symlink all marked files containing |
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
1280 @var{regexp} to @var{newname}. See functions |
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
1281 @code{dired-do-rename-regexp} and @code{dired-do-relsymlink} for more |
5ecd29c2f552
Lots of markup and wording changes.
Eli Zaretskii <eliz@gnu.org>
parents:
36328
diff
changeset
|
1282 info. |
25829 | 1283 @end table |
1284 | |
1285 @node Bugs, Concept Index, Miscellaneous Commands, Top | |
1286 @comment node-name, next, previous, up | |
1287 @chapter Bugs | |
1288 @cindex Bugs | |
1289 @findex dired-x-submit-report | |
1290 | |
1291 @noindent | |
1292 If you encounter a bug in this package, wish to suggest an | |
1293 enhancement, or want to make a smart remark, then type | |
1294 | |
1295 @example | |
1296 @kbd{M-x dired-x-submit-report} | |
1297 @end example | |
1298 | |
1299 @noindent | |
1300 to set up an outgoing mail buffer, with the proper address to the | |
1301 @file{dired-x.el} maintainer automatically inserted in the @samp{To:@:} field. | |
1302 This command also inserts information that the Dired X maintainer can use to | |
1303 recreate your exact setup, making it easier to verify your bug or social | |
1304 maladjustment. | |
1305 | |
28669 | 1306 Lawrence R. Dodd |
1307 @c <dodd@@roebling.poly.edu> | |
25829 | 1308 |
1309 @node Concept Index, Command Index, Bugs, Top | |
1310 @comment node-name, next, previous, up | |
1311 @unnumbered Concept Index | |
1312 @printindex cp | |
1313 | |
1314 @node Command Index, Key Index, Concept Index, Top | |
1315 @comment node-name, next, previous, up | |
1316 @unnumbered Function Index | |
1317 @printindex fn | |
1318 | |
1319 @node Key Index, Variable Index, Command Index, Top | |
1320 @comment node-name, next, previous, up | |
1321 @unnumbered Key Index | |
1322 @printindex ky | |
1323 | |
28669 | 1324 @node Variable Index, , Key Index, Top |
25829 | 1325 @comment node-name, next, previous, up |
1326 @unnumbered Variable Index | |
1327 @printindex vr | |
1328 | |
29713 | 1329 @setchapternewpage odd |
25829 | 1330 @c @summarycontents |
1331 @contents | |
1332 | |
1333 @bye | |
1334 @c dired-x.texi ends here. |