| blob | 18480acd968274ca052f9349cf023d36388a2ec0 |
1 ;;; dired.el --- directory-browsing commands -*- lexical-binding: t -*-
3 ;; Copyright (C) 1985-1986, 1992-1997, 2000-2012
4 ;; Free Software Foundation, Inc.
6 ;; Author: Sebastian Kremer <sk@thp.uni-koeln.de>
7 ;; Maintainer: FSF
8 ;; Keywords: files
9 ;; Package: emacs
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.
29 ;; It is documented in the Emacs manual.
31 ;; Rewritten in 1990/1991 to add tree features, file marking and
32 ;; sorting by Sebastian Kremer <sk@thp.uni-koeln.de>.
33 ;; Finished up by rms in 1992.
35 ;;; Code:
37 ;;; Customizable variables
40 "Directory editing."
45 "Handling marks in Dired."
50 ;;;###autoload
52 "Switches passed to `ls' for Dired. MUST contain the `l' option.
53 May contain all other options that don't contradict `-l';
54 may contain even `F', `b', `i' and `s'. See also the variable
55 `dired-ls-F-marks-symlinks' concerning the `F' switch.
56 On systems such as MS-DOS and MS-Windows, which use `ls' emulation in Lisp,
57 some of the `ls' switches are not supported; see the doc string of
58 `insert-directory' in `ls-lisp.el' for more details."
63 "If non-nil, switches passed to `ls' for inserting subdirectories.
64 If nil, `dired-listing-switches' is used."
74 "Name of chown command (usually `chown')."
80 The special value of `unspecified' means to check explicitly, and
81 save the result in this variable. This is performed the first
82 time `dired-insert-directory' is called.
84 Note that if you set this option to nil, either through choice or
87 spaces. You might want to install ls from GNU Coreutils, which does
88 support this option. Alternatively, you might want to use Emacs's
90 \(setq ls-lisp-use-insert-directory-program nil)
91 \(require 'ls-lisp)
93 Note that `ls-lisp' does not support as many options as GNU ls, though.
94 For more details, see Info node `(emacs)ls in Lisp'."
101 "Name of chmod command (usually `chmod')."
106 "Name of touch command (usually `touch')."
111 "Informs Dired about how `ls -lF' marks symbolic links.
112 Set this to t if `ls' (or whatever program is specified by
113 `insert-directory-program') with `-lF' marks the symbolic link
114 itself with a trailing @ (usually the case under Ultrix).
116 Example: if `ln -s foo bar; ls -F bar' gives `bar -> foo', set it to
117 nil (the default), if it gives `bar@ -> foo', set it to t.
119 Dired checks if there is really a @ appended. Thus, if you have a
120 marking `ls' program on one host and a non-marking on another host, and
121 don't care about symbolic links which really end in a @, you can
122 always set this variable to t."
127 "Regexp of files to skip when finding first file of a directory.
128 A value of nil means move to the subdir line.
129 A value of t means move to first file."
132 regexp)
136 ;; Use t as default so that moved files "take their markers with them".
137 "Controls marking of renamed files.
138 If t, files keep their previous marks when they are renamed.
139 If a character, renamed files (whether previously marked or not)
140 are afterward marked with that character."
146 "Controls marking of copied files.
147 If t, copied files are marked if and as the corresponding original files were.
148 If a character, copied files are unconditionally marked with that character."
154 "Controls marking of newly made hard links.
155 If t, they are marked if and as the files linked to were marked.
156 If a character, new links are unconditionally marked with that character."
162 "Controls marking of newly made symbolic links.
163 If t, they are marked if and as the files linked to were marked.
164 If a character, new links are unconditionally marked with that character."
170 "If non-nil, Dired tries to guess a default target directory.
171 This means: if there is a Dired buffer displayed in the next
172 window, use its current directory, instead of this Dired buffer's
173 current directory.
175 The target is used in the prompt for file copy, rename etc."
180 "If non-nil, Dired preserves the last-modified time in a file copy.
181 \(This works on only some systems.)"
185 ; These variables were deleted and the replacements are on files.el.
186 ; We leave aliases behind for back-compatibility.
190 ;;; Hook variables
193 "Run after loading Dired.
194 You can customize key bindings or load extensions with this."
199 "Run at the very end of `dired-mode'."
204 "This hook is run before a dired buffer is read in (created or reverted)."
209 "Hook run after each time a file or directory is read by Dired.
210 After each listing of a file or directory, this hook is run
211 with the buffer narrowed to the listing."
214 ;; Note this can't simply be run inside function `dired-ls' as the hook
215 ;; functions probably depend on the dired-subdir-alist to be OK.
221 "The functions to call when a drop in `dired-mode' is made.
222 See `dnd-protocol-alist' for more information. When nil, behave
223 as in other buffers. Changing this option is effective only for
224 new dired buffers."
230 ;; Internal variables
233 ;; so that you can write things like
234 ;; (let ((dired-marker-char ?X))
235 ;; ;; great code using X markers ...
236 ;; )
237 ;; For example, commands operating on two sets of files, A and B.
238 ;; Or marking files with digits 0-9. This could implicate
239 ;; concentric sets or an order for the marked files.
240 ;; The code depends on dynamic scoping on the marker char.
241 "In Dired, the current mark character.
248 ;; I see no reason ever to make this nil -- rms.
249 ;; (> baud-rate search-slow-speed)
254 ;;;###autoload
256 "The directory name or wildcard spec that this dired directory lists.
257 Local to each dired buffer. May be a list, in which case the car is the
258 directory name and the cdr is the list of files to mention.
261 ;; Beware of "-l;reboot" etc. See bug#3230.
263 "Return non-nil if string SWITCHES does not look risky for dired."
277 ;; These regexps must be tested at beginning-of-line, but are also
278 ;; used to search for next matches, so neither omitting "^" nor
279 ;; replacing "^" by "\n" (to make it slightly faster) will work.
282 ;; "Regexp matching a marked line.
283 ;; Important: the match ends just after the marker."
285 ;; The [^:] part after "d" and "l" is to avoid confusion with the
286 ;; DOS/Windows-style drive letters in directory names, like in "d:/foo".
294 "-[-r][-w].[-r][-w][xs][-r][-w]."
300 ;; The subdirectory names in the next two lists are expanded.
302 "Association list of subdirectories and their buffer positions.
303 Each subdirectory has an element: (DIRNAME . STARTMARKER).
304 The order of elements is the reverse of the order in the buffer.
308 "Keeps track of which switches to use for inserted subdirectories.
316 "Regexp matching a maybe hidden subdirectory line in `ls -lR' output.
317 Subexpression 1 is the subdirectory proper, no trailing colon.
318 The match starts at the beginning of the line and ends after the end
323 "Faces used by Dired."
329 "Face used for directory headers."
337 "Face used for dired marks."
345 "Face used for marked files."
353 "Face used for files flagged for deletion."
360 ;; Inherit from font-lock-warning-face since with min-colors 8
361 ;; font-lock-comment-face is not colored any more.
363 "Face used to highlight a part of a buffer that needs user attention."
371 ;; Inherit from font-lock-comment-delimiter-face since with min-colors 8
372 ;; font-lock-comment-face is not colored any more.
374 "Face used to highlight permissions of group- and world-writable files."
382 "Face used for subdirectories."
390 "Face used for symbolic links."
398 "Face used for files suffixed with `completion-ignored-extensions'."
406 ;;
407 ;; Dired marks.
409 ;;
410 ;; We make heavy use of MATCH-ANCHORED, since the regexps don't identify the
411 ;; file name itself. We search for Dired defined regexps, and then use the
412 ;; Dired defined function `dired-move-to-filename' before searching for the
413 ;; simple regexp ".+". It is that regexp which matches the file name.
414 ;;
415 ;; Marked files.
418 ;;
419 ;; Flagged files.
422 ;; People who are paranoid about security would consider this more
423 ;; important than other things such as whether it is a directory.
424 ;; But we don't want to encourage paranoia, so our default
425 ;; should be what's most useful for non-paranoids. -- rms.
426 ;;; ;;
427 ;;; ;; Files that are group or world writable.
428 ;;; (list (concat dired-re-maybe-mark dired-re-inode-size
429 ;;; "\\([-d]\\(....w....\\|.......w.\\)\\)")
430 ;;; '(1 dired-warning-face)
431 ;;; '(".+" (dired-move-to-filename) nil (0 dired-warning-face)))
432 ;; However, we don't need to highlight the file name, only the
433 ;; permissions, to win generally. -- fx.
434 ;; Fixme: we could also put text properties on the permission
435 ;; fields with keymaps to frob the permissions, somewhat a la XEmacs.
442 ;;
443 ;; Subdirectories.
446 ;;
447 ;; Symbolic links.
450 ;;
451 ;; Files suffixed with `completion-ignored-extensions'.
453 ;; It is quicker to first find just an extension, then go back to the
454 ;; start of that file name. So we do this complex MATCH-ANCHORED form.
457 ;;
458 ;; Files suffixed with `completion-ignored-extensions'
459 ;; plus a character put in by -F.
465 ;; If the last character is not part of the filename,
466 ;; move back to the start of the filename
467 ;; so it can be fontified.
468 ;; Otherwise, leave point at the end of the line;
469 ;; that way, nothing is fontified.
473 ;;
474 ;; Explicitly put the default face on file names ending in a colon to
475 ;; avoid fontifying them as directory header.
478 ;;
479 ;; Directory headers.
481 )
485 \f
486 ;;; Macros must be defined before they are used, for the byte compiler.
489 "Mark all files for which PREDICATE evals to non-nil.
490 PREDICATE is evaluated on each line, with point at beginning of line.
491 MSG is a noun phrase for the type of files being marked.
492 It should end with a noun that can be pluralized by adding `s'.
493 Return value is the number of files marked, or nil if none were marked."
503 ,msg
505 " for deletion"
516 count
517 ,msg
525 distinguish-one-marked)
526 "Eval BODY with point on each marked line. Return a list of BODY's results.
527 If no marked file could be found, execute BODY on the current
528 line. ARG, if non-nil, specifies the files to use instead of the
529 marked files.
531 If ARG is an integer, use the next ARG (or previous -ARG, if
532 ARG<0) files. In that case, point is dragged along. This is so
533 that commands on the next ARG (instead of the marked) files can
534 be chained easily.
535 For any other non-nil value of ARG, use the current file.
537 If optional third arg SHOW-PROGRESS evaluates to non-nil,
538 redisplay the dired buffer after each file is processed.
540 No guarantee is made about the position on the marked line. BODY
541 must ensure this itself if it depends on this.
543 Search starts at the beginning of the buffer, thus the car of the
544 list corresponds to the line nearest to the buffer's bottom.
545 This is also true for (positive and negative) integer values of
546 ARG.
548 BODY should not be too long as it is expanded four times.
550 If DISTINGUISH-ONE-MARKED is non-nil, then if we find just one
551 marked file, return (t FILENAME) instead of (FILENAME)."
552 ;;
553 ;;Warning: BODY must not add new lines before point - this may cause an
554 ;;endless loop.
555 ;;This warning should not apply any longer, sk 2-Sep-1991 14:10.
562 ,arg
568 results))
569 ;; non-nil, non-integer ARG means use current file:
574 ;; remember position of next marked file before BODY
575 ;; can insert lines before the just found file,
576 ;; confusing us by finding the same marked file again
577 ;; and again and...
585 ;; move after last match
594 results
596 ;; save-excursion loses, again
600 "Return the marked files' names as list of strings.
601 The list is in the same order as the buffer, that is, the car is the
602 first marked file.
603 Values returned are normally absolute file names.
604 Optional arg LOCALP as in `dired-get-filename'.
605 Optional second argument ARG, if non-nil, specifies files near
606 point instead of marked files. It usually comes from the prefix
607 argument.
608 If ARG is an integer, use the next ARG files.
609 Any other non-nil value means to use the current file instead.
610 Optional third argument FILTER, if non-nil, is a function to select
611 some of the files--those for which (funcall FILTER FILENAME) is non-nil.
613 If DISTINGUISH-ONE-MARKED is non-nil, then if we find just one marked file,
614 return (t FILENAME) instead of (FILENAME).
615 Don't use that together with FILTER."
620 arg nil distinguish-one-marked)))
621 result)
624 all-of-them
629 result)))
630 \f
631 ;; The dired command
634 ;; For use in interactive.
638 dired-listing-switches))
639 ;; If a dialog is used, call `read-directory-name' so the
640 ;; dialog code knows we want directories. Some dialogs
641 ;; can only select directories or files when popped up,
642 ;; not both. If no dialog is used, call `read-file-name'
643 ;; because the user may want completion of file names for
644 ;; use in a wildcard pattern.
647 nil default-directory nil)
649 nil default-directory nil)))))
651 ;; We want to switch to a more sophisticated version of
652 ;; dired-read-dir-and-switches like the following, if there is a way
653 ;; to make it more intuitive. See bug#1285.
655 ;; (defun dired-read-dir-and-switches (str)
656 ;; ;; For use in interactive.
657 ;; (reverse
658 ;; (list
659 ;; (if current-prefix-arg
660 ;; (read-string "Dired listing switches: "
661 ;; dired-listing-switches))
662 ;; ;; If a dialog is about to be used, call read-directory-name so
663 ;; ;; the dialog code knows we want directories. Some dialogs can
664 ;; ;; only select directories or files when popped up, not both.
665 ;; (if (next-read-file-uses-dialog-p)
666 ;; (read-directory-name (format "Dired %s(directory): " str)
667 ;; nil default-directory nil)
668 ;; (let ((cie ()))
669 ;; (dolist (ext completion-ignored-extensions)
670 ;; (if (eq ?/ (aref ext (1- (length ext)))) (push ext cie)))
671 ;; (setq cie (concat (regexp-opt cie "\\(?:") "\\'"))
672 ;; (let* ((default (and buffer-file-name
673 ;; (abbreviate-file-name buffer-file-name)))
674 ;; (cie cie)
675 ;; (completion-table
676 ;; ;; We need a mix of read-file-name and
677 ;; ;; read-directory-name so that completion to directories
678 ;; ;; is preferred, but if the user wants to enter a global
679 ;; ;; pattern, he can still use completion on filenames to
680 ;; ;; help him write the pattern.
681 ;; ;; Essentially, we want to use
682 ;; ;; (completion-table-with-predicate
683 ;; ;; 'read-file-name-internal 'file-directory-p nil)
684 ;; ;; but that doesn't work because read-file-name-internal
685 ;; ;; does not obey its `predicate' argument.
686 ;; (completion-table-in-turn
687 ;; (lambda (str pred action)
688 ;; (let ((read-file-name-predicate
689 ;; (lambda (f)
690 ;; (and (not (member f '("./" "../")))
691 ;; ;; Hack! Faster than file-directory-p!
692 ;; (eq (aref f (1- (length f))) ?/)
693 ;; (not (string-match cie f))))))
694 ;; (complete-with-action
695 ;; action 'read-file-name-internal str nil)))
696 ;; 'read-file-name-internal)))
697 ;; (minibuffer-with-setup-hook
698 ;; (lambda ()
699 ;; (setq minibuffer-default default)
700 ;; (setq minibuffer-completion-table completion-table))
701 ;; (read-file-name (format "Dired %s(directory): " str)
702 ;; nil default-directory nil))))))))
705 "Try to get a file name at point in the current dired buffer.
706 This hook is intended to be put in `file-name-at-point-functions'."
713 ;;;###autoload (define-key ctl-x-map "d" 'dired)
714 ;;;###autoload
717 Optional second argument SWITCHES specifies the `ls' options used.
718 \(Interactively, use a prefix argument to be able to specify SWITCHES.)
719 Dired displays a list of files in DIRNAME (which may also have
720 shell wildcards appended to select certain files). If DIRNAME is a cons,
721 its first element is taken as the directory name and the rest as an explicit
722 list of files to make directory entries for.
728 If DIRNAME is already in a dired buffer, that buffer is used without refresh."
729 ;; Cannot use (interactive "D") because of wildcards.
733 ;;;###autoload (define-key ctl-x-4-map "d" 'dired-other-window)
734 ;;;###autoload
740 ;;;###autoload (define-key ctl-x-5-map "d" 'dired-other-frame)
741 ;;;###autoload
747 ;;;###autoload
749 "Like `dired' but returns the dired buffer as value, does not select it."
751 ;; This loses the distinction between "/foo/*/" and "/foo/*" that
752 ;; some shells make:
763 ;; If the argument was syntactically a directory name not a file name,
764 ;; or if it happens to name a file that is a directory,
765 ;; convert it syntactically to a directory name.
766 ;; The reason for checking initially-was-dirname
767 ;; and not just file-directory-p
768 ;; is that file-directory-p is slow over ftp.
776 ;; The following is an internal dired function. It returns non-nil if
777 ;; the directory visited by the current dired buffer has changed on
778 ;; disk. DIRNAME should be the directory name of that directory.
787 "Return non-nil if current dired buffer needs updating.
788 If NOCONFIRM is non-nil, then this function always returns nil
789 for a remote directory. This feature is used by Auto Revert Mode."
795 ;; Do not auto-revert when the dired buffer can be currently
796 ;; written by the user as in `wdired-mode'.
797 buffer-read-only
801 "Automatically revert dired buffer on revisiting.
802 If t, revisiting an existing dired buffer automatically reverts it.
803 If its value is a function, call this function with the directory
804 name as single argument and revert the buffer if it returns non-nil.
805 Otherwise, a message offering to revert the changed dired buffer
806 is displayed.
807 Note that this is not the same as `auto-revert-mode' that
808 periodically reverts at specified time intervals."
818 ;; If there is an existing dired buffer for DIRNAME, just leave
819 ;; buffer as it is (don't even call dired-revert).
820 ;; This saves time especially for deep trees or with ange-ftp.
821 ;; The user can type `g' easily, and it is more consistent with find-file.
822 ;; But if SWITCHES are given they are probably different from the
823 ;; buffer's old value, so call dired-sort-other, which does
824 ;; revert the buffer.
825 ;; A pity we can't possibly do "Directory has changed - refresh? "
826 ;; like find-file does.
827 ;; Optional argument MODE is passed to dired-find-buffer-nocreate,
828 ;; see there.
831 ;; Look for an existing buffer.
833 ;; Note that buffer already is in dired-mode, if found.
840 ;; file list may have changed
842 ;; this calls dired-revert
844 ;; Always revert regardless of whether it has changed or not.
847 ;; Revert when predicate function returns non-nil.
852 ;; If directory has changed on disk, offer to revert.
857 ;; Else a new buffer
859 ;; We can do this unconditionally
860 ;; because dired-noselect ensures that the name
861 ;; is passed in directory name syntax
862 ;; if it was the name of a directory at all.
867 ;; default-directory and dired-actual-switches are set now
868 ;; (buffer-local), so we can call dired-readin:
873 ;; dired-readin can fail if parent directories are inaccessible.
874 ;; Don't leave an empty buffer around in that case.
879 buffer))
882 ;; Enlarged by dired-advertise
883 ;; Queried by function dired-buffers-for-dir. When this detects a
884 ;; killed buffer, it is removed from this list.
889 ;; FIXME add a doc-string, and document dired-x extensions.
891 ;; This differs from dired-buffers-for-dir in that it does not consider
892 ;; subdirs of default-directory and searches for the first match only.
893 ;; Also, the major mode must be MODE.
895 dired-find-subdir
896 ;; Don't try to find a wildcard as a subdirectory.
902 ;; Wildcards must match, too:
904 ;; We don't want to switch to the same buffer---
907 ;; ---unless it's the only possibility:
909 ;; No dired-x, or dired-find-subdir nil.
918 dired-directory ;; nil during find-alternate-file
923 dired-directory))))
925 blist nil)
927 found)))
929 \f
930 ;; Read in a new dired buffer
933 "Read in a new dired buffer.
934 Differs from `dired-insert-subdir' in that it accepts
935 wildcards, erases the buffer, and builds the subdir-alist anew
936 \(including making it buffer-local and clearing it first)."
938 ;; default-directory and dired-actual-switches must be buffer-local
939 ;; and initialized by now.
941 ;; This makes readin much much faster.
942 ;; In particular, it prevents the font lock hook from running
943 ;; until the directory is all read in.
950 ;; This hook which may want to modify dired-actual-switches
951 ;; based on dired-directory, e.g. with ange-ftp to a SysV host
952 ;; where ls won't understand -Al switches.
960 ;; Don't make undo entries for readin.
966 ;; Must first make alist buffer local and set it to nil because
967 ;; dired-build-subdir-alist will call dired-clear-alist first
974 ;; No need to narrow since the whole buffer contains just
975 ;; dired-readin's output, nothing else. The hook can
976 ;; successfully use dired functions (e.g. dired-get-filename)
977 ;; as the subdir-alist has been built in dired-readin.
980 ;; Subroutines of dired-readin
983 ;; Insert listing for the specified dir (and maybe file list)
984 ;; already in dired-directory, assuming a clean buffer.
990 file-list nil))
994 ;; If we are reading a whole single directory...
999 ;; Else treat it as a wildcard spec
1000 ;; unless we have an explicit list of files.
1005 "Align the fields of a file to the ones of surrounding lines.
1006 BEG..END is the line where the file info is located."
1007 ;; Some versions of ls try to adjust the size of each field so as to just
1008 ;; hold the largest element ("largest" in the current invocation, of
1009 ;; course). So when a single line is output, the size of each field is
1010 ;; just big enough for that one output. Thus when dired refreshes one
1011 ;; line, the alignment if this line w.r.t the rest is messed up because
1012 ;; the fields of that one line will generally be smaller.
1013 ;;
1014 ;; To work around this problem, we here add spaces to try and
1015 ;; re-align the fields as needed. Since this is purely aesthetic,
1016 ;; it is of utmost importance that it doesn't mess up anything like
1017 ;; `dired-move-to-filename'. To this end, we limit ourselves to
1018 ;; adding spaces only, and to only add them at places where there
1019 ;; was already at least one space. This way, as long as
1020 ;; `directory-listing-before-filename-regexp' always matches spaces
1021 ;; with "*" or "+", we know we haven't made anything worse. There
1022 ;; is one spot where the exact number of spaces is important, which
1023 ;; is just before the actual filename, so we refrain from adding
1024 ;; spaces there (and within the filename as well, of course).
1027 ;; Check that there is indeed a file, and that there is another adjacent
1028 ;; file with which to align, and that additional spaces are needed to
1029 ;; align the filenames.
1042 ;; Make sure there is some work left to do.
1044 ;; If we've only looked at the line above, check to see if the line
1045 ;; below exists as well and if so, align with the shorter one.
1054 ;; Keep positions uptodate when we insert stuff.
1057 ;; Main loop.
1061 ;; Don't touch anything just before (and after) the
1062 ;; beginning of the filename.
1064 ;; We're now just in front of a field, with a space behind us.
1066 ;; Nums are right-aligned.
1068 ;; Let's look at the other line, in the same column: we
1069 ;; should be either near the end of the previous field, or
1070 ;; in the space between that field and the next.
1071 ;; [ Of course, it's also possible that we're already within
1072 ;; the next field or even past it, but that's unlikely since
1073 ;; other-col > file-col. ]
1074 ;; Let's find the distance to the alignment-point (either
1075 ;; the beginning or the end of the next field, depending on
1076 ;; whether this field is left or right aligned).
1086 ;; Now, the number of spaces to insert is align-pt-offset
1087 ;; minus the distance to the equivalent point on the
1088 ;; current line.
1091 align-pt-offset
1101 ;; Let's just make really sure we did not mess up.
1104 ;; Damn! We messed up: let's revert the change.
1106 ;; Now skip to next field.
1114 "Return non-nil if the string SWITCHES contains -b or --escape."
1115 ;; Do not match things like "--block-size" that happen to contain "b".
1119 "Insert a directory listing of DIR, Dired style.
1120 Use SWITCHES to make the listings.
1121 If FILE-LIST is non-nil, list only those files.
1122 Otherwise, if WILDCARD is non-nil, expand wildcards;
1123 in that case, DIR should be a file name that uses wildcards.
1124 In other cases, DIR should be a directory name or a directory filename.
1125 If HDR is non-nil, insert a header line with the directory name."
1128 end)
1130 ;; Don't try to invoke `ls' if we are on DOS/Windows where
1131 ;; ls-lisp emulation is used, except if they want to use `ls'
1132 ;; as indicated by `ls-lisp-use-insert-directory-program'.
1136 ;; Check whether "ls --dired" gives exit code 0, and
1137 ;; save the answer in `dired-use-ls-dired'.
1144 nil))
1145 dired-use-ls-dired)
1148 ;; We used to specify the C locale here, to force English month names;
1149 ;; but this should not be necessary any more,
1150 ;; with the new value of `directory-listing-before-filename-regexp'.
1155 ;; Re-align fields, if necessary.
1158 ;; Quote certain characters, unless ls quoted them for us.
1167 nil t))
1173 nil t))
1175 ;; Replace any newlines in DIR with literal "\n"s, for the sake
1176 ;; of the header line. To disambiguate a literal "\n" in the
1177 ;; actual dirname, we also replace "\" with "\\".
1178 ;; Personally, I think this should always be done, irrespective
1179 ;; of the value of dired-actual-switches, because:
1180 ;; i) Dired simply does not work with an unescaped newline in
1181 ;; the directory name used in the header (bug=10469#28), and
1182 ;; ii) "\" is always replaced with "\\" in the listing, so doing
1183 ;; it in the header as well makes things consistent.
1184 ;; But at present it is only done if "-b" is in ls-switches,
1185 ;; because newlines in dirnames are uncommon, and people may
1186 ;; have gotten used to seeing unescaped "\" in the headers.
1187 ;; Note: adjust dired-build-subdir-alist if you change this.
1191 ;; If we used --dired and it worked, the lines are already indented.
1192 ;; Otherwise, indent them.
1198 ;; Insert text at the beginning to standardize things.
1204 ;; Note that dired-build-subdir-alist will replace the name
1205 ;; by its expansion, so it does not matter whether what we insert
1206 ;; here is fully expanded, but it should be absolute.
1209 ;; Insert "wildcard" line where "total" line would be for a full dir.
1213 "Add various text properties to the lines in the region."
1225 dired-filename t
1229 \f
1230 ;; Reverting a dired buffer
1233 "Reread the dired buffer.
1234 Must also be called after `dired-actual-switches' have changed.
1235 Should not fail even on completely garbaged buffers.
1236 Preserves old cursor, marks/flags, hidden-p.
1238 Dired sets `revert-buffer-function' to this function. The args
1239 ARG and NOCONFIRM, passed from `revert-buffer', are ignored."
1251 ;; treat top level dir extra (it may contain wildcards)
1258 ;; Run dired-after-readin-hook just once, below.
1263 ;; ... run the hook for the whole buffer, and only after markers
1264 ;; have been reinserted (else omitting in dired-x would omit marked files)
1272 ;; outside of the let scope
1273 ;;; Might as well not override the user if the user changed this.
1274 ;;; (setq buffer-read-only t)
1275 )
1277 ;; Subroutines of dired-revert
1278 ;; Some of these are also used when inserting subdirs.
1281 "Return current positions in the buffer and all windows with this directory.
1282 The positions have the form (BUFFER-POSITION WINDOW-POSITIONS).
1284 BUFFER-POSITION is the point position in the current dired buffer.
1285 It has the form (BUFFER DIRED-FILENAME BUFFER-POINT).
1287 WINDOW-POSITIONS are current positions in all windows displaying
1288 this dired buffer. The window positions have the form (WINDOW
1289 DIRED-FILENAME WINDOW-POINT)."
1300 "Restore POSITIONS saved with `dired-save-positions'."
1308 ;; Ensure that window still displays the original buffer.
1317 "Return alist of files and their marks, from BEG to END."
1328 alist))
1331 "Mark all files remembered in ALIST.
1332 Each element of ALIST looks like (FILE . MARKERCHAR)."
1346 "Return a list of names of subdirs currently hidden."
1356 result))
1359 "Try to insert all subdirs that were displayed before.
1360 Do so according to the former subdir alist OLD-SUBDIR-ALIST."
1374 "Remove directory DIR from any directory cache."
1378 \f
1379 ;; dired mode key bindings and initialization
1382 ;; This looks ugly when substitute-command-keys uses C-d instead d:
1383 ;; (define-key dired-mode-map "\C-d" 'dired-flag-file-deletion)
1388 ;; Commands to mark or flag certain categories of files
1392 ;; Upper case keys (except !) for operating on the marked files
1411 ;; Comparison commands
1414 ;; Tree Dired commands
1420 ;; move to marked files
1423 ;; Make all regexp commands share a `%' prefix:
1424 ;; We used to get to the submap via a symbol dired-regexp-prefix,
1425 ;; but that seems to serve little purpose, and copy-keymap
1426 ;; does a better job without it.
1439 ;; Commands for marking and unmarking.
1456 ;; Lower keys for commands not operating on all the marked files
1481 ;; moving
1488 ;; hiding
1491 ;; isearch
1496 ;; misc
1502 ;; thumbnail manipulation (image-dired)
1515 ;; encryption and decryption (epa-dired)
1521 ;; Make menu bar items.
1523 ;; No need to fo this, now that top-level items are fewer.
1524 ;;;;
1525 ;; Get rid of the Edit menu bar item to save space.
1526 ;(define-key map [menu-bar edit] 'undefined)
1635 ;; When running on plain MS-DOS, there's only one
1636 ;; letter-case for file names.
1824 map)
1826 \f
1827 ;; Dired mode is suitable only for specially formatted data.
1830 ;; Autoload cookie needed by desktop.el
1831 ;;;###autoload
1833 "\
1836 \(optionally) its subdirectories, in the format of `ls -lR'.
1839 compress, load or byte-compile them, change their file attributes
1842 by file or all files matching certain criteria.
1844 The buffer is read-only. Digits are prefix arguments.
1847 Most commands operate on the marked files and use the current file
1848 if no files are marked. Use a numeric prefix argument to operate on
1849 the next ARG (or previous -ARG if ARG<0) files, or just `1'
1850 to operate on the current file only. Prefix arguments override marks.
1852 to see why something went wrong.
1857 (or dired it in another buffer, if it is a directory).
1864 This retains all marks and hides subdirs again that were hidden before.
1865 Use `SPC' and `DEL' to move down and up by lines.
1868 to read the
1870 to relist the file at point or the marked files or a
1872 again for the directory tree.
1875 for more info):
1877 `dired-listing-switches'
1878 `dired-trivial-filenames'
1879 `dired-shrink-to-fit'
1880 `dired-marker-char'
1881 `dired-del-marker'
1882 `dired-keep-marker-rename'
1883 `dired-keep-marker-copy'
1884 `dired-keep-marker-hardlink'
1885 `dired-keep-marker-symlink'
1889 `dired-before-readin-hook'
1890 `dired-after-readin-hook'
1891 `dired-mode-hook'
1892 `dired-load-hook'
1894 Keybindings:
1896 ;; Not to be called interactively (e.g. dired-directory will be set
1897 ;; to default-directory, which is wrong with wildcards).
1902 mode-name "Dired"
1903 ;; case-fold-search nil
1904 buffer-read-only t
1905 selective-display t ; for subdirectory hiding
1906 mode-line-buffer-identification
1916 ;; list-buffers uses this to display the dir being edited in this buffer.
1920 dired-directory)))
1936 \f
1937 ;; Idiosyncratic dired commands that don't deal with marks.
1940 "Summarize basic Dired commands and show recent dired errors."
1943 ;>> this should check the key-bindings and use substitute-command-keys if non-standard
1948 "Undo in a dired buffer.
1949 This doesn't recover lost files, it just undoes changes in the buffer itself.
1950 You can use it to recover marks, killed lines or subdirs."
1959 "Edit dired buffer with Wdired, or set it read-only.
1960 Call `wdired-change-to-wdired-mode' in dired buffers whose editing is
1961 supported by Wdired (the major mode of the dired buffer is `dired-mode').
1962 Otherwise, for buffers inheriting from dired-mode, call `toggle-read-only'."
1970 "Move down lines then position at filename.
1971 Optional prefix ARG says how many lines to move; default is one line."
1977 "Move up lines then position at filename.
1978 Optional prefix ARG says how many lines to move; default is one line."
1984 "Goto ARG'th next directory file line."
1996 "Goto ARG'th previous directory file line."
2001 "Run Dired on parent directory of current directory.
2002 Find the parent directory either in this buffer or another buffer.
2003 Creates a buffer if necessary."
2008 ;; Only try dired-goto-subdir if buffer has more than one dir.
2018 "Get the current line's file name, with an error if file does not exist."
2020 ;; We pass t for second arg so that we don't get error for `.' and `..'.
2022 file-name)
2027 file-name
2032 ;; Force C-m keybinding rather than `f' or `e' in the mode doc:
2035 "In Dired, visit the file or directory named on this line."
2037 ;; Bind `find-file-run-dired' so that the command works on directories
2038 ;; too, independent of the user's setting.
2043 "In Dired, visit this file or directory instead of the dired buffer."
2047 ;; Don't override the setting from .emacs.
2048 ;;;###autoload (put 'dired-find-alternate-file 'disabled t)
2051 "In Dired, visit the file or directory name you click on."
2072 "In Dired, examine a file in view mode, returning to Dired when done.
2073 When file is a directory, show it in this buffer if it is inserted.
2074 Otherwise, display it in another buffer."
2084 "In Dired, visit this file or directory in another window."
2089 "In Dired, display this file or directory in another window."
2092 \f
2093 ;;; Functions for extracting and manipulating file names in Dired buffers.
2096 "In Dired, return name of file mentioned on this line.
2097 Value returned normally includes the directory name.
2098 Optional arg LOCALP with value `no-dir' means don't include directory
2099 name in result. A value of `verbatim' means to return the name exactly as
2100 it occurs in the buffer, and a value of t means construct name relative to
2101 `default-directory', which still may contain slashes if in a subdirectory.
2102 Optional arg NO-ERROR-IF-NOT-FILEP means treat `.' and `..' as
2103 regular filenames and return nil if no filename on this line.
2104 Otherwise, an error occurs in these cases."
2109 ;; nil if no file on this line, but no-error-if-not-filep is t:
2112 ;; Get rid of the mouse-face property that file names have.
2114 ;; Unquote names quoted by ls or by dired-insert-directory.
2115 ;; This code was written using `read' to unquote, because
2116 ;; it's faster than substituting \007 (4 chars) -> ^G (1
2117 ;; char) etc. in a lisp loop. Unfortunately, this decision
2118 ;; has necessitated hacks such as dealing with filenames
2119 ;; with quotation marks in their names.
2122 ;; Unescape any spaces escaped by ls -b (bug#10469).
2123 ;; Other -b quotes, eg \t, \n, work transparently.
2141 ;; Hence we don't need to worry about converting `\\' back to `\'.
2143 ;; The above `read' will return a unibyte string if FILE
2144 ;; contains eight-bit-control/graphic characters.
2149 ;; A relative file name can start with ~.
2150 ;; Don't treat it as absolute in this context.
2155 nil)
2157 file)
2165 ;; check for safe-magic property so that we won't
2166 ;; put /: for names that don't really need them.
2167 ;; For instance, .gz files when auto-compression-mode is on.
2170 file)))
2172 file)
2176 ;; check for safe-magic property so that we won't
2177 ;; put /: for names that don't really need them.
2178 ;; For instance, .gz files when auto-compression-mode is on.
2181 file)))
2187 "Replace first match of REGEXP in STRING with NEWTEXT.
2188 If it does not match, nil is returned instead of the new string.
2189 Optional arg LITERAL means to take NEWTEXT literally.
2190 Optional arg GLOBAL means to replace all matches."
2197 ret)
2199 nil
2203 ;;"Convert FILE (a file name relative to DIR) to an absolute file name."
2204 ;; We can't always use expand-file-name as this would get rid of `.'
2205 ;; or expand in / instead default-directory if DIR=="".
2206 ;; This should be good enough for ange-ftp.
2207 ;; It should be reasonably fast, though, as it is called in
2208 ;; dired-get-filename.
2212 "Convert FILE (an absolute file name) to a name relative to DIR.
2213 If DIR is omitted or nil, it defaults to `default-directory'.
2214 If FILE is not in the directory tree of DIR, return FILE
2215 unchanged."
2217 ;; This case comes into play if default-directory is set to
2218 ;; use ~.
2223 file))
2224 \f
2225 ;;; Functions for finding the file name in a dired buffer line.
2231 ;; Move to first char of filename on this line.
2232 ;; Returns position (point) or nil if no filename on this line."
2234 "Move to the beginning of the filename on the current line.
2235 Return the position of the beginning of the filename, or nil if none found."
2236 ;; This is the UNIX version.
2239 ;; First try assuming `ls --dired' was used.
2247 ;; Ha! There *is* a file. Our regexp-from-hell just failed to find it.
2251 nil)
2256 ;; Assumes point is at beginning of filename,
2257 ;; thus the rwx bit re-search-backward below will succeed in *this*
2258 ;; line if at all. So, it should be called only after
2259 ;; (dired-move-to-filename t).
2260 ;; On failure, signals an error (with non-nil NO-ERROR just returns nil).
2261 ;; This is the UNIX version.
2265 ;; case-fold-search is nil now, so we can test for capital F:
2272 nil
2274 ;; Restrict perm bits to be non-blank,
2275 ;; otherwise this matches one char to early (looking backward):
2276 ;; "l---------" (some systems make symlinks that way)
2277 ;; "----------" (plain file with zero perms)
2279 dired-permission-flags-regexp nil t)
2282 ;; Only with -F we need to know whether it's an executable
2284 used-F
2292 ;; Move point to end of name:
2298 dired-ls-F-marks-symlinks
2302 ;; ls -lF marks dirs, sockets, fifos and executables with exactly
2303 ;; one trailing character. (Executable bits on symlinks ain't mean
2304 ;; a thing, even to ls, but we know it's not a symlink.)
2307 executable)
2316 nil
2319 \f
2320 ;;; COPY NAMES OF MARKED FILES INTO KILL-RING.
2323 "Copy names of marked (or next ARG) files into the kill ring.
2324 The names are separated by a space.
2325 With a zero prefix arg, use the absolute file name of each marked file.
2327 `default-directory'. (This still may contain slashes if in a subdirectory.)
2329 If on a subdir headerline, use absolute subdirname instead;
2330 prefix arg and marked files are ignored in this case.
2352 \f
2353 ;; Keeping Dired buffers in sync with the filesystem and with each other
2356 ;; Return a list of buffers for DIR (top level or in-situ subdir).
2357 ;; If FILE is non-nil, include only those whose wildcard pattern (if any)
2358 ;; matches FILE.
2359 ;; The list is in reverse order of buffer creation, most recent last.
2360 ;; As a side effect, killed dired buffers for DIR are removed from
2361 ;; dired-buffers.
2368 ;; Buffer is killed - clean up:
2376 dired-directory)))
2379 file)))
2383 result))
2386 "Convert glob-pattern PATTERN to a regular expression."
2388 regexp)
2400 ;; Fails to handle ^ yet ????
2414 regexp
2422 ;;"Advertise in variable `dired-buffers' that we dired `default-directory'."
2423 ;; With wildcards we actually advertise too much.
2426 t ; we have already advertised ourselves
2429 dired-buffers)))))
2432 ;; Remove DIR from the buffer alist in variable dired-buffers.
2433 ;; This has the effect of removing any buffer whose main directory is DIR.
2434 ;; It does not affect buffers in which DIR is a subdir.
2435 ;; Removing is also done as a side-effect in dired-buffer-for-dir.
2438 \f
2439 ;; Tree Dired
2441 ;;; utility functions
2444 ;;"Is FILE part of the directory tree starting at DIR?"
2449 ;; Prepend default-directory to DIR if relative file name.
2450 ;; dired-get-filename must be able to make a valid file name from a
2451 ;; file and its directory DIR.
2454 dir
2458 ;;"Return the subdir name on this line, or nil if not on a headerline."
2459 ;; Look up in the alist whether this is a headerline.
2465 dired-subdir-alist))))
2466 cur-dir))))
2468 ;; can't use macro, must be redefinable for other alist format in dired-nstd.
2482 ;; Return an index into alist for use with nth
2483 ;; for the sake of subdir moving commands.
2492 "Go to next subdirectory, regardless of level."
2493 ;; Use 0 arg to go to this directory's header line.
2494 ;; NO-SKIP prevents moving to end of header line, returning whatever
2495 ;; position was found in dired-subdir-alist.
2498 pos index)
2499 ;; nth with negative arg does not return nil but the first element
2509 nil ; return nil if not found
2513 "Build `dired-subdir-alist' by parsing the buffer.
2514 Returns the new value of the alist.
2515 If optional arg SWITCHES is non-nil, use its value
2516 instead of `dired-actual-switches'."
2524 new-dir-name
2526 ;; Used to expand subdirectory names correctly in recursive
2527 ;; ange-ftp listings.
2534 ;; Avoid taking a file name ending in a colon
2535 ;; as a subdir name.
2545 new-dir-name
2556 ;; Undo any escaping of newlines and \ by dired-insert-directory.
2557 ;; Convert "n" preceded by odd number of \ to newline, and \\ to \.
2565 temp nil)
2569 temp nil))
2572 temp nil))))
2573 new-dir-name)
2576 ;; Place a sub directory boundary between lines.
2583 ;; We don't need to sort it because it is in buffer order per
2584 ;; constructionem. Return new alist:
2585 dired-subdir-alist))
2588 ;; Add new DIR at NEW-MARKER. Don't sort.
2591 dired-subdir-alist)))
2594 ;; Position point on first nontrivial file after point.
2610 "Go to line describing file FILE in this dired buffer."
2611 ;; Return value of point on success, else nil.
2612 ;; FILE must be an absolute file name.
2613 ;; Loses if FILE contains control chars like "\007" for which ls
2614 ;; either inserts "?" or "\\007" into the buffer, so we won't find
2615 ;; it in the buffer.
2628 ;; First, look for a listing under the absolute name.
2632 ;; Otherwise, look for it as a relative name. The
2633 ;; hair is to get the result of `dired-goto-subdir'
2634 ;; without calling it if we don't have any subdirs.
2641 file
2643 ;; Return buffer position, if found.
2648 "Advance to the Dired listing labeled by FILE; return its position.
2649 Return nil if the listing is not found. If FILE contains
2650 characters that would not appear in a Dired buffer, search using
2651 the quoted forms of those characters.
2653 FULL-NAME specifies the actual file name the listing must have,
2654 as returned by `dired-get-filename'. LIMIT is the search limit."
2660 ;; FIXME: to fix this for embedded control characters etc, we
2661 ;; should escape everything that `ls -b' does.
2666 ;; filenames are preceded by SPC, this makes the search faster
2667 ;; (e.g. for the filename "-").
2671 ;; Check that we are in the right place. Match could have
2672 ;; BASE just as initial substring or in permission bits etc.
2676 found)))
2680 ;; FIXME document whatever dired-x is doing.
2682 "Where point should go in a new listing of DIRNAME.
2683 Point assumed at beginning of new subdir line."
2688 \f
2689 ;; These are hooks which make tree dired work.
2690 ;; They are in this file because other parts of dired need to call them.
2691 ;; But they don't call the rest of tree dired unless there are subdirs loaded.
2693 ;; This function is called for each retrieved filename.
2694 ;; It could stand to be faster, though it's mostly function call
2695 ;; overhead. Avoiding the function call seems to save about 10% in
2696 ;; dired-get-filename. Make it a defsubst?
2698 "Return the name of the subdirectory to which this line belongs.
2699 This returns a string with trailing slash, like `default-directory'.
2700 Optional argument means return a file name relative to `default-directory'."
2703 ;; probably because called in a non-dired buffer
2705 elt dir)
2709 ;; use `<=' (not `<') as subdir line is part of subdir
2711 nil ; found
2715 dir)))
2717 ;; Subdirs start at the beginning of their header lines and end just
2718 ;; before the beginning of the next header line (or end of buffer).
2725 \f
2726 ;; Deleting files
2729 "Whether Dired deletes directories recursively.
2730 If nil, Dired will not delete non-empty directories.
2731 `always' means to delete non-empty directories recursively,
2732 without asking. This is dangerous!
2733 `top' means to ask for each top-level directory specified by the
2734 Dired deletion command, and delete its subdirectories without
2735 asking.
2736 Any other value means to ask for each directory."
2744 ;; Match anything but `.' and `..'.
2747 ;; Delete file, possibly delete a directory and all its files.
2748 ;; This function is useful outside of dired. One could change its name
2749 ;; to e.g. recursive-delete-file and put it somewhere else.
2751 Delete FILE or directory (possibly recursively if optional RECURSIVE is true.)
2752 RECURSIVE determines what to do with a non-empty directory. If RECURSIVE is:
2753 nil, do not delete.
2754 `always', delete recursively without asking.
2755 `top', ask for each directory at top level.
2756 Anything else, ask for each sub-directory."
2757 ;; This test is equivalent to
2758 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
2759 ;; but more efficient
2767 delete-by-moving-to-trash)
2768 "trash"
2776 "In Dired, delete the files flagged for deletion.
2777 If NOMESSAGE is non-nil, we don't display any message
2778 if there are no flagged files.
2779 `dired-recursive-deletes' controls whether deletion of
2780 non-empty directories is allowed."
2784 case-fold-search)
2788 ;; this can't move point since ARG is nil
2790 nil)
2791 nil t)
2796 "Delete all marked (or next ARG) files.
2797 `dired-recursive-deletes' controls whether deletion of
2798 non-empty directories is allowed."
2799 ;; This is more consistent with the file marking feature than
2800 ;; dired-do-flagged-delete.
2803 ;; this may move point if ARG is an integer
2805 arg)
2806 arg t))
2811 ;; L is an alist of files to delete, with their buffer positions.
2812 ;; ARG is the prefix arg.
2813 ;; Filenames are absolute.
2814 ;; (car L) *must* be the *last* (bottommost) file in the dired buffer.
2815 ;; That way as changes are made in the buffer they do not shift the
2816 ;; lines still to be changed, so the (point) values in L stay valid.
2817 ;; Also, for subdirs in natural order, a subdir's files are deleted
2818 ;; before the subdir itself - the other way around would not work.
2826 succ count)))
2827 ;; canonicalize file list for pop up
2842 ;; if we get here, removing worked
2858 failures))))
2863 ;; In all buffers dired'ing DIRECTORY, run FUN with ARGS.
2864 ;; If the buffer has a wildcard pattern, check that it matches FILE.
2865 ;; (FILE does not include a directory component.)
2866 ;; FILE may be nil, in which case ignore it.
2867 ;; Return list of buffers where FUN succeeded (i.e., returned non-nil).
2870 file))
2874 success-list))
2876 ;; Delete the entry for FILE from
2888 "Clean up after a deleted file or directory FN.
2889 Removes any expanded subdirectory of deleted directory.
2890 If `dired-x' is loaded and `dired-clean-up-buffers-too' is non-nil,
2891 also offers to kill buffers visiting deleted files and directories."
2895 ;; Offer to kill buffer of deleted file FN.
2911 \f
2912 ;; Confirmation
2921 "Return a string suitable for use in a Dired prompt.
2922 ARG is normally the prefix argument for the calling command.
2923 FILES should be a list of file names.
2927 ;; distinguish-one-marked can cause the first element to be just t.
2932 ;; more than 1 file:
2934 ;; abs(arg) = count
2935 ;; Perhaps this is nicer, but it also takes more screen space:
2936 ;;(format "[%s %d files]" (if (> arg 0) "next" "previous")
2937 ;; count)
2942 "Pop up buffer BUF in a way suitable for Dired."
2947 ;; Try to split the selected window vertically if
2948 ;; that's possible. (Bug#1806)
2950 ;; Otherwise, try to split WINDOW sensibly.
2952 pop-up-frames)
2954 ;; If dired-shrink-to-fit is t, make its window fit its contents.
2956 ;; Try to not delete window when we want to display less than
2957 ;; `window-min-height' lines.
2961 "A list of symbols for commands Dired should not confirm, or t.
2962 Command symbols are `byte-compile', `chgrp', `chmod', `chown', `compress',
2963 `copy', `delete', `hardlink', `load', `move', `print', `shell', `symlink',
2964 `touch' and `uncompress'.
2965 If t, confirmation is never needed."
2976 "Return FUNCTION's result on ARGS after showing which files are marked.
2977 Displays the file names in a buffer named BUFNAME;
2979 This uses function `dired-pop-to-buffer' to do that.
2981 FUNCTION should not manipulate files, just read input
2982 (an argument or confirmation).
2983 The window is not shown if there is just one file or
2984 OP-SYMBOL is a member of the list in `dired-no-confirm'.
2985 FILES is the list of marked files. It can also be (t FILENAME)
2986 in the case of one marked file, to distinguish that from using
2987 just the current file."
2991 ;; If FILES defaulted to the current line's file.
2996 ;; Handle (t FILE) just like (FILE), here.
2997 ;; That value is used (only in some cases), to mean
2998 ;; just one file that was marked, rather than the current line file.
3010 \f
3011 ;; Commands to mark or flag file(s) at or near current line.
3014 ;; This version skips non-file lines.
3025 ;; Advance to the next line--actually, to the line that *was* next.
3026 ;; (If FUNCTION inserted some new lines in between, skip them.)
3038 ;; This used to be a regexp match of the `total ...' line output by
3039 ;; ls, which is slightly faster, but that is not very robust; notably,
3040 ;; it fails for non-english locales.
3044 "Move to the next marked file, wrapping around the end of the buffer."
3061 "Move to the previous marked file, wrapping around the end of the buffer."
3066 ;; Return FILE's marker, or nil if unmarked.
3080 ;; Skip subdir line and following garbage like the `total' line:
3091 "Mark the current (or next ARG) files.
3092 If on a subdir headerline, mark all its files except `.' and `..'.
3096 this subdir."
3106 "Unmark the current (or next ARG) files.
3107 If looking at a subdir, unmark all its files except `.' and `..'."
3113 "In Dired, flag the current line's file for deletion.
3114 With prefix arg, repeat over several lines.
3116 If on a subdir headerline, mark all its files except `.' and `..'."
3122 "In Dired, move up lines and remove marks or deletion flags there.
3123 Optional prefix ARG says how many lines to unmark/unflag; default
3124 is one line."
3129 "Toggle marks: marked files become unmarked, and vice versa.
3130 Files marked with other flags (such as `D') are not affected.
3131 `.' and `..' are never toggled.
3132 As always, hidden subdirs are not affected."
3140 ;; use subst instead of insdel because it does not move
3141 ;; the gap and thus should be faster and because
3142 ;; other characters are left alone automatically
3149 \f
3150 ;;; Commands to mark or flag files based on their characteristics or names.
3159 "Mark all files matching REGEXP for use in later commands.
3160 A prefix argument means to unmark them instead.
3161 `.' and `..' are never marked.
3164 object files--just `.o' will mark more than you might think."
3178 "Mark all files with contents containing REGEXP for use in later commands.
3179 A prefix argument means to unmark them instead.
3180 `.' and `..' are never marked."
3194 ;; For now we do it inside emacs
3195 ;; Grep might be better if there are a lot of files
3205 )))
3209 "In Dired, flag all files containing the specified REGEXP for deletion.
3210 The match is against the non-directory part of the filename. Use `^'
3211 and `$' to anchor matches. Exclude subdirs by hiding them.
3212 `.' and `..' are never flagged."
3217 "Mark all symbolic links.
3218 With prefix argument, unmark or unflag all those files."
3224 "Mark all directory file lines except `.' and `..'.
3225 With prefix argument, unmark or unflag all those files."
3233 "Mark all executable files.
3234 With prefix argument, unmark or unflag all those files."
3239 ;; dired-x.el has a dired-mark-sexp interactive command: mark
3240 ;; files for which PREDICATE returns non-nil.
3243 "Flag for deletion files whose names suggest they are auto save files.
3244 A prefix argument says to unmark or unflag those files instead."
3248 ;; It is less than general to check for # here,
3249 ;; but it's the only way this runs fast enough.
3253 ;; Handle executables in case of -F option.
3254 ;; We need not worry about the other kinds
3255 ;; of markings that -F makes, since they won't
3256 ;; appear on real auto-save files.
3268 ;; `log' here is dubious, since it's typically used for useful log
3269 ;; files, not just TeX stuff. -- fx
3278 "Flag for deletion all files that match `dired-garbage-files-regexp'."
3283 "Flag all backup files (names ending with `~') for deletion.
3284 With prefix argument, unmark or unflag these files."
3288 ;; Don't call backup-file-name-p unless the last character looks like
3289 ;; it might be the end of a backup file name. This isn't very general,
3290 ;; but it's the only way this runs fast enough.
3292 ;; Handle executables in case of -F option.
3293 ;; We need not worry about the other kinds
3294 ;; of markings that -F makes, since they won't
3295 ;; appear on real backup files.
3305 "Change all OLD marks to NEW marks.
3306 OLD and NEW are both characters used to mark files."
3323 t)
3328 "Remove all marks from all files in the dired buffer."
3333 "Remove a specific mark (or any mark) from every file.
3334 After this command, type the mark character to remove,
3335 or type RET to remove all marks.
3336 With prefix arg, query for each marked file.
3344 Type SPC or `y' to unmark one file, DEL or `n' to skip to next,
3354 file))))
3360 count))))
3361 \f
3362 ;; Logging failures operating on files, and showing the results.
3367 "Pop up a buffer with error log output from Dired.
3368 A group of errors from a single command ends with a formfeed.
3384 ;; Log a message or the contents of a buffer.
3385 ;; If LOG is a string and there are more args, it is formatted with
3386 ;; those ARGS. Usually the LOG string ends with a \n.
3387 ;; End each bunch of errors with (dired-log t):
3388 ;; this inserts the current time and buffer at the start of the page,
3389 ;; and \f (formfeed) at the end.
3397 log)))
3410 "State a summary of a command's failures, in echo area and log buffer.
3411 STRING is an overall summary of the failures.
3412 FAILURES is a list of file names that we failed to operate on,
3413 or nil if file names are not applicable."
3423 string failures))
3424 ;; Log a summary describing a bunch of errors.
3427 \f
3428 ;;; Sorting
3430 ;; Most ls can only sort by name or by date (with -t), nothing else.
3431 ;; GNU ls sorts on size with -S, on extension with -X, and unsorted with -U.
3432 ;; So anything that does not contain these is sort "by name".
3437 This indicates to Dired which option switches to watch out for because they
3438 will change the sorting order behavior of `ls'.
3440 To change the default sorting order \(e.g. add a `-v' option\), see the
3441 variable `dired-listing-switches'. To temporarily override the listing
3446 ;; `dired-ls-sorting-switches' after -t overrides -t.
3458 "Non-nil means the Dired sort command is disabled.
3462 ;; Set mode line display according to dired-actual-switches.
3463 ;; Mode line display of "by name" or "by date" guarantees the user a
3464 ;; match with the corresponding regexps. Non-matching switches are
3465 ;; shown literally.
3470 dired-sort-by-name-regexp dired-actual-switches)
3473 dired-sort-by-date-regexp dired-actual-switches)
3483 "Toggle sorting by date, and refresh the Dired buffer.
3484 With a prefix argument, edit the current listing switches instead."
3494 ;; Toggle between sort by date/name. Reverts the buffer.
3496 dired-actual-switches))
3497 ;; Regexp for finding (possibly embedded) -t switches.
3499 case-fold-search)
3500 ;; Remove the -t switch.
3504 ;; Remove a stand-alone -t switch.
3507 ;; Remove a switch of the form -XtY for some X and Y.
3510 ;; Now, if we weren't sorting by date before, add the -t switch.
3516 ;; Some user code loads dired especially for this.
3517 ;; Don't do that--use replace-regexp-in-string instead.
3519 ;; Replace REGEXP with NEWTEXT everywhere in STRING and return result.
3520 ;; NEWTEXT is taken literally---no \\DIGIT escapes will be recognized.
3526 start me))
3530 "Specify new `ls' SWITCHES for current dired buffer.
3531 Values matching `dired-sort-by-date-regexp' or `dired-sort-by-name-regexp'
3532 set the minor mode accordingly, others appear literally in the mode line.
3533 With optional second arg NO-REVERT, don't refresh the listing afterwards."
3544 "Additional processing of -R in ls option string SWITCHES.
3545 Saves `dired-subdir-alist' when R is set and restores saved value
3546 minus any directories explicitly deleted when R is cleared.
3547 To be called first in body of `dired-sort-other', etc."
3551 ;; Adding -R to ls switches -- save `dired-subdir-alist':
3555 ;; Deleting -R from ls switches -- revert to pre-R subdirs
3556 ;; that are still present:
3562 dired-subdir-alist)
3563 ;; subdir still present...
3566 subdirs)))
3570 ;; No pre-R subdir alist, so revert to main directory
3571 ;; listing:
3573 \f
3575 ;;;; Drag and drop support
3578 "Whether Dired copies directories recursively.
3579 If nil, never copy recursively.
3580 `always' means to copy recursively without asking.
3581 `top' means to ask for each directory at top level.
3582 Any other value means to ask for each directory."
3597 ;; No need to get actions and descriptions from the source,
3598 ;; we only have three actions anyway.
3600 t
3606 "--"
3610 nil)))
3615 ;; Only used when (featurep 'dnd).
3622 "Copy, move or link a file to the dired directory.
3623 URI is the file to handle, ACTION is one of copy, move, link or ask.
3624 Ask means pop up a menu for the user to select one of copy, move or link."
3633 ;; If copying a directory and dired-recursive-copies is
3634 ;; nil, dired-copy-file fails. Pop up a notice.
3643 ;; Binding dired-overwrite-confirmed to nil makes
3644 ;; dired-handle-overwrite a no-op. We instead use
3645 ;; y-or-n-p, which pops a graphical menu.
3646 dired-overwrite-confirmed backup-file)
3648 ;; d-b-o is defined in dired-aux.
3650 dired-backup-overwrite
3666 action))))))
3669 "Copy, move or link a file to the dired directory if it is a local file.
3670 URI is the file to handle. If the hostname in the URI isn't local, do nothing.
3671 ACTION is one of copy, move, link or ask.
3672 Ask means pop up a menu for the user to select one of copy, move or link."
3675 nil)))
3676 \f
3678 ;;;; Desktop support
3683 "Auxiliary information to be saved in desktop file."
3685 ;; Value of `dired-directory'.
3687 ;; Directory name followed by list of files.
3690 ;; Directory name, optionally with shell wildcard.
3692 ;; Subdirectories in `dired-subdir-alist'.
3697 dired-subdir-alist)))))
3700 _buffer-name
3701 misc-data)
3702 "Restore a dired buffer specified in a desktop file."
3703 ;; First element of `misc-data' is the value of `dired-directory'.
3704 ;; This value is a directory name, optionally with shell wildcard or
3705 ;; a directory name followed by list of files.
3711 ;; The following elements of `misc-data' are the keys
3712 ;; from `dired-subdir-alist'.
3717 nil)))
3722 \f
3723 ;;; Start of automatically extracted autoloads.
3724 \f
3725 ;;;### (autoloads (dired-show-file-type dired-do-query-replace-regexp
3726 ;;;;;; dired-do-search dired-do-isearch-regexp dired-do-isearch
3727 ;;;;;; dired-isearch-filenames-regexp dired-isearch-filenames dired-isearch-filenames-setup
3728 ;;;;;; dired-hide-all dired-hide-subdir dired-tree-down dired-tree-up
3729 ;;;;;; dired-kill-subdir dired-mark-subdir-files dired-goto-subdir
3730 ;;;;;; dired-prev-subdir dired-insert-subdir dired-maybe-insert-subdir
3731 ;;;;;; dired-downcase dired-upcase dired-do-symlink-regexp dired-do-hardlink-regexp
3732 ;;;;;; dired-do-copy-regexp dired-do-rename-regexp dired-do-rename
3733 ;;;;;; dired-do-hardlink dired-do-symlink dired-do-copy dired-create-directory
3734 ;;;;;; dired-rename-file dired-copy-file dired-relist-file dired-remove-file
3735 ;;;;;; dired-add-file dired-do-redisplay dired-do-load dired-do-byte-compile
3736 ;;;;;; dired-do-compress dired-query dired-compress-file dired-do-kill-lines
3737 ;;;;;; dired-run-shell-command dired-do-shell-command dired-do-async-shell-command
3738 ;;;;;; dired-clean-directory dired-do-print dired-do-touch dired-do-chown
3739 ;;;;;; dired-do-chgrp dired-do-chmod dired-compare-directories dired-backup-diff
3740 ;;;;;; dired-diff) "dired-aux" "dired-aux.el" "91d39bd8f7e9ce93dc752fe74bea78c2")
3741 ;;; Generated autoloads from dired-aux.el
3744 Compare file at point with file FILE using `diff'.
3745 FILE defaults to the file at the mark. (That's the mark set by
3747 The prompted-for FILE is the first file given to `diff'.
3748 With prefix arg, prompt for second argument SWITCHES,
3749 which is the string of command switches for `diff'.
3754 Diff this file with its backup file or vice versa.
3755 Uses the latest backup, if there are several numerical backups.
3756 If this file is a backup, diff it with its original.
3757 The backup file is the first file given to `diff'.
3758 With prefix arg, prompt for argument SWITCHES which is options for `diff'.
3763 Mark files with different file attributes in two dired buffers.
3764 Compare file attributes of files in the current directory
3765 with file attributes in directory DIR2 using PREDICATE on pairs of files
3766 with the same name. Mark files for which PREDICATE returns non-nil.
3767 Mark files with different names if PREDICATE is nil (or interactively
3768 with empty input at the predicate prompt).
3770 PREDICATE is a Lisp expression that can refer to the following variables:
3772 size1, size2 - file size in bytes
3773 mtime1, mtime2 - last modification time in seconds, as a float
3774 fa1, fa2 - list of file attributes
3775 returned by function `file-attributes'
3777 where 1 refers to attribute of file in the current dired buffer
3778 and 2 to attribute of file in second dired buffer.
3780 Examples of PREDICATE:
3782 (> mtime1 mtime2) - mark newer files
3783 (not (= size1 size2)) - mark files with different sizes
3784 (not (string= (nth 8 fa1) (nth 8 fa2))) - mark files with different modes
3785 (not (and (= (nth 2 fa1) (nth 2 fa2)) - mark files with different UID
3786 (= (nth 3 fa1) (nth 3 fa2)))) and GID.
3791 Change the mode of the marked (or next ARG) files.
3792 Symbolic modes like `g+w' are allowed.
3797 Change the group of the marked (or next ARG) files.
3802 Change the owner of the marked (or next ARG) files.
3807 Change the timestamp of the marked (or next ARG) files.
3808 This calls touch.
3813 Print the marked (or next ARG) files.
3814 Uses the shell command coming from variables `lpr-command' and
3815 `lpr-switches' as default.
3820 Flag numerical backups for deletion.
3821 Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
3822 Positive prefix arg KEEP overrides `dired-kept-versions';
3823 Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
3826 with a prefix argument.
3831 Run a shell command COMMAND on the marked files asynchronously.
3833 Like `dired-do-shell-command' but if COMMAND doesn't end in ampersand,
3834 adds `* &' surrounded by whitespace and executes the command asynchronously.
3835 The output appears in the buffer `*Async Shell Command*'.
3840 Run a shell command COMMAND on the marked files.
3841 If no files are marked or a specific numeric prefix arg is given,
3843 The prompt mentions the file(s) or the marker, as appropriate.
3845 If there is a `*' in COMMAND, surrounded by whitespace, this runs
3846 COMMAND just once with the entire file list substituted there.
3848 If there is no `*', but there is a `?' in COMMAND, surrounded by
3849 whitespace, this runs COMMAND on each file individually with the
3850 file name substituted for `?'.
3852 Otherwise, this runs COMMAND on each file individually with the
3853 file name added at the end of COMMAND (separated by a space).
3855 `*' and `?' when not surrounded by whitespace have no special
3856 significance for `dired-do-shell-command', and are passed through
3857 normally to the shell, but you must confirm first.
3859 If you want to use `*' as a shell wildcard with whitespace around
3861 `*' in the shell, but avoids Dired's special handling.
3863 If COMMAND produces output, it goes to a separate buffer.
3865 This feature does not try to redisplay Dired buffers afterward, as
3866 there's no telling what files COMMAND may have changed.
3869 When COMMAND runs, its working directory is the top-level directory
3870 of the Dired buffer, so output files usually are created there
3871 instead of in a subdir.
3873 In a noninteractive call (from Lisp code), you must specify
3874 the list of file names explicitly with the FILE-LIST argument, which
3875 can be produced by `dired-get-marked-files', for example.
3885 Kill all marked lines (not the files).
3886 With a prefix argument, kill that many lines starting with the current line.
3887 \(A negative argument kills backward.)
3888 If you use this command with a prefix argument to kill the line
3889 for a file that is a directory, which you have inserted in the
3890 Dired buffer as a subdirectory, then it deletes that subdirectory
3891 from the buffer as well.
3892 To kill an entire subdirectory (without killing its line in the
3893 parent directory), go to its directory header line and use this
3894 command with a prefix argument (the value does not matter).
3904 Format PROMPT with ARGS, query user, and store the result in SYM.
3905 The return value is either nil or t.
3907 The user may type y or SPC to accept once; n or DEL to skip once;
3908 ! to accept this and subsequent queries; or q or ESC to decline
3909 this and subsequent queries.
3911 If SYM is already bound to a non-nil value, this function may
3912 return automatically without querying the user. If SYM is !,
3913 return t; if SYM is q or ESC, return nil.
3918 Compress or uncompress marked (or next ARG) files.
3923 Byte compile marked (or next ARG) Emacs Lisp files.
3928 Load the marked (or next ARG) Emacs Lisp files.
3933 Redisplay all marked (or next ARG) files.
3934 If on a subdir line, redisplay that subdirectory. In that case,
3935 a prefix arg lets you edit the `ls' switches used for the new listing.
3937 Dired remembers switches specified with a prefix arg, so that reverting
3938 the buffer will not reset them. However, using `dired-undo' to re-insert
3939 or delete subdirectories can bypass this machinery. Hence, you sometimes
3940 may have to reset some subdirectory switches after a `dired-undo'.
3941 You can reset all subdirectory switches to the default using
3943 See Info node `(emacs)Subdir switches' for more details.
3958 Create or update the line for FILE in all Dired buffers it would belong in.
3973 Create a directory called DIRECTORY.
3974 If DIRECTORY already exists, signal an error.
3979 Copy all marked (or next ARG) files, or copy the current file.
3980 When operating on just the current file, prompt for the new name.
3982 When operating on multiple or marked files, prompt for a target
3983 directory, and make the new copies in that directory, with the
3984 same names as the original files. The initial suggestion for the
3985 target directory is the Dired buffer's current directory (or, if
3986 `dired-dwim-target' is non-nil, the current directory of a
3987 neighboring Dired window).
3989 If `dired-copy-preserve-time' is non-nil, this command preserves
3990 the modification time of each old file in the copy, similar to
3993 This command copies symbolic links by creating new ones, similar
3999 Make symbolic links to current file or all marked (or next ARG) files.
4000 When operating on just the current file, you specify the new name.
4001 When operating on multiple or marked files, you specify a directory
4002 and new symbolic links are made in that directory
4003 with the same names that the files currently have. The default
4004 suggested for the target directory depends on the value of
4005 `dired-dwim-target', which see.
4012 Add names (hard links) current file or all marked (or next ARG) files.
4013 When operating on just the current file, you specify the new name.
4014 When operating on multiple or marked files, you specify a directory
4015 and new hard links are made in that directory
4016 with the same names that the files currently have. The default
4017 suggested for the target directory depends on the value of
4018 `dired-dwim-target', which see.
4023 Rename current file or all marked (or next ARG) files.
4024 When renaming just the current file, you specify the new name.
4025 When renaming multiple or marked files, you specify a directory.
4026 This command also renames any buffers that are visiting the files.
4027 The default suggested for the target directory depends on the value
4028 of `dired-dwim-target', which see.
4033 Rename selected files whose names match REGEXP to NEWNAME.
4035 With non-zero prefix argument ARG, the command operates on the next ARG
4036 files. Otherwise, it operates on all the marked files, or the current
4037 file if none are marked.
4039 As each match is found, the user must type a character saying
4042 REGEXP defaults to the last regexp used.
4044 With a zero prefix arg, renaming by regexp affects the absolute file name.
4045 Normally, only the non-directory part of the file name is used and changed.
4050 Copy selected files whose names match REGEXP to NEWNAME.
4051 See function `dired-do-rename-regexp' for more info.
4056 Hardlink selected files whose names match REGEXP to NEWNAME.
4057 See function `dired-do-rename-regexp' for more info.
4062 Symlink selected files whose names match REGEXP to NEWNAME.
4063 See function `dired-do-rename-regexp' for more info.
4068 Rename all marked (or next ARG) files to upper case.
4073 Rename all marked (or next ARG) files to lower case.
4078 Insert this subdirectory into the same dired buffer.
4080 else inserts it at its natural place (as `ls -lR' would have done).
4081 With a prefix arg, you may edit the ls switches used for this listing.
4082 You can add `R' to the switches to expand the whole tree starting at
4083 this subdirectory.
4084 This function takes some pains to conform to `ls -lR' output.
4086 Dired remembers switches specified with a prefix arg, so that reverting
4087 the buffer will not reset them. However, using `dired-undo' to re-insert
4088 or delete subdirectories can bypass this machinery. Hence, you sometimes
4089 may have to reset some subdirectory switches after a `dired-undo'.
4090 You can reset all subdirectory switches to the default using
4092 See Info node `(emacs)Subdir switches' for more details.
4097 Insert this subdirectory into the same Dired buffer.
4098 If it is already present, overwrite the previous entry;
4099 otherwise, insert it at its natural place (as `ls -lR' would
4100 have done).
4101 With a prefix arg, you may edit the `ls' switches used for this listing.
4102 You can add `R' to the switches to expand the whole tree starting at
4103 this subdirectory.
4104 This function takes some pains to conform to `ls -lR' output.
4109 Go to previous subdirectory, regardless of level.
4110 When called interactively and not on a subdir line, go to this subdir's line.
4115 Go to end of header line of DIR in this dired buffer.
4116 Return value of point on success, otherwise return nil.
4122 Mark all files except `.' and `..' in current subdirectory.
4123 If the Dired buffer shows multiple directories, this command
4124 marks the files listed in the subdirectory that point is in.
4129 Remove all lines of current subdirectory.
4130 Lower levels are unaffected.
4135 Go up ARG levels in the dired tree.
4140 Go down in the dired tree.
4145 Hide or unhide the current subdirectory and move to next directory.
4146 Optional prefix arg is a repeat factor.
4152 Hide all subdirectories, leaving only their header lines.
4153 If there is already something hidden, make everything visible again.
4159 Set up isearch to search in Dired file names.
4160 Intended to be added to `isearch-mode-hook'.
4165 Search for a string using Isearch only in file names in the Dired buffer.
4170 Search for a regexp using Isearch only in file names in the Dired buffer.
4175 Search for a string through all marked files using Isearch.
4180 Search for a regexp through all marked files using Isearch.
4185 Search through all marked files for a match for REGEXP.
4186 Stops when a match is found.
4192 Do `query-replace-regexp' of FROM with TO, on all marked files.
4193 Third arg DELIMITED (prefix arg) means replace only word-delimited matches.
4200 Print the type of FILE, according to the `file' command.
4201 If you give a prefix to this command, and FILE is a symbolic
4202 link, then the type of the file linked to by FILE is printed
4203 instead.
4207 ;;;***
4208 \f
4209 ;;;### (autoloads (dired-do-relsymlink dired-jump-other-window dired-jump)
4210 ;;;;;; "dired-x" "dired-x.el" "d2461aa6efb8c1d7de8f245728ab448e")
4211 ;;; Generated autoloads from dired-x.el
4214 Jump to dired buffer corresponding to current buffer.
4215 If in a file, dired the current directory and move to file's line.
4216 If in Dired already, pop up a level and goto old directory's line.
4217 In case the proper dired file line cannot be found, refresh the dired
4218 buffer and try again.
4219 When OTHER-WINDOW is non-nil, jump to dired buffer in other window.
4220 Interactively with prefix argument, read FILE-NAME and
4221 move to its line in dired.
4231 Relative symlink all marked (or next ARG) files into a directory.
4232 Otherwise make a relative symbolic link to the current file.
4233 This creates relative symbolic links like
4235 foo -> ../bar/foo
4237 not absolute ones like
4239 foo -> /ugly/file/name/that/may/change/any/day/bar/foo
4245 ;;;***
4246 \f
4247 ;;; End of automatically extracted autoloads.
4253 ;;; dired.el ends here