dired-x.el 65.1 KB
Newer Older
Richard M. Stallman's avatar
Richard M. Stallman committed
1 2 3 4 5
;;; dired-x.el --- Sebastian Kremer's Extra DIRED hacked up for GNU Emacs19

;; Author: Sebastian Kremer <sk@thp.uni-koeln.de>
;;	Lawrence R. Dodd <dodd@roebling.poly.edu>
;; Maintainer: Lawrence R. Dodd <dodd@roebling.poly.edu>
6 7
;; Version: 2.37+
;; Date: 1994/08/18 19:27:42
Richard M. Stallman's avatar
Richard M. Stallman committed
8 9
;; Keywords: dired extensions

10
;; Copyright (C) 1993, 1994, 1997 Free Software Foundation, Inc.
Richard M. Stallman's avatar
Richard M. Stallman committed
11 12 13 14 15

;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
Richard M. Stallman's avatar
Richard M. Stallman committed
16
;; the Free Software Foundation; either version 2, or (at your option)
Richard M. Stallman's avatar
Richard M. Stallman committed
17 18 19 20 21 22 23 24
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
Erik Naggum's avatar
Erik Naggum committed
25 26 27
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
Richard M. Stallman's avatar
Richard M. Stallman committed
28

Karl Heuer's avatar
Karl Heuer committed
29
;;; Commentary:
Richard M. Stallman's avatar
Richard M. Stallman committed
30

Erik Naggum's avatar
Erik Naggum committed
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93
;; This is Sebastian Kremer's excellent dired-x.el (Dired Extra), version
;; 1.191, hacked up for GNU Emacs 19.  Redundant or conflicting material
;; has been removed or renamed in order to work properly with dired of
;; GNU Emacs 19.  All suggestions or comments are most welcomed.

;;  
;; Please, PLEASE, *PLEASE* see the info pages.
;; 

;; BUGS: Type M-x dired-x-submit-report and a report will be generated.

;; INSTALLATION: In your ~/.emacs,
;;
;; (add-hook 'dired-load-hook
;;           (function (lambda ()
;;                       (load "dired-x")
;;                       ;; Set global variables here.  For example:
;;                       ;; (setq dired-guess-shell-gnutar "gtar")
;;                       )))
;; (add-hook 'dired-mode-hook
;;           (function (lambda ()
;;                       ;; Set buffer-local variables here.  For example:
;;                       ;; (setq dired-omit-files-p t)
;;                       )))
;;
;; At load time dired-x.el will install itself, redefine some functions, and
;; bind some dired keys.  *Please* see the info pages for more details.

;; CAUTION: If you are using a version of GNU Emacs earlier than 19.20 than
;; you may have to edit dired.el.  The copy of dired.el in GNU Emacs versions
;; earlier than 19.20 incorrectly had the call to run-hooks *before* the call
;; to provide.  In such a case, it is possible that byte-compiling and/or
;; loading dired can cause an infinite loop.  To prevent this, make sure the
;; line of code
;;  
;;         (run-hooks 'dired-load-hook) 
;;  
;; is the *last* executable line in the file dired.el.  That is, make sure it
;; comes *after* the line
;;  
;;         (provide 'dired) 
;; 
;; *Please* see the info pages for more details. 

;; User defined variables:
;;
;;      dired-bind-vm
;;      dired-vm-read-only-folders
;;      dired-bind-jump
;;      dired-bind-info
;;      dired-bind-man
;;      dired-x-hands-off-my-keys 
;;      dired-find-subdir
;;      dired-enable-local-variables
;;      dired-local-variables-file
;;      dired-guess-shell-gnutar
;;      dired-guess-shell-gzip-quiet
;;      dired-guess-shell-znew-switches
;;      dired-guess-shell-alist-user
;;      dired-clean-up-buffers-too
;;      dired-omit-files-p
;;      dired-omit-files
;;      dired-omit-extensions
94
;;      dired-omit-size-limit
Erik Naggum's avatar
Erik Naggum committed
95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117
;;
;; To find out more about these variables, load this file, put your cursor at
;; the end of any of the variable names, and hit C-h v [RET].  *Please* see
;; the info pages for more details.

;; When loaded this code redefines the following functions of GNU Emacs
;;
;;   Function                         Found in this file of GNU Emacs
;;   --------                         -------------------------------
;;   dired-clean-up-after-deletion    ../lisp/dired.el
;;   dired-find-buffer-nocreate       ../lisp/dired.el
;;   dired-initial-position           ../lisp/dired.el
;;
;;   dired-add-entry                  ../lisp/dired-aux.el
;;   dired-read-shell-command         ../lisp/dired-aux.el
;;
;; One drawback is that dired-x.el will load dired-aux.el as soon as dired is
;; loaded.  Thus, the advantage of separating out non-essential dired stuff
;; into dired-aux.el and only loading when necessary will be lost.  Please
;; note also that some of the comments in dired.el and dired-aux.el are
;; Kremer's that referred to the old dired-x.el.  This now should be referring
;; to this program.  (This is also a good reason to call this dired-x.el
;; instead of dired-x19.el.)
Richard M. Stallman's avatar
Richard M. Stallman committed
118 119


Erik Naggum's avatar
Erik Naggum committed
120
;;; Code:
Richard M. Stallman's avatar
Richard M. Stallman committed
121

Erik Naggum's avatar
Erik Naggum committed
122
;; LOAD.
Richard M. Stallman's avatar
Richard M. Stallman committed
123

Erik Naggum's avatar
Erik Naggum committed
124 125 126
;; This is a no-op if dired-x is being loaded via `dired-load-hook'.  It is
;; here in case the user has autoloaded dired-x via the dired-jump key binding
;; (instead of autoloading to dired as is suggested in the info-pages).
Karl Heuer's avatar
Karl Heuer committed
127

128
(require 'dired)
Karl Heuer's avatar
Karl Heuer committed
129

Erik Naggum's avatar
Erik Naggum committed
130 131
;; We will redefine some functions and also need some macros so we need to
;; load dired stuff of GNU Emacs.
132 133

(require 'dired-aux)
Karl Heuer's avatar
Karl Heuer committed
134

Erik Naggum's avatar
Erik Naggum committed
135
;;; User-defined variables.
Richard M. Stallman's avatar
Richard M. Stallman committed
136

137 138 139
(defgroup dired-x nil
  "Extended directory editing (dired-x)."
  :group 'dired)
Richard M. Stallman's avatar
Richard M. Stallman committed
140

141 142 143 144
(defgroup dired-keys nil
  "Dired keys customizations."
  :prefix "dired-"
  :group 'dired-x)
Richard M. Stallman's avatar
Richard M. Stallman committed
145

146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168
(defcustom dired-bind-vm nil
  "*t says \"V\" in dired-mode will `dired-vm', otherwise \"V\" is `dired-rmail'.
Also, RMAIL files contain -*- rmail -*- at the top so \"f\",
`dired-advertised-find-file', will run rmail."
  :type 'boolean
  :group 'dired-keys)

(defcustom dired-bind-jump t
  "*t says bind `dired-jump' to C-x C-j, otherwise do not."
  :type 'boolean
  :group 'dired-keys)

(defcustom dired-bind-man t
  "*t says bind `dired-man' to \"N\" in dired-mode, otherwise do not."
  :type 'boolean
  :group 'dired-keys)

(defcustom dired-bind-info t
  "*t says bind `dired-info' to \"I\" in dired-mode, otherwise do not."
  :type 'boolean
  :group 'dired-keys)

(defcustom dired-vm-read-only-folders nil
Richard M. Stallman's avatar
Richard M. Stallman committed
169 170 171 172
  "*If t, \\[dired-vm] will visit all folders read-only.
If neither nil nor t, e.g. the symbol `if-file-read-only', only
files not writable by you are visited read-only.

173 174 175
Read-only folders only work in VM 5, not in VM 4."
  :type '(choice (const :tag "off" nil)
		 (const :tag "on" t)
176
		 (other :tag "non-writable only" if-file-read-only))
177
  :group 'dired-x)
Richard M. Stallman's avatar
Richard M. Stallman committed
178

179
(defcustom dired-omit-files-p nil
Richard M. Stallman's avatar
Richard M. Stallman committed
180 181 182
  "*If non-nil, \"uninteresting\" files are not listed (buffer-local).
Use \\[dired-omit-toggle] to toggle its value.
Uninteresting files are those whose filenames match regexp `dired-omit-files',
183 184 185
plus those ending with extensions in `dired-omit-extensions'."
  :type 'boolean
  :group 'dired-x)
186
(make-variable-buffer-local 'dired-omit-files-p)
Richard M. Stallman's avatar
Richard M. Stallman committed
187

188
(defcustom dired-omit-files "^\\.?#\\|^\\.$\\|^\\.\\.$"
189
  "*Filenames matching this regexp will not be displayed.
190 191
This only has effect when `dired-omit-files-p' is t.  See interactive function
`dired-omit-toggle' \(\\[dired-omit-toggle]\) and variable
192 193
`dired-omit-extensions'.  The default is to omit  `.', `..', auto-save
files and lock files."
194 195
  :type 'regexp
  :group 'dired-x)
Richard M. Stallman's avatar
Richard M. Stallman committed
196

197
(defcustom dired-find-subdir nil           ; t is pretty near to DWIM...
198 199 200
  "*If non-nil, Dired always finds a directory in a buffer of its own.
If nil, Dired finds the directory as a subdirectory in some other buffer
if it is present as one.
Richard M. Stallman's avatar
Richard M. Stallman committed
201 202 203 204 205 206

If there are several Dired buffers for a directory, the most recently
used is chosen.

Dired avoids switching to the current buffer, so that if you have
a normal and a wildcard buffer for the same directory, C-x d RET will
207 208 209 210
toggle between those two."
  :type 'boolean
  :group 'dired-x)

211
(defcustom dired-omit-size-limit 30000
212 213 214 215
  "*Maximum size for the \"omitting\" feature.
If nil, there is no maximum size."
  :type '(choice (const :tag "no maximum" nil) integer)
  :group 'dired-x)
Richard M. Stallman's avatar
Richard M. Stallman committed
216

217
(defcustom dired-enable-local-variables t
Richard M. Stallman's avatar
Richard M. Stallman committed
218 219 220 221 222 223
  "*Control use of local-variables lists in dired.
The value can be t, nil or something else.
A value of t means local-variables lists are obeyed;
nil means they are ignored; anything else means query.

This temporarily overrides the value of `enable-local-variables' when listing
224 225 226
a directory.  See also `dired-local-variables-file'."
  :type 'boolean
  :group 'dired-x)
Richard M. Stallman's avatar
Richard M. Stallman committed
227

228
(defcustom dired-guess-shell-gnutar nil
Richard M. Stallman's avatar
Richard M. Stallman committed
229 230
  "*If non-nil, name of GNU tar executable (e.g., \"tar\" or \"gtar\") and `z'
switch will be used for compressed or gzip'ed tar files.  If no GNU tar, set
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248
to nil: a pipe using `zcat' or `gunzip -c' will be used."
  :type 'boolean
  :group 'dired-x)

(defcustom dired-guess-shell-gzip-quiet t
  "*non-nil says pass -q to gzip overriding verbose GZIP environment."
  :type 'boolean
  :group 'dired-x)

(defcustom dired-guess-shell-znew-switches nil
  "*If non-nil, then string of switches passed to `znew', example: \"-K\""
  :type 'boolean
  :group 'dired-x)

(defcustom dired-clean-up-buffers-too t
  "*t says offer to kill buffers visiting files and dirs deleted in dired."
  :type 'boolean
  :group 'dired-x)
Richard M. Stallman's avatar
Richard M. Stallman committed
249

Erik Naggum's avatar
Erik Naggum committed
250
;;; KEY BINDINGS.
Richard M. Stallman's avatar
Richard M. Stallman committed
251 252 253

(define-key dired-mode-map "\M-o" 'dired-omit-toggle)
(define-key dired-mode-map "\M-(" 'dired-mark-sexp)
254 255
(define-key dired-mode-map "*(" 'dired-mark-sexp)
(define-key dired-mode-map "*." 'dired-mark-extension)
Richard M. Stallman's avatar
Richard M. Stallman committed
256 257 258 259 260 261 262 263 264 265 266 267 268 269 270
(define-key dired-mode-map "\M-!" 'dired-smart-shell-command)
(define-key dired-mode-map "w" 'dired-copy-filename-as-kill)
(define-key dired-mode-map "\M-g" 'dired-goto-file)
(define-key dired-mode-map "\M-G" 'dired-goto-subdir)
(define-key dired-mode-map "F" 'dired-do-find-marked-files)
(define-key dired-mode-map "Y"  'dired-do-relsymlink)
(define-key dired-mode-map "%Y" 'dired-do-relsymlink-regexp)
(define-key dired-mode-map "V" 'dired-do-run-mail)

(if dired-bind-man
    (define-key dired-mode-map "N" 'dired-man))

(if dired-bind-info
    (define-key dired-mode-map "I" 'dired-info))

Karl Heuer's avatar
Karl Heuer committed
271
;;; GLOBAL BINDING.
Richard M. Stallman's avatar
Richard M. Stallman committed
272 273 274 275 276 277
(if dired-bind-jump
    (progn
      (define-key global-map "\C-x\C-j" 'dired-jump)
      (define-key global-map "\C-x4\C-j" 'dired-jump-other-window)))


Erik Naggum's avatar
Erik Naggum committed
278
;;; Install into appropriate hooks.
Richard M. Stallman's avatar
Richard M. Stallman committed
279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305

(add-hook 'dired-mode-hook 'dired-extra-startup)
(add-hook 'dired-after-readin-hook 'dired-omit-expunge)

(defun dired-extra-startup ()
  "Automatically put on dired-mode-hook to get extra dired features:
\\<dired-mode-map>

  \\[dired-do-run-mail]\t-- run mail on folder (see `dired-bind-vm')
  \\[dired-info]\t-- run info on file
  \\[dired-man]\t-- run man on file
  \\[dired-do-find-marked-files]\t-- visit all marked files simultaneously
  \\[dired-omit-toggle]\t-- toggle omitting of files
  \\[dired-mark-sexp]\t-- mark by lisp expression
  \\[dired-copy-filename-as-kill]\t-- copy the file or subdir names into the kill ring.
  \t   You can feed it to other commands using \\[yank].

For more features, see variables

  dired-bind-vm
  dired-bind-jump
  dired-bind-info
  dired-bind-man
  dired-vm-read-only-folders
  dired-omit-files-p
  dired-omit-files
  dired-omit-extensions
306
  dired-omit-size-limit
Richard M. Stallman's avatar
Richard M. Stallman committed
307 308 309 310 311 312 313
  dired-find-subdir
  dired-enable-local-variables
  dired-local-variables-file
  dired-guess-shell-gnutar
  dired-guess-shell-gzip-quiet
  dired-guess-shell-znew-switches
  dired-guess-shell-alist-user
Karl Heuer's avatar
Karl Heuer committed
314
  dired-clean-up-buffers-too
Richard M. Stallman's avatar
Richard M. Stallman committed
315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333

See also functions

  dired-flag-extension
  dired-virtual
  dired-jump
  dired-man
  dired-vm
  dired-rmail
  dired-info
  dired-do-find-marked-files
"
  (interactive)

  ;; These must be done in each new dired buffer.
  (dired-hack-local-variables)
  (dired-omit-startup))


Erik Naggum's avatar
Erik Naggum committed
334
;;; BUFFER CLEANING.
Richard M. Stallman's avatar
Richard M. Stallman committed
335

Erik Naggum's avatar
Erik Naggum committed
336
;; REDEFINE.
Richard M. Stallman's avatar
Richard M. Stallman committed
337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354
(defun dired-clean-up-after-deletion (fn)

  ;; Clean up after a deleted file or directory FN.
  ;; Remove expanded subdir of deleted dir, if any.
  (save-excursion (and (cdr dired-subdir-alist)
                       (dired-goto-subdir fn)
                       (dired-kill-subdir)))

  ;; Offer to kill buffer of deleted file FN.
  (if dired-clean-up-buffers-too
      (progn
        (let ((buf (get-file-buffer fn)))
          (and buf
               (funcall (function y-or-n-p)
                        (format "Kill buffer of %s, too? "
                                (file-name-nondirectory fn)))
               (save-excursion ; you never know where kill-buffer leaves you
                 (kill-buffer buf))))
355
        (let ((buf-list (dired-buffers-for-dir (expand-file-name fn)))
Richard M. Stallman's avatar
Richard M. Stallman committed
356 357 358 359 360 361 362 363
              (buf nil))
          (and buf-list
               (y-or-n-p (format "Kill dired buffer%s of %s, too? "
                                 (dired-plural-s (length buf-list))
                                 (file-name-nondirectory fn)))
               (while buf-list
                 (save-excursion (kill-buffer (car buf-list)))
                 (setq buf-list (cdr buf-list)))))))
Karl Heuer's avatar
Karl Heuer committed
364
  ;; Anything else?
Richard M. Stallman's avatar
Richard M. Stallman committed
365 366 367
  )


Erik Naggum's avatar
Erik Naggum committed
368
;;; EXTENSION MARKING FUNCTIONS.
Richard M. Stallman's avatar
Richard M. Stallman committed
369

Karl Heuer's avatar
Karl Heuer committed
370
;;; Mark files with some extension.
Richard M. Stallman's avatar
Richard M. Stallman committed
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421
(defun dired-mark-extension (extension &optional marker-char)
  "Mark all files with a certain extension for use in later commands.
A `.' is not automatically prepended to the string entered."
  ;; EXTENSION may also be a list of extensions instead of a single one.
  ;; Optional MARKER-CHAR is marker to use.
  (interactive "sMarking extension: \nP")
  (or (listp extension)
      (setq extension (list extension)))
  (dired-mark-files-regexp
   (concat ".";; don't match names with nothing but an extension
           "\\("
           (mapconcat 'regexp-quote extension "\\|")
           "\\)$")
   marker-char))

(defun dired-flag-extension (extension)
  "In dired, flag all files with a certain extension for deletion.
A `.' is *not* automatically prepended to the string entered."
  (interactive "sFlagging extension: ")
  (dired-mark-extension extension dired-del-marker))

;;; Define some unpopular file extensions.  Used for cleaning and omitting.

(defvar dired-patch-unclean-extensions
  '(".rej" ".orig")
  "List of extensions of dispensable files created by the `patch' program.")

(defvar dired-tex-unclean-extensions
  '(".toc" ".log" ".aux");; these are already in completion-ignored-extensions
  "List of extensions of dispensable files created by TeX.")

(defvar dired-latex-unclean-extensions
  '(".idx" ".lof" ".lot" ".glo")
  "List of extensions of dispensable files created by LaTeX.")

(defvar dired-bibtex-unclean-extensions
  '(".blg" ".bbl")
  "List of extensions of dispensable files created by BibTeX.")

(defvar dired-texinfo-unclean-extensions
  '(".cp" ".cps" ".fn" ".fns" ".ky" ".kys" ".pg" ".pgs"
    ".tp" ".tps" ".vr" ".vrs")
  "List of extensions of dispensable files created by texinfo.")

(defun dired-clean-patch ()
  "Flag dispensable files created by patch for deletion.
See variable `dired-patch-unclean-extensions'."
  (interactive)
  (dired-flag-extension dired-patch-unclean-extensions))

(defun dired-clean-tex ()
Karl Heuer's avatar
Karl Heuer committed
422 423 424 425
  "Flag dispensable files created by [La]TeX etc. for deletion.
See variables `dired-texinfo-unclean-extensions',
`dired-latex-unclean-extensions', `dired-bibtex-unclean-extensions' and
`dired-texinfo-unclean-extensions'."
Richard M. Stallman's avatar
Richard M. Stallman committed
426 427 428 429 430 431
  (interactive)
  (dired-flag-extension (append dired-texinfo-unclean-extensions
                                dired-latex-unclean-extensions
                                dired-bibtex-unclean-extensions
                                dired-tex-unclean-extensions)))

Karl Heuer's avatar
Karl Heuer committed
432 433 434 435 436
(defun dired-very-clean-tex ()
  "Flag dispensable files created by [La]TeX *and* \".dvi\" for deletion.
See variables `dired-texinfo-unclean-extensions',
`dired-latex-unclean-extensions', `dired-bibtex-unclean-extensions' and
`dired-texinfo-unclean-extensions'."
Richard M. Stallman's avatar
Richard M. Stallman committed
437
  (interactive)
Karl Heuer's avatar
Karl Heuer committed
438 439 440 441 442
  (dired-flag-extension (append dired-texinfo-unclean-extensions
                                dired-latex-unclean-extensions
                                dired-bibtex-unclean-extensions
                                dired-tex-unclean-extensions
                                (list ".dvi"))))
Richard M. Stallman's avatar
Richard M. Stallman committed
443

Erik Naggum's avatar
Erik Naggum committed
444
;;; JUMP.
Richard M. Stallman's avatar
Richard M. Stallman committed
445

446
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
447 448 449 450 451 452 453 454 455 456 457 458 459 460 461
(defun dired-jump (&optional other-window)
  "Jump to dired buffer corresponding to current buffer.
If in a file, dired the current directory and move to file's line.
If in dired already, pop up a level and goto old directory's line.
In case the proper dired file line cannot be found, refresh the dired
buffer and try again."
  (interactive "P")
  (let* ((file buffer-file-name)
         (dir (if file (file-name-directory file) default-directory)))
    (if (eq major-mode 'dired-mode)
        (progn
          (setq dir (dired-current-directory))
          (dired-up-directory other-window)
          (or (dired-goto-file dir)
              ;; refresh and try again
Karl Heuer's avatar
Karl Heuer committed
462
              (progn
Richard M. Stallman's avatar
Richard M. Stallman committed
463 464 465 466 467 468 469 470
                (dired-insert-subdir (file-name-directory dir))
                (dired-goto-file dir))))
      (if other-window
          (dired-other-window dir)
        (dired dir))
      (if file
          (or (dired-goto-file file)
              ;; refresh and try again
Karl Heuer's avatar
Karl Heuer committed
471
              (progn
Richard M. Stallman's avatar
Richard M. Stallman committed
472
                (dired-insert-subdir (file-name-directory file))
473 474 475 476 477 478
                (dired-goto-file file))
              ;; Toggle omitting, if it is on, and try again.
	      (if dired-omit-files-p
		  (progn
		    (dired-omit-toggle)
		    (dired-goto-file file))))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
479 480 481 482 483 484

(defun dired-jump-other-window ()
  "Like \\[dired-jump] (dired-jump) but in other window."
  (interactive)
  (dired-jump t))

Erik Naggum's avatar
Erik Naggum committed
485
;;; COPY NAMES OF MARKED FILES INTO KILL-RING.
Karl Heuer's avatar
Karl Heuer committed
486

Richard M. Stallman's avatar
Richard M. Stallman committed
487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513
(defun dired-copy-filename-as-kill (&optional arg)
  "Copy names of marked (or next ARG) files into the kill ring.
The names are separated by a space.
With a zero prefix arg, use the complete pathname of each marked file.
With \\[universal-argument], use the relative pathname of each marked file.

If on a subdir headerline, use subdirname instead; prefix arg is ignored
in this case.

You can then feed the file name(s) to other commands with \\[yank]."
  (interactive "P")
  (let ((string
         (or (dired-get-subdir)
             (mapconcat (function identity)
                        (if arg
                            (cond ((zerop (prefix-numeric-value arg))
                                   (dired-get-marked-files))
                                  ((integerp arg)
                                   (dired-get-marked-files 'no-dir arg))
                                  (t    ; else a raw arg
                                   (dired-get-marked-files t)))
                          (dired-get-marked-files 'no-dir))
                        " "))))
    (kill-new string)
    (message "%s" string)))


Erik Naggum's avatar
Erik Naggum committed
514
;;; OMITTING.
Richard M. Stallman's avatar
Richard M. Stallman committed
515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537

;;; Enhanced omitting of lines from directory listings.
;;; Marked files are never omitted.

;; should probably get rid of this and always use 'no-dir.
;; sk 28-Aug-1991 09:37
(defvar dired-omit-localp 'no-dir
  "The LOCALP argument dired-omit-expunge passes to dired-get-filename.
If it is 'no-dir, omitting is much faster, but you can only match
against the basename of the file.  Set it to nil if you need to match the
whole pathname.")

;; \017=^O for Omit - other packages can chose other control characters.
(defvar dired-omit-marker-char ?\017
  "Temporary marker used by by dired-omit.
Should never be used as marker by the user or other packages.")

(defun dired-omit-startup ()
  (or (assq 'dired-omit-files-p minor-mode-alist)
      (setq minor-mode-alist
            (append '((dired-omit-files-p " Omit")) minor-mode-alist))))

(defun dired-omit-toggle (&optional flag)
538
  "Toggle omitting files matching `dired-omit-files' and `dired-omit-extensions'.
Richard M. Stallman's avatar
Richard M. Stallman committed
539 540 541 542 543 544 545 546 547 548 549 550 551 552
With an arg, and if omitting was off, don't toggle and just mark the
  files but don't actually omit them.
With an arg, and if omitting was on, turn it off but don't refresh the buffer."
  (interactive "P")
  (if flag
      (if dired-omit-files-p
          (setq dired-omit-files-p (not dired-omit-files-p))
        (dired-mark-unmarked-files (dired-omit-regexp) nil nil
                                   dired-omit-localp))
    ;; no FLAG
    (setq dired-omit-files-p (not dired-omit-files-p))
    (if (not dired-omit-files-p)
        (revert-buffer)
      ;; this will mention how many were omitted:
553 554
      (let ((dired-omit-size-limit nil))
        (dired-omit-expunge)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
555 556 557 558 559 560

(defvar dired-omit-extensions
  (append completion-ignored-extensions
          dired-latex-unclean-extensions
          dired-bibtex-unclean-extensions
          dired-texinfo-unclean-extensions)
561 562 563 564 565 566 567
  "If non-nil, a list of extensions \(strings\) to omit from Dired listings.  
Defaults to elements of `completion-ignored-extensions',
`dired-latex-unclean-extensions', `dired-bibtex-unclean-extensions', and
`dired-texinfo-unclean-extensions'.  

See interactive function `dired-omit-toggle' \(\\[dired-omit-toggle]\) and
variables `dired-omit-files-p' and `dired-omit-files'.")
Richard M. Stallman's avatar
Richard M. Stallman committed
568 569 570

(defun dired-omit-expunge (&optional regexp)
  "Erases all unmarked files matching REGEXP.
571 572
Does nothing if global variable `dired-omit-files-p' is nil, or if called
  non-interactively and buffer is bigger than `dired-omit-size-limit'.
Richard M. Stallman's avatar
Richard M. Stallman committed
573 574 575 576 577 578 579
If REGEXP is nil or not specified, uses `dired-omit-files', and also omits
  filenames ending in `dired-omit-extensions'.
If REGEXP is the empty string, this function is a no-op.

This functions works by temporarily binding `dired-marker-char' to
`dired-omit-marker-char' and calling `dired-do-kill-lines'."
  (interactive "sOmit files (regexp): ")
580 581 582
  (if (and dired-omit-files-p
           (or (interactive-p)
               (not dired-omit-size-limit)
583 584 585 586 587 588
               (< (buffer-size) dired-omit-size-limit)
	       (progn
		 (message "Not omitting: directory larger than %d characters."
			  dired-omit-size-limit)
		 (setq dired-omit-files-p nil)
		 nil)))
Richard M. Stallman's avatar
Richard M. Stallman committed
589
      (let ((omit-re (or regexp (dired-omit-regexp)))
590
            (old-modified-p (buffer-modified-p))
Richard M. Stallman's avatar
Richard M. Stallman committed
591 592 593 594 595 596 597
            count)
        (or (string= omit-re "")
            (let ((dired-marker-char dired-omit-marker-char))
              (message "Omitting...")
              (if (dired-mark-unmarked-files omit-re nil nil dired-omit-localp)
                  (progn
                    (setq count (dired-do-kill-lines nil "Omitted %d line%s."))
598
                    (force-mode-line-update))
Richard M. Stallman's avatar
Richard M. Stallman committed
599
                (message "(Nothing to omit)"))))
600 601 602 603 604 605
        ;; Try to preserve modified state of buffer.  So `%*' doesn't appear
        ;; in mode-line of omitted buffers.
        (set-buffer-modified-p (and old-modified-p 
                                    (save-excursion
                                      (goto-char (point-min))
                                      (re-search-forward dired-re-mark nil t))))
Richard M. Stallman's avatar
Richard M. Stallman committed
606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635
        count)))

(defun dired-omit-regexp ()
  (concat (if dired-omit-files (concat "\\(" dired-omit-files "\\)") "")
          (if (and dired-omit-files dired-omit-extensions) "\\|" "")
          (if dired-omit-extensions
              (concat ".";; a non-extension part should exist
                      "\\("
                      (mapconcat 'regexp-quote dired-omit-extensions "\\|")
                      "\\)$")
            "")))

;; Returns t if any work was done, nil otherwise.
(defun dired-mark-unmarked-files (regexp msg &optional unflag-p localp)
  "Marks unmarked files matching REGEXP, displaying MSG.
REGEXP is matched against the complete pathname.
Does not re-mark files which already have a mark.
With prefix argument, unflag all those files.
Second optional argument LOCALP is as in `dired-get-filename'."
  (interactive "P")
  (let ((dired-marker-char (if unflag-p ?\  dired-marker-char)))
    (dired-mark-if
     (and
      ;; not already marked
      (looking-at " ")
      ;; uninteresting
      (let ((fn (dired-get-filename localp t)))
        (and fn (string-match regexp fn))))
     msg)))

Karl Heuer's avatar
Karl Heuer committed
636
;;; REDEFINE.
637
(defun dired-omit-new-add-entry (filename &optional marker-char relative)
Richard M. Stallman's avatar
Richard M. Stallman committed
638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655
  ;; This redefines dired-aux.el's dired-add-entry to avoid calling ls for
  ;; files that are going to be omitted anyway.
  (if dired-omit-files-p
      ;; perhaps return t without calling ls
      (let ((omit-re (dired-omit-regexp)))
        (if (or (string= omit-re "")
                (not
                 (string-match omit-re
                               (cond
                                ((eq 'no-dir dired-omit-localp)
                                 filename)
                                ((eq t dired-omit-localp)
                                 (dired-make-relative filename))
                                (t
                                 (dired-make-absolute
                                  filename
                                  (file-name-directory filename)))))))
            ;; if it didn't match, go ahead and add the entry
656
            (dired-omit-old-add-entry filename marker-char relative)
Richard M. Stallman's avatar
Richard M. Stallman committed
657 658 659 660
          ;; dired-add-entry returns t for success, perhaps we should
          ;; return file-exists-p
          t))
    ;; omitting is not turned on at all
661
    (dired-omit-old-add-entry filename marker-char relative)))
Richard M. Stallman's avatar
Richard M. Stallman committed
662

Karl Heuer's avatar
Karl Heuer committed
663
;;; REDEFINE.
Richard M. Stallman's avatar
Richard M. Stallman committed
664 665 666 667 668 669 670 671
;;; Redefine dired-aux.el's version of `dired-add-entry'
;;; Save old defun if not already done:
(or (fboundp 'dired-omit-old-add-entry)
    (fset 'dired-omit-old-add-entry (symbol-function 'dired-add-entry)))
;; Redefine it.
(fset 'dired-add-entry 'dired-omit-new-add-entry)


Erik Naggum's avatar
Erik Naggum committed
672
;;; VIRTUAL DIRED MODE.
Richard M. Stallman's avatar
Richard M. Stallman committed
673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790

;;; For browsing `ls -lR' listings in a dired-like fashion.

(fset 'virtual-dired 'dired-virtual)
(defun dired-virtual (dirname &optional switches)
  "Put this buffer into Virtual Dired mode.

In Virtual Dired mode, all commands that do not actually consult the
filesystem will work.

This is useful if you want to peruse and move around in an ls -lR
output file, for example one you got from an ftp server.  With
ange-ftp, you can even dired a directory containing an ls-lR file,
visit that file and turn on virtual dired mode.  But don't try to save
this file, as dired-virtual indents the listing and thus changes the
buffer.

If you have save a Dired buffer in a file you can use \\[dired-virtual] to
resume it in a later session.

Type \\<dired-mode-map>\\[revert-buffer] in the
Virtual Dired buffer and answer `y' to convert the virtual to a real
dired buffer again.  You don't have to do this, though: you can relist
single subdirs using \\[dired-do-redisplay].
"

  ;; DIRNAME is the top level directory of the buffer.  It will become
  ;; its `default-directory'.  If nil, the old value of
  ;; default-directory is used.

  ;; Optional SWITCHES are the ls switches to use.

  ;; Shell wildcards will be used if there already is a `wildcard'
  ;; line in the buffer (thus it is a saved Dired buffer), but there
  ;; is no other way to get wildcards.  Insert a `wildcard' line by
  ;; hand if you want them.

  (interactive
   (list (read-string "Virtual Dired directory: " (dired-virtual-guess-dir))))
  (goto-char (point-min))
  (or (looking-at "  ")
      ;; if not already indented, do it now:
      (indent-region (point-min) (point-max) 2))
  (or dirname (setq dirname default-directory))
  (setq dirname (expand-file-name (file-name-as-directory dirname)))
  (setq default-directory dirname)      ; contains no wildcards
  (let ((wildcard (save-excursion
                    (goto-char (point-min))
                    (forward-line 1)
                    (and (looking-at "^  wildcard ")
                         (buffer-substring (match-end 0)
                                           (progn (end-of-line) (point)))))))
  (if wildcard
        (setq dirname (expand-file-name wildcard default-directory))))
  ;; If raw ls listing (not a saved old dired buffer), give it a
  ;; decent subdir headerline:
  (goto-char (point-min))
  (or (looking-at dired-subdir-regexp)
      (dired-insert-headerline default-directory))
  (dired-mode dirname (or switches dired-listing-switches))
  (setq mode-name "Virtual Dired"
        revert-buffer-function 'dired-virtual-revert)
  (set (make-local-variable 'dired-subdir-alist) nil)
  (dired-build-subdir-alist)
  (goto-char (point-min))
  (dired-initial-position dirname))

(defun dired-virtual-guess-dir ()

  ;; Guess and return appropriate working directory of this buffer,
  ;; assumed to be in Dired or ls -lR format.
  ;; The guess is based upon buffer contents.
  ;; If nothing could be guessed, returns nil.

  (let ((regexp "^\\(  \\)?\\([^ \n\r]*\\)\\(:\\)[\n\r]")
        (subexpr 2))
    (goto-char (point-min))
    (cond ((looking-at regexp)
           ;; If a saved dired buffer, look to which dir and
           ;; perhaps wildcard it belongs:
           (let ((dir (buffer-substring (match-beginning subexpr)
                                        (match-end subexpr))))
             (file-name-as-directory dir)))
          ;; Else no match for headerline found.  It's a raw ls listing.
          ;; In raw ls listings the directory does not have a headerline
          ;; try parent of first subdir, if any
          ((re-search-forward regexp nil t)
           (file-name-directory
            (directory-file-name
             (file-name-as-directory
              (buffer-substring (match-beginning subexpr)
                                (match-end subexpr))))))
          (t                            ; if all else fails
           nil))))


(defun dired-virtual-revert (&optional arg noconfirm)
  (if (not
       (y-or-n-p "Cannot revert a Virtual Dired buffer - switch to Real Dired mode? "))
      (error "Cannot revert a Virtual Dired buffer.")
    (setq mode-name "Dired"
          revert-buffer-function 'dired-revert)
    (revert-buffer)))

;; A zero-arg version of dired-virtual.
;; You need my modified version of set-auto-mode for the
;; `buffer-contents-mode-alist'.
;; Or you use infer-mode.el and infer-mode-alist, same syntax.
(defun dired-virtual-mode ()
  "Put current buffer into virtual dired mode (see `dired-virtual').
Useful on `buffer-contents-mode-alist' (which see) with the regexp

    \"^  \\(/[^ /]+\\)/?+:$\"

to put saved dired buffers automatically into virtual dired mode.

Also useful for `auto-mode-alist' (which see) like this:

791
  \(setq auto-mode-alist (cons '(\"[^/]\\.dired\\'\" . dired-virtual-mode)
Richard M. Stallman's avatar
Richard M. Stallman committed
792 793 794 795 796
                              auto-mode-alist)\)"
  (interactive)
  (dired-virtual (dired-virtual-guess-dir)))


Erik Naggum's avatar
Erik Naggum committed
797
;;; SMART SHELL.
Richard M. Stallman's avatar
Richard M. Stallman committed
798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825

;;; An Emacs buffer can have but one working directory, stored in the
;;; buffer-local variable `default-directory'.  A Dired buffer may have
;;; several subdirectories inserted, but still has but one working directory:
;;; that of the top level Dired directory in that buffer.  For some commands
;;; it is appropriate that they use the current Dired directory instead of
;;; `default-directory', e.g., `find-file' and `compile'.  This is a general
;;; mechanism is provided for special handling of the working directory in
;;; special major modes.

;; It's easier to add to this alist than redefine function
;; default-directory while keeping the old information.
(defconst default-directory-alist
  '((dired-mode . (if (fboundp 'dired-current-directory)
                      (dired-current-directory)
                    default-directory)))
  "Alist of major modes and their opinion on default-directory, as a
lisp expression to evaluate.  A resulting value of nil is ignored in
favor of default-directory.")

(defun default-directory ()
  "Usage like variable `default-directory', but knows about the special
cases in variable `default-directory-alist' (which see)."
  (or (eval (cdr (assq major-mode default-directory-alist)))
      default-directory))

(defun dired-smart-shell-command (cmd &optional insert)
  "Like function `shell-command', but in the current Tree Dired directory."
826 827 828
  (interactive (list (read-from-minibuffer "Shell command: "
					   nil nil nil 'shell-command-history)
		     current-prefix-arg))
Richard M. Stallman's avatar
Richard M. Stallman committed
829 830 831 832
  (let ((default-directory (default-directory)))
    (shell-command cmd insert)))


Erik Naggum's avatar
Erik Naggum committed
833
;;; LOCAL VARIABLES FOR DIRED BUFFERS.
Richard M. Stallman's avatar
Richard M. Stallman committed
834

Karl Heuer's avatar
Karl Heuer committed
835 836 837 838
;;; Brief Description:
;;;
;;; * `dired-extra-startup' is part of the `dired-mode-hook'.
;;;
Richard M. Stallman's avatar
Richard M. Stallman committed
839
;;; * `dired-extra-startup' calls `dired-hack-local-variables'
Karl Heuer's avatar
Karl Heuer committed
840
;;;
Richard M. Stallman's avatar
Richard M. Stallman committed
841
;;; * `dired-hack-local-variables' checks the value of
Karl Heuer's avatar
Karl Heuer committed
842 843
;;;   `dired-local-variables-file'
;;;
Richard M. Stallman's avatar
Richard M. Stallman committed
844 845
;;; * Check if `dired-local-variables-file' is a non-nil string and is a
;;;   filename found in the directory of the Dired Buffer being created.
Karl Heuer's avatar
Karl Heuer committed
846
;;;
Richard M. Stallman's avatar
Richard M. Stallman committed
847 848
;;; * If `dired-local-variables-file' satisfies the above, then temporarily
;;;   include it in the Dired Buffer at the bottom.
Karl Heuer's avatar
Karl Heuer committed
849
;;;
Richard M. Stallman's avatar
Richard M. Stallman committed
850 851 852 853
;;; * Set `enable-local-variables' temporarily to the user variable
;;;   `dired-enable-local-variables' and run `hack-local-variables' on the
;;;   Dired Buffer.

854
(defvar dired-local-variables-file (convert-standard-filename ".dired")
Richard M. Stallman's avatar
Richard M. Stallman committed
855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880
  "Filename, as string, containing local dired buffer variables to be hacked.
If this file found in current directory, then it will be inserted into dired
buffer and `hack-local-variables' will be run.  See Emacs Info pages for more
information on local variables.  See also `dired-enable-local-variables'.")

(defun dired-hack-local-variables ()
  "Evaluate local variables in `dired-local-variables-file' for dired buffer."
  (if (and dired-local-variables-file
           (stringp dired-local-variables-file)
           (file-exists-p dired-local-variables-file))
      (let ((opoint (point-max))
            buffer-read-only
            ;; In case user has `enable-local-variables' set to nil we
            ;; override it locally with dired's variable.
            (enable-local-variables dired-enable-local-variables))
        ;; Insert 'em.
        (save-excursion
          (goto-char opoint)
          (insert "\^L\n")
          (insert-file-contents dired-local-variables-file))
        ;; Hack 'em.
        (let ((buffer-file-name dired-local-variables-file))
          (hack-local-variables))
        ;; Make sure that the modeline shows the proper information.
        (dired-sort-set-modeline)
        ;; Delete this stuff: `eobp' is used to find last subdir by dired.el.
Karl Heuer's avatar
Karl Heuer committed
881
        (delete-region opoint (point-max)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
882

Karl Heuer's avatar
Karl Heuer committed
883
(defun dired-omit-here-always ()
Richard M. Stallman's avatar
Richard M. Stallman committed
884 885 886
  "Creates `dired-local-variables-file' for omitting and reverts directory.
Sets dired-omit-file-p to t in a local variables file that is readable by
dired."
Karl Heuer's avatar
Karl Heuer committed
887
  (interactive)
Richard M. Stallman's avatar
Richard M. Stallman committed
888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903
  (if (file-exists-p dired-local-variables-file)
      (message "File `./%s' already exists." dired-local-variables-file)

    ;; Create `dired-local-variables-file'.
    (save-excursion
      (set-buffer (get-buffer-create " *dot-dired*"))
      (erase-buffer)
      (insert "Local Variables:\ndired-omit-files-p: t\nEnd:\n")
      (write-file dired-local-variables-file)
      (kill-buffer (current-buffer)))

    ;; Run extra-hooks and revert directory.
    (dired-extra-startup)
    (dired-revert)))


Erik Naggum's avatar
Erik Naggum committed
904
;;; GUESS SHELL COMMAND.
Richard M. Stallman's avatar
Richard M. Stallman committed
905

Karl Heuer's avatar
Karl Heuer committed
906 907 908 909
;;; Brief Description:
;;;
;;; `dired-do-shell-command' is bound to `!' by dired.el.
;;;
Richard M. Stallman's avatar
Richard M. Stallman committed
910 911
;;; * Redefine `dired-do-shell-command' so it calls
;;;   `dired-guess-shell-command'.
Karl Heuer's avatar
Karl Heuer committed
912
;;;
Richard M. Stallman's avatar
Richard M. Stallman committed
913 914
;;; * `dired-guess-shell-command' calls `dired-guess-default' with list of
;;;    marked files.
Karl Heuer's avatar
Karl Heuer committed
915
;;;
Richard M. Stallman's avatar
Richard M. Stallman committed
916 917 918
;;; * Parse `dired-guess-shell-alist-user' and
;;;   `dired-guess-shell-alist-default' (in that order) for the first REGEXP
;;;   that matches the first file in the file list.
Karl Heuer's avatar
Karl Heuer committed
919
;;;
Richard M. Stallman's avatar
Richard M. Stallman committed
920
;;; * If the REGEXP matches all the entries of the file list then evaluate
Richard M. Stallman's avatar
Richard M. Stallman committed
921
;;;   COMMAND, which is either a string or a Lisp expression returning a
Richard M. Stallman's avatar
Richard M. Stallman committed
922
;;;   string.  COMMAND may be a list of commands.
Karl Heuer's avatar
Karl Heuer committed
923
;;;
Richard M. Stallman's avatar
Richard M. Stallman committed
924
;;; * Return this command to `dired-guess-shell-command' which prompts user
Karl Heuer's avatar
Karl Heuer committed
925
;;;   with it.  The list of commands is temporarily put into the history list.
Richard M. Stallman's avatar
Richard M. Stallman committed
926 927 928 929 930 931 932
;;;   If a command is used successfully then it is stored permanently in
;;;   `dired-shell-command-history'.

;;; Guess what shell command to apply to a file.
(defvar dired-shell-command-history nil
  "History list for commands that read dired-shell commands.")

Karl Heuer's avatar
Karl Heuer committed
933
;;; Default list of shell commands.
Richard M. Stallman's avatar
Richard M. Stallman committed
934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955

;;; NOTE: Use `gunzip -c' instead of `zcat' on `.gz' files.  Some do not
;;; install GNU zip's version of zcat.

(defvar dired-guess-shell-alist-default
  (list
   (list "\\.tar$" '(if dired-guess-shell-gnutar
                        (concat dired-guess-shell-gnutar " xvf")
                      "tar xvf"))

   ;; REGEXPS for compressed archives must come before the .Z rule to
   ;; be recognized:
   (list "\\.tar\\.Z$"
         ;; Untar it.
         '(if dired-guess-shell-gnutar
              (concat dired-guess-shell-gnutar " zxvf")
            (concat "zcat * | tar xvf -"))
         ;; Optional conversion to gzip format.
         '(concat "znew" (if dired-guess-shell-gzip-quiet " -q")
                  " " dired-guess-shell-znew-switches))

   ;; gzip'ed archives
956
   (list "\\.t\\(ar\\.\\)?gz$"
Richard M. Stallman's avatar
Richard M. Stallman committed
957 958 959 960 961
         '(if dired-guess-shell-gnutar
              (concat dired-guess-shell-gnutar " zxvf")
            (concat "gunzip -qc * | tar xvf -"))
         ;; Optional decompression.
         '(concat "gunzip" (if dired-guess-shell-gzip-quiet " -q" "")))
962 963 964 965 966
   ;; bzip2'ed archives
   (list "\\.tar\\.bz2$"
	 "bunzip2 -c * | tar xvf -"
	 ;; Optional decompression.
         "bunzip2")
Richard M. Stallman's avatar
Richard M. Stallman committed
967 968 969 970

   '("\\.shar.Z$" "zcat * | unshar")
   '("\\.shar.g?z$" "gunzip -qc * | unshar")

971
   '("\\.e?ps$" "ghostview" "xloadimage" "lpr")
972
   (list "\\.e?ps.g?z$" "gunzip -qc * | ghostview -"
Richard M. Stallman's avatar
Richard M. Stallman committed
973 974
         ;; Optional decompression.
         '(concat "gunzip" (if dired-guess-shell-gzip-quiet " -q")))
975
   (list "\\.e?ps.Z$" "zcat * | ghostview -"
Richard M. Stallman's avatar
Richard M. Stallman committed
976 977 978 979 980 981 982 983 984 985 986
         ;; Optional conversion to gzip format.
         '(concat "znew" (if dired-guess-shell-gzip-quiet " -q")
                  " " dired-guess-shell-znew-switches))
   '("\\.patch$" "cat * | patch")
   '("\\.patch.g?z$" "gunzip -qc * | patch")
   (list "\\.patch.Z$" "zcat * | patch"
         ;; Optional conversion to gzip format.
         '(concat "znew" (if dired-guess-shell-gzip-quiet " -q")
                  " " dired-guess-shell-znew-switches))

   '("\\.dvi$" "xdvi" "dvips")          ; preview and printing
Karl Heuer's avatar
Karl Heuer committed
987
   '("\\.au$" "play")                   ; play Sun audiofiles
Richard M. Stallman's avatar
Richard M. Stallman committed
988 989 990 991 992 993
   '("\\.mpg$" "mpeg_play")
   '("\\.uu$" "uudecode")               ; for uudecoded files
   '("\\.hqx$" "mcvert")
   '("\\.sh$" "sh")                     ; execute shell scripts
   '("\\.xbm$" "bitmap")                ; view X11 bitmaps
   '("\\.gp$" "gnuplot")
994 995 996 997 998
   '("\\.p[bgpn]m$" "xloadimage")
   '("\\.gif$" "xloadimage")                    ; view gif pictures
   '("\\.tif$" "xloadimage")
   '("\\.png$" "xloadimage")
   '("\\.jpg$" "xloadimage")
Richard M. Stallman's avatar
Richard M. Stallman committed
999 1000 1001 1002
   '("\\.fig$" "xfig")                  ; edit fig pictures
   '("\\.out$" "xgraph")                ; for plotting purposes.
   '("\\.tex$" "latex" "tex")
   '("\\.texi\\(nfo\\)?$" "makeinfo" "texi2dvi")
1003
   '("\\.pdf$" "xpdf")              ; edit PDF files
Richard M. Stallman's avatar
Richard M. Stallman committed
1004 1005 1006 1007 1008 1009 1010 1011 1012 1013

   ;; Some other popular archivers.
   '("\\.zoo$" "zoo x//")
   '("\\.zip$" "unzip")
   '("\\.lzh$" "lharc x")
   '("\\.arc$" "arc x")
   '("\\.shar$" "unshar")

   ;; Compression.
   (list "\\.g?z$" '(concat "gunzip" (if dired-guess-shell-gzip-quiet " -q")))
1014
   (list "\\.bz2$" "bunzip2")
Richard M. Stallman's avatar
Richard M. Stallman committed
1015 1016 1017 1018 1019
   (list "\\.Z$" "uncompress"
         ;; Optional conversion to gzip format.
         '(concat "znew" (if dired-guess-shell-gzip-quiet " -q")
                  " " dired-guess-shell-znew-switches))
   )
Karl Heuer's avatar
Karl Heuer committed
1020

Richard M. Stallman's avatar
Richard M. Stallman committed
1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051
  "Default alist used for shell command guessing.
See `dired-guess-shell-alist-user'")

(defvar dired-guess-shell-alist-user nil
  "User-defined alist of rules for suggested commands. These rules take
precedence over the predefined rules in the variable
`dired-guess-shell-alist-default' (to which they are prepended).

Each element of this list looks like

    \(REGEXP COMMAND...\)

where each COMMAND can either be a string or a lisp expression that evaluates
to a string.  If several COMMANDs are given, the first one will be the default
and the rest will be added temporarily to the history and can be retrieved
with \\[previous-history-element] (M-p) .

You can set this variable in your ~/.emacs.  For example, to add rules for
`.foo' and `.bar' files, write

 \(setq dired-guess-shell-alist-user
       (list (list \"\\\\.foo$\" \"FOO-COMMAND\");; fixed rule
              ;; possibly more rules ...
              (list \"\\\\.bar$\";; rule with condition test
                    '(if condition
                          \"BAR-COMMAND-1\"
                        \"BAR-COMMAND-2\")))\)
")

(defun dired-guess-default (files)

Karl Heuer's avatar
Karl Heuer committed
1052 1053
  ;; Guess a shell commands for FILES.  Return command or list of commands.
  ;; See `dired-guess-shell-alist-user'.
Richard M. Stallman's avatar
Richard M. Stallman committed
1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075

  (let* ((case-fold-search nil) ; case-sensitive matching
         ;; Prepend the user's alist to the default alist.
         (alist (append dired-guess-shell-alist-user
                        dired-guess-shell-alist-default))
         (file (car files))
         (flist (cdr files))
         elt regexp cmds)

    ;; Find the first match in the alist for first file in FILES.
    (while alist
      (setq elt (car alist)
            regexp (car elt)
            alist (cdr alist))
      (if (string-match regexp file)
          (setq cmds (cdr elt)
                alist nil)))

    ;; If more than one file, see if all of FILES match regular expression.
    (while (and flist
                (string-match regexp (car flist)))
      (setq flist (cdr flist)))
Karl Heuer's avatar
Karl Heuer committed
1076

Richard M. Stallman's avatar
Richard M. Stallman committed
1077 1078 1079 1080
    ;; If flist is still non-nil, then do not guess since this means that not
    ;; all the files in FILES were matched by the regexp.
    (setq cmds (and (not flist) cmds))

Karl Heuer's avatar
Karl Heuer committed
1081 1082
    ;; Return commands or nil if flist is still non-nil.
    ;; Evaluate the commands in order that any logical testing will be done.
Richard M. Stallman's avatar
Richard M. Stallman committed
1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141
    (cond ((not (cdr cmds))
           (eval (car cmds))) ; single command
          (t
           (mapcar (function eval) cmds)))))

(defun dired-guess-shell-command (prompt files)

  ;; Ask user with PROMPT for a shell command, guessing a default from FILES.

  (let ((default (dired-guess-default files))
        default-list old-history val (failed t))

    (if (null default)
        ;; Nothing to guess
        (read-from-minibuffer prompt nil nil nil 'dired-shell-command-history)

      ;; Save current history list
      (setq old-history dired-shell-command-history)

      (if (listp default)

          ;; More than one guess
          (setq default-list default
                default (car default)
                prompt (concat
                        prompt
                        (format "{%d guesses} " (length default-list))))

        ;; Just one guess
        (setq default-list (list default)))

      ;; Push all guesses onto history so that they can be retrieved with M-p
      ;; and put the first guess in the prompt but not in the initial value.
      (setq dired-shell-command-history
            (append default-list dired-shell-command-history)
            prompt (concat prompt (format "[%s] " default)))

      ;; The unwind-protect returns VAL, and we too.
      (unwind-protect
          ;; BODYFORM
          (progn
            (setq val (read-from-minibuffer prompt nil nil nil
                                            'dired-shell-command-history)
                  failed nil)
            ;; If we got a return, then use default.
            (if (equal val "")
                (setq val default))
            val)

        ;; UNWINDFORMS
        ;; Undo pushing onto the history list so that an aborted
        ;; command doesn't get the default in the next command.
        (setq dired-shell-command-history old-history)
        (if (not failed)
            (or (equal val (car-safe dired-shell-command-history))
                (setq dired-shell-command-history
                      (cons val dired-shell-command-history))))))))


Karl Heuer's avatar
Karl Heuer committed
1142
;;; REDEFINE.
Richard M. Stallman's avatar
Richard M. Stallman committed
1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155
;;; Redefine dired-aux.el's version:
(defun dired-read-shell-command (prompt arg files)
;;  "Read a dired shell command prompting with PROMPT (using read-string).
;;ARG is the prefix arg and may be used to indicate in the prompt which
;;  files are affected.
;;This is an extra function so that you can redefine it, e.g., to use gmhist."
  (dired-mark-pop-up
   nil 'shell files
   'dired-guess-shell-command
   (format prompt (dired-mark-prompt arg files)) ; PROMPT
   files))                                       ; FILES


Erik Naggum's avatar
Erik Naggum committed
1156
;;; RELATIVE SYMBOLIC LINKS.
Richard M. Stallman's avatar
Richard M. Stallman committed
1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186

(defvar dired-keep-marker-relsymlink ?S
  "See variable `dired-keep-marker-move'.")

(defun dired-make-relative-symlink (file1 file2 &optional ok-if-already-exists)
  "Three arguments: FILE1 FILE2 &optional OK-IF-ALREADY-EXISTS
Make a symbolic link (pointing to FILE1) in FILE2.
The link is relative (if possible), for example

    \"/vol/tex/bin/foo\" \"/vol/local/bin/foo\"

results in

    \"../../tex/bin/foo\" \"/vol/local/bin/foo\"
"
  (interactive "FRelSymLink: \nFRelSymLink %s: \np")
  (let (name1 name2 len1 len2 (index 0) sub)
    (setq file1 (expand-file-name file1)
          file2 (expand-file-name file2)
          len1 (length file1)
          len2 (length file2))
    ;; Find common initial pathname components:
    (let (next)
      (while (and (setq next (string-match "/" file1 index))
                  (setq next (1+ next))
                  (< next (min len1 len2))
                  ;; For the comparison, both substrings must end in
                  ;; `/', so NEXT is *one plus* the result of the
                  ;; string-match.
                  ;; E.g., consider the case of linking "/tmp/a/abc"
Karl Heuer's avatar
Karl Heuer committed
1187
                  ;; to "/tmp/abc" erroneously giving "/tmp/a" instead
Richard M. Stallman's avatar
Richard M. Stallman committed
1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238
                  ;; of "/tmp/" as common initial component
                  (string-equal (substring file1 0 next)
                                (substring file2 0 next)))
        (setq index next))
      (setq name2 file2
            sub (substring file1 0 index)
            name1 (substring file1 index)))
    (if (string-equal sub "/")
        ;; No common initial pathname found
        (setq name1 file1)
      ;; Else they have a common parent directory
      (let ((tem (substring file2 index))
            (start 0)
            (count 0))
        ;; Count number of slashes we must compensate for ...
        (while (setq start (string-match "/" tem start))
          (setq count (1+ count)
                start (1+ start)))
        ;; ... and prepend a "../" for each slash found:
        (while (> count 0)
          (setq count (1- count)
                name1 (concat "../" name1)))))
    (make-symbolic-link
     (directory-file-name name1)        ; must not link to foo/
                                        ; (trailing slash!)
     name2 ok-if-already-exists)))

(defun dired-do-relsymlink (&optional arg)
   "Relative symlink all marked (or next ARG) files into a directory,
or make a relative symbolic link to the current file.
This creates relative symbolic links like

    foo -> ../bar/foo

not absolute ones like

    foo -> /ugly/path/that/may/change/any/day/bar/foo"
  (interactive "P")
  (dired-do-create-files 'relsymlink (function dired-make-relative-symlink)
                           "RelSymLink" arg dired-keep-marker-relsymlink))

(defun dired-do-relsymlink-regexp (regexp newname &optional whole-path)
  "RelSymlink all marked files containing REGEXP to NEWNAME.
See functions `dired-do-rename-regexp' and `dired-do-relsymlink'
for more info."
  (interactive (dired-mark-read-regexp "RelSymLink"))
  (dired-do-create-files-regexp
   (function dired-make-relative-symlink)
   "RelSymLink" nil regexp newname whole-path dired-keep-marker-relsymlink))


Erik Naggum's avatar
Erik Naggum committed
1239
;;; VISIT ALL MARKED FILES SIMULTANEOUSLY.
Richard M. Stallman's avatar
Richard M. Stallman committed
1240

Karl Heuer's avatar
Karl Heuer committed
1241 1242 1243 1244
;;; Brief Description:
;;;
;;; `dired-do-find-marked-files' is bound to `F' by dired-x.el.
;;;
Richard M. Stallman's avatar
Richard M. Stallman committed
1245
;;; * Use `dired-get-marked-files' to collect the marked files in the current
Karl Heuer's avatar
Karl Heuer committed
1246 1247
;;;   Dired Buffer into a list of filenames `FILE-LIST'.
;;;
Richard M. Stallman's avatar
Richard M. Stallman committed
1248 1249
;;; * Pass FILE-LIST to `dired-simultaneous-find-file' all with
;;;   `dired-do-find-marked-files''s prefix argument NOSELECT.
Karl Heuer's avatar
Karl Heuer committed
1250
;;;
Richard M. Stallman's avatar
Richard M. Stallman committed
1251 1252
;;; * `dired-simultaneous-find-file' runs through FILE-LIST decrementing the
;;;   list each time.
Karl Heuer's avatar
Karl Heuer committed
1253
;;;
Richard M. Stallman's avatar
Richard M. Stallman committed
1254 1255
;;; * If NOSELECT is non-nil then just run `find-file-noselect'  on each
;;;   element of FILE-LIST.
Karl Heuer's avatar
Karl Heuer committed
1256
;;;
Richard M. Stallman's avatar
Richard M. Stallman committed
1257 1258 1259
;;; * If NOSELECT is nil then calculate the `size' of the window for each file
;;;   by dividing the `window-height' by length of FILE-LIST.  Thus, `size' is
;;;   cognizant of the window-configuration.
Karl Heuer's avatar
Karl Heuer committed
1260
;;;
Richard M. Stallman's avatar
Richard M. Stallman committed
1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272
;;; * If `size' is too small abort, otherwise run `find-file' on each element
;;;   of FILE-LIST giving each a window of height `size'.

(defun dired-do-find-marked-files (&optional noselect)
  "Find all marked files displaying all of them simultaneously.
With optional NOSELECT just find files but do not select them.

The current window is split across all files marked, as evenly as possible.
Remaining lines go to bottom-most window.  The number of files that can be
displayed this way is restricted by the height of the current window and
`window-min-height'.

Karl Heuer's avatar
Karl Heuer committed
1273
To keep dired buffer displayed, type \\[split-window-vertically] first.
Richard M. Stallman's avatar
Richard M. Stallman committed
1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286
To display just marked files, type \\[delete-other-windows] first."

  (interactive "P")
  (dired-simultaneous-find-file (dired-get-marked-files) noselect))

(defun dired-simultaneous-find-file (file-list noselect)

  ;; Visit all files in FILE-LIST and display them simultaneously.  The
  ;; current window is split across all files in FILE-LIST, as evenly as
  ;; possible.  Remaining lines go to the bottom-most window.  The number of
  ;; files that can be displayed this way is restricted by the height of the
  ;; current window and the variable `window-min-height'.  With non-nil
  ;; NOSELECT the files are merely found but not selected.
Karl Heuer's avatar
Karl Heuer committed
1287

Richard M. Stallman's avatar
Richard M. Stallman committed
1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320
  ;; We don't make this function interactive because it is usually too clumsy
  ;; to specify FILE-LIST interactively unless via dired.

  (let (size)

    (if noselect
        ;; Do not select the buffer.
        (find-file-noselect (car file-list))

      ;; We will have to select the buffer.  Calculate and check window size.
      (setq size (/ (window-height) (length file-list)))
      (or (<= window-min-height size)
          (error "Too many files to visit simultaneously.  Try C-u prefix."))
      (find-file (car file-list)))

    ;; Decrement.
    (setq file-list (cdr file-list))

    (while file-list

      (if noselect
          ;; Do not select the buffer.
          (find-file-noselect (car file-list))

        ;; Vertically split off a window of desired size.  Upper window will
        ;; have SIZE lines.  Select lower (larger) window.  We split it again.
        (select-window (split-window nil size))
        (find-file (car file-list)))

      ;; Decrement.
      (setq file-list (cdr file-list)))))


Erik Naggum's avatar
Erik Naggum committed
1321
;;; MISCELLANEOUS COMMANDS.
Richard M. Stallman's avatar
Richard M. Stallman committed
1322

Karl Heuer's avatar
Karl Heuer committed
1323 1324
;;; Run man on files.

Richard M. Stallman's avatar
Richard M. Stallman committed
1325
(defun dired-man ()
Karl Heuer's avatar
Karl Heuer committed
1326
  "Run man on this file.  Display old buffer if buffer name matches filename.
1327
Uses ../lisp/man.el of \\[manual-entry] fame."
Richard M. Stallman's avatar
Richard M. Stallman committed
1328
  (interactive)
1329 1330
  (require 'man)
  (let ((file (dired-get-filename))
1331
        (manual-program "nroff -man -h"))
1332
    (Man-getpage-in-background file)))
Richard M. Stallman's avatar
Richard M. Stallman committed
1333 1334 1335 1336 1337 1338 1339 1340 1341 1342

;;; Run Info on files.

(defun dired-info ()
  "Run info on this file."
  (interactive)
  (info (dired-get-filename)))

;;; Run mail on mail folders.

Karl Heuer's avatar
Karl Heuer committed
1343 1344 1345 1346
;;; (and (not (fboundp 'vm-visit-folder))
;;;      (defun vm-visit-folder (file &optional arg)
;;;        nil))

Richard M. Stallman's avatar
Richard M. Stallman committed
1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376
(defun dired-vm (&optional read-only)
  "Run VM on this file.
With prefix arg, visit folder read-only (this requires at least VM 5).
See also variable `dired-vm-read-only-folders'."
  (interactive "P")
  (let ((dir (dired-current-directory))
        (fil (dired-get-filename)))
    ;; take care to supply 2nd arg only if requested - may still run VM 4!
    (cond (read-only (vm-visit-folder fil t))
          ((eq t dired-vm-read-only-folders) (vm-visit-folder fil t))
          ((null dired-vm-read-only-folders) (vm-visit-folder fil))
          (t (vm-visit-folder fil (not (file-writable-p fil)))))
    ;; so that pressing `v' inside VM does prompt within current directory:
    (set (make-local-variable 'vm-folder-directory) dir)))

(defun dired-rmail ()
  "Run RMAIL on this file."
  (interactive)
  (rmail (dired-get-filename)))

(defun dired-do-run-mail ()
  "If `dired-bind-vm' is t, then function `dired-vm', otherwise `dired-rmail'."
  (interactive)
  (if dired-bind-vm
      ;; Read mail folder using vm.
      (dired-vm)
    ;; Read mail folder using rmail.
    (dired-rmail)))


Erik Naggum's avatar
Erik Naggum committed
1377
;;; MISCELLANEOUS INTERNAL FUNCTIONS.
Richard M. Stallman's avatar
Richard M. Stallman committed
1378 1379 1380 1381 1382

(or (fboundp 'dired-old-find-buffer-nocreate)
    (fset 'dired-old-find-buffer-nocreate
          (symbol-function 'dired-find-buffer-nocreate)))

Karl Heuer's avatar
Karl Heuer committed
1383
;;; REDEFINE.
Richard M. Stallman's avatar
Richard M. Stallman committed
1384
;;; Redefines dired.el's version of `dired-find-buffer-nocreate'
1385
(defun dired-find-buffer-nocreate (dirname &optional mode)
1386 1387 1388
  (if (and dired-find-subdir
	   ;; don't try to find a wildcard as a subdirectory
	   (string-equal dirname (file-name-directory dirname)))
Richard M. Stallman's avatar
Richard M. Stallman committed
1389
      (let* ((cur-buf (current-buffer))
1390
	     (buffers (nreverse
1391
		       (dired-buffers-for-dir (expand-file-name dirname))))
1392 1393 1394 1395 1396 1397 1398 1399
	     (cur-buf-matches (and (memq cur-buf buffers)
				   ;; wildcards must match, too:
				   (equal dired-directory dirname))))
	;; We don't want to switch to the same buffer---
	(setq buffers (delq cur-buf buffers));;need setq with delq
	(or (car (sort buffers (function dired-buffer-more-recently-used-p)))
	    ;; ---unless it's the only possibility:
	    (and cur-buf-matches cur-buf)))
1400
    (dired-old-find-buffer-nocreate dirname mode)))
Richard M. Stallman's avatar
Richard M. Stallman committed
1401 1402 1403 1404 1405 1406 1407 1408