1 \input texinfo @comment -*-texinfo-*-
3 @c dired-x.texi --- Sebastian Kremer's Extra DIRED hacked up for GNU Emacs19
5 @c Author: Sebastian Kremer <sk@thp.uni-koeln.de>
6 @c Lawrence R. Dodd <dodd@roebling.poly.edu>
7 @c [Dodd's address no longer valid.]
9 @c Date: 2001/02/25 14:05:46
10 @c Keywords: dired extensions
11 @c dired-x.el REVISION NUMBER: 2
14 @c Ident: dired-x.texi,v 2.53 2001/02/25 14:05:46 dodd Released
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
24 @c @setchapternewpage odd % For book style double sided manual.
25 @comment %**end of header (This is for running Texinfo on a region.)
28 Copyright @copyright{} 1994, 1995, 1999, 2001, 2002, 2003, 2004,
29 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
32 Permission is granted to copy, distribute and/or modify this document
33 under the terms of the GNU Free Documentation License, Version 1.2 or
34 any later version published by the Free Software Foundation; with no
35 Invariant Sections, with the Front-Cover texts being ``A GNU Manual'',
36 and with the Back-Cover Texts as in (a) below. A copy of the license
37 is included in the section entitled ``GNU Free Documentation License''.
39 (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
40 modify this GNU manual. Buying copies from the FSF supports it in
41 developing GNU and promoting software freedom.''
47 * Dired-X: (dired-x). Dired Extra Features.
53 %\global\baselineskip 30pt % For printing in double spaces
58 @c dired-x.el REVISION NUMBER
59 @center @titlefont{Dired Extra Version 2}
61 @center @titlefont{For The GNU Emacs}
63 @center @titlefont{Directory Editor}
65 @center Lawrence R@. Dodd
66 @c @center @t{dodd@@roebling.poly.edu}
68 @center (Based on @file{dired.texi} by Sebastian Kremer <sk@@thp.uni-koeln.de>)
70 @vskip 0pt plus 1filll
79 @comment node-name, next, previous, up
82 This documents the ``extra'' features for Dired Mode for GNU Emacs that are
83 provided by the file @file{dired-x.el}.
88 Based on @file{dired.texi} by Sebastian Kremer <sk@@thp.uni-koeln.de>
90 @c dired-x.el REVISION NUMBER
92 For @file{dired-x.el} revision 2
95 @c Revision of this manual: 2.53 (2001/02/25 14:05:46)
98 @c Bugs to Lawrence R. Dodd <dodd@@roebling.poly.edu>. @emph{Please} type
99 @c @kbd{M-x dired-x-submit-report} to submit a bug report (@pxref{Bugs}).
102 @c You can obtain a copy of this package via anonymous ftp in
103 @c @t{/roebling.poly.edu:/pub/packages/dired-x.tar.gz}
110 * Omitting Files in Dired::
112 * Shell Command Guessing::
114 * Advanced Mark Commands::
115 * Multiple Dired Directories::
116 * Find File At Point::
117 * Miscellaneous Commands::
120 * GNU Free Documentation License::
130 @node Introduction, Installation, Top, Top
131 @comment node-name, next, previous, up
132 @chapter Introduction
134 This documents the @emph{extra} features for Dired Mode for GNU Emacs. It
135 is derived from version 1.191 of Sebastian Kremer's @file{dired-x.el}.
137 In adopting this @file{dired-x.el} to GNU Emacs v19 some material that has
138 been incorporated into @file{dired.el} and @file{dired-aux.el} of the GNU Emacs
139 19 distribution has been removed and some material was modified for agreement
140 with the functions in @file{dired.el} and @file{dired-aux.el}. For example,
141 the code using @code{gmhist} history functions was replaced with code using
142 the mini-buffer history now built into GNU Emacs. Finally, a few other
143 features have been added and a few more functions have been bound to keys.
148 * Technical Details::
152 @node Features, Technical Details, , Introduction
153 @comment node-name, next, previous, up
157 Some features provided by Dired Extra
161 Omitting uninteresting files from Dired listing.
163 @xref{Omitting Files in Dired}.
166 Local variables for Dired directories.
168 @xref{Local Variables}.
171 Guessing shell commands in Dired buffers.
173 @xref{Shell Command Guessing}.
176 Running Dired command in non-Dired buffers.
178 @xref{Virtual Dired}.
181 Finding a file mentioned in a buffer
183 @xref{Find File At Point}.
186 Commands using file marking.
188 @xref{Advanced Mark Commands}.
193 @file{dired-x.el} binds some functions to keys in Dired Mode (@pxref{Key
194 Index}) and also binds @kbd{C-x C-j} and @kbd{C-x 4 C-j} @emph{globally} to
195 @code{dired-jump} (@pxref{Miscellaneous Commands}). It may also bind @kbd{C-x
196 C-f} and @kbd{C-x 4 C-f} to @code{dired-x-find-file} and
197 @code{dired-x-find-file-other-window}, respectively (@pxref{Find File At
200 @node Technical Details, , Features, Introduction
201 @comment node-name, next, previous, up
202 @section Technical Details
203 @cindex Redefined functions
204 @cindex @file{dired-aux.el}
206 When loaded this code @emph{redefines} the following functions of GNU Emacs
211 @code{dired-clean-up-after-deletion}
213 @code{dired-find-buffer-nocreate}
215 @code{dired-initial-position}
217 @code{dired-up-directory}
221 and the following functions from @file{dired-aux.el}
225 @code{dired-add-entry}
227 @code{dired-read-shell-command}
230 @node Installation, Omitting Files in Dired, Introduction, Top
231 @comment node-name, next, previous, up
232 @chapter Installation
235 This manual describes the Dired features provided by the file
236 @file{dired-x.el}. To take advantage of these features, you must load the
237 file and (optionally) set some variables.
240 In your @file{.emacs} file in your home directory, or in the system-wide
241 initialization file @file{default.el} in the @file{site-lisp} directory, put
244 (add-hook 'dired-load-hook
247 ;; Set dired-x global variables here. For example:
248 ;; (setq dired-guess-shell-gnutar "gtar")
249 ;; (setq dired-x-hands-off-my-keys nil)
251 (add-hook 'dired-mode-hook
253 ;; Set dired-x buffer-local variables here. For example:
254 ;; (dired-omit-mode 1)
259 This will load @file{dired-x.el} when Dired is first invoked (for example,
260 when you first type @kbd{C-x d}).
264 * Optional Installation Dired Jump::
265 * Optional Installation File At Point::
269 @node Optional Installation Dired Jump, Optional Installation File At Point, , Installation
270 @comment node-name, next, previous, up
271 @section Optional Installation Dired Jump
273 @cindex Autoloading @code{dired-jump} and @code{dired-jump-other-window}
275 In order to have @code{dired-jump} and @code{dired-jump-other-window}
276 (@pxref{Miscellaneous Commands}) work @emph{before} @code{dired} and
277 @code{dired-x} have been properly loaded the user should set-up an autoload
278 for these functions. In your @file{.emacs} file put
281 ;; Autoload `dired-jump' and `dired-jump-other-window'.
282 ;; We autoload from FILE dired.el. This will then load dired-x.el
283 ;; and hence define `dired-jump' and `dired-jump-other-window'.
284 (define-key global-map "\C-x\C-j" 'dired-jump)
285 (define-key global-map "\C-x4\C-j" 'dired-jump-other-window)
287 (autoload (quote dired-jump) "dired" "\
288 Jump to Dired buffer corresponding to current buffer.
289 If in a file, Dired the current directory and move to file's line.
290 If in Dired already, pop up a level and goto old directory's line.
291 In case the proper Dired file line cannot be found, refresh the Dired
292 buffer and try again." t nil)
294 (autoload (quote dired-jump-other-window) "dired" "\
295 Like \\[dired-jump] (dired-jump) but in other window." t nil)
298 Note that in recent releases of GNU Emacs 19 (i.e., 19.25 or later) the file
299 @file{../lisp/loaddefs.el} of the Emacs distribution already contains the
300 proper auto-loading for @code{dired-jump} so you need only put
303 (define-key global-map "\C-x\C-j" 'dired-jump)
307 in your @file{.emacs} file in order to have @kbd{C-x C-j} work
308 before @code{dired} is loaded.
310 @node Optional Installation File At Point, , Optional Installation Dired Jump, Installation
311 @comment node-name, next, previous, up
312 @section Optional Installation File At Point
314 @cindex Binding @code{dired-x-find-file}
315 If you choose to have @file{dired-x.el} bind @code{dired-x-find-file} over
316 @code{find-file} (@pxref{Find File At Point}), then you will need to set
317 @code{dired-x-hands-off-my-keys} and make a call to the function
318 @code{dired-x-bind-find-file} in the @code{dired-load-hook}:
321 (add-hook 'dired-load-hook
324 ;; Bind dired-x-find-file.
325 (setq dired-x-hands-off-my-keys nil)
326 ;; Make sure our binding preference is invoked.
327 (dired-x-bind-find-file)
331 Alternatively, you can set the variable @emph{before} @file{dired-x.el} is
335 (add-hook 'dired-load-hook
337 ;; Bind dired-x-find-file.
338 (setq dired-x-hands-off-my-keys nil)
343 @node Omitting Files in Dired, Local Variables, Installation, Top
344 @comment node-name, next, previous, up
345 @chapter Omitting Files in Dired
347 @cindex Omitting Files in Dired
348 @cindex Uninteresting files
349 @dfn{Omitting} a file means removing it from the directory listing. Omitting
350 is useful for keeping Dired buffers free of ``uninteresting'' files (for
351 instance, auto-save, auxiliary, backup, and revision control files) so that
352 the user can concentrate on the interesting files. Like hidden files, omitted
353 files are never seen by Dired. Omitting differs from hiding in several
359 Omitting works on individual files, not on directories; an entire directory
360 cannot be omitted (though each of its files could be).
363 Omitting is wholesale; if omitting is turned on for a Dired buffer, then all
364 uninteresting files listed in that buffer are omitted. The user does not omit
365 (or unomit) files one at a time.
368 Omitting can be automatic; uninteresting file lines in the buffer can be
369 removed before the user ever sees them.
372 Marked files are never omitted.
378 @findex dired-omit-mode
379 (@code{dired-omit-mode}) Toggle between displaying and omitting
380 ``uninteresting'' files.
383 @findex dired-mark-omitted
384 (@code{dired-mark-omitted}) Mark ``uninteresting'' files.
388 In order to make Dired Omit work you first need to load @file{dired-x.el}
389 inside @code{dired-load-hook} (@pxref{Installation}) and then evaluate
390 @code{(dired-omit-mode 1)} in some way (@pxref{Omitting Variables}).
394 * Omitting Variables::
395 * Omitting Examples::
396 * Omitting Technical::
400 @node Omitting Variables, Omitting Examples, , Omitting Files in Dired
401 @comment node-name, next, previous, up
403 @section Omitting Variables
405 @cindex Customizing file omitting
406 The following variables can be used to customize omitting.
410 @vindex dired-omit-mode
411 @item dired-omit-mode
415 @cindex How to make omitting the default in Dired
416 If non-@code{nil}, ``uninteresting'' files are not listed.
417 Uninteresting files are those whose files whose names match regexp
418 @code{dired-omit-files}, plus those ending with extensions in
419 @code{dired-omit-extensions}. @kbd{M-o} (@code{dired-omit-mode})
420 toggles its value, which is buffer-local. Put
427 inside your @code{dired-mode-hook} to have omitting initially turned on in
428 @emph{every} Dired buffer (@pxref{Installation}). You can then use @kbd{M-o} to
429 unomit in that buffer.
431 To enable omitting automatically only in certain directories one can use Dired
432 Local Variables and put
441 into a file @file{.dired} (the default value of
442 @code{dired-local-variables-file}) in that directory (@pxref{Local Variables}).
445 @findex dired-omit-here-always
446 @item dired-omit-here-always
448 This is an interactive function that creates a local variables file exactly
449 like the example above (if it does not already exist) in the file
450 @code{dired-local-variables-file} in the current directory and then refreshes
451 the directory listing (@pxref{Local Variables}).
454 @vindex dired-omit-files
455 @item dired-omit-files
457 Default: @code{"^#\\|\\.$"}
459 Files whose names match this buffer-local regexp will not be displayed.
460 This only has effect when @code{dired-omit-mode}'s value is @code{t}.
462 The default value omits the special directories @file{.} and @file{..} and
463 autosave files (plus other files ending in @file{.}) (@pxref{Omitting Examples}).
465 @vindex dired-omit-extensions
466 @item dired-omit-extensions
468 Default: The elements of @code{completion-ignored-extensions},
469 @code{dired-latex-unclean-extensions}, @code{dired-bibtex-unclean-extensions}
470 and @code{dired-texinfo-unclean-extensions}.
472 If non-@code{nil}, a list of extensions (strings) to omit from Dired listings.
473 Its format is the same as that of @code{completion-ignored-extensions}.
475 @vindex dired-omit-localp
476 @item dired-omit-localp
478 Default: @code{no-dir}
480 The @var{localp} argument @code{dired-omit-expunge} passes to
481 @code{dired-get-filename}. If it is @code{no-dir}, omitting is much faster,
482 but you can only match against the non-directory part of the file name. Set it
483 to @code{nil} if you need to match the whole file name or @code{t} to match the
484 file name relative to the buffer's top-level directory.
486 @item dired-omit-marker-char
487 @vindex dired-omit-marker-char
488 @cindex Omitting additional files
491 Temporary marker used by Dired to implement omitting. Should never be used
492 as marker by the user or other packages. There is one exception to this rule:
496 (setq dired-mark-keys "\C-o")
497 ;; i.e., the value of dired-omit-marker-char
498 ;; (which is not defined yet)
502 to your @file{~/.emacs}, you can bind the @kbd{C-o} key to insert a
503 @kbd{C-o} marker, thus causing these files to be omitted in addition to the
504 usually omitted files. Unfortunately the files you omitted manually this way
505 will show up again after reverting the buffer, unlike the others.
509 @node Omitting Examples, Omitting Technical, Omitting Variables, Omitting Files in Dired
510 @comment node-name, next, previous, up
511 @section Examples of Omitting Various File Types
516 @cindex RCS files, how to omit them in Dired
517 @cindex Omitting RCS files in Dired
518 If you wish to avoid seeing RCS files and the @file{RCS} directory, then put
521 (setq dired-omit-files
522 (concat dired-omit-files "\\|^RCS$\\|,v$"))
526 in the @code{dired-load-hook} (@pxref{Installation}). This assumes
527 @code{dired-omit-localp} has its default value of @code{no-dir} to make the
528 @code{^}-anchored matches work. As a slower alternative, with
529 @code{dired-omit-localp} set to @code{nil}, you can use @code{/} instead of
530 @code{^} in the regexp.
533 @cindex Tib files, how to omit them in Dired
534 @cindex Omitting tib files in Dired
535 If you use @code{tib}, the bibliography program for use with @TeX{} and
537 want to omit the @file{INDEX} and the @file{*-t.tex} files, then put
540 (setq dired-omit-files
541 (concat dired-omit-files "\\|^INDEX$\\|-t\\.tex$"))
545 in the @code{dired-load-hook} (@pxref{Installation}).
548 @cindex Dot files, how to omit them in Dired
549 @cindex Omitting dot files in Dired
550 If you do not wish to see @samp{dot} files (files starting with a @file{.}),
554 (setq dired-omit-files
555 (concat dired-omit-files "\\|^\\..+$"))
559 in the @code{dired-load-hook} (@pxref{Installation}).
563 @node Omitting Technical, , Omitting Examples, Omitting Files in Dired
564 @comment node-name, next, previous, up
565 @section Some Technical Details of Omitting
567 Loading @file{dired-x.el} will install Dired Omit by putting
568 @code{dired-omit-expunge} on your @code{dired-after-readin-hook}, and will
569 call @code{dired-extra-startup}, which in turn calls @code{dired-omit-startup}
570 in your @code{dired-mode-hook}.
572 @node Local Variables, Shell Command Guessing, Omitting Files in Dired, Top
573 @comment node-name, next, previous, up
574 @chapter Local Variables for Dired Directories
576 @cindex Local Variables for Dired Directories
577 @vindex dired-local-variables-file
578 @vindex dired-enable-local-variables
580 When Dired visits a directory, it looks for a file whose name is the value of
581 variable @code{dired-local-variables-file} (default: @file{.dired}). If such
582 a file is found, Dired will temporarily insert it into the Dired buffer and
583 run @code{hack-local-variables}.
586 For example, if the user puts
590 dired-actual-switches: "-lat"
596 into a file called @file{.dired} in a directory then when that directory is
603 omitted automatically
607 You can set @code{dired-local-variables-file} to @code{nil} to suppress this.
608 The value of @code{dired-enable-local-variables} controls if and how these
609 local variables are read. This variable exists so that if may override the
610 default value of @code{enable-local-variables}.
613 Please see the GNU Emacs Manual to learn more about local variables.
614 @xref{File Variables,Local Variables in Files,Local Variables in
615 Files,emacs,The GNU Emacs Manual}.
618 The following variables affect Dired Local Variables
621 @vindex dired-local-variables-file
622 @item dired-local-variables-file
623 Default: @code{".dired"}
625 If non-@code{nil}, file name for local variables for Dired. If Dired finds a
626 file with that name in the current directory, it will temporarily insert it
627 into the Dired buffer and run @code{hack-local-variables}.
629 @vindex dired-enable-local-variables
630 @item dired-enable-local-variables
633 Controls the use of local-variables lists in Dired. The value can be @code{t},
634 @code{nil}, or something else. A value of @code{t} means local-variables
635 lists are obeyed in the @code{dired-local-variables-file}; @code{nil} means
636 they are ignored; anything else means query. This variable temporarily
637 overrides the value of @code{enable-local-variables} when the Dired Local
638 Variables are hacked.
641 @node Shell Command Guessing, Virtual Dired, Local Variables, Top
642 @comment node-name, next, previous, up
643 @chapter Shell Command Guessing
644 @cindex Guessing shell commands for files.
646 Based upon the name of a file, Dired tries to guess what shell
647 command you might want to apply to it. For example, if you have point
648 on a file named @file{foo.tar} and you press @kbd{!}, Dired will guess
649 you want to @samp{tar xvf} it and suggest that as the default shell
652 The default is mentioned in brackets and you can type @kbd{M-n} to get
653 the default into the minibuffer and then edit it, e.g., to change
654 @samp{tar xvf} to @samp{tar tvf}. If there are several commands for a given
655 file, e.g., @samp{xtex} and @samp{dvips} for a @file{.dvi} file, you can type
656 @kbd{M-n} several times to see each of the matching commands.
658 Dired only tries to guess a command for a single file, never for a list
662 @item dired-guess-shell-alist-default
663 @vindex dired-guess-shell-alist-default
664 Predefined rules for shell commands. Set this to @code{nil} to turn guessing off.
665 The elements of @code{dired-guess-shell-alist-user} (defined by the
666 user) will override these rules.@refill
668 @item dired-guess-shell-alist-user
669 @vindex dired-guess-shell-alist-user
670 If non-@code{nil}, a user-defined alist of file regexps and their suggested
671 commands. These rules take precedence over the predefined rules in the
672 variable @code{dired-guess-shell-alist-default} (to which they are prepended)
673 when @code{dired-do-shell-command} is run).
676 Each element of the alist looks like
679 (@var{regexp} @var{command}@dots{})
683 where each @var{command} can either be a string or a Lisp expression
684 that evaluates to a string. If several commands are given, all of
685 them will temporarily be pushed onto the history.
687 If @samp{*} in the shell command, that means to substitute the file
690 You can set this variable in your @file{~/.emacs}. For example,
691 to add rules for @samp{.foo} and @samp{.bar} file extensions, write
694 (setq dired-guess-shell-alist-user
696 (list "\\.foo$" "@var{foo-command}");; fixed rule
697 ;; possibly more rules...
698 (list "\\.bar$";; rule with condition test
700 "@var{bar-command-1}"
701 "@var{bar-command-2}"))))
705 This will override any predefined rules for the same extensions.
707 @item dired-guess-shell-gnutar
708 @vindex dired-guess-shell-gnutar
709 @cindex Passing GNU Tar its @samp{z} switch.
712 If non-@code{nil}, this is the name of the GNU Tar executable (e.g.,
713 @samp{tar} or @samp{gnutar}). GNU Tar's @samp{z} switch is used for
714 compressed tar files.
715 If you don't have GNU tar, set this to @code{nil}: a pipe using @samp{zcat} is
718 @item dired-guess-shell-gzip-quiet
719 @vindex dired-guess-shell-gzip-quiet
723 A non-@code{nil} value means that @samp{-q} is passed to @code{gzip}
724 overriding a verbose option in the @env{GZIP} environment variable.
726 @item dired-guess-shell-znew-switches nil
727 @vindex dired-guess-shell-znew-switches nil
731 A string of switches passed to @code{znew}. An example is
732 @samp{-K} which will make @code{znew} keep a @file{.Z} file when it is
733 smaller than the @file{.gz} file.
735 @item dired-shell-command-history nil
736 @vindex dired-shell-command-history nil
738 History list for commands that read dired-shell commands.
741 @node Virtual Dired, Advanced Mark Commands, Shell Command Guessing, Top
742 @comment node-name, next, previous, up
743 @chapter Virtual Dired
745 @cindex Virtual Dired
746 @cindex Perusing @code{ls} listings
747 @cindex @code{ls} listings, how to peruse them in Dired
748 Using @dfn{Virtual Dired} means putting a buffer with Dired-like
749 contents in Dired mode. The files described by the buffer contents need
750 not actually exist. This is useful if you want to peruse an @samp{ls -lR}
751 output file, for example one you got from an FTP server. You can use
752 all motion commands usually available in Dired. You can also use
753 it to save a Dired buffer in a file and resume it in a later session.
755 @findex dired-virtual
757 @findex dired-virtual-revert
758 Type @kbd{M-x dired-virtual} to put the current buffer into virtual
759 Dired mode. You will be prompted for the top level directory of this
760 buffer, with a default value guessed from the buffer contents. To
761 convert the virtual to a real Dired buffer again, type @kbd{g} (which
762 calls @code{dired-virtual-revert}) in the virtual Dired buffer and
763 answer @samp{y}. You don't have to do this, though: you can relist
764 single subdirectories using @kbd{l} (@code{dired-do-redisplay}) on the subdirectory
765 headerline, leaving the buffer in virtual Dired mode all the time.
767 @findex dired-virtual-mode
768 @vindex auto-mode-alist
769 The function @samp{dired-virtual-mode} is specially designed to turn on
770 virtual Dired mode from the @code{auto-mode-alist}. To edit all
771 @file{*.dired} files automatically in virtual Dired mode, put this into your
775 (setq auto-mode-alist (cons '("[^/]\\.dired$" . dired-virtual-mode)
780 The regexp is a bit more complicated than usual to exclude @file{.dired}
781 local-variable files.
783 @node Advanced Mark Commands, Multiple Dired Directories, Virtual Dired, Top
784 @comment node-name, next, previous, up
785 @chapter Advanced Mark Commands
790 @cindex Visiting several files at once
791 @cindex Simultaneous visiting of several files
792 @findex dired-do-find-marked-files
793 (@code{dired-do-find-marked-files}) Find all marked files at once displaying
794 them simultaneously. If optional @var{noselect} is non-@code{nil} then just
796 files but do not select. If you want to keep the Dired buffer displayed, type
797 @kbd{C-x 2} first. If you want just the marked files displayed and nothing
798 else, type @kbd{C-x 1} first.
800 The current window is split across all files marked, as evenly as possible.
801 Remaining lines go to the bottom-most window. The number of files that can be
802 displayed this way is restricted by the height of the current window and the
803 variable @code{window-min-height}.
807 @item dired-mark-extension
808 @findex dired-mark-extension
809 Mark all files with a certain extension for use in later commands. A @samp{.}
810 is not automatically prepended to the string entered, you must type it
813 When called from Lisp, @var{extension} may also be a list of extensions
814 and an optional argument @var{marker-char} specifies the marker used.
816 @item dired-flag-extension
817 @findex dired-flag-extension
818 Flag all files with a certain extension for deletion. A @samp{.} is
819 @emph{not} automatically prepended to the string entered.
824 * Advanced Cleaning Functions::
825 * Advanced Cleaning Variables::
826 * Special Marking Function::
830 @node Advanced Cleaning Functions, Advanced Cleaning Variables, , Advanced Mark Commands
831 @comment node-name, next, previous, up
833 @section Advanced Cleaning Functions
836 @item dired-clean-patch
837 @findex dired-clean-patch
838 Flag dispensable files created by the @samp{patch} program for deletion. See
839 variable @code{dired-patch-unclean-extensions}.
841 @item dired-clean-tex
842 @findex dired-clean-tex
843 Flag dispensable files created by @TeX{}, La@TeX{}, and @samp{texinfo} for
844 deletion. See the following variables (@pxref{Advanced Cleaning Variables}):
848 @code{dired-tex-unclean-extensions}
850 @code{dired-texinfo-unclean-extensions}
852 @code{dired-latex-unclean-extensions}
854 @code{dired-bibtex-unclean-extensions}
857 @item dired-very-clean-tex
858 @findex dired-very-clean-tex
859 Flag dispensable files created by @TeX{}, La@TeX{}, @samp{texinfo},
860 and @file{*.dvi} files for deletion.
863 @node Advanced Cleaning Variables, Special Marking Function, Advanced Cleaning Functions, Advanced Mark Commands
864 @comment node-name, next, previous, up
866 @section Advanced Cleaning Variables
868 @noindent Variables used by the above cleaning commands (and in the default value for
869 variable @code{dired-omit-extensions}, @pxref{Omitting Variables})
872 @item dired-patch-unclean-extensions
873 @vindex dired-patch-unclean-extensions
874 Default: @code{(".rej" ".orig")}
876 List of extensions of dispensable files created by the @samp{patch} program.
878 @item dired-tex-unclean-extensions
879 @vindex dired-tex-unclean-extensions
880 Default: @code{(".toc" ".log" ".aux")}
882 List of extensions of dispensable files created by @TeX{}.
884 @item dired-texinfo-unclean-extensions
885 @vindex dired-texinfo-unclean-extensions
886 Default: @code{(".cp" ".cps" ".fn" ".fns" ".ky" ".kys"}
887 @code{".pg" ".pgs" ".tp" ".tps" ".vr" ".vrs")}
889 List of extensions of dispensable files created by @samp{texinfo}.
891 @item dired-latex-unclean-extensions
892 @vindex dired-latex-unclean-extensions
893 Default: @code{(".idx" ".lof" ".lot" ".glo")}
895 List of extensions of dispensable files created by La@TeX{}.
897 @item dired-bibtex-unclean-extensions
898 @vindex dired-bibtex-unclean-extensions
899 Default: @code{(".blg" ".bbl")}
901 List of extensions of dispensable files created by Bib@TeX{}.
904 @node Special Marking Function, , Advanced Cleaning Variables, Advanced Mark Commands
905 @comment node-name, next, previous, up
907 @section Special Marking Function
912 @findex dired-mark-sexp
913 @cindex Lisp expression, marking files with in Dired
914 @cindex Mark file by Lisp expression
915 (@code{dired-mark-sexp}) Mark files for which @var{predicate} returns
916 non-@code{nil}. With a prefix argument, unflag those files instead.
918 The @var{predicate} is a Lisp expression that can refer to the following
922 [@i{integer}] the inode of the file (only for @samp{ls -i} output)
924 [@i{integer}] the size of the file for @samp{ls -s} output (usually in blocks or,
925 with @samp{-k}, in KBytes)
927 [@i{string}] file permission bits, e.g., @samp{-rw-r--r--}
929 [@i{integer}] number of links to file
933 [@i{string}] group (If the gid is not displayed by @samp{ls}, this
934 will still be set (to the same as uid))
936 [@i{integer}] file size in bytes
938 [@i{string}] the time that @samp{ls} displays, e.g., @samp{Feb 12 14:17}
940 [@i{string}] the name of the file
942 [@i{string}] if file is a symbolic link, the linked-to name, else @code{""}
950 to mark all zero length files.
952 To find out all not yet compiled Emacs Lisp files in a directory, Dired
953 all @file{.el} files in the lisp directory using the wildcard
954 @samp{*.el}. Then use @kbd{M-(} with
956 (not (file-exists-p (concat name "c")))
958 to mark all @file{.el} files without a corresponding @file{.elc} file.
962 @node Multiple Dired Directories, Find File At Point, Advanced Mark Commands, Top
963 @comment node-name, next, previous, up
964 @chapter Multiple Dired Directories and Non-Dired Commands
966 @cindex Multiple Dired directories
967 @cindex Working directory
968 An Emacs buffer can have but one working directory, stored in the
969 buffer-local variable @code{default-directory}. A Dired buffer may have
970 several subdirectories inserted, but it still has only one working
971 directory: that of the top-level Dired directory in that buffer. For
972 some commands it is appropriate that they use the current Dired
973 directory instead of @code{default-directory}, e.g., @code{find-file} and
976 A general mechanism is provided for special handling of the working
977 directory in special major modes:
980 @item default-directory-alist
981 @vindex default-directory-alist
982 Default: @code{((dired-mode . (dired-current-directory)))}
984 Alist of major modes and their notion of @code{default-directory}, as a
985 Lisp expression to evaluate. A resulting value of @code{nil} is ignored
986 in favor of @code{default-directory}.
988 @item dired-default-directory
989 @findex dired-default-directory
990 Use this function like you would use the variable
991 @code{default-directory}, except that @code{dired-default-directory}
992 also consults the variable @code{default-directory-alist}.
995 @node Find File At Point, Miscellaneous Commands, Multiple Dired Directories, Top
996 @comment node-name, next, previous, up
998 @section Find File At Point
999 @cindex Visiting a file mentioned in a buffer
1000 @cindex Finding a file at point
1002 @file{dired-x} provides a method of visiting or editing a file mentioned in
1003 the buffer you are viewing (e.g., a mail buffer, a news article, a
1004 @file{README} file, etc.) or to test if that file exists. You can then modify
1005 this in the minibuffer after snatching the file name.
1007 When installed @file{dired-x} will substitute @code{dired-x-find-file} for
1008 @code{find-file} (normally bound to @kbd{C-x C-f}) and
1009 @code{dired-x-find-file-other-window} for @code{find-file-other-window}
1010 (normally bound to @kbd{C-x 4 C-f}).
1012 In order to use this feature, you will need to set
1013 @code{dired-x-hands-off-my-keys} to @code{nil} inside @code{dired-load-hook}
1014 (@pxref{Optional Installation File At Point}).
1017 @item dired-x-find-file
1018 @findex dired-x-find-file
1021 @code{dired-x-find-file} behaves exactly like @code{find-file} (normally bound
1022 to @kbd{C-x C-f}) unless a prefix argument is passed to the function in which
1023 case it will use the file name at point as a guess for the file to visit.
1025 For example, if the buffer you were reading contained the words
1028 Available via anonymous ftp in
1030 /roebling.poly.edu:/pub/lisp/crypt++.el.gz
1034 then you could move your cursor to the line containing the ftp address and
1035 type @kbd{C-u C-x C-f} (the @kbd{C-u} is a universal argument). The
1036 minibuffer would read
1039 Find file: /roebling.poly.edu:/pub/lisp/crypt++.el.gz
1043 with the point after the last @code{/}. If you hit @key{RET}, emacs will visit
1044 the file at that address. This also works with files on your own computer.
1046 @item dired-x-find-file-other-window
1047 @findex dired-x-find-file-other-window
1050 @code{dired-x-find-file-other-window} behaves exactly like
1051 @code{find-file-other-window} (normally bound to @kbd{C-x 4 C-f}) unless a
1052 prefix argument is used. See @code{dired-x-find-file} for more information.
1054 @item dired-x-hands-off-my-keys
1055 @vindex dired-x-hands-off-my-keys
1056 If set to @code{t}, then it means that @file{dired-x} should @emph{not} bind
1057 @code{dired-x-find-file} over @code{find-file} on keyboard. Similarly, it
1058 should not bind @code{dired-x-find-file-other-window} over
1059 @code{find-file-other-window}. If you change this variable after
1060 @file{dired-x.el} is loaded then do @kbd{M-x dired-x-bind-find-file}. The
1061 default value of this variable is @code{t}; by default, the binding is not
1062 done. See @xref{Optional Installation File At Point}.
1064 @item dired-x-bind-find-file
1065 @findex dired-x-bind-find-file
1066 A function, which can be called interactively or in your @file{~/.emacs} file,
1067 that uses the value of @code{dired-x-hands-off-my-keys} to determine if
1068 @code{dired-x-find-file} should be bound over @code{find-file} and
1069 @code{dired-x-find-file-other-window} bound over
1070 @code{find-file-other-window}. See @xref{Optional Installation File At Point}.
1073 @node Miscellaneous Commands, Bugs, Find File At Point, Top
1074 @comment node-name, next, previous, up
1075 @chapter Miscellaneous Commands
1077 Miscellaneous features not fitting anywhere else:
1080 @item dired-find-subdir
1081 @vindex dired-find-subdir
1084 If non-@code{nil}, Dired does not make a new buffer for a directory if it can
1085 be found (perhaps as subdirectory) in some existing Dired buffer.
1087 If there are several Dired buffers for a directory, the most recently
1090 Dired avoids switching to the current buffer, so that if you have a
1091 normal and a wildcard buffer for the same directory, @kbd{C-x d RET}
1092 will toggle between those two.
1096 @findex dired-goto-subdir
1099 (@code{dired-goto-subdir}) Go to the header line of an inserted directory.
1100 This command reads its argument, with completion derived from the names of the
1101 inserted subdirectories.
1105 @item dired-smart-shell-command
1106 @findex dired-smart-shell-command
1107 @findex shell-command
1109 Like function @code{shell-command}, but in the current Dired directory.
1110 Bound to @kbd{M-!} in Dired buffers.
1115 @cindex Jumping to Dired listing containing file.
1116 Bound to @kbd{C-x C-j}. Jump back to Dired: If in a file, edit the current
1117 directory and move to file's line. If in Dired already, pop up a level and
1118 go to old directory's line. In case the proper Dired file line cannot be
1119 found, refresh the Dired buffer and try again.
1121 @item dired-jump-other-window
1122 @findex dired-jump-other-window
1124 Bound to @kbd{C-x 4 C-j}. Like @code{dired-jump}, but to other window.
1126 These functions can be autoloaded so they work even though @file{dired-x.el}
1127 has not been loaded yet (@pxref{Optional Installation Dired Jump}).
1129 @vindex dired-bind-jump
1130 If the variable @code{dired-bind-jump} is @code{nil}, @code{dired-jump} will not be
1131 bound to @kbd{C-x C-j} and @code{dired-jump-other-window} will not be bound to
1135 @cindex Reading mail.
1138 Bound to @kbd{V} if @code{dired-bind-vm} is @code{t}. Run VM on this
1139 file (assumed to be a UNIX mail folder).
1141 @vindex dired-vm-read-only-folders
1142 If you give this command a prefix argument, it will visit the folder
1143 read-only. This only works in VM 5, not VM 4.
1145 If the variable @code{dired-vm-read-only-folders} is @code{t},
1146 @code{dired-vm} will
1147 visit all folders read-only. If it is neither @code{nil} nor @code{t}, e.g.,
1148 the symbol @code{if-file-read-only}, only files not writable by you are
1149 visited read-only. This is the recommended value if you run VM 5.
1151 @vindex dired-bind-vm
1152 If the variable @code{dired-bind-vm} is @code{t}, @code{dired-vm} will be bound
1153 to @kbd{V}. Otherwise, @code{dired-bind-rmail} will be bound.
1156 @cindex Reading mail.
1158 Bound to @kbd{V} if @code{dired-bind-vm} is @code{nil}. Run Rmail on this
1159 file (assumed to be mail folder in Rmail/BABYL format).
1163 @cindex Running info.
1165 Bound to @kbd{I}. Run Info on this file (assumed to be a file in Info
1168 @vindex dired-bind-info
1169 If the variable @code{dired-bind-info} is @code{nil}, @code{dired-info} will
1170 not be bound to @kbd{I}.
1173 @cindex Running man.
1176 Bound to @kbd{N}. Run man on this file (assumed to be a file in @code{nroff}
1179 @vindex dired-bind-man
1180 If the variable @code{dired-bind-man} is @code{nil}, @code{dired-man} will not
1181 be bound to @kbd{N}.
1183 @item dired-do-relsymlink
1184 @cindex Relative symbolic links.
1186 @findex dired-do-relsymlink
1187 Bound to @kbd{Y}. Relative symlink all marked (or next ARG) files into a
1188 directory, or make a relative symbolic link to the current file. This creates
1189 relative symbolic links like
1196 not absolute ones like
1199 foo -> /ugly/path/that/may/change/any/day/bar/foo
1202 @item dired-do-relsymlink-regexp
1204 @findex dired-do-relsymlink-regexp
1205 Bound to @kbd{%Y}. Relative symlink all marked files containing
1206 @var{regexp} to @var{newname}. See functions
1207 @code{dired-do-rename-regexp} and @code{dired-do-relsymlink} for more
1211 @node Bugs, GNU Free Documentation License, Miscellaneous Commands, Top
1212 @comment node-name, next, previous, up
1215 @findex dired-x-submit-report
1218 If you encounter a bug in this package, wish to suggest an
1219 enhancement, or want to make a smart remark, then type
1222 @kbd{M-x dired-x-submit-report}
1226 to set up an outgoing mail buffer, with the proper address to the
1227 @file{dired-x.el} maintainer automatically inserted in the @samp{To:@:} field.
1228 This command also inserts information that the Dired X maintainer can use to
1229 recreate your exact setup, making it easier to verify your bug or social
1233 @c <dodd@@roebling.poly.edu>
1235 @node GNU Free Documentation License, Concept Index, Bugs, Top
1236 @appendix GNU Free Documentation License
1237 @include doclicense.texi
1239 @node Concept Index, Command Index, GNU Free Documentation License, Top
1240 @comment node-name, next, previous, up
1241 @unnumbered Concept Index
1244 @node Command Index, Key Index, Concept Index, Top
1245 @comment node-name, next, previous, up
1246 @unnumbered Function Index
1249 @node Key Index, Variable Index, Command Index, Top
1250 @comment node-name, next, previous, up
1251 @unnumbered Key Index
1254 @node Variable Index, , Key Index, Top
1255 @comment node-name, next, previous, up
1256 @unnumbered Variable Index
1259 @setchapternewpage odd
1264 @c dired-x.texi ends here.
1267 arch-tag: 201727aa-9318-4c74-a0d7-4f51c550c4de