1 ;;; dired.el --- directory-browsing commands
3 ;; Copyright (C) 1985-1986, 1992-1997, 2000-2011
4 ;; Free Software Foundation, Inc.
6 ;; Author: Sebastian Kremer <sk@thp.uni-koeln.de>
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
28 ;; This is a major mode for directory browsing and editing.
29 ;; It is documented in the Emacs manual.
31 ;; Rewritten in 1990/1991 to add tree features, file marking and
32 ;; sorting by Sebastian Kremer <sk@thp.uni-koeln.de>.
33 ;; Finished up by rms in 1992.
37 (eval-when-compile (require 'cl
))
39 ;;; Customizable variables
43 :link
'(custom-manual "(emacs)Dired")
46 (defgroup dired-mark nil
47 "Handling marks in Dired."
53 (defcustom dired-listing-switches
(purecopy "-al")
54 "Switches passed to `ls' for Dired. MUST contain the `l' option.
55 May contain all other options that don't contradict `-l';
56 may contain even `F', `b', `i' and `s'. See also the variable
57 `dired-ls-F-marks-symlinks' concerning the `F' switch.
58 On systems such as MS-DOS and MS-Windows, which use `ls' emulation in Lisp,
59 some of the `ls' switches are not supported; see the doc string of
60 `insert-directory' in `ls-lisp.el' for more details."
64 (defcustom dired-subdir-switches nil
65 "If non-nil, switches passed to `ls' for inserting subdirectories.
66 If nil, `dired-listing-switches' is used."
68 :type
'(choice (const :tag
"Use dired-listing-switches" nil
)
69 (string :tag
"Switches")))
71 (defcustom dired-chown-program
72 (purecopy (cond ((executable-find "chown") "chown")
73 ((file-executable-p "/usr/sbin/chown") "/usr/sbin/chown")
74 ((file-executable-p "/etc/chown") "/etc/chown")
76 "Name of chown command (usually `chown')."
80 (defcustom dired-use-ls-dired
'unspecified
81 "Non-nil means Dired should use \"ls --dired\".
82 The special value of `unspecified' means to check explicitly, and
83 save the result in this variable. This is performed the first
84 time `dired-insert-directory' is called."
86 :type
'(choice (const :tag
"Check for --dired support" unspecified
)
87 (const :tag
"Do not use --dired" nil
)
88 (other :tag
"Use --dired" t
)))
90 (defcustom dired-chmod-program
"chmod"
91 "Name of chmod command (usually `chmod')."
95 (defcustom dired-touch-program
"touch"
96 "Name of touch command (usually `touch')."
100 (defcustom dired-ls-F-marks-symlinks nil
101 "Informs Dired about how `ls -lF' marks symbolic links.
102 Set this to t if `ls' (or whatever program is specified by
103 `insert-directory-program') with `-lF' marks the symbolic link
104 itself with a trailing @ (usually the case under Ultrix).
106 Example: if `ln -s foo bar; ls -F bar' gives `bar -> foo', set it to
107 nil (the default), if it gives `bar@ -> foo', set it to t.
109 Dired checks if there is really a @ appended. Thus, if you have a
110 marking `ls' program on one host and a non-marking on another host, and
111 don't care about symbolic links which really end in a @, you can
112 always set this variable to t."
116 (defcustom dired-trivial-filenames
(purecopy "^\\.\\.?$\\|^#")
117 "Regexp of files to skip when finding first file of a directory.
118 A value of nil means move to the subdir line.
119 A value of t means move to first file."
120 :type
'(choice (const :tag
"Move to subdir" nil
)
121 (const :tag
"Move to first" t
)
125 (defcustom dired-keep-marker-rename t
126 ;; Use t as default so that moved files "take their markers with them".
127 "Controls marking of renamed files.
128 If t, files keep their previous marks when they are renamed.
129 If a character, renamed files (whether previously marked or not)
130 are afterward marked with that character."
131 :type
'(choice (const :tag
"Keep" t
)
132 (character :tag
"Mark"))
135 (defcustom dired-keep-marker-copy ?C
136 "Controls marking of copied files.
137 If t, copied files are marked if and as the corresponding original files were.
138 If a character, copied files are unconditionally marked with that character."
139 :type
'(choice (const :tag
"Keep" t
)
140 (character :tag
"Mark"))
143 (defcustom dired-keep-marker-hardlink ?H
144 "Controls marking of newly made hard links.
145 If t, they are marked if and as the files linked to were marked.
146 If a character, new links are unconditionally marked with that character."
147 :type
'(choice (const :tag
"Keep" t
)
148 (character :tag
"Mark"))
151 (defcustom dired-keep-marker-symlink ?Y
152 "Controls marking of newly made symbolic links.
153 If t, they are marked if and as the files linked to were marked.
154 If a character, new links are unconditionally marked with that character."
155 :type
'(choice (const :tag
"Keep" t
)
156 (character :tag
"Mark"))
159 (defcustom dired-dwim-target nil
160 "If non-nil, Dired tries to guess a default target directory.
161 This means: if there is a dired buffer displayed in the next window,
162 use its current subdir, instead of the current subdir of this dired buffer.
164 The target is used in the prompt for file copy, rename etc."
168 (defcustom dired-copy-preserve-time t
169 "If non-nil, Dired preserves the last-modified time in a file copy.
170 \(This works on only some systems.)"
174 ; These variables were deleted and the replacements are on files.el.
175 ; We leave aliases behind for back-compatibility.
176 (defvaralias 'dired-free-space-program
'directory-free-space-program
)
177 (defvaralias 'dired-free-space-args
'directory-free-space-args
)
181 (defcustom dired-load-hook nil
182 "Run after loading Dired.
183 You can customize key bindings or load extensions with this."
187 (defcustom dired-mode-hook nil
188 "Run at the very end of `dired-mode'."
192 (defcustom dired-before-readin-hook nil
193 "This hook is run before a dired buffer is read in (created or reverted)."
197 (defcustom dired-after-readin-hook nil
198 "Hook run after each time a file or directory is read by Dired.
199 After each listing of a file or directory, this hook is run
200 with the buffer narrowed to the listing."
203 ;; Note this can't simply be run inside function `dired-ls' as the hook
204 ;; functions probably depend on the dired-subdir-alist to be OK.
206 (defcustom dired-dnd-protocol-alist
207 '(("^file:///" . dired-dnd-handle-local-file
)
208 ("^file://" . dired-dnd-handle-file
)
209 ("^file:" . dired-dnd-handle-local-file
))
210 "The functions to call when a drop in `dired-mode' is made.
211 See `dnd-protocol-alist' for more information. When nil, behave
212 as in other buffers. Changing this option is effective only for
214 :type
'(choice (repeat (cons (regexp) (function)))
215 (const :tag
"Behave as in other buffers" nil
))
219 ;; Internal variables
221 (defvar dired-marker-char ?
* ; the answer is 42
222 ;; so that you can write things like
223 ;; (let ((dired-marker-char ?X))
224 ;; ;; great code using X markers ...
226 ;; For example, commands operating on two sets of files, A and B.
227 ;; Or marking files with digits 0-9. This could implicate
228 ;; concentric sets or an order for the marked files.
229 ;; The code depends on dynamic scoping on the marker char.
230 "In Dired, the current mark character.
231 This is what the do-commands look for, and what the mark-commands store.")
233 (defvar dired-del-marker ?D
234 "Character used to flag files for deletion.")
236 (defvar dired-shrink-to-fit t
237 ;; I see no reason ever to make this nil -- rms.
238 ;; (> baud-rate search-slow-speed)
239 "Non-nil means Dired shrinks the display buffer to fit the marked files.")
241 (defvar dired-flagging-regexp nil
);; Last regexp used to flag files.
243 (defvar dired-file-version-alist
)
246 (defvar dired-directory nil
247 "The directory name or wildcard spec that this dired directory lists.
248 Local to each dired buffer. May be a list, in which case the car is the
249 directory name and the cdr is the list of files to mention.
250 The directory name must be absolute, but need not be fully expanded.")
252 (defvar dired-actual-switches nil
253 "The value of `dired-listing-switches' used to make this buffer's text.")
255 (defvar dired-re-inode-size
"[0-9 \t]*"
256 "Regexp for optional initial inode and file size as made by `ls -i -s'.")
258 ;; These regexps must be tested at beginning-of-line, but are also
259 ;; used to search for next matches, so neither omitting "^" nor
260 ;; replacing "^" by "\n" (to make it slightly faster) will work.
262 (defvar dired-re-mark
"^[^ \n]")
263 ;; "Regexp matching a marked line.
264 ;; Important: the match ends just after the marker."
265 (defvar dired-re-maybe-mark
"^. ")
266 ;; The [^:] part after "d" and "l" is to avoid confusion with the
267 ;; DOS/Windows-style drive letters in directory names, like in "d:/foo".
268 (defvar dired-re-dir
(concat dired-re-maybe-mark dired-re-inode-size
"d[^:]"))
269 (defvar dired-re-sym
(concat dired-re-maybe-mark dired-re-inode-size
"l[^:]"))
270 (defvar dired-re-exe
;; match ls permission string of an executable file
273 (concat dired-re-maybe-mark dired-re-inode-size x
)))
274 '("-[-r][-w][xs][-r][-w].[-r][-w]."
275 "-[-r][-w].[-r][-w][xs][-r][-w]."
276 "-[-r][-w].[-r][-w].[-r][-w][xst]")
278 (defvar dired-re-perms
"[-bcdlps][-r][-w].[-r][-w].[-r][-w].")
279 (defvar dired-re-dot
"^.* \\.\\.?/?$")
281 ;; The subdirectory names in the next two lists are expanded.
282 (defvar dired-subdir-alist nil
283 "Association list of subdirectories and their buffer positions.
284 Each subdirectory has an element: (DIRNAME . STARTMARKER).
285 The order of elements is the reverse of the order in the buffer.
286 In simple cases, this list contains one element.")
288 (defvar dired-switches-alist nil
289 "Keeps track of which switches to use for inserted subdirectories.
290 This is an alist of the form (SUBDIR . SWITCHES).")
291 (make-variable-buffer-local 'dired-switches-alist
)
293 (defvaralias 'dired-move-to-filename-regexp
294 'directory-listing-before-filename-regexp
)
296 (defvar dired-subdir-regexp
"^. \\([^\n\r]+\\)\\(:\\)[\n\r]"
297 "Regexp matching a maybe hidden subdirectory line in `ls -lR' output.
298 Subexpression 1 is the subdirectory proper, no trailing colon.
299 The match starts at the beginning of the line and ends after the end
300 of the line (\\n or \\r).
301 Subexpression 2 must end right before the \\n or \\r.")
303 (defgroup dired-faces nil
304 "Faces used by Dired."
308 (defface dired-header
309 '((t (:inherit font-lock-type-face
)))
310 "Face used for directory headers."
313 (defvar dired-header-face
'dired-header
314 "Face name used for directory headers.")
317 '((t (:inherit font-lock-constant-face
)))
318 "Face used for dired marks."
321 (defvar dired-mark-face
'dired-mark
322 "Face name used for dired marks.")
324 (defface dired-marked
325 '((t (:inherit font-lock-warning-face
)))
326 "Face used for marked files."
329 (defvar dired-marked-face
'dired-marked
330 "Face name used for marked files.")
332 (defface dired-flagged
333 '((t (:inherit font-lock-warning-face
)))
334 "Face used for flagged files."
337 (defvar dired-flagged-face
'dired-flagged
338 "Face name used for flagged files.")
340 (defface dired-warning
341 ;; Inherit from font-lock-warning-face since with min-colors 8
342 ;; font-lock-comment-face is not colored any more.
343 '((t (:inherit font-lock-warning-face
)))
344 "Face used to highlight a part of a buffer that needs user attention."
347 (defvar dired-warning-face
'dired-warning
348 "Face name used for a part of a buffer that needs user attention.")
350 (defface dired-perm-write
351 '((((type w32 pc
)) :inherit default
) ;; These default to rw-rw-rw.
352 ;; Inherit from font-lock-comment-delimiter-face since with min-colors 8
353 ;; font-lock-comment-face is not colored any more.
354 (t (:inherit font-lock-comment-delimiter-face
)))
355 "Face used to highlight permissions of group- and world-writable files."
358 (defvar dired-perm-write-face
'dired-perm-write
359 "Face name used for permissions of group- and world-writable files.")
361 (defface dired-directory
362 '((t (:inherit font-lock-function-name-face
)))
363 "Face used for subdirectories."
366 (defvar dired-directory-face
'dired-directory
367 "Face name used for subdirectories.")
369 (defface dired-symlink
370 '((t (:inherit font-lock-keyword-face
)))
371 "Face used for symbolic links."
374 (defvar dired-symlink-face
'dired-symlink
375 "Face name used for symbolic links.")
377 (defface dired-ignored
378 '((t (:inherit shadow
)))
379 "Face used for files suffixed with `completion-ignored-extensions'."
382 (defvar dired-ignored-face
'dired-ignored
383 "Face name used for files suffixed with `completion-ignored-extensions'.")
385 (defvar dired-font-lock-keywords
389 (list dired-re-mark
'(0 dired-mark-face
))
391 ;; We make heavy use of MATCH-ANCHORED, since the regexps don't identify the
392 ;; file name itself. We search for Dired defined regexps, and then use the
393 ;; Dired defined function `dired-move-to-filename' before searching for the
394 ;; simple regexp ".+". It is that regexp which matches the file name.
397 (list (concat "^[" (char-to-string dired-marker-char
) "]")
398 '(".+" (dired-move-to-filename) nil
(0 dired-marked-face
)))
401 (list (concat "^[" (char-to-string dired-del-marker
) "]")
402 '(".+" (dired-move-to-filename) nil
(0 dired-flagged-face
)))
403 ;; People who are paranoid about security would consider this more
404 ;; important than other things such as whether it is a directory.
405 ;; But we don't want to encourage paranoia, so our default
406 ;; should be what's most useful for non-paranoids. -- rms.
408 ;;; ;; Files that are group or world writable.
409 ;;; (list (concat dired-re-maybe-mark dired-re-inode-size
410 ;;; "\\([-d]\\(....w....\\|.......w.\\)\\)")
411 ;;; '(1 dired-warning-face)
412 ;;; '(".+" (dired-move-to-filename) nil (0 dired-warning-face)))
413 ;; However, we don't need to highlight the file name, only the
414 ;; permissions, to win generally. -- fx.
415 ;; Fixme: we could also put text properties on the permission
416 ;; fields with keymaps to frob the permissions, somewhat a la XEmacs.
417 (list (concat dired-re-maybe-mark dired-re-inode-size
418 "[-d]....\\(w\\)....") ; group writable
419 '(1 dired-perm-write-face
))
420 (list (concat dired-re-maybe-mark dired-re-inode-size
421 "[-d].......\\(w\\).") ; world writable
422 '(1 dired-perm-write-face
))
426 '(".+" (dired-move-to-filename) nil
(0 dired-directory-face
)))
430 '(".+" (dired-move-to-filename) nil
(0 dired-symlink-face
)))
432 ;; Files suffixed with `completion-ignored-extensions'.
434 ;; It is quicker to first find just an extension, then go back to the
435 ;; start of that file name. So we do this complex MATCH-ANCHORED form.
436 (list (concat "\\(" (regexp-opt completion-ignored-extensions
) "\\|#\\)$")
437 '(".+" (dired-move-to-filename) nil
(0 dired-ignored-face
))))
439 ;; Files suffixed with `completion-ignored-extensions'
440 ;; plus a character put in by -F.
442 (list (concat "\\(" (regexp-opt completion-ignored-extensions
)
446 ;; If the last character is not part of the filename,
447 ;; move back to the start of the filename
448 ;; so it can be fontified.
449 ;; Otherwise, leave point at the end of the line;
450 ;; that way, nothing is fontified.
451 (unless (get-text-property (1- (point)) 'mouse-face
)
452 (dired-move-to-filename)))
453 nil
(0 dired-ignored-face
))))
455 ;; Explicitly put the default face on file names ending in a colon to
456 ;; avoid fontifying them as directory header.
457 (list (concat dired-re-maybe-mark dired-re-inode-size dired-re-perms
".*:$")
458 '(".+" (dired-move-to-filename) nil
(0 'default
)))
460 ;; Directory headers.
461 (list dired-subdir-regexp
'(1 dired-header-face
))
463 "Additional expressions to highlight in Dired mode.")
465 (defvar dnd-protocol-alist
)
467 ;;; Macros must be defined before they are used, for the byte compiler.
469 (defmacro dired-mark-if
(predicate msg
)
470 "Mark all files for which PREDICATE evals to non-nil.
471 PREDICATE is evaluated on each line, with point at beginning of line.
472 MSG is a noun phrase for the type of files being marked.
473 It should end with a noun that can be pluralized by adding `s'.
474 Return value is the number of files marked, or nil if none were marked."
475 `(let ((inhibit-read-only t
) count
)
478 (if ,msg
(message "Marking %ss..." ,msg
))
479 (goto-char (point-min))
484 (insert dired-marker-char
)
485 (setq count
(1+ count
))))
487 (if ,msg
(message "%s %s%s %s%s."
490 (dired-plural-s count
)
491 (if (eq dired-marker-char ?
\040) "un" "")
492 (if (eq dired-marker-char dired-del-marker
)
493 "flagged" "marked"))))
494 (and (> count
0) count
)))
496 (defmacro dired-map-over-marks
(body arg
&optional show-progress
497 distinguish-one-marked
)
498 "Eval BODY with point on each marked line. Return a list of BODY's results.
499 If no marked file could be found, execute BODY on the current line.
500 ARG, if non-nil, specifies the files to use instead of the marked files.
501 If ARG is an integer, use the next ARG (or previous -ARG, if
502 ARG<0) files. In that case, point is dragged along. This is
503 so that commands on the next ARG (instead of the marked) files
504 can be chained easily.
505 For any other non-nil value of ARG, use the current file.
506 If optional third arg SHOW-PROGRESS evaluates to non-nil,
507 redisplay the dired buffer after each file is processed.
508 No guarantee is made about the position on the marked line.
509 BODY must ensure this itself if it depends on this.
510 Search starts at the beginning of the buffer, thus the car of the list
511 corresponds to the line nearest to the buffer's bottom. This
512 is also true for (positive and negative) integer values of ARG.
513 BODY should not be too long as it is expanded four times.
515 If DISTINGUISH-ONE-MARKED is non-nil, then if we find just one marked file,
516 return (t FILENAME) instead of (FILENAME)."
518 ;;Warning: BODY must not add new lines before point - this may cause an
520 ;;This warning should not apply any longer, sk 2-Sep-1991 14:10.
522 (let ((inhibit-read-only t
) case-fold-search found results
)
525 (progn ;; no save-excursion, want to move point.
526 (dired-repeat-over-lines
529 (if ,show-progress
(sit-for 0))
530 (setq results
(cons ,body results
)))))
534 ;; non-nil, non-integer ARG means use current file:
536 (let ((regexp (dired-marker-regexp)) next-position
)
538 (goto-char (point-min))
539 ;; remember position of next marked file before BODY
540 ;; can insert lines before the just found file,
541 ;; confusing us by finding the same marked file again
543 (setq next-position
(and (re-search-forward regexp nil t
)
545 found
(not (null next-position
)))
547 (goto-char next-position
)
548 (if ,show-progress
(sit-for 0))
549 (setq results
(cons ,body results
))
550 ;; move after last match
551 (goto-char next-position
)
553 (set-marker next-position nil
)
554 (setq next-position
(and (re-search-forward regexp nil t
)
556 (if (and ,distinguish-one-marked
(= (length results
) 1))
557 (setq results
(cons t results
)))
561 ;; save-excursion loses, again
562 (dired-move-to-filename)))
564 (defun dired-get-marked-files (&optional localp arg filter distinguish-one-marked
)
565 "Return the marked files' names as list of strings.
566 The list is in the same order as the buffer, that is, the car is the
568 Values returned are normally absolute file names.
569 Optional arg LOCALP as in `dired-get-filename'.
570 Optional second argument ARG, if non-nil, specifies files near
571 point instead of marked files. It usually comes from the prefix
573 If ARG is an integer, use the next ARG files.
574 Any other non-nil value means to use the current file instead.
575 Optional third argument FILTER, if non-nil, is a function to select
576 some of the files--those for which (funcall FILTER FILENAME) is non-nil.
578 If DISTINGUISH-ONE-MARKED is non-nil, then if we find just one marked file,
579 return (t FILENAME) instead of (FILENAME).
580 Don't use that together with FILTER."
583 (dired-map-over-marks
584 (dired-get-filename localp
)
585 arg nil distinguish-one-marked
)))
588 (if (and distinguish-one-marked
(eq (car all-of-them
) t
))
590 (nreverse all-of-them
))
591 (dolist (file all-of-them
)
592 (if (funcall filter file
)
598 (defun dired-read-dir-and-switches (str)
599 ;; For use in interactive.
601 (if current-prefix-arg
602 (read-string "Dired listing switches: "
603 dired-listing-switches
))
604 ;; If a dialog is about to be used, call read-directory-name so
605 ;; the dialog code knows we want directories. Some dialogs can
606 ;; only select directories or files when popped up, not both.
607 (if (next-read-file-uses-dialog-p)
608 (read-directory-name (format "Dired %s(directory): " str
)
609 nil default-directory nil
)
610 (read-file-name (format "Dired %s(directory): " str
)
611 nil default-directory nil
)))))
613 ;; We want to switch to a more sophisticated version of
614 ;; dired-read-dir-and-switches like the following, if there is a way
615 ;; to make it more intuitive. See bug#1285.
617 ;; (defun dired-read-dir-and-switches (str)
618 ;; ;; For use in interactive.
621 ;; (if current-prefix-arg
622 ;; (read-string "Dired listing switches: "
623 ;; dired-listing-switches))
624 ;; ;; If a dialog is about to be used, call read-directory-name so
625 ;; ;; the dialog code knows we want directories. Some dialogs can
626 ;; ;; only select directories or files when popped up, not both.
627 ;; (if (next-read-file-uses-dialog-p)
628 ;; (read-directory-name (format "Dired %s(directory): " str)
629 ;; nil default-directory nil)
631 ;; (dolist (ext completion-ignored-extensions)
632 ;; (if (eq ?/ (aref ext (1- (length ext)))) (push ext cie)))
633 ;; (setq cie (concat (regexp-opt cie "\\(?:") "\\'"))
634 ;; (lexical-let* ((default (and buffer-file-name
635 ;; (abbreviate-file-name buffer-file-name)))
638 ;; ;; We need a mix of read-file-name and
639 ;; ;; read-directory-name so that completion to directories
640 ;; ;; is preferred, but if the user wants to enter a global
641 ;; ;; pattern, he can still use completion on filenames to
642 ;; ;; help him write the pattern.
643 ;; ;; Essentially, we want to use
644 ;; ;; (completion-table-with-predicate
645 ;; ;; 'read-file-name-internal 'file-directory-p nil)
646 ;; ;; but that doesn't work because read-file-name-internal
647 ;; ;; does not obey its `predicate' argument.
648 ;; (completion-table-in-turn
649 ;; (lambda (str pred action)
650 ;; (let ((read-file-name-predicate
652 ;; (and (not (member f '("./" "../")))
653 ;; ;; Hack! Faster than file-directory-p!
654 ;; (eq (aref f (1- (length f))) ?/)
655 ;; (not (string-match cie f))))))
656 ;; (complete-with-action
657 ;; action 'read-file-name-internal str nil)))
658 ;; 'read-file-name-internal)))
659 ;; (minibuffer-with-setup-hook
661 ;; (setq minibuffer-default default)
662 ;; (setq minibuffer-completion-table completion-table))
663 ;; (read-file-name (format "Dired %s(directory): " str)
664 ;; nil default-directory nil))))))))
666 (defun dired-file-name-at-point ()
667 "Try to get a file name at point in the current dired buffer.
668 This hook is inteneded to be put in `file-name-at-point-functions'."
669 (let ((filename (dired-get-filename nil t
)))
671 (if (file-directory-p filename
)
672 (file-name-as-directory (abbreviate-file-name filename
))
673 (abbreviate-file-name filename
)))))
675 ;;;###autoload (define-key ctl-x-map "d" 'dired)
677 (defun dired (dirname &optional switches
)
678 "\"Edit\" directory DIRNAME--delete, rename, print, etc. some files in it.
679 Optional second argument SWITCHES specifies the `ls' options used.
680 \(Interactively, use a prefix argument to be able to specify SWITCHES.)
681 Dired displays a list of files in DIRNAME (which may also have
682 shell wildcards appended to select certain files). If DIRNAME is a cons,
683 its first element is taken as the directory name and the rest as an explicit
684 list of files to make directory entries for.
686 You can move around in it with the usual commands.
687 You can flag files for deletion with \\[dired-flag-file-deletion] and then
688 delete them by typing \\[dired-do-flagged-delete].
689 Type \\[describe-mode] after entering Dired for more info.
691 If DIRNAME is already in a dired buffer, that buffer is used without refresh."
692 ;; Cannot use (interactive "D") because of wildcards.
693 (interactive (dired-read-dir-and-switches ""))
694 (switch-to-buffer (dired-noselect dirname switches
)))
696 ;;;###autoload (define-key ctl-x-4-map "d" 'dired-other-window)
698 (defun dired-other-window (dirname &optional switches
)
699 "\"Edit\" directory DIRNAME. Like `dired' but selects in another window."
700 (interactive (dired-read-dir-and-switches "in other window "))
701 (switch-to-buffer-other-window (dired-noselect dirname switches
)))
703 ;;;###autoload (define-key ctl-x-5-map "d" 'dired-other-frame)
705 (defun dired-other-frame (dirname &optional switches
)
706 "\"Edit\" directory DIRNAME. Like `dired' but makes a new frame."
707 (interactive (dired-read-dir-and-switches "in other frame "))
708 (switch-to-buffer-other-frame (dired-noselect dirname switches
)))
711 (defun dired-noselect (dir-or-list &optional switches
)
712 "Like `dired' but returns the dired buffer as value, does not select it."
713 (or dir-or-list
(setq dir-or-list default-directory
))
714 ;; This loses the distinction between "/foo/*/" and "/foo/*" that
716 (let (dirname initially-was-dirname
)
717 (if (consp dir-or-list
)
718 (setq dirname
(car dir-or-list
))
719 (setq dirname dir-or-list
))
720 (setq initially-was-dirname
721 (string= (file-name-as-directory dirname
) dirname
))
722 (setq dirname
(abbreviate-file-name
723 (expand-file-name (directory-file-name dirname
))))
724 (if find-file-visit-truename
725 (setq dirname
(file-truename dirname
)))
726 ;; If the argument was syntactically a directory name not a file name,
727 ;; or if it happens to name a file that is a directory,
728 ;; convert it syntactically to a directory name.
729 ;; The reason for checking initially-was-dirname
730 ;; and not just file-directory-p
731 ;; is that file-directory-p is slow over ftp.
732 (if (or initially-was-dirname
(file-directory-p dirname
))
733 (setq dirname
(file-name-as-directory dirname
)))
734 (if (consp dir-or-list
)
735 (setq dir-or-list
(cons dirname
(cdr dir-or-list
)))
736 (setq dir-or-list dirname
))
737 (dired-internal-noselect dir-or-list switches
)))
739 ;; The following is an internal dired function. It returns non-nil if
740 ;; the directory visited by the current dired buffer has changed on
741 ;; disk. DIRNAME should be the directory name of that directory.
742 (defun dired-directory-changed-p (dirname)
743 (not (let ((attributes (file-attributes dirname
))
744 (modtime (visited-file-modtime)))
746 (not (eq (car attributes
) t
))
747 (equal (nth 5 attributes
) modtime
)))))
749 (defun dired-buffer-stale-p (&optional noconfirm
)
750 "Return non-nil if current dired buffer needs updating.
751 If NOCONFIRM is non-nil, then this function always returns nil
752 for a remote directory. This feature is used by Auto Revert Mode."
754 (if (consp dired-directory
) (car dired-directory
) dired-directory
)))
755 (and (stringp dirname
)
756 (not (when noconfirm
(file-remote-p dirname
)))
757 (file-readable-p dirname
)
758 ;; Do not auto-revert when the dired buffer can be currently
759 ;; written by the user as in `wdired-mode'.
761 (dired-directory-changed-p dirname
))))
763 (defcustom dired-auto-revert-buffer nil
764 "Automatically revert dired buffer on revisiting.
765 If t, revisiting an existing dired buffer automatically reverts it.
766 If its value is a function, call this function with the directory
767 name as single argument and revert the buffer if it returns non-nil.
768 Otherwise, a message offering to revert the changed dired buffer
770 Note that this is not the same as `auto-revert-mode' that
771 periodically reverts at specified time intervals."
773 (const :tag
"Don't revert" nil
)
774 (const :tag
"Always revert visited dired buffer" t
)
775 (const :tag
"Revert changed dired buffer" dired-directory-changed-p
)
776 (function :tag
"Predicate function"))
780 (defun dired-internal-noselect (dir-or-list &optional switches mode
)
781 ;; If there is an existing dired buffer for DIRNAME, just leave
782 ;; buffer as it is (don't even call dired-revert).
783 ;; This saves time especially for deep trees or with ange-ftp.
784 ;; The user can type `g' easily, and it is more consistent with find-file.
785 ;; But if SWITCHES are given they are probably different from the
786 ;; buffer's old value, so call dired-sort-other, which does
787 ;; revert the buffer.
788 ;; A pity we can't possibly do "Directory has changed - refresh? "
789 ;; like find-file does.
790 ;; Optional argument MODE is passed to dired-find-buffer-nocreate,
792 (let* ((old-buf (current-buffer))
793 (dirname (if (consp dir-or-list
) (car dir-or-list
) dir-or-list
))
794 ;; Look for an existing buffer.
795 (buffer (dired-find-buffer-nocreate dirname mode
))
796 ;; Note that buffer already is in dired-mode, if found.
797 (new-buffer-p (null buffer
)))
799 (setq buffer
(create-file-buffer (directory-file-name dirname
))))
801 (if (not new-buffer-p
) ; existing buffer ...
802 (cond (switches ; ... but new switches
803 ;; file list may have changed
804 (setq dired-directory dir-or-list
)
805 ;; this calls dired-revert
806 (dired-sort-other switches
))
807 ;; Always revert regardless of whether it has changed or not.
808 ((eq dired-auto-revert-buffer t
)
810 ;; Revert when predicate function returns non-nil.
811 ((functionp dired-auto-revert-buffer
)
812 (when (funcall dired-auto-revert-buffer dirname
)
814 (message "Changed directory automatically updated")))
815 ;; If directory has changed on disk, offer to revert.
816 ((when (dired-directory-changed-p dirname
)
818 (substitute-command-keys
819 "Directory has changed on disk; type \\[revert-buffer] to update Dired")))))
821 (setq default-directory
822 ;; We can do this unconditionally
823 ;; because dired-noselect ensures that the name
824 ;; is passed in directory name syntax
825 ;; if it was the name of a directory at all.
826 (file-name-directory dirname
))
827 (or switches
(setq switches dired-listing-switches
))
828 (if mode
(funcall mode
)
829 (dired-mode dir-or-list switches
))
830 ;; default-directory and dired-actual-switches are set now
831 ;; (buffer-local), so we can call dired-readin:
834 (progn (dired-readin)
836 ;; dired-readin can fail if parent directories are inaccessible.
837 ;; Don't leave an empty buffer around in that case.
838 (if failed
(kill-buffer buffer
))))
839 (goto-char (point-min))
840 (dired-initial-position dirname
))
844 (defvar dired-buffers nil
845 ;; Enlarged by dired-advertise
846 ;; Queried by function dired-buffers-for-dir. When this detects a
847 ;; killed buffer, it is removed from this list.
848 "Alist of expanded directories and their associated dired buffers.")
850 (defun dired-find-buffer-nocreate (dirname &optional mode
)
851 ;; This differs from dired-buffers-for-dir in that it does not consider
852 ;; subdirs of default-directory and searches for the first match only.
853 ;; Also, the major mode must be MODE.
854 (setq dirname
(expand-file-name dirname
))
855 (let (found (blist dired-buffers
)) ; was (buffer-list)
856 (or mode
(setq mode
'dired-mode
))
858 (if (null (buffer-name (cdr (car blist
))))
859 (setq blist
(cdr blist
))
860 (with-current-buffer (cdr (car blist
))
861 (if (and (eq major-mode mode
)
862 dired-directory
;; nil during find-alternate-file
865 (if (consp dired-directory
)
866 (car dired-directory
)
868 (setq found
(cdr (car blist
))
870 (setq blist
(cdr blist
))))))
874 ;; Read in a new dired buffer
876 (defun dired-readin ()
877 "Read in a new dired buffer.
878 Differs from `dired-insert-subdir' in that it accepts
879 wildcards, erases the buffer, and builds the subdir-alist anew
880 \(including making it buffer-local and clearing it first)."
882 ;; default-directory and dired-actual-switches must be buffer-local
883 ;; and initialized by now.
885 ;; This makes readin much much faster.
886 ;; In particular, it prevents the font lock hook from running
887 ;; until the directory is all read in.
888 (inhibit-modification-hooks t
))
889 (if (consp dired-directory
)
890 (setq dirname
(car dired-directory
))
891 (setq dirname dired-directory
))
892 (setq dirname
(expand-file-name dirname
))
894 ;; This hook which may want to modify dired-actual-switches
895 ;; based on dired-directory, e.g. with ange-ftp to a SysV host
896 ;; where ls won't understand -Al switches.
897 (run-hooks 'dired-before-readin-hook
)
898 (if (consp buffer-undo-list
)
899 (setq buffer-undo-list nil
))
900 (make-local-variable 'file-name-coding-system
)
901 (setq file-name-coding-system
902 (or coding-system-for-read file-name-coding-system
))
903 (let ((inhibit-read-only t
)
904 ;; Don't make undo entries for readin.
905 (buffer-undo-list t
))
908 (dired-readin-insert))
909 (goto-char (point-min))
910 ;; Must first make alist buffer local and set it to nil because
911 ;; dired-build-subdir-alist will call dired-clear-alist first
912 (set (make-local-variable 'dired-subdir-alist
) nil
)
913 (dired-build-subdir-alist)
914 (let ((attributes (file-attributes dirname
)))
915 (if (eq (car attributes
) t
)
916 (set-visited-file-modtime (nth 5 attributes
))))
917 (set-buffer-modified-p nil
)
918 ;; No need to narrow since the whole buffer contains just
919 ;; dired-readin's output, nothing else. The hook can
920 ;; successfully use dired functions (e.g. dired-get-filename)
921 ;; as the subdir-alist has been built in dired-readin.
922 (run-hooks 'dired-after-readin-hook
))))
924 ;; Subroutines of dired-readin
926 (defun dired-readin-insert ()
927 ;; Insert listing for the specified dir (and maybe file list)
928 ;; already in dired-directory, assuming a clean buffer.
930 (if (consp dired-directory
)
931 (setq dir
(car dired-directory
)
932 file-list
(cdr dired-directory
))
933 (setq dir dired-directory
935 (setq dir
(expand-file-name dir
))
936 (if (and (equal "" (file-name-nondirectory dir
))
938 ;; If we are reading a whole single directory...
939 (dired-insert-directory dir dired-actual-switches nil nil t
)
940 (if (not (file-readable-p
941 (directory-file-name (file-name-directory dir
))))
942 (error "Directory %s inaccessible or nonexistent" dir
)
943 ;; Else treat it as a wildcard spec
944 ;; unless we have an explicit list of files.
945 (dired-insert-directory dir dired-actual-switches
946 file-list
(not file-list
) t
)))))
948 (defun dired-align-file (beg end
)
949 "Align the fields of a file to the ones of surrounding lines.
950 BEG..END is the line where the file info is located."
951 ;; Some versions of ls try to adjust the size of each field so as to just
952 ;; hold the largest element ("largest" in the current invocation, of
953 ;; course). So when a single line is output, the size of each field is
954 ;; just big enough for that one output. Thus when dired refreshes one
955 ;; line, the alignment if this line w.r.t the rest is messed up because
956 ;; the fields of that one line will generally be smaller.
958 ;; To work around this problem, we here add spaces to try and
959 ;; re-align the fields as needed. Since this is purely aesthetic,
960 ;; it is of utmost importance that it doesn't mess up anything like
961 ;; `dired-move-to-filename'. To this end, we limit ourselves to
962 ;; adding spaces only, and to only add them at places where there
963 ;; was already at least one space. This way, as long as
964 ;; `directory-listing-before-filename-regexp' always matches spaces
965 ;; with "*" or "+", we know we haven't made anything worse. There
966 ;; is one spot where the exact number of spaces is important, which
967 ;; is just before the actual filename, so we refrain from adding
968 ;; spaces there (and within the filename as well, of course).
970 (let (file file-col other other-col
)
971 ;; Check that there is indeed a file, and that there is anoter adjacent
972 ;; file with which to align, and that additional spaces are needed to
973 ;; align the filenames.
974 (when (and (setq file
(progn (goto-char beg
)
975 (dired-move-to-filename nil end
)))
976 (setq file-col
(current-column))
978 (or (and (goto-char beg
)
979 (zerop (forward-line -
1))
980 (dired-move-to-filename))
982 (zerop (forward-line 1))
983 (dired-move-to-filename))))
984 (setq other-col
(current-column))
986 ;; Make sure there is some work left to do.
987 (> other-col file-col
))
988 ;; If we've only looked at the line above, check to see if the line
989 ;; below exists as well and if so, align with the shorter one.
990 (when (and (< other file
)
992 (zerop (forward-line 1))
993 (dired-move-to-filename))
994 (let ((alt-col (current-column)))
995 (when (< alt-col other-col
)
996 (setq other-col alt-col
)
997 (setq other
(point)))))
998 ;; Keep positions uptodate when we insert stuff.
999 (if (> other file
) (setq other
(copy-marker other
)))
1000 (setq file
(copy-marker file
))
1003 (skip-chars-forward " ") ;Skip to the first field.
1004 (while (and (> other-col file-col
)
1005 ;; Don't touch anything just before (and after) the
1006 ;; beginning of the filename.
1008 ;; We're now just in front of a field, with a space behind us.
1009 (let* ((curcol (current-column))
1010 ;; Nums are right-aligned.
1011 (num-align (looking-at "[0-9]"))
1012 ;; Let's look at the other line, in the same column: we
1013 ;; should be either near the end of the previous field, or
1014 ;; in the space between that field and the next.
1015 ;; [ Of course, it's also possible that we're already within
1016 ;; the next field or even past it, but that's unlikely since
1017 ;; other-col > file-col. ]
1018 ;; Let's find the distance to the alignment-point (either
1019 ;; the beginning or the end of the next field, depending on
1020 ;; whether this field is left or right aligned).
1024 (move-to-column curcol
)
1027 (if (eq (char-before) ?\s
) " *" "[^ ]* *")
1028 (if num-align
"[0-9][^ ]*")))
1029 (- (match-end 0) (match-beginning 0)))))
1030 ;; Now, the number of spaces to insert is align-pt-offset
1031 ;; minus the distance to the equivalent point on the
1036 (and align-pt-offset
1038 (skip-chars-forward "^ ")
1039 (- align-pt-offset
(- (current-column) curcol
)))))))
1040 (when (and spaces
(> spaces
0))
1041 (setq file-col
(+ spaces file-col
))
1042 (if (> file-col other-col
)
1043 (setq spaces
(- spaces
(- file-col other-col
))))
1044 (insert-char ?\s spaces
)
1045 ;; Let's just make really sure we did not mess up.
1046 (unless (save-excursion
1047 (eq (dired-move-to-filename) (marker-position file
)))
1048 ;; Damn! We messed up: let's revert the change.
1049 (delete-char (- spaces
)))))
1050 ;; Now skip to next field.
1051 (skip-chars-forward "^ ") (skip-chars-forward " "))
1052 (set-marker file nil
)))))
1055 (defvar ls-lisp-use-insert-directory-program
)
1057 (defun dired-insert-directory (dir switches
&optional file-list wildcard hdr
)
1058 "Insert a directory listing of DIR, Dired style.
1059 Use SWITCHES to make the listings.
1060 If FILE-LIST is non-nil, list only those files.
1061 Otherwise, if WILDCARD is non-nil, expand wildcards;
1062 in that case, DIR should be a file name that uses wildcards.
1063 In other cases, DIR should be a directory name or a directory filename.
1064 If HDR is non-nil, insert a header line with the directory name."
1065 (let ((opoint (point))
1066 (process-environment (copy-sequence process-environment
))
1069 ;; Don't try to invoke `ls' if we are on DOS/Windows where
1070 ;; ls-lisp emulation is used, except if they want to use `ls'
1071 ;; as indicated by `ls-lisp-use-insert-directory-program'.
1072 (not (and (featurep 'ls-lisp
)
1073 (null ls-lisp-use-insert-directory-program
)))
1074 (or (if (eq dired-use-ls-dired
'unspecified
)
1075 ;; Check whether "ls --dired" gives exit code 0, and
1076 ;; save the answer in `dired-use-ls-dired'.
1077 (setq dired-use-ls-dired
1078 (eq (call-process insert-directory-program nil nil nil
"--dired")
1081 (file-remote-p dir
)))
1082 (setq switches
(concat "--dired " switches
)))
1083 ;; We used to specify the C locale here, to force English month names;
1084 ;; but this should not be necessary any more,
1085 ;; with the new value of `directory-listing-before-filename-regexp'.
1087 (dolist (f file-list
)
1088 (let ((beg (point)))
1089 (insert-directory f switches nil nil
)
1090 ;; Re-align fields, if necessary.
1091 (dired-align-file beg
(point))))
1092 (insert-directory dir switches wildcard
(not wildcard
)))
1093 ;; Quote certain characters, unless ls quoted them for us.
1094 (if (not (string-match "b" dired-actual-switches
))
1096 (setq end
(point-marker))
1098 (while (search-forward "\\" end t
)
1099 (replace-match (apply #'propertize
1101 (text-properties-at (match-beginning 0)))
1104 (while (search-forward "\^m" end t
)
1105 (replace-match (apply #'propertize
1107 (text-properties-at (match-beginning 0)))
1109 (set-marker end nil
)))
1110 (dired-insert-set-properties opoint
(point))
1111 ;; If we used --dired and it worked, the lines are already indented.
1112 ;; Otherwise, indent them.
1113 (unless (save-excursion
1116 (let ((indent-tabs-mode nil
))
1117 (indent-rigidly opoint
(point) 2)))
1118 ;; Insert text at the beginning to standardize things.
1121 (if (and (or hdr wildcard
)
1122 (not (and (looking-at "^ \\(.*\\):$")
1123 (file-name-absolute-p (match-string 1)))))
1124 ;; Note that dired-build-subdir-alist will replace the name
1125 ;; by its expansion, so it does not matter whether what we insert
1126 ;; here is fully expanded, but it should be absolute.
1127 (insert " " (directory-file-name (file-name-directory dir
)) ":\n"))
1129 ;; Insert "wildcard" line where "total" line would be for a full dir.
1130 (insert " wildcard " (file-name-nondirectory dir
) "\n")))))
1132 (defun dired-insert-set-properties (beg end
)
1133 "Make the file names highlight when the mouse is on them."
1136 (while (< (point) end
)
1138 (if (dired-move-to-filename)
1139 (add-text-properties
1142 (dired-move-to-end-of-filename)
1144 '(mouse-face highlight
1146 help-echo
"mouse-2: visit this file in other window")))
1150 ;; Reverting a dired buffer
1152 (defun dired-revert (&optional arg noconfirm
)
1153 "Reread the dired buffer.
1154 Must also be called after `dired-actual-switches' have changed.
1155 Should not fail even on completely garbaged buffers.
1156 Preserves old cursor, marks/flags, hidden-p.
1158 Dired sets `revert-buffer-function' to this function. The args
1159 ARG and NOCONFIRM, passed from `revert-buffer', are ignored."
1160 (widen) ; just in case user narrowed
1161 (let ((modflag (buffer-modified-p))
1162 (positions (dired-save-positions))
1163 (mark-alist nil
) ; save marked files
1164 (hidden-subdirs (dired-remember-hidden))
1165 (old-subdir-alist (cdr (reverse dired-subdir-alist
))) ; except pwd
1166 (case-fold-search nil
) ; we check for upper case ls flags
1167 (inhibit-read-only t
))
1168 (goto-char (point-min))
1169 (setq mark-alist
;; only after dired-remember-hidden since this unhides:
1170 (dired-remember-marks (point-min) (point-max)))
1171 ;; treat top level dir extra (it may contain wildcards)
1172 (if (not (consp dired-directory
))
1173 (dired-uncache dired-directory
)
1174 (dired-uncache (car dired-directory
))
1175 (dolist (dir (cdr dired-directory
))
1176 (if (file-name-absolute-p dir
)
1177 (dired-uncache dir
))))
1178 ;; Run dired-after-readin-hook just once, below.
1179 (let ((dired-after-readin-hook nil
))
1181 (dired-insert-old-subdirs old-subdir-alist
))
1182 (dired-mark-remembered mark-alist
) ; mark files that were marked
1183 ;; ... run the hook for the whole buffer, and only after markers
1184 ;; have been reinserted (else omitting in dired-x would omit marked files)
1185 (run-hooks 'dired-after-readin-hook
) ; no need to narrow
1186 (dired-restore-positions positions
)
1187 (save-excursion ; hide subdirs that were hidden
1188 (dolist (dir hidden-subdirs
)
1189 (if (dired-goto-subdir dir
)
1190 (dired-hide-subdir 1))))
1191 (unless modflag
(restore-buffer-modified-p nil
)))
1192 ;; outside of the let scope
1193 ;;; Might as well not override the user if the user changed this.
1194 ;;; (setq buffer-read-only t)
1197 ;; Subroutines of dired-revert
1198 ;; Some of these are also used when inserting subdirs.
1200 (defun dired-save-positions ()
1201 "Return current positions in the buffer and all windows with this directory.
1202 The positions have the form (BUFFER-POSITION WINDOW-POSITIONS).
1204 BUFFER-POSITION is the point position in the current dired buffer.
1205 It has the form (BUFFER DIRED-FILENAME BUFFER-POINT).
1207 WINDOW-POSITIONS are current positions in all windows displaying
1208 this dired buffer. The window positions have the form (WINDOW
1209 DIRED-FILENAME WINDOW-POINT)."
1211 (list (current-buffer) (dired-get-filename nil t
) (point))
1214 (with-selected-window w
1215 (dired-get-filename nil t
))
1217 (get-buffer-window-list nil
0 t
))))
1219 (defun dired-restore-positions (positions)
1220 "Restore POSITIONS saved with `dired-save-positions'."
1221 (let* ((buf-file-pos (nth 0 positions
))
1222 (buffer (nth 0 buf-file-pos
)))
1223 (unless (and (nth 1 buf-file-pos
)
1224 (dired-goto-file (nth 1 buf-file-pos
)))
1225 (goto-char (nth 2 buf-file-pos
))
1226 (dired-move-to-filename))
1227 (dolist (win-file-pos (nth 1 positions
))
1228 ;; Ensure that window still displays the original buffer.
1229 (when (eq (window-buffer (nth 0 win-file-pos
)) buffer
)
1230 (with-selected-window (nth 0 win-file-pos
)
1231 (unless (and (nth 1 win-file-pos
)
1232 (dired-goto-file (nth 1 win-file-pos
)))
1233 (goto-char (nth 2 win-file-pos
))
1234 (dired-move-to-filename)))))))
1236 (defun dired-remember-marks (beg end
)
1237 "Return alist of files and their marks, from BEG to END."
1238 (if selective-display
; must unhide to make this work.
1239 (let ((inhibit-read-only t
))
1240 (subst-char-in-region beg end ?
\r ?
\n)))
1241 (let (fil chr alist
)
1244 (while (re-search-forward dired-re-mark end t
)
1245 (if (setq fil
(dired-get-filename nil t
))
1246 (setq chr
(preceding-char)
1247 alist
(cons (cons fil chr
) alist
)))))
1250 (defun dired-mark-remembered (alist)
1251 "Mark all files remembered in ALIST.
1252 Each element of ALIST looks like (FILE . MARKERCHAR)."
1255 (setq elt
(car alist
)
1259 (if (dired-goto-file fil
)
1265 (defun dired-remember-hidden ()
1266 "Return a list of names of subdirs currently hidden."
1267 (let ((l dired-subdir-alist
) dir pos result
)
1269 (setq dir
(car (car l
))
1273 (skip-chars-forward "^\r\n")
1274 (if (eq (following-char) ?
\r)
1275 (setq result
(cons dir result
))))
1278 (defun dired-insert-old-subdirs (old-subdir-alist)
1279 "Try to insert all subdirs that were displayed before.
1280 Do so according to the former subdir alist OLD-SUBDIR-ALIST."
1281 (or (string-match "R" dired-actual-switches
)
1283 (while old-subdir-alist
1284 (setq elt
(car old-subdir-alist
)
1285 old-subdir-alist
(cdr old-subdir-alist
)
1290 (dired-insert-subdir dir
))
1293 (defun dired-uncache (dir)
1294 "Remove directory DIR from any directory cache."
1295 (let ((handler (find-file-name-handler dir
'dired-uncache
)))
1297 (funcall handler
'dired-uncache dir
))))
1299 ;; dired mode key bindings and initialization
1301 (defvar dired-mode-map
1302 ;; This looks ugly when substitute-command-keys uses C-d instead d:
1303 ;; (define-key dired-mode-map "\C-d" 'dired-flag-file-deletion)
1304 (let ((map (make-keymap)))
1305 (set-keymap-parent map special-mode-map
)
1306 (define-key map
[mouse-2
] 'dired-mouse-find-file-other-window
)
1307 (define-key map
[follow-link
] 'mouse-face
)
1308 ;; Commands to mark or flag certain categories of files
1309 (define-key map
"#" 'dired-flag-auto-save-files
)
1310 (define-key map
"." 'dired-clean-directory
)
1311 (define-key map
"~" 'dired-flag-backup-files
)
1312 ;; Upper case keys (except !) for operating on the marked files
1313 (define-key map
"A" 'dired-do-search
)
1314 (define-key map
"C" 'dired-do-copy
)
1315 (define-key map
"B" 'dired-do-byte-compile
)
1316 (define-key map
"D" 'dired-do-delete
)
1317 (define-key map
"G" 'dired-do-chgrp
)
1318 (define-key map
"H" 'dired-do-hardlink
)
1319 (define-key map
"L" 'dired-do-load
)
1320 (define-key map
"M" 'dired-do-chmod
)
1321 (define-key map
"O" 'dired-do-chown
)
1322 (define-key map
"P" 'dired-do-print
)
1323 (define-key map
"Q" 'dired-do-query-replace-regexp
)
1324 (define-key map
"R" 'dired-do-rename
)
1325 (define-key map
"S" 'dired-do-symlink
)
1326 (define-key map
"T" 'dired-do-touch
)
1327 (define-key map
"X" 'dired-do-shell-command
)
1328 (define-key map
"Z" 'dired-do-compress
)
1329 (define-key map
"!" 'dired-do-shell-command
)
1330 (define-key map
"&" 'dired-do-async-shell-command
)
1331 ;; Comparison commands
1332 (define-key map
"=" 'dired-diff
)
1333 (define-key map
"\M-=" 'dired-backup-diff
)
1334 ;; Tree Dired commands
1335 (define-key map
"\M-\C-?" 'dired-unmark-all-files
)
1336 (define-key map
"\M-\C-d" 'dired-tree-down
)
1337 (define-key map
"\M-\C-u" 'dired-tree-up
)
1338 (define-key map
"\M-\C-n" 'dired-next-subdir
)
1339 (define-key map
"\M-\C-p" 'dired-prev-subdir
)
1340 ;; move to marked files
1341 (define-key map
"\M-{" 'dired-prev-marked-file
)
1342 (define-key map
"\M-}" 'dired-next-marked-file
)
1343 ;; Make all regexp commands share a `%' prefix:
1344 ;; We used to get to the submap via a symbol dired-regexp-prefix,
1345 ;; but that seems to serve little purpose, and copy-keymap
1346 ;; does a better job without it.
1347 (define-key map
"%" nil
)
1348 (define-key map
"%u" 'dired-upcase
)
1349 (define-key map
"%l" 'dired-downcase
)
1350 (define-key map
"%d" 'dired-flag-files-regexp
)
1351 (define-key map
"%g" 'dired-mark-files-containing-regexp
)
1352 (define-key map
"%m" 'dired-mark-files-regexp
)
1353 (define-key map
"%r" 'dired-do-rename-regexp
)
1354 (define-key map
"%C" 'dired-do-copy-regexp
)
1355 (define-key map
"%H" 'dired-do-hardlink-regexp
)
1356 (define-key map
"%R" 'dired-do-rename-regexp
)
1357 (define-key map
"%S" 'dired-do-symlink-regexp
)
1358 (define-key map
"%&" 'dired-flag-garbage-files
)
1359 ;; Commands for marking and unmarking.
1360 (define-key map
"*" nil
)
1361 (define-key map
"**" 'dired-mark-executables
)
1362 (define-key map
"*/" 'dired-mark-directories
)
1363 (define-key map
"*@" 'dired-mark-symlinks
)
1364 (define-key map
"*%" 'dired-mark-files-regexp
)
1365 (define-key map
"*c" 'dired-change-marks
)
1366 (define-key map
"*s" 'dired-mark-subdir-files
)
1367 (define-key map
"*m" 'dired-mark
)
1368 (define-key map
"*u" 'dired-unmark
)
1369 (define-key map
"*?" 'dired-unmark-all-files
)
1370 (define-key map
"*!" 'dired-unmark-all-marks
)
1371 (define-key map
"U" 'dired-unmark-all-marks
)
1372 (define-key map
"*\177" 'dired-unmark-backward
)
1373 (define-key map
"*\C-n" 'dired-next-marked-file
)
1374 (define-key map
"*\C-p" 'dired-prev-marked-file
)
1375 (define-key map
"*t" 'dired-toggle-marks
)
1376 ;; Lower keys for commands not operating on all the marked files
1377 (define-key map
"a" 'dired-find-alternate-file
)
1378 (define-key map
"d" 'dired-flag-file-deletion
)
1379 (define-key map
"e" 'dired-find-file
)
1380 (define-key map
"f" 'dired-find-file
)
1381 (define-key map
"\C-m" 'dired-find-file
)
1382 (put 'dired-find-file
:advertised-binding
"\C-m")
1383 (define-key map
"g" 'revert-buffer
)
1384 (define-key map
"i" 'dired-maybe-insert-subdir
)
1385 (define-key map
"j" 'dired-goto-file
)
1386 (define-key map
"k" 'dired-do-kill-lines
)
1387 (define-key map
"l" 'dired-do-redisplay
)
1388 (define-key map
"m" 'dired-mark
)
1389 (define-key map
"n" 'dired-next-line
)
1390 (define-key map
"o" 'dired-find-file-other-window
)
1391 (define-key map
"\C-o" 'dired-display-file
)
1392 (define-key map
"p" 'dired-previous-line
)
1393 (define-key map
"s" 'dired-sort-toggle-or-edit
)
1394 (define-key map
"t" 'dired-toggle-marks
)
1395 (define-key map
"u" 'dired-unmark
)
1396 (define-key map
"v" 'dired-view-file
)
1397 (define-key map
"w" 'dired-copy-filename-as-kill
)
1398 (define-key map
"x" 'dired-do-flagged-delete
)
1399 (define-key map
"y" 'dired-show-file-type
)
1400 (define-key map
"+" 'dired-create-directory
)
1402 (define-key map
"<" 'dired-prev-dirline
)
1403 (define-key map
">" 'dired-next-dirline
)
1404 (define-key map
"^" 'dired-up-directory
)
1405 (define-key map
" " 'dired-next-line
)
1406 (define-key map
[remap next-line
] 'dired-next-line
)
1407 (define-key map
[remap previous-line
] 'dired-previous-line
)
1409 (define-key map
"$" 'dired-hide-subdir
)
1410 (define-key map
"\M-$" 'dired-hide-all
)
1412 (define-key map
(kbd "M-s a C-s") 'dired-do-isearch
)
1413 (define-key map
(kbd "M-s a M-C-s") 'dired-do-isearch-regexp
)
1414 (define-key map
(kbd "M-s f C-s") 'dired-isearch-filenames
)
1415 (define-key map
(kbd "M-s f M-C-s") 'dired-isearch-filenames-regexp
)
1417 (define-key map
[remap toggle-read-only
] 'dired-toggle-read-only
)
1418 (define-key map
"?" 'dired-summary
)
1419 (define-key map
"\177" 'dired-unmark-backward
)
1420 (define-key map
[remap undo
] 'dired-undo
)
1421 (define-key map
[remap advertised-undo
] 'dired-undo
)
1422 ;; thumbnail manipulation (image-dired)
1423 (define-key map
"\C-td" 'image-dired-display-thumbs
)
1424 (define-key map
"\C-tt" 'image-dired-tag-files
)
1425 (define-key map
"\C-tr" 'image-dired-delete-tag
)
1426 (define-key map
"\C-tj" 'image-dired-jump-thumbnail-buffer
)
1427 (define-key map
"\C-ti" 'image-dired-dired-display-image
)
1428 (define-key map
"\C-tx" 'image-dired-dired-display-external
)
1429 (define-key map
"\C-ta" 'image-dired-display-thumbs-append
)
1430 (define-key map
"\C-t." 'image-dired-display-thumb
)
1431 (define-key map
"\C-tc" 'image-dired-dired-comment-files
)
1432 (define-key map
"\C-tf" 'image-dired-mark-tagged-files
)
1433 (define-key map
"\C-t\C-t" 'image-dired-dired-toggle-marked-thumbs
)
1434 (define-key map
"\C-te" 'image-dired-dired-edit-comment-and-tags
)
1435 ;; encryption and decryption (epa-dired)
1436 (define-key map
":d" 'epa-dired-do-decrypt
)
1437 (define-key map
":v" 'epa-dired-do-verify
)
1438 (define-key map
":s" 'epa-dired-do-sign
)
1439 (define-key map
":e" 'epa-dired-do-encrypt
)
1441 ;; Make menu bar items.
1443 ;; No need to fo this, now that top-level items are fewer.
1445 ;; Get rid of the Edit menu bar item to save space.
1446 ;(define-key map [menu-bar edit] 'undefined)
1448 (define-key map
[menu-bar subdir
]
1449 (cons "Subdir" (make-sparse-keymap "Subdir")))
1451 (define-key map
[menu-bar subdir hide-all
]
1452 '(menu-item "Hide All" dired-hide-all
1453 :help
"Hide all subdirectories, leave only header lines"))
1454 (define-key map
[menu-bar subdir hide-subdir
]
1455 '(menu-item "Hide/UnHide Subdir" dired-hide-subdir
1456 :help
"Hide or unhide current directory listing"))
1457 (define-key map
[menu-bar subdir tree-down
]
1458 '(menu-item "Tree Down" dired-tree-down
1459 :help
"Go to first subdirectory header down the tree"))
1460 (define-key map
[menu-bar subdir tree-up
]
1461 '(menu-item "Tree Up" dired-tree-up
1462 :help
"Go to first subdirectory header up the tree"))
1463 (define-key map
[menu-bar subdir up
]
1464 '(menu-item "Up Directory" dired-up-directory
1465 :help
"Edit the parent directory"))
1466 (define-key map
[menu-bar subdir prev-subdir
]
1467 '(menu-item "Prev Subdir" dired-prev-subdir
1468 :help
"Go to previous subdirectory header line"))
1469 (define-key map
[menu-bar subdir next-subdir
]
1470 '(menu-item "Next Subdir" dired-next-subdir
1471 :help
"Go to next subdirectory header line"))
1472 (define-key map
[menu-bar subdir prev-dirline
]
1473 '(menu-item "Prev Dirline" dired-prev-dirline
1474 :help
"Move to next directory-file line"))
1475 (define-key map
[menu-bar subdir next-dirline
]
1476 '(menu-item "Next Dirline" dired-next-dirline
1477 :help
"Move to previous directory-file line"))
1478 (define-key map
[menu-bar subdir insert
]
1479 '(menu-item "Insert This Subdir" dired-maybe-insert-subdir
1480 :help
"Insert contents of subdirectory"
1481 :enable
(let ((f (dired-get-filename nil t
)))
1482 (and f
(file-directory-p f
)))))
1483 (define-key map
[menu-bar immediate
]
1484 (cons "Immediate" (make-sparse-keymap "Immediate")))
1487 [menu-bar immediate image-dired-dired-display-external
]
1488 '(menu-item "Display Image Externally" image-dired-dired-display-external
1489 :help
"Display image in external viewer"))
1491 [menu-bar immediate image-dired-dired-display-image
]
1492 '(menu-item "Display Image" image-dired-dired-display-image
1493 :help
"Display sized image in a separate window"))
1495 (define-key map
[menu-bar immediate revert-buffer
]
1496 '(menu-item "Refresh" revert-buffer
1497 :help
"Update contents of shown directories"))
1499 (define-key map
[menu-bar immediate dashes
]
1502 (define-key map
[menu-bar immediate isearch-filenames-regexp
]
1503 '(menu-item "Isearch Regexp in File Names..." dired-isearch-filenames-regexp
1504 :help
"Incrementally search for regexp in file names only"))
1505 (define-key map
[menu-bar immediate isearch-filenames
]
1506 '(menu-item "Isearch in File Names..." dired-isearch-filenames
1507 :help
"Incrementally search for string in file names only."))
1508 (define-key map
[menu-bar immediate compare-directories
]
1509 '(menu-item "Compare Directories..." dired-compare-directories
1510 :help
"Mark files with different attributes in two dired buffers"))
1511 (define-key map
[menu-bar immediate backup-diff
]
1512 '(menu-item "Compare with Backup" dired-backup-diff
1513 :help
"Diff file at cursor with its latest backup"))
1514 (define-key map
[menu-bar immediate diff
]
1515 '(menu-item "Diff..." dired-diff
1516 :help
"Compare file at cursor with another file"))
1517 (define-key map
[menu-bar immediate view
]
1518 '(menu-item "View This File" dired-view-file
1519 :help
"Examine file at cursor in read-only mode"))
1520 (define-key map
[menu-bar immediate display
]
1521 '(menu-item "Display in Other Window" dired-display-file
1522 :help
"Display file at cursor in other window"))
1523 (define-key map
[menu-bar immediate find-file-other-window
]
1524 '(menu-item "Find in Other Window" dired-find-file-other-window
1525 :help
"Edit file at cursor in other window"))
1526 (define-key map
[menu-bar immediate find-file
]
1527 '(menu-item "Find This File" dired-find-file
1528 :help
"Edit file at cursor"))
1529 (define-key map
[menu-bar immediate create-directory
]
1530 '(menu-item "Create Directory..." dired-create-directory
1531 :help
"Create a directory"))
1532 (define-key map
[menu-bar immediate wdired-mode
]
1533 '(menu-item "Edit File Names" wdired-change-to-wdired-mode
1534 :help
"Put a dired buffer in a mode in which filenames are editable"
1536 :filter
(lambda (x) (if (eq major-mode
'dired-mode
) x
))))
1538 (define-key map
[menu-bar regexp
]
1539 (cons "Regexp" (make-sparse-keymap "Regexp")))
1542 [menu-bar regexp image-dired-mark-tagged-files
]
1543 '(menu-item "Mark From Image Tag..." image-dired-mark-tagged-files
1544 :help
"Mark files whose image tags matches regexp"))
1546 (define-key map
[menu-bar regexp dashes-1
]
1549 (define-key map
[menu-bar regexp downcase
]
1550 '(menu-item "Downcase" dired-downcase
1551 ;; When running on plain MS-DOS, there's only one
1552 ;; letter-case for file names.
1553 :enable
(or (not (fboundp 'msdos-long-file-names
))
1554 (msdos-long-file-names))
1555 :help
"Rename marked files to lower-case name"))
1556 (define-key map
[menu-bar regexp upcase
]
1557 '(menu-item "Upcase" dired-upcase
1558 :enable
(or (not (fboundp 'msdos-long-file-names
))
1559 (msdos-long-file-names))
1560 :help
"Rename marked files to upper-case name"))
1561 (define-key map
[menu-bar regexp hardlink
]
1562 '(menu-item "Hardlink..." dired-do-hardlink-regexp
1563 :help
"Make hard links for files matching regexp"))
1564 (define-key map
[menu-bar regexp symlink
]
1565 '(menu-item "Symlink..." dired-do-symlink-regexp
1566 :visible
(fboundp 'make-symbolic-link
)
1567 :help
"Make symbolic links for files matching regexp"))
1568 (define-key map
[menu-bar regexp rename
]
1569 '(menu-item "Rename..." dired-do-rename-regexp
1570 :help
"Rename marked files matching regexp"))
1571 (define-key map
[menu-bar regexp copy
]
1572 '(menu-item "Copy..." dired-do-copy-regexp
1573 :help
"Copy marked files matching regexp"))
1574 (define-key map
[menu-bar regexp flag
]
1575 '(menu-item "Flag..." dired-flag-files-regexp
1576 :help
"Flag files matching regexp for deletion"))
1577 (define-key map
[menu-bar regexp mark
]
1578 '(menu-item "Mark..." dired-mark-files-regexp
1579 :help
"Mark files matching regexp for future operations"))
1580 (define-key map
[menu-bar regexp mark-cont
]
1581 '(menu-item "Mark Containing..." dired-mark-files-containing-regexp
1582 :help
"Mark files whose contents matches regexp"))
1584 (define-key map
[menu-bar mark
]
1585 (cons "Mark" (make-sparse-keymap "Mark")))
1587 (define-key map
[menu-bar mark prev
]
1588 '(menu-item "Previous Marked" dired-prev-marked-file
1589 :help
"Move to previous marked file"))
1590 (define-key map
[menu-bar mark next
]
1591 '(menu-item "Next Marked" dired-next-marked-file
1592 :help
"Move to next marked file"))
1593 (define-key map
[menu-bar mark marks
]
1594 '(menu-item "Change Marks..." dired-change-marks
1595 :help
"Replace marker with another character"))
1596 (define-key map
[menu-bar mark unmark-all
]
1597 '(menu-item "Unmark All" dired-unmark-all-marks
))
1598 (define-key map
[menu-bar mark symlinks
]
1599 '(menu-item "Mark Symlinks" dired-mark-symlinks
1600 :visible
(fboundp 'make-symbolic-link
)
1601 :help
"Mark all symbolic links"))
1602 (define-key map
[menu-bar mark directories
]
1603 '(menu-item "Mark Directories" dired-mark-directories
1604 :help
"Mark all directories except `.' and `..'"))
1605 (define-key map
[menu-bar mark directory
]
1606 '(menu-item "Mark Old Backups" dired-clean-directory
1607 :help
"Flag old numbered backups for deletion"))
1608 (define-key map
[menu-bar mark executables
]
1609 '(menu-item "Mark Executables" dired-mark-executables
1610 :help
"Mark all executable files"))
1611 (define-key map
[menu-bar mark garbage-files
]
1612 '(menu-item "Flag Garbage Files" dired-flag-garbage-files
1613 :help
"Flag unneeded files for deletion"))
1614 (define-key map
[menu-bar mark backup-files
]
1615 '(menu-item "Flag Backup Files" dired-flag-backup-files
1616 :help
"Flag all backup files for deletion"))
1617 (define-key map
[menu-bar mark auto-save-files
]
1618 '(menu-item "Flag Auto-save Files" dired-flag-auto-save-files
1619 :help
"Flag auto-save files for deletion"))
1620 (define-key map
[menu-bar mark deletion
]
1621 '(menu-item "Flag" dired-flag-file-deletion
1622 :help
"Flag current line's file for deletion"))
1623 (define-key map
[menu-bar mark unmark
]
1624 '(menu-item "Unmark" dired-unmark
1625 :help
"Unmark or unflag current line's file"))
1626 (define-key map
[menu-bar mark mark
]
1627 '(menu-item "Mark" dired-mark
1628 :help
"Mark current line's file for future operations"))
1629 (define-key map
[menu-bar mark toggle-marks
]
1630 '(menu-item "Toggle Marks" dired-toggle-marks
1631 :help
"Mark unmarked files, unmark marked ones"))
1633 (define-key map
[menu-bar operate
]
1634 (cons "Operate" (make-sparse-keymap "Operate")))
1637 [menu-bar operate image-dired-delete-tag
]
1638 '(menu-item "Delete Image Tag..." image-dired-delete-tag
1639 :help
"Delete image tag from current or marked files"))
1641 [menu-bar operate image-dired-tag-files
]
1642 '(menu-item "Add Image Tags..." image-dired-tag-files
1643 :help
"Add image tags to current or marked files"))
1645 [menu-bar operate image-dired-dired-comment-files
]
1646 '(menu-item "Add Image Comment..." image-dired-dired-comment-files
1647 :help
"Add image comment to current or marked files"))
1649 [menu-bar operate image-dired-display-thumbs
]
1650 '(menu-item "Display image thumbnails" image-dired-display-thumbs
1651 :help
"Display image thumbnails for current or marked image files"))
1653 (define-key map
[menu-bar operate dashes-4
]
1657 [menu-bar operate epa-dired-do-decrypt
]
1658 '(menu-item "Decrypt" epa-dired-do-decrypt
1659 :help
"Decrypt file at cursor"))
1662 [menu-bar operate epa-dired-do-verify
]
1663 '(menu-item "Verify" epa-dired-do-verify
1664 :help
"Verify digital signature of file at cursor"))
1667 [menu-bar operate epa-dired-do-sign
]
1668 '(menu-item "Sign" epa-dired-do-sign
1669 :help
"Create digital signature of file at cursor"))
1672 [menu-bar operate epa-dired-do-encrypt
]
1673 '(menu-item "Encrypt" epa-dired-do-encrypt
1674 :help
"Encrypt file at cursor"))
1676 (define-key map
[menu-bar operate dashes-3
]
1679 (define-key map
[menu-bar operate query-replace
]
1680 '(menu-item "Query Replace in Files..." dired-do-query-replace-regexp
1681 :help
"Replace regexp in marked files"))
1682 (define-key map
[menu-bar operate search
]
1683 '(menu-item "Search Files..." dired-do-search
1684 :help
"Search marked files for regexp"))
1685 (define-key map
[menu-bar operate isearch-regexp
]
1686 '(menu-item "Isearch Regexp Files..." dired-do-isearch-regexp
1687 :help
"Incrementally search marked files for regexp"))
1688 (define-key map
[menu-bar operate isearch
]
1689 '(menu-item "Isearch Files..." dired-do-isearch
1690 :help
"Incrementally search marked files for string"))
1691 (define-key map
[menu-bar operate chown
]
1692 '(menu-item "Change Owner..." dired-do-chown
1693 :visible
(not (memq system-type
'(ms-dos windows-nt
)))
1694 :help
"Change the owner of marked files"))
1695 (define-key map
[menu-bar operate chgrp
]
1696 '(menu-item "Change Group..." dired-do-chgrp
1697 :visible
(not (memq system-type
'(ms-dos windows-nt
)))
1698 :help
"Change the group of marked files"))
1699 (define-key map
[menu-bar operate chmod
]
1700 '(menu-item "Change Mode..." dired-do-chmod
1701 :help
"Change mode (attributes) of marked files"))
1702 (define-key map
[menu-bar operate touch
]
1703 '(menu-item "Change Timestamp..." dired-do-touch
1704 :help
"Change timestamp of marked files"))
1705 (define-key map
[menu-bar operate load
]
1706 '(menu-item "Load" dired-do-load
1707 :help
"Load marked Emacs Lisp files"))
1708 (define-key map
[menu-bar operate compile
]
1709 '(menu-item "Byte-compile" dired-do-byte-compile
1710 :help
"Byte-compile marked Emacs Lisp files"))
1711 (define-key map
[menu-bar operate compress
]
1712 '(menu-item "Compress" dired-do-compress
1713 :help
"Compress/uncompress marked files"))
1714 (define-key map
[menu-bar operate print
]
1715 '(menu-item "Print..." dired-do-print
1716 :help
"Ask for print command and print marked files"))
1717 (define-key map
[menu-bar operate hardlink
]
1718 '(menu-item "Hardlink to..." dired-do-hardlink
1719 :help
"Make hard links for current or marked files"))
1720 (define-key map
[menu-bar operate symlink
]
1721 '(menu-item "Symlink to..." dired-do-symlink
1722 :visible
(fboundp 'make-symbolic-link
)
1723 :help
"Make symbolic links for current or marked files"))
1724 (define-key map
[menu-bar operate async-command
]
1725 '(menu-item "Asynchronous Shell Command..." dired-do-async-shell-command
1726 :help
"Run a shell command asynchronously on current or marked files"))
1727 (define-key map
[menu-bar operate command
]
1728 '(menu-item "Shell Command..." dired-do-shell-command
1729 :help
"Run a shell command on current or marked files"))
1730 (define-key map
[menu-bar operate delete
]
1731 '(menu-item "Delete" dired-do-delete
1732 :help
"Delete current file or all marked files"))
1733 (define-key map
[menu-bar operate rename
]
1734 '(menu-item "Rename to..." dired-do-rename
1735 :help
"Rename current file or move marked files"))
1736 (define-key map
[menu-bar operate copy
]
1737 '(menu-item "Copy to..." dired-do-copy
1738 :help
"Copy current file or all marked files"))
1741 "Local keymap for `dired-mode' buffers.")
1743 ;; Dired mode is suitable only for specially formatted data.
1744 (put 'dired-mode
'mode-class
'special
)
1746 ;; Autoload cookie needed by desktop.el
1748 (defun dired-mode (&optional dirname switches
)
1750 Mode for \"editing\" directory listings.
1751 In Dired, you are \"editing\" a list of the files in a directory and
1752 \(optionally) its subdirectories, in the format of `ls -lR'.
1753 Each directory is a page: use \\[backward-page] and \\[forward-page] to move pagewise.
1754 \"Editing\" means that you can run shell commands on files, visit,
1755 compress, load or byte-compile them, change their file attributes
1756 and insert subdirectories into the same buffer. You can \"mark\"
1757 files for later commands or \"flag\" them for deletion, either file
1758 by file or all files matching certain criteria.
1759 You can move using the usual cursor motion commands.\\<dired-mode-map>
1760 Letters no longer insert themselves. Digits are prefix arguments.
1761 Instead, type \\[dired-flag-file-deletion] to flag a file for Deletion.
1762 Type \\[dired-mark] to Mark a file or subdirectory for later commands.
1763 Most commands operate on the marked files and use the current file
1764 if no files are marked. Use a numeric prefix argument to operate on
1765 the next ARG (or previous -ARG if ARG<0) files, or just `1'
1766 to operate on the current file only. Prefix arguments override marks.
1767 Mark-using commands display a list of failures afterwards. Type \\[dired-summary]
1768 to see why something went wrong.
1769 Type \\[dired-unmark] to Unmark a file or all files of a subdirectory.
1770 Type \\[dired-unmark-backward] to back up one line and unflag.
1771 Type \\[dired-do-flagged-delete] to eXecute the deletions requested.
1772 Type \\[dired-find-file] to Find the current line's file
1773 (or dired it in another buffer, if it is a directory).
1774 Type \\[dired-find-file-other-window] to find file or dired directory in Other window.
1775 Type \\[dired-maybe-insert-subdir] to Insert a subdirectory in this buffer.
1776 Type \\[dired-do-rename] to Rename a file or move the marked files to another directory.
1777 Type \\[dired-do-copy] to Copy files.
1778 Type \\[dired-sort-toggle-or-edit] to toggle Sorting by name/date or change the `ls' switches.
1779 Type \\[revert-buffer] to read all currently expanded directories aGain.
1780 This retains all marks and hides subdirs again that were hidden before.
1781 SPC and DEL can be used to move down and up by lines.
1783 If Dired ever gets confused, you can either type \\[revert-buffer] \
1785 directories again, type \\[dired-do-redisplay] \
1786 to relist a single or the marked files or a
1787 subdirectory, or type \\[dired-build-subdir-alist] to parse the buffer
1788 again for the directory tree.
1790 Customization variables (rename this buffer and type \\[describe-variable] on each line
1793 `dired-listing-switches'
1794 `dired-trivial-filenames'
1795 `dired-shrink-to-fit'
1798 `dired-keep-marker-rename'
1799 `dired-keep-marker-copy'
1800 `dired-keep-marker-hardlink'
1801 `dired-keep-marker-symlink'
1803 Hooks (use \\[describe-variable] to see their documentation):
1805 `dired-before-readin-hook'
1806 `dired-after-readin-hook'
1812 ;; Not to be called interactively (e.g. dired-directory will be set
1813 ;; to default-directory, which is wrong with wildcards).
1814 (kill-all-local-variables)
1815 (use-local-map dired-mode-map
)
1816 (dired-advertise) ; default-directory is already set
1817 (setq major-mode
'dired-mode
1819 ;; case-fold-search nil
1821 selective-display t
; for subdirectory hiding
1822 mode-line-buffer-identification
1823 (propertized-buffer-identification "%17b"))
1824 (set (make-local-variable 'revert-buffer-function
)
1825 (function dired-revert
))
1826 (set (make-local-variable 'buffer-stale-function
)
1827 (function dired-buffer-stale-p
))
1828 (set (make-local-variable 'page-delimiter
)
1830 (set (make-local-variable 'dired-directory
)
1831 (or dirname default-directory
))
1832 ;; list-buffers uses this to display the dir being edited in this buffer.
1833 (setq list-buffers-directory
1834 (expand-file-name (if (listp dired-directory
)
1835 (car dired-directory
)
1837 (set (make-local-variable 'dired-actual-switches
)
1838 (or switches dired-listing-switches
))
1839 (set (make-local-variable 'font-lock-defaults
)
1840 '(dired-font-lock-keywords t nil nil beginning-of-line
))
1841 (set (make-local-variable 'desktop-save-buffer
)
1842 'dired-desktop-buffer-misc-data
)
1843 (setq dired-switches-alist nil
)
1844 (dired-sort-other dired-actual-switches t
)
1845 (when (featurep 'dnd
)
1846 (set (make-local-variable 'dnd-protocol-alist
)
1847 (append dired-dnd-protocol-alist dnd-protocol-alist
)))
1848 (add-hook 'file-name-at-point-functions
'dired-file-name-at-point nil t
)
1849 (add-hook 'isearch-mode-hook
'dired-isearch-filenames-setup nil t
)
1850 (run-mode-hooks 'dired-mode-hook
))
1852 ;; Idiosyncratic dired commands that don't deal with marks.
1854 (defun dired-summary ()
1855 "Summarize basic Dired commands and show recent dired errors."
1858 ;>> this should check the key-bindings and use substitute-command-keys if non-standard
1860 "d-elete, u-ndelete, x-punge, f-ind, o-ther window, R-ename, C-opy, h-elp"))
1862 (defun dired-undo ()
1863 "Undo in a dired buffer.
1864 This doesn't recover lost files, it just undoes changes in the buffer itself.
1865 You can use it to recover marks, killed lines or subdirs."
1867 (let ((inhibit-read-only t
))
1869 (dired-build-subdir-alist)
1870 (message "Change in dired buffer undone.
1871 Actual changes in files cannot be undone by Emacs."))
1873 (defun dired-toggle-read-only ()
1874 "Edit dired buffer with Wdired, or set it read-only.
1875 Call `wdired-change-to-wdired-mode' in dired buffers whose editing is
1876 supported by Wdired (the major mode of the dired buffer is `dired-mode').
1877 Otherwise, for buffers inheriting from dired-mode, call `toggle-read-only'."
1879 (if (eq major-mode
'dired-mode
)
1880 (wdired-change-to-wdired-mode)
1881 (toggle-read-only)))
1883 (defun dired-next-line (arg)
1884 "Move down lines then position at filename.
1885 Optional prefix ARG says how many lines to move; default is one line."
1888 (dired-move-to-filename))
1890 (defun dired-previous-line (arg)
1891 "Move up lines then position at filename.
1892 Optional prefix ARG says how many lines to move; default is one line."
1894 (forward-line (- arg
))
1895 (dired-move-to-filename))
1897 (defun dired-next-dirline (arg &optional opoint
)
1898 "Goto ARG'th next directory file line."
1900 (or opoint
(setq opoint
(point)))
1902 (re-search-forward dired-re-dir nil t arg
)
1904 (re-search-backward dired-re-dir nil t
(- arg
)))
1905 (dired-move-to-filename) ; user may type `i' or `f'
1907 (error "No more subdirectories")))
1909 (defun dired-prev-dirline (arg)
1910 "Goto ARG'th previous directory file line."
1912 (dired-next-dirline (- arg
)))
1914 (defun dired-up-directory (&optional other-window
)
1915 "Run Dired on parent directory of current directory.
1916 Find the parent directory either in this buffer or another buffer.
1917 Creates a buffer if necessary."
1919 (let* ((dir (dired-current-directory))
1920 (up (file-name-directory (directory-file-name dir
))))
1921 (or (dired-goto-file (directory-file-name dir
))
1922 ;; Only try dired-goto-subdir if buffer has more than one dir.
1923 (and (cdr dired-subdir-alist
)
1924 (dired-goto-subdir up
))
1927 (dired-other-window up
)
1929 (dired-goto-file dir
)))))
1931 (defun dired-get-file-for-visit ()
1932 "Get the current line's file name, with an error if file does not exist."
1934 ;; We pass t for second arg so that we don't get error for `.' and `..'.
1935 (let ((raw (dired-get-filename nil t
))
1938 (error "No file on this line"))
1939 (setq file-name
(file-name-sans-versions raw t
))
1940 (if (file-exists-p file-name
)
1942 (if (file-symlink-p file-name
)
1943 (error "File is a symlink to a nonexistent target")
1944 (error "File no longer exists; type `g' to update dired buffer")))))
1946 ;; Force C-m keybinding rather than `f' or `e' in the mode doc:
1947 (define-obsolete-function-alias 'dired-advertised-find-file
'dired-find-file
"23.2")
1948 (defun dired-find-file ()
1949 "In Dired, visit the file or directory named on this line."
1951 ;; Bind `find-file-run-dired' so that the command works on directories
1952 ;; too, independent of the user's setting.
1953 (let ((find-file-run-dired t
))
1954 (find-file (dired-get-file-for-visit))))
1956 (defun dired-find-alternate-file ()
1957 "In Dired, visit this file or directory instead of the dired buffer."
1959 (set-buffer-modified-p nil
)
1960 (find-alternate-file (dired-get-file-for-visit)))
1961 ;; Don't override the setting from .emacs.
1962 ;;;###autoload (put 'dired-find-alternate-file 'disabled t)
1964 (defun dired-mouse-find-file-other-window (event)
1965 "In Dired, visit the file or directory name you click on."
1967 (let (window pos file
)
1969 (setq window
(posn-window (event-end event
))
1970 pos
(posn-point (event-end event
)))
1971 (if (not (windowp window
))
1972 (error "No file chosen"))
1973 (set-buffer (window-buffer window
))
1975 (setq file
(dired-get-file-for-visit)))
1976 (if (file-directory-p file
)
1977 (or (and (cdr dired-subdir-alist
)
1978 (dired-goto-subdir file
))
1980 (select-window window
)
1981 (dired-other-window file
)))
1982 (select-window window
)
1983 (find-file-other-window (file-name-sans-versions file t
)))))
1985 (defun dired-view-file ()
1986 "In Dired, examine a file in view mode, returning to Dired when done.
1987 When file is a directory, show it in this buffer if it is inserted.
1988 Otherwise, display it in another buffer."
1990 (let ((file (dired-get-file-for-visit)))
1991 (if (file-directory-p file
)
1992 (or (and (cdr dired-subdir-alist
)
1993 (dired-goto-subdir file
))
1997 (defun dired-find-file-other-window ()
1998 "In Dired, visit this file or directory in another window."
2000 (find-file-other-window (dired-get-file-for-visit)))
2002 (defun dired-display-file ()
2003 "In Dired, display this file or directory in another window."
2005 (display-buffer (find-file-noselect (dired-get-file-for-visit))))
2007 ;;; Functions for extracting and manipulating file names in Dired buffers.
2009 (defun dired-get-filename (&optional localp no-error-if-not-filep
)
2010 "In Dired, return name of file mentioned on this line.
2011 Value returned normally includes the directory name.
2012 Optional arg LOCALP with value `no-dir' means don't include directory
2013 name in result. A value of `verbatim' means to return the name exactly as
2014 it occurs in the buffer, and a value of t means construct name relative to
2015 `default-directory', which still may contain slashes if in a subdirectory.
2016 Optional arg NO-ERROR-IF-NOT-FILEP means treat `.' and `..' as
2017 regular filenames and return nil if no filename on this line.
2018 Otherwise, an error occurs in these cases."
2019 (let (case-fold-search file p1 p2 already-absolute
)
2021 (if (setq p1
(dired-move-to-filename (not no-error-if-not-filep
)))
2022 (setq p2
(dired-move-to-end-of-filename no-error-if-not-filep
))))
2023 ;; nil if no file on this line, but no-error-if-not-filep is t:
2024 (if (setq file
(and p1 p2
(buffer-substring p1 p2
)))
2026 ;; Get rid of the mouse-face property that file names have.
2027 (set-text-properties 0 (length file
) nil file
)
2028 ;; Unquote names quoted by ls or by dired-insert-directory.
2029 ;; This code was written using `read' to unquote, because
2030 ;; it's faster than substituting \007 (4 chars) -> ^G (1
2031 ;; char) etc. in a lisp loop. Unfortunately, this decision
2032 ;; has necessitated hacks such as dealing with filenames
2033 ;; with quotation marks in their names.
2034 (while (string-match "\\(?:[^\\]\\|\\`\\)\\(\"\\)" file
)
2035 (setq file
(replace-match "\\\"" nil t file
1)))
2037 (when (eq system-type
'windows-nt
)
2040 (while (string-match "\\\\" file start
)
2041 (aset file
(match-beginning 0) ?
/)
2042 (setq start
(match-end 0))))))
2044 (setq file
(read (concat "\"" file
"\"")))
2045 ;; The above `read' will return a unibyte string if FILE
2046 ;; contains eight-bit-control/graphic characters.
2047 (if (and enable-multibyte-characters
2048 (not (multibyte-string-p file
)))
2049 (setq file
(string-to-multibyte file
)))))
2050 (and file
(file-name-absolute-p file
)
2051 ;; A relative file name can start with ~.
2052 ;; Don't treat it as absolute in this context.
2053 (not (eq (aref file
0) ?~
))
2054 (setq already-absolute t
))
2058 ((eq localp
'verbatim
)
2060 ((and (not no-error-if-not-filep
)
2061 (member file
'("." "..")))
2062 (error "Cannot operate on `.' or `..'"))
2063 ((and (eq localp
'no-dir
) already-absolute
)
2064 (file-name-nondirectory file
))
2066 (let ((handler (find-file-name-handler file nil
)))
2067 ;; check for safe-magic property so that we won't
2068 ;; put /: for names that don't really need them.
2069 ;; For instance, .gz files when auto-compression-mode is on.
2070 (if (and handler
(not (get handler
'safe-magic
)))
2073 ((eq localp
'no-dir
)
2075 ((equal (dired-current-directory) "/")
2076 (setq file
(concat (dired-current-directory localp
) file
))
2077 (let ((handler (find-file-name-handler file nil
)))
2078 ;; check for safe-magic property so that we won't
2079 ;; put /: for names that don't really need them.
2080 ;; For instance, .gz files when auto-compression-mode is on.
2081 (if (and handler
(not (get handler
'safe-magic
)))
2085 (concat (dired-current-directory localp
) file
)))))
2087 (defun dired-string-replace-match (regexp string newtext
2088 &optional literal global
)
2089 "Replace first match of REGEXP in STRING with NEWTEXT.
2090 If it does not match, nil is returned instead of the new string.
2091 Optional arg LITERAL means to take NEWTEXT literally.
2092 Optional arg GLOBAL means to replace all matches."
2094 (let ((start 0) ret
)
2095 (while (string-match regexp string start
)
2096 (let ((from-end (- (length string
) (match-end 0))))
2097 (setq ret
(setq string
(replace-match newtext t literal string
)))
2098 (setq start
(- (length string
) from-end
))))
2100 (if (not (string-match regexp string
0))
2102 (replace-match newtext t literal string
))))
2104 (defun dired-make-absolute (file &optional dir
)
2105 ;;"Convert FILE (a file name relative to DIR) to an absolute file name."
2106 ;; We can't always use expand-file-name as this would get rid of `.'
2107 ;; or expand in / instead default-directory if DIR=="".
2108 ;; This should be good enough for ange-ftp.
2109 ;; It should be reasonably fast, though, as it is called in
2110 ;; dired-get-filename.
2111 (concat (or dir default-directory
) file
))
2113 (defun dired-make-relative (file &optional dir ignore
)
2114 "Convert FILE (an absolute file name) to a name relative to DIR.
2115 If this is impossible, return FILE unchanged.
2116 DIR must be a directory name, not a file name."
2117 (or dir
(setq dir default-directory
))
2118 ;; This case comes into play if default-directory is set to
2120 (if (and (> (length dir
) 0) (= (aref dir
0) ?~
))
2121 (setq dir
(expand-file-name dir
)))
2122 (if (string-match (concat "^" (regexp-quote dir
)) file
)
2123 (substring file
(match-end 0))
2125 ;;; (error "%s: not in directory tree growing at %s" file dir))
2128 ;;; Functions for finding the file name in a dired buffer line.
2130 (defvar dired-permission-flags-regexp
2131 "\\([^ ]\\)[-r][-w]\\([^ ]\\)[-r][-w]\\([^ ]\\)[-r][-w]\\([^ ]\\)"
2132 "Regular expression to match the permission flags in `ls -l'.")
2134 ;; Move to first char of filename on this line.
2135 ;; Returns position (point) or nil if no filename on this line."
2136 (defun dired-move-to-filename (&optional raise-error eol
)
2137 "Move to the beginning of the filename on the current line.
2138 Return the position of the beginning of the filename, or nil if none found."
2139 ;; This is the UNIX version.
2140 (or eol
(setq eol
(line-end-position)))
2142 ;; First try assuming `ls --dired' was used.
2143 (let ((change (next-single-property-change (point) 'dired-filename nil eol
)))
2145 ((and change
(< change eol
))
2147 ((re-search-forward directory-listing-before-filename-regexp eol t
)
2148 (goto-char (match-end 0)))
2149 ((re-search-forward dired-permission-flags-regexp eol t
)
2150 ;; Ha! There *is* a file. Our regexp-from-hell just failed to find it.
2152 (error "Unrecognized line! Check directory-listing-before-filename-regexp"))
2156 (error "No file on this line")))))
2158 (defun dired-move-to-end-of-filename (&optional no-error
)
2159 ;; Assumes point is at beginning of filename,
2160 ;; thus the rwx bit re-search-backward below will succeed in *this*
2161 ;; line if at all. So, it should be called only after
2162 ;; (dired-move-to-filename t).
2163 ;; On failure, signals an error (with non-nil NO-ERROR just returns nil).
2164 ;; This is the UNIX version.
2165 (if (get-text-property (point) 'dired-filename
)
2166 (goto-char (next-single-property-change (point) 'dired-filename
))
2167 (let (opoint file-type executable symlink hidden case-fold-search used-F eol
)
2168 ;; case-fold-search is nil now, so we can test for capital F:
2169 (setq used-F
(string-match "F" dired-actual-switches
)
2171 eol
(line-end-position)
2172 hidden
(and selective-display
2173 (save-excursion (search-forward "\r" eol t
))))
2176 (save-excursion ;; Find out what kind of file this is:
2177 ;; Restrict perm bits to be non-blank,
2178 ;; otherwise this matches one char to early (looking backward):
2179 ;; "l---------" (some systems make symlinks that way)
2180 ;; "----------" (plain file with zero perms)
2181 (if (re-search-backward
2182 dired-permission-flags-regexp nil t
)
2183 (setq file-type
(char-after (match-beginning 1))
2184 symlink
(eq file-type ?l
)
2185 ;; Only with -F we need to know whether it's an executable
2189 "[xst]" ;; execute bit set anywhere?
2193 (match-string 4)))))
2194 (or no-error
(error "No file on this line"))))
2195 ;; Move point to end of name:
2197 (if (search-forward " -> " eol t
)
2201 dired-ls-F-marks-symlinks
2202 (eq (preceding-char) ?
@) ;; did ls really mark the link?
2203 (forward-char -
1))))
2204 (goto-char eol
) ;; else not a symbolic link
2205 ;; ls -lF marks dirs, sockets, fifos and executables with exactly
2206 ;; one trailing character. (Executable bits on symlinks ain't mean
2207 ;; a thing, even to ls, but we know it's not a symlink.)
2209 (or (memq file-type
'(?d ?s ?p
))
2211 (forward-char -
1))))
2213 (not (eq opoint
(point)))
2214 (error "%s" (if hidden
2215 (substitute-command-keys
2216 "File line is hidden, type \\[dired-hide-subdir] to unhide")
2217 "No file on this line")))
2218 (if (eq opoint
(point))
2223 ;;; COPY NAMES OF MARKED FILES INTO KILL-RING.
2225 (defun dired-copy-filename-as-kill (&optional arg
)
2226 "Copy names of marked (or next ARG) files into the kill ring.
2227 The names are separated by a space.
2228 With a zero prefix arg, use the absolute file name of each marked file.
2229 With \\[universal-argument], use the file name relative to the dired buffer's
2230 `default-directory'. (This still may contain slashes if in a subdirectory.)
2232 If on a subdir headerline, use absolute subdirname instead;
2233 prefix arg and marked files are ignored in this case.
2235 You can then feed the file name(s) to other commands with \\[yank]."
2238 (or (dired-get-subdir)
2239 (mapconcat (function identity
)
2241 (cond ((zerop (prefix-numeric-value arg
))
2242 (dired-get-marked-files))
2244 (dired-get-marked-files t
))
2246 (dired-get-marked-files
2247 'no-dir
(prefix-numeric-value arg
))))
2248 (dired-get-marked-files 'no-dir
))
2250 (if (eq last-command
'kill-region
)
2251 (kill-append string nil
)
2253 (message "%s" string
)))
2256 ;; Keeping Dired buffers in sync with the filesystem and with each other
2258 (defun dired-buffers-for-dir (dir &optional file
)
2259 ;; Return a list of buffers for DIR (top level or in-situ subdir).
2260 ;; If FILE is non-nil, include only those whose wildcard pattern (if any)
2262 ;; The list is in reverse order of buffer creation, most recent last.
2263 ;; As a side effect, killed dired buffers for DIR are removed from
2265 (setq dir
(file-name-as-directory dir
))
2267 (dolist (elt dired-buffers
)
2268 (setq buf
(cdr elt
))
2270 ((null (buffer-name buf
))
2271 ;; Buffer is killed - clean up:
2272 (setq dired-buffers
(delq elt dired-buffers
)))
2273 ((dired-in-this-tree dir
(car elt
))
2274 (with-current-buffer buf
2275 (and (assoc dir dired-subdir-alist
)
2277 (if (stringp dired-directory
)
2278 (let ((wildcards (file-name-nondirectory
2280 (or (= 0 (length wildcards
))
2281 (string-match (dired-glob-regexp wildcards
)
2283 (member (expand-file-name file dir
)
2284 (cdr dired-directory
))))
2285 (setq result
(cons buf result
)))))))
2288 (defun dired-glob-regexp (pattern)
2289 "Convert glob-pattern PATTERN to a regular expression."
2290 (let ((matched-in-pattern 0) ;; How many chars of PATTERN we've handled.
2292 (while (string-match "[[?*]" pattern matched-in-pattern
)
2293 (let ((op-end (match-end 0))
2294 (next-op (aref pattern
(match-beginning 0))))
2295 (setq regexp
(concat regexp
2297 (substring pattern matched-in-pattern
2298 (match-beginning 0)))))
2299 (cond ((= next-op ??
)
2300 (setq regexp
(concat regexp
"."))
2301 (setq matched-in-pattern op-end
))
2303 ;; Fails to handle ^ yet ????
2304 (let* ((set-start (match-beginning 0))
2306 (if (= (aref pattern
(1+ set-start
)) ?^
)
2309 (set-end (string-match "]" pattern set-cont
))
2310 (set (substring pattern set-start
(1+ set-end
))))
2311 (setq regexp
(concat regexp set
))
2312 (setq matched-in-pattern
(1+ set-end
))))
2314 (setq regexp
(concat regexp
".*"))
2315 (setq matched-in-pattern op-end
)))))
2319 (substring pattern matched-in-pattern
))
2324 (defun dired-advertise ()
2325 ;;"Advertise in variable `dired-buffers' that we dired `default-directory'."
2326 ;; With wildcards we actually advertise too much.
2327 (let ((expanded-default (expand-file-name default-directory
)))
2328 (if (memq (current-buffer) (dired-buffers-for-dir expanded-default
))
2329 t
; we have already advertised ourselves
2331 (cons (cons expanded-default
(current-buffer))
2334 (defun dired-unadvertise (dir)
2335 ;; Remove DIR from the buffer alist in variable dired-buffers.
2336 ;; This has the effect of removing any buffer whose main directory is DIR.
2337 ;; It does not affect buffers in which DIR is a subdir.
2338 ;; Removing is also done as a side-effect in dired-buffer-for-dir.
2340 (delq (assoc (expand-file-name dir
) dired-buffers
) dired-buffers
)))
2344 ;;; utility functions
2346 (defun dired-in-this-tree (file dir
)
2347 ;;"Is FILE part of the directory tree starting at DIR?"
2348 (let (case-fold-search)
2349 (string-match (concat "^" (regexp-quote dir
)) file
)))
2351 (defun dired-normalize-subdir (dir)
2352 ;; Prepend default-directory to DIR if relative file name.
2353 ;; dired-get-filename must be able to make a valid file name from a
2354 ;; file and its directory DIR.
2355 (file-name-as-directory
2356 (if (file-name-absolute-p dir
)
2358 (expand-file-name dir default-directory
))))
2360 (defun dired-get-subdir ()
2361 ;;"Return the subdir name on this line, or nil if not on a headerline."
2362 ;; Look up in the alist whether this is a headerline.
2364 (let ((cur-dir (dired-current-directory)))
2365 (beginning-of-line) ; alist stores b-o-l positions
2366 (and (zerop (- (point)
2367 (dired-get-subdir-min (assoc cur-dir
2368 dired-subdir-alist
))))
2371 ;(defun dired-get-subdir-min (elt)
2373 ;; can't use macro, must be redefinable for other alist format in dired-nstd.
2374 (defalias 'dired-get-subdir-min
'cdr
)
2376 (defun dired-get-subdir-max (elt)
2378 (goto-char (dired-get-subdir-min elt
))
2379 (dired-subdir-max)))
2381 (defun dired-clear-alist ()
2382 (while dired-subdir-alist
2383 (set-marker (dired-get-subdir-min (car dired-subdir-alist
)) nil
)
2384 (setq dired-subdir-alist
(cdr dired-subdir-alist
))))
2386 (defun dired-subdir-index (dir)
2387 ;; Return an index into alist for use with nth
2388 ;; for the sake of subdir moving commands.
2389 (let (found (index 0) (alist dired-subdir-alist
))
2391 (if (string= dir
(car (car alist
)))
2392 (setq alist nil found t
)
2393 (setq alist
(cdr alist
) index
(1+ index
))))
2394 (if found index nil
)))
2396 (defun dired-next-subdir (arg &optional no-error-if-not-found no-skip
)
2397 "Go to next subdirectory, regardless of level."
2398 ;; Use 0 arg to go to this directory's header line.
2399 ;; NO-SKIP prevents moving to end of header line, returning whatever
2400 ;; position was found in dired-subdir-alist.
2402 (let ((this-dir (dired-current-directory))
2404 ;; nth with negative arg does not return nil but the first element
2405 (setq index
(- (dired-subdir-index this-dir
) arg
))
2406 (setq pos
(if (>= index
0)
2407 (dired-get-subdir-min (nth index dired-subdir-alist
))))
2411 (or no-skip
(skip-chars-forward "^\n\r"))
2413 (if no-error-if-not-found
2414 nil
; return nil if not found
2415 (error "%s directory" (if (> arg
0) "Last" "First"))))))
2417 (defun dired-build-subdir-alist (&optional switches
)
2418 "Build `dired-subdir-alist' by parsing the buffer.
2419 Returns the new value of the alist.
2420 If optional arg SWITCHES is non-nil, use its value
2421 instead of `dired-actual-switches'."
2426 (inhibit-read-only t
)
2427 (buffer-undo-list t
)
2428 (switches (or switches dired-actual-switches
))
2430 (R-ftp-base-dir-regex
2431 ;; Used to expand subdirectory names correctly in recursive
2432 ;; ange-ftp listings.
2433 (and (string-match "R" switches
)
2434 (string-match "\\`/.*:\\(/.*\\)" default-directory
)
2435 (concat "\\`" (match-string 1 default-directory
)))))
2436 (goto-char (point-min))
2437 (setq dired-subdir-alist nil
)
2438 (while (re-search-forward dired-subdir-regexp nil t
)
2439 ;; Avoid taking a file name ending in a colon
2440 ;; as a subdir name.
2441 (unless (save-excursion
2442 (goto-char (match-beginning 0))
2445 (save-match-data (looking-at dired-re-perms
)))
2447 (goto-char (match-beginning 1))
2449 (buffer-substring-no-properties (point) (match-end 1))
2452 (if (and R-ftp-base-dir-regex
2453 (not (string= new-dir-name default-directory
))
2454 (string-match R-ftp-base-dir-regex new-dir-name
))
2455 (concat default-directory
2456 (substring new-dir-name
(match-end 0)))
2457 (expand-file-name new-dir-name
))))
2458 (delete-region (point) (match-end 1))
2459 (insert new-dir-name
))
2460 (setq count
(1+ count
))
2461 (dired-alist-add-1 new-dir-name
2462 ;; Place a sub directory boundary between lines.
2464 (goto-char (match-beginning 0))
2467 (if (and (> count
1) (called-interactively-p 'interactive
))
2468 (message "Buffer includes %d directories" count
)))
2469 ;; We don't need to sort it because it is in buffer order per
2470 ;; constructionem. Return new alist:
2471 dired-subdir-alist
))
2473 (defun dired-alist-add-1 (dir new-marker
)
2474 ;; Add new DIR at NEW-MARKER. Don't sort.
2475 (setq dired-subdir-alist
2476 (cons (cons (dired-normalize-subdir dir
) new-marker
)
2477 dired-subdir-alist
)))
2479 (defun dired-goto-next-nontrivial-file ()
2480 ;; Position point on first nontrivial file after point.
2481 (dired-goto-next-file);; so there is a file to compare with
2482 (if (stringp dired-trivial-filenames
)
2483 (while (and (not (eobp))
2484 (string-match dired-trivial-filenames
2485 (file-name-nondirectory
2486 (or (dired-get-filename nil t
) ""))))
2488 (dired-move-to-filename))))
2490 (defun dired-goto-next-file ()
2491 (let ((max (1- (dired-subdir-max))))
2492 (while (and (not (dired-move-to-filename)) (< (point) max
))
2495 (defun dired-goto-file (file)
2496 "Go to line describing file FILE in this dired buffer."
2497 ;; Return value of point on success, else nil.
2498 ;; FILE must be an absolute file name.
2499 ;; Loses if FILE contains control chars like "\007" for which ls
2500 ;; either inserts "?" or "\\007" into the buffer, so we won't find
2501 ;; it in the buffer.
2503 (prog1 ; let push-mark display its message
2504 (list (expand-file-name
2505 (read-file-name "Goto file: "
2506 (dired-current-directory))))
2508 (setq file
(directory-file-name file
)) ; does no harm if no directory
2509 (let (found case-fold-search dir
)
2510 (setq dir
(or (file-name-directory file
)
2511 (error "File name `%s' is not absolute" file
)))
2513 ;; The hair here is to get the result of dired-goto-subdir
2514 ;; without really calling it if we don't have any subdirs.
2515 (if (if (string= dir
(expand-file-name default-directory
))
2516 (goto-char (point-min))
2517 (and (cdr dired-subdir-alist
)
2518 (dired-goto-subdir dir
)))
2519 (let ((base (file-name-nondirectory file
))
2521 (boundary (dired-subdir-max)))
2523 (replace-regexp-in-string "\^m" "\\^m" base nil t
))
2525 (replace-regexp-in-string "\\\\" "\\\\" search-string nil t
))
2526 (while (and (not found
)
2527 ;; filenames are preceded by SPC, this makes
2528 ;; the search faster (e.g. for the filename "-"!).
2529 (search-forward (concat " " search-string
)
2531 ;; Match could have BASE just as initial substring or
2532 ;; or in permission bits or date or
2533 ;; not be a proper filename at all:
2534 (if (equal base
(dired-get-filename 'no-dir t
))
2535 ;; Must move to filename since an (actually
2536 ;; correct) match could have been elsewhere on the
2537 ;; ;; line (e.g. "-" would match somewhere in the
2538 ;; permission bits).
2539 (setq found
(dired-move-to-filename))
2540 ;; If this isn't the right line, move forward to avoid
2541 ;; trying this line again.
2542 (forward-line 1))))))
2544 ;; return value of point (i.e., FOUND):
2545 (goto-char found
))))
2547 (defun dired-initial-position (dirname)
2548 ;; Where point should go in a new listing of DIRNAME.
2549 ;; Point assumed at beginning of new subdir line.
2550 ;; You may redefine this function as you wish, e.g. like in dired-x.el.
2552 (if dired-trivial-filenames
(dired-goto-next-nontrivial-file)))
2554 ;; These are hooks which make tree dired work.
2555 ;; They are in this file because other parts of dired need to call them.
2556 ;; But they don't call the rest of tree dired unless there are subdirs loaded.
2558 ;; This function is called for each retrieved filename.
2559 ;; It could stand to be faster, though it's mostly function call
2560 ;; overhead. Avoiding the function call seems to save about 10% in
2561 ;; dired-get-filename. Make it a defsubst?
2562 (defun dired-current-directory (&optional localp
)
2563 "Return the name of the subdirectory to which this line belongs.
2564 This returns a string with trailing slash, like `default-directory'.
2565 Optional argument means return a file name relative to `default-directory'."
2566 (let ((here (point))
2567 (alist (or dired-subdir-alist
2568 ;; probably because called in a non-dired buffer
2569 (error "No subdir-alist in %s" (current-buffer))))
2572 (setq elt
(car alist
)
2574 ;; use `<=' (not `<') as subdir line is part of subdir
2575 alist
(if (<= (dired-get-subdir-min elt
) here
)
2579 (dired-make-relative dir default-directory
)
2582 ;; Subdirs start at the beginning of their header lines and end just
2583 ;; before the beginning of the next header line (or end of buffer).
2585 (defun dired-subdir-max ()
2587 (if (or (null (cdr dired-subdir-alist
)) (not (dired-next-subdir 1 t t
)))
2593 (defcustom dired-recursive-deletes
'top
2594 "Decide whether recursive deletes are allowed.
2595 A value of nil means no recursive deletes.
2596 `always' means delete recursively without asking. This is DANGEROUS!
2597 `top' means ask for each directory at top level, but delete its subdirectories
2599 Anything else means ask for each directory."
2600 :type
'(choice :tag
"Delete non-empty directories"
2601 (const :tag
"Yes" always
)
2602 (const :tag
"No--only delete empty directories" nil
)
2603 (const :tag
"Confirm for each directory" t
)
2604 (const :tag
"Confirm for each top directory only" top
))
2607 ;; Match anything but `.' and `..'.
2608 (defvar dired-re-no-dot
"^\\([^.]\\|\\.\\([^.]\\|\\..\\)\\).*")
2610 ;; Delete file, possibly delete a directory and all its files.
2611 ;; This function is usefull outside of dired. One could change it's name
2612 ;; to e.g. recursive-delete-file and put it somewhere else.
2613 (defun dired-delete-file (file &optional recursive trash
) "\
2614 Delete FILE or directory (possibly recursively if optional RECURSIVE is true.)
2615 RECURSIVE determines what to do with a non-empty directory. If RECURSIVE is:
2617 `always', delete recursively without asking.
2618 `top', ask for each directory at top level.
2619 Anything else, ask for each sub-directory."
2620 ;; This test is equivalent to
2621 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
2622 ;; but more efficient
2623 (if (not (eq t
(car (file-attributes file
))))
2624 (delete-file file trash
)
2626 (directory-files file t dired-re-no-dot
) ; Not empty.
2627 (or (eq recursive
'always
)
2628 (yes-or-no-p (format "Recursively %s %s? "
2630 delete-by-moving-to-trash
)
2633 (dired-make-relative file
)))))
2634 (if (eq recursive
'top
) (setq recursive
'always
)) ; Don't ask again.
2635 (setq recursive nil
))
2636 (delete-directory file recursive trash
)))
2638 (defun dired-do-flagged-delete (&optional nomessage
)
2639 "In Dired, delete the files flagged for deletion.
2640 If NOMESSAGE is non-nil, we don't display any message
2641 if there are no flagged files.
2642 `dired-recursive-deletes' controls whether deletion of
2643 non-empty directories is allowed."
2645 (let* ((dired-marker-char dired-del-marker
)
2646 (regexp (dired-marker-regexp))
2648 (if (save-excursion (goto-char (point-min))
2649 (re-search-forward regexp nil t
))
2650 (dired-internal-do-deletions
2651 ;; this can't move point since ARG is nil
2652 (dired-map-over-marks (cons (dired-get-filename) (point))
2656 (message "(No deletions requested)")))))
2658 (defun dired-do-delete (&optional arg
)
2659 "Delete all marked (or next ARG) files.
2660 `dired-recursive-deletes' controls whether deletion of
2661 non-empty directories is allowed."
2662 ;; This is more consistent with the file marking feature than
2663 ;; dired-do-flagged-delete.
2665 (dired-internal-do-deletions
2666 ;; this may move point if ARG is an integer
2667 (dired-map-over-marks (cons (dired-get-filename) (point))
2671 (defvar dired-deletion-confirmer
'yes-or-no-p
) ; or y-or-n-p?
2673 (defun dired-internal-do-deletions (l arg
&optional trash
)
2674 ;; L is an alist of files to delete, with their buffer positions.
2675 ;; ARG is the prefix arg.
2676 ;; Filenames are absolute.
2677 ;; (car L) *must* be the *last* (bottommost) file in the dired buffer.
2678 ;; That way as changes are made in the buffer they do not shift the
2679 ;; lines still to be changed, so the (point) values in L stay valid.
2680 ;; Also, for subdirs in natural order, a subdir's files are deleted
2681 ;; before the subdir itself - the other way around would not work.
2682 (let* ((files (mapcar (function car
) l
))
2685 (trashing (and trash delete-by-moving-to-trash
))
2687 (make-progress-reporter
2688 (if trashing
"Trashing..." "Deleting...")
2690 ;; canonicalize file list for pop up
2691 (setq files
(nreverse (mapcar (function dired-make-relative
) files
)))
2692 (if (dired-mark-pop-up
2693 " *Deletions*" 'delete files dired-deletion-confirmer
2695 (if trashing
"Trash" "Delete")
2696 (dired-mark-prompt arg files
)))
2698 (let (failures);; files better be in reverse order for this loop!
2700 (goto-char (cdr (car l
)))
2701 (let ((inhibit-read-only t
))
2703 (let ((fn (car (car l
))))
2704 (dired-delete-file fn dired-recursive-deletes trash
)
2705 ;; if we get here, removing worked
2706 (setq succ
(1+ succ
))
2707 (progress-reporter-update progress-reporter succ
)
2708 (dired-fun-in-all-buffers
2709 (file-name-directory fn
) (file-name-nondirectory fn
)
2710 (function dired-delete-entry
) fn
))
2711 (error;; catch errors from failed deletions
2712 (dired-log "%s\n" err
)
2713 (setq failures
(cons (car (car l
)) failures
)))))
2716 (progress-reporter-done progress-reporter
)
2718 (format "%d of %d deletion%s failed"
2719 (length failures
) count
2720 (dired-plural-s count
))
2722 (message "(No deletions performed)")))
2723 (dired-move-to-filename))
2725 (defun dired-fun-in-all-buffers (directory file fun
&rest args
)
2726 ;; In all buffers dired'ing DIRECTORY, run FUN with ARGS.
2727 ;; If the buffer has a wildcard pattern, check that it matches FILE.
2728 ;; (FILE does not include a directory component.)
2729 ;; FILE may be nil, in which case ignore it.
2730 ;; Return list of buffers where FUN succeeded (i.e., returned non-nil).
2732 (dolist (buf (dired-buffers-for-dir (expand-file-name directory
)
2734 (with-current-buffer buf
2735 (if (apply fun args
)
2736 (setq success-list
(cons (buffer-name buf
) success-list
)))))
2739 ;; Delete the entry for FILE from
2740 (defun dired-delete-entry (file)
2742 (and (dired-goto-file file
)
2743 (let ((inhibit-read-only t
))
2744 (delete-region (progn (beginning-of-line) (point))
2745 (save-excursion (forward-line 1) (point))))))
2746 (dired-clean-up-after-deletion file
))
2748 ;; This is a separate function for the sake of dired-x.el.
2749 (defun dired-clean-up-after-deletion (fn)
2750 ;; Clean up after a deleted file or directory FN.
2751 (save-excursion (and (cdr dired-subdir-alist
)
2752 (dired-goto-subdir fn
)
2753 (dired-kill-subdir))))
2757 (defun dired-marker-regexp ()
2758 (concat "^" (regexp-quote (char-to-string dired-marker-char
))))
2760 (defun dired-plural-s (count)
2761 (if (= 1 count
) "" "s"))
2763 (defun dired-mark-prompt (arg files
)
2764 "Return a string for use in a prompt, either the current file
2765 name, or the marker and a count of marked files."
2766 ;; distinguish-one-marked can cause the first element to be just t.
2767 (if (eq (car files
) t
) (setq files
(cdr files
)))
2768 (let ((count (length files
)))
2771 ;; more than 1 file:
2774 ;; Perhaps this is nicer, but it also takes more screen space:
2775 ;;(format "[%s %d files]" (if (> arg 0) "next" "previous")
2777 (format "[next %d files]" arg
)
2778 (format "%c [%d files]" dired-marker-char count
)))))
2780 (defun dired-pop-to-buffer (buf)
2781 "Pop up buffer BUF in a way suitable for Dired."
2782 (let ((split-window-preferred-function
2784 (or (and (let ((split-height-threshold 0))
2785 (window-splittable-p (selected-window)))
2786 ;; Try to split the selected window vertically if
2787 ;; that's possible. (Bug#1806)
2788 (split-window-vertically))
2789 ;; Otherwise, try to split WINDOW sensibly.
2790 (split-window-sensibly window
))))
2792 (pop-to-buffer (get-buffer-create buf
)))
2793 ;; If dired-shrink-to-fit is t, make its window fit its contents.
2794 (when dired-shrink-to-fit
2795 ;; Try to not delete window when we want to display less than
2796 ;; `window-min-height' lines.
2797 (fit-window-to-buffer (get-buffer-window buf
) nil
1)))
2799 (defcustom dired-no-confirm nil
2800 "A list of symbols for commands Dired should not confirm, or t.
2801 Command symbols are `byte-compile', `chgrp', `chmod', `chown', `compress',
2802 `copy', `delete', `hardlink', `load', `move', `print', `shell', `symlink',
2803 `touch' and `uncompress'.
2804 If t, confirmation is never needed."
2806 :type
'(choice (const :tag
"Confirmation never needed" t
)
2807 (set (const byte-compile
) (const chgrp
)
2808 (const chmod
) (const chown
) (const compress
)
2809 (const copy
) (const delete
) (const hardlink
)
2810 (const load
) (const move
) (const print
)
2811 (const shell
) (const symlink
) (const touch
)
2812 (const uncompress
))))
2814 (defun dired-mark-pop-up (bufname op-symbol files function
&rest args
)
2815 "Return FUNCTION's result on ARGS after showing which files are marked.
2816 Displays the file names in a buffer named BUFNAME;
2817 nil gives \" *Marked Files*\".
2818 This uses function `dired-pop-to-buffer' to do that.
2820 FUNCTION should not manipulate files, just read input
2821 (an argument or confirmation).
2822 The window is not shown if there is just one file or
2823 OP-SYMBOL is a member of the list in `dired-no-confirm'.
2824 FILES is the list of marked files. It can also be (t FILENAME)
2825 in the case of one marked file, to distinguish that from using
2826 just the current file."
2827 (or bufname
(setq bufname
" *Marked Files*"))
2828 (if (or (eq dired-no-confirm t
)
2829 (memq op-symbol dired-no-confirm
)
2830 ;; If FILES defaulted to the current line's file.
2831 (= (length files
) 1))
2832 (apply function args
)
2833 (with-current-buffer (get-buffer-create bufname
)
2835 ;; Handle (t FILE) just like (FILE), here.
2836 ;; That value is used (only in some cases), to mean
2837 ;; just one file that was marked, rather than the current line file.
2838 (dired-format-columns-of-files (if (eq (car files
) t
) (cdr files
) files
))
2839 (remove-text-properties (point-min) (point-max)
2840 '(mouse-face nil help-echo nil
)))
2841 (save-window-excursion
2842 (dired-pop-to-buffer bufname
)
2843 (apply function args
))))
2845 (defun dired-format-columns-of-files (files)
2846 (let ((beg (point)))
2847 (completion--insert-strings files
)
2848 (put-text-property beg
(point) 'mouse-face nil
)))
2850 ;; Commands to mark or flag file(s) at or near current line.
2852 (defun dired-repeat-over-lines (arg function
)
2853 ;; This version skips non-file lines.
2854 (let ((pos (make-marker)))
2856 (while (and (> arg
0) (not (eobp)))
2859 (while (and (not (eobp)) (dired-between-files)) (forward-line 1))
2862 (move-marker pos
(1+ (point))))
2863 (save-excursion (funcall function
))
2864 ;; Advance to the next line--actually, to the line that *was* next.
2865 ;; (If FUNCTION inserted some new lines in between, skip them.)
2867 (while (and (< arg
0) (not (bobp)))
2870 (while (and (not (bobp)) (dired-between-files)) (forward-line -
1))
2872 (save-excursion (funcall function
)))
2873 (move-marker pos nil
)
2874 (dired-move-to-filename)))
2876 (defun dired-between-files ()
2877 ;; This used to be a regexp match of the `total ...' line output by
2878 ;; ls, which is slightly faster, but that is not very robust; notably,
2879 ;; it fails for non-english locales.
2880 (save-excursion (not (dired-move-to-filename))))
2882 (defun dired-next-marked-file (arg &optional wrap opoint
)
2883 "Move to the next marked file, wrapping around the end of the buffer."
2884 (interactive "p\np")
2885 (or opoint
(setq opoint
(point)));; return to where interactively started
2887 (re-search-forward dired-re-mark nil t arg
)
2889 (re-search-backward dired-re-mark nil t
(- arg
)))
2890 (dired-move-to-filename)
2894 (error "No next marked file"))
2895 (message "(Wraparound for next marked file)")
2896 (goto-char (if (> arg
0) (point-min) (point-max)))
2897 (dired-next-marked-file arg nil opoint
))))
2899 (defun dired-prev-marked-file (arg &optional wrap
)
2900 "Move to the previous marked file, wrapping around the end of the buffer."
2901 (interactive "p\np")
2902 (dired-next-marked-file (- arg
) wrap
))
2904 (defun dired-file-marker (file)
2905 ;; Return FILE's marker, or nil if unmarked.
2907 (and (dired-goto-file file
)
2910 (if (not (equal ?
\040 (following-char)))
2911 (following-char))))))
2913 (defun dired-mark-files-in-region (start end
)
2914 (let ((inhibit-read-only t
))
2916 (error "start > end"))
2917 (goto-char start
) ; assumed at beginning of line
2918 (while (< (point) end
)
2919 ;; Skip subdir line and following garbage like the `total' line:
2920 (while (and (< (point) end
) (dired-between-files))
2922 (if (and (not (looking-at dired-re-dot
))
2923 (dired-get-filename nil t
))
2926 (insert dired-marker-char
)))
2929 (defun dired-mark (arg)
2930 "Mark the current (or next ARG) files.
2931 If on a subdir headerline, mark all its files except `.' and `..'.
2933 Use \\[dired-unmark-all-files] to remove all marks
2934 and \\[dired-unmark] on a subdir to remove the marks in
2937 (if (dired-get-subdir)
2938 (save-excursion (dired-mark-subdir-files))
2939 (let ((inhibit-read-only t
))
2940 (dired-repeat-over-lines
2941 (prefix-numeric-value arg
)
2942 (function (lambda () (delete-char 1) (insert dired-marker-char
)))))))
2944 (defun dired-unmark (arg)
2945 "Unmark the current (or next ARG) files.
2946 If looking at a subdir, unmark all its files except `.' and `..'."
2948 (let ((dired-marker-char ?
\040))
2951 (defun dired-flag-file-deletion (arg)
2952 "In Dired, flag the current line's file for deletion.
2953 With prefix arg, repeat over several lines.
2955 If on a subdir headerline, mark all its files except `.' and `..'."
2957 (let ((dired-marker-char dired-del-marker
))
2960 (defun dired-unmark-backward (arg)
2961 "In Dired, move up lines and remove deletion flag there.
2962 Optional prefix ARG says how many lines to unflag; default is one line."
2964 (dired-unmark (- arg
)))
2966 (defun dired-toggle-marks ()
2967 "Toggle marks: marked files become unmarked, and vice versa.
2968 Files marked with other flags (such as `D') are not affected.
2969 `.' and `..' are never toggled.
2970 As always, hidden subdirs are not affected."
2973 (goto-char (point-min))
2974 (let ((inhibit-read-only t
))
2976 (or (dired-between-files)
2977 (looking-at dired-re-dot
)
2978 ;; use subst instead of insdel because it does not move
2979 ;; the gap and thus should be faster and because
2980 ;; other characters are left alone automatically
2981 (apply 'subst-char-in-region
2982 (point) (1+ (point))
2983 (if (eq ?
\040 (following-char)) ; SPC
2984 (list ?
\040 dired-marker-char
)
2985 (list dired-marker-char ?
\040))))
2986 (forward-line 1)))))
2988 ;;; Commands to mark or flag files based on their characteristics or names.
2990 (defvar dired-regexp-history nil
2991 "History list of regular expressions used in Dired commands.")
2993 (defun dired-read-regexp (prompt)
2994 (read-from-minibuffer prompt nil nil nil
'dired-regexp-history
))
2996 (defun dired-mark-files-regexp (regexp &optional marker-char
)
2997 "Mark all files matching REGEXP for use in later commands.
2998 A prefix argument means to unmark them instead.
2999 `.' and `..' are never marked.
3001 REGEXP is an Emacs regexp, not a shell wildcard. Thus, use `\\.o$' for
3002 object files--just `.o' will mark more than you might think."
3004 (list (dired-read-regexp (concat (if current-prefix-arg
"Unmark" "Mark")
3005 " files (regexp): "))
3006 (if current-prefix-arg ?
\040)))
3007 (let ((dired-marker-char (or marker-char dired-marker-char
)))
3009 (and (not (looking-at dired-re-dot
))
3010 (not (eolp)) ; empty line
3011 (let ((fn (dired-get-filename nil t
)))
3012 (and fn
(string-match regexp
(file-name-nondirectory fn
)))))
3015 (defun dired-mark-files-containing-regexp (regexp &optional marker-char
)
3016 "Mark all files with contents containing REGEXP for use in later commands.
3017 A prefix argument means to unmark them instead.
3018 `.' and `..' are never marked."
3020 (list (dired-read-regexp (concat (if current-prefix-arg
"Unmark" "Mark")
3021 " files containing (regexp): "))
3022 (if current-prefix-arg ?
\040)))
3023 (let ((dired-marker-char (or marker-char dired-marker-char
)))
3025 (and (not (looking-at dired-re-dot
))
3026 (not (eolp)) ; empty line
3027 (let ((fn (dired-get-filename nil t
)))
3028 (when (and fn
(file-readable-p fn
)
3029 (not (file-directory-p fn
)))
3030 (let ((prebuf (get-file-buffer fn
)))
3031 (message "Checking %s" fn
)
3032 ;; For now we do it inside emacs
3033 ;; Grep might be better if there are a lot of files
3035 (with-current-buffer prebuf
3037 (goto-char (point-min))
3038 (re-search-forward regexp nil t
)))
3040 (insert-file-contents fn
)
3041 (goto-char (point-min))
3042 (re-search-forward regexp nil t
))))
3046 (defun dired-flag-files-regexp (regexp)
3047 "In Dired, flag all files containing the specified REGEXP for deletion.
3048 The match is against the non-directory part of the filename. Use `^'
3049 and `$' to anchor matches. Exclude subdirs by hiding them.
3050 `.' and `..' are never flagged."
3051 (interactive (list (dired-read-regexp "Flag for deletion (regexp): ")))
3052 (dired-mark-files-regexp regexp dired-del-marker
))
3054 (defun dired-mark-symlinks (unflag-p)
3055 "Mark all symbolic links.
3056 With prefix argument, unflag all those files."
3058 (let ((dired-marker-char (if unflag-p ?
\040 dired-marker-char
)))
3059 (dired-mark-if (looking-at dired-re-sym
) "symbolic link")))
3061 (defun dired-mark-directories (unflag-p)
3062 "Mark all directory file lines except `.' and `..'.
3063 With prefix argument, unflag all those files."
3065 (let ((dired-marker-char (if unflag-p ?
\040 dired-marker-char
)))
3066 (dired-mark-if (and (looking-at dired-re-dir
)
3067 (not (looking-at dired-re-dot
)))
3070 (defun dired-mark-executables (unflag-p)
3071 "Mark all executable files.
3072 With prefix argument, unflag all those files."
3074 (let ((dired-marker-char (if unflag-p ?
\040 dired-marker-char
)))
3075 (dired-mark-if (looking-at dired-re-exe
) "executable file")))
3077 ;; dired-x.el has a dired-mark-sexp interactive command: mark
3078 ;; files for which PREDICATE returns non-nil.
3080 (defun dired-flag-auto-save-files (&optional unflag-p
)
3081 "Flag for deletion files whose names suggest they are auto save files.
3082 A prefix argument says to unflag those files instead."
3084 (let ((dired-marker-char (if unflag-p ?
\040 dired-del-marker
)))
3086 ;; It is less than general to check for # here,
3087 ;; but it's the only way this runs fast enough.
3088 (and (save-excursion (end-of-line)
3090 (eq (preceding-char) ?
#)
3091 ;; Handle executables in case of -F option.
3092 ;; We need not worry about the other kinds
3093 ;; of markings that -F makes, since they won't
3094 ;; appear on real auto-save files.
3095 (if (eq (preceding-char) ?
*)
3098 (eq (preceding-char) ?
#)))))
3099 (not (looking-at dired-re-dir
))
3100 (let ((fn (dired-get-filename t t
)))
3101 (if fn
(auto-save-file-name-p
3102 (file-name-nondirectory fn
)))))
3105 (defcustom dired-garbage-files-regexp
3106 ;; `log' here is dubious, since it's typically used for useful log
3107 ;; files, not just TeX stuff. -- fx
3109 '(".log" ".toc" ".dvi" ".bak" ".orig" ".rej" ".aux"))
3111 "Regular expression to match \"garbage\" files for `dired-flag-garbage-files'."
3115 (defun dired-flag-garbage-files ()
3116 "Flag for deletion all files that match `dired-garbage-files-regexp'."
3118 (dired-flag-files-regexp dired-garbage-files-regexp
))
3120 (defun dired-flag-backup-files (&optional unflag-p
)
3121 "Flag all backup files (names ending with `~') for deletion.
3122 With prefix argument, unflag these files."
3124 (let ((dired-marker-char (if unflag-p ?\s dired-del-marker
)))
3126 ;; Don't call backup-file-name-p unless the last character looks like
3127 ;; it might be the end of a backup file name. This isn't very general,
3128 ;; but it's the only way this runs fast enough.
3129 (and (save-excursion (end-of-line)
3130 ;; Handle executables in case of -F option.
3131 ;; We need not worry about the other kinds
3132 ;; of markings that -F makes, since they won't
3133 ;; appear on real backup files.
3134 (if (eq (preceding-char) ?
*)
3136 (eq (preceding-char) ?~
))
3137 (not (looking-at dired-re-dir
))
3138 (let ((fn (dired-get-filename t t
)))
3139 (if fn
(backup-file-name-p fn
))))
3142 (defun dired-change-marks (&optional old new
)
3143 "Change all OLD marks to NEW marks.
3144 OLD and NEW are both characters used to mark files."
3146 (let* ((cursor-in-echo-area t
)
3147 (old (progn (message "Change (old mark): ") (read-char)))
3148 (new (progn (message "Change %c marks to (new mark): " old
)
3151 (if (or (eq old ?
\r) (eq new ?
\r))
3153 (let ((string (format "\n%c" old
))
3154 (inhibit-read-only t
))
3156 (goto-char (point-min))
3157 (while (search-forward string nil t
)
3160 (dired-get-filename 'no-dir t
))
3162 (subst-char-in-region (match-beginning 0)
3163 (match-end 0) old new
)))))))
3165 (defun dired-unmark-all-marks ()
3166 "Remove all marks from all files in the dired buffer."
3168 (dired-unmark-all-files ?
\r))
3170 (defun dired-unmark-all-files (mark &optional arg
)
3171 "Remove a specific mark (or any mark) from every file.
3172 After this command, type the mark character to remove,
3173 or type RET to remove all marks.
3174 With prefix arg, query for each marked file.
3175 Type \\[help-command] at that time for help."
3176 (interactive "cRemove marks (RET means all): \nP")
3179 (inhibit-read-only t
) case-fold-search query
3180 (string (format "\n%c" mark
))
3182 Type SPC or `y' to unmark one file, DEL or `n' to skip to next,
3183 `!' to unmark all remaining files with no more questions."))
3184 (goto-char (point-min))
3185 (while (if (eq mark ?
\r)
3186 (re-search-forward dired-re-mark nil t
)
3187 (search-forward string nil t
))
3189 (let ((file (dired-get-filename t t
)))
3191 (dired-query 'query
"Unmark file `%s'? "
3193 (progn (subst-char-in-region (1- (point)) (point)
3194 (preceding-char) ?\s
)
3195 (setq count
(1+ count
)))))
3196 (message (if (= count
1) "1 mark removed"
3200 ;; Logging failures operating on files, and showing the results.
3202 (defvar dired-log-buffer
"*Dired log*")
3205 "Pop up a buffer with error log output from Dired.
3206 A group of errors from a single command ends with a formfeed.
3207 Thus, use \\[backward-page] to find the beginning of a group of errors."
3209 (if (get-buffer dired-log-buffer
)
3210 (let ((owindow (selected-window))
3211 (window (display-buffer (get-buffer dired-log-buffer
))))
3214 (select-window window
)
3215 (goto-char (point-max))
3219 (select-window owindow
)))))
3221 (defun dired-log (log &rest args
)
3222 ;; Log a message or the contents of a buffer.
3223 ;; If LOG is a string and there are more args, it is formatted with
3224 ;; those ARGS. Usually the LOG string ends with a \n.
3225 ;; End each bunch of errors with (dired-log t):
3226 ;; this inserts the current time and buffer at the start of the page,
3227 ;; and \f (formfeed) at the end.
3228 (let ((obuf (current-buffer)))
3229 (with-current-buffer (get-buffer-create dired-log-buffer
)
3230 (goto-char (point-max))
3231 (let ((inhibit-read-only t
))
3232 (cond ((stringp log
)
3234 (apply (function format
) log args
)
3237 (insert-buffer-substring log
))
3242 (insert (current-time-string)
3243 "\tBuffer `" (buffer-name obuf
) "'\n")
3244 (goto-char (point-max))
3245 (insert "\f\n")))))))
3247 (defun dired-log-summary (string failures
)
3248 "State a summary of a command's failures, in echo area and log buffer.
3249 STRING is an overall summary of the failures.
3250 FAILURES is a list of file names that we failed to operate on,
3251 or nil if file names are not applicable."
3252 (if (= (length failures
) 1)
3254 (with-current-buffer dired-log-buffer
3255 (goto-char (point-max))
3257 (if (eolp) (forward-line 1))
3258 (buffer-substring (point) (point-max))))
3259 (message (if failures
"%s--type ? for details (%s)"
3260 "%s--type ? for details")
3262 ;; Log a summary describing a bunch of errors.
3263 (dired-log (concat "\n" string
"\n"))
3268 ;; Most ls can only sort by name or by date (with -t), nothing else.
3269 ;; GNU ls sorts on size with -S, on extension with -X, and unsorted with -U.
3270 ;; So anything that does not contain these is sort "by name".
3272 (defvar dired-ls-sorting-switches
"SXU"
3273 "String of `ls' switches \(single letters\) except \"t\" that influence sorting.
3275 This indicates to Dired which option switches to watch out for because they
3276 will change the sorting order behavior of `ls'.
3278 To change the default sorting order \(e.g. add a `-v' option\), see the
3279 variable `dired-listing-switches'. To temporarily override the listing
3280 format, use `\\[universal-argument] \\[dired]'.")
3282 (defvar dired-sort-by-date-regexp
3283 (concat "\\(\\`\\| \\)-[^- ]*t"
3284 ;; `dired-ls-sorting-switches' after -t overrides -t.
3285 "[^ " dired-ls-sorting-switches
"]*"
3286 "\\(\\(\\`\\| +\\)\\(--[^ ]+\\|-[^- t"
3287 dired-ls-sorting-switches
"]+\\)\\)* *$")
3288 "Regexp recognized by Dired to set `by date' mode.")
3290 (defvar dired-sort-by-name-regexp
3291 (concat "\\`\\(\\(\\`\\| +\\)\\(--[^ ]+\\|"
3292 "-[^- t" dired-ls-sorting-switches
"]+\\)\\)* *$")
3293 "Regexp recognized by Dired to set `by name' mode.")
3295 (defvar dired-sort-inhibit nil
3296 "Non-nil means the Dired sort command is disabled.
3297 The idea is to set this buffer-locally in special dired buffers.")
3299 (defun dired-sort-set-modeline ()
3300 ;; Set modeline display according to dired-actual-switches.
3301 ;; Modeline display of "by name" or "by date" guarantees the user a
3302 ;; match with the corresponding regexps. Non-matching switches are
3304 (when (eq major-mode
'dired-mode
)
3306 (let (case-fold-search)
3307 (cond ((string-match
3308 dired-sort-by-name-regexp dired-actual-switches
)
3311 dired-sort-by-date-regexp dired-actual-switches
)
3314 (concat "Dired " dired-actual-switches
)))))
3315 (force-mode-line-update)))
3317 (defun dired-sort-toggle-or-edit (&optional arg
)
3318 "Toggle sorting by date, and refresh the Dired buffer.
3319 With a prefix argument, edit the current listing switches instead."
3321 (when dired-sort-inhibit
3322 (error "Cannot sort this dired buffer"))
3325 (read-string "ls switches (must contain -l): " dired-actual-switches
))
3326 (dired-sort-toggle)))
3328 (defun dired-sort-toggle ()
3329 ;; Toggle between sort by date/name. Reverts the buffer.
3330 (let ((sorting-by-date (string-match dired-sort-by-date-regexp
3331 dired-actual-switches
))
3332 ;; Regexp for finding (possibly embedded) -t switches.
3333 (switch-regexp "\\(\\`\\| \\)-\\([a-su-zA-Z]*\\)\\(t\\)\\([^ ]*\\)")
3335 ;; Remove the -t switch.
3336 (while (string-match switch-regexp dired-actual-switches
)
3337 (if (and (equal (match-string 2 dired-actual-switches
) "")
3338 (equal (match-string 4 dired-actual-switches
) ""))
3339 ;; Remove a stand-alone -t switch.
3340 (setq dired-actual-switches
3341 (replace-match "" t t dired-actual-switches
))
3342 ;; Remove a switch of the form -XtY for some X and Y.
3343 (setq dired-actual-switches
3344 (replace-match "" t t dired-actual-switches
3))))
3345 ;; Now, if we weren't sorting by date before, add the -t switch.
3346 (unless sorting-by-date
3347 (setq dired-actual-switches
(concat dired-actual-switches
" -t"))))
3348 (dired-sort-set-modeline)
3351 ;; Some user code loads dired especially for this.
3352 ;; Don't do that--use replace-regexp-in-string instead.
3353 (defun dired-replace-in-string (regexp newtext string
)
3354 ;; Replace REGEXP with NEWTEXT everywhere in STRING and return result.
3355 ;; NEWTEXT is taken literally---no \\DIGIT escapes will be recognized.
3356 (let ((result "") (start 0) mb me
)
3357 (while (string-match regexp string start
)
3358 (setq mb
(match-beginning 0)
3360 result
(concat result
(substring string start mb
) newtext
)
3362 (concat result
(substring string start
))))
3364 (defun dired-sort-other (switches &optional no-revert
)
3365 "Specify new `ls' SWITCHES for current dired buffer.
3366 Values matching `dired-sort-by-date-regexp' or `dired-sort-by-name-regexp'
3367 set the minor mode accordingly, others appear literally in the mode line.
3368 With optional second arg NO-REVERT, don't refresh the listing afterwards."
3369 (dired-sort-R-check switches
)
3370 (setq dired-actual-switches switches
)
3371 (dired-sort-set-modeline)
3372 (or no-revert
(revert-buffer)))
3374 (defvar dired-subdir-alist-pre-R nil
3375 "Value of `dired-subdir-alist' before -R switch added.")
3376 (make-variable-buffer-local 'dired-subdir-alist-pre-R
)
3378 (defun dired-sort-R-check (switches)
3379 "Additional processing of -R in ls option string SWITCHES.
3380 Saves `dired-subdir-alist' when R is set and restores saved value
3381 minus any directories explicitly deleted when R is cleared.
3382 To be called first in body of `dired-sort-other', etc."
3384 ((and (string-match "R" switches
)
3385 (not (string-match "R" dired-actual-switches
)))
3386 ;; Adding -R to ls switches -- save `dired-subdir-alist':
3387 (setq dired-subdir-alist-pre-R dired-subdir-alist
))
3388 ((and (string-match "R" dired-actual-switches
)
3389 (not (string-match "R" switches
)))
3390 ;; Deleting -R from ls switches -- revert to pre-R subdirs
3391 ;; that are still present:
3392 (setq dired-subdir-alist
3393 (if dired-subdir-alist-pre-R
3395 (while dired-subdir-alist-pre-R
3396 (if (assoc (caar dired-subdir-alist-pre-R
)
3398 ;; subdir still present...
3400 (cons (car dired-subdir-alist-pre-R
)
3402 (setq dired-subdir-alist-pre-R
3403 (cdr dired-subdir-alist-pre-R
)))
3405 ;; No pre-R subdir alist, so revert to main directory
3407 (list (car (reverse dired-subdir-alist
))))))))
3410 ;;;; Drag and drop support
3412 (defcustom dired-recursive-copies
'top
3413 "Decide whether recursive copies are allowed.
3414 A value of nil means no recursive copies.
3415 `always' means copy recursively without asking.
3416 `top' means ask for each directory at top level.
3417 Anything else means ask for each directory."
3418 :type
'(choice :tag
"Copy directories"
3419 (const :tag
"No recursive copies" nil
)
3420 (const :tag
"Ask for each directory" t
)
3421 (const :tag
"Ask for each top directory only" top
)
3422 (const :tag
"Copy directories without asking" always
))
3425 (defun dired-dnd-popup-notice ()
3427 "Dired recursive copies are currently disabled.\nSee the variable `dired-recursive-copies'."))
3429 (declare-function x-popup-menu
"menu.c" (position menu
))
3431 (defun dired-dnd-do-ask-action (uri)
3432 ;; No need to get actions and descriptions from the source,
3433 ;; we only have three actions anyway.
3434 (let ((action (x-popup-menu
3436 (list "What action?"
3438 '(("Copy here" . copy
)
3439 ("Move here" . move
)
3440 ("Link here" . link
)
3442 ("Cancel" . nil
)))))))
3444 (dired-dnd-handle-local-file uri action
)
3447 (declare-function dired-relist-entry
"dired-aux" (file))
3448 (declare-function make-symbolic-link
"fileio.c")
3450 ;; Only used when (featurep 'dnd).
3451 (declare-function dnd-get-local-file-name
"dnd" (uri &optional must-exist
))
3452 (declare-function dnd-get-local-file-uri
"dnd" (uri))
3454 (defun dired-dnd-handle-local-file (uri action
)
3455 "Copy, move or link a file to the dired directory.
3456 URI is the file to handle, ACTION is one of copy, move, link or ask.
3457 Ask means pop up a menu for the user to select one of copy, move or link."
3458 (require 'dired-aux
)
3459 (let* ((from (dnd-get-local-file-name uri t
))
3461 (concat (dired-current-directory)
3462 (file-name-nondirectory from
)))))
3464 (cond ((eq action
'ask
)
3465 (dired-dnd-do-ask-action uri
))
3466 ;; If copying a directory and dired-recursive-copies is
3467 ;; nil, dired-copy-file fails. Pop up a notice.
3468 ((and (memq action
'(copy private
))
3469 (file-directory-p from
)
3470 (not dired-recursive-copies
))
3471 (dired-dnd-popup-notice))
3472 ((memq action
'(copy private move link
))
3473 (let ((overwrite (and (file-exists-p to
)
3475 (format "Overwrite existing file `%s'? " to
))))
3476 ;; Binding dired-overwrite-confirmed to nil makes
3477 ;; dired-handle-overwrite a no-op. We instead use
3478 ;; y-or-n-p, which pops a graphical menu.
3479 dired-overwrite-confirmed backup-file
)
3480 (when (and overwrite
3481 ;; d-b-o is defined in dired-aux.
3482 (boundp 'dired-backup-overwrite
)
3483 dired-backup-overwrite
3485 (car (find-backup-file-name to
)))
3486 (or (eq dired-backup-overwrite
'always
)
3489 "Make backup for existing file `%s'? " to
))))
3490 (rename-file to backup-file
0)
3491 (dired-relist-entry backup-file
))
3492 (cond ((memq action
'(copy private
))
3493 (dired-copy-file from to overwrite
))
3495 (dired-rename-file from to overwrite
))
3497 (make-symbolic-link from to overwrite
)))
3498 (dired-relist-entry to
)
3501 (defun dired-dnd-handle-file (uri action
)
3502 "Copy, move or link a file to the dired directory if it is a local file.
3503 URI is the file to handle. If the hostname in the URI isn't local, do nothing.
3504 ACTION is one of copy, move, link or ask.
3505 Ask means pop up a menu for the user to select one of copy, move or link."
3506 (let ((local-file (dnd-get-local-file-uri uri
)))
3507 (if local-file
(dired-dnd-handle-local-file local-file action
)
3511 ;;;; Desktop support
3513 (eval-when-compile (require 'desktop
))
3515 (defun dired-desktop-buffer-misc-data (desktop-dirname)
3516 "Auxiliary information to be saved in desktop file."
3518 ;; Value of `dired-directory'.
3519 (if (consp dired-directory
)
3520 ;; Directory name followed by list of files.
3521 (cons (desktop-file-name (car dired-directory
) desktop-dirname
)
3522 (cdr dired-directory
))
3523 ;; Directory name, optionally with shell wildcard.
3524 (desktop-file-name dired-directory desktop-dirname
))
3525 ;; Subdirectories in `dired-subdir-alist'.
3529 (function (lambda (f) (desktop-file-name (car f
) desktop-dirname
)))
3530 dired-subdir-alist
)))))
3532 (defun dired-restore-desktop-buffer (desktop-buffer-file-name
3534 desktop-buffer-misc
)
3535 "Restore a dired buffer specified in a desktop file."
3536 ;; First element of `desktop-buffer-misc' is the value of `dired-directory'.
3537 ;; This value is a directory name, optionally with shell wildcard or
3538 ;; a directory name followed by list of files.
3539 (let* ((dired-dir (car desktop-buffer-misc
))
3540 (dir (if (consp dired-dir
) (car dired-dir
) dired-dir
)))
3541 (if (file-directory-p (file-name-directory dir
))
3544 ;; The following elements of `desktop-buffer-misc' are the keys
3545 ;; from `dired-subdir-alist'.
3546 (mapc 'dired-maybe-insert-subdir
(cdr desktop-buffer-misc
))
3548 (message "Desktop: Directory %s no longer exists." dir
)
3549 (when desktop-missing-file-warning
(sit-for 1))
3552 (add-to-list 'desktop-buffer-mode-handlers
3553 '(dired-mode . dired-restore-desktop-buffer
))
3556 ;;; Start of automatically extracted autoloads.
3558 ;;;### (autoloads (dired-show-file-type dired-do-query-replace-regexp
3559 ;;;;;; dired-do-search dired-do-isearch-regexp dired-do-isearch
3560 ;;;;;; dired-isearch-filenames-regexp dired-isearch-filenames dired-isearch-filenames-setup
3561 ;;;;;; dired-hide-all dired-hide-subdir dired-tree-down dired-tree-up
3562 ;;;;;; dired-kill-subdir dired-mark-subdir-files dired-goto-subdir
3563 ;;;;;; dired-prev-subdir dired-insert-subdir dired-maybe-insert-subdir
3564 ;;;;;; dired-downcase dired-upcase dired-do-symlink-regexp dired-do-hardlink-regexp
3565 ;;;;;; dired-do-copy-regexp dired-do-rename-regexp dired-do-rename
3566 ;;;;;; dired-do-hardlink dired-do-symlink dired-do-copy dired-create-directory
3567 ;;;;;; dired-rename-file dired-copy-file dired-relist-file dired-remove-file
3568 ;;;;;; dired-add-file dired-do-redisplay dired-do-load dired-do-byte-compile
3569 ;;;;;; dired-do-compress dired-query dired-compress-file dired-do-kill-lines
3570 ;;;;;; dired-run-shell-command dired-do-shell-command dired-do-async-shell-command
3571 ;;;;;; dired-clean-directory dired-do-print dired-do-touch dired-do-chown
3572 ;;;;;; dired-do-chgrp dired-do-chmod dired-compare-directories dired-backup-diff
3573 ;;;;;; dired-diff) "dired-aux" "dired-aux.el" "e66465bcd1687d66cfb1202c9963d567")
3574 ;;; Generated autoloads from dired-aux.el
3576 (autoload 'dired-diff
"dired-aux" "\
3577 Compare file at point with file FILE using `diff'.
3578 FILE defaults to the file at the mark. (That's the mark set by
3579 \\[set-mark-command], not by Dired's \\[dired-mark] command.)
3580 The prompted-for file is the first file given to `diff'.
3581 With prefix arg, prompt for second argument SWITCHES,
3582 which is options for `diff'.
3584 \(fn FILE &optional SWITCHES)" t nil
)
3586 (autoload 'dired-backup-diff
"dired-aux" "\
3587 Diff this file with its backup file or vice versa.
3588 Uses the latest backup, if there are several numerical backups.
3589 If this file is a backup, diff it with its original.
3590 The backup file is the first file given to `diff'.
3591 With prefix arg, prompt for argument SWITCHES which is options for `diff'.
3593 \(fn &optional SWITCHES)" t nil
)
3595 (autoload 'dired-compare-directories
"dired-aux" "\
3596 Mark files with different file attributes in two dired buffers.
3597 Compare file attributes of files in the current directory
3598 with file attributes in directory DIR2 using PREDICATE on pairs of files
3599 with the same name. Mark files for which PREDICATE returns non-nil.
3600 Mark files with different names if PREDICATE is nil (or interactively
3601 with empty input at the predicate prompt).
3603 PREDICATE is a Lisp expression that can refer to the following variables:
3605 size1, size2 - file size in bytes
3606 mtime1, mtime2 - last modification time in seconds, as a float
3607 fa1, fa2 - list of file attributes
3608 returned by function `file-attributes'
3610 where 1 refers to attribute of file in the current dired buffer
3611 and 2 to attribute of file in second dired buffer.
3613 Examples of PREDICATE:
3615 (> mtime1 mtime2) - mark newer files
3616 (not (= size1 size2)) - mark files with different sizes
3617 (not (string= (nth 8 fa1) (nth 8 fa2))) - mark files with different modes
3618 (not (and (= (nth 2 fa1) (nth 2 fa2)) - mark files with different UID
3619 (= (nth 3 fa1) (nth 3 fa2)))) and GID.
3621 \(fn DIR2 PREDICATE)" t nil
)
3623 (autoload 'dired-do-chmod
"dired-aux" "\
3624 Change the mode of the marked (or next ARG) files.
3625 Symbolic modes like `g+w' are allowed.
3627 \(fn &optional ARG)" t nil
)
3629 (autoload 'dired-do-chgrp
"dired-aux" "\
3630 Change the group of the marked (or next ARG) files.
3632 \(fn &optional ARG)" t nil
)
3634 (autoload 'dired-do-chown
"dired-aux" "\
3635 Change the owner of the marked (or next ARG) files.
3637 \(fn &optional ARG)" t nil
)
3639 (autoload 'dired-do-touch
"dired-aux" "\
3640 Change the timestamp of the marked (or next ARG) files.
3643 \(fn &optional ARG)" t nil
)
3645 (autoload 'dired-do-print
"dired-aux" "\
3646 Print the marked (or next ARG) files.
3647 Uses the shell command coming from variables `lpr-command' and
3648 `lpr-switches' as default.
3650 \(fn &optional ARG)" t nil
)
3652 (autoload 'dired-clean-directory
"dired-aux" "\
3653 Flag numerical backups for deletion.
3654 Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
3655 Positive prefix arg KEEP overrides `dired-kept-versions';
3656 Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
3658 To clear the flags on these files, you can use \\[dired-flag-backup-files]
3659 with a prefix argument.
3663 (autoload 'dired-do-async-shell-command
"dired-aux" "\
3664 Run a shell command COMMAND on the marked files asynchronously.
3666 Like `dired-do-shell-command' but if COMMAND doesn't end in ampersand,
3667 adds `* &' surrounded by whitespace and executes the command asynchronously.
3668 The output appears in the buffer `*Async Shell Command*'.
3670 \(fn COMMAND &optional ARG FILE-LIST)" t nil
)
3672 (autoload 'dired-do-shell-command
"dired-aux" "\
3673 Run a shell command COMMAND on the marked files.
3674 If no files are marked or a specific numeric prefix arg is given,
3675 the next ARG files are used. Just \\[universal-argument] means the current file.
3676 The prompt mentions the file(s) or the marker, as appropriate.
3678 If there is a `*' in COMMAND, surrounded by whitespace, this runs
3679 COMMAND just once with the entire file list substituted there.
3681 If there is no `*', but there is a `?' in COMMAND, surrounded by
3682 whitespace, this runs COMMAND on each file individually with the
3683 file name substituted for `?'.
3685 Otherwise, this runs COMMAND on each file individually with the
3686 file name added at the end of COMMAND (separated by a space).
3688 `*' and `?' when not surrounded by whitespace have no special
3689 significance for `dired-do-shell-command', and are passed through
3690 normally to the shell, but you must confirm first. To pass `*' by
3691 itself to the shell as a wildcard, type `*\"\"'.
3693 If COMMAND produces output, it goes to a separate buffer.
3695 This feature does not try to redisplay Dired buffers afterward, as
3696 there's no telling what files COMMAND may have changed.
3697 Type \\[dired-do-redisplay] to redisplay the marked files.
3699 When COMMAND runs, its working directory is the top-level directory
3700 of the Dired buffer, so output files usually are created there
3701 instead of in a subdir.
3703 In a noninteractive call (from Lisp code), you must specify
3704 the list of file names explicitly with the FILE-LIST argument, which
3705 can be produced by `dired-get-marked-files', for example.
3707 \(fn COMMAND &optional ARG FILE-LIST)" t nil
)
3709 (autoload 'dired-run-shell-command
"dired-aux" "\
3712 \(fn COMMAND)" nil nil
)
3714 (autoload 'dired-do-kill-lines
"dired-aux" "\
3715 Kill all marked lines (not the files).
3716 With a prefix argument, kill that many lines starting with the current line.
3717 \(A negative argument kills backward.)
3718 If you use this command with a prefix argument to kill the line
3719 for a file that is a directory, which you have inserted in the
3720 Dired buffer as a subdirectory, then it deletes that subdirectory
3721 from the buffer as well.
3722 To kill an entire subdirectory (without killing its line in the
3723 parent directory), go to its directory header line and use this
3724 command with a prefix argument (the value does not matter).
3726 \(fn &optional ARG FMT)" t nil
)
3728 (autoload 'dired-compress-file
"dired-aux" "\
3731 \(fn FILE)" nil nil
)
3733 (autoload 'dired-query
"dired-aux" "\
3734 Format PROMPT with ARGS, query user, and store the result in SYM.
3735 The return value is either nil or t.
3737 The user may type y or SPC to accept once; n or DEL to skip once;
3738 ! to accept this and subsequent queries; or q or ESC to decline
3739 this and subsequent queries.
3741 If SYM is already bound to a non-nil value, this function may
3742 return automatically without querying the user. If SYM is !,
3743 return t; if SYM is q or ESC, return nil.
3745 \(fn SYM PROMPT &rest ARGS)" nil nil
)
3747 (autoload 'dired-do-compress
"dired-aux" "\
3748 Compress or uncompress marked (or next ARG) files.
3750 \(fn &optional ARG)" t nil
)
3752 (autoload 'dired-do-byte-compile
"dired-aux" "\
3753 Byte compile marked (or next ARG) Emacs Lisp files.
3755 \(fn &optional ARG)" t nil
)
3757 (autoload 'dired-do-load
"dired-aux" "\
3758 Load the marked (or next ARG) Emacs Lisp files.
3760 \(fn &optional ARG)" t nil
)
3762 (autoload 'dired-do-redisplay
"dired-aux" "\
3763 Redisplay all marked (or next ARG) files.
3764 If on a subdir line, redisplay that subdirectory. In that case,
3765 a prefix arg lets you edit the `ls' switches used for the new listing.
3767 Dired remembers switches specified with a prefix arg, so that reverting
3768 the buffer will not reset them. However, using `dired-undo' to re-insert
3769 or delete subdirectories can bypass this machinery. Hence, you sometimes
3770 may have to reset some subdirectory switches after a `dired-undo'.
3771 You can reset all subdirectory switches to the default using
3772 \\<dired-mode-map>\\[dired-reset-subdir-switches].
3773 See Info node `(emacs)Subdir switches' for more details.
3775 \(fn &optional ARG TEST-FOR-SUBDIR)" t nil
)
3777 (autoload 'dired-add-file
"dired-aux" "\
3780 \(fn FILENAME &optional MARKER-CHAR)" nil nil
)
3782 (autoload 'dired-remove-file
"dired-aux" "\
3785 \(fn FILE)" nil nil
)
3787 (autoload 'dired-relist-file
"dired-aux" "\
3788 Create or update the line for FILE in all Dired buffers it would belong in.
3790 \(fn FILE)" nil nil
)
3792 (autoload 'dired-copy-file
"dired-aux" "\
3795 \(fn FROM TO OK-FLAG)" nil nil
)
3797 (autoload 'dired-rename-file
"dired-aux" "\
3800 \(fn FILE NEWNAME OK-IF-ALREADY-EXISTS)" nil nil
)
3802 (autoload 'dired-create-directory
"dired-aux" "\
3803 Create a directory called DIRECTORY.
3805 \(fn DIRECTORY)" t nil
)
3807 (autoload 'dired-do-copy
"dired-aux" "\
3808 Copy all marked (or next ARG) files, or copy the current file.
3809 This normally preserves the last-modified date when copying.
3810 When operating on just the current file, you specify the new name.
3811 When operating on multiple or marked files, you specify a directory,
3812 and new copies of these files are made in that directory
3813 with the same names that the files currently have. The default
3814 suggested for the target directory depends on the value of
3815 `dired-dwim-target', which see.
3817 This command copies symbolic links by creating new ones,
3820 \(fn &optional ARG)" t nil
)
3822 (autoload 'dired-do-symlink
"dired-aux" "\
3823 Make symbolic links to current file or all marked (or next ARG) files.
3824 When operating on just the current file, you specify the new name.
3825 When operating on multiple or marked files, you specify a directory
3826 and new symbolic links are made in that directory
3827 with the same names that the files currently have. The default
3828 suggested for the target directory depends on the value of
3829 `dired-dwim-target', which see.
3831 For relative symlinks, use \\[dired-do-relsymlink].
3833 \(fn &optional ARG)" t nil
)
3835 (autoload 'dired-do-hardlink
"dired-aux" "\
3836 Add names (hard links) current file or all marked (or next ARG) files.
3837 When operating on just the current file, you specify the new name.
3838 When operating on multiple or marked files, you specify a directory
3839 and new hard links are made in that directory
3840 with the same names that the files currently have. The default
3841 suggested for the target directory depends on the value of
3842 `dired-dwim-target', which see.
3844 \(fn &optional ARG)" t nil
)
3846 (autoload 'dired-do-rename
"dired-aux" "\
3847 Rename current file or all marked (or next ARG) files.
3848 When renaming just the current file, you specify the new name.
3849 When renaming multiple or marked files, you specify a directory.
3850 This command also renames any buffers that are visiting the files.
3851 The default suggested for the target directory depends on the value
3852 of `dired-dwim-target', which see.
3854 \(fn &optional ARG)" t nil
)
3856 (autoload 'dired-do-rename-regexp
"dired-aux" "\
3857 Rename selected files whose names match REGEXP to NEWNAME.
3859 With non-zero prefix argument ARG, the command operates on the next ARG
3860 files. Otherwise, it operates on all the marked files, or the current
3861 file if none are marked.
3863 As each match is found, the user must type a character saying
3864 what to do with it. For directions, type \\[help-command] at that time.
3865 NEWNAME may contain \\=\\<n> or \\& as in `query-replace-regexp'.
3866 REGEXP defaults to the last regexp used.
3868 With a zero prefix arg, renaming by regexp affects the absolute file name.
3869 Normally, only the non-directory part of the file name is used and changed.
3871 \(fn REGEXP NEWNAME &optional ARG WHOLE-NAME)" t nil
)
3873 (autoload 'dired-do-copy-regexp
"dired-aux" "\
3874 Copy selected files whose names match REGEXP to NEWNAME.
3875 See function `dired-do-rename-regexp' for more info.
3877 \(fn REGEXP NEWNAME &optional ARG WHOLE-NAME)" t nil
)
3879 (autoload 'dired-do-hardlink-regexp
"dired-aux" "\
3880 Hardlink selected files whose names match REGEXP to NEWNAME.
3881 See function `dired-do-rename-regexp' for more info.
3883 \(fn REGEXP NEWNAME &optional ARG WHOLE-NAME)" t nil
)
3885 (autoload 'dired-do-symlink-regexp
"dired-aux" "\
3886 Symlink selected files whose names match REGEXP to NEWNAME.
3887 See function `dired-do-rename-regexp' for more info.
3889 \(fn REGEXP NEWNAME &optional ARG WHOLE-NAME)" t nil
)
3891 (autoload 'dired-upcase
"dired-aux" "\
3892 Rename all marked (or next ARG) files to upper case.
3894 \(fn &optional ARG)" t nil
)
3896 (autoload 'dired-downcase
"dired-aux" "\
3897 Rename all marked (or next ARG) files to lower case.
3899 \(fn &optional ARG)" t nil
)
3901 (autoload 'dired-maybe-insert-subdir
"dired-aux" "\
3902 Insert this subdirectory into the same dired buffer.
3903 If it is already present, just move to it (type \\[dired-do-redisplay] to refresh),
3904 else inserts it at its natural place (as `ls -lR' would have done).
3905 With a prefix arg, you may edit the ls switches used for this listing.
3906 You can add `R' to the switches to expand the whole tree starting at
3908 This function takes some pains to conform to `ls -lR' output.
3910 Dired remembers switches specified with a prefix arg, so that reverting
3911 the buffer will not reset them. However, using `dired-undo' to re-insert
3912 or delete subdirectories can bypass this machinery. Hence, you sometimes
3913 may have to reset some subdirectory switches after a `dired-undo'.
3914 You can reset all subdirectory switches to the default using
3915 \\<dired-mode-map>\\[dired-reset-subdir-switches].
3916 See Info node `(emacs)Subdir switches' for more details.
3918 \(fn DIRNAME &optional SWITCHES NO-ERROR-IF-NOT-DIR-P)" t nil
)
3920 (autoload 'dired-insert-subdir
"dired-aux" "\
3921 Insert this subdirectory into the same dired buffer.
3922 If it is already present, overwrites previous entry,
3923 else inserts it at its natural place (as `ls -lR' would have done).
3924 With a prefix arg, you may edit the `ls' switches used for this listing.
3925 You can add `R' to the switches to expand the whole tree starting at
3927 This function takes some pains to conform to `ls -lR' output.
3929 \(fn DIRNAME &optional SWITCHES NO-ERROR-IF-NOT-DIR-P)" t nil
)
3931 (autoload 'dired-prev-subdir
"dired-aux" "\
3932 Go to previous subdirectory, regardless of level.
3933 When called interactively and not on a subdir line, go to this subdir's line.
3935 \(fn ARG &optional NO-ERROR-IF-NOT-FOUND NO-SKIP)" t nil
)
3937 (autoload 'dired-goto-subdir
"dired-aux" "\
3938 Go to end of header line of DIR in this dired buffer.
3939 Return value of point on success, otherwise return nil.
3940 The next char is either \\n, or \\r if DIR is hidden.
3944 (autoload 'dired-mark-subdir-files
"dired-aux" "\
3945 Mark all files except `.' and `..' in current subdirectory.
3946 If the Dired buffer shows multiple directories, this command
3947 marks the files listed in the subdirectory that point is in.
3951 (autoload 'dired-kill-subdir
"dired-aux" "\
3952 Remove all lines of current subdirectory.
3953 Lower levels are unaffected.
3955 \(fn &optional REMEMBER-MARKS)" t nil
)
3957 (autoload 'dired-tree-up
"dired-aux" "\
3958 Go up ARG levels in the dired tree.
3962 (autoload 'dired-tree-down
"dired-aux" "\
3963 Go down in the dired tree.
3967 (autoload 'dired-hide-subdir
"dired-aux" "\
3968 Hide or unhide the current subdirectory and move to next directory.
3969 Optional prefix arg is a repeat factor.
3970 Use \\[dired-hide-all] to (un)hide all directories.
3974 (autoload 'dired-hide-all
"dired-aux" "\
3975 Hide all subdirectories, leaving only their header lines.
3976 If there is already something hidden, make everything visible again.
3977 Use \\[dired-hide-subdir] to (un)hide a particular subdirectory.
3979 \(fn &optional IGNORED)" t nil
)
3981 (autoload 'dired-isearch-filenames-setup
"dired-aux" "\
3982 Set up isearch to search in Dired file names.
3983 Intended to be added to `isearch-mode-hook'.
3987 (autoload 'dired-isearch-filenames
"dired-aux" "\
3988 Search for a string using Isearch only in file names in the Dired buffer.
3992 (autoload 'dired-isearch-filenames-regexp
"dired-aux" "\
3993 Search for a regexp using Isearch only in file names in the Dired buffer.
3997 (autoload 'dired-do-isearch
"dired-aux" "\
3998 Search for a string through all marked files using Isearch.
4002 (autoload 'dired-do-isearch-regexp
"dired-aux" "\
4003 Search for a regexp through all marked files using Isearch.
4007 (autoload 'dired-do-search
"dired-aux" "\
4008 Search through all marked files for a match for REGEXP.
4009 Stops when a match is found.
4010 To continue searching for next match, use command \\[tags-loop-continue].
4012 \(fn REGEXP)" t nil
)
4014 (autoload 'dired-do-query-replace-regexp
"dired-aux" "\
4015 Do `query-replace-regexp' of FROM with TO, on all marked files.
4016 Third arg DELIMITED (prefix arg) means replace only word-delimited matches.
4017 If you exit (\\[keyboard-quit], RET or q), you can resume the query replace
4018 with the command \\[tags-loop-continue].
4020 \(fn FROM TO &optional DELIMITED)" t nil
)
4022 (autoload 'dired-show-file-type
"dired-aux" "\
4023 Print the type of FILE, according to the `file' command.
4024 If FILE is a symbolic link and the optional argument DEREF-SYMLINKS is
4025 true then the type of the file linked to by FILE is printed instead.
4027 \(fn FILE &optional DEREF-SYMLINKS)" t nil
)
4031 ;;;### (autoloads (dired-do-relsymlink dired-jump) "dired-x" "dired-x.el"
4032 ;;;;;; "a2af6147cf06b53166d9e1a3bb200675")
4033 ;;; Generated autoloads from dired-x.el
4035 (autoload 'dired-jump
"dired-x" "\
4036 Jump to dired buffer corresponding to current buffer.
4037 If in a file, dired the current directory and move to file's line.
4038 If in Dired already, pop up a level and goto old directory's line.
4039 In case the proper dired file line cannot be found, refresh the dired
4040 buffer and try again.
4041 When OTHER-WINDOW is non-nil, jump to dired buffer in other window.
4042 Interactively with prefix argument, read FILE-NAME and
4043 move to its line in dired.
4045 \(fn &optional OTHER-WINDOW FILE-NAME)" t nil
)
4047 (autoload 'dired-do-relsymlink
"dired-x" "\
4048 Relative symlink all marked (or next ARG) files into a directory.
4049 Otherwise make a relative symbolic link to the current file.
4050 This creates relative symbolic links like
4054 not absolute ones like
4056 foo -> /ugly/file/name/that/may/change/any/day/bar/foo
4058 For absolute symlinks, use \\[dired-do-symlink].
4060 \(fn &optional ARG)" t nil
)
4064 ;;; End of automatically extracted autoloads.
4068 (run-hooks 'dired-load-hook
) ; for your customizations
4070 ;;; dired.el ends here