| blob | af99d4c741325211e7e3d1c56243727aa0a556c3 |
1 ;;; dired.el --- directory-browsing commands -*- lexical-binding: t -*-
3 ;; Copyright (C) 1985-1986, 1992-1997, 2000-2011
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."
91 "Name of chmod command (usually `chmod')."
96 "Name of touch command (usually `touch')."
101 "Informs Dired about how `ls -lF' marks symbolic links.
102 Set this to t if `ls' (or whatever program is specified by
103 `insert-directory-program') with `-lF' marks the symbolic link
104 itself with a trailing @ (usually the case under Ultrix).
106 Example: if `ln -s foo bar; ls -F bar' gives `bar -> foo', set it to
107 nil (the default), if it gives `bar@ -> foo', set it to t.
109 Dired checks if there is really a @ appended. Thus, if you have a
110 marking `ls' program on one host and a non-marking on another host, and
111 don't care about symbolic links which really end in a @, you can
112 always set this variable to t."
117 "Regexp of files to skip when finding first file of a directory.
118 A value of nil means move to the subdir line.
119 A value of t means move to first file."
122 regexp)
126 ;; Use t as default so that moved files "take their markers with them".
127 "Controls marking of renamed files.
128 If t, files keep their previous marks when they are renamed.
129 If a character, renamed files (whether previously marked or not)
130 are afterward marked with that character."
136 "Controls marking of copied files.
137 If t, copied files are marked if and as the corresponding original files were.
138 If a character, copied files are unconditionally marked with that character."
144 "Controls marking of newly made hard links.
145 If t, they are marked if and as the files linked to were marked.
146 If a character, new links are unconditionally marked with that character."
152 "Controls marking of newly made symbolic links.
153 If t, they are marked if and as the files linked to were marked.
154 If a character, new links are unconditionally marked with that character."
160 "If non-nil, Dired tries to guess a default target directory.
161 This means: if there is a dired buffer displayed in the next window,
162 use its current subdir, instead of the current subdir of this dired buffer.
164 The target is used in the prompt for file copy, rename etc."
169 "If non-nil, Dired preserves the last-modified time in a file copy.
170 \(This works on only some systems.)"
174 ; These variables were deleted and the replacements are on files.el.
175 ; We leave aliases behind for back-compatibility.
179 ;;; Hook variables
182 "Run after loading Dired.
183 You can customize key bindings or load extensions with this."
188 "Run at the very end of `dired-mode'."
193 "This hook is run before a dired buffer is read in (created or reverted)."
198 "Hook run after each time a file or directory is read by Dired.
199 After each listing of a file or directory, this hook is run
200 with the buffer narrowed to the listing."
203 ;; Note this can't simply be run inside function `dired-ls' as the hook
204 ;; functions probably depend on the dired-subdir-alist to be OK.
210 "The functions to call when a drop in `dired-mode' is made.
211 See `dnd-protocol-alist' for more information. When nil, behave
212 as in other buffers. Changing this option is effective only for
213 new dired buffers."
219 ;; Internal variables
222 ;; so that you can write things like
223 ;; (let ((dired-marker-char ?X))
224 ;; ;; great code using X markers ...
225 ;; )
226 ;; For example, commands operating on two sets of files, A and B.
227 ;; Or marking files with digits 0-9. This could implicate
228 ;; concentric sets or an order for the marked files.
229 ;; The code depends on dynamic scoping on the marker char.
230 "In Dired, the current mark character.
237 ;; I see no reason ever to make this nil -- rms.
238 ;; (> baud-rate search-slow-speed)
245 ;;;###autoload
247 "The directory name or wildcard spec that this dired directory lists.
248 Local to each dired buffer. May be a list, in which case the car is the
249 directory name and the cdr is the list of files to mention.
258 ;; These regexps must be tested at beginning-of-line, but are also
259 ;; used to search for next matches, so neither omitting "^" nor
260 ;; replacing "^" by "\n" (to make it slightly faster) will work.
263 ;; "Regexp matching a marked line.
264 ;; Important: the match ends just after the marker."
266 ;; The [^:] part after "d" and "l" is to avoid confusion with the
267 ;; DOS/Windows-style drive letters in directory names, like in "d:/foo".
275 "-[-r][-w].[-r][-w][xs][-r][-w]."
281 ;; The subdirectory names in the next two lists are expanded.
283 "Association list of subdirectories and their buffer positions.
284 Each subdirectory has an element: (DIRNAME . STARTMARKER).
285 The order of elements is the reverse of the order in the buffer.
289 "Keeps track of which switches to use for inserted subdirectories.
297 "Regexp matching a maybe hidden subdirectory line in `ls -lR' output.
298 Subexpression 1 is the subdirectory proper, no trailing colon.
299 The match starts at the beginning of the line and ends after the end
304 "Faces used by Dired."
310 "Face used for directory headers."
318 "Face used for dired marks."
326 "Face used for marked files."
334 "Face used for flagged files."
341 ;; Inherit from font-lock-warning-face since with min-colors 8
342 ;; font-lock-comment-face is not colored any more.
344 "Face used to highlight a part of a buffer that needs user attention."
352 ;; Inherit from font-lock-comment-delimiter-face since with min-colors 8
353 ;; font-lock-comment-face is not colored any more.
355 "Face used to highlight permissions of group- and world-writable files."
363 "Face used for subdirectories."
371 "Face used for symbolic links."
379 "Face used for files suffixed with `completion-ignored-extensions'."
387 ;;
388 ;; Dired marks.
390 ;;
391 ;; We make heavy use of MATCH-ANCHORED, since the regexps don't identify the
392 ;; file name itself. We search for Dired defined regexps, and then use the
393 ;; Dired defined function `dired-move-to-filename' before searching for the
394 ;; simple regexp ".+". It is that regexp which matches the file name.
395 ;;
396 ;; Marked files.
399 ;;
400 ;; Flagged files.
403 ;; People who are paranoid about security would consider this more
404 ;; important than other things such as whether it is a directory.
405 ;; But we don't want to encourage paranoia, so our default
406 ;; should be what's most useful for non-paranoids. -- rms.
407 ;;; ;;
408 ;;; ;; Files that are group or world writable.
409 ;;; (list (concat dired-re-maybe-mark dired-re-inode-size
410 ;;; "\\([-d]\\(....w....\\|.......w.\\)\\)")
411 ;;; '(1 dired-warning-face)
412 ;;; '(".+" (dired-move-to-filename) nil (0 dired-warning-face)))
413 ;; However, we don't need to highlight the file name, only the
414 ;; permissions, to win generally. -- fx.
415 ;; Fixme: we could also put text properties on the permission
416 ;; fields with keymaps to frob the permissions, somewhat a la XEmacs.
423 ;;
424 ;; Subdirectories.
427 ;;
428 ;; Symbolic links.
431 ;;
432 ;; Files suffixed with `completion-ignored-extensions'.
434 ;; It is quicker to first find just an extension, then go back to the
435 ;; start of that file name. So we do this complex MATCH-ANCHORED form.
438 ;;
439 ;; Files suffixed with `completion-ignored-extensions'
440 ;; plus a character put in by -F.
446 ;; If the last character is not part of the filename,
447 ;; move back to the start of the filename
448 ;; so it can be fontified.
449 ;; Otherwise, leave point at the end of the line;
450 ;; that way, nothing is fontified.
454 ;;
455 ;; Explicitly put the default face on file names ending in a colon to
456 ;; avoid fontifying them as directory header.
459 ;;
460 ;; Directory headers.
462 )
466 \f
467 ;;; Macros must be defined before they are used, for the byte compiler.
470 "Mark all files for which PREDICATE evals to non-nil.
471 PREDICATE is evaluated on each line, with point at beginning of line.
472 MSG is a noun phrase for the type of files being marked.
473 It should end with a noun that can be pluralized by adding `s'.
474 Return value is the number of files marked, or nil if none were marked."
488 count
489 ,msg
497 distinguish-one-marked)
498 "Eval BODY with point on each marked line. Return a list of BODY's results.
499 If no marked file could be found, execute BODY on the current line.
500 ARG, if non-nil, specifies the files to use instead of the marked files.
501 If ARG is an integer, use the next ARG (or previous -ARG, if
502 ARG<0) files. In that case, point is dragged along. This is
503 so that commands on the next ARG (instead of the marked) files
504 can be chained easily.
505 For any other non-nil value of ARG, use the current file.
506 If optional third arg SHOW-PROGRESS evaluates to non-nil,
507 redisplay the dired buffer after each file is processed.
508 No guarantee is made about the position on the marked line.
509 BODY must ensure this itself if it depends on this.
510 Search starts at the beginning of the buffer, thus the car of the list
511 corresponds to the line nearest to the buffer's bottom. This
512 is also true for (positive and negative) integer values of ARG.
513 BODY should not be too long as it is expanded four times.
515 If DISTINGUISH-ONE-MARKED is non-nil, then if we find just one marked file,
516 return (t FILENAME) instead of (FILENAME)."
517 ;;
518 ;;Warning: BODY must not add new lines before point - this may cause an
519 ;;endless loop.
520 ;;This warning should not apply any longer, sk 2-Sep-1991 14:10.
527 ,arg
533 results))
534 ;; non-nil, non-integer ARG means use current file:
539 ;; remember position of next marked file before BODY
540 ;; can insert lines before the just found file,
541 ;; confusing us by finding the same marked file again
542 ;; and again and...
550 ;; move after last match
559 results
561 ;; save-excursion loses, again
565 "Return the marked files' names as list of strings.
566 The list is in the same order as the buffer, that is, the car is the
567 first marked file.
568 Values returned are normally absolute file names.
569 Optional arg LOCALP as in `dired-get-filename'.
570 Optional second argument ARG, if non-nil, specifies files near
571 point instead of marked files. It usually comes from the prefix
572 argument.
573 If ARG is an integer, use the next ARG files.
574 Any other non-nil value means to use the current file instead.
575 Optional third argument FILTER, if non-nil, is a function to select
576 some of the files--those for which (funcall FILTER FILENAME) is non-nil.
578 If DISTINGUISH-ONE-MARKED is non-nil, then if we find just one marked file,
579 return (t FILENAME) instead of (FILENAME).
580 Don't use that together with FILTER."
585 arg nil distinguish-one-marked)))
586 result)
589 all-of-them
594 result)))
595 \f
596 ;; The dired command
599 ;; For use in interactive.
603 dired-listing-switches))
604 ;; If a dialog is about to be used, call read-directory-name so
605 ;; the dialog code knows we want directories. Some dialogs can
606 ;; only select directories or files when popped up, not both.
609 nil default-directory nil)
611 nil default-directory nil)))))
613 ;; We want to switch to a more sophisticated version of
614 ;; dired-read-dir-and-switches like the following, if there is a way
615 ;; to make it more intuitive. See bug#1285.
617 ;; (defun dired-read-dir-and-switches (str)
618 ;; ;; For use in interactive.
619 ;; (reverse
620 ;; (list
621 ;; (if current-prefix-arg
622 ;; (read-string "Dired listing switches: "
623 ;; dired-listing-switches))
624 ;; ;; If a dialog is about to be used, call read-directory-name so
625 ;; ;; the dialog code knows we want directories. Some dialogs can
626 ;; ;; only select directories or files when popped up, not both.
627 ;; (if (next-read-file-uses-dialog-p)
628 ;; (read-directory-name (format "Dired %s(directory): " str)
629 ;; nil default-directory nil)
630 ;; (let ((cie ()))
631 ;; (dolist (ext completion-ignored-extensions)
632 ;; (if (eq ?/ (aref ext (1- (length ext)))) (push ext cie)))
633 ;; (setq cie (concat (regexp-opt cie "\\(?:") "\\'"))
634 ;; (lexical-let* ((default (and buffer-file-name
635 ;; (abbreviate-file-name buffer-file-name)))
636 ;; (cie cie)
637 ;; (completion-table
638 ;; ;; We need a mix of read-file-name and
639 ;; ;; read-directory-name so that completion to directories
640 ;; ;; is preferred, but if the user wants to enter a global
641 ;; ;; pattern, he can still use completion on filenames to
642 ;; ;; help him write the pattern.
643 ;; ;; Essentially, we want to use
644 ;; ;; (completion-table-with-predicate
645 ;; ;; 'read-file-name-internal 'file-directory-p nil)
646 ;; ;; but that doesn't work because read-file-name-internal
647 ;; ;; does not obey its `predicate' argument.
648 ;; (completion-table-in-turn
649 ;; (lambda (str pred action)
650 ;; (let ((read-file-name-predicate
651 ;; (lambda (f)
652 ;; (and (not (member f '("./" "../")))
653 ;; ;; Hack! Faster than file-directory-p!
654 ;; (eq (aref f (1- (length f))) ?/)
655 ;; (not (string-match cie f))))))
656 ;; (complete-with-action
657 ;; action 'read-file-name-internal str nil)))
658 ;; 'read-file-name-internal)))
659 ;; (minibuffer-with-setup-hook
660 ;; (lambda ()
661 ;; (setq minibuffer-default default)
662 ;; (setq minibuffer-completion-table completion-table))
663 ;; (read-file-name (format "Dired %s(directory): " str)
664 ;; nil default-directory nil))))))))
667 "Try to get a file name at point in the current dired buffer.
668 This hook is inteneded to be put in `file-name-at-point-functions'."
675 ;;;###autoload (define-key ctl-x-map "d" 'dired)
676 ;;;###autoload
679 Optional second argument SWITCHES specifies the `ls' options used.
680 \(Interactively, use a prefix argument to be able to specify SWITCHES.)
681 Dired displays a list of files in DIRNAME (which may also have
682 shell wildcards appended to select certain files). If DIRNAME is a cons,
683 its first element is taken as the directory name and the rest as an explicit
684 list of files to make directory entries for.
686 You can move around in it with the usual commands.
691 If DIRNAME is already in a dired buffer, that buffer is used without refresh."
692 ;; Cannot use (interactive "D") because of wildcards.
696 ;;;###autoload (define-key ctl-x-4-map "d" 'dired-other-window)
697 ;;;###autoload
703 ;;;###autoload (define-key ctl-x-5-map "d" 'dired-other-frame)
704 ;;;###autoload
710 ;;;###autoload
712 "Like `dired' but returns the dired buffer as value, does not select it."
714 ;; This loses the distinction between "/foo/*/" and "/foo/*" that
715 ;; some shells make:
726 ;; If the argument was syntactically a directory name not a file name,
727 ;; or if it happens to name a file that is a directory,
728 ;; convert it syntactically to a directory name.
729 ;; The reason for checking initially-was-dirname
730 ;; and not just file-directory-p
731 ;; is that file-directory-p is slow over ftp.
739 ;; The following is an internal dired function. It returns non-nil if
740 ;; the directory visited by the current dired buffer has changed on
741 ;; disk. DIRNAME should be the directory name of that directory.
750 "Return non-nil if current dired buffer needs updating.
751 If NOCONFIRM is non-nil, then this function always returns nil
752 for a remote directory. This feature is used by Auto Revert Mode."
758 ;; Do not auto-revert when the dired buffer can be currently
759 ;; written by the user as in `wdired-mode'.
760 buffer-read-only
764 "Automatically revert dired buffer on revisiting.
765 If t, revisiting an existing dired buffer automatically reverts it.
766 If its value is a function, call this function with the directory
767 name as single argument and revert the buffer if it returns non-nil.
768 Otherwise, a message offering to revert the changed dired buffer
769 is displayed.
770 Note that this is not the same as `auto-revert-mode' that
771 periodically reverts at specified time intervals."
781 ;; If there is an existing dired buffer for DIRNAME, just leave
782 ;; buffer as it is (don't even call dired-revert).
783 ;; This saves time especially for deep trees or with ange-ftp.
784 ;; The user can type `g' easily, and it is more consistent with find-file.
785 ;; But if SWITCHES are given they are probably different from the
786 ;; buffer's old value, so call dired-sort-other, which does
787 ;; revert the buffer.
788 ;; A pity we can't possibly do "Directory has changed - refresh? "
789 ;; like find-file does.
790 ;; Optional argument MODE is passed to dired-find-buffer-nocreate,
791 ;; see there.
794 ;; Look for an existing buffer.
796 ;; Note that buffer already is in dired-mode, if found.
803 ;; file list may have changed
805 ;; this calls dired-revert
807 ;; Always revert regardless of whether it has changed or not.
810 ;; Revert when predicate function returns non-nil.
815 ;; If directory has changed on disk, offer to revert.
820 ;; Else a new buffer
822 ;; We can do this unconditionally
823 ;; because dired-noselect ensures that the name
824 ;; is passed in directory name syntax
825 ;; if it was the name of a directory at all.
830 ;; default-directory and dired-actual-switches are set now
831 ;; (buffer-local), so we can call dired-readin:
836 ;; dired-readin can fail if parent directories are inaccessible.
837 ;; Don't leave an empty buffer around in that case.
842 buffer))
845 ;; Enlarged by dired-advertise
846 ;; Queried by function dired-buffers-for-dir. When this detects a
847 ;; killed buffer, it is removed from this list.
852 ;; FIXME add a doc-string, and document dired-x extensions.
854 ;; This differs from dired-buffers-for-dir in that it does not consider
855 ;; subdirs of default-directory and searches for the first match only.
856 ;; Also, the major mode must be MODE.
858 dired-find-subdir
859 ;; Don't try to find a wildcard as a subdirectory.
865 ;; Wildcards must match, too:
867 ;; We don't want to switch to the same buffer---
870 ;; ---unless it's the only possibility:
872 ;; No dired-x, or dired-find-subdir nil.
881 dired-directory ;; nil during find-alternate-file
886 dired-directory))))
888 blist nil)
890 found)))
892 \f
893 ;; Read in a new dired buffer
896 "Read in a new dired buffer.
897 Differs from `dired-insert-subdir' in that it accepts
898 wildcards, erases the buffer, and builds the subdir-alist anew
899 \(including making it buffer-local and clearing it first)."
901 ;; default-directory and dired-actual-switches must be buffer-local
902 ;; and initialized by now.
904 ;; This makes readin much much faster.
905 ;; In particular, it prevents the font lock hook from running
906 ;; until the directory is all read in.
913 ;; This hook which may want to modify dired-actual-switches
914 ;; based on dired-directory, e.g. with ange-ftp to a SysV host
915 ;; where ls won't understand -Al switches.
923 ;; Don't make undo entries for readin.
929 ;; Must first make alist buffer local and set it to nil because
930 ;; dired-build-subdir-alist will call dired-clear-alist first
937 ;; No need to narrow since the whole buffer contains just
938 ;; dired-readin's output, nothing else. The hook can
939 ;; successfully use dired functions (e.g. dired-get-filename)
940 ;; as the subdir-alist has been built in dired-readin.
943 ;; Subroutines of dired-readin
946 ;; Insert listing for the specified dir (and maybe file list)
947 ;; already in dired-directory, assuming a clean buffer.
953 file-list nil))
957 ;; If we are reading a whole single directory...
962 ;; Else treat it as a wildcard spec
963 ;; unless we have an explicit list of files.
968 "Align the fields of a file to the ones of surrounding lines.
969 BEG..END is the line where the file info is located."
970 ;; Some versions of ls try to adjust the size of each field so as to just
971 ;; hold the largest element ("largest" in the current invocation, of
972 ;; course). So when a single line is output, the size of each field is
973 ;; just big enough for that one output. Thus when dired refreshes one
974 ;; line, the alignment if this line w.r.t the rest is messed up because
975 ;; the fields of that one line will generally be smaller.
976 ;;
977 ;; To work around this problem, we here add spaces to try and
978 ;; re-align the fields as needed. Since this is purely aesthetic,
979 ;; it is of utmost importance that it doesn't mess up anything like
980 ;; `dired-move-to-filename'. To this end, we limit ourselves to
981 ;; adding spaces only, and to only add them at places where there
982 ;; was already at least one space. This way, as long as
983 ;; `directory-listing-before-filename-regexp' always matches spaces
984 ;; with "*" or "+", we know we haven't made anything worse. There
985 ;; is one spot where the exact number of spaces is important, which
986 ;; is just before the actual filename, so we refrain from adding
987 ;; spaces there (and within the filename as well, of course).
990 ;; Check that there is indeed a file, and that there is anoter adjacent
991 ;; file with which to align, and that additional spaces are needed to
992 ;; align the filenames.
1005 ;; Make sure there is some work left to do.
1007 ;; If we've only looked at the line above, check to see if the line
1008 ;; below exists as well and if so, align with the shorter one.
1017 ;; Keep positions uptodate when we insert stuff.
1020 ;; Main loop.
1024 ;; Don't touch anything just before (and after) the
1025 ;; beginning of the filename.
1027 ;; We're now just in front of a field, with a space behind us.
1029 ;; Nums are right-aligned.
1031 ;; Let's look at the other line, in the same column: we
1032 ;; should be either near the end of the previous field, or
1033 ;; in the space between that field and the next.
1034 ;; [ Of course, it's also possible that we're already within
1035 ;; the next field or even past it, but that's unlikely since
1036 ;; other-col > file-col. ]
1037 ;; Let's find the distance to the alignment-point (either
1038 ;; the beginning or the end of the next field, depending on
1039 ;; whether this field is left or right aligned).
1049 ;; Now, the number of spaces to insert is align-pt-offset
1050 ;; minus the distance to the equivalent point on the
1051 ;; current line.
1054 align-pt-offset
1064 ;; Let's just make really sure we did not mess up.
1067 ;; Damn! We messed up: let's revert the change.
1069 ;; Now skip to next field.
1077 "Insert a directory listing of DIR, Dired style.
1078 Use SWITCHES to make the listings.
1079 If FILE-LIST is non-nil, list only those files.
1080 Otherwise, if WILDCARD is non-nil, expand wildcards;
1081 in that case, DIR should be a file name that uses wildcards.
1082 In other cases, DIR should be a directory name or a directory filename.
1083 If HDR is non-nil, insert a header line with the directory name."
1086 end)
1088 ;; Don't try to invoke `ls' if we are on DOS/Windows where
1089 ;; ls-lisp emulation is used, except if they want to use `ls'
1090 ;; as indicated by `ls-lisp-use-insert-directory-program'.
1094 ;; Check whether "ls --dired" gives exit code 0, and
1095 ;; save the answer in `dired-use-ls-dired'.
1099 dired-use-ls-dired)
1102 ;; We used to specify the C locale here, to force English month names;
1103 ;; but this should not be necessary any more,
1104 ;; with the new value of `directory-listing-before-filename-regexp'.
1109 ;; Re-align fields, if necessary.
1112 ;; Quote certain characters, unless ls quoted them for us.
1121 nil t))
1127 nil t))
1130 ;; If we used --dired and it worked, the lines are already indented.
1131 ;; Otherwise, indent them.
1137 ;; Insert text at the beginning to standardize things.
1143 ;; Note that dired-build-subdir-alist will replace the name
1144 ;; by its expansion, so it does not matter whether what we insert
1145 ;; here is fully expanded, but it should be absolute.
1148 ;; Insert "wildcard" line where "total" line would be for a full dir.
1152 "Make the file names highlight when the mouse is on them."
1164 dired-filename t
1168 \f
1169 ;; Reverting a dired buffer
1172 "Reread the dired buffer.
1173 Must also be called after `dired-actual-switches' have changed.
1174 Should not fail even on completely garbaged buffers.
1175 Preserves old cursor, marks/flags, hidden-p.
1177 Dired sets `revert-buffer-function' to this function. The args
1178 ARG and NOCONFIRM, passed from `revert-buffer', are ignored."
1190 ;; treat top level dir extra (it may contain wildcards)
1197 ;; Run dired-after-readin-hook just once, below.
1202 ;; ... run the hook for the whole buffer, and only after markers
1203 ;; have been reinserted (else omitting in dired-x would omit marked files)
1211 ;; outside of the let scope
1212 ;;; Might as well not override the user if the user changed this.
1213 ;;; (setq buffer-read-only t)
1214 )
1216 ;; Subroutines of dired-revert
1217 ;; Some of these are also used when inserting subdirs.
1220 "Return current positions in the buffer and all windows with this directory.
1221 The positions have the form (BUFFER-POSITION WINDOW-POSITIONS).
1223 BUFFER-POSITION is the point position in the current dired buffer.
1224 It has the form (BUFFER DIRED-FILENAME BUFFER-POINT).
1226 WINDOW-POSITIONS are current positions in all windows displaying
1227 this dired buffer. The window positions have the form (WINDOW
1228 DIRED-FILENAME WINDOW-POINT)."
1239 "Restore POSITIONS saved with `dired-save-positions'."
1247 ;; Ensure that window still displays the original buffer.
1256 "Return alist of files and their marks, from BEG to END."
1267 alist))
1270 "Mark all files remembered in ALIST.
1271 Each element of ALIST looks like (FILE . MARKERCHAR)."
1285 "Return a list of names of subdirs currently hidden."
1295 result))
1298 "Try to insert all subdirs that were displayed before.
1299 Do so according to the former subdir alist OLD-SUBDIR-ALIST."
1313 "Remove directory DIR from any directory cache."
1317 \f
1318 ;; dired mode key bindings and initialization
1321 ;; This looks ugly when substitute-command-keys uses C-d instead d:
1322 ;; (define-key dired-mode-map "\C-d" 'dired-flag-file-deletion)
1327 ;; Commands to mark or flag certain categories of files
1331 ;; Upper case keys (except !) for operating on the marked files
1350 ;; Comparison commands
1353 ;; Tree Dired commands
1359 ;; move to marked files
1362 ;; Make all regexp commands share a `%' prefix:
1363 ;; We used to get to the submap via a symbol dired-regexp-prefix,
1364 ;; but that seems to serve little purpose, and copy-keymap
1365 ;; does a better job without it.
1378 ;; Commands for marking and unmarking.
1395 ;; Lower keys for commands not operating on all the marked files
1420 ;; moving
1427 ;; hiding
1430 ;; isearch
1435 ;; misc
1441 ;; thumbnail manipulation (image-dired)
1454 ;; encryption and decryption (epa-dired)
1460 ;; Make menu bar items.
1462 ;; No need to fo this, now that top-level items are fewer.
1463 ;;;;
1464 ;; Get rid of the Edit menu bar item to save space.
1465 ;(define-key map [menu-bar edit] 'undefined)
1570 ;; When running on plain MS-DOS, there's only one
1571 ;; letter-case for file names.
1759 map)
1761 \f
1762 ;; Dired mode is suitable only for specially formatted data.
1765 ;; Autoload cookie needed by desktop.el
1766 ;;;###autoload
1768 "\
1771 \(optionally) its subdirectories, in the format of `ls -lR'.
1774 compress, load or byte-compile them, change their file attributes
1777 by file or all files matching certain criteria.
1779 Letters no longer insert themselves. Digits are prefix arguments.
1782 Most commands operate on the marked files and use the current file
1783 if no files are marked. Use a numeric prefix argument to operate on
1784 the next ARG (or previous -ARG if ARG<0) files, or just `1'
1785 to operate on the current file only. Prefix arguments override marks.
1787 to see why something went wrong.
1792 (or dired it in another buffer, if it is a directory).
1799 This retains all marks and hides subdirs again that were hidden before.
1800 SPC and DEL can be used to move down and up by lines.
1803 to read the
1805 to relist a single or the marked files or a
1807 again for the directory tree.
1810 for more info):
1812 `dired-listing-switches'
1813 `dired-trivial-filenames'
1814 `dired-shrink-to-fit'
1815 `dired-marker-char'
1816 `dired-del-marker'
1817 `dired-keep-marker-rename'
1818 `dired-keep-marker-copy'
1819 `dired-keep-marker-hardlink'
1820 `dired-keep-marker-symlink'
1824 `dired-before-readin-hook'
1825 `dired-after-readin-hook'
1826 `dired-mode-hook'
1827 `dired-load-hook'
1829 Keybindings:
1831 ;; Not to be called interactively (e.g. dired-directory will be set
1832 ;; to default-directory, which is wrong with wildcards).
1837 mode-name "Dired"
1838 ;; case-fold-search nil
1839 buffer-read-only t
1840 selective-display t ; for subdirectory hiding
1841 mode-line-buffer-identification
1851 ;; list-buffers uses this to display the dir being edited in this buffer.
1855 dired-directory)))
1870 \f
1871 ;; Idiosyncratic dired commands that don't deal with marks.
1874 "Summarize basic Dired commands and show recent dired errors."
1877 ;>> this should check the key-bindings and use substitute-command-keys if non-standard
1882 "Undo in a dired buffer.
1883 This doesn't recover lost files, it just undoes changes in the buffer itself.
1884 You can use it to recover marks, killed lines or subdirs."
1893 "Edit dired buffer with Wdired, or set it read-only.
1894 Call `wdired-change-to-wdired-mode' in dired buffers whose editing is
1895 supported by Wdired (the major mode of the dired buffer is `dired-mode').
1896 Otherwise, for buffers inheriting from dired-mode, call `toggle-read-only'."
1903 "Move down lines then position at filename.
1904 Optional prefix ARG says how many lines to move; default is one line."
1910 "Move up lines then position at filename.
1911 Optional prefix ARG says how many lines to move; default is one line."
1917 "Goto ARG'th next directory file line."
1929 "Goto ARG'th previous directory file line."
1934 "Run Dired on parent directory of current directory.
1935 Find the parent directory either in this buffer or another buffer.
1936 Creates a buffer if necessary."
1941 ;; Only try dired-goto-subdir if buffer has more than one dir.
1951 "Get the current line's file name, with an error if file does not exist."
1953 ;; We pass t for second arg so that we don't get error for `.' and `..'.
1955 file-name)
1960 file-name
1965 ;; Force C-m keybinding rather than `f' or `e' in the mode doc:
1968 "In Dired, visit the file or directory named on this line."
1970 ;; Bind `find-file-run-dired' so that the command works on directories
1971 ;; too, independent of the user's setting.
1976 "In Dired, visit this file or directory instead of the dired buffer."
1980 ;; Don't override the setting from .emacs.
1981 ;;;###autoload (put 'dired-find-alternate-file 'disabled t)
1984 "In Dired, visit the file or directory name you click on."
2005 "In Dired, examine a file in view mode, returning to Dired when done.
2006 When file is a directory, show it in this buffer if it is inserted.
2007 Otherwise, display it in another buffer."
2017 "In Dired, visit this file or directory in another window."
2022 "In Dired, display this file or directory in another window."
2025 \f
2026 ;;; Functions for extracting and manipulating file names in Dired buffers.
2029 "In Dired, return name of file mentioned on this line.
2030 Value returned normally includes the directory name.
2031 Optional arg LOCALP with value `no-dir' means don't include directory
2032 name in result. A value of `verbatim' means to return the name exactly as
2033 it occurs in the buffer, and a value of t means construct name relative to
2034 `default-directory', which still may contain slashes if in a subdirectory.
2035 Optional arg NO-ERROR-IF-NOT-FILEP means treat `.' and `..' as
2036 regular filenames and return nil if no filename on this line.
2037 Otherwise, an error occurs in these cases."
2042 ;; nil if no file on this line, but no-error-if-not-filep is t:
2045 ;; Get rid of the mouse-face property that file names have.
2047 ;; Unquote names quoted by ls or by dired-insert-directory.
2048 ;; This code was written using `read' to unquote, because
2049 ;; it's faster than substituting \007 (4 chars) -> ^G (1
2050 ;; char) etc. in a lisp loop. Unfortunately, this decision
2051 ;; has necessitated hacks such as dealing with filenames
2052 ;; with quotation marks in their names.
2064 ;; The above `read' will return a unibyte string if FILE
2065 ;; contains eight-bit-control/graphic characters.
2070 ;; A relative file name can start with ~.
2071 ;; Don't treat it as absolute in this context.
2076 nil)
2078 file)
2086 ;; check for safe-magic property so that we won't
2087 ;; put /: for names that don't really need them.
2088 ;; For instance, .gz files when auto-compression-mode is on.
2091 file)))
2093 file)
2097 ;; check for safe-magic property so that we won't
2098 ;; put /: for names that don't really need them.
2099 ;; For instance, .gz files when auto-compression-mode is on.
2102 file)))
2108 "Replace first match of REGEXP in STRING with NEWTEXT.
2109 If it does not match, nil is returned instead of the new string.
2110 Optional arg LITERAL means to take NEWTEXT literally.
2111 Optional arg GLOBAL means to replace all matches."
2118 ret)
2120 nil
2124 ;;"Convert FILE (a file name relative to DIR) to an absolute file name."
2125 ;; We can't always use expand-file-name as this would get rid of `.'
2126 ;; or expand in / instead default-directory if DIR=="".
2127 ;; This should be good enough for ange-ftp.
2128 ;; It should be reasonably fast, though, as it is called in
2129 ;; dired-get-filename.
2133 "Convert FILE (an absolute file name) to a name relative to DIR.
2134 If this is impossible, return FILE unchanged.
2135 DIR must be a directory name, not a file name."
2137 ;; This case comes into play if default-directory is set to
2138 ;; use ~.
2143 ;;; (or no-error
2144 ;;; (error "%s: not in directory tree growing at %s" file dir))
2145 file))
2146 \f
2147 ;;; Functions for finding the file name in a dired buffer line.
2153 ;; Move to first char of filename on this line.
2154 ;; Returns position (point) or nil if no filename on this line."
2156 "Move to the beginning of the filename on the current line.
2157 Return the position of the beginning of the filename, or nil if none found."
2158 ;; This is the UNIX version.
2161 ;; First try assuming `ls --dired' was used.
2169 ;; Ha! There *is* a file. Our regexp-from-hell just failed to find it.
2173 nil)
2178 ;; Assumes point is at beginning of filename,
2179 ;; thus the rwx bit re-search-backward below will succeed in *this*
2180 ;; line if at all. So, it should be called only after
2181 ;; (dired-move-to-filename t).
2182 ;; On failure, signals an error (with non-nil NO-ERROR just returns nil).
2183 ;; This is the UNIX version.
2187 ;; case-fold-search is nil now, so we can test for capital F:
2194 nil
2196 ;; Restrict perm bits to be non-blank,
2197 ;; otherwise this matches one char to early (looking backward):
2198 ;; "l---------" (some systems make symlinks that way)
2199 ;; "----------" (plain file with zero perms)
2201 dired-permission-flags-regexp nil t)
2204 ;; Only with -F we need to know whether it's an executable
2206 used-F
2214 ;; Move point to end of name:
2220 dired-ls-F-marks-symlinks
2224 ;; ls -lF marks dirs, sockets, fifos and executables with exactly
2225 ;; one trailing character. (Executable bits on symlinks ain't mean
2226 ;; a thing, even to ls, but we know it's not a symlink.)
2229 executable)
2238 nil
2241 \f
2242 ;;; COPY NAMES OF MARKED FILES INTO KILL-RING.
2245 "Copy names of marked (or next ARG) files into the kill ring.
2246 The names are separated by a space.
2247 With a zero prefix arg, use the absolute file name of each marked file.
2249 `default-directory'. (This still may contain slashes if in a subdirectory.)
2251 If on a subdir headerline, use absolute subdirname instead;
2252 prefix arg and marked files are ignored in this case.
2274 \f
2275 ;; Keeping Dired buffers in sync with the filesystem and with each other
2278 ;; Return a list of buffers for DIR (top level or in-situ subdir).
2279 ;; If FILE is non-nil, include only those whose wildcard pattern (if any)
2280 ;; matches FILE.
2281 ;; The list is in reverse order of buffer creation, most recent last.
2282 ;; As a side effect, killed dired buffers for DIR are removed from
2283 ;; dired-buffers.
2290 ;; Buffer is killed - clean up:
2298 dired-directory)))
2301 file)))
2305 result))
2308 "Convert glob-pattern PATTERN to a regular expression."
2310 regexp)
2322 ;; Fails to handle ^ yet ????
2336 regexp
2344 ;;"Advertise in variable `dired-buffers' that we dired `default-directory'."
2345 ;; With wildcards we actually advertise too much.
2348 t ; we have already advertised ourselves
2351 dired-buffers)))))
2354 ;; Remove DIR from the buffer alist in variable dired-buffers.
2355 ;; This has the effect of removing any buffer whose main directory is DIR.
2356 ;; It does not affect buffers in which DIR is a subdir.
2357 ;; Removing is also done as a side-effect in dired-buffer-for-dir.
2360 \f
2361 ;; Tree Dired
2363 ;;; utility functions
2366 ;;"Is FILE part of the directory tree starting at DIR?"
2371 ;; Prepend default-directory to DIR if relative file name.
2372 ;; dired-get-filename must be able to make a valid file name from a
2373 ;; file and its directory DIR.
2376 dir
2380 ;;"Return the subdir name on this line, or nil if not on a headerline."
2381 ;; Look up in the alist whether this is a headerline.
2387 dired-subdir-alist))))
2388 cur-dir))))
2390 ;(defun dired-get-subdir-min (elt)
2391 ; (cdr elt))
2392 ;; can't use macro, must be redefinable for other alist format in dired-nstd.
2406 ;; Return an index into alist for use with nth
2407 ;; for the sake of subdir moving commands.
2416 "Go to next subdirectory, regardless of level."
2417 ;; Use 0 arg to go to this directory's header line.
2418 ;; NO-SKIP prevents moving to end of header line, returning whatever
2419 ;; position was found in dired-subdir-alist.
2422 pos index)
2423 ;; nth with negative arg does not return nil but the first element
2433 nil ; return nil if not found
2437 "Build `dired-subdir-alist' by parsing the buffer.
2438 Returns the new value of the alist.
2439 If optional arg SWITCHES is non-nil, use its value
2440 instead of `dired-actual-switches'."
2448 new-dir-name
2450 ;; Used to expand subdirectory names correctly in recursive
2451 ;; ange-ftp listings.
2458 ;; Avoid taking a file name ending in a colon
2459 ;; as a subdir name.
2469 new-dir-name
2481 ;; Place a sub directory boundary between lines.
2488 ;; We don't need to sort it because it is in buffer order per
2489 ;; constructionem. Return new alist:
2490 dired-subdir-alist))
2493 ;; Add new DIR at NEW-MARKER. Don't sort.
2496 dired-subdir-alist)))
2499 ;; Position point on first nontrivial file after point.
2515 "Go to line describing file FILE in this dired buffer."
2516 ;; Return value of point on success, else nil.
2517 ;; FILE must be an absolute file name.
2518 ;; Loses if FILE contains control chars like "\007" for which ls
2519 ;; either inserts "?" or "\\007" into the buffer, so we won't find
2520 ;; it in the buffer.
2532 ;; The hair here is to get the result of dired-goto-subdir
2533 ;; without really calling it if we don't have any subdirs.
2539 search-string
2546 ;; filenames are preceded by SPC, this makes
2547 ;; the search faster (e.g. for the filename "-"!).
2550 ;; Match could have BASE just as initial substring or
2551 ;; or in permission bits or date or
2552 ;; not be a proper filename at all:
2554 ;; Must move to filename since an (actually
2555 ;; correct) match could have been elsewhere on the
2556 ;; ;; line (e.g. "-" would match somewhere in the
2557 ;; permission bits).
2559 ;; If this isn't the right line, move forward to avoid
2560 ;; trying this line again.
2563 ;; return value of point (i.e., FOUND):
2568 ;; FIXME document whatever dired-x is doing.
2570 "Where point should go in a new listing of DIRNAME.
2571 Point assumed at beginning of new subdir line."
2576 \f
2577 ;; These are hooks which make tree dired work.
2578 ;; They are in this file because other parts of dired need to call them.
2579 ;; But they don't call the rest of tree dired unless there are subdirs loaded.
2581 ;; This function is called for each retrieved filename.
2582 ;; It could stand to be faster, though it's mostly function call
2583 ;; overhead. Avoiding the function call seems to save about 10% in
2584 ;; dired-get-filename. Make it a defsubst?
2586 "Return the name of the subdirectory to which this line belongs.
2587 This returns a string with trailing slash, like `default-directory'.
2588 Optional argument means return a file name relative to `default-directory'."
2591 ;; probably because called in a non-dired buffer
2593 elt dir)
2597 ;; use `<=' (not `<') as subdir line is part of subdir
2599 nil ; found
2603 dir)))
2605 ;; Subdirs start at the beginning of their header lines and end just
2606 ;; before the beginning of the next header line (or end of buffer).
2613 \f
2614 ;; Deleting files
2617 "Decide whether recursive deletes are allowed.
2618 A value of nil means no recursive deletes.
2619 `always' means delete recursively without asking. This is DANGEROUS!
2620 `top' means ask for each directory at top level, but delete its subdirectories
2621 without asking.
2622 Anything else means ask for each directory."
2630 ;; Match anything but `.' and `..'.
2633 ;; Delete file, possibly delete a directory and all its files.
2634 ;; This function is usefull outside of dired. One could change it's name
2635 ;; to e.g. recursive-delete-file and put it somewhere else.
2637 Delete FILE or directory (possibly recursively if optional RECURSIVE is true.)
2638 RECURSIVE determines what to do with a non-empty directory. If RECURSIVE is:
2639 nil, do not delete.
2640 `always', delete recursively without asking.
2641 `top', ask for each directory at top level.
2642 Anything else, ask for each sub-directory."
2643 ;; This test is equivalent to
2644 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
2645 ;; but more efficient
2653 delete-by-moving-to-trash)
2654 "trash"
2662 "In Dired, delete the files flagged for deletion.
2663 If NOMESSAGE is non-nil, we don't display any message
2664 if there are no flagged files.
2665 `dired-recursive-deletes' controls whether deletion of
2666 non-empty directories is allowed."
2670 case-fold-search)
2674 ;; this can't move point since ARG is nil
2676 nil)
2677 nil t)
2682 "Delete all marked (or next ARG) files.
2683 `dired-recursive-deletes' controls whether deletion of
2684 non-empty directories is allowed."
2685 ;; This is more consistent with the file marking feature than
2686 ;; dired-do-flagged-delete.
2689 ;; this may move point if ARG is an integer
2691 arg)
2692 arg t))
2697 ;; L is an alist of files to delete, with their buffer positions.
2698 ;; ARG is the prefix arg.
2699 ;; Filenames are absolute.
2700 ;; (car L) *must* be the *last* (bottommost) file in the dired buffer.
2701 ;; That way as changes are made in the buffer they do not shift the
2702 ;; lines still to be changed, so the (point) values in L stay valid.
2703 ;; Also, for subdirs in natural order, a subdir's files are deleted
2704 ;; before the subdir itself - the other way around would not work.
2712 succ count)))
2713 ;; canonicalize file list for pop up
2728 ;; if we get here, removing worked
2744 failures))))
2749 ;; In all buffers dired'ing DIRECTORY, run FUN with ARGS.
2750 ;; If the buffer has a wildcard pattern, check that it matches FILE.
2751 ;; (FILE does not include a directory component.)
2752 ;; FILE may be nil, in which case ignore it.
2753 ;; Return list of buffers where FUN succeeded (i.e., returned non-nil).
2756 file))
2760 success-list))
2762 ;; Delete the entry for FILE from
2774 "Clean up after a deleted file or directory FN.
2775 Removes any expanded subdirectory of deleted directory.
2776 If `dired-x' is loaded and `dired-clean-up-buffers-too' is non-nil,
2777 also offers to kill buffers visiting deleted files and directories."
2781 ;; Offer to kill buffer of deleted file FN.
2797 \f
2798 ;; Confirmation
2807 "Return a string for use in a prompt, either the current file
2808 name, or the marker and a count of marked files."
2809 ;; distinguish-one-marked can cause the first element to be just t.
2814 ;; more than 1 file:
2816 ;; abs(arg) = count
2817 ;; Perhaps this is nicer, but it also takes more screen space:
2818 ;;(format "[%s %d files]" (if (> arg 0) "next" "previous")
2819 ;; count)
2824 "Pop up buffer BUF in a way suitable for Dired."
2829 ;; Try to split the selected window vertically if
2830 ;; that's possible. (Bug#1806)
2832 ;; Otherwise, try to split WINDOW sensibly.
2834 pop-up-frames)
2836 ;; If dired-shrink-to-fit is t, make its window fit its contents.
2838 ;; Try to not delete window when we want to display less than
2839 ;; `window-min-height' lines.
2843 "A list of symbols for commands Dired should not confirm, or t.
2844 Command symbols are `byte-compile', `chgrp', `chmod', `chown', `compress',
2845 `copy', `delete', `hardlink', `load', `move', `print', `shell', `symlink',
2846 `touch' and `uncompress'.
2847 If t, confirmation is never needed."
2858 "Return FUNCTION's result on ARGS after showing which files are marked.
2859 Displays the file names in a buffer named BUFNAME;
2861 This uses function `dired-pop-to-buffer' to do that.
2863 FUNCTION should not manipulate files, just read input
2864 (an argument or confirmation).
2865 The window is not shown if there is just one file or
2866 OP-SYMBOL is a member of the list in `dired-no-confirm'.
2867 FILES is the list of marked files. It can also be (t FILENAME)
2868 in the case of one marked file, to distinguish that from using
2869 just the current file."
2873 ;; If FILES defaulted to the current line's file.
2878 ;; Handle (t FILE) just like (FILE), here.
2879 ;; That value is used (only in some cases), to mean
2880 ;; just one file that was marked, rather than the current line file.
2892 \f
2893 ;; Commands to mark or flag file(s) at or near current line.
2896 ;; This version skips non-file lines.
2907 ;; Advance to the next line--actually, to the line that *was* next.
2908 ;; (If FUNCTION inserted some new lines in between, skip them.)
2920 ;; This used to be a regexp match of the `total ...' line output by
2921 ;; ls, which is slightly faster, but that is not very robust; notably,
2922 ;; it fails for non-english locales.
2926 "Move to the next marked file, wrapping around the end of the buffer."
2943 "Move to the previous marked file, wrapping around the end of the buffer."
2948 ;; Return FILE's marker, or nil if unmarked.
2962 ;; Skip subdir line and following garbage like the `total' line:
2973 "Mark the current (or next ARG) files.
2974 If on a subdir headerline, mark all its files except `.' and `..'.
2978 this subdir."
2988 "Unmark the current (or next ARG) files.
2989 If looking at a subdir, unmark all its files except `.' and `..'."
2995 "In Dired, flag the current line's file for deletion.
2996 With prefix arg, repeat over several lines.
2998 If on a subdir headerline, mark all its files except `.' and `..'."
3004 "In Dired, move up lines and remove deletion flag there.
3005 Optional prefix ARG says how many lines to unflag; default is one line."
3010 "Toggle marks: marked files become unmarked, and vice versa.
3011 Files marked with other flags (such as `D') are not affected.
3012 `.' and `..' are never toggled.
3013 As always, hidden subdirs are not affected."
3021 ;; use subst instead of insdel because it does not move
3022 ;; the gap and thus should be faster and because
3023 ;; other characters are left alone automatically
3030 \f
3031 ;;; Commands to mark or flag files based on their characteristics or names.
3040 "Mark all files matching REGEXP for use in later commands.
3041 A prefix argument means to unmark them instead.
3042 `.' and `..' are never marked.
3045 object files--just `.o' will mark more than you might think."
3059 "Mark all files with contents containing REGEXP for use in later commands.
3060 A prefix argument means to unmark them instead.
3061 `.' and `..' are never marked."
3075 ;; For now we do it inside emacs
3076 ;; Grep might be better if there are a lot of files
3086 )))
3090 "In Dired, flag all files containing the specified REGEXP for deletion.
3091 The match is against the non-directory part of the filename. Use `^'
3092 and `$' to anchor matches. Exclude subdirs by hiding them.
3093 `.' and `..' are never flagged."
3098 "Mark all symbolic links.
3099 With prefix argument, unflag all those files."
3105 "Mark all directory file lines except `.' and `..'.
3106 With prefix argument, unflag all those files."
3114 "Mark all executable files.
3115 With prefix argument, unflag all those files."
3120 ;; dired-x.el has a dired-mark-sexp interactive command: mark
3121 ;; files for which PREDICATE returns non-nil.
3124 "Flag for deletion files whose names suggest they are auto save files.
3125 A prefix argument says to unflag those files instead."
3129 ;; It is less than general to check for # here,
3130 ;; but it's the only way this runs fast enough.
3134 ;; Handle executables in case of -F option.
3135 ;; We need not worry about the other kinds
3136 ;; of markings that -F makes, since they won't
3137 ;; appear on real auto-save files.
3149 ;; `log' here is dubious, since it's typically used for useful log
3150 ;; files, not just TeX stuff. -- fx
3159 "Flag for deletion all files that match `dired-garbage-files-regexp'."
3164 "Flag all backup files (names ending with `~') for deletion.
3165 With prefix argument, unflag these files."
3169 ;; Don't call backup-file-name-p unless the last character looks like
3170 ;; it might be the end of a backup file name. This isn't very general,
3171 ;; but it's the only way this runs fast enough.
3173 ;; Handle executables in case of -F option.
3174 ;; We need not worry about the other kinds
3175 ;; of markings that -F makes, since they won't
3176 ;; appear on real backup files.
3186 "Change all OLD marks to NEW marks.
3187 OLD and NEW are both characters used to mark files."
3204 t)
3209 "Remove all marks from all files in the dired buffer."
3214 "Remove a specific mark (or any mark) from every file.
3215 After this command, type the mark character to remove,
3216 or type RET to remove all marks.
3217 With prefix arg, query for each marked file.
3225 Type SPC or `y' to unmark one file, DEL or `n' to skip to next,
3235 file))))
3241 count))))
3242 \f
3243 ;; Logging failures operating on files, and showing the results.
3248 "Pop up a buffer with error log output from Dired.
3249 A group of errors from a single command ends with a formfeed.
3265 ;; Log a message or the contents of a buffer.
3266 ;; If LOG is a string and there are more args, it is formatted with
3267 ;; those ARGS. Usually the LOG string ends with a \n.
3268 ;; End each bunch of errors with (dired-log t):
3269 ;; this inserts the current time and buffer at the start of the page,
3270 ;; and \f (formfeed) at the end.
3278 log)))
3291 "State a summary of a command's failures, in echo area and log buffer.
3292 STRING is an overall summary of the failures.
3293 FAILURES is a list of file names that we failed to operate on,
3294 or nil if file names are not applicable."
3304 string failures))
3305 ;; Log a summary describing a bunch of errors.
3308 \f
3309 ;;; Sorting
3311 ;; Most ls can only sort by name or by date (with -t), nothing else.
3312 ;; GNU ls sorts on size with -S, on extension with -X, and unsorted with -U.
3313 ;; So anything that does not contain these is sort "by name".
3318 This indicates to Dired which option switches to watch out for because they
3319 will change the sorting order behavior of `ls'.
3321 To change the default sorting order \(e.g. add a `-v' option\), see the
3322 variable `dired-listing-switches'. To temporarily override the listing
3327 ;; `dired-ls-sorting-switches' after -t overrides -t.
3339 "Non-nil means the Dired sort command is disabled.
3343 ;; Set modeline display according to dired-actual-switches.
3344 ;; Modeline display of "by name" or "by date" guarantees the user a
3345 ;; match with the corresponding regexps. Non-matching switches are
3346 ;; shown literally.
3351 dired-sort-by-name-regexp dired-actual-switches)
3354 dired-sort-by-date-regexp dired-actual-switches)
3361 "Toggle sorting by date, and refresh the Dired buffer.
3362 With a prefix argument, edit the current listing switches instead."
3372 ;; Toggle between sort by date/name. Reverts the buffer.
3374 dired-actual-switches))
3375 ;; Regexp for finding (possibly embedded) -t switches.
3377 case-fold-search)
3378 ;; Remove the -t switch.
3382 ;; Remove a stand-alone -t switch.
3385 ;; Remove a switch of the form -XtY for some X and Y.
3388 ;; Now, if we weren't sorting by date before, add the -t switch.
3394 ;; Some user code loads dired especially for this.
3395 ;; Don't do that--use replace-regexp-in-string instead.
3397 ;; Replace REGEXP with NEWTEXT everywhere in STRING and return result.
3398 ;; NEWTEXT is taken literally---no \\DIGIT escapes will be recognized.
3404 start me))
3408 "Specify new `ls' SWITCHES for current dired buffer.
3409 Values matching `dired-sort-by-date-regexp' or `dired-sort-by-name-regexp'
3410 set the minor mode accordingly, others appear literally in the mode line.
3411 With optional second arg NO-REVERT, don't refresh the listing afterwards."
3422 "Additional processing of -R in ls option string SWITCHES.
3423 Saves `dired-subdir-alist' when R is set and restores saved value
3424 minus any directories explicitly deleted when R is cleared.
3425 To be called first in body of `dired-sort-other', etc."
3429 ;; Adding -R to ls switches -- save `dired-subdir-alist':
3433 ;; Deleting -R from ls switches -- revert to pre-R subdirs
3434 ;; that are still present:
3440 dired-subdir-alist)
3441 ;; subdir still present...
3444 subdirs)))
3448 ;; No pre-R subdir alist, so revert to main directory
3449 ;; listing:
3451 \f
3453 ;;;; Drag and drop support
3456 "Decide whether recursive copies are allowed.
3457 A value of nil means no recursive copies.
3458 `always' means copy recursively without asking.
3459 `top' means ask for each directory at top level.
3460 Anything else means ask for each directory."
3475 ;; No need to get actions and descriptions from the source,
3476 ;; we only have three actions anyway.
3478 t
3484 "--"
3488 nil)))
3493 ;; Only used when (featurep 'dnd).
3500 "Copy, move or link a file to the dired directory.
3501 URI is the file to handle, ACTION is one of copy, move, link or ask.
3502 Ask means pop up a menu for the user to select one of copy, move or link."
3511 ;; If copying a directory and dired-recursive-copies is
3512 ;; nil, dired-copy-file fails. Pop up a notice.
3521 ;; Binding dired-overwrite-confirmed to nil makes
3522 ;; dired-handle-overwrite a no-op. We instead use
3523 ;; y-or-n-p, which pops a graphical menu.
3524 dired-overwrite-confirmed backup-file)
3526 ;; d-b-o is defined in dired-aux.
3528 dired-backup-overwrite
3544 action))))))
3547 "Copy, move or link a file to the dired directory if it is a local file.
3548 URI is the file to handle. If the hostname in the URI isn't local, do nothing.
3549 ACTION is one of copy, move, link or ask.
3550 Ask means pop up a menu for the user to select one of copy, move or link."
3553 nil)))
3554 \f
3556 ;;;; Desktop support
3561 "Auxiliary information to be saved in desktop file."
3563 ;; Value of `dired-directory'.
3565 ;; Directory name followed by list of files.
3568 ;; Directory name, optionally with shell wildcard.
3570 ;; Subdirectories in `dired-subdir-alist'.
3575 dired-subdir-alist)))))
3578 _buffer-name
3579 misc-data)
3580 "Restore a dired buffer specified in a desktop file."
3581 ;; First element of `misc-data' is the value of `dired-directory'.
3582 ;; This value is a directory name, optionally with shell wildcard or
3583 ;; a directory name followed by list of files.
3589 ;; The following elements of `misc-data' are the keys
3590 ;; from `dired-subdir-alist'.
3595 nil)))
3600 \f
3601 ;;; Start of automatically extracted autoloads.
3602 \f
3603 ;;;### (autoloads (dired-show-file-type dired-do-query-replace-regexp
3604 ;;;;;; dired-do-search dired-do-isearch-regexp dired-do-isearch
3605 ;;;;;; dired-isearch-filenames-regexp dired-isearch-filenames dired-isearch-filenames-setup
3606 ;;;;;; dired-hide-all dired-hide-subdir dired-tree-down dired-tree-up
3607 ;;;;;; dired-kill-subdir dired-mark-subdir-files dired-goto-subdir
3608 ;;;;;; dired-prev-subdir dired-insert-subdir dired-maybe-insert-subdir
3609 ;;;;;; dired-downcase dired-upcase dired-do-symlink-regexp dired-do-hardlink-regexp
3610 ;;;;;; dired-do-copy-regexp dired-do-rename-regexp dired-do-rename
3611 ;;;;;; dired-do-hardlink dired-do-symlink dired-do-copy dired-create-directory
3612 ;;;;;; dired-rename-file dired-copy-file dired-relist-file dired-remove-file
3613 ;;;;;; dired-add-file dired-do-redisplay dired-do-load dired-do-byte-compile
3614 ;;;;;; dired-do-compress dired-query dired-compress-file dired-do-kill-lines
3615 ;;;;;; dired-run-shell-command dired-do-shell-command dired-do-async-shell-command
3616 ;;;;;; dired-clean-directory dired-do-print dired-do-touch dired-do-chown
3617 ;;;;;; dired-do-chgrp dired-do-chmod dired-compare-directories dired-backup-diff
3618 ;;;;;; dired-diff) "dired-aux" "dired-aux.el" "9d6333fab9c0f1b49e0bf2a536b8f245")
3619 ;;; Generated autoloads from dired-aux.el
3622 Compare file at point with file FILE using `diff'.
3623 FILE defaults to the file at the mark. (That's the mark set by
3625 The prompted-for file is the first file given to `diff'.
3626 With prefix arg, prompt for second argument SWITCHES,
3627 which is options for `diff'.
3632 Diff this file with its backup file or vice versa.
3633 Uses the latest backup, if there are several numerical backups.
3634 If this file is a backup, diff it with its original.
3635 The backup file is the first file given to `diff'.
3636 With prefix arg, prompt for argument SWITCHES which is options for `diff'.
3641 Mark files with different file attributes in two dired buffers.
3642 Compare file attributes of files in the current directory
3643 with file attributes in directory DIR2 using PREDICATE on pairs of files
3644 with the same name. Mark files for which PREDICATE returns non-nil.
3645 Mark files with different names if PREDICATE is nil (or interactively
3646 with empty input at the predicate prompt).
3648 PREDICATE is a Lisp expression that can refer to the following variables:
3650 size1, size2 - file size in bytes
3651 mtime1, mtime2 - last modification time in seconds, as a float
3652 fa1, fa2 - list of file attributes
3653 returned by function `file-attributes'
3655 where 1 refers to attribute of file in the current dired buffer
3656 and 2 to attribute of file in second dired buffer.
3658 Examples of PREDICATE:
3660 (> mtime1 mtime2) - mark newer files
3661 (not (= size1 size2)) - mark files with different sizes
3662 (not (string= (nth 8 fa1) (nth 8 fa2))) - mark files with different modes
3663 (not (and (= (nth 2 fa1) (nth 2 fa2)) - mark files with different UID
3664 (= (nth 3 fa1) (nth 3 fa2)))) and GID.
3669 Change the mode of the marked (or next ARG) files.
3670 Symbolic modes like `g+w' are allowed.
3675 Change the group of the marked (or next ARG) files.
3680 Change the owner of the marked (or next ARG) files.
3685 Change the timestamp of the marked (or next ARG) files.
3686 This calls touch.
3691 Print the marked (or next ARG) files.
3692 Uses the shell command coming from variables `lpr-command' and
3693 `lpr-switches' as default.
3698 Flag numerical backups for deletion.
3699 Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
3700 Positive prefix arg KEEP overrides `dired-kept-versions';
3701 Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
3704 with a prefix argument.
3709 Run a shell command COMMAND on the marked files asynchronously.
3711 Like `dired-do-shell-command' but if COMMAND doesn't end in ampersand,
3712 adds `* &' surrounded by whitespace and executes the command asynchronously.
3713 The output appears in the buffer `*Async Shell Command*'.
3718 Run a shell command COMMAND on the marked files.
3719 If no files are marked or a specific numeric prefix arg is given,
3721 The prompt mentions the file(s) or the marker, as appropriate.
3723 If there is a `*' in COMMAND, surrounded by whitespace, this runs
3724 COMMAND just once with the entire file list substituted there.
3726 If there is no `*', but there is a `?' in COMMAND, surrounded by
3727 whitespace, this runs COMMAND on each file individually with the
3728 file name substituted for `?'.
3730 Otherwise, this runs COMMAND on each file individually with the
3731 file name added at the end of COMMAND (separated by a space).
3733 `*' and `?' when not surrounded by whitespace have no special
3734 significance for `dired-do-shell-command', and are passed through
3735 normally to the shell, but you must confirm first. To pass `*' by
3738 If COMMAND produces output, it goes to a separate buffer.
3740 This feature does not try to redisplay Dired buffers afterward, as
3741 there's no telling what files COMMAND may have changed.
3744 When COMMAND runs, its working directory is the top-level directory
3745 of the Dired buffer, so output files usually are created there
3746 instead of in a subdir.
3748 In a noninteractive call (from Lisp code), you must specify
3749 the list of file names explicitly with the FILE-LIST argument, which
3750 can be produced by `dired-get-marked-files', for example.
3755 Not documented
3760 Kill all marked lines (not the files).
3761 With a prefix argument, kill that many lines starting with the current line.
3762 \(A negative argument kills backward.)
3763 If you use this command with a prefix argument to kill the line
3764 for a file that is a directory, which you have inserted in the
3765 Dired buffer as a subdirectory, then it deletes that subdirectory
3766 from the buffer as well.
3767 To kill an entire subdirectory (without killing its line in the
3768 parent directory), go to its directory header line and use this
3769 command with a prefix argument (the value does not matter).
3774 Not documented
3779 Format PROMPT with ARGS, query user, and store the result in SYM.
3780 The return value is either nil or t.
3782 The user may type y or SPC to accept once; n or DEL to skip once;
3783 ! to accept this and subsequent queries; or q or ESC to decline
3784 this and subsequent queries.
3786 If SYM is already bound to a non-nil value, this function may
3787 return automatically without querying the user. If SYM is !,
3788 return t; if SYM is q or ESC, return nil.
3793 Compress or uncompress marked (or next ARG) files.
3798 Byte compile marked (or next ARG) Emacs Lisp files.
3803 Load the marked (or next ARG) Emacs Lisp files.
3808 Redisplay all marked (or next ARG) files.
3809 If on a subdir line, redisplay that subdirectory. In that case,
3810 a prefix arg lets you edit the `ls' switches used for the new listing.
3812 Dired remembers switches specified with a prefix arg, so that reverting
3813 the buffer will not reset them. However, using `dired-undo' to re-insert
3814 or delete subdirectories can bypass this machinery. Hence, you sometimes
3815 may have to reset some subdirectory switches after a `dired-undo'.
3816 You can reset all subdirectory switches to the default using
3818 See Info node `(emacs)Subdir switches' for more details.
3823 Not documented
3828 Not documented
3833 Create or update the line for FILE in all Dired buffers it would belong in.
3838 Not documented
3843 Not documented
3848 Create a directory called DIRECTORY.
3853 Copy all marked (or next ARG) files, or copy the current file.
3854 This normally preserves the last-modified date when copying.
3855 When operating on just the current file, you specify the new name.
3856 When operating on multiple or marked files, you specify a directory,
3857 and new copies of these files are made in that directory
3858 with the same names that the files currently have. The default
3859 suggested for the target directory depends on the value of
3860 `dired-dwim-target', which see.
3862 This command copies symbolic links by creating new ones,
3863 like `cp -d'.
3868 Make symbolic links to current file or all marked (or next ARG) files.
3869 When operating on just the current file, you specify the new name.
3870 When operating on multiple or marked files, you specify a directory
3871 and new symbolic links are made in that directory
3872 with the same names that the files currently have. The default
3873 suggested for the target directory depends on the value of
3874 `dired-dwim-target', which see.
3881 Add names (hard links) current file or all marked (or next ARG) files.
3882 When operating on just the current file, you specify the new name.
3883 When operating on multiple or marked files, you specify a directory
3884 and new hard links are made in that directory
3885 with the same names that the files currently have. The default
3886 suggested for the target directory depends on the value of
3887 `dired-dwim-target', which see.
3892 Rename current file or all marked (or next ARG) files.
3893 When renaming just the current file, you specify the new name.
3894 When renaming multiple or marked files, you specify a directory.
3895 This command also renames any buffers that are visiting the files.
3896 The default suggested for the target directory depends on the value
3897 of `dired-dwim-target', which see.
3902 Rename selected files whose names match REGEXP to NEWNAME.
3904 With non-zero prefix argument ARG, the command operates on the next ARG
3905 files. Otherwise, it operates on all the marked files, or the current
3906 file if none are marked.
3908 As each match is found, the user must type a character saying
3911 REGEXP defaults to the last regexp used.
3913 With a zero prefix arg, renaming by regexp affects the absolute file name.
3914 Normally, only the non-directory part of the file name is used and changed.
3919 Copy selected files whose names match REGEXP to NEWNAME.
3920 See function `dired-do-rename-regexp' for more info.
3925 Hardlink selected files whose names match REGEXP to NEWNAME.
3926 See function `dired-do-rename-regexp' for more info.
3931 Symlink selected files whose names match REGEXP to NEWNAME.
3932 See function `dired-do-rename-regexp' for more info.
3937 Rename all marked (or next ARG) files to upper case.
3942 Rename all marked (or next ARG) files to lower case.
3947 Insert this subdirectory into the same dired buffer.
3949 else inserts it at its natural place (as `ls -lR' would have done).
3950 With a prefix arg, you may edit the ls switches used for this listing.
3951 You can add `R' to the switches to expand the whole tree starting at
3952 this subdirectory.
3953 This function takes some pains to conform to `ls -lR' output.
3955 Dired remembers switches specified with a prefix arg, so that reverting
3956 the buffer will not reset them. However, using `dired-undo' to re-insert
3957 or delete subdirectories can bypass this machinery. Hence, you sometimes
3958 may have to reset some subdirectory switches after a `dired-undo'.
3959 You can reset all subdirectory switches to the default using
3961 See Info node `(emacs)Subdir switches' for more details.
3966 Insert this subdirectory into the same dired buffer.
3967 If it is already present, overwrites previous entry,
3968 else inserts it at its natural place (as `ls -lR' would have done).
3969 With a prefix arg, you may edit the `ls' switches used for this listing.
3970 You can add `R' to the switches to expand the whole tree starting at
3971 this subdirectory.
3972 This function takes some pains to conform to `ls -lR' output.
3977 Go to previous subdirectory, regardless of level.
3978 When called interactively and not on a subdir line, go to this subdir's line.
3983 Go to end of header line of DIR in this dired buffer.
3984 Return value of point on success, otherwise return nil.
3990 Mark all files except `.' and `..' in current subdirectory.
3991 If the Dired buffer shows multiple directories, this command
3992 marks the files listed in the subdirectory that point is in.
3997 Remove all lines of current subdirectory.
3998 Lower levels are unaffected.
4003 Go up ARG levels in the dired tree.
4008 Go down in the dired tree.
4013 Hide or unhide the current subdirectory and move to next directory.
4014 Optional prefix arg is a repeat factor.
4020 Hide all subdirectories, leaving only their header lines.
4021 If there is already something hidden, make everything visible again.
4027 Set up isearch to search in Dired file names.
4028 Intended to be added to `isearch-mode-hook'.
4033 Search for a string using Isearch only in file names in the Dired buffer.
4038 Search for a regexp using Isearch only in file names in the Dired buffer.
4043 Search for a string through all marked files using Isearch.
4048 Search for a regexp through all marked files using Isearch.
4053 Search through all marked files for a match for REGEXP.
4054 Stops when a match is found.
4060 Do `query-replace-regexp' of FROM with TO, on all marked files.
4061 Third arg DELIMITED (prefix arg) means replace only word-delimited matches.
4068 Print the type of FILE, according to the `file' command.
4069 If FILE is a symbolic link and the optional argument DEREF-SYMLINKS is
4070 true then the type of the file linked to by FILE is printed instead.
4074 ;;;***
4075 \f
4076 ;;;### (autoloads (dired-do-relsymlink dired-jump) "dired-x" "dired-x.el"
4077 ;;;;;; "86d436093caa9ae80f7b73915c6a4b4c")
4078 ;;; Generated autoloads from dired-x.el
4081 Jump to dired buffer corresponding to current buffer.
4082 If in a file, dired the current directory and move to file's line.
4083 If in Dired already, pop up a level and goto old directory's line.
4084 In case the proper dired file line cannot be found, refresh the dired
4085 buffer and try again.
4086 When OTHER-WINDOW is non-nil, jump to dired buffer in other window.
4087 Interactively with prefix argument, read FILE-NAME and
4088 move to its line in dired.
4093 Relative symlink all marked (or next ARG) files into a directory.
4094 Otherwise make a relative symbolic link to the current file.
4095 This creates relative symbolic links like
4097 foo -> ../bar/foo
4099 not absolute ones like
4101 foo -> /ugly/file/name/that/may/change/any/day/bar/foo
4107 ;;;***
4108 \f
4109 ;;; End of automatically extracted autoloads.
4115 ;;; dired.el ends here