dired.el 123 KB
Newer Older
1
;;; dired.el --- directory-browsing commands
2

Kim F. Storm's avatar
Kim F. Storm committed
3
;; Copyright (C) 1985, 86, 92, 93, 94, 95, 96, 1997, 2000, 2001, 2003
4
;;  Free Software Foundation, Inc.
5

6 7
;; Author: Sebastian Kremer <sk@thp.uni-koeln.de>
;; Maintainer: FSF
Gerd Moellmann's avatar
Gerd Moellmann committed
8
;; Keywords: files
Eric S. Raymond's avatar
Eric S. Raymond committed
9 10 11 12 13

;; 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
14
;; the Free Software Foundation; either version 2, or (at your option)
Eric S. Raymond's avatar
Eric S. Raymond committed
15 16 17 18 19 20 21 22
;; 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
23 24 25
;; 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.
Eric S. Raymond's avatar
Eric S. Raymond committed
26

27 28
;;; Commentary:

29 30 31
;; This is a major mode for directory browsing and editing.  It is
;; documented in the Emacs manual.

32 33 34 35
;; Rewritten in 1990/1991 to add tree features, file marking and
;; sorting by Sebastian Kremer <sk@thp.uni-koeln.de>.
;; Finished up by rms in 1992.

36
;;; Code:
37 38 39

;;; Customizable variables

40 41
(defgroup dired nil
  "Directory editing."
42
  :group 'files)
43 44

(defgroup dired-mark nil
Richard M. Stallman's avatar
Richard M. Stallman committed
45
  "Handling marks in Dired."
46 47 48 49
  :prefix "dired-"
  :group 'dired)


Eric S. Raymond's avatar
Eric S. Raymond committed
50
;;;###autoload
51
(defcustom dired-listing-switches "-al"
52 53
  "*Switches passed to `ls' for dired.  MUST contain the `l' option.
May contain all other options that don't contradict `-l';
54
may contain even `F', `b', `i' and `s'.  See also the variable
55 56 57 58
`dired-ls-F-marks-symlinks' concerning the `F' switch.
On systems such as MS-DOS and MS-Windows, which use `ls' emulation in Lisp,
some of the `ls' switches are not supported; see the doc string of
`insert-directory' on ls-lisp.el for more details."
59 60
  :type 'string
  :group 'dired)
Eric S. Raymond's avatar
Eric S. Raymond committed
61

Kim F. Storm's avatar
Kim F. Storm committed
62
; Don't use absolute file names as /bin should be in any PATH and people
63 64 65 66
; may prefer /usr/local/gnu/bin or whatever.  However, chown is
; usually not in PATH.

;;;###autoload
Eric S. Raymond's avatar
Eric S. Raymond committed
67
(defvar dired-chown-program
Juanma Barranquero's avatar
Juanma Barranquero committed
68
  (if (memq system-type '(hpux dgux usg-unix-v irix linux gnu/linux cygwin))
69 70 71 72
      "chown"
    (if (file-exists-p "/usr/sbin/chown")
	"/usr/sbin/chown"
      "/etc/chown"))
73
  "Name of chown command (usually `chown' or `/etc/chown').")
74

75 76 77
(defvar dired-use-ls-dired (not (not (string-match "gnu" system-configuration)))
  "Non-nil means Dired should use `ls --dired'.")

78 79
(defvar dired-chmod-program "chmod"
  "Name of chmod command (usually `chmod').")
Karl Heuer's avatar
Karl Heuer committed
80

81
;;;###autoload
82
(defcustom dired-ls-F-marks-symlinks nil
83
  "*Informs dired about how `ls -lF' marks symbolic links.
84 85
Set this to t if `ls' (or whatever program is specified by
`insert-directory-program') with `-lF' marks the symbolic link
86
itself with a trailing @ (usually the case under Ultrix).
Eric S. Raymond's avatar
Eric S. Raymond committed
87

88 89 90 91 92 93
Example: if `ln -s foo bar; ls -F bar' gives `bar -> foo', set it to
nil (the default), if it gives `bar@ -> foo', set it to t.

Dired checks if there is really a @ appended.  Thus, if you have a
marking `ls' program on one host and a non-marking on another host, and
don't care about symbolic links which really end in a @, you can
94 95 96
always set this variable to t."
  :type 'boolean
  :group 'dired-mark)
97 98

;;;###autoload
99
(defcustom dired-trivial-filenames "^\\.\\.?$\\|^#"
100 101
  "*Regexp of files to skip when finding first file of a directory.
A value of nil means move to the subdir line.
102 103 104 105 106
A value of t means move to first file."
  :type '(choice (const :tag "Move to subdir" nil)
		 (const :tag "Move to first" t)
		 regexp)
  :group 'dired)
107 108

;;;###autoload
109
(defcustom dired-keep-marker-rename t
110 111 112 113
  ;; Use t as default so that moved files "take their markers with them".
  "*Controls marking of renamed files.
If t, files keep their previous marks when they are renamed.
If a character, renamed files (whether previously marked or not)
114 115 116 117
are afterward marked with that character."
  :type '(choice (const :tag "Keep" t)
		 (character :tag "Mark"))
  :group 'dired-mark)
118 119

;;;###autoload
120
(defcustom dired-keep-marker-copy ?C
121 122
  "*Controls marking of copied files.
If t, copied files are marked if and as the corresponding original files were.
123 124 125 126
If a character, copied files are unconditionally marked with that character."
  :type '(choice (const :tag "Keep" t)
		 (character :tag "Mark"))
  :group 'dired-mark)
127 128

;;;###autoload
129
(defcustom dired-keep-marker-hardlink ?H
130 131
  "*Controls marking of newly made hard links.
If t, they are marked if and as the files linked to were marked.
132 133 134 135
If a character, new links are unconditionally marked with that character."
  :type '(choice (const :tag "Keep" t)
		 (character :tag "Mark"))
  :group 'dired-mark)
136 137

;;;###autoload
138
(defcustom dired-keep-marker-symlink ?Y
139 140
  "*Controls marking of newly made symbolic links.
If t, they are marked if and as the files linked to were marked.
141 142 143 144
If a character, new links are unconditionally marked with that character."
  :type '(choice (const :tag "Keep" t)
		 (character :tag "Mark"))
  :group 'dired-mark)
145 146

;;;###autoload
147
(defcustom dired-dwim-target nil
148 149 150 151
  "*If non-nil, dired tries to guess a default target directory.
This means: if there is a dired buffer displayed in the next window,
use its current subdir, instead of the current subdir of this dired buffer.

152 153 154
The target is used in the prompt for file copy, rename etc."
  :type 'boolean
  :group 'dired)
155 156

;;;###autoload
157
(defcustom dired-copy-preserve-time t
158
  "*If non-nil, Dired preserves the last-modified time in a file copy.
159 160 161
\(This works on only some systems.)"
  :type 'boolean
  :group 'dired)
162

163 164 165 166 167
; These variables were deleted and the replacements are on files.el.
; We leave aliases behind for back-compatibility.
(defvaralias 'dired-free-space-program 'directory-free-space-program)
(defvaralias 'dired-free-space-args 'directory-free-space-args)

168 169
;;; Hook variables

170
(defcustom dired-load-hook nil
171
  "Run after loading dired.
172 173 174
You can customize key bindings or load extensions with this."
  :group 'dired
  :type 'hook)
175

176 177 178 179
(defcustom dired-mode-hook nil
  "Run at the very end of dired-mode."
  :group 'dired
  :type 'hook)
180

181 182 183 184
(defcustom dired-before-readin-hook nil
  "This hook is run before a dired buffer is read in (created or reverted)."
  :group 'dired
  :type 'hook)
185

186
(defcustom dired-after-readin-hook nil
187 188
  "Hook run after each time a file or directory is read by Dired.
After each listing of a file or directory, this hook is run
189 190 191
with the buffer narrowed to the listing."
  :group 'dired
  :type 'hook)
192 193 194
;; Note this can't simply be run inside function `dired-ls' as the hook
;; functions probably depend on the dired-subdir-alist to be OK.

195 196 197 198 199 200 201 202 203 204 205 206 207 208
(defcustom dired-view-command-alist
  '(("[.]\\(ps\\|ps_pages\\|eps\\)\\'" . "gv -spartan -color -watch %s")
    ("[.]pdf\\'" . "xpdf %s")
    ("[.]\\(jpe?g\\|gif\\|png\\)\\'" . "eog %s")
    ("[.]dvi\\'" . "xdvi -sidemargin 0.5 -topmargin 1 %s"))
  "Alist specifying how to view special types of files.
Each element has the form (REGEXP . SHELL-COMMAND).
When the file name matches REGEXP, `dired-view-file'
invokes SHELL-COMMAND to view the file, processing it through `format'.
Use `%s' in SHELL-COMMAND to specify where to put the file name."
  :group 'dired
  :type '(alist :key-type regexp :value-type string)
  :version "21.4")

209
;; Internal variables
210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226

(defvar dired-marker-char ?*		; the answer is 42
  ;; so that you can write things like
  ;; (let ((dired-marker-char ?X))
  ;;    ;; great code using X markers ...
  ;;    )
  ;; For example, commands operating on two sets of files, A and B.
  ;; Or marking files with digits 0-9.  This could implicate
  ;; concentric sets or an order for the marked files.
  ;; The code depends on dynamic scoping on the marker char.
  "In Dired, the current mark character.
This is what the `do' commands look for and what the `mark' commands store.")

(defvar dired-del-marker ?D
  "Character used to flag files for deletion.")

(defvar dired-shrink-to-fit
227 228 229
  t
;; I see no reason ever to make this nil -- rms.
;;  (> baud-rate search-slow-speed)
230 231 232 233
  "Non-nil means Dired shrinks the display buffer to fit the marked files.")

(defvar dired-flagging-regexp nil);; Last regexp used to flag files.

234 235
(defvar dired-file-version-alist)

236
;;;###autoload
237
(defvar dired-directory nil
238
  "The directory name or wildcard spec that this Dired directory lists.
239
Local to each dired buffer.  May be a list, in which case the car is the
240 241
directory name and the cdr is the list of files to mention.
The directory name must be absolute, but need not be fully expanded.")
242 243 244 245 246 247 248 249 250 251 252 253 254 255 256

(defvar dired-actual-switches nil
  "The value of `dired-listing-switches' used to make this buffer's text.")

(defvar dired-re-inode-size "[0-9 \t]*"
  "Regexp for optional initial inode and file size as made by `ls -i -s'.")

;; These regexps must be tested at beginning-of-line, but are also
;; used to search for next matches, so neither omitting "^" nor
;; replacing "^" by "\n" (to make it slightly faster) will work.

(defvar dired-re-mark "^[^ \n]")
;; "Regexp matching a marked line.
;; Important: the match ends just after the marker."
(defvar dired-re-maybe-mark "^. ")
257 258 259 260
;; The [^:] part after "d" and "l" is to avoid confusion with the
;; DOS/Windows-style drive letters in directory names, like in "d:/foo".
(defvar dired-re-dir (concat dired-re-maybe-mark dired-re-inode-size "d[^:]"))
(defvar dired-re-sym (concat dired-re-maybe-mark dired-re-inode-size "l[^:]"))
261 262 263 264 265 266 267 268
(defvar dired-re-exe;; match ls permission string of an executable file
  (mapconcat (function
	      (lambda (x)
		(concat dired-re-maybe-mark dired-re-inode-size x)))
	     '("-[-r][-w][xs][-r][-w].[-r][-w]."
	       "-[-r][-w].[-r][-w][xs][-r][-w]."
	       "-[-r][-w].[-r][-w].[-r][-w][xst]")
	     "\\|"))
269
(defvar dired-re-perms "[-bcdlps][-r][-w].[-r][-w].[-r][-w].")
270
(defvar dired-re-dot "^.* \\.\\.?/?$")
271

272
;; The subdirectory names in this list are expanded.
273 274 275
(defvar dired-subdir-alist nil
  "Association list of subdirectories and their buffer positions.
Each subdirectory has an element: (DIRNAME . STARTMARKER).
Richard M. Stallman's avatar
Richard M. Stallman committed
276 277
The order of elements is the reverse of the order in the buffer.
In simple cases, this list contains one element.")
278

279
(defvar dired-subdir-regexp "^. \\([^\n\r]+\\)\\(:\\)[\n\r]"
280 281 282 283 284 285
  "Regexp matching a maybe hidden subdirectory line in `ls -lR' output.
Subexpression 1 is the subdirectory proper, no trailing colon.
The match starts at the beginning of the line and ends after the end
of the line (\\n or \\r).
Subexpression 2 must end right before the \\n or \\r.")

286 287 288 289 290 291 292 293 294 295 296 297 298
(defvar dired-font-lock-keywords
  (list
   ;;
   ;; Directory headers.
   (list dired-subdir-regexp '(1 font-lock-type-face))
   ;;
   ;; We make heavy use of MATCH-ANCHORED, since the regexps don't identify the
   ;; file name itself.  We search for Dired defined regexps, and then use the
   ;; Dired defined function `dired-move-to-filename' before searching for the
   ;; simple regexp ".+".  It is that regexp which matches the file name.
   ;;
   ;; Dired marks.
   (list dired-re-mark
299
	 '(0 font-lock-constant-face)
300
	 '(".+" (dired-move-to-filename) nil (0 font-lock-warning-face)))
301 302 303 304 305 306 307 308 309 310
   ;; People who are paranoid about security would consider this more
   ;; important than other things such as whether it is a directory.
   ;; But we don't want to encourage paranoia, so our default
   ;; should be what's most useful for non-paranoids. -- rms.
;;;   ;;
;;;   ;; Files that are group or world writable.
;;;   (list (concat dired-re-maybe-mark dired-re-inode-size
;;;		 "\\([-d]\\(....w....\\|.......w.\\)\\)")
;;;	 '(1 font-lock-comment-face)
;;;	 '(".+" (dired-move-to-filename) nil (0 font-lock-comment-face)))
311 312 313
   ;;
   ;; Subdirectories.
   (list dired-re-dir
314
	 '(".+" (dired-move-to-filename) nil (0 font-lock-function-name-face)))
315 316
   ;;
   ;; Symbolic links.
Juanma Barranquero's avatar
Juanma Barranquero committed
317
   (list dired-re-sym
318
	 '(".+" (dired-move-to-filename) nil (0 font-lock-keyword-face)))
319 320 321
   ;;
   ;; Files suffixed with `completion-ignored-extensions'.
   '(eval .
322 323 324 325
     ;; It is quicker to first find just an extension, then go back to the
     ;; start of that file name.  So we do this complex MATCH-ANCHORED form.
     (list (concat "\\(" (regexp-opt completion-ignored-extensions) "\\|#\\)$")
	   '(".+" (dired-move-to-filename) nil (0 font-lock-string-face)))))
326
  "Additional expressions to highlight in Dired mode.")
Dave Love's avatar
Dave Love committed
327

328 329 330 331 332 333 334 335
;;; Macros must be defined before they are used, for the byte compiler.

;; Mark all files for which CONDITION evals to non-nil.
;; CONDITION is evaluated on each line, with point at beginning of line.
;; MSG is a noun phrase for the type of files being marked.
;; It should end with a noun that can be pluralized by adding `s'.
;; Return value is the number of files marked, or nil if none were marked.
(defmacro dired-mark-if (predicate msg)
336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355
  `(let (buffer-read-only count)
    (save-excursion
      (setq count 0)
      (if ,msg (message "Marking %ss..." ,msg))
      (goto-char (point-min))
      (while (not (eobp))
        (if ,predicate
            (progn
              (delete-char 1)
              (insert dired-marker-char)
              (setq count (1+ count))))
        (forward-line 1))
      (if ,msg (message "%s %s%s %s%s."
                        count
                        ,msg
                        (dired-plural-s count)
                        (if (eq dired-marker-char ?\040) "un" "")
                        (if (eq dired-marker-char dired-del-marker)
                            "flagged" "marked"))))
    (and (> count 0) count)))
356 357

(defmacro dired-map-over-marks (body arg &optional show-progress)
358 359 360 361 362 363 364 365 366 367 368 369 370 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
  "Eval BODY with point on each marked line.  Return a list of BODY's results.
If no marked file could be found, execute BODY on the current line.
  If ARG is an integer, use the next ARG (or previous -ARG, if ARG<0)
  files instead of the marked files.
  In that case point is dragged along.  This is so that commands on
  the next ARG (instead of the marked) files can be chained easily.
  If ARG is otherwise non-nil, use current file instead.
If optional third arg SHOW-PROGRESS evaluates to non-nil,
  redisplay the dired buffer after each file is processed.
No guarantee is made about the position on the marked line.
  BODY must ensure this itself if it depends on this.
Search starts at the beginning of the buffer, thus the car of the list
  corresponds to the line nearest to the buffer's bottom.  This
  is also true for (positive and negative) integer values of ARG.
BODY should not be too long as it is expanded four times."
  ;;
  ;;Warning: BODY must not add new lines before point - this may cause an
  ;;endless loop.
  ;;This warning should not apply any longer, sk  2-Sep-1991 14:10.
  `(prog1
       (let (buffer-read-only case-fold-search found results)
	 (if ,arg
	     (if (integerp ,arg)
		 (progn	;; no save-excursion, want to move point.
		   (dired-repeat-over-lines
		    ,arg
		    (function (lambda ()
				(if ,show-progress (sit-for 0))
				(setq results (cons ,body results)))))
		   (if (< ,arg 0)
		       (nreverse results)
		     results))
	       ;; non-nil, non-integer ARG means use current file:
	       (list ,body))
	   (let ((regexp (dired-marker-regexp)) next-position)
	     (save-excursion
	       (goto-char (point-min))
	       ;; remember position of next marked file before BODY
	       ;; can insert lines before the just found file,
	       ;; confusing us by finding the same marked file again
	       ;; and again and...
	       (setq next-position (and (re-search-forward regexp nil t)
					(point-marker))
		     found (not (null next-position)))
	       (while next-position
		 (goto-char next-position)
		 (if ,show-progress (sit-for 0))
		 (setq results (cons ,body results))
		 ;; move after last match
		 (goto-char next-position)
		 (forward-line 1)
		 (set-marker next-position nil)
410
		 (setq next-position (and (re-search-forward regexp nil t)
411 412 413 414 415 416
					  (point-marker)))))
	     (if found
		 results
	       (list ,body)))))
     ;; save-excursion loses, again
     (dired-move-to-filename)))
417

418
(defun dired-get-marked-files (&optional localp arg filter)
419 420 421
  "Return the marked files' names as list of strings.
The list is in the same order as the buffer, that is, the car is the
  first marked file.
422
Values returned are normally absolute file names.
423
Optional arg LOCALP as in `dired-get-filename'.
424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439
Optional second argument ARG specifies files near point
 instead of marked files.  If ARG is an integer, use the next ARG files.
  If ARG is otherwise non-nil, use file.  Usually ARG comes from
  the command's prefix arg.
Optional third argument FILTER, if non-nil, is a function to select
  some of the files--those for which (funcall FILTER FILENAME) is non-nil."
  (let ((all-of-them
	 (save-excursion
	   (dired-map-over-marks (dired-get-filename localp) arg)))
	result)
    (if (not filter)
	(nreverse all-of-them)
      (dolist (file all-of-them)
	(if (funcall filter file)
	    (push file result)))
      result)))
Dave Love's avatar
Dave Love committed
440

441 442 443 444 445 446 447 448 449 450
;; The dired command

(defun dired-read-dir-and-switches (str)
  ;; For use in interactive.
  (reverse (list
	    (if current-prefix-arg
		(read-string "Dired listing switches: "
			     dired-listing-switches))
	    (read-file-name (format "Dired %s(directory): " str)
			    nil default-directory nil))))
Eric S. Raymond's avatar
Eric S. Raymond committed
451

452
;;;###autoload (define-key ctl-x-map "d" 'dired)
Eric S. Raymond's avatar
Eric S. Raymond committed
453
;;;###autoload
454
(defun dired (dirname &optional switches)
Eric S. Raymond's avatar
Eric S. Raymond committed
455
  "\"Edit\" directory DIRNAME--delete, rename, print, etc. some files in it.
456 457 458
Optional second argument SWITCHES specifies the `ls' options used.
\(Interactively, use a prefix argument to be able to specify SWITCHES.)
Dired displays a list of files in DIRNAME (which may also have
459
shell wildcards appended to select certain files).  If DIRNAME is a cons,
Richard M. Stallman's avatar
Richard M. Stallman committed
460
its first element is taken as the directory name and the rest as an explicit
461
list of files to make directory entries for.
462
\\<dired-mode-map>\
463
You can move around in it with the usual commands.
464 465
You can flag files for deletion with \\[dired-flag-file-deletion] and then
delete them by typing \\[dired-do-flagged-delete].
466
Type \\[describe-mode] after entering dired for more info.
Eric S. Raymond's avatar
Eric S. Raymond committed
467

468 469 470 471 472 473
If DIRNAME is already in a dired buffer, that buffer is used without refresh."
  ;; Cannot use (interactive "D") because of wildcards.
  (interactive (dired-read-dir-and-switches ""))
  (switch-to-buffer (dired-noselect dirname switches)))

;;;###autoload (define-key ctl-x-4-map "d" 'dired-other-window)
Eric S. Raymond's avatar
Eric S. Raymond committed
474
;;;###autoload
475
(defun dired-other-window (dirname &optional switches)
Eric S. Raymond's avatar
Eric S. Raymond committed
476
  "\"Edit\" directory DIRNAME.  Like `dired' but selects in another window."
477 478
  (interactive (dired-read-dir-and-switches "in other window "))
  (switch-to-buffer-other-window (dired-noselect dirname switches)))
Eric S. Raymond's avatar
Eric S. Raymond committed
479

480 481 482 483 484 485 486
;;;###autoload (define-key ctl-x-5-map "d" 'dired-other-frame)
;;;###autoload
(defun dired-other-frame (dirname &optional switches)
  "\"Edit\" directory DIRNAME.  Like `dired' but makes a new frame."
  (interactive (dired-read-dir-and-switches "in other frame "))
  (switch-to-buffer-other-frame (dired-noselect dirname switches)))

Eric S. Raymond's avatar
Eric S. Raymond committed
487
;;;###autoload
488
(defun dired-noselect (dir-or-list &optional switches)
Eric S. Raymond's avatar
Eric S. Raymond committed
489
  "Like `dired' but returns the dired buffer as value, does not select it."
490
  (or dir-or-list (setq dir-or-list default-directory))
491 492
  ;; This loses the distinction between "/foo/*/" and "/foo/*" that
  ;; some shells make:
493
  (let (dirname initially-was-dirname)
494 495 496
    (if (consp dir-or-list)
	(setq dirname (car dir-or-list))
      (setq dirname dir-or-list))
497 498
    (setq initially-was-dirname
	  (string= (file-name-as-directory dirname) dirname))
499 500
    (setq dirname (abbreviate-file-name
		   (expand-file-name (directory-file-name dirname))))
501 502
    (if find-file-visit-truename
	(setq dirname (file-truename dirname)))
503 504 505 506 507 508 509 510
    ;; If the argument was syntactically  a directory name not a file name,
    ;; or if it happens to name a file that is a directory,
    ;; convert it syntactically to a directory name.
    ;; The reason for checking initially-was-dirname
    ;; and not just file-directory-p
    ;; is that file-directory-p is slow over ftp.
    (if (or initially-was-dirname (file-directory-p dirname))
	(setq dirname  (file-name-as-directory dirname)))
511 512 513 514
    (if (consp dir-or-list)
	(setq dir-or-list (cons dirname (cdr dir-or-list)))
      (setq dir-or-list dirname))
    (dired-internal-noselect dir-or-list switches)))
515 516

;; Separate function from dired-noselect for the sake of dired-vms.el.
517
(defun dired-internal-noselect (dir-or-list &optional switches mode)
518 519 520 521 522 523 524 525 526
  ;; If there is an existing dired buffer for DIRNAME, just leave
  ;; buffer as it is (don't even call dired-revert).
  ;; This saves time especially for deep trees or with ange-ftp.
  ;; The user can type `g'easily, and it is more consistent with find-file.
  ;; But if SWITCHES are given they are probably different from the
  ;; buffer's old value, so call dired-sort-other, which does
  ;; revert the buffer.
  ;; A pity we can't possibly do "Directory has changed - refresh? "
  ;; like find-file does.
527 528
  ;; Optional argument MODE is passed to dired-find-buffer-nocreate,
  ;; see there.
529 530
  (let* (dirname
	 buffer
531
	 ;; note that buffer already is in dired-mode, if found
532
	 new-buffer-p
533
	 (old-buf (current-buffer)))
534 535 536 537 538 539
    (if (consp dir-or-list)
	(setq dirname (car dir-or-list))
      (setq dirname dir-or-list))
    ;; Look for an existing buffer.
    (setq buffer (dired-find-buffer-nocreate dirname mode)
	  new-buffer-p (null buffer))
540 541 542 543 544 545 546
    (or buffer
	(let ((default-major-mode 'fundamental-mode))
	  ;; We don't want default-major-mode to run hooks and set auto-fill
	  ;; or whatever, now that dired-mode does not
	  ;; kill-all-local-variables any longer.
	  (setq buffer (create-file-buffer (directory-file-name dirname)))))
    (set-buffer buffer)
547
    (if (not new-buffer-p)     ; existing buffer ...
Juanma Barranquero's avatar
Juanma Barranquero committed
548
	(cond (switches        ; ... but new switches
549
	       ;; file list may have changed
550
	       (setq dired-directory dir-or-list)
551
	       ;; this calls dired-revert
Juanma Barranquero's avatar
Juanma Barranquero committed
552
	       (dired-sort-other switches))
553 554 555 556 557 558 559 560
	      ;; If directory has changed on disk, offer to revert.
	      ((if (let ((attributes (file-attributes dirname))
			 (modtime (visited-file-modtime)))
		     (or (eq modtime 0)
			 (not (eq (car attributes) t))
			 (and (= (car (nth 5 attributes)) (car modtime))
			      (= (nth 1 (nth 5 attributes)) (cdr modtime)))))
		   nil
561
		 (message "%s"
Karl Heuer's avatar
Karl Heuer committed
562 563
			  (substitute-command-keys
			   "Directory has changed on disk; type \\[revert-buffer] to update Dired")))))
564
      ;; Else a new buffer
565
      (setq default-directory
566 567 568 569 570
	    ;; We can do this unconditionally
	    ;; because dired-noselect ensures that the name
	    ;; is passed in directory name syntax
	    ;; if it was the name of a directory at all.
	    (file-name-directory dirname))
571
      (or switches (setq switches dired-listing-switches))
572
      (if mode (funcall mode)
573
        (dired-mode dir-or-list switches))
574 575 576 577
      ;; default-directory and dired-actual-switches are set now
      ;; (buffer-local), so we can call dired-readin:
      (let ((failed t))
	(unwind-protect
578
	    (progn (dired-readin)
579 580 581 582 583 584 585
		   (setq failed nil))
	  ;; dired-readin can fail if parent directories are inaccessible.
	  ;; Don't leave an empty buffer around in that case.
	  (if failed (kill-buffer buffer))))
      (goto-char (point-min))
      (dired-initial-position dirname))
    (set-buffer old-buf)
Eric S. Raymond's avatar
Eric S. Raymond committed
586 587
    buffer))

588 589 590 591 592 593
(defvar dired-buffers nil
  ;; Enlarged by dired-advertise
  ;; Queried by function dired-buffers-for-dir. When this detects a
  ;; killed buffer, it is removed from this list.
  "Alist of expanded directories and their associated dired buffers.")

594 595 596 597
(defun dired-find-buffer-nocreate (dirname &optional mode)
  ;; This differs from dired-buffers-for-dir in that it does not consider
  ;; subdirs of default-directory and searches for the first match only.
  ;; Also, the major mode must be MODE.
598
  (setq dirname (expand-file-name dirname))
599
  (let (found (blist dired-buffers))    ; was (buffer-list)
600
    (or mode (setq mode 'dired-mode))
601
    (while blist
602 603 604 605
      (if (null (buffer-name (cdr (car blist))))
	  (setq blist (cdr blist))
	(save-excursion
	  (set-buffer (cdr (car blist)))
606
	  (if (and (eq major-mode mode)
607
		   dired-directory  ;; nil during find-alternate-file
608 609 610 611 612
		   (equal dirname
			  (expand-file-name
			   (if (consp dired-directory)
			       (car dired-directory)
			     dired-directory))))
613 614 615
	      (setq found (cdr (car blist))
		    blist nil)
	    (setq blist (cdr blist))))))
616 617
    found))

Dave Love's avatar
Dave Love committed
618

619 620 621 622 623
;; Read in a new dired buffer

;; dired-readin differs from dired-insert-subdir in that it accepts
;; wildcards, erases the buffer, and builds the subdir-alist anew
;; (including making it buffer-local and clearing it first).
624
(defun dired-readin ()
625 626
  ;; default-directory and dired-actual-switches must be buffer-local
  ;; and initialized by now.
627 628 629 630
  (let (dirname)
    (if (consp dired-directory)
	(setq dirname (car dired-directory))
      (setq dirname dired-directory))
631 632
    (setq dirname (expand-file-name dirname))
    (save-excursion
633 634 635 636
      ;; This hook which may want to modify dired-actual-switches
      ;; based on dired-directory, e.g. with ange-ftp to a SysV host
      ;; where ls won't understand -Al switches.
      (run-hooks 'dired-before-readin-hook)
637
      (message "Reading directory %s..." dirname)
638 639 640 641 642
      (if (consp buffer-undo-list)
	  (setq buffer-undo-list nil))
      (let (buffer-read-only
	    ;; Don't make undo entries for readin.
	    (buffer-undo-list t))
643 644
	(widen)
	(erase-buffer)
645
	(dired-readin-insert))
646
      (message "Reading directory %s...done" dirname)
647
      (goto-char (point-min))
648 649 650
      ;; Must first make alist buffer local and set it to nil because
      ;; dired-build-subdir-alist will call dired-clear-alist first
      (set (make-local-variable 'dired-subdir-alist) nil)
651
      (dired-build-subdir-alist)
652 653 654
      (let ((attributes (file-attributes dirname)))
	(if (eq (car attributes) t)
	    (set-visited-file-modtime (nth 5 attributes))))
655 656 657 658 659 660
      (set-buffer-modified-p nil)
      ;; No need to narrow since the whole buffer contains just
      ;; dired-readin's output, nothing else.  The hook can
      ;; successfully use dired functions (e.g. dired-get-filename)
      ;; as the subdir-alist has been built in dired-readin.
      (run-hooks 'dired-after-readin-hook))))
661 662 663

;; Subroutines of dired-readin

664 665 666 667 668 669 670 671 672
(defun dired-readin-insert ()
  ;; Insert listing for the specified dir (and maybe file list)
  ;; already in dired-directory, assuming a clean buffer.
  (let (dir file-list)
    (if (consp dired-directory)
	(setq dir (car dired-directory)
	      file-list (cdr dired-directory))
      (setq dir dired-directory
	    file-list nil))
673
    (setq dir (expand-file-name dir))
674 675
    (if (and (equal "" (file-name-nondirectory dir))
	     (not file-list))
676
	;; If we are reading a whole single directory...
677
	(dired-insert-directory dir dired-actual-switches nil nil t)
678
      (if (not (file-readable-p
679 680 681 682 683 684 685 686 687 688 689 690 691 692 693
		(directory-file-name (file-name-directory dir))))
	  (error "Directory %s inaccessible or nonexistent" dir)
	;; Else treat it as a wildcard spec
	;; unless we have an explicit list of files.
	(dired-insert-directory dir dired-actual-switches
				file-list (not file-list) t)))))

(defun dired-insert-directory (dir switches &optional file-list wildcard hdr)
  "Insert a directory listing of DIR, Dired style.
Use SWITCHES to make the listings.
If FILE-LIST is non-nil, list only those files.
Otherwise, if WILDCARD is non-nil, expand wildcards;
 in that case, DIR should be a file name that uses wildcards.
In other cases, DIR should be a directory name or a directory filename.
If HDR is non-nil, insert a header line with the directory name."
694
  (let ((opoint (point))
695
	(process-environment (copy-sequence process-environment))
696
	end)
697
    (if (or dired-use-ls-dired (file-remote-p dir))
698
	(setq switches (concat "--dired " switches)))
699 700 701
    ;; We used to specify the C locale here, to force English month names;
    ;; but this should not be necessary any more,
    ;; with the new value of dired-move-to-filename-regexp.
702 703 704 705
    (if file-list
	(dolist (f file-list)
	  (insert-directory f switches nil nil))
      (insert-directory dir switches wildcard (not wildcard)))
706
    ;; Quote certain characters, unless ls quoted them for us.
707 708 709 710 711
    (if (not (string-match "b" dired-actual-switches))
	(save-excursion
	  (setq end (point-marker))
	  (goto-char opoint)
	  (while (search-forward "\\" end t)
712 713 714 715
	    (replace-match (apply #'propertize
				  "\\\\"
				  (text-properties-at (match-beginning 0)))
			   nil t))
716 717
	  (goto-char opoint)
	  (while (search-forward "\^m" end t)
718 719 720 721
	    (replace-match (apply #'propertize
				  "\\015"
				  (text-properties-at (match-beginning 0)))
			   nil t))
722
	  (set-marker end nil)))
723 724 725 726
    (dired-insert-set-properties opoint (point))
    ;; If we used --dired and it worked, the lines are already indented.
    ;; Otherwise, indent them.
    (unless (save-excursion
727
	      (goto-char opoint)
728 729 730 731 732 733 734 735 736 737 738 739 740 741
	      (looking-at "  "))
      (let ((indent-tabs-mode nil))
	(indent-rigidly opoint (point) 2)))
    ;; Insert text at the beginning to standardize things.
    (save-excursion
      (goto-char opoint)
      (if (and (or hdr wildcard) (not (looking-at "^  /.*:$")))
	  ;; Note that dired-build-subdir-alist will replace the name
	  ;; by its expansion, so it does not matter whether what we insert
	  ;; here is fully expanded, but it should be absolute.
	  (insert "  " (directory-file-name (file-name-directory dir)) ":\n"))
      (when wildcard
	;; Insert "wildcard" line where "total" line would be for a full dir.
	(insert "  wildcard " (file-name-nondirectory dir) "\n")))))
742

743
;; Make the file names highlight when the mouse is on them.
744 745 746 747
(defun dired-insert-set-properties (beg end)
  (save-excursion
    (goto-char beg)
    (while (< (point) end)
748 749
      (condition-case nil
	  (if (dired-move-to-filename)
750 751 752 753 754
	      (add-text-properties
	       (point)
	       (save-excursion
		 (dired-move-to-end-of-filename)
		 (point))
755
	       '(mouse-face highlight
756
		 help-echo "mouse-2: visit this file in other window")))
757
	(error nil))
758
      (forward-line 1))))
Dave Love's avatar
Dave Love committed
759

760 761
;; Reverting a dired buffer

Eric S. Raymond's avatar
Eric S. Raymond committed
762
(defun dired-revert (&optional arg noconfirm)
763 764 765 766 767
  ;; Reread the dired buffer.  Must also be called after
  ;; dired-actual-switches have changed.
  ;; Should not fail even on completely garbaged buffers.
  ;; Preserves old cursor, marks/flags, hidden-p.
  (widen)				; just in case user narrowed
Eric S. Raymond's avatar
Eric S. Raymond committed
768
  (let ((opoint (point))
769 770 771 772 773 774 775 776 777 778
	(ofile (dired-get-filename nil t))
	(mark-alist nil)		; save marked files
	(hidden-subdirs (dired-remember-hidden))
	(old-subdir-alist (cdr (reverse dired-subdir-alist))) ; except pwd
	(case-fold-search nil)		; we check for upper case ls flags
	buffer-read-only)
    (goto-char (point-min))
    (setq mark-alist;; only after dired-remember-hidden since this unhides:
	  (dired-remember-marks (point-min) (point-max)))
    ;; treat top level dir extra (it may contain wildcards)
779 780
    (dired-uncache
     (if (consp dired-directory) (car dired-directory) dired-directory))
781
    (dired-readin)
782 783 784 785 786 787 788 789 790
    (let ((dired-after-readin-hook nil))
      ;; don't run that hook for each subdir...
      (dired-insert-old-subdirs old-subdir-alist))
    (dired-mark-remembered mark-alist)	; mark files that were marked
    ;; ... run the hook for the whole buffer, and only after markers
    ;; have been reinserted (else omitting in dired-x would omit marked files)
    (run-hooks 'dired-after-readin-hook)	; no need to narrow
    (or (and ofile (dired-goto-file ofile)) ; move cursor to where it
	(goto-char opoint))		; was before
Eric S. Raymond's avatar
Eric S. Raymond committed
791
    (dired-move-to-filename)
792 793 794 795 796 797 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 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842
    (save-excursion			; hide subdirs that were hidden
      (mapcar (function (lambda (dir)
			  (if (dired-goto-subdir dir)
			      (dired-hide-subdir 1))))
	      hidden-subdirs)))
  ;; outside of the let scope
;;; Might as well not override the user if the user changed this.
;;;  (setq buffer-read-only t)
  )

;; Subroutines of dired-revert
;; Some of these are also used when inserting subdirs.

(defun dired-remember-marks (beg end)
  ;; Return alist of files and their marks, from BEG to END.
  (if selective-display			; must unhide to make this work.
      (let (buffer-read-only)
	(subst-char-in-region beg end ?\r ?\n)))
  (let (fil chr alist)
    (save-excursion
      (goto-char beg)
      (while (re-search-forward dired-re-mark end t)
	(if (setq fil (dired-get-filename nil t))
	    (setq chr (preceding-char)
		  alist (cons (cons fil chr) alist)))))
    alist))

;; Mark all files remembered in ALIST.
;; Each element of ALIST looks like (FILE . MARKERCHAR).
(defun dired-mark-remembered (alist)
  (let (elt fil chr)
    (while alist
      (setq elt (car alist)
	    alist (cdr alist)
	    fil (car elt)
	    chr (cdr elt))
      (if (dired-goto-file fil)
	  (save-excursion
	    (beginning-of-line)
	    (delete-char 1)
	    (insert chr))))))

;; Return a list of names of subdirs currently hidden.
(defun dired-remember-hidden ()
  (let ((l dired-subdir-alist) dir pos result)
    (while l
      (setq dir (car (car l))
	    pos (cdr (car l))
	    l (cdr l))
      (goto-char pos)
      (skip-chars-forward "^\r\n")
843
      (if (eq (following-char) ?\r)
844 845 846 847 848 849 850 851 852 853 854 855 856
	  (setq result (cons dir result))))
    result))

;; Try to insert all subdirs that were displayed before,
;; according to the former subdir alist OLD-SUBDIR-ALIST.
(defun dired-insert-old-subdirs (old-subdir-alist)
  (or (string-match "R" dired-actual-switches)
      (let (elt dir)
	(while old-subdir-alist
	  (setq elt (car old-subdir-alist)
		old-subdir-alist (cdr old-subdir-alist)
		dir (car elt))
	  (condition-case ()
857 858 859
	      (progn
		(dired-uncache dir)
		(dired-insert-subdir dir))
860
	    (error nil))))))
861 862 863

;; Remove directory DIR from any directory cache.
(defun dired-uncache (dir)
864
  (let ((handler (find-file-name-handler dir 'dired-uncache)))
865 866
    (if handler
	(funcall handler 'dired-uncache dir))))
Dave Love's avatar
Dave Love committed
867

868
;; dired mode key bindings and initialization
Eric S. Raymond's avatar
Eric S. Raymond committed
869 870 871 872

(defvar dired-mode-map nil "Local keymap for dired-mode buffers.")
(if dired-mode-map
    nil
873 874 875
  ;; This looks ugly when substitute-command-keys uses C-d instead d:
  ;;  (define-key dired-mode-map "\C-d" 'dired-flag-file-deletion)

876 877 878 879 880 881 882
  (let ((map (make-keymap)))
    (suppress-keymap map)
    (define-key map [mouse-2] 'dired-mouse-find-file-other-window)
    ;; Commands to mark or flag certain categories of files
    (define-key map "#" 'dired-flag-auto-save-files)
    (define-key map "." 'dired-clean-directory)
    (define-key map "~" 'dired-flag-backup-files)
883
    (define-key map "&" 'dired-flag-garbage-files)
884 885 886 887 888 889 890 891 892 893 894
    ;; Upper case keys (except !) for operating on the marked files
    (define-key map "A" 'dired-do-search)
    (define-key map "C" 'dired-do-copy)
    (define-key map "B" 'dired-do-byte-compile)
    (define-key map "D" 'dired-do-delete)
    (define-key map "G" 'dired-do-chgrp)
    (define-key map "H" 'dired-do-hardlink)
    (define-key map "L" 'dired-do-load)
    (define-key map "M" 'dired-do-chmod)
    (define-key map "O" 'dired-do-chown)
    (define-key map "P" 'dired-do-print)
895
    (define-key map "Q" 'dired-do-query-replace-regexp)
896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920
    (define-key map "R" 'dired-do-rename)
    (define-key map "S" 'dired-do-symlink)
    (define-key map "X" 'dired-do-shell-command)
    (define-key map "Z" 'dired-do-compress)
    (define-key map "!" 'dired-do-shell-command)
    ;; Comparison commands
    (define-key map "=" 'dired-diff)
    (define-key map "\M-=" 'dired-backup-diff)
    ;; Tree Dired commands
    (define-key map "\M-\C-?" 'dired-unmark-all-files)
    (define-key map "\M-\C-d" 'dired-tree-down)
    (define-key map "\M-\C-u" 'dired-tree-up)
    (define-key map "\M-\C-n" 'dired-next-subdir)
    (define-key map "\M-\C-p" 'dired-prev-subdir)
    ;; move to marked files
    (define-key map "\M-{" 'dired-prev-marked-file)
    (define-key map "\M-}" 'dired-next-marked-file)
    ;; Make all regexp commands share a `%' prefix:
    ;; We used to get to the submap via a symbol dired-regexp-prefix,
    ;; but that seems to serve little purpose, and copy-keymap
    ;; does a better job without it.
    (define-key map "%" nil)
    (define-key map "%u" 'dired-upcase)
    (define-key map "%l" 'dired-downcase)
    (define-key map "%d" 'dired-flag-files-regexp)
921
    (define-key map "%g" 'dired-mark-files-containing-regexp)
922 923 924 925 926 927
    (define-key map "%m" 'dired-mark-files-regexp)
    (define-key map "%r" 'dired-do-rename-regexp)
    (define-key map "%C" 'dired-do-copy-regexp)
    (define-key map "%H" 'dired-do-hardlink-regexp)
    (define-key map "%R" 'dired-do-rename-regexp)
    (define-key map "%S" 'dired-do-symlink-regexp)
928 929 930 931 932 933 934
    ;; Commands for marking and unmarking.
    (define-key map "*" nil)
    (define-key map "**" 'dired-mark-executables)
    (define-key map "*/" 'dired-mark-directories)
    (define-key map "*@" 'dired-mark-symlinks)
    (define-key map "*%" 'dired-mark-files-regexp)
    (define-key map "*c" 'dired-change-marks)
935
    (define-key map "*s" 'dired-mark-subdir-files)
936 937 938
    (define-key map "*m" 'dired-mark)
    (define-key map "*u" 'dired-unmark)
    (define-key map "*?" 'dired-unmark-all-files)
939
    (define-key map "*!" 'dired-unmark-all-marks)
940 941 942
    (define-key map "*\177" 'dired-unmark-backward)
    (define-key map "*\C-n" 'dired-next-marked-file)
    (define-key map "*\C-p" 'dired-prev-marked-file)
943
    (define-key map "*t" 'dired-toggle-marks)
944
    ;; Lower keys for commands not operating on all the marked files
945
    (define-key map "a" 'dired-find-alternate-file)
946 947 948 949 950
    (define-key map "d" 'dired-flag-file-deletion)
    (define-key map "e" 'dired-find-file)
    (define-key map "f" 'dired-find-file)
    (define-key map "\C-m" 'dired-advertised-find-file)
    (define-key map "g" 'revert-buffer)
Luc Teirlinck's avatar
Luc Teirlinck committed
951
    (define-key map "\M-g" 'dired-goto-file)
952 953 954 955 956 957 958 959 960
    (define-key map "h" 'describe-mode)
    (define-key map "i" 'dired-maybe-insert-subdir)
    (define-key map "k" 'dired-do-kill-lines)
    (define-key map "l" 'dired-do-redisplay)
    (define-key map "m" 'dired-mark)
    (define-key map "n" 'dired-next-line)
    (define-key map "o" 'dired-find-file-other-window)
    (define-key map "\C-o" 'dired-display-file)
    (define-key map "p" 'dired-previous-line)
961
    (define-key map "q" 'quit-window)
962
    (define-key map "s" 'dired-sort-toggle-or-edit)
963
    (define-key map "t" 'dired-toggle-marks)
964 965
    (define-key map "u" 'dired-unmark)
    (define-key map "v" 'dired-view-file)
966
    (define-key map "w" 'dired-copy-filename-as-kill)
967
    (define-key map "x" 'dired-do-flagged-delete)
968
    (define-key map "y" 'dired-show-file-type)
969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989
    (define-key map "+" 'dired-create-directory)
    ;; moving
    (define-key map "<" 'dired-prev-dirline)
    (define-key map ">" 'dired-next-dirline)
    (define-key map "^" 'dired-up-directory)
    (define-key map " "  'dired-next-line)
    (define-key map "\C-n" 'dired-next-line)
    (define-key map "\C-p" 'dired-previous-line)
    (define-key map [down] 'dired-next-line)
    (define-key map [up] 'dired-previous-line)
    ;; hiding
    (define-key map "$" 'dired-hide-subdir)
    (define-key map "\M-$" 'dired-hide-all)
    ;; misc
    (define-key map "?" 'dired-summary)
    (define-key map "\177" 'dired-unmark-backward)
    (define-key map "\C-_" 'dired-undo)
    (define-key map "\C-xu" 'dired-undo)

    ;; Make menu bar items.

990 991
    ;; No need to fo this, now that top-level items are fewer.
    ;;;;
992
    ;; Get rid of the Edit menu bar item to save space.
993
    ;(define-key map [menu-bar edit] 'undefined)
994 995 996 997 998

    (define-key map [menu-bar subdir]
      (cons "Subdir" (make-sparse-keymap "Subdir")))

    (define-key map [menu-bar subdir hide-all]
999 1000
      '(menu-item "Hide All" dired-hide-all
		  :help "Hide all subdirectories, leave only header lines"))
1001
    (define-key map [menu-bar subdir hide-subdir]
1002 1003
      '(menu-item "Hide/UnHide Subdir" dired-hide-subdir
		  :help "Hide or unhide current directory listing"))
1004
    (define-key map [menu-bar subdir tree-down]
1005 1006
      '(menu-item "Tree Down" dired-tree-down
		  :help "Go to first subdirectory header down the tree"))
1007
    (define-key map [menu-bar subdir tree-up]
1008 1009
      '(menu-item "Tree Up" dired-tree-up
		  :help "Go to first subdirectory header up the tree"))
1010
    (define-key map [menu-bar subdir up]
1011 1012
      '(menu-item "Up Directory" dired-up-directory
		  :help "Edit the parent directory"))
1013
    (define-key map [menu-bar subdir prev-subdir]
1014 1015
      '(menu-item "Prev Subdir" dired-prev-subdir
		  :help "Go to previous subdirectory header line"))
1016
    (define-key map [menu-bar subdir next-subdir]
1017 1018
      '(menu-item "Next Subdir" dired-next-subdir
		  :help "Go to next subdirectory header line"))
1019
    (define-key map [menu-bar subdir prev-dirline]
1020 1021
      '(menu-item "Prev Dirline" dired-prev-dirline
		  :help "Move to next directory-file line"))
1022
    (define-key map [menu-bar subdir next-dirline]
1023 1024
      '(menu-item "Next Dirline" dired-next-dirline
		  :help "Move to previous directory-file line"))
1025
    (define-key map [menu-bar subdir insert]
1026 1027
      '(menu-item "Insert This Subdir" dired-maybe-insert-subdir
		  :help "Insert contents of subdirectory"))
1028 1029 1030 1031

    (define-key map [menu-bar immediate]
      (cons "Immediate" (make-sparse-keymap "Immediate")))

1032
    (define-key map [menu-bar immediate revert-buffer]
1033 1034
      '(menu-item "Refresh" revert-buffer
		  :help "Update contents of shown directories"))
1035 1036 1037 1038

    (define-key map [menu-bar immediate dashes]
      '("--"))

1039
    (define-key map [menu-bar immediate backup-diff]
1040 1041
      '(menu-item "Compare with Backup" dired-backup-diff
		  :help "Diff file at cursor with its latest backup"))
1042
    (define-key map [menu-bar immediate diff]
1043 1044
      '(menu-item "Diff..." dired-diff
		  :help "Compare file at cursor with another file"))