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