| blob | d322752e15f336c97c454543da85c5174e23f4de |
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:
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.
66 If nil, `dired-listing-switches' is used."
76 "Name of chown command (usually `chown')."
82 The special value of `unspecified' means to check explicitly, and
83 save the result in this variable. This is performed the first
84 time `dired-insert-directory' is called.
86 Note that if you set this option to nil, either through choice or
89 spaces. You might want to install ls from GNU Coreutils, which does
90 support this option. Alternatively, you might want to use Emacs's
92 \(setq ls-lisp-use-insert-directory-program nil)
93 \(require 'ls-lisp)
95 Note that `ls-lisp' does not support as many options as GNU ls, though.
96 For more details, see Info node `(emacs)ls in Lisp'."
103 "Name of chmod command (usually `chmod')."
108 "Name of touch command (usually `touch')."
113 "Informs Dired about how `ls -lF' marks symbolic links.
114 Set this to t if `ls' (or whatever program is specified by
115 `insert-directory-program') with `-lF' marks the symbolic link
116 itself with a trailing @ (usually the case under Ultrix).
118 Example: if `ln -s foo bar; ls -F bar' gives `bar -> foo', set it to
119 nil (the default), if it gives `bar@ -> foo', set it to t.
121 Dired checks if there is really a @ appended. Thus, if you have a
122 marking `ls' program on one host and a non-marking on another host, and
123 don't care about symbolic links which really end in a @, you can
124 always set this variable to t."
129 "Regexp of files to skip when finding first file of a directory.
130 A value of nil means move to the subdir line.
131 A value of t means move to first file."
134 regexp)
138 ;; Use t as default so that moved files "take their markers with them".
139 "Controls marking of renamed files.
140 If t, files keep their previous marks when they are renamed.
141 If a character, renamed files (whether previously marked or not)
142 are afterward marked with that character."
148 "Controls marking of copied files.
149 If t, copied files are marked if and as the corresponding original files were.
150 If a character, copied files are unconditionally marked with that character."
156 "Controls marking of newly made hard links.
157 If t, they are marked if and as the files linked to were marked.
158 If a character, new links are unconditionally marked with that character."
164 "Controls marking of newly made symbolic links.
165 If t, they are marked if and as the files linked to were marked.
166 If a character, new links are unconditionally marked with that character."
172 "If non-nil, Dired tries to guess a default target directory.
173 This means: if there is a dired buffer displayed in the next window,
174 use its current subdir, instead of the current subdir of this dired buffer.
176 The target is used in the prompt for file copy, rename etc."
181 "If non-nil, Dired preserves the last-modified time in a file copy.
182 \(This works on only some systems.)"
186 ; These variables were deleted and the replacements are on files.el.
187 ; We leave aliases behind for back-compatibility.
191 ;;; Hook variables
194 "Run after loading Dired.
195 You can customize key bindings or load extensions with this."
200 "Run at the very end of `dired-mode'."
205 "This hook is run before a dired buffer is read in (created or reverted)."
210 "Hook run after each time a file or directory is read by Dired.
211 After each listing of a file or directory, this hook is run
212 with the buffer narrowed to the listing."
215 ;; Note this can't simply be run inside function `dired-ls' as the hook
216 ;; functions probably depend on the dired-subdir-alist to be OK.
222 "The functions to call when a drop in `dired-mode' is made.
223 See `dnd-protocol-alist' for more information. When nil, behave
224 as in other buffers. Changing this option is effective only for
225 new dired buffers."
231 ;; Internal variables
234 ;; so that you can write things like
235 ;; (let ((dired-marker-char ?X))
236 ;; ;; great code using X markers ...
237 ;; )
238 ;; For example, commands operating on two sets of files, A and B.
239 ;; Or marking files with digits 0-9. This could implicate
240 ;; concentric sets or an order for the marked files.
241 ;; The code depends on dynamic scoping on the marker char.
242 "In Dired, the current mark character.
249 ;; I see no reason ever to make this nil -- rms.
250 ;; (> baud-rate search-slow-speed)
255 ;;;###autoload
257 "The directory name or wildcard spec that this dired directory lists.
258 Local to each dired buffer. May be a list, in which case the car is the
259 directory name and the cdr is the list of files to mention.
262 ;; Beware of "-l;reboot" etc. See bug#3230.
264 "Return non-nil if string SWITCHES does not look risky for dired."
278 ;; These regexps must be tested at beginning-of-line, but are also
279 ;; used to search for next matches, so neither omitting "^" nor
280 ;; replacing "^" by "\n" (to make it slightly faster) will work.
283 ;; "Regexp matching a marked line.
284 ;; Important: the match ends just after the marker."
286 ;; The [^:] part after "d" and "l" is to avoid confusion with the
287 ;; DOS/Windows-style drive letters in directory names, like in "d:/foo".
295 "-[-r][-w].[-r][-w][xs][-r][-w]."
301 ;; The subdirectory names in the next two lists are expanded.
303 "Association list of subdirectories and their buffer positions.
304 Each subdirectory has an element: (DIRNAME . STARTMARKER).
305 The order of elements is the reverse of the order in the buffer.
309 "Keeps track of which switches to use for inserted subdirectories.
317 "Regexp matching a maybe hidden subdirectory line in `ls -lR' output.
318 Subexpression 1 is the subdirectory proper, no trailing colon.
319 The match starts at the beginning of the line and ends after the end
324 "Faces used by Dired."
330 "Face used for directory headers."
338 "Face used for dired marks."
346 "Face used for marked files."
354 "Face used for files flagged for deletion."
361 ;; Inherit from font-lock-warning-face since with min-colors 8
362 ;; font-lock-comment-face is not colored any more.
364 "Face used to highlight a part of a buffer that needs user attention."
372 ;; Inherit from font-lock-comment-delimiter-face since with min-colors 8
373 ;; font-lock-comment-face is not colored any more.
375 "Face used to highlight permissions of group- and world-writable files."
383 "Face used for subdirectories."
391 "Face used for symbolic links."
399 "Face used for files suffixed with `completion-ignored-extensions'."
407 ;;
408 ;; Dired marks.
410 ;;
411 ;; We make heavy use of MATCH-ANCHORED, since the regexps don't identify the
412 ;; file name itself. We search for Dired defined regexps, and then use the
413 ;; Dired defined function `dired-move-to-filename' before searching for the
414 ;; simple regexp ".+". It is that regexp which matches the file name.
415 ;;
416 ;; Marked files.
419 ;;
420 ;; Flagged files.
423 ;; People who are paranoid about security would consider this more
424 ;; important than other things such as whether it is a directory.
425 ;; But we don't want to encourage paranoia, so our default
426 ;; should be what's most useful for non-paranoids. -- rms.
427 ;;; ;;
428 ;;; ;; Files that are group or world writable.
429 ;;; (list (concat dired-re-maybe-mark dired-re-inode-size
430 ;;; "\\([-d]\\(....w....\\|.......w.\\)\\)")
431 ;;; '(1 dired-warning-face)
432 ;;; '(".+" (dired-move-to-filename) nil (0 dired-warning-face)))
433 ;; However, we don't need to highlight the file name, only the
434 ;; permissions, to win generally. -- fx.
435 ;; Fixme: we could also put text properties on the permission
436 ;; fields with keymaps to frob the permissions, somewhat a la XEmacs.
443 ;;
444 ;; Subdirectories.
447 ;;
448 ;; Symbolic links.
451 ;;
452 ;; Files suffixed with `completion-ignored-extensions'.
454 ;; It is quicker to first find just an extension, then go back to the
455 ;; start of that file name. So we do this complex MATCH-ANCHORED form.
458 ;;
459 ;; Files suffixed with `completion-ignored-extensions'
460 ;; plus a character put in by -F.
466 ;; If the last character is not part of the filename,
467 ;; move back to the start of the filename
468 ;; so it can be fontified.
469 ;; Otherwise, leave point at the end of the line;
470 ;; that way, nothing is fontified.
474 ;;
475 ;; Explicitly put the default face on file names ending in a colon to
476 ;; avoid fontifying them as directory header.
479 ;;
480 ;; Directory headers.
482 )
486 \f
487 ;;; Macros must be defined before they are used, for the byte compiler.
490 "Mark all files for which PREDICATE evals to non-nil.
491 PREDICATE is evaluated on each line, with point at beginning of line.
492 MSG is a noun phrase for the type of files being marked.
493 It should end with a noun that can be pluralized by adding `s'.
494 Return value is the number of files marked, or nil if none were marked."
504 ,msg
506 " for deletion"
517 count
518 ,msg
526 distinguish-one-marked)
527 "Eval BODY with point on each marked line. Return a list of BODY's results.
528 If no marked file could be found, execute BODY on the current
529 line. ARG, if non-nil, specifies the files to use instead of the
530 marked files.
532 If ARG is an integer, use the next ARG (or previous -ARG, if
533 ARG<0) files. In that case, point is dragged along. This is so
534 that commands on the next ARG (instead of the marked) files can
535 be chained easily.
536 For any other non-nil value of ARG, use the current file.
538 If optional third arg SHOW-PROGRESS evaluates to non-nil,
539 redisplay the dired buffer after each file is processed.
541 No guarantee is made about the position on the marked line. BODY
542 must ensure this itself if it depends on this.
544 Search starts at the beginning of the buffer, thus the car of the
545 list corresponds to the line nearest to the buffer's bottom.
546 This is also true for (positive and negative) integer values of
547 ARG.
549 BODY should not be too long as it is expanded four times.
551 If DISTINGUISH-ONE-MARKED is non-nil, then if we find just one
552 marked file, return (t FILENAME) instead of (FILENAME)."
553 ;;
554 ;;Warning: BODY must not add new lines before point - this may cause an
555 ;;endless loop.
556 ;;This warning should not apply any longer, sk 2-Sep-1991 14:10.
563 ,arg
569 results))
570 ;; non-nil, non-integer ARG means use current file:
575 ;; remember position of next marked file before BODY
576 ;; can insert lines before the just found file,
577 ;; confusing us by finding the same marked file again
578 ;; and again and...
586 ;; move after last match
595 results
597 ;; save-excursion loses, again
601 "Return the marked files' names as list of strings.
602 The list is in the same order as the buffer, that is, the car is the
603 first marked file.
604 Values returned are normally absolute file names.
605 Optional arg LOCALP as in `dired-get-filename'.
606 Optional second argument ARG, if non-nil, specifies files near
607 point instead of marked files. It usually comes from the prefix
608 argument.
609 If ARG is an integer, use the next ARG files.
610 Any other non-nil value means to use the current file instead.
611 Optional third argument FILTER, if non-nil, is a function to select
612 some of the files--those for which (funcall FILTER FILENAME) is non-nil.
614 If DISTINGUISH-ONE-MARKED is non-nil, then if we find just one marked file,
615 return (t FILENAME) instead of (FILENAME).
616 Don't use that together with FILTER."
621 arg nil distinguish-one-marked)))
622 result)
625 all-of-them
630 result)))
631 \f
632 ;; The dired command
635 ;; For use in interactive.
639 dired-listing-switches))
640 ;; If a dialog is used, call `read-directory-name' so the
641 ;; dialog code knows we want directories. Some dialogs
642 ;; can only select directories or files when popped up,
643 ;; not both. If no dialog is used, call `read-file-name'
644 ;; because the user may want completion of file names for
645 ;; use in a wildcard pattern.
648 nil default-directory nil)
650 nil default-directory nil)))))
652 ;; We want to switch to a more sophisticated version of
653 ;; dired-read-dir-and-switches like the following, if there is a way
654 ;; to make it more intuitive. See bug#1285.
656 ;; (defun dired-read-dir-and-switches (str)
657 ;; ;; For use in interactive.
658 ;; (reverse
659 ;; (list
660 ;; (if current-prefix-arg
661 ;; (read-string "Dired listing switches: "
662 ;; dired-listing-switches))
663 ;; ;; If a dialog is about to be used, call read-directory-name so
664 ;; ;; the dialog code knows we want directories. Some dialogs can
665 ;; ;; only select directories or files when popped up, not both.
666 ;; (if (next-read-file-uses-dialog-p)
667 ;; (read-directory-name (format "Dired %s(directory): " str)
668 ;; nil default-directory nil)
669 ;; (let ((cie ()))
670 ;; (dolist (ext completion-ignored-extensions)
671 ;; (if (eq ?/ (aref ext (1- (length ext)))) (push ext cie)))
672 ;; (setq cie (concat (regexp-opt cie "\\(?:") "\\'"))
673 ;; (lexical-let* ((default (and buffer-file-name
674 ;; (abbreviate-file-name buffer-file-name)))
675 ;; (cie cie)
676 ;; (completion-table
677 ;; ;; We need a mix of read-file-name and
678 ;; ;; read-directory-name so that completion to directories
679 ;; ;; is preferred, but if the user wants to enter a global
680 ;; ;; pattern, he can still use completion on filenames to
681 ;; ;; help him write the pattern.
682 ;; ;; Essentially, we want to use
683 ;; ;; (completion-table-with-predicate
684 ;; ;; 'read-file-name-internal 'file-directory-p nil)
685 ;; ;; but that doesn't work because read-file-name-internal
686 ;; ;; does not obey its `predicate' argument.
687 ;; (completion-table-in-turn
688 ;; (lambda (str pred action)
689 ;; (let ((read-file-name-predicate
690 ;; (lambda (f)
691 ;; (and (not (member f '("./" "../")))
692 ;; ;; Hack! Faster than file-directory-p!
693 ;; (eq (aref f (1- (length f))) ?/)
694 ;; (not (string-match cie f))))))
695 ;; (complete-with-action
696 ;; action 'read-file-name-internal str nil)))
697 ;; 'read-file-name-internal)))
698 ;; (minibuffer-with-setup-hook
699 ;; (lambda ()
700 ;; (setq minibuffer-default default)
701 ;; (setq minibuffer-completion-table completion-table))
702 ;; (read-file-name (format "Dired %s(directory): " str)
703 ;; nil default-directory nil))))))))
706 "Try to get a file name at point in the current dired buffer.
707 This hook is intended to be put in `file-name-at-point-functions'."
714 ;;;###autoload (define-key ctl-x-map "d" 'dired)
715 ;;;###autoload
718 Optional second argument SWITCHES specifies the `ls' options used.
719 \(Interactively, use a prefix argument to be able to specify SWITCHES.)
720 Dired displays a list of files in DIRNAME (which may also have
721 shell wildcards appended to select certain files). If DIRNAME is a cons,
722 its first element is taken as the directory name and the rest as an explicit
723 list of files to make directory entries for.
729 If DIRNAME is already in a dired buffer, that buffer is used without refresh."
730 ;; Cannot use (interactive "D") because of wildcards.
734 ;;;###autoload (define-key ctl-x-4-map "d" 'dired-other-window)
735 ;;;###autoload
741 ;;;###autoload (define-key ctl-x-5-map "d" 'dired-other-frame)
742 ;;;###autoload
748 ;;;###autoload
750 "Like `dired' but returns the dired buffer as value, does not select it."
752 ;; This loses the distinction between "/foo/*/" and "/foo/*" that
753 ;; some shells make:
764 ;; If the argument was syntactically a directory name not a file name,
765 ;; or if it happens to name a file that is a directory,
766 ;; convert it syntactically to a directory name.
767 ;; The reason for checking initially-was-dirname
768 ;; and not just file-directory-p
769 ;; is that file-directory-p is slow over ftp.
777 ;; The following is an internal dired function. It returns non-nil if
778 ;; the directory visited by the current dired buffer has changed on
779 ;; disk. DIRNAME should be the directory name of that directory.
788 "Return non-nil if current dired buffer needs updating.
789 If NOCONFIRM is non-nil, then this function always returns nil
790 for a remote directory. This feature is used by Auto Revert Mode."
796 ;; Do not auto-revert when the dired buffer can be currently
797 ;; written by the user as in `wdired-mode'.
798 buffer-read-only
802 "Automatically revert dired buffer on revisiting.
803 If t, revisiting an existing dired buffer automatically reverts it.
804 If its value is a function, call this function with the directory
805 name as single argument and revert the buffer if it returns non-nil.
806 Otherwise, a message offering to revert the changed dired buffer
807 is displayed.
808 Note that this is not the same as `auto-revert-mode' that
809 periodically reverts at specified time intervals."
819 ;; If there is an existing dired buffer for DIRNAME, just leave
820 ;; buffer as it is (don't even call dired-revert).
821 ;; This saves time especially for deep trees or with ange-ftp.
822 ;; The user can type `g' easily, and it is more consistent with find-file.
823 ;; But if SWITCHES are given they are probably different from the
824 ;; buffer's old value, so call dired-sort-other, which does
825 ;; revert the buffer.
826 ;; A pity we can't possibly do "Directory has changed - refresh? "
827 ;; like find-file does.
828 ;; Optional argument MODE is passed to dired-find-buffer-nocreate,
829 ;; see there.
832 ;; Look for an existing buffer.
834 ;; Note that buffer already is in dired-mode, if found.
841 ;; file list may have changed
843 ;; this calls dired-revert
845 ;; Always revert regardless of whether it has changed or not.
848 ;; Revert when predicate function returns non-nil.
853 ;; If directory has changed on disk, offer to revert.
858 ;; Else a new buffer
860 ;; We can do this unconditionally
861 ;; because dired-noselect ensures that the name
862 ;; is passed in directory name syntax
863 ;; if it was the name of a directory at all.
868 ;; default-directory and dired-actual-switches are set now
869 ;; (buffer-local), so we can call dired-readin:
874 ;; dired-readin can fail if parent directories are inaccessible.
875 ;; Don't leave an empty buffer around in that case.
880 buffer))
883 ;; Enlarged by dired-advertise
884 ;; Queried by function dired-buffers-for-dir. When this detects a
885 ;; killed buffer, it is removed from this list.
890 ;; FIXME add a doc-string, and document dired-x extensions.
892 ;; This differs from dired-buffers-for-dir in that it does not consider
893 ;; subdirs of default-directory and searches for the first match only.
894 ;; Also, the major mode must be MODE.
896 dired-find-subdir
897 ;; Don't try to find a wildcard as a subdirectory.
903 ;; Wildcards must match, too:
905 ;; We don't want to switch to the same buffer---
908 ;; ---unless it's the only possibility:
910 ;; No dired-x, or dired-find-subdir nil.
919 dired-directory ;; nil during find-alternate-file
924 dired-directory))))
926 blist nil)
928 found)))
930 \f
931 ;; Read in a new dired buffer
934 "Read in a new dired buffer.
935 Differs from `dired-insert-subdir' in that it accepts
936 wildcards, erases the buffer, and builds the subdir-alist anew
937 \(including making it buffer-local and clearing it first)."
939 ;; default-directory and dired-actual-switches must be buffer-local
940 ;; and initialized by now.
942 ;; This makes readin much much faster.
943 ;; In particular, it prevents the font lock hook from running
944 ;; until the directory is all read in.
951 ;; This hook which may want to modify dired-actual-switches
952 ;; based on dired-directory, e.g. with ange-ftp to a SysV host
953 ;; where ls won't understand -Al switches.
961 ;; Don't make undo entries for readin.
967 ;; Must first make alist buffer local and set it to nil because
968 ;; dired-build-subdir-alist will call dired-clear-alist first
975 ;; No need to narrow since the whole buffer contains just
976 ;; dired-readin's output, nothing else. The hook can
977 ;; successfully use dired functions (e.g. dired-get-filename)
978 ;; as the subdir-alist has been built in dired-readin.
981 ;; Subroutines of dired-readin
984 ;; Insert listing for the specified dir (and maybe file list)
985 ;; already in dired-directory, assuming a clean buffer.
991 file-list nil))
995 ;; If we are reading a whole single directory...
1000 ;; Else treat it as a wildcard spec
1001 ;; unless we have an explicit list of files.
1006 "Align the fields of a file to the ones of surrounding lines.
1007 BEG..END is the line where the file info is located."
1008 ;; Some versions of ls try to adjust the size of each field so as to just
1009 ;; hold the largest element ("largest" in the current invocation, of
1010 ;; course). So when a single line is output, the size of each field is
1011 ;; just big enough for that one output. Thus when dired refreshes one
1012 ;; line, the alignment if this line w.r.t the rest is messed up because
1013 ;; the fields of that one line will generally be smaller.
1014 ;;
1015 ;; To work around this problem, we here add spaces to try and
1016 ;; re-align the fields as needed. Since this is purely aesthetic,
1017 ;; it is of utmost importance that it doesn't mess up anything like
1018 ;; `dired-move-to-filename'. To this end, we limit ourselves to
1019 ;; adding spaces only, and to only add them at places where there
1020 ;; was already at least one space. This way, as long as
1021 ;; `directory-listing-before-filename-regexp' always matches spaces
1022 ;; with "*" or "+", we know we haven't made anything worse. There
1023 ;; is one spot where the exact number of spaces is important, which
1024 ;; is just before the actual filename, so we refrain from adding
1025 ;; spaces there (and within the filename as well, of course).
1028 ;; Check that there is indeed a file, and that there is another adjacent
1029 ;; file with which to align, and that additional spaces are needed to
1030 ;; align the filenames.
1043 ;; Make sure there is some work left to do.
1045 ;; If we've only looked at the line above, check to see if the line
1046 ;; below exists as well and if so, align with the shorter one.
1055 ;; Keep positions uptodate when we insert stuff.
1058 ;; Main loop.
1062 ;; Don't touch anything just before (and after) the
1063 ;; beginning of the filename.
1065 ;; We're now just in front of a field, with a space behind us.
1067 ;; Nums are right-aligned.
1069 ;; Let's look at the other line, in the same column: we
1070 ;; should be either near the end of the previous field, or
1071 ;; in the space between that field and the next.
1072 ;; [ Of course, it's also possible that we're already within
1073 ;; the next field or even past it, but that's unlikely since
1074 ;; other-col > file-col. ]
1075 ;; Let's find the distance to the alignment-point (either
1076 ;; the beginning or the end of the next field, depending on
1077 ;; whether this field is left or right aligned).
1087 ;; Now, the number of spaces to insert is align-pt-offset
1088 ;; minus the distance to the equivalent point on the
1089 ;; current line.
1092 align-pt-offset
1102 ;; Let's just make really sure we did not mess up.
1105 ;; Damn! We messed up: let's revert the change.
1107 ;; Now skip to next field.
1115 "Return non-nil if the string SWITCHES contains -b or --escape."
1116 ;; Do not match things like "--block-size" that happen to contain "b".
1120 "Insert a directory listing of DIR, Dired style.
1121 Use SWITCHES to make the listings.
1122 If FILE-LIST is non-nil, list only those files.
1123 Otherwise, if WILDCARD is non-nil, expand wildcards;
1124 in that case, DIR should be a file name that uses wildcards.
1125 In other cases, DIR should be a directory name or a directory filename.
1126 If HDR is non-nil, insert a header line with the directory name."
1129 end)
1131 ;; Don't try to invoke `ls' if we are on DOS/Windows where
1132 ;; ls-lisp emulation is used, except if they want to use `ls'
1133 ;; as indicated by `ls-lisp-use-insert-directory-program'.
1137 ;; Check whether "ls --dired" gives exit code 0, and
1138 ;; save the answer in `dired-use-ls-dired'.
1145 nil))
1146 dired-use-ls-dired)
1149 ;; We used to specify the C locale here, to force English month names;
1150 ;; but this should not be necessary any more,
1151 ;; with the new value of `directory-listing-before-filename-regexp'.
1156 ;; Re-align fields, if necessary.
1159 ;; Quote certain characters, unless ls quoted them for us.
1168 nil t))
1174 nil t))
1176 ;; Replace any newlines in DIR with literal "\n"s, for the sake
1177 ;; of the header line. To disambiguate a literal "\n" in the
1178 ;; actual dirname, we also replace "\" with "\\".
1179 ;; Personally, I think this should always be done, irrespective
1180 ;; of the value of dired-actual-switches, because:
1181 ;; i) Dired simply does not work with an unescaped newline in
1182 ;; the directory name used in the header (bug=10469#28), and
1183 ;; ii) "\" is always replaced with "\\" in the listing, so doing
1184 ;; it in the header as well makes things consistent.
1185 ;; But at present it is only done if "-b" is in ls-switches,
1186 ;; because newlines in dirnames are uncommon, and people may
1187 ;; have gotten used to seeing unescaped "\" in the headers.
1188 ;; Note: adjust dired-build-subdir-alist if you change this.
1192 ;; If we used --dired and it worked, the lines are already indented.
1193 ;; Otherwise, indent them.
1199 ;; Insert text at the beginning to standardize things.
1205 ;; Note that dired-build-subdir-alist will replace the name
1206 ;; by its expansion, so it does not matter whether what we insert
1207 ;; here is fully expanded, but it should be absolute.
1210 ;; Insert "wildcard" line where "total" line would be for a full dir.
1214 "Add various text properties to the lines in the region."
1226 dired-filename t
1230 \f
1231 ;; Reverting a dired buffer
1234 "Reread the dired buffer.
1235 Must also be called after `dired-actual-switches' have changed.
1236 Should not fail even on completely garbaged buffers.
1237 Preserves old cursor, marks/flags, hidden-p.
1239 Dired sets `revert-buffer-function' to this function. The args
1240 ARG and NOCONFIRM, passed from `revert-buffer', are ignored."
1252 ;; treat top level dir extra (it may contain wildcards)
1259 ;; Run dired-after-readin-hook just once, below.
1264 ;; ... run the hook for the whole buffer, and only after markers
1265 ;; have been reinserted (else omitting in dired-x would omit marked files)
1273 ;; outside of the let scope
1274 ;;; Might as well not override the user if the user changed this.
1275 ;;; (setq buffer-read-only t)
1276 )
1278 ;; Subroutines of dired-revert
1279 ;; Some of these are also used when inserting subdirs.
1282 "Return current positions in the buffer and all windows with this directory.
1283 The positions have the form (BUFFER-POSITION WINDOW-POSITIONS).
1285 BUFFER-POSITION is the point position in the current dired buffer.
1286 It has the form (BUFFER DIRED-FILENAME BUFFER-POINT).
1288 WINDOW-POSITIONS are current positions in all windows displaying
1289 this dired buffer. The window positions have the form (WINDOW
1290 DIRED-FILENAME WINDOW-POINT)."
1301 "Restore POSITIONS saved with `dired-save-positions'."
1309 ;; Ensure that window still displays the original buffer.
1318 "Return alist of files and their marks, from BEG to END."
1329 alist))
1332 "Mark all files remembered in ALIST.
1333 Each element of ALIST looks like (FILE . MARKERCHAR)."
1347 "Return a list of names of subdirs currently hidden."
1357 result))
1360 "Try to insert all subdirs that were displayed before.
1361 Do so according to the former subdir alist OLD-SUBDIR-ALIST."
1375 "Remove directory DIR from any directory cache."
1379 \f
1380 ;; dired mode key bindings and initialization
1383 ;; This looks ugly when substitute-command-keys uses C-d instead d:
1384 ;; (define-key dired-mode-map "\C-d" 'dired-flag-file-deletion)
1389 ;; Commands to mark or flag certain categories of files
1393 ;; Upper case keys (except !) for operating on the marked files
1412 ;; Comparison commands
1415 ;; Tree Dired commands
1421 ;; move to marked files
1424 ;; Make all regexp commands share a `%' prefix:
1425 ;; We used to get to the submap via a symbol dired-regexp-prefix,
1426 ;; but that seems to serve little purpose, and copy-keymap
1427 ;; does a better job without it.
1440 ;; Commands for marking and unmarking.
1457 ;; Lower keys for commands not operating on all the marked files
1482 ;; moving
1489 ;; hiding
1492 ;; isearch
1497 ;; misc
1503 ;; thumbnail manipulation (image-dired)
1516 ;; encryption and decryption (epa-dired)
1522 ;; Make menu bar items.
1524 ;; No need to fo this, now that top-level items are fewer.
1525 ;;;;
1526 ;; Get rid of the Edit menu bar item to save space.
1527 ;(define-key map [menu-bar edit] 'undefined)
1636 ;; When running on plain MS-DOS, there's only one
1637 ;; letter-case for file names.
1825 map)
1827 \f
1828 ;; Dired mode is suitable only for specially formatted data.
1831 ;; Autoload cookie needed by desktop.el
1832 ;;;###autoload
1834 "\
1837 \(optionally) its subdirectories, in the format of `ls -lR'.
1840 compress, load or byte-compile them, change their file attributes
1843 by file or all files matching certain criteria.
1845 The buffer is read-only. Digits are prefix arguments.
1848 Most commands operate on the marked files and use the current file
1849 if no files are marked. Use a numeric prefix argument to operate on
1850 the next ARG (or previous -ARG if ARG<0) files, or just `1'
1851 to operate on the current file only. Prefix arguments override marks.
1853 to see why something went wrong.
1858 (or dired it in another buffer, if it is a directory).
1865 This retains all marks and hides subdirs again that were hidden before.
1866 Use `SPC' and `DEL' to move down and up by lines.
1869 to read the
1871 to relist the file at point or the marked files or a
1873 again for the directory tree.
1876 for more info):
1878 `dired-listing-switches'
1879 `dired-trivial-filenames'
1880 `dired-shrink-to-fit'
1881 `dired-marker-char'
1882 `dired-del-marker'
1883 `dired-keep-marker-rename'
1884 `dired-keep-marker-copy'
1885 `dired-keep-marker-hardlink'
1886 `dired-keep-marker-symlink'
1890 `dired-before-readin-hook'
1891 `dired-after-readin-hook'
1892 `dired-mode-hook'
1893 `dired-load-hook'
1895 Keybindings:
1897 ;; Not to be called interactively (e.g. dired-directory will be set
1898 ;; to default-directory, which is wrong with wildcards).
1903 mode-name "Dired"
1904 ;; case-fold-search nil
1905 buffer-read-only t
1906 selective-display t ; for subdirectory hiding
1907 mode-line-buffer-identification
1917 ;; list-buffers uses this to display the dir being edited in this buffer.
1921 dired-directory)))
1937 \f
1938 ;; Idiosyncratic dired commands that don't deal with marks.
1941 "Summarize basic Dired commands and show recent dired errors."
1944 ;>> this should check the key-bindings and use substitute-command-keys if non-standard
1949 "Undo in a dired buffer.
1950 This doesn't recover lost files, it just undoes changes in the buffer itself.
1951 You can use it to recover marks, killed lines or subdirs."
1960 "Edit dired buffer with Wdired, or set it read-only.
1961 Call `wdired-change-to-wdired-mode' in dired buffers whose editing is
1962 supported by Wdired (the major mode of the dired buffer is `dired-mode').
1963 Otherwise, for buffers inheriting from dired-mode, call `toggle-read-only'."
1971 "Move down lines then position at filename.
1972 Optional prefix ARG says how many lines to move; default is one line."
1978 "Move up lines then position at filename.
1979 Optional prefix ARG says how many lines to move; default is one line."
1985 "Goto ARG'th next directory file line."
1997 "Goto ARG'th previous directory file line."
2002 "Run Dired on parent directory of current directory.
2003 Find the parent directory either in this buffer or another buffer.
2004 Creates a buffer if necessary."
2009 ;; Only try dired-goto-subdir if buffer has more than one dir.
2019 "Get the current line's file name, with an error if file does not exist."
2021 ;; We pass t for second arg so that we don't get error for `.' and `..'.
2023 file-name)
2028 file-name
2033 ;; Force C-m keybinding rather than `f' or `e' in the mode doc:
2036 "In Dired, visit the file or directory named on this line."
2038 ;; Bind `find-file-run-dired' so that the command works on directories
2039 ;; too, independent of the user's setting.
2044 "In Dired, visit this file or directory instead of the dired buffer."
2048 ;; Don't override the setting from .emacs.
2049 ;;;###autoload (put 'dired-find-alternate-file 'disabled t)
2052 "In Dired, visit the file or directory name you click on."
2073 "In Dired, examine a file in view mode, returning to Dired when done.
2074 When file is a directory, show it in this buffer if it is inserted.
2075 Otherwise, display it in another buffer."
2085 "In Dired, visit this file or directory in another window."
2090 "In Dired, display this file or directory in another window."
2093 \f
2094 ;;; Functions for extracting and manipulating file names in Dired buffers.
2097 "In Dired, return name of file mentioned on this line.
2098 Value returned normally includes the directory name.
2099 Optional arg LOCALP with value `no-dir' means don't include directory
2100 name in result. A value of `verbatim' means to return the name exactly as
2101 it occurs in the buffer, and a value of t means construct name relative to
2102 `default-directory', which still may contain slashes if in a subdirectory.
2103 Optional arg NO-ERROR-IF-NOT-FILEP means treat `.' and `..' as
2104 regular filenames and return nil if no filename on this line.
2105 Otherwise, an error occurs in these cases."
2110 ;; nil if no file on this line, but no-error-if-not-filep is t:
2113 ;; Get rid of the mouse-face property that file names have.
2115 ;; Unquote names quoted by ls or by dired-insert-directory.
2116 ;; This code was written using `read' to unquote, because
2117 ;; it's faster than substituting \007 (4 chars) -> ^G (1
2118 ;; char) etc. in a lisp loop. Unfortunately, this decision
2119 ;; has necessitated hacks such as dealing with filenames
2120 ;; with quotation marks in their names.
2123 ;; Unescape any spaces escaped by ls -b (bug#10469).
2124 ;; Other -b quotes, eg \t, \n, work transparently.
2142 ;; Hence we don't need to worry about converting `\\' back to `\'.
2144 ;; The above `read' will return a unibyte string if FILE
2145 ;; contains eight-bit-control/graphic characters.
2150 ;; A relative file name can start with ~.
2151 ;; Don't treat it as absolute in this context.
2156 nil)
2158 file)
2166 ;; check for safe-magic property so that we won't
2167 ;; put /: for names that don't really need them.
2168 ;; For instance, .gz files when auto-compression-mode is on.
2171 file)))
2173 file)
2177 ;; check for safe-magic property so that we won't
2178 ;; put /: for names that don't really need them.
2179 ;; For instance, .gz files when auto-compression-mode is on.
2182 file)))
2188 "Replace first match of REGEXP in STRING with NEWTEXT.
2189 If it does not match, nil is returned instead of the new string.
2190 Optional arg LITERAL means to take NEWTEXT literally.
2191 Optional arg GLOBAL means to replace all matches."
2198 ret)
2200 nil
2204 ;;"Convert FILE (a file name relative to DIR) to an absolute file name."
2205 ;; We can't always use expand-file-name as this would get rid of `.'
2206 ;; or expand in / instead default-directory if DIR=="".
2207 ;; This should be good enough for ange-ftp.
2208 ;; It should be reasonably fast, though, as it is called in
2209 ;; dired-get-filename.
2213 "Convert FILE (an absolute file name) to a name relative to DIR.
2214 If this is impossible, return FILE unchanged.
2215 DIR must be a directory name, not a file name."
2217 ;; This case comes into play if default-directory is set to
2218 ;; use ~.
2223 ;;; (or no-error
2224 ;;; (error "%s: not in directory tree growing at %s" file dir))
2225 file))
2226 \f
2227 ;;; Functions for finding the file name in a dired buffer line.
2233 ;; Move to first char of filename on this line.
2234 ;; Returns position (point) or nil if no filename on this line."
2236 "Move to the beginning of the filename on the current line.
2237 Return the position of the beginning of the filename, or nil if none found."
2238 ;; This is the UNIX version.
2241 ;; First try assuming `ls --dired' was used.
2249 ;; Ha! There *is* a file. Our regexp-from-hell just failed to find it.
2253 nil)
2258 ;; Assumes point is at beginning of filename,
2259 ;; thus the rwx bit re-search-backward below will succeed in *this*
2260 ;; line if at all. So, it should be called only after
2261 ;; (dired-move-to-filename t).
2262 ;; On failure, signals an error (with non-nil NO-ERROR just returns nil).
2263 ;; This is the UNIX version.
2267 ;; case-fold-search is nil now, so we can test for capital F:
2274 nil
2276 ;; Restrict perm bits to be non-blank,
2277 ;; otherwise this matches one char to early (looking backward):
2278 ;; "l---------" (some systems make symlinks that way)
2279 ;; "----------" (plain file with zero perms)
2281 dired-permission-flags-regexp nil t)
2284 ;; Only with -F we need to know whether it's an executable
2286 used-F
2294 ;; Move point to end of name:
2300 dired-ls-F-marks-symlinks
2304 ;; ls -lF marks dirs, sockets, fifos and executables with exactly
2305 ;; one trailing character. (Executable bits on symlinks ain't mean
2306 ;; a thing, even to ls, but we know it's not a symlink.)
2309 executable)
2318 nil
2321 \f
2322 ;;; COPY NAMES OF MARKED FILES INTO KILL-RING.
2325 "Copy names of marked (or next ARG) files into the kill ring.
2326 The names are separated by a space.
2327 With a zero prefix arg, use the absolute file name of each marked file.
2329 `default-directory'. (This still may contain slashes if in a subdirectory.)
2331 If on a subdir headerline, use absolute subdirname instead;
2332 prefix arg and marked files are ignored in this case.
2354 \f
2355 ;; Keeping Dired buffers in sync with the filesystem and with each other
2358 ;; Return a list of buffers for DIR (top level or in-situ subdir).
2359 ;; If FILE is non-nil, include only those whose wildcard pattern (if any)
2360 ;; matches FILE.
2361 ;; The list is in reverse order of buffer creation, most recent last.
2362 ;; As a side effect, killed dired buffers for DIR are removed from
2363 ;; dired-buffers.
2370 ;; Buffer is killed - clean up:
2378 dired-directory)))
2381 file)))
2385 result))
2388 "Convert glob-pattern PATTERN to a regular expression."
2390 regexp)
2402 ;; Fails to handle ^ yet ????
2416 regexp
2424 ;;"Advertise in variable `dired-buffers' that we dired `default-directory'."
2425 ;; With wildcards we actually advertise too much.
2428 t ; we have already advertised ourselves
2431 dired-buffers)))))
2434 ;; Remove DIR from the buffer alist in variable dired-buffers.
2435 ;; This has the effect of removing any buffer whose main directory is DIR.
2436 ;; It does not affect buffers in which DIR is a subdir.
2437 ;; Removing is also done as a side-effect in dired-buffer-for-dir.
2440 \f
2441 ;; Tree Dired
2443 ;;; utility functions
2446 ;;"Is FILE part of the directory tree starting at DIR?"
2451 ;; Prepend default-directory to DIR if relative file name.
2452 ;; dired-get-filename must be able to make a valid file name from a
2453 ;; file and its directory DIR.
2456 dir
2460 ;;"Return the subdir name on this line, or nil if not on a headerline."
2461 ;; Look up in the alist whether this is a headerline.
2467 dired-subdir-alist))))
2468 cur-dir))))
2470 ;(defun dired-get-subdir-min (elt)
2471 ; (cdr elt))
2472 ;; can't use macro, must be redefinable for other alist format in dired-nstd.
2486 ;; Return an index into alist for use with nth
2487 ;; for the sake of subdir moving commands.
2496 "Go to next subdirectory, regardless of level."
2497 ;; Use 0 arg to go to this directory's header line.
2498 ;; NO-SKIP prevents moving to end of header line, returning whatever
2499 ;; position was found in dired-subdir-alist.
2502 pos index)
2503 ;; nth with negative arg does not return nil but the first element
2513 nil ; return nil if not found
2517 "Build `dired-subdir-alist' by parsing the buffer.
2518 Returns the new value of the alist.
2519 If optional arg SWITCHES is non-nil, use its value
2520 instead of `dired-actual-switches'."
2528 new-dir-name
2530 ;; Used to expand subdirectory names correctly in recursive
2531 ;; ange-ftp listings.
2538 ;; Avoid taking a file name ending in a colon
2539 ;; as a subdir name.
2549 new-dir-name
2560 ;; Undo any escaping of newlines and \ by dired-insert-directory.
2561 ;; Convert "n" preceded by odd number of \ to newline, and \\ to \.
2569 temp nil)
2573 temp nil))
2576 temp nil))))
2577 new-dir-name)
2580 ;; Place a sub directory boundary between lines.
2587 ;; We don't need to sort it because it is in buffer order per
2588 ;; constructionem. Return new alist:
2589 dired-subdir-alist))
2592 ;; Add new DIR at NEW-MARKER. Don't sort.
2595 dired-subdir-alist)))
2598 ;; Position point on first nontrivial file after point.
2614 "Go to line describing file FILE in this dired buffer."
2615 ;; Return value of point on success, else nil.
2616 ;; FILE must be an absolute file name.
2617 ;; Loses if FILE contains control chars like "\007" for which ls
2618 ;; either inserts "?" or "\\007" into the buffer, so we won't find
2619 ;; it in the buffer.
2632 ;; First, look for a listing under the absolute name.
2636 ;; Otherwise, look for it as a relative name. The
2637 ;; hair is to get the result of `dired-goto-subdir'
2638 ;; without calling it if we don't have any subdirs.
2645 file
2647 ;; Return buffer position, if found.
2652 "Advance to the Dired listing labeled by FILE; return its position.
2653 Return nil if the listing is not found. If FILE contains
2654 characters that would not appear in a Dired buffer, search using
2655 the quoted forms of those characters.
2657 FULL-NAME specifies the actual file name the listing must have,
2658 as returned by `dired-get-filename'. LIMIT is the search limit."
2664 ;; FIXME: to fix this for embedded control characters etc, we
2665 ;; should escape everything that `ls -b' does.
2670 ;; filenames are preceded by SPC, this makes the search faster
2671 ;; (e.g. for the filename "-").
2675 ;; Check that we are in the right place. Match could have
2676 ;; BASE just as initial substring or in permission bits etc.
2680 found)))
2684 ;; FIXME document whatever dired-x is doing.
2686 "Where point should go in a new listing of DIRNAME.
2687 Point assumed at beginning of new subdir line."
2692 \f
2693 ;; These are hooks which make tree dired work.
2694 ;; They are in this file because other parts of dired need to call them.
2695 ;; But they don't call the rest of tree dired unless there are subdirs loaded.
2697 ;; This function is called for each retrieved filename.
2698 ;; It could stand to be faster, though it's mostly function call
2699 ;; overhead. Avoiding the function call seems to save about 10% in
2700 ;; dired-get-filename. Make it a defsubst?
2702 "Return the name of the subdirectory to which this line belongs.
2703 This returns a string with trailing slash, like `default-directory'.
2704 Optional argument means return a file name relative to `default-directory'."
2707 ;; probably because called in a non-dired buffer
2709 elt dir)
2713 ;; use `<=' (not `<') as subdir line is part of subdir
2715 nil ; found
2719 dir)))
2721 ;; Subdirs start at the beginning of their header lines and end just
2722 ;; before the beginning of the next header line (or end of buffer).
2729 \f
2730 ;; Deleting files
2733 "Decide whether recursive deletes are allowed.
2734 A value of nil means no recursive deletes.
2735 `always' means delete recursively without asking. This is DANGEROUS!
2736 `top' means ask for each directory at top level, but delete its subdirectories
2737 without asking.
2738 Anything else means ask for each directory."
2746 ;; Match anything but `.' and `..'.
2749 ;; Delete file, possibly delete a directory and all its files.
2750 ;; This function is useful outside of dired. One could change its name
2751 ;; to e.g. recursive-delete-file and put it somewhere else.
2753 Delete FILE or directory (possibly recursively if optional RECURSIVE is true.)
2754 RECURSIVE determines what to do with a non-empty directory. If RECURSIVE is:
2755 nil, do not delete.
2756 `always', delete recursively without asking.
2757 `top', ask for each directory at top level.
2758 Anything else, ask for each sub-directory."
2759 ;; This test is equivalent to
2760 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
2761 ;; but more efficient
2769 delete-by-moving-to-trash)
2770 "trash"
2778 "In Dired, delete the files flagged for deletion.
2779 If NOMESSAGE is non-nil, we don't display any message
2780 if there are no flagged files.
2781 `dired-recursive-deletes' controls whether deletion of
2782 non-empty directories is allowed."
2786 case-fold-search)
2790 ;; this can't move point since ARG is nil
2792 nil)
2793 nil t)
2798 "Delete all marked (or next ARG) files.
2799 `dired-recursive-deletes' controls whether deletion of
2800 non-empty directories is allowed."
2801 ;; This is more consistent with the file marking feature than
2802 ;; dired-do-flagged-delete.
2805 ;; this may move point if ARG is an integer
2807 arg)
2808 arg t))
2813 ;; L is an alist of files to delete, with their buffer positions.
2814 ;; ARG is the prefix arg.
2815 ;; Filenames are absolute.
2816 ;; (car L) *must* be the *last* (bottommost) file in the dired buffer.
2817 ;; That way as changes are made in the buffer they do not shift the
2818 ;; lines still to be changed, so the (point) values in L stay valid.
2819 ;; Also, for subdirs in natural order, a subdir's files are deleted
2820 ;; before the subdir itself - the other way around would not work.
2828 succ count)))
2829 ;; canonicalize file list for pop up
2844 ;; if we get here, removing worked
2860 failures))))
2865 ;; In all buffers dired'ing DIRECTORY, run FUN with ARGS.
2866 ;; If the buffer has a wildcard pattern, check that it matches FILE.
2867 ;; (FILE does not include a directory component.)
2868 ;; FILE may be nil, in which case ignore it.
2869 ;; Return list of buffers where FUN succeeded (i.e., returned non-nil).
2872 file))
2876 success-list))
2878 ;; Delete the entry for FILE from
2890 "Clean up after a deleted file or directory FN.
2891 Removes any expanded subdirectory of deleted directory.
2892 If `dired-x' is loaded and `dired-clean-up-buffers-too' is non-nil,
2893 also offers to kill buffers visiting deleted files and directories."
2897 ;; Offer to kill buffer of deleted file FN.
2913 \f
2914 ;; Confirmation
2923 "Return a string suitable for use in a Dired prompt.
2924 ARG is normally the prefix argument for the calling command.
2925 FILES should be a list of file names.
2929 ;; distinguish-one-marked can cause the first element to be just t.
2934 ;; more than 1 file:
2936 ;; abs(arg) = count
2937 ;; Perhaps this is nicer, but it also takes more screen space:
2938 ;;(format "[%s %d files]" (if (> arg 0) "next" "previous")
2939 ;; count)
2944 "Pop up buffer BUF in a way suitable for Dired."
2949 ;; Try to split the selected window vertically if
2950 ;; that's possible. (Bug#1806)
2952 ;; Otherwise, try to split WINDOW sensibly.
2954 pop-up-frames)
2956 ;; If dired-shrink-to-fit is t, make its window fit its contents.
2958 ;; Try to not delete window when we want to display less than
2959 ;; `window-min-height' lines.
2963 "A list of symbols for commands Dired should not confirm, or t.
2964 Command symbols are `byte-compile', `chgrp', `chmod', `chown', `compress',
2965 `copy', `delete', `hardlink', `load', `move', `print', `shell', `symlink',
2966 `touch' and `uncompress'.
2967 If t, confirmation is never needed."
2978 "Return FUNCTION's result on ARGS after showing which files are marked.
2979 Displays the file names in a buffer named BUFNAME;
2981 This uses function `dired-pop-to-buffer' to do that.
2983 FUNCTION should not manipulate files, just read input
2984 (an argument or confirmation).
2985 The window is not shown if there is just one file or
2986 OP-SYMBOL is a member of the list in `dired-no-confirm'.
2987 FILES is the list of marked files. It can also be (t FILENAME)
2988 in the case of one marked file, to distinguish that from using
2989 just the current file."
2993 ;; If FILES defaulted to the current line's file.
2998 ;; Handle (t FILE) just like (FILE), here.
2999 ;; That value is used (only in some cases), to mean
3000 ;; just one file that was marked, rather than the current line file.
3012 \f
3013 ;; Commands to mark or flag file(s) at or near current line.
3016 ;; This version skips non-file lines.
3027 ;; Advance to the next line--actually, to the line that *was* next.
3028 ;; (If FUNCTION inserted some new lines in between, skip them.)
3040 ;; This used to be a regexp match of the `total ...' line output by
3041 ;; ls, which is slightly faster, but that is not very robust; notably,
3042 ;; it fails for non-english locales.
3046 "Move to the next marked file, wrapping around the end of the buffer."
3063 "Move to the previous marked file, wrapping around the end of the buffer."
3068 ;; Return FILE's marker, or nil if unmarked.
3082 ;; Skip subdir line and following garbage like the `total' line:
3093 "Mark the current (or next ARG) files.
3094 If on a subdir headerline, mark all its files except `.' and `..'.
3098 this subdir."
3108 "Unmark the current (or next ARG) files.
3109 If looking at a subdir, unmark all its files except `.' and `..'."
3115 "In Dired, flag the current line's file for deletion.
3116 With prefix arg, repeat over several lines.
3118 If on a subdir headerline, mark all its files except `.' and `..'."
3124 "In Dired, move up lines and remove marks or deletion flags there.
3125 Optional prefix ARG says how many lines to unmark/unflag; default
3126 is one line."
3131 "Toggle marks: marked files become unmarked, and vice versa.
3132 Files marked with other flags (such as `D') are not affected.
3133 `.' and `..' are never toggled.
3134 As always, hidden subdirs are not affected."
3142 ;; use subst instead of insdel because it does not move
3143 ;; the gap and thus should be faster and because
3144 ;; other characters are left alone automatically
3151 \f
3152 ;;; Commands to mark or flag files based on their characteristics or names.
3161 "Mark all files matching REGEXP for use in later commands.
3162 A prefix argument means to unmark them instead.
3163 `.' and `..' are never marked.
3166 object files--just `.o' will mark more than you might think."
3180 "Mark all files with contents containing REGEXP for use in later commands.
3181 A prefix argument means to unmark them instead.
3182 `.' and `..' are never marked."
3196 ;; For now we do it inside emacs
3197 ;; Grep might be better if there are a lot of files
3207 )))
3211 "In Dired, flag all files containing the specified REGEXP for deletion.
3212 The match is against the non-directory part of the filename. Use `^'
3213 and `$' to anchor matches. Exclude subdirs by hiding them.
3214 `.' and `..' are never flagged."
3219 "Mark all symbolic links.
3220 With prefix argument, unmark or unflag all those files."
3226 "Mark all directory file lines except `.' and `..'.
3227 With prefix argument, unmark or unflag all those files."
3235 "Mark all executable files.
3236 With prefix argument, unmark or unflag all those files."
3241 ;; dired-x.el has a dired-mark-sexp interactive command: mark
3242 ;; files for which PREDICATE returns non-nil.
3245 "Flag for deletion files whose names suggest they are auto save files.
3246 A prefix argument says to unmark or unflag those files instead."
3250 ;; It is less than general to check for # here,
3251 ;; but it's the only way this runs fast enough.
3255 ;; Handle executables in case of -F option.
3256 ;; We need not worry about the other kinds
3257 ;; of markings that -F makes, since they won't
3258 ;; appear on real auto-save files.
3270 ;; `log' here is dubious, since it's typically used for useful log
3271 ;; files, not just TeX stuff. -- fx
3280 "Flag for deletion all files that match `dired-garbage-files-regexp'."
3285 "Flag all backup files (names ending with `~') for deletion.
3286 With prefix argument, unmark or unflag these files."
3290 ;; Don't call backup-file-name-p unless the last character looks like
3291 ;; it might be the end of a backup file name. This isn't very general,
3292 ;; but it's the only way this runs fast enough.
3294 ;; Handle executables in case of -F option.
3295 ;; We need not worry about the other kinds
3296 ;; of markings that -F makes, since they won't
3297 ;; appear on real backup files.
3307 "Change all OLD marks to NEW marks.
3308 OLD and NEW are both characters used to mark files."
3325 t)
3330 "Remove all marks from all files in the dired buffer."
3335 "Remove a specific mark (or any mark) from every file.
3336 After this command, type the mark character to remove,
3337 or type RET to remove all marks.
3338 With prefix arg, query for each marked file.
3346 Type SPC or `y' to unmark one file, DEL or `n' to skip to next,
3356 file))))
3362 count))))
3363 \f
3364 ;; Logging failures operating on files, and showing the results.
3369 "Pop up a buffer with error log output from Dired.
3370 A group of errors from a single command ends with a formfeed.
3386 ;; Log a message or the contents of a buffer.
3387 ;; If LOG is a string and there are more args, it is formatted with
3388 ;; those ARGS. Usually the LOG string ends with a \n.
3389 ;; End each bunch of errors with (dired-log t):
3390 ;; this inserts the current time and buffer at the start of the page,
3391 ;; and \f (formfeed) at the end.
3399 log)))
3412 "State a summary of a command's failures, in echo area and log buffer.
3413 STRING is an overall summary of the failures.
3414 FAILURES is a list of file names that we failed to operate on,
3415 or nil if file names are not applicable."
3425 string failures))
3426 ;; Log a summary describing a bunch of errors.
3429 \f
3430 ;;; Sorting
3432 ;; Most ls can only sort by name or by date (with -t), nothing else.
3433 ;; GNU ls sorts on size with -S, on extension with -X, and unsorted with -U.
3434 ;; So anything that does not contain these is sort "by name".
3439 This indicates to Dired which option switches to watch out for because they
3440 will change the sorting order behavior of `ls'.
3442 To change the default sorting order \(e.g. add a `-v' option\), see the
3443 variable `dired-listing-switches'. To temporarily override the listing
3448 ;; `dired-ls-sorting-switches' after -t overrides -t.
3460 "Non-nil means the Dired sort command is disabled.
3464 ;; Set modeline display according to dired-actual-switches.
3465 ;; Modeline display of "by name" or "by date" guarantees the user a
3466 ;; match with the corresponding regexps. Non-matching switches are
3467 ;; shown literally.
3472 dired-sort-by-name-regexp dired-actual-switches)
3475 dired-sort-by-date-regexp dired-actual-switches)
3482 "Toggle sorting by date, and refresh the Dired buffer.
3483 With a prefix argument, edit the current listing switches instead."
3493 ;; Toggle between sort by date/name. Reverts the buffer.
3495 dired-actual-switches))
3496 ;; Regexp for finding (possibly embedded) -t switches.
3498 case-fold-search)
3499 ;; Remove the -t switch.
3503 ;; Remove a stand-alone -t switch.
3506 ;; Remove a switch of the form -XtY for some X and Y.
3509 ;; Now, if we weren't sorting by date before, add the -t switch.
3515 ;; Some user code loads dired especially for this.
3516 ;; Don't do that--use replace-regexp-in-string instead.
3518 ;; Replace REGEXP with NEWTEXT everywhere in STRING and return result.
3519 ;; NEWTEXT is taken literally---no \\DIGIT escapes will be recognized.
3525 start me))
3529 "Specify new `ls' SWITCHES for current dired buffer.
3530 Values matching `dired-sort-by-date-regexp' or `dired-sort-by-name-regexp'
3531 set the minor mode accordingly, others appear literally in the mode line.
3532 With optional second arg NO-REVERT, don't refresh the listing afterwards."
3543 "Additional processing of -R in ls option string SWITCHES.
3544 Saves `dired-subdir-alist' when R is set and restores saved value
3545 minus any directories explicitly deleted when R is cleared.
3546 To be called first in body of `dired-sort-other', etc."
3550 ;; Adding -R to ls switches -- save `dired-subdir-alist':
3554 ;; Deleting -R from ls switches -- revert to pre-R subdirs
3555 ;; that are still present:
3561 dired-subdir-alist)
3562 ;; subdir still present...
3565 subdirs)))
3569 ;; No pre-R subdir alist, so revert to main directory
3570 ;; listing:
3572 \f
3574 ;;;; Drag and drop support
3577 "Decide whether recursive copies are allowed.
3578 A value of nil means no recursive copies.
3579 `always' means copy recursively without asking.
3580 `top' means ask for each directory at top level.
3581 Anything else means ask for each directory."
3596 ;; No need to get actions and descriptions from the source,
3597 ;; we only have three actions anyway.
3599 t
3605 "--"
3609 nil)))
3614 ;; Only used when (featurep 'dnd).
3621 "Copy, move or link a file to the dired directory.
3622 URI is the file to handle, ACTION is one of copy, move, link or ask.
3623 Ask means pop up a menu for the user to select one of copy, move or link."
3632 ;; If copying a directory and dired-recursive-copies is
3633 ;; nil, dired-copy-file fails. Pop up a notice.
3642 ;; Binding dired-overwrite-confirmed to nil makes
3643 ;; dired-handle-overwrite a no-op. We instead use
3644 ;; y-or-n-p, which pops a graphical menu.
3645 dired-overwrite-confirmed backup-file)
3647 ;; d-b-o is defined in dired-aux.
3649 dired-backup-overwrite
3665 action))))))
3668 "Copy, move or link a file to the dired directory if it is a local file.
3669 URI is the file to handle. If the hostname in the URI isn't local, do nothing.
3670 ACTION is one of copy, move, link or ask.
3671 Ask means pop up a menu for the user to select one of copy, move or link."
3674 nil)))
3675 \f
3677 ;;;; Desktop support
3682 "Auxiliary information to be saved in desktop file."
3684 ;; Value of `dired-directory'.
3686 ;; Directory name followed by list of files.
3689 ;; Directory name, optionally with shell wildcard.
3691 ;; Subdirectories in `dired-subdir-alist'.
3696 dired-subdir-alist)))))
3699 _buffer-name
3700 misc-data)
3701 "Restore a dired buffer specified in a desktop file."
3702 ;; First element of `misc-data' is the value of `dired-directory'.
3703 ;; This value is a directory name, optionally with shell wildcard or
3704 ;; a directory name followed by list of files.
3710 ;; The following elements of `misc-data' are the keys
3711 ;; from `dired-subdir-alist'.
3716 nil)))
3721 \f
3722 ;;; Start of automatically extracted autoloads.
3723 \f
3724 ;;;### (autoloads (dired-show-file-type dired-do-query-replace-regexp
3725 ;;;;;; dired-do-search dired-do-isearch-regexp dired-do-isearch
3726 ;;;;;; dired-isearch-filenames-regexp dired-isearch-filenames dired-isearch-filenames-setup
3727 ;;;;;; dired-hide-all dired-hide-subdir dired-tree-down dired-tree-up
3728 ;;;;;; dired-kill-subdir dired-mark-subdir-files dired-goto-subdir
3729 ;;;;;; dired-prev-subdir dired-insert-subdir dired-maybe-insert-subdir
3730 ;;;;;; dired-downcase dired-upcase dired-do-symlink-regexp dired-do-hardlink-regexp
3731 ;;;;;; dired-do-copy-regexp dired-do-rename-regexp dired-do-rename
3732 ;;;;;; dired-do-hardlink dired-do-symlink dired-do-copy dired-create-directory
3733 ;;;;;; dired-rename-file dired-copy-file dired-relist-file dired-remove-file
3734 ;;;;;; dired-add-file dired-do-redisplay dired-do-load dired-do-byte-compile
3735 ;;;;;; dired-do-compress dired-query dired-compress-file dired-do-kill-lines
3736 ;;;;;; dired-run-shell-command dired-do-shell-command dired-do-async-shell-command
3737 ;;;;;; dired-clean-directory dired-do-print dired-do-touch dired-do-chown
3738 ;;;;;; dired-do-chgrp dired-do-chmod dired-compare-directories dired-backup-diff
3739 ;;;;;; dired-diff) "dired-aux" "dired-aux.el" "58d623eb8e68e472e6164a1bcae83360")
3740 ;;; Generated autoloads from dired-aux.el
3743 Compare file at point with file FILE using `diff'.
3744 FILE defaults to the file at the mark. (That's the mark set by
3746 The prompted-for FILE is the first file given to `diff'.
3747 With prefix arg, prompt for second argument SWITCHES,
3748 which is the string of command switches for `diff'.
3753 Diff this file with its backup file or vice versa.
3754 Uses the latest backup, if there are several numerical backups.
3755 If this file is a backup, diff it with its original.
3756 The backup file is the first file given to `diff'.
3757 With prefix arg, prompt for argument SWITCHES which is options for `diff'.
3762 Mark files with different file attributes in two dired buffers.
3763 Compare file attributes of files in the current directory
3764 with file attributes in directory DIR2 using PREDICATE on pairs of files
3765 with the same name. Mark files for which PREDICATE returns non-nil.
3766 Mark files with different names if PREDICATE is nil (or interactively
3767 with empty input at the predicate prompt).
3769 PREDICATE is a Lisp expression that can refer to the following variables:
3771 size1, size2 - file size in bytes
3772 mtime1, mtime2 - last modification time in seconds, as a float
3773 fa1, fa2 - list of file attributes
3774 returned by function `file-attributes'
3776 where 1 refers to attribute of file in the current dired buffer
3777 and 2 to attribute of file in second dired buffer.
3779 Examples of PREDICATE:
3781 (> mtime1 mtime2) - mark newer files
3782 (not (= size1 size2)) - mark files with different sizes
3783 (not (string= (nth 8 fa1) (nth 8 fa2))) - mark files with different modes
3784 (not (and (= (nth 2 fa1) (nth 2 fa2)) - mark files with different UID
3785 (= (nth 3 fa1) (nth 3 fa2)))) and GID.
3790 Change the mode of the marked (or next ARG) files.
3791 Symbolic modes like `g+w' are allowed.
3796 Change the group of the marked (or next ARG) files.
3801 Change the owner of the marked (or next ARG) files.
3806 Change the timestamp of the marked (or next ARG) files.
3807 This calls touch.
3812 Print the marked (or next ARG) files.
3813 Uses the shell command coming from variables `lpr-command' and
3814 `lpr-switches' as default.
3819 Flag numerical backups for deletion.
3820 Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
3821 Positive prefix arg KEEP overrides `dired-kept-versions';
3822 Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
3825 with a prefix argument.
3830 Run a shell command COMMAND on the marked files asynchronously.
3832 Like `dired-do-shell-command' but if COMMAND doesn't end in ampersand,
3833 adds `* &' surrounded by whitespace and executes the command asynchronously.
3834 The output appears in the buffer `*Async Shell Command*'.
3839 Run a shell command COMMAND on the marked files.
3840 If no files are marked or a specific numeric prefix arg is given,
3842 The prompt mentions the file(s) or the marker, as appropriate.
3844 If there is a `*' in COMMAND, surrounded by whitespace, this runs
3845 COMMAND just once with the entire file list substituted there.
3847 If there is no `*', but there is a `?' in COMMAND, surrounded by
3848 whitespace, this runs COMMAND on each file individually with the
3849 file name substituted for `?'.
3851 Otherwise, this runs COMMAND on each file individually with the
3852 file name added at the end of COMMAND (separated by a space).
3854 `*' and `?' when not surrounded by whitespace have no special
3855 significance for `dired-do-shell-command', and are passed through
3856 normally to the shell, but you must confirm first.
3858 If you want to use `*' as a shell wildcard with whitespace around
3860 `*' in the shell, but avoids Dired's special handling.
3862 If COMMAND produces output, it goes to a separate buffer.
3864 This feature does not try to redisplay Dired buffers afterward, as
3865 there's no telling what files COMMAND may have changed.
3868 When COMMAND runs, its working directory is the top-level directory
3869 of the Dired buffer, so output files usually are created there
3870 instead of in a subdir.
3872 In a noninteractive call (from Lisp code), you must specify
3873 the list of file names explicitly with the FILE-LIST argument, which
3874 can be produced by `dired-get-marked-files', for example.
3884 Kill all marked lines (not the files).
3885 With a prefix argument, kill that many lines starting with the current line.
3886 \(A negative argument kills backward.)
3887 If you use this command with a prefix argument to kill the line
3888 for a file that is a directory, which you have inserted in the
3889 Dired buffer as a subdirectory, then it deletes that subdirectory
3890 from the buffer as well.
3891 To kill an entire subdirectory (without killing its line in the
3892 parent directory), go to its directory header line and use this
3893 command with a prefix argument (the value does not matter).
3903 Format PROMPT with ARGS, query user, and store the result in SYM.
3904 The return value is either nil or t.
3906 The user may type y or SPC to accept once; n or DEL to skip once;
3907 ! to accept this and subsequent queries; or q or ESC to decline
3908 this and subsequent queries.
3910 If SYM is already bound to a non-nil value, this function may
3911 return automatically without querying the user. If SYM is !,
3912 return t; if SYM is q or ESC, return nil.
3917 Compress or uncompress marked (or next ARG) files.
3922 Byte compile marked (or next ARG) Emacs Lisp files.
3927 Load the marked (or next ARG) Emacs Lisp files.
3932 Redisplay all marked (or next ARG) files.
3933 If on a subdir line, redisplay that subdirectory. In that case,
3934 a prefix arg lets you edit the `ls' switches used for the new listing.
3936 Dired remembers switches specified with a prefix arg, so that reverting
3937 the buffer will not reset them. However, using `dired-undo' to re-insert
3938 or delete subdirectories can bypass this machinery. Hence, you sometimes
3939 may have to reset some subdirectory switches after a `dired-undo'.
3940 You can reset all subdirectory switches to the default using
3942 See Info node `(emacs)Subdir switches' for more details.
3957 Create or update the line for FILE in all Dired buffers it would belong in.
3972 Create a directory called DIRECTORY.
3973 If DIRECTORY already exists, signal an error.
3978 Copy all marked (or next ARG) files, or copy the current file.
3979 This normally preserves the last-modified date when copying.
3980 When operating on just the current file, you specify the new name.
3981 When operating on multiple or marked files, you specify a directory,
3982 and new copies of these files are made in that directory
3983 with the same names that the files currently have. The default
3984 suggested for the target directory depends on the value of
3985 `dired-dwim-target', which see.
3987 This command copies symbolic links by creating new ones,
3988 like `cp -d'.
3993 Make symbolic links to current file or all marked (or next ARG) files.
3994 When operating on just the current file, you specify the new name.
3995 When operating on multiple or marked files, you specify a directory
3996 and new symbolic links are made in that directory
3997 with the same names that the files currently have. The default
3998 suggested for the target directory depends on the value of
3999 `dired-dwim-target', which see.
4006 Add names (hard links) current file or all marked (or next ARG) files.
4007 When operating on just the current file, you specify the new name.
4008 When operating on multiple or marked files, you specify a directory
4009 and new hard links are made in that directory
4010 with the same names that the files currently have. The default
4011 suggested for the target directory depends on the value of
4012 `dired-dwim-target', which see.
4017 Rename current file or all marked (or next ARG) files.
4018 When renaming just the current file, you specify the new name.
4019 When renaming multiple or marked files, you specify a directory.
4020 This command also renames any buffers that are visiting the files.
4021 The default suggested for the target directory depends on the value
4022 of `dired-dwim-target', which see.
4027 Rename selected files whose names match REGEXP to NEWNAME.
4029 With non-zero prefix argument ARG, the command operates on the next ARG
4030 files. Otherwise, it operates on all the marked files, or the current
4031 file if none are marked.
4033 As each match is found, the user must type a character saying
4036 REGEXP defaults to the last regexp used.
4038 With a zero prefix arg, renaming by regexp affects the absolute file name.
4039 Normally, only the non-directory part of the file name is used and changed.
4044 Copy selected files whose names match REGEXP to NEWNAME.
4045 See function `dired-do-rename-regexp' for more info.
4050 Hardlink selected files whose names match REGEXP to NEWNAME.
4051 See function `dired-do-rename-regexp' for more info.
4056 Symlink selected files whose names match REGEXP to NEWNAME.
4057 See function `dired-do-rename-regexp' for more info.
4062 Rename all marked (or next ARG) files to upper case.
4067 Rename all marked (or next ARG) files to lower case.
4072 Insert this subdirectory into the same dired buffer.
4074 else inserts it at its natural place (as `ls -lR' would have done).
4075 With a prefix arg, you may edit the ls switches used for this listing.
4076 You can add `R' to the switches to expand the whole tree starting at
4077 this subdirectory.
4078 This function takes some pains to conform to `ls -lR' output.
4080 Dired remembers switches specified with a prefix arg, so that reverting
4081 the buffer will not reset them. However, using `dired-undo' to re-insert
4082 or delete subdirectories can bypass this machinery. Hence, you sometimes
4083 may have to reset some subdirectory switches after a `dired-undo'.
4084 You can reset all subdirectory switches to the default using
4086 See Info node `(emacs)Subdir switches' for more details.
4091 Insert this subdirectory into the same dired buffer.
4092 If it is already present, overwrites previous entry,
4093 else inserts it at its natural place (as `ls -lR' would have done).
4094 With a prefix arg, you may edit the `ls' switches used for this listing.
4095 You can add `R' to the switches to expand the whole tree starting at
4096 this subdirectory.
4097 This function takes some pains to conform to `ls -lR' output.
4102 Go to previous subdirectory, regardless of level.
4103 When called interactively and not on a subdir line, go to this subdir's line.
4108 Go to end of header line of DIR in this dired buffer.
4109 Return value of point on success, otherwise return nil.
4115 Mark all files except `.' and `..' in current subdirectory.
4116 If the Dired buffer shows multiple directories, this command
4117 marks the files listed in the subdirectory that point is in.
4122 Remove all lines of current subdirectory.
4123 Lower levels are unaffected.
4128 Go up ARG levels in the dired tree.
4133 Go down in the dired tree.
4138 Hide or unhide the current subdirectory and move to next directory.
4139 Optional prefix arg is a repeat factor.
4145 Hide all subdirectories, leaving only their header lines.
4146 If there is already something hidden, make everything visible again.
4152 Set up isearch to search in Dired file names.
4153 Intended to be added to `isearch-mode-hook'.
4158 Search for a string using Isearch only in file names in the Dired buffer.
4163 Search for a regexp using Isearch only in file names in the Dired buffer.
4168 Search for a string through all marked files using Isearch.
4173 Search for a regexp through all marked files using Isearch.
4178 Search through all marked files for a match for REGEXP.
4179 Stops when a match is found.
4185 Do `query-replace-regexp' of FROM with TO, on all marked files.
4186 Third arg DELIMITED (prefix arg) means replace only word-delimited matches.
4193 Print the type of FILE, according to the `file' command.
4194 If you give a prefix to this command, and FILE is a symbolic
4195 link, then the type of the file linked to by FILE is printed
4196 instead.
4200 ;;;***
4201 \f
4202 ;;;### (autoloads (dired-do-relsymlink dired-jump-other-window dired-jump)
4203 ;;;;;; "dired-x" "dired-x.el" "2a39a8306a5541c304bc4ab602876f92")
4204 ;;; Generated autoloads from dired-x.el
4207 Jump to dired buffer corresponding to current buffer.
4208 If in a file, dired the current directory and move to file's line.
4209 If in Dired already, pop up a level and goto old directory's line.
4210 In case the proper dired file line cannot be found, refresh the dired
4211 buffer and try again.
4212 When OTHER-WINDOW is non-nil, jump to dired buffer in other window.
4213 Interactively with prefix argument, read FILE-NAME and
4214 move to its line in dired.
4224 Relative symlink all marked (or next ARG) files into a directory.
4225 Otherwise make a relative symbolic link to the current file.
4226 This creates relative symbolic links like
4228 foo -> ../bar/foo
4230 not absolute ones like
4232 foo -> /ugly/file/name/that/may/change/any/day/bar/foo
4238 ;;;***
4239 \f
4240 ;;; End of automatically extracted autoloads.
4246 ;;; dired.el ends here