1 ;;; dired-x.el --- extra Dired functionality -*-byte-compile-dynamic: t;-*-
3 ;; Copyright (C) 1993, 1994, 1997, 2001, 2002, 2003, 2004,
4 ;; 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
6 ;; Author: Sebastian Kremer <sk@thp.uni-koeln.de>
7 ;; Lawrence R. Dodd <dodd@roebling.poly.edu>
8 ;; Maintainer: Romain Francoise <rfrancoise@gnu.org>
9 ;; Keywords: dired extensions files
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software; you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation; either version 3, or (at your option)
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs; see the file COPYING. If not, write to the
25 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
26 ;; Boston, MA 02110-1301, USA.
30 ;; This is Sebastian Kremer's excellent dired-x.el (Dired Extra), version
31 ;; 1.191, hacked up for GNU Emacs. Redundant or conflicting material has
32 ;; been removed or renamed in order to work properly with dired of GNU
33 ;; Emacs. All suggestions or comments are most welcomed.
36 ;; Please, PLEASE, *PLEASE* see the info pages.
39 ;; BUGS: Type M-x dired-x-submit-report and a report will be generated.
41 ;; INSTALLATION: In your ~/.emacs,
43 ;; (add-hook 'dired-load-hook
44 ;; (function (lambda ()
46 ;; ;; Set global variables here. For example:
47 ;; ;; (setq dired-guess-shell-gnutar "gtar")
49 ;; (add-hook 'dired-mode-hook
50 ;; (function (lambda ()
51 ;; ;; Set buffer-local variables here. For example:
52 ;; ;; (dired-omit-mode 1)
55 ;; At load time dired-x.el will install itself, redefine some functions, and
56 ;; bind some dired keys. *Please* see the info pages for more details.
58 ;; *Please* see the info pages for more details.
60 ;; User defined variables:
63 ;; dired-vm-read-only-folders
67 ;; dired-x-hands-off-my-keys
69 ;; dired-enable-local-variables
70 ;; dired-local-variables-file
71 ;; dired-guess-shell-gnutar
72 ;; dired-guess-shell-gzip-quiet
73 ;; dired-guess-shell-znew-switches
74 ;; dired-guess-shell-alist-user
75 ;; dired-clean-up-buffers-too
78 ;; dired-omit-extensions
79 ;; dired-omit-size-limit
81 ;; To find out more about these variables, load this file, put your cursor at
82 ;; the end of any of the variable names, and hit C-h v [RET]. *Please* see
83 ;; the info pages for more details.
85 ;; When loaded this code redefines the following functions of GNU Emacs
87 ;; Function Found in this file of GNU Emacs
88 ;; -------- -------------------------------
89 ;; dired-clean-up-after-deletion ../lisp/dired.el
90 ;; dired-find-buffer-nocreate ../lisp/dired.el
91 ;; dired-initial-position ../lisp/dired.el
93 ;; dired-add-entry ../lisp/dired-aux.el
94 ;; dired-read-shell-command ../lisp/dired-aux.el
101 ;; This is a no-op if dired-x is being loaded via `dired-load-hook'. It is
102 ;; here in case the user has autoloaded dired-x via the dired-jump key binding
103 ;; (instead of autoloading to dired as is suggested in the info-pages).
107 ;; We will redefine some functions and also need some macros so we need to
108 ;; load dired stuff of GNU Emacs.
112 (defvar vm-folder-directory
)
113 (eval-when-compile (require 'man
))
115 ;;; User-defined variables.
117 (defgroup dired-x nil
118 "Extended directory editing (dired-x)."
121 (defgroup dired-keys nil
122 "Dired keys customizations."
126 (defcustom dired-bind-vm nil
127 "*Non-nil means \"V\" runs `dired-vm', otherwise \"V\" runs `dired-rmail'.
128 Also, RMAIL files contain -*- rmail -*- at the top so \"f\",
129 `dired-advertised-find-file', will run rmail."
133 (defcustom dired-bind-jump t
134 "*Non-nil means bind `dired-jump' to C-x C-j, otherwise do not."
138 (defcustom dired-bind-man t
139 "*Non-nil means bind `dired-man' to \"N\" in dired-mode, otherwise do not."
143 (defcustom dired-bind-info t
144 "*Non-nil means bind `dired-info' to \"I\" in dired-mode, otherwise do not."
148 (defcustom dired-vm-read-only-folders nil
149 "*If non-nil, \\[dired-vm] will visit all folders read-only.
150 If neither nil nor t, e.g. the symbol `if-file-read-only', only
151 files not writable by you are visited read-only.
153 Read-only folders only work in VM 5, not in VM 4."
154 :type
'(choice (const :tag
"off" nil
)
156 (other :tag
"non-writable only" if-file-read-only
))
159 (define-minor-mode dired-omit-mode
160 "Toggle Dired-Omit mode.
161 With numeric ARG, enable Dired-Omit mode if ARG is positive, disable
162 otherwise. Enabling and disabling is buffer-local.
163 If enabled, \"uninteresting\" files are not listed.
164 Uninteresting files are those whose filenames match regexp `dired-omit-files',
165 plus those ending with extensions in `dired-omit-extensions'."
168 ;; This will mention how many lines were omitted:
169 (let ((dired-omit-size-limit nil
)) (dired-omit-expunge))
172 ;; For backward compatibility
173 (define-obsolete-variable-alias 'dired-omit-files-p
'dired-omit-mode
"22.1")
175 (defcustom dired-omit-files
"^\\.?#\\|^\\.$\\|^\\.\\.$"
176 "*Filenames matching this regexp will not be displayed.
177 This only has effect when `dired-omit-mode' is t. See interactive function
178 `dired-omit-mode' \(\\[dired-omit-mode]\) and variable
179 `dired-omit-extensions'. The default is to omit `.', `..', auto-save
180 files and lock files."
184 (defcustom dired-find-subdir nil
; t is pretty near to DWIM...
185 "*If non-nil, Dired always finds a directory in a buffer of its own.
186 If nil, Dired finds the directory as a subdirectory in some other buffer
187 if it is present as one.
189 If there are several dired buffers for a directory, the most recently
192 Dired avoids switching to the current buffer, so that if you have
193 a normal and a wildcard buffer for the same directory, \\[dired] will
194 toggle between those two."
198 (defcustom dired-omit-size-limit
30000
199 "*Maximum size for the \"omitting\" feature.
200 If nil, there is no maximum size."
201 :type
'(choice (const :tag
"no maximum" nil
) integer
)
204 (defcustom dired-enable-local-variables t
205 "*Control use of local-variables lists in Dired.
206 The value can be t, nil or something else.
207 A value of t means local-variables lists are obeyed;
208 nil means they are ignored; anything else means query.
210 This temporarily overrides the value of `enable-local-variables' when listing
211 a directory. See also `dired-local-variables-file'."
215 (defcustom dired-guess-shell-gnutar
(when (or (eq system-type
'gnu
)
216 (eq system-type
'gnu
/linux
))
218 "*If non-nil, name of GNU tar executable.
219 \(E.g., \"tar\" or \"gtar\"). The `z' switch will be used with it for
220 compressed or gzip'ed tar files. If you don't have GNU tar, set this
221 to nil: a pipe using `zcat' or `gunzip -c' will be used."
222 :type
'(choice (const :tag
"Not GNU tar" nil
)
223 (string :tag
"Command name"))
226 (defcustom dired-guess-shell-gzip-quiet t
227 "*Non-nil says pass -q to gzip overriding verbose GZIP environment."
231 (defcustom dired-guess-shell-znew-switches nil
232 "*If non-nil, then string of switches passed to `znew', example: \"-K\"."
233 :type
'(choice (const :tag
"None" nil
)
234 (string :tag
"Switches"))
237 (defcustom dired-clean-up-buffers-too t
238 "*Non-nil means offer to kill buffers visiting files and dirs deleted in Dired."
244 (define-key dired-mode-map
"\M-o" 'dired-omit-mode
)
245 (define-key dired-mode-map
"*O" 'dired-mark-omitted
)
246 (define-key dired-mode-map
"\M-(" 'dired-mark-sexp
)
247 (define-key dired-mode-map
"*(" 'dired-mark-sexp
)
248 (define-key dired-mode-map
"*." 'dired-mark-extension
)
249 (define-key dired-mode-map
"\M-!" 'dired-smart-shell-command
)
250 (define-key dired-mode-map
"w" 'dired-copy-filename-as-kill
)
251 (define-key dired-mode-map
"\M-G" 'dired-goto-subdir
)
252 (define-key dired-mode-map
"F" 'dired-do-find-marked-files
)
253 (define-key dired-mode-map
"Y" 'dired-do-relsymlink
)
254 (define-key dired-mode-map
"%Y" 'dired-do-relsymlink-regexp
)
255 (define-key dired-mode-map
"V" 'dired-do-run-mail
)
258 (define-key dired-mode-map
"N" 'dired-man
))
261 (define-key dired-mode-map
"I" 'dired-info
))
265 (let ((menu-bar (lookup-key dired-mode-map
[menu-bar
])))
266 (let ((menu (lookup-key menu-bar
[operate])))
272 dired-do-find-marked-files
273 :help "Find current or marked files")
279 "Relative symlink to..."
281 :visible (fboundp 'make-symbolic-link)
282 :help "Make relative symbolic links for current or marked files")
284 (let ((menu (lookup-key menu-bar [mark])))
291 :help "Flag files with a certain extension for deletion")
299 :help "Mark files with a certain extension")
307 :help "Mark files matching `dired-omit-files' and `dired-omit-extensions'")
309 (let ((menu (lookup-key menu-bar [regexp])))
314 "Relative symlink..."
315 dired-do-relsymlink-regexp
316 :visible (fboundp 'make-symbolic-link)
317 :help "Make relative symbolic links for files matching regexp")
319 (let ((menu (lookup-key menu-bar [immediate])))
324 "Omit mode" dired-omit-mode
325 :button (:toggle . dired-omit-mode)
326 :help "Enable or disable omitting \"uninteresting\" files")
332 (define-key global-map "\C-x\C-j" 'dired-jump)
333 (define-key global-map "\C-x4\C-j" 'dired-jump-other-window)))
336 ;;; Install into appropriate hooks.
338 (add-hook 'dired-mode-hook 'dired-extra-startup)
339 (add-hook 'dired-after-readin-hook 'dired-omit-expunge)
341 (defun dired-extra-startup ()
342 "Automatically put on `dired-mode-hook' to get extra Dired features:
344 \\[dired-do-run-mail]\t-- run mail on folder (see `dired-bind-vm')
345 \\[dired-info]\t-- run info on file
346 \\[dired-man]\t-- run man on file
347 \\[dired-do-find-marked-files]\t-- visit all marked files simultaneously
348 \\[dired-omit-mode]\t-- toggle omitting of files
349 \\[dired-mark-sexp]\t-- mark by Lisp expression
350 \\[dired-copy-filename-as-kill]\t-- copy the file or subdir names into the kill ring;
351 \t you can feed it to other commands using \\[yank]
353 For more features, see variables
359 `dired-vm-read-only-folders'
362 `dired-omit-extensions'
363 `dired-omit-size-limit'
365 `dired-enable-local-variables'
366 `dired-local-variables-file'
367 `dired-guess-shell-gnutar'
368 `dired-guess-shell-gzip-quiet'
369 `dired-guess-shell-znew-switches'
370 `dired-guess-shell-alist-user'
371 `dired-clean-up-buffers-too'
375 `dired-flag-extension'
382 `dired-do-find-marked-files'"
385 ;; These must be done in each new dired buffer.
386 (dired-hack-local-variables)
387 (dired-omit-startup))
393 (defun dired-clean-up-after-deletion (fn)
394 "Clean up after a deleted file or directory FN.
395 Remove expanded subdir of deleted dir, if any."
396 (save-excursion (and (cdr dired-subdir-alist)
397 (dired-goto-subdir fn)
398 (dired-kill-subdir)))
400 ;; Offer to kill buffer of deleted file FN.
401 (if dired-clean-up-buffers-too
403 (let ((buf (get-file-buffer fn)))
405 (funcall (function y-or-n-p)
406 (format "Kill buffer of %s, too? "
407 (file-name-nondirectory fn)))
408 (save-excursion ; you never know where kill-buffer leaves you
410 (let ((buf-list (dired-buffers-for-dir (expand-file-name fn)))
413 (y-or-n-p (format "Kill dired buffer%s of %s, too? "
414 (dired-plural-s (length buf-list))
415 (file-name-nondirectory fn)))
417 (save-excursion (kill-buffer (car buf-list)))
418 (setq buf-list (cdr buf-list)))))))
423 ;;; EXTENSION MARKING FUNCTIONS.
425 ;;; Mark files with some extension.
426 (defun dired-mark-extension (extension &optional marker-char)
427 "Mark all files with a certain EXTENSION for use in later commands.
428 A `.' is *not* automatically prepended to the string entered."
429 ;; EXTENSION may also be a list of extensions instead of a single one.
430 ;; Optional MARKER-CHAR is marker to use.
431 (interactive "sMarking extension: \nP")
432 (or (listp extension)
433 (setq extension (list extension)))
434 (dired-mark-files-regexp
435 (concat ".";; don't match names with nothing but an extension
437 (mapconcat 'regexp-quote extension "\\|")
441 (defun dired-flag-extension (extension)
442 "In dired, flag all files with a certain EXTENSION for deletion.
443 A `.' is *not* automatically prepended to the string entered."
444 (interactive "sFlagging extension: ")
445 (dired-mark-extension extension dired-del-marker))
447 ;;; Define some unpopular file extensions. Used for cleaning and omitting.
449 (defvar dired-patch-unclean-extensions
451 "List of extensions of dispensable files created by the `patch' program.")
453 (defvar dired-tex-unclean-extensions
454 '(".toc" ".log" ".aux");; these are already in completion-ignored-extensions
455 "List of extensions of dispensable files created by TeX.")
457 (defvar dired-latex-unclean-extensions
458 '(".idx" ".lof" ".lot" ".glo")
459 "List of extensions of dispensable files created by LaTeX.")
461 (defvar dired-bibtex-unclean-extensions
463 "List of extensions of dispensable files created by BibTeX.")
465 (defvar dired-texinfo-unclean-extensions
466 '(".cp" ".cps" ".fn" ".fns" ".ky" ".kys" ".pg" ".pgs"
467 ".tp" ".tps" ".vr" ".vrs")
468 "List of extensions of dispensable files created by texinfo.")
470 (defun dired-clean-patch ()
471 "Flag dispensable files created by patch for deletion.
472 See variable `dired-patch-unclean-extensions'."
474 (dired-flag-extension dired-patch-unclean-extensions))
476 (defun dired-clean-tex ()
477 "Flag dispensable files created by [La]TeX etc. for deletion.
478 See variables `dired-tex-unclean-extensions',
479 `dired-latex-unclean-extensions', `dired-bibtex-unclean-extensions' and
480 `dired-texinfo-unclean-extensions'."
482 (dired-flag-extension (append dired-texinfo-unclean-extensions
483 dired-latex-unclean-extensions
484 dired-bibtex-unclean-extensions
485 dired-tex-unclean-extensions)))
487 (defun dired-very-clean-tex ()
488 "Flag dispensable files created by [La]TeX *and* \".dvi\" for deletion.
489 See variables `dired-texinfo-unclean-extensions',
490 `dired-latex-unclean-extensions', `dired-bibtex-unclean-extensions' and
491 `dired-texinfo-unclean-extensions'."
493 (dired-flag-extension (append dired-texinfo-unclean-extensions
494 dired-latex-unclean-extensions
495 dired-bibtex-unclean-extensions
496 dired-tex-unclean-extensions
502 (defun dired-jump (&optional other-window)
503 "Jump to dired buffer corresponding to current buffer.
504 If in a file, dired the current directory and move to file's line.
505 If in Dired already, pop up a level and goto old directory's line.
506 In case the proper dired file line cannot be found, refresh the dired
507 buffer and try again."
509 (let* ((file buffer-file-name)
510 (dir (if file (file-name-directory file) default-directory)))
511 (if (eq major-mode 'dired-mode)
513 (setq dir (dired-current-directory))
514 (dired-up-directory other-window)
515 (or (dired-goto-file dir)
516 ;; refresh and try again
518 (dired-insert-subdir (file-name-directory dir))
519 (dired-goto-file dir))))
521 (dired-other-window dir)
524 (or (dired-goto-file file)
525 ;; refresh and try again
527 (dired-insert-subdir (file-name-directory file))
528 (dired-goto-file file))
529 ;; Toggle omitting, if it is on, and try again.
533 (dired-goto-file file))))))))
535 (defun dired-jump-other-window ()
536 "Like \\[dired-jump] (`dired-jump') but in other window."
542 ;;; Enhanced omitting of lines from directory listings.
543 ;;; Marked files are never omitted.
545 ;; should probably get rid of this and always use 'no-dir.
546 ;; sk 28-Aug-1991 09:37
547 (defvar dired-omit-localp 'no-dir
548 "The LOCALP argument `dired-omit-expunge' passes to `dired-get-filename'.
549 If it is `no-dir', omitting is much faster, but you can only match
550 against the non-directory part of the file name. Set it to nil if you
551 need to match the entire file name.")
553 ;; \017=^O for Omit - other packages can chose other control characters.
554 (defvar dired-omit-marker-char ?\017
555 "Temporary marker used by dired-omit.
556 Should never be used as marker by the user or other packages.")
558 (defun dired-omit-startup ()
559 (or (assq 'dired-omit-mode minor-mode-alist)
560 (setq minor-mode-alist
561 (append '((dired-omit-mode
562 (:eval (if (eq major-mode 'dired-mode)
566 (defun dired-mark-omitted ()
567 "Mark files matching `dired-omit-files' and `dired-omit-extensions'."
569 (let ((dired-omit-mode nil)) (revert-buffer)) ;; Show omitted files
570 (dired-mark-unmarked-files (dired-omit-regexp) nil nil dired-omit-localp))
572 (defvar dired-omit-extensions
573 (append completion-ignored-extensions
574 dired-latex-unclean-extensions
575 dired-bibtex-unclean-extensions
576 dired-texinfo-unclean-extensions)
577 "If non-nil, a list of extensions \(strings\) to omit from Dired listings.
578 Defaults to elements of `completion-ignored-extensions',
579 `dired-latex-unclean-extensions', `dired-bibtex-unclean-extensions', and
580 `dired-texinfo-unclean-extensions'.
582 See interactive function `dired-omit-mode' \(\\[dired-omit-mode]\) and
583 variables `dired-omit-mode' and `dired-omit-files'.")
585 (defun dired-omit-expunge (&optional regexp)
586 "Erases all unmarked files matching REGEXP.
587 Does nothing if global variable `dired-omit-mode' is nil, or if called
588 non-interactively and buffer is bigger than `dired-omit-size-limit'.
589 If REGEXP is nil or not specified, uses `dired-omit-files', and also omits
590 filenames ending in `dired-omit-extensions'.
591 If REGEXP is the empty string, this function is a no-op.
593 This functions works by temporarily binding `dired-marker-char' to
594 `dired-omit-marker-char' and calling `dired-do-kill-lines'."
595 (interactive "sOmit files (regexp): ")
596 (if (and dired-omit-mode
598 (not dired-omit-size-limit)
599 (< (buffer-size) dired-omit-size-limit)
601 (message "Not omitting: directory larger than %d characters."
602 dired-omit-size-limit)
603 (setq dired-omit-mode nil)
605 (let ((omit-re (or regexp (dired-omit-regexp)))
606 (old-modified-p (buffer-modified-p))
608 (or (string= omit-re "")
609 (let ((dired-marker-char dired-omit-marker-char))
610 (message "Omitting...")
611 (if (dired-mark-unmarked-files omit-re nil nil dired-omit-localp)
613 (setq count (dired-do-kill-lines nil "Omitted %d line%s."))
614 (force-mode-line-update))
615 (message "(Nothing to omit)"))))
616 ;; Try to preserve modified state of buffer. So `%*' doesn't appear
617 ;; in mode-line of omitted buffers.
618 (set-buffer-modified-p (and old-modified-p
620 (goto-char (point-min))
621 (re-search-forward dired-re-mark nil t))))
624 (defun dired-omit-regexp ()
625 (concat (if dired-omit-files (concat "\\(" dired-omit-files "\\)") "")
626 (if (and dired-omit-files dired-omit-extensions) "\\|" "")
627 (if dired-omit-extensions
628 (concat ".";; a non-extension part should exist
630 (mapconcat 'regexp-quote dired-omit-extensions "\\|")
634 ;; Returns t if any work was done, nil otherwise.
635 (defun dired-mark-unmarked-files (regexp msg &optional unflag-p localp)
636 "Mark unmarked files matching REGEXP, displaying MSG.
637 REGEXP is matched against the entire file name.
638 Does not re-mark files which already have a mark.
639 With prefix argument, unflag all those files.
640 Optional fourth argument LOCALP is as in `dired-get-filename'."
642 (let ((dired-marker-char (if unflag-p ?\s dired-marker-char)))
645 ;; not already marked
648 (let ((fn (dired-get-filename localp t)))
649 (and fn (string-match regexp fn))))
652 ;; Compiler does not get fset.
653 (declare-function dired-omit-old-add-entry "dired-x")
656 ;;; Redefine dired-aux.el's version of `dired-add-entry'
657 ;;; Save old defun if not already done:
658 (or (fboundp 'dired-omit-old-add-entry)
659 (fset 'dired-omit-old-add-entry (symbol-function 'dired-add-entry)))
662 (defun dired-omit-new-add-entry (filename &optional marker-char relative)
663 ;; This redefines dired-aux.el's dired-add-entry to avoid calling ls for
664 ;; files that are going to be omitted anyway.
666 ;; perhaps return t without calling ls
667 (let ((omit-re (dired-omit-regexp)))
668 (if (or (string= omit-re "")
670 (string-match omit-re
672 ((eq 'no-dir dired-omit-localp)
674 ((eq t dired-omit-localp)
675 (dired-make-relative filename))
679 (file-name-directory filename)))))))
680 ;; if it didn't match, go ahead and add the entry
681 (dired-omit-old-add-entry filename marker-char relative)
682 ;; dired-add-entry returns t for success, perhaps we should
683 ;; return file-exists-p
685 ;; omitting is not turned on at all
686 (dired-omit-old-add-entry filename marker-char relative)))
689 (fset 'dired-add-entry 'dired-omit-new-add-entry)
692 ;;; VIRTUAL DIRED MODE.
694 ;;; For browsing `ls -lR' listings in a dired-like fashion.
696 (defalias 'virtual-dired 'dired-virtual)
697 (defun dired-virtual (dirname &optional switches)
698 "Put this buffer into Virtual Dired mode.
700 In Virtual Dired mode, all commands that do not actually consult the
701 filesystem will work.
703 This is useful if you want to peruse and move around in an ls -lR
704 output file, for example one you got from an ftp server. With
705 ange-ftp, you can even dired a directory containing an ls-lR file,
706 visit that file and turn on virtual dired mode. But don't try to save
707 this file, as dired-virtual indents the listing and thus changes the
710 If you have save a Dired buffer in a file you can use \\[dired-virtual] to
711 resume it in a later session.
713 Type \\<dired-mode-map>\\[revert-buffer] \
714 in the Virtual Dired buffer and answer `y' to convert
715 the virtual to a real dired buffer again. You don't have to do this, though:
716 you can relist single subdirs using \\[dired-do-redisplay]."
718 ;; DIRNAME is the top level directory of the buffer. It will become
719 ;; its `default-directory'. If nil, the old value of
720 ;; default-directory is used.
722 ;; Optional SWITCHES are the ls switches to use.
724 ;; Shell wildcards will be used if there already is a `wildcard'
725 ;; line in the buffer (thus it is a saved Dired buffer), but there
726 ;; is no other way to get wildcards. Insert a `wildcard' line by
727 ;; hand if you want them.
730 (list (read-string "Virtual Dired directory: " (dired-virtual-guess-dir))))
731 (goto-char (point-min))
733 ;; if not already indented, do it now:
734 (indent-region (point-min) (point-max) 2))
735 (or dirname (setq dirname default-directory))
736 (setq dirname (expand-file-name (file-name-as-directory dirname)))
737 (setq default-directory dirname) ; contains no wildcards
738 (let ((wildcard (save-excursion
739 (goto-char (point-min))
741 (and (looking-at "^ wildcard ")
742 (buffer-substring (match-end 0)
743 (progn (end-of-line) (point)))))))
745 (setq dirname (expand-file-name wildcard default-directory))))
746 ;; If raw ls listing (not a saved old dired buffer), give it a
747 ;; decent subdir headerline:
748 (goto-char (point-min))
749 (or (looking-at dired-subdir-regexp)
751 (directory-file-name (file-name-directory default-directory))
753 (dired-mode dirname (or switches dired-listing-switches))
754 (setq mode-name "Virtual Dired"
755 revert-buffer-function 'dired-virtual-revert)
756 (set (make-local-variable 'dired-subdir-alist) nil)
757 (dired-build-subdir-alist)
758 (goto-char (point-min))
759 (dired-initial-position dirname))
761 (defun dired-virtual-guess-dir ()
762 "Guess and return appropriate working directory of this buffer.
763 The buffer is assumed to be in Dired or ls -lR format. The guess is
764 based upon buffer contents. If nothing could be guessed, returns
767 (let ((regexp "^\\( \\)?\\([^ \n\r]*\\)\\(:\\)[\n\r]")
769 (goto-char (point-min))
770 (cond ((looking-at regexp)
771 ;; If a saved dired buffer, look to which dir and
772 ;; perhaps wildcard it belongs:
773 (let ((dir (buffer-substring (match-beginning subexpr)
774 (match-end subexpr))))
775 (file-name-as-directory dir)))
776 ;; Else no match for headerline found. It's a raw ls listing.
777 ;; In raw ls listings the directory does not have a headerline
778 ;; try parent of first subdir, if any
779 ((re-search-forward regexp nil t)
782 (file-name-as-directory
783 (buffer-substring (match-beginning subexpr)
784 (match-end subexpr))))))
785 (t ; if all else fails
789 (defun dired-virtual-revert (&optional arg noconfirm)
791 (y-or-n-p "Cannot revert a Virtual Dired buffer - switch to Real Dired mode? "))
792 (error "Cannot revert a Virtual Dired buffer")
793 (setq mode-name "Dired"
794 revert-buffer-function 'dired-revert)
797 ;; A zero-arg version of dired-virtual.
798 (defun dired-virtual-mode ()
799 "Put current buffer into Virtual Dired mode (see `dired-virtual').
800 Useful on `magic-mode-alist' with the regexp
802 \"^ \\\\(/[^ /]+\\\\)+/?:$\"
804 to put saved dired buffers automatically into Virtual Dired mode.
806 Also useful for `auto-mode-alist' like this:
808 (add-to-list 'auto-mode-alist
809 '(\"[^/]\\\\.dired\\\\'\" . dired-virtual-mode))"
811 (dired-virtual (dired-virtual-guess-dir)))
816 ;;; An Emacs buffer can have but one working directory, stored in the
817 ;;; buffer-local variable `default-directory'. A Dired buffer may have
818 ;;; several subdirectories inserted, but still has but one working directory:
819 ;;; that of the top level Dired directory in that buffer. For some commands
820 ;;; it is appropriate that they use the current Dired directory instead of
821 ;;; `default-directory', e.g., `find-file' and `compile'. This is a general
822 ;;; mechanism is provided for special handling of the working directory in
823 ;;; special major modes.
825 ;; It's easier to add to this alist than redefine function
826 ;; default-directory while keeping the old information.
827 (defconst default-directory-alist
828 '((dired-mode . (if (fboundp 'dired-current-directory)
829 (dired-current-directory)
831 "Alist of major modes and their opinion on `default-directory'.
832 This is given as a Lisp expression to evaluate. A resulting value of
833 nil is ignored in favor of `default-directory'.")
835 (defun dired-default-directory ()
836 "Usage like variable `default-directory'.
837 Knows about the special cases in variable `default-directory-alist'."
838 (or (eval (cdr (assq major-mode default-directory-alist)))
841 (defun dired-smart-shell-command (command &optional output-buffer error-buffer)
842 "Like function `shell-command', but in the current Virtual Dired directory."
845 (minibuffer-with-setup-hook
847 (set (make-local-variable 'minibuffer-default-add-function)
848 'minibuffer-default-add-shell-commands))
849 (read-shell-command "Shell command: " nil nil
851 (buffer-file-name (file-relative-name buffer-file-name))
852 ((eq major-mode 'dired-mode) (dired-get-filename t t)))))
854 shell-command-default-error-buffer))
855 (let ((default-directory (dired-default-directory)))
856 (shell-command command output-buffer error-buffer)))
859 ;;; LOCAL VARIABLES FOR DIRED BUFFERS.
861 ;;; Brief Description:
863 ;;; * `dired-extra-startup' is part of the `dired-mode-hook'.
865 ;;; * `dired-extra-startup' calls `dired-hack-local-variables'
867 ;;; * `dired-hack-local-variables' checks the value of
868 ;;; `dired-local-variables-file'
870 ;;; * Check if `dired-local-variables-file' is a non-nil string and is a
871 ;;; filename found in the directory of the Dired Buffer being created.
873 ;;; * If `dired-local-variables-file' satisfies the above, then temporarily
874 ;;; include it in the Dired Buffer at the bottom.
876 ;;; * Set `enable-local-variables' temporarily to the user variable
877 ;;; `dired-enable-local-variables' and run `hack-local-variables' on the
880 (defvar dired-local-variables-file (convert-standard-filename ".dired")
881 "Filename, as string, containing local dired buffer variables to be hacked.
882 If this file found in current directory, then it will be inserted into dired
883 buffer and `hack-local-variables' will be run. See Info node
884 `(emacs)File Variables' for more information on local variables.
885 See also `dired-enable-local-variables'.")
887 (defun dired-hack-local-variables ()
888 "Evaluate local variables in `dired-local-variables-file' for dired buffer."
889 (if (and dired-local-variables-file
890 (stringp dired-local-variables-file)
891 (file-exists-p dired-local-variables-file))
892 (let ((opoint (point-max))
894 ;; In case user has `enable-local-variables' set to nil we
895 ;; override it locally with dired's variable.
896 (enable-local-variables dired-enable-local-variables))
901 (insert-file-contents dired-local-variables-file))
903 (let ((buffer-file-name dired-local-variables-file))
904 (hack-local-variables))
905 ;; Make sure that the modeline shows the proper information.
906 (dired-sort-set-modeline)
907 ;; Delete this stuff: `eobp' is used to find last subdir by dired.el.
908 (delete-region opoint (point-max)))))
910 (defun dired-omit-here-always ()
911 "Create `dired-local-variables-file' for omitting and reverts directory.
912 Sets `dired-omit-mode' to t in a local variables file that is readable by
915 (if (file-exists-p dired-local-variables-file)
916 (message "File `./%s' already exists." dired-local-variables-file)
918 ;; Create `dired-local-variables-file'.
920 (set-buffer (get-buffer-create " *dot-dired*"))
922 (insert "Local Variables:\ndired-omit-mode: t\nEnd:\n")
923 (write-file dired-local-variables-file)
924 (kill-buffer (current-buffer)))
926 ;; Run extra-hooks and revert directory.
927 (dired-extra-startup)
931 ;;; GUESS SHELL COMMAND.
933 ;;; Brief Description:
935 ;;; `dired-do-shell-command' is bound to `!' by dired.el.
937 ;;; * Redefine `dired-read-shell-command' so it calls
938 ;;; `dired-guess-shell-command'.
940 ;;; * `dired-guess-shell-command' calls `dired-guess-default' with list of
943 ;;; * Parse `dired-guess-shell-alist-user' and
944 ;;; `dired-guess-shell-alist-default' (in that order) for the first REGEXP
945 ;;; that matches the first file in the file list.
947 ;;; * If the REGEXP matches all the entries of the file list then evaluate
948 ;;; COMMAND, which is either a string or a Lisp expression returning a
949 ;;; string. COMMAND may be a list of commands.
951 ;;; * Return this command to `dired-guess-shell-command' which prompts user
952 ;;; with it. The list of commands is put into the list of default values.
953 ;;; If a command is used successfully then it is stored permanently in
954 ;;; `dired-shell-command-history'.
956 ;;; Guess what shell command to apply to a file.
957 (defvar dired-shell-command-history nil
958 "History list for commands that read dired-shell commands.")
960 ;;; Default list of shell commands.
962 ;;; NOTE: Use `gunzip -c' instead of `zcat' on `.gz' files. Some do not
963 ;;; install GNU zip's version of zcat.
965 (defvar dired-guess-shell-alist-default
968 '(if dired-guess-shell-gnutar
969 (concat dired-guess-shell-gnutar " xvf")
971 ;; Extract files into a separate subdirectory
972 '(if dired-guess-shell-gnutar
973 (concat "mkdir " (file-name-sans-extension file)
974 "; " dired-guess-shell-gnutar " -C "
975 (file-name-sans-extension file) " -xvf")
976 (concat "mkdir " (file-name-sans-extension file)
977 "; tar -C " (file-name-sans-extension file) " -xvf"))
978 ;; List archive contents.
979 '(if dired-guess-shell-gnutar
980 (concat dired-guess-shell-gnutar " tvf")
983 ;; REGEXPS for compressed archives must come before the .Z rule to
987 '(if dired-guess-shell-gnutar
988 (concat dired-guess-shell-gnutar " zxvf")
989 (concat "zcat * | tar xvf -"))
990 ;; Optional conversion to gzip format.
991 '(concat "znew" (if dired-guess-shell-gzip-quiet " -q")
992 " " dired-guess-shell-znew-switches))
995 (list "\\.t\\(ar\\.\\)?gz$"
996 '(if dired-guess-shell-gnutar
997 (concat dired-guess-shell-gnutar " zxvf")
998 (concat "gunzip -qc * | tar xvf -"))
999 ;; Extract files into a separate subdirectory
1000 '(if dired-guess-shell-gnutar
1001 (concat "mkdir " (file-name-sans-extension file)
1002 "; " dired-guess-shell-gnutar " -C "
1003 (file-name-sans-extension file) " -zxvf")
1004 (concat "mkdir " (file-name-sans-extension file)
1005 "; gunzip -qc * | tar -C "
1006 (file-name-sans-extension file) " -xvf -"))
1007 ;; Optional decompression.
1008 '(concat "gunzip" (if dired-guess-shell-gzip-quiet " -q" ""))
1009 ;; List archive contents.
1010 '(if dired-guess-shell-gnutar
1011 (concat dired-guess-shell-gnutar " ztvf")
1012 (concat "gunzip -qc * | tar tvf -")))
1014 ;; bzip2'ed archives
1015 (list "\\.t\\(ar\\.bz2\\|bz\\)$"
1016 "bunzip2 -c * | tar xvf -"
1017 ;; Extract files into a separate subdirectory
1018 '(concat "mkdir " (file-name-sans-extension file)
1019 "; bunzip2 -c * | tar -C "
1020 (file-name-sans-extension file) " -xvf -")
1021 ;; Optional decompression.
1024 '("\\.shar\\.Z$" "zcat * | unshar")
1025 '("\\.shar\\.g?z$" "gunzip -qc * | unshar")
1027 '("\\.e?ps$" "ghostview" "xloadimage" "lpr")
1028 (list "\\.e?ps\\.g?z$" "gunzip -qc * | ghostview -"
1029 ;; Optional decompression.
1030 '(concat "gunzip" (if dired-guess-shell-gzip-quiet " -q")))
1031 (list "\\.e?ps\\.Z$" "zcat * | ghostview -"
1032 ;; Optional conversion to gzip format.
1033 '(concat "znew" (if dired-guess-shell-gzip-quiet " -q")
1034 " " dired-guess-shell-znew-switches))
1036 '("\\.patch$" "cat * | patch")
1037 (list "\\.patch\\.g?z$" "gunzip -qc * | patch"
1038 ;; Optional decompression.
1039 '(concat "gunzip" (if dired-guess-shell-gzip-quiet " -q")))
1040 (list "\\.patch\\.Z$" "zcat * | patch"
1041 ;; Optional conversion to gzip format.
1042 '(concat "znew" (if dired-guess-shell-gzip-quiet " -q")
1043 " " dired-guess-shell-znew-switches))
1045 ;; The following four extensions are useful with dired-man ("N" key)
1046 (list "\\.\\(?:[0-9]\\|man\\)$" '(progn (require 'man)
1047 (if (Man-support-local-filenames)
1049 "cat * | tbl | nroff -man -h")))
1050 (list "\\.\\(?:[0-9]\\|man\\)\\.g?z$" '(progn (require 'man)
1051 (if (Man-support-local-filenames)
1053 "gunzip -qc * | tbl | nroff -man -h"))
1054 ;; Optional decompression.
1055 '(concat "gunzip" (if dired-guess-shell-gzip-quiet " -q")))
1056 (list "\\.[0-9]\\.Z$" '(progn (require 'man)
1057 (if (Man-support-local-filenames)
1059 "zcat * | tbl | nroff -man -h"))
1060 ;; Optional conversion to gzip format.
1061 '(concat "znew" (if dired-guess-shell-gzip-quiet " -q")
1062 " " dired-guess-shell-znew-switches))
1063 '("\\.pod$" "perldoc" "pod2man * | nroff -man")
1065 '("\\.dvi$" "xdvi" "dvips") ; preview and printing
1066 '("\\.au$" "play") ; play Sun audiofiles
1067 '("\\.mpe?g$\\|\\.avi$" "xine -p")
1069 '("\\.uu$" "uudecode") ; for uudecoded files
1070 '("\\.hqx$" "mcvert")
1071 '("\\.sh$" "sh") ; execute shell scripts
1072 '("\\.xbm$" "bitmap") ; view X11 bitmaps
1073 '("\\.gp$" "gnuplot")
1074 '("\\.p[bgpn]m$" "xloadimage")
1075 '("\\.gif$" "xloadimage") ; view gif pictures
1076 '("\\.tif$" "xloadimage")
1077 '("\\.png$" "display") ; xloadimage 4.1 doesn't grok PNG
1078 '("\\.jpe?g$" "xloadimage")
1079 '("\\.fig$" "xfig") ; edit fig pictures
1080 '("\\.out$" "xgraph") ; for plotting purposes.
1081 '("\\.tex$" "latex" "tex")
1082 '("\\.texi\\(nfo\\)?$" "makeinfo" "texi2dvi")
1084 '("\\.doc$" "antiword" "strings")
1085 '("\\.rpm$" "rpm -qilp" "rpm -ivh")
1089 ;; Some other popular archivers.
1090 (list "\\.zip$" "unzip" "unzip -l"
1091 ;; Extract files into a separate subdirectory
1092 '(concat "unzip" (if dired-guess-shell-gzip-quiet " -q")
1093 " -d " (file-name-sans-extension file)))
1094 '("\\.zoo$" "zoo x//")
1095 '("\\.lzh$" "lharc x")
1096 '("\\.arc$" "arc x")
1097 '("\\.shar$" "unshar")
1100 (list "\\.g?z$" '(concat "gunzip" (if dired-guess-shell-gzip-quiet " -q")))
1101 (list "\\.dz$" "dictunzip")
1102 (list "\\.bz2$" "bunzip2")
1103 (list "\\.Z$" "uncompress"
1104 ;; Optional conversion to gzip format.
1105 '(concat "znew" (if dired-guess-shell-gzip-quiet " -q")
1106 " " dired-guess-shell-znew-switches))
1108 '("\\.sign?$" "gpg --verify"))
1110 "Default alist used for shell command guessing.
1111 See `dired-guess-shell-alist-user'.")
1113 (defcustom dired-guess-shell-alist-user nil
1114 "User-defined alist of rules for suggested commands.
1115 These rules take precedence over the predefined rules in the variable
1116 `dired-guess-shell-alist-default' (to which they are prepended).
1118 Each element of this list looks like
1120 \(REGEXP COMMAND...\)
1122 where each COMMAND can either be a string or a Lisp expression that evaluates
1123 to a string. If several COMMANDs are given, the first one will be the default
1124 and the rest will be added temporarily to the history and can be retrieved
1125 with \\[previous-history-element] (M-p) .
1127 You can set this variable in your ~/.emacs. For example, to add rules for
1128 `.foo' and `.bar' files, write
1130 \(setq dired-guess-shell-alist-user
1131 (list (list \"\\\\.foo\\\\'\" \"FOO-COMMAND\");; fixed rule
1132 ;; possibly more rules ...
1133 (list \"\\\\.bar\\\'\";; rule with condition test
1136 \"BAR-COMMAND-2\")))\)"
1138 :type '(alist :key-type regexp :value-type (repeat sexp)))
1140 (defcustom dired-guess-shell-case-fold-search t
1141 "If non-nil, `dired-guess-shell-alist-default' and
1142 `dired-guess-shell-alist-user' are matched case-insensitively."
1146 (defun dired-guess-default (files)
1147 "Guess a shell commands for FILES. Return command or list of commands.
1148 See `dired-guess-shell-alist-user'."
1150 (let* ((case-fold-search dired-guess-shell-case-fold-search)
1151 ;; Prepend the user's alist to the default alist.
1152 (alist (append dired-guess-shell-alist-user
1153 dired-guess-shell-alist-default))
1158 ;; Find the first match in the alist for first file in FILES.
1160 (setq elt (car alist)
1163 (if (string-match regexp file)
1164 (setq cmds (cdr elt)
1167 ;; If more than one file, see if all of FILES match regular expression.
1169 (string-match regexp (car flist)))
1170 (setq flist (cdr flist)))
1172 ;; If flist is still non-nil, then do not guess since this means that not
1173 ;; all the files in FILES were matched by the regexp.
1174 (setq cmds (and (not flist) cmds))
1176 ;; Return commands or nil if flist is still non-nil.
1177 ;; Evaluate the commands in order that any logical testing will be done.
1178 (cond ((not (cdr cmds))
1179 (eval (car cmds))) ; single command
1181 (mapcar (function eval) cmds)))))
1183 (defun dired-guess-shell-command (prompt files)
1184 "Ask user with PROMPT for a shell command, guessing a default from FILES."
1185 (let ((default (dired-guess-default files))
1189 (read-from-minibuffer prompt nil nil nil 'dired-shell-command-history)
1191 ;; More than one guess
1192 (setq default-list default
1193 default (car default)
1196 (format "{%d guesses} " (length default-list))))
1198 (setq default-list (list default)))
1199 ;; Put the first guess in the prompt but not in the initial value.
1200 (setq prompt (concat prompt (format "[%s] " default)))
1201 ;; All guesses can be retrieved with M-n
1202 (setq val (read-from-minibuffer prompt nil nil nil
1203 'dired-shell-command-history
1205 ;; If we got a return, then return default.
1206 (if (equal val "") default val))))
1209 ;;; Redefine dired-aux.el's version:
1210 (defun dired-read-shell-command (prompt arg files)
1211 "Read a dired shell command prompting with PROMPT (using read-string).
1212 ARG is the prefix arg and may be used to indicate in the prompt which
1214 This is an extra function so that you can redefine it."
1217 'dired-guess-shell-command
1218 (format prompt (dired-mark-prompt arg files)) ; PROMPT
1222 ;;; RELATIVE SYMBOLIC LINKS.
1224 (declare-function make-symbolic-link "fileio.c")
1226 (defvar dired-keep-marker-relsymlink ?S
1227 "See variable `dired-keep-marker-move'.")
1229 (defun dired-make-relative-symlink (file1 file2 &optional ok-if-already-exists)
1230 "Make a symbolic link (pointing to FILE1) in FILE2.
1231 The link is relative (if possible), for example
1233 \"/vol/tex/bin/foo\" \"/vol/local/bin/foo\"
1237 \"../../tex/bin/foo\" \"/vol/local/bin/foo\""
1238 (interactive "FRelSymLink: \nFRelSymLink %s: \np")
1239 (let (name1 name2 len1 len2 (index 0) sub)
1240 (setq file1 (expand-file-name file1)
1241 file2 (expand-file-name file2)
1243 len2 (length file2))
1244 ;; Find common initial file name components:
1246 (while (and (setq next (string-match "/" file1 index))
1247 (setq next (1+ next))
1248 (< next (min len1 len2))
1249 ;; For the comparison, both substrings must end in
1250 ;; `/', so NEXT is *one plus* the result of the
1252 ;; E.g., consider the case of linking "/tmp/a/abc"
1253 ;; to "/tmp/abc" erroneously giving "/tmp/a" instead
1254 ;; of "/tmp/" as common initial component
1255 (string-equal (substring file1 0 next)
1256 (substring file2 0 next)))
1259 sub (substring file1 0 index)
1260 name1 (substring file1 index)))
1261 (if (string-equal sub "/")
1262 ;; No common initial file name found
1264 ;; Else they have a common parent directory
1265 (let ((tem (substring file2 index))
1268 ;; Count number of slashes we must compensate for ...
1269 (while (setq start (string-match "/" tem start))
1270 (setq count (1+ count)
1272 ;; ... and prepend a "../" for each slash found:
1274 (setq count (1- count)
1275 name1 (concat "../" name1)))))
1277 (directory-file-name name1) ; must not link to foo/
1279 name2 ok-if-already-exists)))
1282 (defun dired-do-relsymlink (&optional arg)
1283 "Relative symlink all marked (or next ARG) files into a directory.
1284 Otherwise make a relative symbolic link to the current file.
1285 This creates relative symbolic links like
1289 not absolute ones like
1291 foo -> /ugly/file/name/that/may/change/any/day/bar/foo
1293 For absolute symlinks, use \\[dired-do-symlink]."
1295 (dired-do-create-files 'relsymlink (function dired-make-relative-symlink)
1296 "RelSymLink" arg dired-keep-marker-relsymlink))
1298 (defun dired-do-relsymlink-regexp (regexp newname &optional arg whole-name)
1299 "RelSymlink all marked files containing REGEXP to NEWNAME.
1300 See functions `dired-do-rename-regexp' and `dired-do-relsymlink'
1302 (interactive (dired-mark-read-regexp "RelSymLink"))
1303 (dired-do-create-files-regexp
1304 (function dired-make-relative-symlink)
1305 "RelSymLink" arg regexp newname whole-name dired-keep-marker-relsymlink))
1308 ;;; VISIT ALL MARKED FILES SIMULTANEOUSLY.
1310 ;;; Brief Description:
1312 ;;; `dired-do-find-marked-files' is bound to `F' by dired-x.el.
1314 ;;; * Use `dired-get-marked-files' to collect the marked files in the current
1315 ;;; Dired Buffer into a list of filenames `FILE-LIST'.
1317 ;;; * Pass FILE-LIST to `dired-simultaneous-find-file' all with
1318 ;;; `dired-do-find-marked-files''s prefix argument NOSELECT.
1320 ;;; * `dired-simultaneous-find-file' runs through FILE-LIST decrementing the
1323 ;;; * If NOSELECT is non-nil then just run `find-file-noselect' on each
1324 ;;; element of FILE-LIST.
1326 ;;; * If NOSELECT is nil then calculate the `size' of the window for each file
1327 ;;; by dividing the `window-height' by length of FILE-LIST. Thus, `size' is
1328 ;;; cognizant of the window-configuration.
1330 ;;; * If `size' is too small abort, otherwise run `find-file' on each element
1331 ;;; of FILE-LIST giving each a window of height `size'.
1333 (defun dired-do-find-marked-files (&optional noselect)
1334 "Find all marked files displaying all of them simultaneously.
1335 With optional NOSELECT just find files but do not select them.
1337 The current window is split across all files marked, as evenly as possible.
1338 Remaining lines go to bottom-most window. The number of files that can be
1339 displayed this way is restricted by the height of the current window and
1340 `window-min-height'.
1342 To keep dired buffer displayed, type \\[split-window-vertically] first.
1343 To display just marked files, type \\[delete-other-windows] first."
1346 (dired-simultaneous-find-file (dired-get-marked-files) noselect))
1348 (defun dired-simultaneous-find-file (file-list noselect)
1350 "Visit all files in FILE-LIST and display them simultaneously.
1351 The current window is split across all files in FILE-LIST, as evenly as
1352 possible. Remaining lines go to the bottom-most window. The number of
1353 files that can be displayed this way is restricted by the height of the
1354 current window and the variable `window-min-height'. With non-nil
1355 NOSELECT the files are merely found but not selected."
1357 ;; We don't make this function interactive because it is usually too clumsy
1358 ;; to specify FILE-LIST interactively unless via dired.
1363 ;; Do not select the buffer.
1364 (find-file-noselect (car file-list))
1366 ;; We will have to select the buffer. Calculate and check window size.
1367 (setq size (/ (window-height) (length file-list)))
1368 (or (<= window-min-height size)
1369 (error "Too many files to visit simultaneously. Try C-u prefix"))
1370 (find-file (car file-list)))
1373 (setq file-list (cdr file-list))
1378 ;; Do not select the buffer.
1379 (find-file-noselect (car file-list))
1381 ;; Vertically split off a window of desired size. Upper window will
1382 ;; have SIZE lines. Select lower (larger) window. We split it again.
1383 (select-window (split-window nil size))
1384 (find-file (car file-list)))
1387 (setq file-list (cdr file-list)))))
1390 ;;; MISCELLANEOUS COMMANDS.
1392 ;;; Run man on files.
1395 "Run man on this file. Display old buffer if buffer name matches filename.
1396 Uses `man.el' of \\[manual-entry] fame."
1399 (let* ((file (dired-get-filename))
1400 (manual-program (replace-regexp-in-string "\\*" "%s"
1401 (dired-guess-shell-command
1402 "Man command: " (list file)))))
1403 (Man-getpage-in-background file)))
1405 ;;; Run Info on files.
1407 (defun dired-info ()
1408 "Run info on this file."
1410 (info (dired-get-filename)))
1412 ;;; Run mail on mail folders.
1414 ;; Avoid compiler warning.
1416 (when (not (fboundp 'vm-visit-folder))
1417 (defun vm-visit-folder (file &optional arg)
1420 (defun dired-vm (&optional read-only)
1421 "Run VM on this file.
1422 With prefix arg, visit folder read-only (this requires at least VM 5).
1423 See also variable `dired-vm-read-only-folders'."
1425 (let ((dir (dired-current-directory))
1426 (fil (dired-get-filename)))
1427 ;; take care to supply 2nd arg only if requested - may still run VM 4!
1428 (cond (read-only (vm-visit-folder fil t))
1429 ((eq t dired-vm-read-only-folders) (vm-visit-folder fil t))
1430 ((null dired-vm-read-only-folders) (vm-visit-folder fil))
1431 (t (vm-visit-folder fil (not (file-writable-p fil)))))
1432 ;; so that pressing `v' inside VM does prompt within current directory:
1433 (set (make-local-variable 'vm-folder-directory) dir)))
1435 (defun dired-rmail ()
1436 "Run RMAIL on this file."
1438 (rmail (dired-get-filename)))
1440 (defun dired-do-run-mail ()
1441 "If `dired-bind-vm' is t, then function `dired-vm', otherwise `dired-rmail'."
1444 ;; Read mail folder using vm.
1446 ;; Read mail folder using rmail.
1450 ;;; MISCELLANEOUS INTERNAL FUNCTIONS.
1452 (declare-function dired-old-find-buffer-nocreate "dired-x")
1454 (or (fboundp 'dired-old-find-buffer-nocreate)
1455 (fset 'dired-old-find-buffer-nocreate
1456 (symbol-function 'dired-find-buffer-nocreate)))
1459 ;;; Redefines dired.el's version of `dired-find-buffer-nocreate'
1460 (defun dired-find-buffer-nocreate (dirname &optional mode)
1461 (if (and dired-find-subdir
1462 ;; don't try to find a wildcard as a subdirectory
1463 (string-equal dirname (file-name-directory dirname)))
1464 (let* ((cur-buf (current-buffer))
1466 (dired-buffers-for-dir (expand-file-name dirname))))
1467 (cur-buf-matches (and (memq cur-buf buffers)
1468 ;; wildcards must match, too:
1469 (equal dired-directory dirname))))
1470 ;; We don't want to switch to the same buffer---
1471 (setq buffers (delq cur-buf buffers));;need setq with delq
1472 (or (car (sort buffers (function dired-buffer-more-recently-used-p)))
1473 ;; ---unless it's the only possibility:
1474 (and cur-buf-matches cur-buf)))
1475 (dired-old-find-buffer-nocreate dirname mode)))
1477 ;; This should be a builtin
1478 (defun dired-buffer-more-recently-used-p (buffer1 buffer2)
1479 "Return t if BUFFER1 is more recently used than BUFFER2."
1480 (if (equal buffer1 buffer2)
1482 (let ((more-recent nil)
1483 (list (buffer-list)))
1485 (not (setq more-recent (equal buffer1 (car list))))
1486 (not (equal buffer2 (car list))))
1487 (setq list (cdr list)))
1490 ;;; Same thing as `dired-buffers-for-dir' of dired.el? - lrd 11/23/93
1491 ;;; (defun dired-buffers-for-dir-exact (dir)
1492 ;;; ;; Return a list of buffers that dired DIR (a directory or wildcard)
1493 ;;; ;; at top level, or as subdirectory.
1494 ;;; ;; Top level matches must match the wildcard part too, if any.
1495 ;;; ;; The list is in reverse order of buffer creation, most recent last.
1496 ;;; ;; As a side effect, killed dired buffers for DIR are removed from
1497 ;;; ;; dired-buffers.
1498 ;;; (let ((alist dired-buffers) result elt)
1500 ;;; (setq elt (car alist)
1501 ;;; alist (cdr alist))
1502 ;;; (let ((buf (cdr elt)))
1503 ;;; (if (buffer-name buf)
1504 ;;; ;; Top level must match exactly against dired-directory in
1505 ;;; ;; case one of them is a wildcard.
1506 ;;; (if (or (equal dir (save-excursion (set-buffer buf)
1507 ;;; dired-directory))
1508 ;;; (assoc dir (save-excursion (set-buffer buf)
1509 ;;; dired-subdir-alist)))
1510 ;;; (setq result (cons buf result)))
1511 ;;; ;; else buffer is killed - clean up:
1512 ;;; (setq dired-buffers (delq elt dired-buffers)))))
1516 ;;; Redefines dired.el's version of `dired-initial-position'
1517 (defun dired-initial-position (dirname)
1518 "Where point should go in a new listing of DIRNAME.
1519 Point assumed at beginning of new subdir line.
1520 You may redefine this function as you wish, e.g. like in `dired-x.el'."
1522 (if dired-find-subdir (dired-goto-subdir dirname)) ; new
1523 (if dired-trivial-filenames (dired-goto-next-nontrivial-file)))
1526 ;; Does anyone use this? - lrd 6/29/93.
1527 ;; Apparently people do use it. - lrd 12/22/97.
1528 (defun dired-mark-sexp (predicate &optional unflag-p)
1529 "Mark files for which PREDICATE returns non-nil.
1530 With a prefix arg, unflag those files instead.
1532 PREDICATE is a lisp expression that can refer to the following symbols:
1534 inode [integer] the inode of the file (only for ls -i output)
1535 s [integer] the size of the file for ls -s output
1536 (usually in blocks or, with -k, in KByte)
1537 mode [string] file permission bits, e.g. \"-rw-r--r--\"
1538 nlink [integer] number of links to file
1540 gid [string] group (If the gid is not displayed by ls,
1541 this will still be set (to the same as uid))
1542 size [integer] file size in bytes
1543 time [string] the time that ls displays, e.g. \"Feb 12 14:17\"
1544 name [string] the name of the file
1545 sym [string] if file is a symbolic link, the linked-to name, else \"\"
1551 to mark all zero length files."
1552 ;; Using sym="" instead of nil avoids the trap of
1553 ;; (string-match "foo" sym) into which a user would soon fall.
1554 ;; Give `equal' instead of `=' in the example, as this works on
1555 ;; integers and strings.
1556 (interactive "xMark if (lisp expr): \nP")
1557 (message "%s" predicate)
1558 (let ((dired-marker-char (if unflag-p ?\040 dired-marker-char))
1559 inode s mode nlink uid gid size time name sym)
1564 ;; inode s mode nlink uid gid size time name sym
1566 ;; according to current file line. Returns t for success, nil if
1567 ;; there is no file line. Upon success, all variables are set, either
1568 ;; to nil or the appropriate value, so they need not be initialized.
1569 ;; Moves point within the current line.
1570 (if (dired-move-to-filename)
1572 (mode-len 10) ; length of mode string
1573 ;; like in dired.el, but with subexpressions \1=inode, \2=s:
1574 (dired-re-inode-size "\\s *\\([0-9]*\\)\\s *\\([0-9]*\\) ?"))
1577 (if (looking-at dired-re-inode-size)
1579 (goto-char (match-end 0))
1580 (setq inode (string-to-number (buffer-substring (match-beginning 1)
1582 s (string-to-number (buffer-substring (match-beginning 2)
1586 (setq mode (buffer-substring (point) (+ mode-len (point))))
1587 (forward-char mode-len)
1588 (setq nlink (read (current-buffer)))
1589 ;; Karsten Wenger <kw@cis.uni-muenchen.de> fixed uid.
1590 (setq uid (buffer-substring (+ (point) 1)
1591 (progn (forward-word 1) (point))))
1592 (re-search-forward directory-listing-before-filename-regexp)
1593 (goto-char (match-beginning 1))
1595 (setq size (string-to-number (buffer-substring (save-excursion
1601 ;; if no gid is displayed, gid will be set to uid
1602 ;; but user will then not reference it anyway in PREDICATE.
1603 (setq gid (buffer-substring (save-excursion
1604 (forward-word 1) (point))
1606 time (buffer-substring (match-beginning 1)
1607 (1- (dired-move-to-filename)))
1608 name (buffer-substring (point)
1610 (dired-move-to-end-of-filename t)
1613 (if (looking-at " -> ")
1615 (progn (forward-char 4) (point))
1616 (progn (end-of-line) (point)))
1621 (format "'%s file" predicate))))
1624 ;;; FIND FILE AT POINT.
1626 (defvar dired-x-hands-off-my-keys t
1627 "*Non-nil means don't bind `dired-x-find-file' over `find-file' on keyboard.
1628 Similarly for `dired-x-find-file-other-window' over `find-file-other-window'.
1629 If you change this variable after `dired-x.el' is loaded then do
1630 \\[dired-x-bind-find-file].")
1632 ;;; Bind `dired-x-find-file{-other-window}' over wherever
1633 ;;; `find-file{-other-window}' is bound?
1634 (defun dired-x-bind-find-file ()
1635 "Bind `dired-x-find-file' in place of `find-file' \(or reverse\).
1636 Similarly for `dired-x-find-file-other-window' and `find-file-other-window'.
1637 Binding direction based on `dired-x-hands-off-my-keys'.
1638 This function is part of `after-init-hook'."
1641 (setq dired-x-hands-off-my-keys
1642 (not (y-or-n-p "Bind dired-x-find-file over find-file? "))))
1643 (cond ((not dired-x-hands-off-my-keys)
1644 (substitute-key-definition 'find-file
1646 (current-global-map))
1647 (substitute-key-definition 'find-file-other-window
1648 'dired-x-find-file-other-window
1649 (current-global-map)))
1651 (substitute-key-definition 'dired-x-find-file
1653 (current-global-map))
1654 (substitute-key-definition 'dired-x-find-file-other-window
1655 'find-file-other-window
1656 (current-global-map))))
1657 ;; Clear mini-buffer.
1660 ;;; Now call it so binding is correct and put on `after-init-hook' in case
1661 ;;; user changes binding.
1662 (dired-x-bind-find-file)
1663 (add-hook 'after-init-hook 'dired-x-bind-find-file)
1665 (defun dired-x-find-file (filename)
1666 "Edit file FILENAME.
1667 May create a new window, or reuse an existing one.
1668 See the function `display-buffer'.
1670 Identical to `find-file' except when called interactively, with a prefix arg
1671 \(e.g., \\[universal-argument]\), in which case it guesses filename near point.
1672 Useful for editing file mentioned in buffer you are viewing,
1673 or to test if that file exists. Use minibuffer after snatching filename."
1674 (interactive (list (read-filename-at-point "Find file: ")))
1675 (find-file (expand-file-name filename)))
1677 (defun dired-x-find-file-other-window (filename)
1678 "Edit file FILENAME, in another window.
1679 May create a new window, or reuse an existing one.
1680 See the function `display-buffer'.
1682 Identical to `find-file-other-window' except when called interactively, with a
1683 prefix arg \(e.g., \\[universal-argument]\), in which case it guesses filename near point.
1684 Useful for editing file mentioned in buffer you are viewing,
1685 or to test if that file exists. Use minibuffer after snatching filename."
1686 (interactive (list (read-filename-at-point "Find file: ")))
1687 (find-file-other-window (expand-file-name filename)))
1689 ;;; Internal functions.
1691 ;; Fixme: This should probably use `thing-at-point'. -- fx
1692 (defun dired-filename-at-point ()
1693 "Get the filename closest to point, but do not change position.
1694 Has a preference for looking backward when not directly on a symbol. Not
1695 perfect - point must be in middle of or end of filename."
1697 (let ((filename-chars "-.[:alnum:]_/:$+@")
1698 start end filename prefix)
1701 ;; First see if just past a filename.
1703 (if (looking-at "[] \t\n[{}()]") ; whitespace or some parens
1705 (skip-chars-backward " \n\t\r({[]})")
1707 (backward-char 1)))))
1709 (if (string-match (concat "[" filename-chars "]")
1710 (char-to-string (following-char)))
1712 (if (re-search-backward (concat "[^" filename-chars "]") nil t)
1714 (goto-char (point-min)))
1715 (setq start (point))
1719 (buffer-substring start (line-beginning-position)))
1722 (if (string-match "[/~]" (char-to-string (preceding-char)))
1723 (setq start (1- start)))
1724 (re-search-forward (concat "\\=[" filename-chars "]*") nil t))
1726 (error "No file found around point!"))
1729 (expand-file-name (concat prefix (buffer-substring start (point)))))))
1731 (defun read-filename-at-point (prompt)
1732 "Return filename prompting with PROMPT with completion.
1733 If `current-prefix-arg' is non-nil, uses name at point as guess."
1734 (if current-prefix-arg
1735 (let ((guess (dired-filename-at-point)))
1736 (read-file-name prompt
1737 (file-name-directory guess)
1739 nil (file-name-nondirectory guess)))
1740 (read-file-name prompt default-directory)))
1744 ;; Fixme: get rid of this later.
1746 ;;; This section is provided for reports. It uses Barry A. Warsaw's
1747 ;;; reporter.el which is bundled with GNU Emacs v19.
1749 (defconst dired-x-help-address "bug-gnu-emacs@gnu.org"
1750 "Address(es) accepting submission of reports on dired-x.el.")
1752 (defconst dired-x-variable-list
1755 'dired-vm-read-only-folders
1760 'dired-enable-local-variables
1761 'dired-local-variables-file
1762 'dired-guess-shell-gnutar
1763 'dired-guess-shell-gzip-quiet
1764 'dired-guess-shell-znew-switches
1765 'dired-guess-shell-alist-user
1766 'dired-clean-up-buffers-too
1769 'dired-omit-extensions
1771 "List of variables to be appended to reports sent by `dired-x-submit-report'.")
1773 (defun dired-x-submit-report ()
1774 "Submit via `reporter.el' a bug report on program.
1775 Send report on `dired-x-file' version `dired-x-version,' to
1776 `dired-x-maintainer' at address `dired-x-help-address' listing
1777 variables `dired-x-variable-list' in the message."
1780 (reporter-submit-bug-report
1781 dired-x-help-address ; address
1783 dired-x-variable-list ; varlist
1784 nil nil ; pre-/post-hooks
1788 ;; As Barry Warsaw would say: "This might be useful..."
1791 ;; arch-tag: 71a43ba2-7a00-4793-a028-0613dd7765ae
1792 ;;; dired-x.el ends here