| blob | 08f2e28d05ecbda0e15e8153d6e1d5c24562e531 |
1 ;;; dired.el --- directory-browsing commands
3 ;; Copyright (C) 1985, 1986, 1992, 1993, 1994, 1995, 1996, 1997, 2000,
4 ;; 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
5 ;; Free Software Foundation, Inc.
7 ;; Author: Sebastian Kremer <sk@thp.uni-koeln.de>
8 ;; Maintainer: FSF
9 ;; Keywords: files
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 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/>.
26 ;;; Commentary:
28 ;; This is a major mode for directory browsing and editing. It is
29 ;; 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.
35 ;;; Code:
39 ;;; Customizable variables
42 "Directory editing."
47 "Handling marks in Dired."
52 ;;;###autoload
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."
65 "If non-nil, switches passed to `ls' for inserting subdirectories.
68 ; Don't use absolute file names as /bin should be in any PATH and people
69 ; may prefer /usr/local/gnu/bin or whatever. However, chown is
70 ; usually not in PATH.
72 ;;;###autoload
76 "chown"
78 "/usr/sbin/chown"
92 "Informs Dired about how `ls -lF' marks symbolic links.
93 Set this to t if `ls' (or whatever program is specified by
94 `insert-directory-program') with `-lF' marks the symbolic link
95 itself with a trailing @ (usually the case under Ultrix).
97 Example: if `ln -s foo bar; ls -F bar' gives `bar -> foo', set it to
98 nil (the default), if it gives `bar@ -> foo', set it to t.
100 Dired checks if there is really a @ appended. Thus, if you have a
101 marking `ls' program on one host and a non-marking on another host, and
102 don't care about symbolic links which really end in a @, you can
103 always set this variable to t."
107 ;;;###autoload
109 "Regexp of files to skip when finding first file of a directory.
110 A value of nil means move to the subdir line.
111 A value of t means move to first file."
114 regexp)
118 ;; Use t as default so that moved files "take their markers with them".
119 "Controls marking of renamed files.
120 If t, files keep their previous marks when they are renamed.
121 If a character, renamed files (whether previously marked or not)
122 are afterward marked with that character."
128 "Controls marking of copied files.
129 If t, copied files are marked if and as the corresponding original files were.
130 If a character, copied files are unconditionally marked with that character."
136 "Controls marking of newly made hard links.
137 If t, they are marked if and as the files linked to were marked.
138 If a character, new links are unconditionally marked with that character."
144 "Controls marking of newly made symbolic 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."
152 "If non-nil, Dired tries to guess a default target directory.
153 This means: if there is a dired buffer displayed in the next window,
154 use its current subdir, instead of the current subdir of this dired buffer.
156 The target is used in the prompt for file copy, rename etc."
161 "If non-nil, Dired preserves the last-modified time in a file copy.
162 \(This works on only some systems.)"
166 ; These variables were deleted and the replacements are on files.el.
167 ; We leave aliases behind for back-compatibility.
171 ;;; Hook variables
174 "Run after loading Dired.
175 You can customize key bindings or load extensions with this."
180 "Run at the very end of `dired-mode'."
185 "This hook is run before a dired buffer is read in (created or reverted)."
190 "Hook run after each time a file or directory is read by Dired.
191 After each listing of a file or directory, this hook is run
192 with the buffer narrowed to the listing."
195 ;; Note this can't simply be run inside function `dired-ls' as the hook
196 ;; functions probably depend on the dired-subdir-alist to be OK.
202 "The functions to call when a drop in `dired-mode' is made.
203 See `dnd-protocol-alist' for more information. When nil, behave
204 as in other buffers. Changing this option is effective only for
205 new dired buffers."
211 ;; Internal variables
214 ;; so that you can write things like
215 ;; (let ((dired-marker-char ?X))
216 ;; ;; great code using X markers ...
217 ;; )
218 ;; For example, commands operating on two sets of files, A and B.
219 ;; Or marking files with digits 0-9. This could implicate
220 ;; concentric sets or an order for the marked files.
221 ;; The code depends on dynamic scoping on the marker char.
222 "In Dired, the current mark character.
229 ;; I see no reason ever to make this nil -- rms.
230 ;; (> baud-rate search-slow-speed)
237 ;;;###autoload
239 "The directory name or wildcard spec that this dired directory lists.
240 Local to each dired buffer. May be a list, in which case the car is the
241 directory name and the cdr is the list of files to mention.
250 ;; These regexps must be tested at beginning-of-line, but are also
251 ;; used to search for next matches, so neither omitting "^" nor
252 ;; replacing "^" by "\n" (to make it slightly faster) will work.
255 ;; "Regexp matching a marked line.
256 ;; Important: the match ends just after the marker."
258 ;; The [^:] part after "d" and "l" is to avoid confusion with the
259 ;; DOS/Windows-style drive letters in directory names, like in "d:/foo".
267 "-[-r][-w].[-r][-w][xs][-r][-w]."
273 ;; The subdirectory names in the next two lists are expanded.
275 "Association list of subdirectories and their buffer positions.
276 Each subdirectory has an element: (DIRNAME . STARTMARKER).
277 The order of elements is the reverse of the order in the buffer.
281 "Keeps track of which switches to use for inserted subdirectories.
289 "Regexp matching a maybe hidden subdirectory line in `ls -lR' output.
290 Subexpression 1 is the subdirectory proper, no trailing colon.
291 The match starts at the beginning of the line and ends after the end
296 "Faces used by Dired."
302 "Face used for directory headers."
310 "Face used for dired marks."
318 "Face used for marked files."
326 "Face used for flagged files."
333 ;; Inherit from font-lock-warning-face since with min-colors 8
334 ;; font-lock-comment-face is not colored any more.
336 "Face used to highlight a part of a buffer that needs user attention."
344 ;; Inherit from font-lock-comment-delimiter-face since with min-colors 8
345 ;; font-lock-comment-face is not colored any more.
347 "Face used to highlight permissions of group- and world-writable files."
355 "Face used for subdirectories."
363 "Face used for symbolic links."
371 "Face used for files suffixed with `completion-ignored-extensions'."
379 ;;
380 ;; Dired marks.
382 ;;
383 ;; We make heavy use of MATCH-ANCHORED, since the regexps don't identify the
384 ;; file name itself. We search for Dired defined regexps, and then use the
385 ;; Dired defined function `dired-move-to-filename' before searching for the
386 ;; simple regexp ".+". It is that regexp which matches the file name.
387 ;;
388 ;; Marked files.
391 ;;
392 ;; Flagged files.
395 ;; People who are paranoid about security would consider this more
396 ;; important than other things such as whether it is a directory.
397 ;; But we don't want to encourage paranoia, so our default
398 ;; should be what's most useful for non-paranoids. -- rms.
399 ;;; ;;
400 ;;; ;; Files that are group or world writable.
401 ;;; (list (concat dired-re-maybe-mark dired-re-inode-size
402 ;;; "\\([-d]\\(....w....\\|.......w.\\)\\)")
403 ;;; '(1 dired-warning-face)
404 ;;; '(".+" (dired-move-to-filename) nil (0 dired-warning-face)))
405 ;; However, we don't need to highlight the file name, only the
406 ;; permissions, to win generally. -- fx.
407 ;; Fixme: we could also put text properties on the permission
408 ;; fields with keymaps to frob the permissions, somewhat a la XEmacs.
415 ;;
416 ;; Subdirectories.
419 ;;
420 ;; Symbolic links.
423 ;;
424 ;; Files suffixed with `completion-ignored-extensions'.
426 ;; It is quicker to first find just an extension, then go back to the
427 ;; start of that file name. So we do this complex MATCH-ANCHORED form.
430 ;;
431 ;; Files suffixed with `completion-ignored-extensions'
432 ;; plus a character put in by -F.
438 ;; If the last character is not part of the filename,
439 ;; move back to the start of the filename
440 ;; so it can be fontified.
441 ;; Otherwise, leave point at the end of the line;
442 ;; that way, nothing is fontified.
446 ;;
447 ;; Explicitly put the default face on file names ending in a colon to
448 ;; avoid fontifying them as directory header.
451 ;;
452 ;; Directory headers.
454 )
458 \f
459 ;;; Macros must be defined before they are used, for the byte compiler.
462 "Mark all files for which PREDICATE evals to non-nil.
463 PREDICATE is evaluated on each line, with point at beginning of line.
464 MSG is a noun phrase for the type of files being marked.
465 It should end with a noun that can be pluralized by adding `s'.
466 Return value is the number of files marked, or nil if none were marked."
480 count
481 ,msg
489 distinguish-one-marked)
490 "Eval BODY with point on each marked line. Return a list of BODY's results.
491 If no marked file could be found, execute BODY on the current line.
492 ARG, if non-nil, specifies the files to use instead of the marked files.
493 If ARG is an integer, use the next ARG (or previous -ARG, if
494 ARG<0) files. In that case, point is dragged along. This is
495 so that commands on the next ARG (instead of the marked) files
496 can be chained easily.
497 For any other non-nil value of ARG, use the current file.
498 If optional third arg SHOW-PROGRESS evaluates to non-nil,
499 redisplay the dired buffer after each file is processed.
500 No guarantee is made about the position on the marked line.
501 BODY must ensure this itself if it depends on this.
502 Search starts at the beginning of the buffer, thus the car of the list
503 corresponds to the line nearest to the buffer's bottom. This
504 is also true for (positive and negative) integer values of ARG.
505 BODY should not be too long as it is expanded four times.
507 If DISTINGUISH-ONE-MARKED is non-nil, then if we find just one marked file,
508 return (t FILENAME) instead of (FILENAME)."
509 ;;
510 ;;Warning: BODY must not add new lines before point - this may cause an
511 ;;endless loop.
512 ;;This warning should not apply any longer, sk 2-Sep-1991 14:10.
519 ,arg
525 results))
526 ;; non-nil, non-integer ARG means use current file:
531 ;; remember position of next marked file before BODY
532 ;; can insert lines before the just found file,
533 ;; confusing us by finding the same marked file again
534 ;; and again and...
542 ;; move after last match
551 results
553 ;; save-excursion loses, again
557 "Return the marked files' names as list of strings.
558 The list is in the same order as the buffer, that is, the car is the
559 first marked file.
560 Values returned are normally absolute file names.
561 Optional arg LOCALP as in `dired-get-filename'.
562 Optional second argument ARG, if non-nil, specifies files near
563 point instead of marked files. It usually comes from the prefix
564 argument.
565 If ARG is an integer, use the next ARG files.
566 Any other non-nil value means to use the current file instead.
567 Optional third argument FILTER, if non-nil, is a function to select
568 some of the files--those for which (funcall FILTER FILENAME) is non-nil.
570 If DISTINGUISH-ONE-MARKED is non-nil, then if we find just one marked file,
571 return (t FILENAME) instead of (FILENAME).
572 Don't use that together with FILTER."
577 arg nil distinguish-one-marked)))
578 result)
581 all-of-them
586 result)))
587 \f
588 ;; The dired command
591 ;; For use in interactive.
595 dired-listing-switches))
596 ;; If a dialog is about to be used, call read-directory-name so
597 ;; the dialog code knows we want directories. Some dialogs can
598 ;; only select directories or files when popped up, not both.
601 nil default-directory nil)
603 nil default-directory nil)))))
605 ;; We want to switch to a more sophisticated version of
606 ;; dired-read-dir-and-switches like the following, if there is a way
607 ;; to make it more intuitive. See bug#1285.
609 ;; (defun dired-read-dir-and-switches (str)
610 ;; ;; For use in interactive.
611 ;; (reverse
612 ;; (list
613 ;; (if current-prefix-arg
614 ;; (read-string "Dired listing switches: "
615 ;; dired-listing-switches))
616 ;; ;; If a dialog is about to be used, call read-directory-name so
617 ;; ;; the dialog code knows we want directories. Some dialogs can
618 ;; ;; only select directories or files when popped up, not both.
619 ;; (if (next-read-file-uses-dialog-p)
620 ;; (read-directory-name (format "Dired %s(directory): " str)
621 ;; nil default-directory nil)
622 ;; (let ((cie ()))
623 ;; (dolist (ext completion-ignored-extensions)
624 ;; (if (eq ?/ (aref ext (1- (length ext)))) (push ext cie)))
625 ;; (setq cie (concat (regexp-opt cie "\\(?:") "\\'"))
626 ;; (lexical-let* ((default (and buffer-file-name
627 ;; (abbreviate-file-name buffer-file-name)))
628 ;; (cie cie)
629 ;; (completion-table
630 ;; ;; We need a mix of read-file-name and
631 ;; ;; read-directory-name so that completion to directories
632 ;; ;; is preferred, but if the user wants to enter a global
633 ;; ;; pattern, he can still use completion on filenames to
634 ;; ;; help him write the pattern.
635 ;; ;; Essentially, we want to use
636 ;; ;; (completion-table-with-predicate
637 ;; ;; 'read-file-name-internal 'file-directory-p nil)
638 ;; ;; but that doesn't work because read-file-name-internal
639 ;; ;; does not obey its `predicate' argument.
640 ;; (completion-table-in-turn
641 ;; (lambda (str pred action)
642 ;; (let ((read-file-name-predicate
643 ;; (lambda (f)
644 ;; (and (not (member f '("./" "../")))
645 ;; ;; Hack! Faster than file-directory-p!
646 ;; (eq (aref f (1- (length f))) ?/)
647 ;; (not (string-match cie f))))))
648 ;; (complete-with-action
649 ;; action 'read-file-name-internal str nil)))
650 ;; 'read-file-name-internal)))
651 ;; (minibuffer-with-setup-hook
652 ;; (lambda ()
653 ;; (setq minibuffer-default default)
654 ;; (setq minibuffer-completion-table completion-table))
655 ;; (read-file-name (format "Dired %s(directory): " str)
656 ;; nil default-directory nil))))))))
659 "Try to get a file name at point in the current dired buffer.
660 This hook is inteneded to be put in `file-name-at-point-functions'."
667 ;;;###autoload (define-key ctl-x-map "d" 'dired)
668 ;;;###autoload
671 Optional second argument SWITCHES specifies the `ls' options used.
672 \(Interactively, use a prefix argument to be able to specify SWITCHES.)
673 Dired displays a list of files in DIRNAME (which may also have
674 shell wildcards appended to select certain files). If DIRNAME is a cons,
675 its first element is taken as the directory name and the rest as an explicit
676 list of files to make directory entries for.
678 You can move around in it with the usual commands.
683 If DIRNAME is already in a dired buffer, that buffer is used without refresh."
684 ;; Cannot use (interactive "D") because of wildcards.
688 ;;;###autoload (define-key ctl-x-4-map "d" 'dired-other-window)
689 ;;;###autoload
695 ;;;###autoload (define-key ctl-x-5-map "d" 'dired-other-frame)
696 ;;;###autoload
702 ;;;###autoload
704 "Like `dired' but returns the dired buffer as value, does not select it."
706 ;; This loses the distinction between "/foo/*/" and "/foo/*" that
707 ;; some shells make:
718 ;; If the argument was syntactically a directory name not a file name,
719 ;; or if it happens to name a file that is a directory,
720 ;; convert it syntactically to a directory name.
721 ;; The reason for checking initially-was-dirname
722 ;; and not just file-directory-p
723 ;; is that file-directory-p is slow over ftp.
731 ;; The following is an internal dired function. It returns non-nil if
732 ;; the directory visited by the current dired buffer has changed on
733 ;; disk. DIRNAME should be the directory name of that directory.
742 "Return non-nil if current dired buffer needs updating.
743 If NOCONFIRM is non-nil, then this function always returns nil
744 for a remote directory. This feature is used by Auto Revert Mode."
750 ;; Do not auto-revert when the dired buffer can be currently
751 ;; written by the user as in `wdired-mode'.
752 buffer-read-only
755 ;;;###autoload
757 "Automatically revert dired buffer on revisiting.
758 If t, revisiting an existing dired buffer automatically reverts it.
759 If its value is a function, call this function with the directory
760 name as single argument and revert the buffer if it returns non-nil.
761 Otherwise, a message offering to revert the changed dired buffer
762 is displayed.
763 Note that this is not the same as `auto-revert-mode' that
764 periodically reverts at specified time intervals."
774 ;; If there is an existing dired buffer for DIRNAME, just leave
775 ;; buffer as it is (don't even call dired-revert).
776 ;; This saves time especially for deep trees or with ange-ftp.
777 ;; The user can type `g' easily, and it is more consistent with find-file.
778 ;; But if SWITCHES are given they are probably different from the
779 ;; buffer's old value, so call dired-sort-other, which does
780 ;; revert the buffer.
781 ;; A pity we can't possibly do "Directory has changed - refresh? "
782 ;; like find-file does.
783 ;; Optional argument MODE is passed to dired-find-buffer-nocreate,
784 ;; see there.
787 ;; Look for an existing buffer.
789 ;; Note that buffer already is in dired-mode, if found.
796 ;; file list may have changed
798 ;; this calls dired-revert
800 ;; Always revert regardless of whether it has changed or not.
803 ;; Revert when predicate function returns non-nil.
808 ;; If directory has changed on disk, offer to revert.
813 ;; Else a new buffer
815 ;; We can do this unconditionally
816 ;; because dired-noselect ensures that the name
817 ;; is passed in directory name syntax
818 ;; if it was the name of a directory at all.
823 ;; default-directory and dired-actual-switches are set now
824 ;; (buffer-local), so we can call dired-readin:
829 ;; dired-readin can fail if parent directories are inaccessible.
830 ;; Don't leave an empty buffer around in that case.
835 buffer))
838 ;; Enlarged by dired-advertise
839 ;; Queried by function dired-buffers-for-dir. When this detects a
840 ;; killed buffer, it is removed from this list.
844 ;; This differs from dired-buffers-for-dir in that it does not consider
845 ;; subdirs of default-directory and searches for the first match only.
846 ;; Also, the major mode must be MODE.
855 dired-directory ;; nil during find-alternate-file
860 dired-directory))))
862 blist nil)
864 found))
866 \f
867 ;; Read in a new dired buffer
870 "Read in a new dired buffer.
871 Differs from `dired-insert-subdir' in that it accepts
872 wildcards, erases the buffer, and builds the subdir-alist anew
873 \(including making it buffer-local and clearing it first)."
875 ;; default-directory and dired-actual-switches must be buffer-local
876 ;; and initialized by now.
878 ;; This makes readin much much faster.
879 ;; In particular, it prevents the font lock hook from running
880 ;; until the directory is all read in.
887 ;; This hook which may want to modify dired-actual-switches
888 ;; based on dired-directory, e.g. with ange-ftp to a SysV host
889 ;; where ls won't understand -Al switches.
897 ;; Don't make undo entries for readin.
903 ;; Must first make alist buffer local and set it to nil because
904 ;; dired-build-subdir-alist will call dired-clear-alist first
911 ;; No need to narrow since the whole buffer contains just
912 ;; dired-readin's output, nothing else. The hook can
913 ;; successfully use dired functions (e.g. dired-get-filename)
914 ;; as the subdir-alist has been built in dired-readin.
917 ;; Subroutines of dired-readin
920 ;; Insert listing for the specified dir (and maybe file list)
921 ;; already in dired-directory, assuming a clean buffer.
927 file-list nil))
931 ;; If we are reading a whole single directory...
936 ;; Else treat it as a wildcard spec
937 ;; unless we have an explicit list of files.
942 "Align the fields of a file to the ones of surrounding lines.
943 BEG..END is the line where the file info is located."
944 ;; Some versions of ls try to adjust the size of each field so as to just
945 ;; hold the largest element ("largest" in the current invocation, of
946 ;; course). So when a single line is output, the size of each field is
947 ;; just big enough for that one output. Thus when dired refreshes one
948 ;; line, the alignment if this line w.r.t the rest is messed up because
949 ;; the fields of that one line will generally be smaller.
950 ;;
951 ;; To work around this problem, we here add spaces to try and
952 ;; re-align the fields as needed. Since this is purely aesthetic,
953 ;; it is of utmost importance that it doesn't mess up anything like
954 ;; `dired-move-to-filename'. To this end, we limit ourselves to
955 ;; adding spaces only, and to only add them at places where there
956 ;; was already at least one space. This way, as long as
957 ;; `directory-listing-before-filename-regexp' always matches spaces
958 ;; with "*" or "+", we know we haven't made anything worse. There
959 ;; is one spot where the exact number of spaces is important, which
960 ;; is just before the actual filename, so we refrain from adding
961 ;; spaces there (and within the filename as well, of course).
964 ;; Check that there is indeed a file, and that there is anoter adjacent
965 ;; file with which to align, and that additional spaces are needed to
966 ;; align the filenames.
979 ;; Make sure there is some work left to do.
981 ;; If we've only looked at the line above, check to see if the line
982 ;; below exists as well and if so, align with the shorter one.
991 ;; Keep positions uptodate when we insert stuff.
994 ;; Main loop.
998 ;; Don't touch anything just before (and after) the
999 ;; beginning of the filename.
1001 ;; We're now just in front of a field, with a space behind us.
1003 ;; Nums are right-aligned.
1005 ;; Let's look at the other line, in the same column: we
1006 ;; should be either near the end of the previous field, or
1007 ;; in the space between that field and the next.
1008 ;; [ Of course, it's also possible that we're already within
1009 ;; the next field or even past it, but that's unlikely since
1010 ;; other-col > file-col. ]
1011 ;; Let's find the distance to the alignment-point (either
1012 ;; the beginning or the end of the next field, depending on
1013 ;; whether this field is left or right aligned).
1023 ;; Now, the number of spaces to insert is align-pt-offset
1024 ;; minus the distance to the equivalent point on the
1025 ;; current line.
1028 align-pt-offset
1038 ;; Let's just make really sure we did not mess up.
1041 ;; Damn! We messed up: let's revert the change.
1043 ;; Now skip to next field.
1049 "Insert a directory listing of DIR, Dired style.
1050 Use SWITCHES to make the listings.
1051 If FILE-LIST is non-nil, list only those files.
1052 Otherwise, if WILDCARD is non-nil, expand wildcards;
1053 in that case, DIR should be a file name that uses wildcards.
1054 In other cases, DIR should be a directory name or a directory filename.
1055 If HDR is non-nil, insert a header line with the directory name."
1058 end)
1061 ;; We used to specify the C locale here, to force English month names;
1062 ;; but this should not be necessary any more,
1063 ;; with the new value of `directory-listing-before-filename-regexp'.
1068 ;; Re-align fields, if necessary.
1071 ;; Quote certain characters, unless ls quoted them for us.
1080 nil t))
1086 nil t))
1089 ;; If we used --dired and it worked, the lines are already indented.
1090 ;; Otherwise, indent them.
1096 ;; Insert text at the beginning to standardize things.
1102 ;; Note that dired-build-subdir-alist will replace the name
1103 ;; by its expansion, so it does not matter whether what we insert
1104 ;; here is fully expanded, but it should be absolute.
1107 ;; Insert "wildcard" line where "total" line would be for a full dir.
1111 "Make the file names highlight when the mouse is on them."
1123 dired-filename t
1127 \f
1128 ;; Reverting a dired buffer
1131 "Reread the dired buffer.
1132 Must also be called after `dired-actual-switches' have changed.
1133 Should not fail even on completely garbaged buffers.
1134 Preserves old cursor, marks/flags, hidden-p."
1146 ;; treat top level dir extra (it may contain wildcards)
1153 ;; Run dired-after-readin-hook just once, below.
1158 ;; ... run the hook for the whole buffer, and only after markers
1159 ;; have been reinserted (else omitting in dired-x would omit marked files)
1167 ;; outside of the let scope
1168 ;;; Might as well not override the user if the user changed this.
1169 ;;; (setq buffer-read-only t)
1170 )
1172 ;; Subroutines of dired-revert
1173 ;; Some of these are also used when inserting subdirs.
1176 "Return current positions in the buffer and all windows with this directory.
1177 The positions have the form (BUFFER-POSITION WINDOW-POSITIONS).
1179 BUFFER-POSITION is the point position in the current dired buffer.
1180 It has the form (BUFFER DIRED-FILENAME BUFFER-POINT).
1182 WINDOW-POSITIONS are current positions in all windows displaying
1183 this dired buffer. The window positions have the form (WINDOW
1184 DIRED-FILENAME WINDOW-POINT)."
1195 "Restore POSITIONS saved with `dired-save-positions'."
1203 ;; Ensure that window still displays the original buffer.
1212 "Return alist of files and their marks, from BEG to END."
1223 alist))
1226 "Mark all files remembered in ALIST.
1227 Each element of ALIST looks like (FILE . MARKERCHAR)."
1241 "Return a list of names of subdirs currently hidden."
1251 result))
1254 "Try to insert all subdirs that were displayed before.
1255 Do so according to the former subdir alist OLD-SUBDIR-ALIST."
1269 "Remove directory DIR from any directory cache."
1273 \f
1274 ;; dired mode key bindings and initialization
1277 ;; This looks ugly when substitute-command-keys uses C-d instead d:
1278 ;; (define-key dired-mode-map "\C-d" 'dired-flag-file-deletion)
1283 ;; Commands to mark or flag certain categories of files
1287 ;; Upper case keys (except !) for operating on the marked files
1306 ;; Comparison commands
1309 ;; Tree Dired commands
1315 ;; move to marked files
1318 ;; Make all regexp commands share a `%' prefix:
1319 ;; We used to get to the submap via a symbol dired-regexp-prefix,
1320 ;; but that seems to serve little purpose, and copy-keymap
1321 ;; does a better job without it.
1334 ;; Commands for marking and unmarking.
1351 ;; Lower keys for commands not operating on all the marked files
1378 ;; moving
1386 (define-key map [up] 'dired-previous-line)
1387 ;; hiding
1388 (define-key map "$" 'dired-hide-subdir)
1389 (define-key map "\M-$" 'dired-hide-all)
1390 ;; isearch
1391 (define-key map (kbd "M-s a C-s") 'dired-do-isearch)
1392 (define-key map (kbd "M-s a M-C-s") 'dired-do-isearch-regexp)
1393 (define-key map (kbd "M-s f C-s") 'dired-isearch-filenames)
1394 (define-key map (kbd "M-s f M-C-s") 'dired-isearch-filenames-regexp)
1395 ;; misc
1396 (define-key map "\C-x\C-q" 'dired-toggle-read-only)
1397 (define-key map "?" 'dired-summary)
1399 (define-key map [remap undo] 'dired-undo)
1400 (define-key map [remap advertised-undo] 'dired-undo)
1401 ;; thumbnail manipulation (image-dired)
1402 (define-key map "\C-td" 'image-dired-display-thumbs)
1403 (define-key map "\C-tt" 'image-dired-tag-files)
1404 (define-key map "\C-tr" 'image-dired-delete-tag)
1405 (define-key map "\C-tj" 'image-dired-jump-thumbnail-buffer)
1406 (define-key map "\C-ti" 'image-dired-dired-display-image)
1407 (define-key map "\C-tx" 'image-dired-dired-display-external)
1408 (define-key map "\C-ta" 'image-dired-display-thumbs-append)
1409 (define-key map "\C-t." 'image-dired-display-thumb)
1410 (define-key map "\C-tc" 'image-dired-dired-comment-files)
1411 (define-key map "\C-tf" 'image-dired-mark-tagged-files)
1412 (define-key map "\C-t\C-t" 'image-dired-dired-insert-marked-thumbs)
1413 (define-key map "\C-te" 'image-dired-dired-edit-comment-and-tags)
1414 ;; encryption and decryption (epa-dired)
1415 (define-key map ":d" 'epa-dired-do-decrypt)
1416 (define-key map ":v" 'epa-dired-do-verify)
1417 (define-key map ":s" 'epa-dired-do-sign)
1418 (define-key map ":e" 'epa-dired-do-encrypt)
1420 ;; Make menu bar items.
1422 ;; No need to fo this, now that top-level items are fewer.
1423 ;;;;
1424 ;; Get rid of the Edit menu bar item to save space.
1425 ;(define-key map [menu-bar edit] 'undefined)
1427 (define-key map [menu-bar subdir]
1428 (cons "Subdir" (make-sparse-keymap "Subdir")))
1430 (define-key map [menu-bar subdir hide-all]
1431 '(menu-item "Hide All" dired-hide-all
1432 :help "Hide all subdirectories, leave only header lines"))
1433 (define-key map [menu-bar subdir hide-subdir]
1434 '(menu-item "Hide/UnHide Subdir" dired-hide-subdir
1435 :help "Hide or unhide current directory listing"))
1436 (define-key map [menu-bar subdir tree-down]
1437 '(menu-item "Tree Down" dired-tree-down
1438 :help "Go to first subdirectory header down the tree"))
1439 (define-key map [menu-bar subdir tree-up]
1440 '(menu-item "Tree Up" dired-tree-up
1441 :help "Go to first subdirectory header up the tree"))
1442 (define-key map [menu-bar subdir up]
1443 '(menu-item "Up Directory" dired-up-directory
1444 :help "Edit the parent directory"))
1445 (define-key map [menu-bar subdir prev-subdir]
1446 '(menu-item "Prev Subdir" dired-prev-subdir
1447 :help "Go to previous subdirectory header line"))
1448 (define-key map [menu-bar subdir next-subdir]
1449 '(menu-item "Next Subdir" dired-next-subdir
1450 :help "Go to next subdirectory header line"))
1451 (define-key map [menu-bar subdir prev-dirline]
1452 '(menu-item "Prev Dirline" dired-prev-dirline
1453 :help "Move to next directory-file line"))
1454 (define-key map [menu-bar subdir next-dirline]
1455 '(menu-item "Next Dirline" dired-next-dirline
1456 :help "Move to previous directory-file line"))
1457 (define-key map [menu-bar subdir insert]
1458 '(menu-item "Insert This Subdir" dired-maybe-insert-subdir
1459 :help "Insert contents of subdirectory"
1460 :enable (let ((f (dired-get-filename nil t)))
1461 (and f (file-directory-p f)))))
1462 (define-key map [menu-bar immediate]
1463 (cons "Immediate" (make-sparse-keymap "Immediate")))
1465 (define-key map
1466 [menu-bar immediate image-dired-dired-display-external]
1467 '(menu-item "Display Image Externally" image-dired-dired-display-external
1468 :help "Display image in external viewer"))
1469 (define-key map
1470 [menu-bar immediate image-dired-dired-display-image]
1471 '(menu-item "Display Image" image-dired-dired-display-image
1472 :help "Display sized image in a separate window"))
1474 (define-key map [menu-bar immediate revert-buffer]
1475 '(menu-item "Refresh" revert-buffer
1476 :help "Update contents of shown directories"))
1478 (define-key map [menu-bar immediate dashes]
1479 '("--"))
1481 (define-key map [menu-bar immediate isearch-filenames-regexp]
1482 '(menu-item "Isearch Regexp in File Names..." dired-isearch-filenames-regexp
1483 :help "Incrementally search for regexp in file names only"))
1484 (define-key map [menu-bar immediate isearch-filenames]
1485 '(menu-item "Isearch in File Names..." dired-isearch-filenames
1486 :help "Incrementally search for string in file names only."))
1487 (define-key map [menu-bar immediate compare-directories]
1488 '(menu-item "Compare Directories..." dired-compare-directories
1489 :help "Mark files with different attributes in two dired buffers"))
1490 (define-key map [menu-bar immediate backup-diff]
1491 '(menu-item "Compare with Backup" dired-backup-diff
1492 :help "Diff file at cursor with its latest backup"))
1493 (define-key map [menu-bar immediate diff]
1494 '(menu-item "Diff..." dired-diff
1495 :help "Compare file at cursor with another file"))
1496 (define-key map [menu-bar immediate view]
1497 '(menu-item "View This File" dired-view-file
1498 :help "Examine file at cursor in read-only mode"))
1499 (define-key map [menu-bar immediate display]
1500 '(menu-item "Display in Other Window" dired-display-file
1501 :help "Display file at cursor in other window"))
1502 (define-key map [menu-bar immediate find-file-other-window]
1503 '(menu-item "Find in Other Window" dired-find-file-other-window
1504 :help "Edit file at cursor in other window"))
1505 (define-key map [menu-bar immediate find-file]
1506 '(menu-item "Find This File" dired-find-file
1507 :help "Edit file at cursor"))
1508 (define-key map [menu-bar immediate create-directory]
1509 '(menu-item "Create Directory..." dired-create-directory
1510 :help "Create a directory"))
1511 (define-key map [menu-bar immediate wdired-mode]
1512 '(menu-item "Edit File Names" wdired-change-to-wdired-mode
1513 :help "Put a dired buffer in a mode in which filenames are editable"
1514 :keys "C-x C-q"
1515 :filter (lambda (x) (if (eq major-mode 'dired-mode) x))))
1517 (define-key map [menu-bar regexp]
1518 (cons "Regexp" (make-sparse-keymap "Regexp")))
1520 (define-key map
1521 [menu-bar regexp image-dired-mark-tagged-files]
1522 '(menu-item "Mark From Image Tag..." image-dired-mark-tagged-files
1523 :help "Mark files whose image tags matches regexp"))
1525 (define-key map [menu-bar regexp dashes-1]
1526 '("--"))
1528 (define-key map [menu-bar regexp downcase]
1529 '(menu-item "Downcase" dired-downcase
1530 ;; When running on plain MS-DOS, there's only one
1531 ;; letter-case for file names.
1532 :enable (or (not (fboundp 'msdos-long-file-names))
1533 (msdos-long-file-names))
1534 :help "Rename marked files to lower-case name"))
1535 (define-key map [menu-bar regexp upcase]
1536 '(menu-item "Upcase" dired-upcase
1537 :enable (or (not (fboundp 'msdos-long-file-names))
1538 (msdos-long-file-names))
1539 :help "Rename marked files to upper-case name"))
1540 (define-key map [menu-bar regexp hardlink]
1541 '(menu-item "Hardlink..." dired-do-hardlink-regexp
1542 :help "Make hard links for files matching regexp"))
1543 (define-key map [menu-bar regexp symlink]
1544 '(menu-item "Symlink..." dired-do-symlink-regexp
1545 :visible (fboundp 'make-symbolic-link)
1546 :help "Make symbolic links for files matching regexp"))
1547 (define-key map [menu-bar regexp rename]
1548 '(menu-item "Rename..." dired-do-rename-regexp
1549 :help "Rename marked files matching regexp"))
1550 (define-key map [menu-bar regexp copy]
1551 '(menu-item "Copy..." dired-do-copy-regexp
1552 :help "Copy marked files matching regexp"))
1553 (define-key map [menu-bar regexp flag]
1554 '(menu-item "Flag..." dired-flag-files-regexp
1555 :help "Flag files matching regexp for deletion"))
1556 (define-key map [menu-bar regexp mark]
1557 '(menu-item "Mark..." dired-mark-files-regexp
1558 :help "Mark files matching regexp for future operations"))
1559 (define-key map [menu-bar regexp mark-cont]
1560 '(menu-item "Mark Containing..." dired-mark-files-containing-regexp
1561 :help "Mark files whose contents matches regexp"))
1563 (define-key map [menu-bar mark]
1564 (cons "Mark" (make-sparse-keymap "Mark")))
1566 (define-key map [menu-bar mark prev]
1567 '(menu-item "Previous Marked" dired-prev-marked-file
1568 :help "Move to previous marked file"))
1569 (define-key map [menu-bar mark next]
1570 '(menu-item "Next Marked" dired-next-marked-file
1571 :help "Move to next marked file"))
1572 (define-key map [menu-bar mark marks]
1573 '(menu-item "Change Marks..." dired-change-marks
1574 :help "Replace marker with another character"))
1575 (define-key map [menu-bar mark unmark-all]
1576 '(menu-item "Unmark All" dired-unmark-all-marks))
1577 (define-key map [menu-bar mark symlinks]
1578 '(menu-item "Mark Symlinks" dired-mark-symlinks
1579 :visible (fboundp 'make-symbolic-link)
1580 :help "Mark all symbolic links"))
1581 (define-key map [menu-bar mark directories]
1582 '(menu-item "Mark Directories" dired-mark-directories
1583 :help "Mark all directories except `.' and `..'"))
1584 (define-key map [menu-bar mark directory]
1585 '(menu-item "Mark Old Backups" dired-clean-directory
1586 :help "Flag old numbered backups for deletion"))
1587 (define-key map [menu-bar mark executables]
1588 '(menu-item "Mark Executables" dired-mark-executables
1589 :help "Mark all executable files"))
1590 (define-key map [menu-bar mark garbage-files]
1591 '(menu-item "Flag Garbage Files" dired-flag-garbage-files
1592 :help "Flag unneeded files for deletion"))
1593 (define-key map [menu-bar mark backup-files]
1594 '(menu-item "Flag Backup Files" dired-flag-backup-files
1595 :help "Flag all backup files for deletion"))
1596 (define-key map [menu-bar mark auto-save-files]
1597 '(menu-item "Flag Auto-save Files" dired-flag-auto-save-files
1598 :help "Flag auto-save files for deletion"))
1599 (define-key map [menu-bar mark deletion]
1600 '(menu-item "Flag" dired-flag-file-deletion
1601 :help "Flag current line's file for deletion"))
1602 (define-key map [menu-bar mark unmark]
1603 '(menu-item "Unmark" dired-unmark
1604 :help "Unmark or unflag current line's file"))
1605 (define-key map [menu-bar mark mark]
1606 '(menu-item "Mark" dired-mark
1607 :help "Mark current line's file for future operations"))
1608 (define-key map [menu-bar mark toggle-marks]
1609 '(menu-item "Toggle Marks" dired-toggle-marks
1610 :help "Mark unmarked files, unmark marked ones"))
1612 (define-key map [menu-bar operate]
1613 (cons "Operate" (make-sparse-keymap "Operate")))
1615 (define-key map
1616 [menu-bar operate image-dired-delete-tag]
1617 '(menu-item "Delete Image Tag..." image-dired-delete-tag
1618 :help "Delete image tag from current or marked files"))
1619 (define-key map
1620 [menu-bar operate image-dired-tag-files]
1621 '(menu-item "Add Image Tags..." image-dired-tag-files
1622 :help "Add image tags to current or marked files"))
1623 (define-key map
1624 [menu-bar operate image-dired-dired-comment-files]
1625 '(menu-item "Add Image Comment..." image-dired-dired-comment-files
1626 :help "Add image comment to current or marked files"))
1627 (define-key map
1628 [menu-bar operate image-dired-display-thumbs]
1629 '(menu-item "Display image thumbnails" image-dired-display-thumbs
1630 :help "Display image thumbnails for current or marked image files"))
1632 (define-key map [menu-bar operate dashes-4]
1633 '("--"))
1635 (define-key map
1636 [menu-bar operate epa-dired-do-decrypt]
1637 '(menu-item "Decrypt" epa-dired-do-decrypt
1638 :help "Decrypt file at cursor"))
1640 (define-key map
1641 [menu-bar operate epa-dired-do-verify]
1642 '(menu-item "Verify" epa-dired-do-verify
1643 :help "Verify digital signature of file at cursor"))
1645 (define-key map
1646 [menu-bar operate epa-dired-do-sign]
1647 '(menu-item "Sign" epa-dired-do-sign
1648 :help "Create digital signature of file at cursor"))
1650 (define-key map
1651 [menu-bar operate epa-dired-do-encrypt]
1652 '(menu-item "Encrypt" epa-dired-do-encrypt
1653 :help "Encrypt file at cursor"))
1655 (define-key map [menu-bar operate dashes-3]
1656 '("--"))
1658 (define-key map [menu-bar operate query-replace]
1659 '(menu-item "Query Replace in Files..." dired-do-query-replace-regexp
1660 :help "Replace regexp in marked files"))
1661 (define-key map [menu-bar operate search]
1662 '(menu-item "Search Files..." dired-do-search
1663 :help "Search marked files for regexp"))
1664 (define-key map [menu-bar operate isearch-regexp]
1665 '(menu-item "Isearch Regexp Files..." dired-do-isearch-regexp
1666 :help "Incrementally search marked files for regexp"))
1667 (define-key map [menu-bar operate isearch]
1668 '(menu-item "Isearch Files..." dired-do-isearch
1669 :help "Incrementally search marked files for string"))
1670 (define-key map [menu-bar operate chown]
1671 '(menu-item "Change Owner..." dired-do-chown
1672 :visible (not (memq system-type '(ms-dos windows-nt)))
1673 :help "Change the owner of marked files"))
1674 (define-key map [menu-bar operate chgrp]
1675 '(menu-item "Change Group..." dired-do-chgrp
1676 :visible (not (memq system-type '(ms-dos windows-nt)))
1677 :help "Change the group of marked files"))
1678 (define-key map [menu-bar operate chmod]
1679 '(menu-item "Change Mode..." dired-do-chmod
1680 :help "Change mode (attributes) of marked files"))
1681 (define-key map [menu-bar operate touch]
1682 '(menu-item "Change Timestamp..." dired-do-touch
1683 :help "Change timestamp of marked files"))
1684 (define-key map [menu-bar operate load]
1685 '(menu-item "Load" dired-do-load
1686 :help "Load marked Emacs Lisp files"))
1687 (define-key map [menu-bar operate compile]
1688 '(menu-item "Byte-compile" dired-do-byte-compile
1689 :help "Byte-compile marked Emacs Lisp files"))
1690 (define-key map [menu-bar operate compress]
1691 '(menu-item "Compress" dired-do-compress
1692 :help "Compress/uncompress marked files"))
1693 (define-key map [menu-bar operate print]
1694 '(menu-item "Print..." dired-do-print
1695 :help "Ask for print command and print marked files"))
1696 (define-key map [menu-bar operate hardlink]
1697 '(menu-item "Hardlink to..." dired-do-hardlink
1698 :help "Make hard links for current or marked files"))
1699 (define-key map [menu-bar operate symlink]
1700 '(menu-item "Symlink to..." dired-do-symlink
1701 :visible (fboundp 'make-symbolic-link)
1702 :help "Make symbolic links for current or marked files"))
1703 (define-key map [menu-bar operate async-command]
1704 '(menu-item "Asynchronous Shell Command..." dired-do-async-shell-command
1705 :help "Run a shell command asynchronously on current or marked files"))
1706 (define-key map [menu-bar operate command]
1707 '(menu-item "Shell Command..." dired-do-shell-command
1708 :help "Run a shell command on current or marked files"))
1709 (define-key map [menu-bar operate delete]
1710 '(menu-item "Delete" dired-do-delete
1711 :help "Delete current file or all marked files"))
1712 (define-key map [menu-bar operate rename]
1713 '(menu-item "Rename to..." dired-do-rename
1714 :help "Rename current file or move marked files"))
1715 (define-key map [menu-bar operate copy]
1716 '(menu-item "Copy to..." dired-do-copy
1717 :help "Copy current file or all marked files"))
1719 map)
1720 "Local keymap for `dired-mode' buffers.")
1721 \f
1722 ;; Dired mode is suitable only for specially formatted data.
1723 (put 'dired-mode 'mode-class 'special)
1725 ;; Autoload cookie needed by desktop.el
1726 ;;;###autoload
1727 (defun dired-mode (&optional dirname switches)
1728 "\
1731 \(optionally) its subdirectories, in the format of `ls -lR'.
1734 compress, load or byte-compile them, change their file attributes
1737 by file or all files matching certain criteria.
1739 Letters no longer insert themselves. Digits are prefix arguments.
1742 Most commands operate on the marked files and use the current file
1743 if no files are marked. Use a numeric prefix argument to operate on
1744 the next ARG (or previous -ARG if ARG<0) files, or just `1'
1745 to operate on the current file only. Prefix arguments override marks.
1747 to see why something went wrong.
1752 (or dired it in another buffer, if it is a directory).
1759 This retains all marks and hides subdirs again that were hidden before.
1760 SPC and DEL can be used to move down and up by lines.
1763 to read the
1765 to relist a single or the marked files or a
1767 again for the directory tree.
1770 for more info):
1772 `dired-listing-switches'
1773 `dired-trivial-filenames'
1774 `dired-shrink-to-fit'
1775 `dired-marker-char'
1776 `dired-del-marker'
1777 `dired-keep-marker-rename'
1778 `dired-keep-marker-copy'
1779 `dired-keep-marker-hardlink'
1780 `dired-keep-marker-symlink'
1784 `dired-before-readin-hook'
1785 `dired-after-readin-hook'
1786 `dired-mode-hook'
1787 `dired-load-hook'
1789 Keybindings:
1791 ;; Not to be called interactively (e.g. dired-directory will be set
1792 ;; to default-directory, which is wrong with wildcards).
1793 (kill-all-local-variables)
1794 (use-local-map dired-mode-map)
1795 (dired-advertise) ; default-directory is already set
1796 (setq major-mode 'dired-mode
1797 mode-name "Dired"
1798 ;; case-fold-search nil
1799 buffer-read-only t
1800 selective-display t ; for subdirectory hiding
1801 mode-line-buffer-identification
1802 (propertized-buffer-identification "%17b"))
1803 (set (make-local-variable 'revert-buffer-function)
1804 (function dired-revert))
1805 (set (make-local-variable 'buffer-stale-function)
1806 (function dired-buffer-stale-p))
1807 (set (make-local-variable 'page-delimiter)
1809 (set (make-local-variable 'dired-directory)
1810 (or dirname default-directory))
1811 ;; list-buffers uses this to display the dir being edited in this buffer.
1812 (setq list-buffers-directory
1813 (expand-file-name (if (listp dired-directory)
1814 (car dired-directory)
1815 dired-directory)))
1816 (set (make-local-variable 'dired-actual-switches)
1817 (or switches dired-listing-switches))
1818 (set (make-local-variable 'font-lock-defaults)
1819 '(dired-font-lock-keywords t nil nil beginning-of-line))
1820 (set (make-local-variable 'desktop-save-buffer)
1821 'dired-desktop-buffer-misc-data)
1822 (setq dired-switches-alist nil)
1823 (dired-sort-other dired-actual-switches t)
1824 (when (featurep 'dnd)
1825 (set (make-local-variable 'dnd-protocol-alist)
1826 (append dired-dnd-protocol-alist dnd-protocol-alist)))
1827 (add-hook 'file-name-at-point-functions 'dired-file-name-at-point nil t)
1828 (add-hook 'isearch-mode-hook 'dired-isearch-filenames-setup nil t)
1829 (run-mode-hooks 'dired-mode-hook))
1830 \f
1831 ;; Idiosyncratic dired commands that don't deal with marks.
1833 (defun dired-summary ()
1834 "Summarize basic Dired commands and show recent dired errors."
1835 (interactive)
1836 (dired-why)
1837 ;>> this should check the key-bindings and use substitute-command-keys if non-standard
1838 (message
1839 "d-elete, u-ndelete, x-punge, f-ind, o-ther window, R-ename, C-opy, h-elp"))
1841 (defun dired-undo ()
1842 "Undo in a dired buffer.
1843 This doesn't recover lost files, it just undoes changes in the buffer itself.
1844 You can use it to recover marks, killed lines or subdirs."
1845 (interactive)
1846 (let ((inhibit-read-only t))
1847 (undo))
1848 (dired-build-subdir-alist)
1849 (message "Change in dired buffer undone.
1850 Actual changes in files cannot be undone by Emacs."))
1852 (defun dired-toggle-read-only ()
1853 "Edit dired buffer with Wdired, or set it read-only.
1854 Call `wdired-change-to-wdired-mode' in dired buffers whose editing is
1855 supported by Wdired (the major mode of the dired buffer is `dired-mode').
1856 Otherwise, for buffers inheriting from dired-mode, call `toggle-read-only'."
1857 (interactive)
1858 (if (eq major-mode 'dired-mode)
1859 (wdired-change-to-wdired-mode)
1860 (toggle-read-only)))
1862 (defun dired-next-line (arg)
1863 "Move down lines then position at filename.
1864 Optional prefix ARG says how many lines to move; default is one line."
1865 (interactive "p")
1866 (forward-line arg)
1867 (dired-move-to-filename))
1869 (defun dired-previous-line (arg)
1870 "Move up lines then position at filename.
1871 Optional prefix ARG says how many lines to move; default is one line."
1872 (interactive "p")
1873 (forward-line (- arg))
1874 (dired-move-to-filename))
1876 (defun dired-next-dirline (arg &optional opoint)
1877 "Goto ARG'th next directory file line."
1878 (interactive "p")
1879 (or opoint (setq opoint (point)))
1880 (if (if (> arg 0)
1881 (re-search-forward dired-re-dir nil t arg)
1882 (beginning-of-line)
1883 (re-search-backward dired-re-dir nil t (- arg)))
1884 (dired-move-to-filename) ; user may type `i' or `f'
1885 (goto-char opoint)
1886 (error "No more subdirectories")))
1888 (defun dired-prev-dirline (arg)
1889 "Goto ARG'th previous directory file line."
1890 (interactive "p")
1891 (dired-next-dirline (- arg)))
1893 (defun dired-up-directory (&optional other-window)
1894 "Run Dired on parent directory of current directory.
1895 Find the parent directory either in this buffer or another buffer.
1896 Creates a buffer if necessary."
1897 (interactive "P")
1898 (let* ((dir (dired-current-directory))
1899 (up (file-name-directory (directory-file-name dir))))
1900 (or (dired-goto-file (directory-file-name dir))
1901 ;; Only try dired-goto-subdir if buffer has more than one dir.
1902 (and (cdr dired-subdir-alist)
1903 (dired-goto-subdir up))
1904 (progn
1905 (if other-window
1906 (dired-other-window up)
1907 (dired up))
1908 (dired-goto-file dir)))))
1910 (defun dired-get-file-for-visit ()
1911 "Get the current line's file name, with an error if file does not exist."
1912 (interactive)
1913 ;; We pass t for second arg so that we don't get error for `.' and `..'.
1914 (let ((raw (dired-get-filename nil t))
1915 file-name)
1916 (if (null raw)
1917 (error "No file on this line"))
1918 (setq file-name (file-name-sans-versions raw t))
1919 (if (file-exists-p file-name)
1920 file-name
1921 (if (file-symlink-p file-name)
1922 (error "File is a symlink to a nonexistent target")
1923 (error "File no longer exists; type `g' to update dired buffer")))))
1925 ;; Force C-m keybinding rather than `f' or `e' in the mode doc:
1926 (define-obsolete-function-alias 'dired-advertised-find-file 'dired-find-file "23.2")
1927 (defun dired-find-file ()
1928 "In Dired, visit the file or directory named on this line."
1929 (interactive)
1930 ;; Bind `find-file-run-dired' so that the command works on directories
1931 ;; too, independent of the user's setting.
1932 (let ((find-file-run-dired t))
1933 (find-file (dired-get-file-for-visit))))
1935 (defun dired-find-alternate-file ()
1936 "In Dired, visit this file or directory instead of the dired buffer."
1937 (interactive)
1938 (set-buffer-modified-p nil)
1939 (find-alternate-file (dired-get-file-for-visit)))
1940 ;; Don't override the setting from .emacs.
1941 ;;;###autoload (put 'dired-find-alternate-file 'disabled t)
1943 (defun dired-mouse-find-file-other-window (event)
1944 "In Dired, visit the file or directory name you click on."
1945 (interactive "e")
1946 (let (window pos file)
1947 (save-excursion
1948 (setq window (posn-window (event-end event))
1949 pos (posn-point (event-end event)))
1950 (if (not (windowp window))
1951 (error "No file chosen"))
1952 (set-buffer (window-buffer window))
1953 (goto-char pos)
1954 (setq file (dired-get-file-for-visit)))
1955 (if (file-directory-p file)
1956 (or (and (cdr dired-subdir-alist)
1957 (dired-goto-subdir file))
1958 (progn
1959 (select-window window)
1960 (dired-other-window file)))
1961 (select-window window)
1962 (find-file-other-window (file-name-sans-versions file t)))))
1964 (defun dired-view-file ()
1965 "In Dired, examine a file in view mode, returning to Dired when done.
1966 When file is a directory, show it in this buffer if it is inserted.
1967 Otherwise, display it in another buffer."
1968 (interactive)
1969 (let ((file (dired-get-file-for-visit)))
1970 (if (file-directory-p file)
1971 (or (and (cdr dired-subdir-alist)
1972 (dired-goto-subdir file))
1973 (dired file))
1974 (view-file file))))
1976 (defun dired-find-file-other-window ()
1977 "In Dired, visit this file or directory in another window."
1978 (interactive)
1979 (find-file-other-window (dired-get-file-for-visit)))
1981 (defun dired-display-file ()
1982 "In Dired, display this file or directory in another window."
1983 (interactive)
1984 (display-buffer (find-file-noselect (dired-get-file-for-visit))))
1985 \f
1986 ;;; Functions for extracting and manipulating file names in Dired buffers.
1988 (defun dired-get-filename (&optional localp no-error-if-not-filep)
1989 "In Dired, return name of file mentioned on this line.
1990 Value returned normally includes the directory name.
1991 Optional arg LOCALP with value `no-dir' means don't include directory
1992 name in result. A value of `verbatim' means to return the name exactly as
1993 it occurs in the buffer, and a value of t means construct name relative to
1994 `default-directory', which still may contain slashes if in a subdirectory.
1995 Optional arg NO-ERROR-IF-NOT-FILEP means treat `.' and `..' as
1996 regular filenames and return nil if no filename on this line.
1997 Otherwise, an error occurs in these cases."
1998 (let (case-fold-search file p1 p2 already-absolute)
1999 (save-excursion
2000 (if (setq p1 (dired-move-to-filename (not no-error-if-not-filep)))
2001 (setq p2 (dired-move-to-end-of-filename no-error-if-not-filep))))
2002 ;; nil if no file on this line, but no-error-if-not-filep is t:
2003 (if (setq file (and p1 p2 (buffer-substring p1 p2)))
2004 (progn
2005 ;; Get rid of the mouse-face property that file names have.
2006 (set-text-properties 0 (length file) nil file)
2007 ;; Unquote names quoted by ls or by dired-insert-directory.
2008 ;; This code was written using `read' to unquote, because
2010 ;; char) etc. in a lisp loop. Unfortunately, this decision
2011 ;; has necessitated hacks such as dealing with filenames
2012 ;; with quotation marks in their names.
2016 (when (eq system-type 'windows-nt)
2017 (save-match-data
2018 (let ((start 0))
2020 (aset file (match-beginning 0) ?/)
2021 (setq start (match-end 0))))))
2024 ;; The above `read' will return a unibyte string if FILE
2025 ;; contains eight-bit-control/graphic characters.
2026 (if (and enable-multibyte-characters
2027 (not (multibyte-string-p file)))
2028 (setq file (string-to-multibyte file)))))
2029 (and file (file-name-absolute-p file)
2030 ;; A relative file name can start with ~.
2031 ;; Don't treat it as absolute in this context.
2032 (not (eq (aref file 0) ?~))
2033 (setq already-absolute t))
2034 (cond
2035 ((null file)
2036 nil)
2037 ((eq localp 'verbatim)
2038 file)
2039 ((and (not no-error-if-not-filep)
2040 (member file '("." "..")))
2041 (error "Cannot operate on `.' or `..'"))
2042 ((and (eq localp 'no-dir) already-absolute)
2043 (file-name-nondirectory file))
2044 (already-absolute
2045 (let ((handler (find-file-name-handler file nil)))
2046 ;; check for safe-magic property so that we won't
2047 ;; put /: for names that don't really need them.
2048 ;; For instance, .gz files when auto-compression-mode is on.
2049 (if (and handler (not (get handler 'safe-magic)))
2050 (concat "/:" file)
2051 file)))
2052 ((eq localp 'no-dir)
2053 file)
2054 ((equal (dired-current-directory) "/")
2055 (setq file (concat (dired-current-directory localp) file))
2056 (let ((handler (find-file-name-handler file nil)))
2057 ;; check for safe-magic property so that we won't
2058 ;; put /: for names that don't really need them.
2059 ;; For instance, .gz files when auto-compression-mode is on.
2060 (if (and handler (not (get handler 'safe-magic)))
2061 (concat "/:" file)
2062 file)))
2063 (t
2064 (concat (dired-current-directory localp) file)))))
2066 (defun dired-string-replace-match (regexp string newtext
2067 &optional literal global)
2068 "Replace first match of REGEXP in STRING with NEWTEXT.
2069 If it does not match, nil is returned instead of the new string.
2070 Optional arg LITERAL means to take NEWTEXT literally.
2071 Optional arg GLOBAL means to replace all matches."
2072 (if global
2073 (let ((start 0) ret)
2074 (while (string-match regexp string start)
2075 (let ((from-end (- (length string) (match-end 0))))
2076 (setq ret (setq string (replace-match newtext t literal string)))
2077 (setq start (- (length string) from-end))))
2078 ret)
2079 (if (not (string-match regexp string 0))
2080 nil
2081 (replace-match newtext t literal string))))
2083 (defun dired-make-absolute (file &optional dir)
2084 ;;"Convert FILE (a file name relative to DIR) to an absolute file name."
2085 ;; We can't always use expand-file-name as this would get rid of `.'
2086 ;; or expand in / instead default-directory if DIR=="".
2087 ;; This should be good enough for ange-ftp.
2088 ;; It should be reasonably fast, though, as it is called in
2089 ;; dired-get-filename.
2090 (concat (or dir default-directory) file))
2092 (defun dired-make-relative (file &optional dir ignore)
2093 "Convert FILE (an absolute file name) to a name relative to DIR.
2094 If this is impossible, return FILE unchanged.
2095 DIR must be a directory name, not a file name."
2096 (or dir (setq dir default-directory))
2097 ;; This case comes into play if default-directory is set to
2098 ;; use ~.
2099 (if (and (> (length dir) 0) (= (aref dir 0) ?~))
2100 (setq dir (expand-file-name dir)))
2101 (if (string-match (concat "^" (regexp-quote dir)) file)
2102 (substring file (match-end 0))
2103 ;;; (or no-error
2104 ;;; (error "%s: not in directory tree growing at %s" file dir))
2105 file))
2106 \f
2107 ;;; Functions for finding the file name in a dired buffer line.
2109 (defvar dired-permission-flags-regexp
2111 "Regular expression to match the permission flags in `ls -l'.")
2113 ;; Move to first char of filename on this line.
2114 ;; Returns position (point) or nil if no filename on this line."
2115 (defun dired-move-to-filename (&optional raise-error eol)
2116 "Move to the beginning of the filename on the current line.
2117 Return the position of the beginning of the filename, or nil if none found."
2118 ;; This is the UNIX version.
2119 (or eol (setq eol (line-end-position)))
2120 (beginning-of-line)
2121 ;; First try assuming `ls --dired' was used.
2122 (let ((change (next-single-property-change (point) 'dired-filename nil eol)))
2123 (cond
2124 ((and change (< change eol))
2125 (goto-char change))
2126 ((re-search-forward directory-listing-before-filename-regexp eol t)
2127 (goto-char (match-end 0)))
2128 ((re-search-forward dired-permission-flags-regexp eol t)
2129 ;; Ha! There *is* a file. Our regexp-from-hell just failed to find it.
2130 (if raise-error
2131 (error "Unrecognized line! Check directory-listing-before-filename-regexp"))
2132 (beginning-of-line)
2133 nil)
2134 (raise-error
2135 (error "No file on this line")))))
2137 (defun dired-move-to-end-of-filename (&optional no-error)
2138 ;; Assumes point is at beginning of filename,
2139 ;; thus the rwx bit re-search-backward below will succeed in *this*
2140 ;; line if at all. So, it should be called only after
2141 ;; (dired-move-to-filename t).
2142 ;; On failure, signals an error (with non-nil NO-ERROR just returns nil).
2143 ;; This is the UNIX version.
2144 (if (get-text-property (point) 'dired-filename)
2145 (goto-char (next-single-property-change (point) 'dired-filename))
2146 (let (opoint file-type executable symlink hidden case-fold-search used-F eol)
2147 ;; case-fold-search is nil now, so we can test for capital F:
2148 (setq used-F (string-match "F" dired-actual-switches)
2149 opoint (point)
2150 eol (save-excursion (end-of-line) (point))
2151 hidden (and selective-display
2153 (if hidden
2154 nil
2155 (save-excursion ;; Find out what kind of file this is:
2156 ;; Restrict perm bits to be non-blank,
2157 ;; otherwise this matches one char to early (looking backward):
2158 ;; "l---------" (some systems make symlinks that way)
2159 ;; "----------" (plain file with zero perms)
2160 (if (re-search-backward
2161 dired-permission-flags-regexp nil t)
2162 (setq file-type (char-after (match-beginning 1))
2163 symlink (eq file-type ?l)
2164 ;; Only with -F we need to know whether it's an executable
2165 executable (and
2166 used-F
2167 (string-match
2168 "[xst]" ;; execute bit set anywhere?
2169 (concat
2170 (match-string 2)
2171 (match-string 3)
2172 (match-string 4)))))
2173 (or no-error (error "No file on this line"))))
2174 ;; Move point to end of name:
2175 (if symlink
2176 (if (search-forward " -> " eol t)
2177 (progn
2178 (forward-char -4)
2179 (and used-F
2180 dired-ls-F-marks-symlinks
2181 (eq (preceding-char) ?@) ;; did ls really mark the link?
2182 (forward-char -1))))
2183 (goto-char eol) ;; else not a symbolic link
2184 ;; ls -lF marks dirs, sockets, fifos and executables with exactly
2185 ;; one trailing character. (Executable bits on symlinks ain't mean
2186 ;; a thing, even to ls, but we know it's not a symlink.)
2187 (and used-F
2188 (or (memq file-type '(?d ?s ?p))
2189 executable)
2190 (forward-char -1))))
2191 (or no-error
2192 (not (eq opoint (point)))
2193 (error "%s" (if hidden
2194 (substitute-command-keys
2196 "No file on this line")))
2197 (if (eq opoint (point))
2198 nil
2199 (point)))))
2201 \f
2202 ;;; COPY NAMES OF MARKED FILES INTO KILL-RING.
2204 (defun dired-copy-filename-as-kill (&optional arg)
2205 "Copy names of marked (or next ARG) files into the kill ring.
2206 The names are separated by a space.
2207 With a zero prefix arg, use the absolute file name of each marked file.
2209 `default-directory'. (This still may contain slashes if in a subdirectory.)
2211 If on a subdir headerline, use absolute subdirname instead;
2212 prefix arg and marked files are ignored in this case.
2215 (interactive "P")
2216 (let ((string
2217 (or (dired-get-subdir)
2218 (mapconcat (function identity)
2219 (if arg
2220 (cond ((zerop (prefix-numeric-value arg))
2221 (dired-get-marked-files))
2222 ((consp arg)
2223 (dired-get-marked-files t))
2224 (t
2225 (dired-get-marked-files
2226 'no-dir (prefix-numeric-value arg))))
2227 (dired-get-marked-files 'no-dir))
2228 " "))))
2229 (if (eq last-command 'kill-region)
2230 (kill-append string nil)
2231 (kill-new string))
2232 (message "%s" string)))
2234 \f
2235 ;; Keeping Dired buffers in sync with the filesystem and with each other
2237 (defun dired-buffers-for-dir (dir &optional file)
2238 ;; Return a list of buffers for DIR (top level or in-situ subdir).
2239 ;; If FILE is non-nil, include only those whose wildcard pattern (if any)
2240 ;; matches FILE.
2241 ;; The list is in reverse order of buffer creation, most recent last.
2242 ;; As a side effect, killed dired buffers for DIR are removed from
2243 ;; dired-buffers.
2244 (setq dir (file-name-as-directory dir))
2245 (let (result buf)
2246 (dolist (elt dired-buffers)
2247 (setq buf (cdr elt))
2248 (cond
2249 ((null (buffer-name buf))
2250 ;; Buffer is killed - clean up:
2251 (setq dired-buffers (delq elt dired-buffers)))
2252 ((dired-in-this-tree dir (car elt))
2253 (with-current-buffer buf
2254 (and (assoc dir dired-subdir-alist)
2255 (or (null file)
2256 (if (stringp dired-directory)
2257 (let ((wildcards (file-name-nondirectory
2258 dired-directory)))
2259 (or (= 0 (length wildcards))
2260 (string-match (dired-glob-regexp wildcards)
2261 file)))
2262 (member (expand-file-name file dir)
2263 (cdr dired-directory))))
2264 (setq result (cons buf result)))))))
2265 result))
2267 (defun dired-glob-regexp (pattern)
2268 "Convert glob-pattern PATTERN to a regular expression."
2269 (let ((matched-in-pattern 0) ;; How many chars of PATTERN we've handled.
2270 regexp)
2271 (while (string-match "[[?*]" pattern matched-in-pattern)
2272 (let ((op-end (match-end 0))
2273 (next-op (aref pattern (match-beginning 0))))
2274 (setq regexp (concat regexp
2275 (regexp-quote
2276 (substring pattern matched-in-pattern
2277 (match-beginning 0)))))
2278 (cond ((= next-op ??)
2279 (setq regexp (concat regexp "."))
2280 (setq matched-in-pattern op-end))
2281 ((= next-op ?\[)
2282 ;; Fails to handle ^ yet ????
2283 (let* ((set-start (match-beginning 0))
2284 (set-cont
2285 (if (= (aref pattern (1+ set-start)) ?^)
2286 (+ 3 set-start)
2287 (+ 2 set-start)))
2288 (set-end (string-match "]" pattern set-cont))
2289 (set (substring pattern set-start (1+ set-end))))
2290 (setq regexp (concat regexp set))
2291 (setq matched-in-pattern (1+ set-end))))
2292 ((= next-op ?*)
2293 (setq regexp (concat regexp ".*"))
2294 (setq matched-in-pattern op-end)))))
2296 regexp
2297 (regexp-quote
2298 (substring pattern matched-in-pattern))
2303 (defun dired-advertise ()
2304 ;;"Advertise in variable `dired-buffers' that we dired `default-directory'."
2305 ;; With wildcards we actually advertise too much.
2306 (let ((expanded-default (expand-file-name default-directory)))
2307 (if (memq (current-buffer) (dired-buffers-for-dir expanded-default))
2308 t ; we have already advertised ourselves
2309 (setq dired-buffers
2310 (cons (cons expanded-default (current-buffer))
2311 dired-buffers)))))
2313 (defun dired-unadvertise (dir)
2314 ;; Remove DIR from the buffer alist in variable dired-buffers.
2315 ;; This has the effect of removing any buffer whose main directory is DIR.
2316 ;; It does not affect buffers in which DIR is a subdir.
2317 ;; Removing is also done as a side-effect in dired-buffer-for-dir.
2318 (setq dired-buffers
2319 (delq (assoc (expand-file-name dir) dired-buffers) dired-buffers)))
2320 \f
2321 ;; Tree Dired
2323 ;;; utility functions
2325 (defun dired-in-this-tree (file dir)
2326 ;;"Is FILE part of the directory tree starting at DIR?"
2327 (let (case-fold-search)
2328 (string-match (concat "^" (regexp-quote dir)) file)))
2330 (defun dired-normalize-subdir (dir)
2331 ;; Prepend default-directory to DIR if relative file name.
2332 ;; dired-get-filename must be able to make a valid file name from a
2333 ;; file and its directory DIR.
2334 (file-name-as-directory
2335 (if (file-name-absolute-p dir)
2336 dir
2337 (expand-file-name dir default-directory))))
2339 (defun dired-get-subdir ()
2340 ;;"Return the subdir name on this line, or nil if not on a headerline."
2341 ;; Look up in the alist whether this is a headerline.
2342 (save-excursion
2343 (let ((cur-dir (dired-current-directory)))
2344 (beginning-of-line) ; alist stores b-o-l positions
2345 (and (zerop (- (point)
2346 (dired-get-subdir-min (assoc cur-dir
2347 dired-subdir-alist))))
2348 cur-dir))))
2350 ;(defun dired-get-subdir-min (elt)
2351 ; (cdr elt))
2352 ;; can't use macro, must be redefinable for other alist format in dired-nstd.
2353 (defalias 'dired-get-subdir-min 'cdr)
2355 (defun dired-get-subdir-max (elt)
2356 (save-excursion
2357 (goto-char (dired-get-subdir-min elt))
2358 (dired-subdir-max)))
2360 (defun dired-clear-alist ()
2361 (while dired-subdir-alist
2362 (set-marker (dired-get-subdir-min (car dired-subdir-alist)) nil)
2363 (setq dired-subdir-alist (cdr dired-subdir-alist))))
2365 (defun dired-subdir-index (dir)
2366 ;; Return an index into alist for use with nth
2367 ;; for the sake of subdir moving commands.
2368 (let (found (index 0) (alist dired-subdir-alist))
2369 (while alist
2370 (if (string= dir (car (car alist)))
2371 (setq alist nil found t)
2372 (setq alist (cdr alist) index (1+ index))))
2373 (if found index nil)))
2375 (defun dired-next-subdir (arg &optional no-error-if-not-found no-skip)
2376 "Go to next subdirectory, regardless of level."
2377 ;; Use 0 arg to go to this directory's header line.
2378 ;; NO-SKIP prevents moving to end of header line, returning whatever
2379 ;; position was found in dired-subdir-alist.
2380 (interactive "p")
2381 (let ((this-dir (dired-current-directory))
2382 pos index)
2383 ;; nth with negative arg does not return nil but the first element
2384 (setq index (- (dired-subdir-index this-dir) arg))
2385 (setq pos (if (>= index 0)
2386 (dired-get-subdir-min (nth index dired-subdir-alist))))
2387 (if pos
2388 (progn
2389 (goto-char pos)
2391 (point))
2392 (if no-error-if-not-found
2393 nil ; return nil if not found
2394 (error "%s directory" (if (> arg 0) "Last" "First"))))))
2396 (defun dired-build-subdir-alist (&optional switches)
2397 "Build `dired-subdir-alist' by parsing the buffer.
2398 Returns the new value of the alist.
2399 If optional arg SWITCHES is non-nil, use its value
2400 instead of `dired-actual-switches'."
2401 (interactive)
2402 (dired-clear-alist)
2403 (save-excursion
2404 (let* ((count 0)
2405 (inhibit-read-only t)
2406 (buffer-undo-list t)
2407 (switches (or switches dired-actual-switches))
2408 new-dir-name
2409 (R-ftp-base-dir-regex
2410 ;; Used to expand subdirectory names correctly in recursive
2411 ;; ange-ftp listings.
2412 (and (string-match "R" switches)
2415 (goto-char (point-min))
2416 (setq dired-subdir-alist nil)
2417 (while (re-search-forward dired-subdir-regexp nil t)
2418 ;; Avoid taking a file name ending in a colon
2419 ;; as a subdir name.
2420 (unless (save-excursion
2421 (goto-char (match-beginning 0))
2422 (beginning-of-line)
2423 (forward-char 2)
2424 (save-match-data (looking-at dired-re-perms)))
2425 (save-excursion
2426 (goto-char (match-beginning 1))
2427 (setq new-dir-name
2428 (buffer-substring-no-properties (point) (match-end 1))
2429 new-dir-name
2430 (save-match-data
2431 (if (and R-ftp-base-dir-regex
2432 (not (string= new-dir-name default-directory))
2433 (string-match R-ftp-base-dir-regex new-dir-name))
2434 (concat default-directory
2435 (substring new-dir-name (match-end 0)))
2436 (expand-file-name new-dir-name))))
2437 (delete-region (point) (match-end 1))
2438 (insert new-dir-name))
2439 (setq count (1+ count))
2440 (dired-alist-add-1 new-dir-name
2441 ;; Place a sub directory boundary between lines.
2442 (save-excursion
2443 (goto-char (match-beginning 0))
2444 (beginning-of-line)
2445 (point-marker)))))
2446 (if (and (> count 1) (called-interactively-p 'interactive))
2447 (message "Buffer includes %d directories" count)))
2448 ;; We don't need to sort it because it is in buffer order per
2449 ;; constructionem. Return new alist:
2450 dired-subdir-alist))
2452 (defun dired-alist-add-1 (dir new-marker)
2453 ;; Add new DIR at NEW-MARKER. Don't sort.
2454 (setq dired-subdir-alist
2455 (cons (cons (dired-normalize-subdir dir) new-marker)
2456 dired-subdir-alist)))
2458 (defun dired-goto-next-nontrivial-file ()
2459 ;; Position point on first nontrivial file after point.
2460 (dired-goto-next-file);; so there is a file to compare with
2461 (if (stringp dired-trivial-filenames)
2462 (while (and (not (eobp))
2463 (string-match dired-trivial-filenames
2464 (file-name-nondirectory
2465 (or (dired-get-filename nil t) ""))))
2466 (forward-line 1)
2467 (dired-move-to-filename))))
2469 (defun dired-goto-next-file ()
2470 (let ((max (1- (dired-subdir-max))))
2471 (while (and (not (dired-move-to-filename)) (< (point) max))
2472 (forward-line 1))))
2474 (defun dired-goto-file (file)
2475 "Go to line describing file FILE in this dired buffer."
2476 ;; Return value of point on success, else nil.
2477 ;; FILE must be an absolute file name.
2480 ;; it in the buffer.
2481 (interactive
2482 (prog1 ; let push-mark display its message
2483 (list (expand-file-name
2484 (read-file-name "Goto file: "
2485 (dired-current-directory))))
2486 (push-mark)))
2487 (setq file (directory-file-name file)) ; does no harm if no directory
2488 (let (found case-fold-search dir)
2489 (setq dir (or (file-name-directory file)
2490 (error "File name `%s' is not absolute" file)))
2491 (save-excursion
2492 ;; The hair here is to get the result of dired-goto-subdir
2493 ;; without really calling it if we don't have any subdirs.
2494 (if (if (string= dir (expand-file-name default-directory))
2495 (goto-char (point-min))
2496 (and (cdr dired-subdir-alist)
2497 (dired-goto-subdir dir)))
2498 (let ((base (file-name-nondirectory file))
2499 search-string
2500 (boundary (dired-subdir-max)))
2501 (setq search-string
2503 (setq search-string
2505 (while (and (not found)
2506 ;; filenames are preceded by SPC, this makes
2507 ;; the search faster (e.g. for the filename "-"!).
2508 (search-forward (concat " " search-string)
2509 boundary 'move))
2510 ;; Match could have BASE just as initial substring or
2511 ;; or in permission bits or date or
2512 ;; not be a proper filename at all:
2513 (if (equal base (dired-get-filename 'no-dir t))
2514 ;; Must move to filename since an (actually
2515 ;; correct) match could have been elsewhere on the
2516 ;; ;; line (e.g. "-" would match somewhere in the
2517 ;; permission bits).
2518 (setq found (dired-move-to-filename))
2519 ;; If this isn't the right line, move forward to avoid
2520 ;; trying this line again.
2521 (forward-line 1))))))
2522 (and found
2523 ;; return value of point (i.e., FOUND):
2524 (goto-char found))))
2526 (defun dired-initial-position (dirname)
2527 ;; Where point should go in a new listing of DIRNAME.
2528 ;; Point assumed at beginning of new subdir line.
2529 ;; You may redefine this function as you wish, e.g. like in dired-x.el.
2530 (end-of-line)
2531 (if dired-trivial-filenames (dired-goto-next-nontrivial-file)))
2532 \f
2533 ;; These are hooks which make tree dired work.
2534 ;; They are in this file because other parts of dired need to call them.
2535 ;; But they don't call the rest of tree dired unless there are subdirs loaded.
2537 ;; This function is called for each retrieved filename.
2538 ;; It could stand to be faster, though it's mostly function call
2539 ;; overhead. Avoiding the function call seems to save about 10% in
2540 ;; dired-get-filename. Make it a defsubst?
2541 (defun dired-current-directory (&optional localp)
2542 "Return the name of the subdirectory to which this line belongs.
2543 This returns a string with trailing slash, like `default-directory'.
2544 Optional argument means return a file name relative to `default-directory'."
2545 (let ((here (point))
2546 (alist (or dired-subdir-alist
2547 ;; probably because called in a non-dired buffer
2548 (error "No subdir-alist in %s" (current-buffer))))
2549 elt dir)
2550 (while alist
2551 (setq elt (car alist)
2552 dir (car elt)
2553 ;; use `<=' (not `<') as subdir line is part of subdir
2554 alist (if (<= (dired-get-subdir-min elt) here)
2555 nil ; found
2556 (cdr alist))))
2557 (if localp
2558 (dired-make-relative dir default-directory)
2559 dir)))
2561 ;; Subdirs start at the beginning of their header lines and end just
2562 ;; before the beginning of the next header line (or end of buffer).
2564 (defun dired-subdir-max ()
2565 (save-excursion
2566 (if (or (null (cdr dired-subdir-alist)) (not (dired-next-subdir 1 t t)))
2567 (point-max)
2568 (point))))
2569 \f
2570 ;; Deleting files
2572 (defcustom dired-recursive-deletes 'top
2573 "Decide whether recursive deletes are allowed.
2574 A value of nil means no recursive deletes.
2575 `always' means delete recursively without asking. This is DANGEROUS!
2576 `top' means ask for each directory at top level, but delete its subdirectories
2577 without asking.
2578 Anything else means ask for each directory."
2579 :type '(choice :tag "Delete non-empty directories"
2580 (const :tag "Yes" always)
2581 (const :tag "No--only delete empty directories" nil)
2582 (const :tag "Confirm for each directory" t)
2583 (const :tag "Confirm for each top directory only" top))
2584 :group 'dired)
2586 ;; Match anything but `.' and `..'.
2589 ;; Delete file, possibly delete a directory and all its files.
2590 ;; This function is usefull outside of dired. One could change it's name
2591 ;; to e.g. recursive-delete-file and put it somewhere else.
2592 (defun dired-delete-file (file &optional recursive) "\
2593 Delete FILE or directory (possibly recursively if optional RECURSIVE is true.)
2594 RECURSIVE determines what to do with a non-empty directory. If RECURSIVE is:
2595 nil, do not delete.
2596 `always', delete recursively without asking.
2597 `top', ask for each directory at top level.
2598 Anything else, ask for each sub-directory."
2599 ;; This test is equivalent to
2600 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
2601 ;; but more efficient
2602 (if (not (eq t (car (file-attributes file))))
2603 (delete-file file)
2604 (if (and recursive
2605 (directory-files file t dired-re-no-dot) ; Not empty.
2606 (or (eq recursive 'always)
2607 (yes-or-no-p (format "Recursive delete of %s? "
2608 (dired-make-relative file)))))
2609 (if (eq recursive 'top) (setq recursive 'always)) ; Don't ask again.
2610 (setq recursive nil))
2611 (delete-directory file recursive)))
2613 (defun dired-do-flagged-delete (&optional nomessage)
2614 "In Dired, delete the files flagged for deletion.
2615 If NOMESSAGE is non-nil, we don't display any message
2616 if there are no flagged files.
2617 `dired-recursive-deletes' controls whether deletion of
2618 non-empty directories is allowed."
2619 (interactive)
2620 (let* ((dired-marker-char dired-del-marker)
2621 (regexp (dired-marker-regexp))
2622 case-fold-search)
2623 (if (save-excursion (goto-char (point-min))
2624 (re-search-forward regexp nil t))
2625 (dired-internal-do-deletions
2626 ;; this can't move point since ARG is nil
2627 (dired-map-over-marks (cons (dired-get-filename) (point))
2628 nil)
2629 nil)
2630 (or nomessage
2631 (message "(No deletions requested)")))))
2633 (defun dired-do-delete (&optional arg)
2634 "Delete all marked (or next ARG) files.
2635 `dired-recursive-deletes' controls whether deletion of
2636 non-empty directories is allowed."
2637 ;; This is more consistent with the file marking feature than
2638 ;; dired-do-flagged-delete.
2639 (interactive "P")
2640 (dired-internal-do-deletions
2641 ;; this may move point if ARG is an integer
2642 (dired-map-over-marks (cons (dired-get-filename) (point))
2643 arg)
2644 arg))
2646 (defvar dired-deletion-confirmer 'yes-or-no-p) ; or y-or-n-p?
2648 (defun dired-internal-do-deletions (l arg)
2649 ;; L is an alist of files to delete, with their buffer positions.
2650 ;; ARG is the prefix arg.
2651 ;; Filenames are absolute.
2652 ;; (car L) *must* be the *last* (bottommost) file in the dired buffer.
2653 ;; That way as changes are made in the buffer they do not shift the
2654 ;; lines still to be changed, so the (point) values in L stay valid.
2655 ;; Also, for subdirs in natural order, a subdir's files are deleted
2656 ;; before the subdir itself - the other way around would not work.
2657 (let ((files (mapcar (function car) l))
2658 (count (length l))
2659 (succ 0))
2660 ;; canonicalize file list for pop up
2661 (setq files (nreverse (mapcar (function dired-make-relative) files)))
2662 (if (dired-mark-pop-up
2663 " *Deletions*" 'delete files dired-deletion-confirmer
2664 (format "Delete %s " (dired-mark-prompt arg files)))
2665 (save-excursion
2666 (let (failures);; files better be in reverse order for this loop!
2667 (while l
2668 (goto-char (cdr (car l)))
2669 (let ((inhibit-read-only t))
2670 (condition-case err
2671 (let ((fn (car (car l))))
2672 (dired-delete-file fn dired-recursive-deletes)
2673 ;; if we get here, removing worked
2674 (setq succ (1+ succ))
2675 (message "%s of %s deletions" succ count)
2676 (dired-fun-in-all-buffers
2677 (file-name-directory fn) (file-name-nondirectory fn)
2678 (function dired-delete-entry) fn))
2679 (error;; catch errors from failed deletions
2681 (setq failures (cons (car (car l)) failures)))))
2682 (setq l (cdr l)))
2683 (if (not failures)
2684 (message "%d deletion%s done" count (dired-plural-s count))
2685 (dired-log-summary
2686 (format "%d of %d deletion%s failed"
2687 (length failures) count
2688 (dired-plural-s count))
2689 failures))))
2690 (message "(No deletions performed)")))
2691 (dired-move-to-filename))
2693 (defun dired-fun-in-all-buffers (directory file fun &rest args)
2694 ;; In all buffers dired'ing DIRECTORY, run FUN with ARGS.
2695 ;; If the buffer has a wildcard pattern, check that it matches FILE.
2696 ;; (FILE does not include a directory component.)
2697 ;; FILE may be nil, in which case ignore it.
2698 ;; Return list of buffers where FUN succeeded (i.e., returned non-nil).
2699 (let (success-list)
2700 (dolist (buf (dired-buffers-for-dir (expand-file-name directory)
2701 file))
2702 (with-current-buffer buf
2703 (if (apply fun args)
2704 (setq success-list (cons (buffer-name buf) success-list)))))
2705 success-list))
2707 ;; Delete the entry for FILE from
2708 (defun dired-delete-entry (file)
2709 (save-excursion
2710 (and (dired-goto-file file)
2711 (let ((inhibit-read-only t))
2712 (delete-region (progn (beginning-of-line) (point))
2713 (save-excursion (forward-line 1) (point))))))
2714 (dired-clean-up-after-deletion file))
2716 ;; This is a separate function for the sake of dired-x.el.
2717 (defun dired-clean-up-after-deletion (fn)
2718 ;; Clean up after a deleted file or directory FN.
2719 (save-excursion (and (cdr dired-subdir-alist)
2720 (dired-goto-subdir fn)
2721 (dired-kill-subdir))))
2722 \f
2723 ;; Confirmation
2725 (defun dired-marker-regexp ()
2726 (concat "^" (regexp-quote (char-to-string dired-marker-char))))
2728 (defun dired-plural-s (count)
2729 (if (= 1 count) "" "s"))
2731 (defun dired-mark-prompt (arg files)
2732 "Return a string for use in a prompt, either the current file
2733 name, or the marker and a count of marked files."
2734 ;; distinguish-one-marked can cause the first element to be just t.
2735 (if (eq (car files) t) (setq files (cdr files)))
2736 (let ((count (length files)))
2737 (if (= count 1)
2738 (car files)
2739 ;; more than 1 file:
2740 (if (integerp arg)
2741 ;; abs(arg) = count
2742 ;; Perhaps this is nicer, but it also takes more screen space:
2743 ;;(format "[%s %d files]" (if (> arg 0) "next" "previous")
2744 ;; count)
2745 (format "[next %d files]" arg)
2746 (format "%c [%d files]" dired-marker-char count)))))
2748 (defun dired-pop-to-buffer (buf)
2749 "Pop up buffer BUF in a way suitable for Dired."
2750 (let ((split-window-preferred-function
2751 (lambda (window)
2752 (or (and (let ((split-height-threshold 0))
2753 (window-splittable-p (selected-window)))
2754 ;; Try to split the selected window vertically if
2755 ;; that's possible. (Bug#1806)
2756 (split-window-vertically))
2757 ;; Otherwise, try to split WINDOW sensibly.
2758 (split-window-sensibly window))))
2759 pop-up-frames)
2760 (pop-to-buffer (get-buffer-create buf)))
2761 ;; If dired-shrink-to-fit is t, make its window fit its contents.
2762 (when dired-shrink-to-fit
2763 ;; Try to not delete window when we want to display less than
2764 ;; `window-min-height' lines.
2765 (fit-window-to-buffer (get-buffer-window buf) nil 1)))
2767 (defcustom dired-no-confirm nil
2768 "A list of symbols for commands Dired should not confirm.
2769 Command symbols are `byte-compile', `chgrp', `chmod', `chown', `compress',
2770 `copy', `delete', `hardlink', `load', `move', `print', `shell', `symlink',
2771 `touch' and `uncompress'."
2772 :group 'dired
2773 :type '(set (const byte-compile) (const chgrp)
2774 (const chmod) (const chown) (const compress)
2775 (const copy) (const delete) (const hardlink)
2776 (const load) (const move) (const print)
2777 (const shell) (const symlink) (const touch)
2778 (const uncompress)))
2780 (defun dired-mark-pop-up (bufname op-symbol files function &rest args)
2781 "Return FUNCTION's result on ARGS after showing which files are marked.
2782 Displays the file names in a buffer named BUFNAME;
2784 This uses function `dired-pop-to-buffer' to do that.
2786 FUNCTION should not manipulate files, just read input
2787 (an argument or confirmation).
2788 The window is not shown if there is just one file or
2789 OP-SYMBOL is a member of the list in `dired-no-confirm'.
2790 FILES is the list of marked files. It can also be (t FILENAME)
2791 in the case of one marked file, to distinguish that from using
2792 just the current file."
2793 (or bufname (setq bufname " *Marked Files*"))
2794 (if (or (eq dired-no-confirm t)
2795 (memq op-symbol dired-no-confirm)
2796 ;; If FILES defaulted to the current line's file.
2797 (= (length files) 1))
2798 (apply function args)
2799 (with-current-buffer (get-buffer-create bufname)
2800 (erase-buffer)
2801 ;; Handle (t FILE) just like (FILE), here.
2802 ;; That value is used (only in some cases), to mean
2803 ;; just one file that was marked, rather than the current line file.
2804 (dired-format-columns-of-files (if (eq (car files) t) (cdr files) files))
2805 (remove-text-properties (point-min) (point-max)
2806 '(mouse-face nil help-echo nil)))
2807 (save-window-excursion
2808 (dired-pop-to-buffer bufname)
2809 (apply function args))))
2811 (defun dired-format-columns-of-files (files)
2812 (let ((beg (point)))
2813 (completion--insert-strings files)
2814 (put-text-property beg (point) 'mouse-face nil)))
2815 \f
2816 ;; Commands to mark or flag file(s) at or near current line.
2818 (defun dired-repeat-over-lines (arg function)
2819 ;; This version skips non-file lines.
2820 (let ((pos (make-marker)))
2821 (beginning-of-line)
2822 (while (and (> arg 0) (not (eobp)))
2823 (setq arg (1- arg))
2824 (beginning-of-line)
2825 (while (and (not (eobp)) (dired-between-files)) (forward-line 1))
2826 (save-excursion
2827 (forward-line 1)
2828 (move-marker pos (1+ (point))))
2829 (save-excursion (funcall function))
2830 ;; Advance to the next line--actually, to the line that *was* next.
2831 ;; (If FUNCTION inserted some new lines in between, skip them.)
2832 (goto-char pos))
2833 (while (and (< arg 0) (not (bobp)))
2834 (setq arg (1+ arg))
2835 (forward-line -1)
2836 (while (and (not (bobp)) (dired-between-files)) (forward-line -1))
2837 (beginning-of-line)
2838 (save-excursion (funcall function)))
2839 (move-marker pos nil)
2840 (dired-move-to-filename)))
2842 (defun dired-between-files ()
2843 ;; This used to be a regexp match of the `total ...' line output by
2844 ;; ls, which is slightly faster, but that is not very robust; notably,
2845 ;; it fails for non-english locales.
2846 (save-excursion (not (dired-move-to-filename))))
2848 (defun dired-next-marked-file (arg &optional wrap opoint)
2849 "Move to the next marked file, wrapping around the end of the buffer."
2851 (or opoint (setq opoint (point)));; return to where interactively started
2852 (if (if (> arg 0)
2853 (re-search-forward dired-re-mark nil t arg)
2854 (beginning-of-line)
2855 (re-search-backward dired-re-mark nil t (- arg)))
2856 (dired-move-to-filename)
2857 (if (null wrap)
2858 (progn
2859 (goto-char opoint)
2860 (error "No next marked file"))
2861 (message "(Wraparound for next marked file)")
2862 (goto-char (if (> arg 0) (point-min) (point-max)))
2863 (dired-next-marked-file arg nil opoint))))
2865 (defun dired-prev-marked-file (arg &optional wrap)
2866 "Move to the previous marked file, wrapping around the end of the buffer."
2868 (dired-next-marked-file (- arg) wrap))
2870 (defun dired-file-marker (file)
2871 ;; Return FILE's marker, or nil if unmarked.
2872 (save-excursion
2873 (and (dired-goto-file file)
2874 (progn
2875 (beginning-of-line)
2877 (following-char))))))
2879 (defun dired-mark-files-in-region (start end)
2880 (let ((inhibit-read-only t))
2881 (if (> start end)
2882 (error "start > end"))
2883 (goto-char start) ; assumed at beginning of line
2884 (while (< (point) end)
2885 ;; Skip subdir line and following garbage like the `total' line:
2886 (while (and (< (point) end) (dired-between-files))
2887 (forward-line 1))
2888 (if (and (not (looking-at dired-re-dot))
2889 (dired-get-filename nil t))
2890 (progn
2891 (delete-char 1)
2892 (insert dired-marker-char)))
2893 (forward-line 1))))
2895 (defun dired-mark (arg)
2896 "Mark the current (or next ARG) files.
2897 If on a subdir headerline, mark all its files except `.' and `..'.
2901 this subdir."
2902 (interactive "P")
2903 (if (dired-get-subdir)
2904 (save-excursion (dired-mark-subdir-files))
2905 (let ((inhibit-read-only t))
2906 (dired-repeat-over-lines
2907 (prefix-numeric-value arg)
2908 (function (lambda () (delete-char 1) (insert dired-marker-char)))))))
2910 (defun dired-unmark (arg)
2911 "Unmark the current (or next ARG) files.
2912 If looking at a subdir, unmark all its files except `.' and `..'."
2913 (interactive "P")
2915 (dired-mark arg)))
2917 (defun dired-flag-file-deletion (arg)
2918 "In Dired, flag the current line's file for deletion.
2919 With prefix arg, repeat over several lines.
2921 If on a subdir headerline, mark all its files except `.' and `..'."
2922 (interactive "P")
2923 (let ((dired-marker-char dired-del-marker))
2924 (dired-mark arg)))
2926 (defun dired-unmark-backward (arg)
2927 "In Dired, move up lines and remove deletion flag there.
2928 Optional prefix ARG says how many lines to unflag; default is one line."
2929 (interactive "p")
2930 (dired-unmark (- arg)))
2932 (defun dired-toggle-marks ()
2933 "Toggle marks: marked files become unmarked, and vice versa.
2934 Files marked with other flags (such as `D') are not affected.
2935 `.' and `..' are never toggled.
2936 As always, hidden subdirs are not affected."
2937 (interactive)
2938 (save-excursion
2939 (goto-char (point-min))
2940 (let ((inhibit-read-only t))
2941 (while (not (eobp))
2942 (or (dired-between-files)
2943 (looking-at dired-re-dot)
2944 ;; use subst instead of insdel because it does not move
2945 ;; the gap and thus should be faster and because
2946 ;; other characters are left alone automatically
2947 (apply 'subst-char-in-region
2948 (point) (1+ (point))
2952 (forward-line 1)))))
2953 \f
2954 ;;; Commands to mark or flag files based on their characteristics or names.
2956 (defvar dired-regexp-history nil
2957 "History list of regular expressions used in Dired commands.")
2959 (defun dired-read-regexp (prompt)
2960 (read-from-minibuffer prompt nil nil nil 'dired-regexp-history))
2962 (defun dired-mark-files-regexp (regexp &optional marker-char)
2963 "Mark all files matching REGEXP for use in later commands.
2964 A prefix argument means to unmark them instead.
2965 `.' and `..' are never marked.
2968 object files--just `.o' will mark more than you might think."
2969 (interactive
2970 (list (dired-read-regexp (concat (if current-prefix-arg "Unmark" "Mark")
2971 " files (regexp): "))
2973 (let ((dired-marker-char (or marker-char dired-marker-char)))
2974 (dired-mark-if
2975 (and (not (looking-at dired-re-dot))
2976 (not (eolp)) ; empty line
2977 (let ((fn (dired-get-filename nil t)))
2978 (and fn (string-match regexp (file-name-nondirectory fn)))))
2979 "matching file")))
2981 (defun dired-mark-files-containing-regexp (regexp &optional marker-char)
2982 "Mark all files with contents containing REGEXP for use in later commands.
2983 A prefix argument means to unmark them instead.
2984 `.' and `..' are never marked."
2985 (interactive
2986 (list (dired-read-regexp (concat (if current-prefix-arg "Unmark" "Mark")
2987 " files containing (regexp): "))
2989 (let ((dired-marker-char (or marker-char dired-marker-char)))
2990 (dired-mark-if
2991 (and (not (looking-at dired-re-dot))
2992 (not (eolp)) ; empty line
2993 (let ((fn (dired-get-filename nil t)))
2994 (when (and fn (file-readable-p fn)
2995 (not (file-directory-p fn)))
2996 (let ((prebuf (get-file-buffer fn)))
2997 (message "Checking %s" fn)
2998 ;; For now we do it inside emacs
2999 ;; Grep might be better if there are a lot of files
3000 (if prebuf
3001 (with-current-buffer prebuf
3002 (save-excursion
3003 (goto-char (point-min))
3004 (re-search-forward regexp nil t)))
3005 (with-temp-buffer
3006 (insert-file-contents fn)
3007 (goto-char (point-min))
3008 (re-search-forward regexp nil t))))
3009 )))
3010 "matching file")))
3012 (defun dired-flag-files-regexp (regexp)
3013 "In Dired, flag all files containing the specified REGEXP for deletion.
3014 The match is against the non-directory part of the filename. Use `^'
3015 and `$' to anchor matches. Exclude subdirs by hiding them.
3016 `.' and `..' are never flagged."
3017 (interactive (list (dired-read-regexp "Flag for deletion (regexp): ")))
3018 (dired-mark-files-regexp regexp dired-del-marker))
3020 (defun dired-mark-symlinks (unflag-p)
3021 "Mark all symbolic links.
3022 With prefix argument, unflag all those files."
3023 (interactive "P")
3025 (dired-mark-if (looking-at dired-re-sym) "symbolic link")))
3027 (defun dired-mark-directories (unflag-p)
3028 "Mark all directory file lines except `.' and `..'.
3029 With prefix argument, unflag all those files."
3030 (interactive "P")
3032 (dired-mark-if (and (looking-at dired-re-dir)
3033 (not (looking-at dired-re-dot)))
3034 "directory file")))
3036 (defun dired-mark-executables (unflag-p)
3037 "Mark all executable files.
3038 With prefix argument, unflag all those files."
3039 (interactive "P")
3041 (dired-mark-if (looking-at dired-re-exe) "executable file")))
3043 ;; dired-x.el has a dired-mark-sexp interactive command: mark
3044 ;; files for which PREDICATE returns non-nil.
3046 (defun dired-flag-auto-save-files (&optional unflag-p)
3047 "Flag for deletion files whose names suggest they are auto save files.
3048 A prefix argument says to unflag those files instead."
3049 (interactive "P")
3051 (dired-mark-if
3052 ;; It is less than general to check for # here,
3053 ;; but it's the only way this runs fast enough.
3054 (and (save-excursion (end-of-line)
3055 (or
3056 (eq (preceding-char) ?#)
3057 ;; Handle executables in case of -F option.
3058 ;; We need not worry about the other kinds
3059 ;; of markings that -F makes, since they won't
3060 ;; appear on real auto-save files.
3061 (if (eq (preceding-char) ?*)
3062 (progn
3063 (forward-char -1)
3064 (eq (preceding-char) ?#)))))
3065 (not (looking-at dired-re-dir))
3066 (let ((fn (dired-get-filename t t)))
3067 (if fn (auto-save-file-name-p
3068 (file-name-nondirectory fn)))))
3069 "auto save file")))
3071 (defcustom dired-garbage-files-regexp
3072 ;; `log' here is dubious, since it's typically used for useful log
3073 ;; files, not just TeX stuff. -- fx
3074 (concat (regexp-opt
3075 '(".log" ".toc" ".dvi" ".bak" ".orig" ".rej" ".aux"))
3078 :type 'regexp
3079 :group 'dired)
3081 (defun dired-flag-garbage-files ()
3082 "Flag for deletion all files that match `dired-garbage-files-regexp'."
3083 (interactive)
3084 (dired-flag-files-regexp dired-garbage-files-regexp))
3086 (defun dired-flag-backup-files (&optional unflag-p)
3087 "Flag all backup files (names ending with `~') for deletion.
3088 With prefix argument, unflag these files."
3089 (interactive "P")
3090 (let ((dired-marker-char (if unflag-p ?\s dired-del-marker)))
3091 (dired-mark-if
3092 ;; Don't call backup-file-name-p unless the last character looks like
3093 ;; it might be the end of a backup file name. This isn't very general,
3094 ;; but it's the only way this runs fast enough.
3095 (and (save-excursion (end-of-line)
3096 ;; Handle executables in case of -F option.
3097 ;; We need not worry about the other kinds
3098 ;; of markings that -F makes, since they won't
3099 ;; appear on real backup files.
3100 (if (eq (preceding-char) ?*)
3101 (forward-char -1))
3102 (eq (preceding-char) ?~))
3103 (not (looking-at dired-re-dir))
3104 (let ((fn (dired-get-filename t t)))
3105 (if fn (backup-file-name-p fn))))
3106 "backup file")))
3108 (defun dired-change-marks (&optional old new)
3109 "Change all OLD marks to NEW marks.
3110 OLD and NEW are both characters used to mark files."
3111 (interactive
3112 (let* ((cursor-in-echo-area t)
3113 (old (progn (message "Change (old mark): ") (read-char)))
3114 (new (progn (message "Change %c marks to (new mark): " old)
3115 (read-char))))
3116 (list old new)))
3118 (ding)
3120 (inhibit-read-only t))
3121 (save-excursion
3122 (goto-char (point-min))
3123 (while (search-forward string nil t)
3124 (if (if (= old ?\s)
3125 (save-match-data
3126 (dired-get-filename 'no-dir t))
3127 t)
3128 (subst-char-in-region (match-beginning 0)
3129 (match-end 0) old new)))))))
3131 (defun dired-unmark-all-marks ()
3132 "Remove all marks from all files in the dired buffer."
3133 (interactive)
3136 (defun dired-unmark-all-files (mark &optional arg)
3137 "Remove a specific mark (or any mark) from every file.
3138 After this command, type the mark character to remove,
3139 or type RET to remove all marks.
3140 With prefix arg, query for each marked file.
3143 (save-excursion
3144 (let* ((count 0)
3145 (inhibit-read-only t) case-fold-search query
3147 (help-form "\
3148 Type SPC or `y' to unmark one file, DEL or `n' to skip to next,
3149 `!' to unmark all remaining files with no more questions."))
3150 (goto-char (point-min))
3152 (re-search-forward dired-re-mark nil t)
3153 (search-forward string nil t))
3154 (if (or (not arg)
3155 (let ((file (dired-get-filename t t)))
3156 (and file
3157 (dired-query 'query "Unmark file `%s'? "
3158 file))))
3159 (progn (subst-char-in-region (1- (point)) (point)
3160 (preceding-char) ?\s)
3161 (setq count (1+ count)))))
3162 (message (if (= count 1) "1 mark removed"
3163 "%d marks removed")
3164 count))))
3165 \f
3166 ;; Logging failures operating on files, and showing the results.
3168 (defvar dired-log-buffer "*Dired log*")
3170 (defun dired-why ()
3171 "Pop up a buffer with error log output from Dired.
3172 A group of errors from a single command ends with a formfeed.
3174 (interactive)
3175 (if (get-buffer dired-log-buffer)
3176 (let ((owindow (selected-window))
3177 (window (display-buffer (get-buffer dired-log-buffer))))
3178 (unwind-protect
3179 (progn
3180 (select-window window)
3181 (goto-char (point-max))
3182 (forward-line -1)
3183 (backward-page 1)
3184 (recenter 0))
3185 (select-window owindow)))))
3187 (defun dired-log (log &rest args)
3188 ;; Log a message or the contents of a buffer.
3189 ;; If LOG is a string and there are more args, it is formatted with
3191 ;; End each bunch of errors with (dired-log t):
3192 ;; this inserts the current time and buffer at the start of the page,
3194 (let ((obuf (current-buffer)))
3195 (with-current-buffer (get-buffer-create dired-log-buffer)
3196 (goto-char (point-max))
3197 (let ((inhibit-read-only t))
3198 (cond ((stringp log)
3199 (insert (if args
3200 (apply (function format) log args)
3201 log)))
3202 ((bufferp log)
3203 (insert-buffer-substring log))
3204 ((eq t log)
3205 (backward-page 1)
3206 (unless (bolp)
3208 (insert (current-time-string)
3210 (goto-char (point-max))
3213 (defun dired-log-summary (string failures)
3214 "State a summary of a command's failures, in echo area and log buffer.
3215 STRING is an overall summary of the failures.
3216 FAILURES is a list of file names that we failed to operate on,
3217 or nil if file names are not applicable."
3218 (if (= (length failures) 1)
3219 (message "%s"
3220 (with-current-buffer dired-log-buffer
3221 (goto-char (point-max))
3222 (backward-page 1)
3223 (if (eolp) (forward-line 1))
3224 (buffer-substring (point) (point-max))))
3225 (message (if failures "%s--type ? for details (%s)"
3226 "%s--type ? for details")
3227 string failures))
3228 ;; Log a summary describing a bunch of errors.
3230 (dired-log t))
3231 \f
3232 ;;; Sorting
3234 ;; Most ls can only sort by name or by date (with -t), nothing else.
3235 ;; GNU ls sorts on size with -S, on extension with -X, and unsorted with -U.
3236 ;; So anything that does not contain these is sort "by name".
3238 (defvar dired-ls-sorting-switches "SXU"
3241 This indicates to Dired which option switches to watch out for because they
3242 will change the sorting order behavior of `ls'.
3244 To change the default sorting order \(e.g. add a `-v' option\), see the
3245 variable `dired-listing-switches'. To temporarily override the listing
3248 (defvar dired-sort-by-date-regexp
3249 (concat "^-[^" dired-ls-sorting-switches
3250 "]*t[^" dired-ls-sorting-switches "]*$")
3251 "Regexp recognized by Dired to set `by date' mode.")
3253 (defvar dired-sort-by-name-regexp
3254 (concat "^-[^t" dired-ls-sorting-switches "]+$")
3255 "Regexp recognized by Dired to set `by name' mode.")
3257 (defvar dired-sort-inhibit nil
3258 "Non-nil means the Dired sort command is disabled.
3259 The idea is to set this buffer-locally in special dired buffers.")
3261 (defun dired-sort-set-modeline ()
3262 ;; Set modeline display according to dired-actual-switches.
3263 ;; Modeline display of "by name" or "by date" guarantees the user a
3264 ;; match with the corresponding regexps. Non-matching switches are
3265 ;; shown literally.
3266 (when (eq major-mode 'dired-mode)
3267 (setq mode-name
3268 (let (case-fold-search)
3269 (cond ((string-match
3270 dired-sort-by-name-regexp dired-actual-switches)
3271 "Dired by name")
3272 ((string-match
3273 dired-sort-by-date-regexp dired-actual-switches)
3274 "Dired by date")
3275 (t
3276 (concat "Dired " dired-actual-switches)))))
3277 (force-mode-line-update)))
3279 (defun dired-sort-toggle-or-edit (&optional arg)
3280 "Toggle between sort by date/name and refresh the dired buffer.
3281 With a prefix argument you can edit the current listing switches instead."
3282 (interactive "P")
3283 (when dired-sort-inhibit
3284 (error "Cannot sort this dired buffer"))
3285 (if arg
3286 (dired-sort-other
3287 (read-string "ls switches (must contain -l): " dired-actual-switches))
3288 (dired-sort-toggle)))
3290 (defun dired-sort-toggle ()
3291 ;; Toggle between sort by date/name. Reverts the buffer.
3292 (setq dired-actual-switches
3293 (let (case-fold-search)
3294 (if (string-match " " dired-actual-switches)
3295 ;; New toggle scheme: add/remove a trailing " -t"
3297 (substring dired-actual-switches 0 (match-beginning 0))
3298 (concat dired-actual-switches " -t"))
3299 ;; old toggle scheme: look for some 't' switch and add/remove it
3300 (concat
3301 "-l"
3302 (dired-replace-in-string (concat "[-lt"
3303 dired-ls-sorting-switches "]")
3304 ""
3305 dired-actual-switches)
3306 (if (string-match (concat "[t" dired-ls-sorting-switches "]")
3307 dired-actual-switches)
3308 ""
3309 "t")))))
3310 (dired-sort-set-modeline)
3311 (revert-buffer))
3313 ;; Some user code loads dired especially for this.
3314 ;; Don't do that--use replace-regexp-in-string instead.
3315 (defun dired-replace-in-string (regexp newtext string)
3316 ;; Replace REGEXP with NEWTEXT everywhere in STRING and return result.
3318 (let ((result "") (start 0) mb me)
3319 (while (string-match regexp string start)
3320 (setq mb (match-beginning 0)
3321 me (match-end 0)
3322 result (concat result (substring string start mb) newtext)
3323 start me))
3324 (concat result (substring string start))))
3326 (defun dired-sort-other (switches &optional no-revert)
3327 "Specify new `ls' SWITCHES for current dired buffer.
3328 Values matching `dired-sort-by-date-regexp' or `dired-sort-by-name-regexp'
3329 set the minor mode accordingly, others appear literally in the mode line.
3330 With optional second arg NO-REVERT, don't refresh the listing afterwards."
3331 (dired-sort-R-check switches)
3332 (setq dired-actual-switches switches)
3333 (dired-sort-set-modeline)
3334 (or no-revert (revert-buffer)))
3336 (defvar dired-subdir-alist-pre-R nil
3337 "Value of `dired-subdir-alist' before -R switch added.")
3338 (make-variable-buffer-local 'dired-subdir-alist-pre-R)
3340 (defun dired-sort-R-check (switches)
3341 "Additional processing of -R in ls option string SWITCHES.
3342 Saves `dired-subdir-alist' when R is set and restores saved value
3343 minus any directories explicitly deleted when R is cleared.
3344 To be called first in body of `dired-sort-other', etc."
3345 (cond
3346 ((and (string-match "R" switches)
3347 (not (string-match "R" dired-actual-switches)))
3348 ;; Adding -R to ls switches -- save `dired-subdir-alist':
3349 (setq dired-subdir-alist-pre-R dired-subdir-alist))
3350 ((and (string-match "R" dired-actual-switches)
3351 (not (string-match "R" switches)))
3352 ;; Deleting -R from ls switches -- revert to pre-R subdirs
3353 ;; that are still present:
3354 (setq dired-subdir-alist
3355 (if dired-subdir-alist-pre-R
3356 (let (subdirs)
3357 (while dired-subdir-alist-pre-R
3358 (if (assoc (caar dired-subdir-alist-pre-R)
3359 dired-subdir-alist)
3360 ;; subdir still present...
3361 (setq subdirs
3362 (cons (car dired-subdir-alist-pre-R)
3363 subdirs)))
3364 (setq dired-subdir-alist-pre-R
3365 (cdr dired-subdir-alist-pre-R)))
3366 (reverse subdirs))
3367 ;; No pre-R subdir alist, so revert to main directory
3368 ;; listing:
3369 (list (car (reverse dired-subdir-alist))))))))
3370 \f
3372 ;;;; Drag and drop support
3374 (defcustom dired-recursive-copies 'top
3375 "Decide whether recursive copies are allowed.
3376 A value of nil means no recursive copies.
3377 `always' means copy recursively without asking.
3378 `top' means ask for each directory at top level.
3379 Anything else means ask for each directory."
3380 :type '(choice :tag "Copy directories"
3381 (const :tag "No recursive copies" nil)
3382 (const :tag "Ask for each directory" t)
3383 (const :tag "Ask for each top directory only" top)
3384 (const :tag "Copy directories without asking" always))
3385 :group 'dired)
3387 (defun dired-dnd-popup-notice ()
3388 (message-box
3391 (declare-function x-popup-menu "menu.c" (position menu))
3393 (defun dired-dnd-do-ask-action (uri)
3394 ;; No need to get actions and descriptions from the source,
3395 ;; we only have three actions anyway.
3396 (let ((action (x-popup-menu
3397 t
3398 (list "What action?"
3399 (cons ""
3400 '(("Copy here" . copy)
3401 ("Move here" . move)
3402 ("Link here" . link)
3403 "--"
3404 ("Cancel" . nil)))))))
3405 (if action
3406 (dired-dnd-handle-local-file uri action)
3407 nil)))
3409 (declare-function dired-relist-entry "dired-aux" (file))
3410 (declare-function make-symbolic-link "fileio.c")
3412 ;; Only used when (featurep 'dnd).
3413 (declare-function dnd-get-local-file-name "dnd" (uri &optional must-exist))
3414 (declare-function dnd-get-local-file-uri "dnd" (uri))
3416 (defun dired-dnd-handle-local-file (uri action)
3417 "Copy, move or link a file to the dired directory.
3418 URI is the file to handle, ACTION is one of copy, move, link or ask.
3419 Ask means pop up a menu for the user to select one of copy, move or link."
3420 (require 'dired-aux)
3421 (let* ((from (dnd-get-local-file-name uri t))
3422 (to (when from
3423 (concat (dired-current-directory)
3424 (file-name-nondirectory from)))))
3425 (when from
3426 (cond ((eq action 'ask)
3427 (dired-dnd-do-ask-action uri))
3428 ;; If copying a directory and dired-recursive-copies is
3429 ;; nil, dired-copy-file fails. Pop up a notice.
3430 ((and (memq action '(copy private))
3431 (file-directory-p from)
3432 (not dired-recursive-copies))
3433 (dired-dnd-popup-notice))
3434 ((memq action '(copy private move link))
3435 (let ((overwrite (and (file-exists-p to)
3436 (y-or-n-p
3437 (format "Overwrite existing file `%s'? " to))))
3438 ;; Binding dired-overwrite-confirmed to nil makes
3439 ;; dired-handle-overwrite a no-op. We instead use
3440 ;; y-or-n-p, which pops a graphical menu.
3441 dired-overwrite-confirmed backup-file)
3442 (when (and overwrite
3443 ;; d-b-o is defined in dired-aux.
3444 (boundp 'dired-backup-overwrite)
3445 dired-backup-overwrite
3446 (setq backup-file
3447 (car (find-backup-file-name to)))
3448 (or (eq dired-backup-overwrite 'always)
3449 (y-or-n-p
3450 (format
3451 "Make backup for existing file `%s'? " to))))
3452 (rename-file to backup-file 0)
3453 (dired-relist-entry backup-file))
3454 (cond ((memq action '(copy private))
3455 (dired-copy-file from to overwrite))
3456 ((eq action 'move)
3457 (dired-rename-file from to overwrite))
3458 ((eq action 'link)
3459 (make-symbolic-link from to overwrite)))
3460 (dired-relist-entry to)
3461 action))))))
3463 (defun dired-dnd-handle-file (uri action)
3464 "Copy, move or link a file to the dired directory if it is a local file.
3465 URI is the file to handle. If the hostname in the URI isn't local, do nothing.
3466 ACTION is one of copy, move, link or ask.
3467 Ask means pop up a menu for the user to select one of copy, move or link."
3468 (let ((local-file (dnd-get-local-file-uri uri)))
3469 (if local-file (dired-dnd-handle-local-file local-file action)
3470 nil)))
3471 \f
3473 ;;;; Desktop support
3475 (eval-when-compile (require 'desktop))
3477 (defun dired-desktop-buffer-misc-data (desktop-dirname)
3478 "Auxiliary information to be saved in desktop file."
3479 (cons
3480 ;; Value of `dired-directory'.
3481 (if (consp dired-directory)
3482 ;; Directory name followed by list of files.
3483 (cons (desktop-file-name (car dired-directory) desktop-dirname)
3484 (cdr dired-directory))
3485 ;; Directory name, optionally with shell wildcard.
3486 (desktop-file-name dired-directory desktop-dirname))
3487 ;; Subdirectories in `dired-subdir-alist'.
3488 (cdr
3489 (nreverse
3490 (mapcar
3491 (function (lambda (f) (desktop-file-name (car f) desktop-dirname)))
3492 dired-subdir-alist)))))
3494 (defun dired-restore-desktop-buffer (desktop-buffer-file-name
3495 desktop-buffer-name
3496 desktop-buffer-misc)
3497 "Restore a dired buffer specified in a desktop file."
3498 ;; First element of `desktop-buffer-misc' is the value of `dired-directory'.
3499 ;; This value is a directory name, optionally with shell wildcard or
3500 ;; a directory name followed by list of files.
3501 (let* ((dired-dir (car desktop-buffer-misc))
3502 (dir (if (consp dired-dir) (car dired-dir) dired-dir)))
3503 (if (file-directory-p (file-name-directory dir))
3504 (progn
3505 (dired dired-dir)
3506 ;; The following elements of `desktop-buffer-misc' are the keys
3507 ;; from `dired-subdir-alist'.
3508 (mapc 'dired-maybe-insert-subdir (cdr desktop-buffer-misc))
3509 (current-buffer))
3510 (message "Desktop: Directory %s no longer exists." dir)
3511 (when desktop-missing-file-warning (sit-for 1))
3512 nil)))
3514 (add-to-list 'desktop-buffer-mode-handlers
3515 '(dired-mode . dired-restore-desktop-buffer))
3517 \f
3518 ;;; Start of automatically extracted autoloads.
3519 \f
3520 ;;;### (autoloads (dired-show-file-type dired-do-query-replace-regexp
3521 ;;;;;; dired-do-search dired-do-isearch-regexp dired-do-isearch
3522 ;;;;;; dired-isearch-filenames-regexp dired-isearch-filenames dired-isearch-filenames-setup
3523 ;;;;;; dired-hide-all dired-hide-subdir dired-tree-down dired-tree-up
3524 ;;;;;; dired-kill-subdir dired-mark-subdir-files dired-goto-subdir
3525 ;;;;;; dired-prev-subdir dired-insert-subdir dired-maybe-insert-subdir
3526 ;;;;;; dired-downcase dired-upcase dired-do-symlink-regexp dired-do-hardlink-regexp
3527 ;;;;;; dired-do-copy-regexp dired-do-rename-regexp dired-do-rename
3528 ;;;;;; dired-do-hardlink dired-do-symlink dired-do-copy dired-create-directory
3529 ;;;;;; dired-rename-file dired-copy-file dired-relist-file dired-remove-file
3530 ;;;;;; dired-add-file dired-do-redisplay dired-do-load dired-do-byte-compile
3531 ;;;;;; dired-do-compress dired-query dired-compress-file dired-do-kill-lines
3532 ;;;;;; dired-run-shell-command dired-do-shell-command dired-do-async-shell-command
3533 ;;;;;; dired-clean-directory dired-do-print dired-do-touch dired-do-chown
3534 ;;;;;; dired-do-chgrp dired-do-chmod dired-compare-directories dired-backup-diff
3535 ;;;;;; dired-diff) "dired-aux" "dired-aux.el" "03cf081d2aac54764123d2407c3196a2")
3536 ;;; Generated autoloads from dired-aux.el
3538 (autoload 'dired-diff "dired-aux" "\
3539 Compare file at point with file FILE using `diff'.
3540 FILE defaults to the file at the mark. (That's the mark set by
3542 The prompted-for file is the first file given to `diff'.
3543 With prefix arg, prompt for second argument SWITCHES,
3544 which is options for `diff'.
3546 \(fn FILE &optional SWITCHES)" t nil)
3548 (autoload 'dired-backup-diff "dired-aux" "\
3549 Diff this file with its backup file or vice versa.
3550 Uses the latest backup, if there are several numerical backups.
3551 If this file is a backup, diff it with its original.
3552 The backup file is the first file given to `diff'.
3553 With prefix arg, prompt for argument SWITCHES which is options for `diff'.
3555 \(fn &optional SWITCHES)" t nil)
3557 (autoload 'dired-compare-directories "dired-aux" "\
3558 Mark files with different file attributes in two dired buffers.
3559 Compare file attributes of files in the current directory
3560 with file attributes in directory DIR2 using PREDICATE on pairs of files
3561 with the same name. Mark files for which PREDICATE returns non-nil.
3562 Mark files with different names if PREDICATE is nil (or interactively
3563 with empty input at the predicate prompt).
3565 PREDICATE is a Lisp expression that can refer to the following variables:
3567 size1, size2 - file size in bytes
3568 mtime1, mtime2 - last modification time in seconds, as a float
3569 fa1, fa2 - list of file attributes
3570 returned by function `file-attributes'
3572 where 1 refers to attribute of file in the current dired buffer
3573 and 2 to attribute of file in second dired buffer.
3575 Examples of PREDICATE:
3577 (> mtime1 mtime2) - mark newer files
3578 (not (= size1 size2)) - mark files with different sizes
3579 (not (string= (nth 8 fa1) (nth 8 fa2))) - mark files with different modes
3580 (not (and (= (nth 2 fa1) (nth 2 fa2)) - mark files with different UID
3581 (= (nth 3 fa1) (nth 3 fa2)))) and GID.
3583 \(fn DIR2 PREDICATE)" t nil)
3585 (autoload 'dired-do-chmod "dired-aux" "\
3586 Change the mode of the marked (or next ARG) files.
3587 Symbolic modes like `g+w' are allowed.
3589 \(fn &optional ARG)" t nil)
3591 (autoload 'dired-do-chgrp "dired-aux" "\
3592 Change the group of the marked (or next ARG) files.
3594 \(fn &optional ARG)" t nil)
3596 (autoload 'dired-do-chown "dired-aux" "\
3597 Change the owner of the marked (or next ARG) files.
3599 \(fn &optional ARG)" t nil)
3601 (autoload 'dired-do-touch "dired-aux" "\
3602 Change the timestamp of the marked (or next ARG) files.
3603 This calls touch.
3605 \(fn &optional ARG)" t nil)
3607 (autoload 'dired-do-print "dired-aux" "\
3608 Print the marked (or next ARG) files.
3609 Uses the shell command coming from variables `lpr-command' and
3610 `lpr-switches' as default.
3612 \(fn &optional ARG)" t nil)
3614 (autoload 'dired-clean-directory "dired-aux" "\
3615 Flag numerical backups for deletion.
3616 Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
3617 Positive prefix arg KEEP overrides `dired-kept-versions';
3618 Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
3621 with a prefix argument.
3623 \(fn KEEP)" t nil)
3625 (autoload 'dired-do-async-shell-command "dired-aux" "\
3626 Run a shell command COMMAND on the marked files asynchronously.
3628 Like `dired-do-shell-command' but if COMMAND doesn't end in ampersand,
3629 adds `* &' surrounded by whitespace and executes the command asynchronously.
3630 The output appears in the buffer `*Async Shell Command*'.
3632 \(fn COMMAND &optional ARG FILE-LIST)" t nil)
3634 (autoload 'dired-do-shell-command "dired-aux" "\
3635 Run a shell command COMMAND on the marked files.
3636 If no files are marked or a specific numeric prefix arg is given,
3638 The prompt mentions the file(s) or the marker, as appropriate.
3640 If there is a `*' in COMMAND, surrounded by whitespace, this runs
3641 COMMAND just once with the entire file list substituted there.
3643 If there is no `*', but there is a `?' in COMMAND, surrounded by
3644 whitespace, this runs COMMAND on each file individually with the
3645 file name substituted for `?'.
3647 Otherwise, this runs COMMAND on each file individually with the
3648 file name added at the end of COMMAND (separated by a space).
3650 `*' and `?' when not surrounded by whitespace have no special
3651 significance for `dired-do-shell-command', and are passed through
3652 normally to the shell, but you must confirm first. To pass `*' by
3655 If COMMAND produces output, it goes to a separate buffer.
3657 This feature does not try to redisplay Dired buffers afterward, as
3658 there's no telling what files COMMAND may have changed.
3661 When COMMAND runs, its working directory is the top-level directory
3662 of the Dired buffer, so output files usually are created there
3663 instead of in a subdir.
3665 In a noninteractive call (from Lisp code), you must specify
3666 the list of file names explicitly with the FILE-LIST argument, which
3667 can be produced by `dired-get-marked-files', for example.
3669 \(fn COMMAND &optional ARG FILE-LIST)" t nil)
3671 (autoload 'dired-run-shell-command "dired-aux" "\
3672 Not documented
3674 \(fn COMMAND)" nil nil)
3676 (autoload 'dired-do-kill-lines "dired-aux" "\
3677 Kill all marked lines (not the files).
3678 With a prefix argument, kill that many lines starting with the current line.
3679 \(A negative argument kills backward.)
3680 If you use this command with a prefix argument to kill the line
3681 for a file that is a directory, which you have inserted in the
3682 Dired buffer as a subdirectory, then it deletes that subdirectory
3683 from the buffer as well.
3684 To kill an entire subdirectory (without killing its line in the
3685 parent directory), go to its directory header line and use this
3686 command with a prefix argument (the value does not matter).
3688 \(fn &optional ARG FMT)" t nil)
3690 (autoload 'dired-compress-file "dired-aux" "\
3691 Not documented
3693 \(fn FILE)" nil nil)
3695 (autoload 'dired-query "dired-aux" "\
3696 Query user and return nil or t.
3697 Store answer in symbol VAR (which must initially be bound to nil).
3698 Format PROMPT with ARGS.
3699 Binding variable `help-form' will help the user who types the help key.
3701 \(fn QS-VAR QS-PROMPT &rest QS-ARGS)" nil nil)
3703 (autoload 'dired-do-compress "dired-aux" "\
3704 Compress or uncompress marked (or next ARG) files.
3706 \(fn &optional ARG)" t nil)
3708 (autoload 'dired-do-byte-compile "dired-aux" "\
3709 Byte compile marked (or next ARG) Emacs Lisp files.
3711 \(fn &optional ARG)" t nil)
3713 (autoload 'dired-do-load "dired-aux" "\
3714 Load the marked (or next ARG) Emacs Lisp files.
3716 \(fn &optional ARG)" t nil)
3718 (autoload 'dired-do-redisplay "dired-aux" "\
3719 Redisplay all marked (or next ARG) files.
3720 If on a subdir line, redisplay that subdirectory. In that case,
3721 a prefix arg lets you edit the `ls' switches used for the new listing.
3723 Dired remembers switches specified with a prefix arg, so that reverting
3724 the buffer will not reset them. However, using `dired-undo' to re-insert
3725 or delete subdirectories can bypass this machinery. Hence, you sometimes
3726 may have to reset some subdirectory switches after a `dired-undo'.
3727 You can reset all subdirectory switches to the default using
3729 See Info node `(emacs)Subdir switches' for more details.
3731 \(fn &optional ARG TEST-FOR-SUBDIR)" t nil)
3733 (autoload 'dired-add-file "dired-aux" "\
3734 Not documented
3736 \(fn FILENAME &optional MARKER-CHAR)" nil nil)
3738 (autoload 'dired-remove-file "dired-aux" "\
3739 Not documented
3741 \(fn FILE)" nil nil)
3743 (autoload 'dired-relist-file "dired-aux" "\
3744 Create or update the line for FILE in all Dired buffers it would belong in.
3746 \(fn FILE)" nil nil)
3748 (autoload 'dired-copy-file "dired-aux" "\
3749 Not documented
3751 \(fn FROM TO OK-FLAG)" nil nil)
3753 (autoload 'dired-rename-file "dired-aux" "\
3754 Not documented
3756 \(fn FILE NEWNAME OK-IF-ALREADY-EXISTS)" nil nil)
3758 (autoload 'dired-create-directory "dired-aux" "\
3759 Create a directory called DIRECTORY.
3761 \(fn DIRECTORY)" t nil)
3763 (autoload 'dired-do-copy "dired-aux" "\
3764 Copy all marked (or next ARG) files, or copy the current file.
3765 This normally preserves the last-modified date when copying.
3766 When operating on just the current file, you specify the new name.
3767 When operating on multiple or marked files, you specify a directory,
3768 and new copies of these files are made in that directory
3769 with the same names that the files currently have. The default
3770 suggested for the target directory depends on the value of
3771 `dired-dwim-target', which see.
3773 This command copies symbolic links by creating new ones,
3774 like `cp -d'.
3776 \(fn &optional ARG)" t nil)
3778 (autoload 'dired-do-symlink "dired-aux" "\
3779 Make symbolic links to current file or all marked (or next ARG) files.
3780 When operating on just the current file, you specify the new name.
3781 When operating on multiple or marked files, you specify a directory
3782 and new symbolic links are made in that directory
3783 with the same names that the files currently have. The default
3784 suggested for the target directory depends on the value of
3785 `dired-dwim-target', which see.
3789 \(fn &optional ARG)" t nil)
3791 (autoload 'dired-do-hardlink "dired-aux" "\
3792 Add names (hard links) current file or all marked (or next ARG) files.
3793 When operating on just the current file, you specify the new name.
3794 When operating on multiple or marked files, you specify a directory
3795 and new hard links are made in that directory
3796 with the same names that the files currently have. The default
3797 suggested for the target directory depends on the value of
3798 `dired-dwim-target', which see.
3800 \(fn &optional ARG)" t nil)
3802 (autoload 'dired-do-rename "dired-aux" "\
3803 Rename current file or all marked (or next ARG) files.
3804 When renaming just the current file, you specify the new name.
3805 When renaming multiple or marked files, you specify a directory.
3806 This command also renames any buffers that are visiting the files.
3807 The default suggested for the target directory depends on the value
3808 of `dired-dwim-target', which see.
3810 \(fn &optional ARG)" t nil)
3812 (autoload 'dired-do-rename-regexp "dired-aux" "\
3813 Rename selected files whose names match REGEXP to NEWNAME.
3815 With non-zero prefix argument ARG, the command operates on the next ARG
3816 files. Otherwise, it operates on all the marked files, or the current
3817 file if none are marked.
3819 As each match is found, the user must type a character saying
3822 REGEXP defaults to the last regexp used.
3824 With a zero prefix arg, renaming by regexp affects the absolute file name.
3825 Normally, only the non-directory part of the file name is used and changed.
3827 \(fn REGEXP NEWNAME &optional ARG WHOLE-NAME)" t nil)
3829 (autoload 'dired-do-copy-regexp "dired-aux" "\
3830 Copy selected files whose names match REGEXP to NEWNAME.
3831 See function `dired-do-rename-regexp' for more info.
3833 \(fn REGEXP NEWNAME &optional ARG WHOLE-NAME)" t nil)
3835 (autoload 'dired-do-hardlink-regexp "dired-aux" "\
3836 Hardlink selected files whose names match REGEXP to NEWNAME.
3837 See function `dired-do-rename-regexp' for more info.
3839 \(fn REGEXP NEWNAME &optional ARG WHOLE-NAME)" t nil)
3841 (autoload 'dired-do-symlink-regexp "dired-aux" "\
3842 Symlink selected files whose names match REGEXP to NEWNAME.
3843 See function `dired-do-rename-regexp' for more info.
3845 \(fn REGEXP NEWNAME &optional ARG WHOLE-NAME)" t nil)
3847 (autoload 'dired-upcase "dired-aux" "\
3848 Rename all marked (or next ARG) files to upper case.
3850 \(fn &optional ARG)" t nil)
3852 (autoload 'dired-downcase "dired-aux" "\
3853 Rename all marked (or next ARG) files to lower case.
3855 \(fn &optional ARG)" t nil)
3857 (autoload 'dired-maybe-insert-subdir "dired-aux" "\
3858 Insert this subdirectory into the same dired buffer.
3860 else inserts it at its natural place (as `ls -lR' would have done).
3861 With a prefix arg, you may edit the ls switches used for this listing.
3862 You can add `R' to the switches to expand the whole tree starting at
3863 this subdirectory.
3864 This function takes some pains to conform to `ls -lR' output.
3866 Dired remembers switches specified with a prefix arg, so that reverting
3867 the buffer will not reset them. However, using `dired-undo' to re-insert
3868 or delete subdirectories can bypass this machinery. Hence, you sometimes
3869 may have to reset some subdirectory switches after a `dired-undo'.
3870 You can reset all subdirectory switches to the default using
3872 See Info node `(emacs)Subdir switches' for more details.
3874 \(fn DIRNAME &optional SWITCHES NO-ERROR-IF-NOT-DIR-P)" t nil)
3876 (autoload 'dired-insert-subdir "dired-aux" "\
3877 Insert this subdirectory into the same dired buffer.
3878 If it is already present, overwrites previous entry,
3879 else inserts it at its natural place (as `ls -lR' would have done).
3880 With a prefix arg, you may edit the `ls' switches used for this listing.
3881 You can add `R' to the switches to expand the whole tree starting at
3882 this subdirectory.
3883 This function takes some pains to conform to `ls -lR' output.
3885 \(fn DIRNAME &optional SWITCHES NO-ERROR-IF-NOT-DIR-P)" t nil)
3887 (autoload 'dired-prev-subdir "dired-aux" "\
3888 Go to previous subdirectory, regardless of level.
3889 When called interactively and not on a subdir line, go to this subdir's line.
3891 \(fn ARG &optional NO-ERROR-IF-NOT-FOUND NO-SKIP)" t nil)
3893 (autoload 'dired-goto-subdir "dired-aux" "\
3894 Go to end of header line of DIR in this dired buffer.
3895 Return value of point on success, otherwise return nil.
3898 \(fn DIR)" t nil)
3900 (autoload 'dired-mark-subdir-files "dired-aux" "\
3901 Mark all files except `.' and `..' in current subdirectory.
3902 If the Dired buffer shows multiple directories, this command
3903 marks the files listed in the subdirectory that point is in.
3905 \(fn)" t nil)
3907 (autoload 'dired-kill-subdir "dired-aux" "\
3908 Remove all lines of current subdirectory.
3909 Lower levels are unaffected.
3911 \(fn &optional REMEMBER-MARKS)" t nil)
3913 (autoload 'dired-tree-up "dired-aux" "\
3914 Go up ARG levels in the dired tree.
3916 \(fn ARG)" t nil)
3918 (autoload 'dired-tree-down "dired-aux" "\
3919 Go down in the dired tree.
3921 \(fn)" t nil)
3923 (autoload 'dired-hide-subdir "dired-aux" "\
3924 Hide or unhide the current subdirectory and move to next directory.
3925 Optional prefix arg is a repeat factor.
3928 \(fn ARG)" t nil)
3930 (autoload 'dired-hide-all "dired-aux" "\
3931 Hide all subdirectories, leaving only their header lines.
3932 If there is already something hidden, make everything visible again.
3935 \(fn &optional IGNORED)" t nil)
3937 (autoload 'dired-isearch-filenames-setup "dired-aux" "\
3938 Set up isearch to search in Dired file names.
3939 Intended to be added to `isearch-mode-hook'.
3941 \(fn)" nil nil)
3943 (autoload 'dired-isearch-filenames "dired-aux" "\
3944 Search for a string using Isearch only in file names in the Dired buffer.
3946 \(fn)" t nil)
3948 (autoload 'dired-isearch-filenames-regexp "dired-aux" "\
3949 Search for a regexp using Isearch only in file names in the Dired buffer.
3951 \(fn)" t nil)
3953 (autoload 'dired-do-isearch "dired-aux" "\
3954 Search for a string through all marked files using Isearch.
3956 \(fn)" t nil)
3958 (autoload 'dired-do-isearch-regexp "dired-aux" "\
3959 Search for a regexp through all marked files using Isearch.
3961 \(fn)" t nil)
3963 (autoload 'dired-do-search "dired-aux" "\
3964 Search through all marked files for a match for REGEXP.
3965 Stops when a match is found.
3968 \(fn REGEXP)" t nil)
3970 (autoload 'dired-do-query-replace-regexp "dired-aux" "\
3971 Do `query-replace-regexp' of FROM with TO, on all marked files.
3972 Third arg DELIMITED (prefix arg) means replace only word-delimited matches.
3976 \(fn FROM TO &optional DELIMITED)" t nil)
3978 (autoload 'dired-show-file-type "dired-aux" "\
3979 Print the type of FILE, according to the `file' command.
3980 If FILE is a symbolic link and the optional argument DEREF-SYMLINKS is
3981 true then the type of the file linked to by FILE is printed instead.
3983 \(fn FILE &optional DEREF-SYMLINKS)" t nil)
3985 ;;;***
3986 \f
3987 ;;;### (autoloads (dired-do-relsymlink dired-jump) "dired-x" "dired-x.el"
3988 ;;;;;; "bb37ec379c0a523368794491b691fd8d")
3989 ;;; Generated autoloads from dired-x.el
3991 (autoload 'dired-jump "dired-x" "\
3992 Jump to dired buffer corresponding to current buffer.
3993 If in a file, dired the current directory and move to file's line.
3994 If in Dired already, pop up a level and goto old directory's line.
3995 In case the proper dired file line cannot be found, refresh the dired
3996 buffer and try again.
3998 \(fn &optional OTHER-WINDOW)" t nil)
4000 (autoload 'dired-do-relsymlink "dired-x" "\
4001 Relative symlink all marked (or next ARG) files into a directory.
4002 Otherwise make a relative symbolic link to the current file.
4003 This creates relative symbolic links like
4005 foo -> ../bar/foo
4007 not absolute ones like
4009 foo -> /ugly/file/name/that/may/change/any/day/bar/foo
4013 \(fn &optional ARG)" t nil)
4015 ;;;***
4016 \f
4017 ;;; End of automatically extracted autoloads.
4019 (provide 'dired)
4021 (run-hooks 'dired-load-hook) ; for your customizations
4023 ;; arch-tag: e1af7a8f-691c-41a0-aac1-ddd4d3c87517
4024 ;;; dired.el ends here