| blob | 22470ea61e6c42b043e9fd262aa8507e21ccbea9 |
1 ;;; dired.el --- directory-browsing commands
3 ;; Copyright (C) 1985-1986, 1992-1997, 2000-2011
4 ;; Free Software Foundation, Inc.
6 ;; Author: Sebastian Kremer <sk@thp.uni-koeln.de>
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.
252 ;; Beware of "-l;reboot" etc. See bug#3230.
254 "Return non-nil if string SWITCHES does not look risky for dired."
268 ;; These regexps must be tested at beginning-of-line, but are also
269 ;; used to search for next matches, so neither omitting "^" nor
270 ;; replacing "^" by "\n" (to make it slightly faster) will work.
273 ;; "Regexp matching a marked line.
274 ;; Important: the match ends just after the marker."
276 ;; The [^:] part after "d" and "l" is to avoid confusion with the
277 ;; DOS/Windows-style drive letters in directory names, like in "d:/foo".
285 "-[-r][-w].[-r][-w][xs][-r][-w]."
291 ;; The subdirectory names in the next two lists are expanded.
293 "Association list of subdirectories and their buffer positions.
294 Each subdirectory has an element: (DIRNAME . STARTMARKER).
295 The order of elements is the reverse of the order in the buffer.
299 "Keeps track of which switches to use for inserted subdirectories.
307 "Regexp matching a maybe hidden subdirectory line in `ls -lR' output.
308 Subexpression 1 is the subdirectory proper, no trailing colon.
309 The match starts at the beginning of the line and ends after the end
314 "Faces used by Dired."
320 "Face used for directory headers."
328 "Face used for dired marks."
336 "Face used for marked files."
344 "Face used for flagged files."
351 ;; Inherit from font-lock-warning-face since with min-colors 8
352 ;; font-lock-comment-face is not colored any more.
354 "Face used to highlight a part of a buffer that needs user attention."
362 ;; Inherit from font-lock-comment-delimiter-face since with min-colors 8
363 ;; font-lock-comment-face is not colored any more.
365 "Face used to highlight permissions of group- and world-writable files."
373 "Face used for subdirectories."
381 "Face used for symbolic links."
389 "Face used for files suffixed with `completion-ignored-extensions'."
397 ;;
398 ;; Dired marks.
400 ;;
401 ;; We make heavy use of MATCH-ANCHORED, since the regexps don't identify the
402 ;; file name itself. We search for Dired defined regexps, and then use the
403 ;; Dired defined function `dired-move-to-filename' before searching for the
404 ;; simple regexp ".+". It is that regexp which matches the file name.
405 ;;
406 ;; Marked files.
409 ;;
410 ;; Flagged files.
413 ;; People who are paranoid about security would consider this more
414 ;; important than other things such as whether it is a directory.
415 ;; But we don't want to encourage paranoia, so our default
416 ;; should be what's most useful for non-paranoids. -- rms.
417 ;;; ;;
418 ;;; ;; Files that are group or world writable.
419 ;;; (list (concat dired-re-maybe-mark dired-re-inode-size
420 ;;; "\\([-d]\\(....w....\\|.......w.\\)\\)")
421 ;;; '(1 dired-warning-face)
422 ;;; '(".+" (dired-move-to-filename) nil (0 dired-warning-face)))
423 ;; However, we don't need to highlight the file name, only the
424 ;; permissions, to win generally. -- fx.
425 ;; Fixme: we could also put text properties on the permission
426 ;; fields with keymaps to frob the permissions, somewhat a la XEmacs.
433 ;;
434 ;; Subdirectories.
437 ;;
438 ;; Symbolic links.
441 ;;
442 ;; Files suffixed with `completion-ignored-extensions'.
444 ;; It is quicker to first find just an extension, then go back to the
445 ;; start of that file name. So we do this complex MATCH-ANCHORED form.
448 ;;
449 ;; Files suffixed with `completion-ignored-extensions'
450 ;; plus a character put in by -F.
456 ;; If the last character is not part of the filename,
457 ;; move back to the start of the filename
458 ;; so it can be fontified.
459 ;; Otherwise, leave point at the end of the line;
460 ;; that way, nothing is fontified.
464 ;;
465 ;; Explicitly put the default face on file names ending in a colon to
466 ;; avoid fontifying them as directory header.
469 ;;
470 ;; Directory headers.
472 )
476 \f
477 ;;; Macros must be defined before they are used, for the byte compiler.
480 "Mark all files for which PREDICATE evals to non-nil.
481 PREDICATE is evaluated on each line, with point at beginning of line.
482 MSG is a noun phrase for the type of files being marked.
483 It should end with a noun that can be pluralized by adding `s'.
484 Return value is the number of files marked, or nil if none were marked."
498 count
499 ,msg
507 distinguish-one-marked)
508 "Eval BODY with point on each marked line. Return a list of BODY's results.
509 If no marked file could be found, execute BODY on the current line.
510 ARG, if non-nil, specifies the files to use instead of the marked files.
511 If ARG is an integer, use the next ARG (or previous -ARG, if
512 ARG<0) files. In that case, point is dragged along. This is
513 so that commands on the next ARG (instead of the marked) files
514 can be chained easily.
515 For any other non-nil value of ARG, use the current file.
516 If optional third arg SHOW-PROGRESS evaluates to non-nil,
517 redisplay the dired buffer after each file is processed.
518 No guarantee is made about the position on the marked line.
519 BODY must ensure this itself if it depends on this.
520 Search starts at the beginning of the buffer, thus the car of the list
521 corresponds to the line nearest to the buffer's bottom. This
522 is also true for (positive and negative) integer values of ARG.
523 BODY should not be too long as it is expanded four times.
525 If DISTINGUISH-ONE-MARKED is non-nil, then if we find just one marked file,
526 return (t FILENAME) instead of (FILENAME)."
527 ;;
528 ;;Warning: BODY must not add new lines before point - this may cause an
529 ;;endless loop.
530 ;;This warning should not apply any longer, sk 2-Sep-1991 14:10.
537 ,arg
543 results))
544 ;; non-nil, non-integer ARG means use current file:
549 ;; remember position of next marked file before BODY
550 ;; can insert lines before the just found file,
551 ;; confusing us by finding the same marked file again
552 ;; and again and...
560 ;; move after last match
569 results
571 ;; save-excursion loses, again
575 "Return the marked files' names as list of strings.
576 The list is in the same order as the buffer, that is, the car is the
577 first marked file.
578 Values returned are normally absolute file names.
579 Optional arg LOCALP as in `dired-get-filename'.
580 Optional second argument ARG, if non-nil, specifies files near
581 point instead of marked files. It usually comes from the prefix
582 argument.
583 If ARG is an integer, use the next ARG files.
584 Any other non-nil value means to use the current file instead.
585 Optional third argument FILTER, if non-nil, is a function to select
586 some of the files--those for which (funcall FILTER FILENAME) is non-nil.
588 If DISTINGUISH-ONE-MARKED is non-nil, then if we find just one marked file,
589 return (t FILENAME) instead of (FILENAME).
590 Don't use that together with FILTER."
595 arg nil distinguish-one-marked)))
596 result)
599 all-of-them
604 result)))
605 \f
606 ;; The dired command
609 ;; For use in interactive.
613 dired-listing-switches))
614 ;; If a dialog is used, call `read-directory-name' so the
615 ;; dialog code knows we want directories. Some dialogs
616 ;; can only select directories or files when popped up,
617 ;; not both. If no dialog is used, call `read-file-name'
618 ;; because the user may want completion of file names for
619 ;; use in a wildcard pattern.
622 nil default-directory nil)
624 nil default-directory nil)))))
626 ;; We want to switch to a more sophisticated version of
627 ;; dired-read-dir-and-switches like the following, if there is a way
628 ;; to make it more intuitive. See bug#1285.
630 ;; (defun dired-read-dir-and-switches (str)
631 ;; ;; For use in interactive.
632 ;; (reverse
633 ;; (list
634 ;; (if current-prefix-arg
635 ;; (read-string "Dired listing switches: "
636 ;; dired-listing-switches))
637 ;; ;; If a dialog is about to be used, call read-directory-name so
638 ;; ;; the dialog code knows we want directories. Some dialogs can
639 ;; ;; only select directories or files when popped up, not both.
640 ;; (if (next-read-file-uses-dialog-p)
641 ;; (read-directory-name (format "Dired %s(directory): " str)
642 ;; nil default-directory nil)
643 ;; (let ((cie ()))
644 ;; (dolist (ext completion-ignored-extensions)
645 ;; (if (eq ?/ (aref ext (1- (length ext)))) (push ext cie)))
646 ;; (setq cie (concat (regexp-opt cie "\\(?:") "\\'"))
647 ;; (lexical-let* ((default (and buffer-file-name
648 ;; (abbreviate-file-name buffer-file-name)))
649 ;; (cie cie)
650 ;; (completion-table
651 ;; ;; We need a mix of read-file-name and
652 ;; ;; read-directory-name so that completion to directories
653 ;; ;; is preferred, but if the user wants to enter a global
654 ;; ;; pattern, he can still use completion on filenames to
655 ;; ;; help him write the pattern.
656 ;; ;; Essentially, we want to use
657 ;; ;; (completion-table-with-predicate
658 ;; ;; 'read-file-name-internal 'file-directory-p nil)
659 ;; ;; but that doesn't work because read-file-name-internal
660 ;; ;; does not obey its `predicate' argument.
661 ;; (completion-table-in-turn
662 ;; (lambda (str pred action)
663 ;; (let ((read-file-name-predicate
664 ;; (lambda (f)
665 ;; (and (not (member f '("./" "../")))
666 ;; ;; Hack! Faster than file-directory-p!
667 ;; (eq (aref f (1- (length f))) ?/)
668 ;; (not (string-match cie f))))))
669 ;; (complete-with-action
670 ;; action 'read-file-name-internal str nil)))
671 ;; 'read-file-name-internal)))
672 ;; (minibuffer-with-setup-hook
673 ;; (lambda ()
674 ;; (setq minibuffer-default default)
675 ;; (setq minibuffer-completion-table completion-table))
676 ;; (read-file-name (format "Dired %s(directory): " str)
677 ;; nil default-directory nil))))))))
680 "Try to get a file name at point in the current dired buffer.
681 This hook is inteneded to be put in `file-name-at-point-functions'."
688 ;;;###autoload (define-key ctl-x-map "d" 'dired)
689 ;;;###autoload
692 Optional second argument SWITCHES specifies the `ls' options used.
693 \(Interactively, use a prefix argument to be able to specify SWITCHES.)
694 Dired displays a list of files in DIRNAME (which may also have
695 shell wildcards appended to select certain files). If DIRNAME is a cons,
696 its first element is taken as the directory name and the rest as an explicit
697 list of files to make directory entries for.
699 You can move around in it with the usual commands.
704 If DIRNAME is already in a dired buffer, that buffer is used without refresh."
705 ;; Cannot use (interactive "D") because of wildcards.
709 ;;;###autoload (define-key ctl-x-4-map "d" 'dired-other-window)
710 ;;;###autoload
716 ;;;###autoload (define-key ctl-x-5-map "d" 'dired-other-frame)
717 ;;;###autoload
723 ;;;###autoload
725 "Like `dired' but returns the dired buffer as value, does not select it."
727 ;; This loses the distinction between "/foo/*/" and "/foo/*" that
728 ;; some shells make:
739 ;; If the argument was syntactically a directory name not a file name,
740 ;; or if it happens to name a file that is a directory,
741 ;; convert it syntactically to a directory name.
742 ;; The reason for checking initially-was-dirname
743 ;; and not just file-directory-p
744 ;; is that file-directory-p is slow over ftp.
752 ;; The following is an internal dired function. It returns non-nil if
753 ;; the directory visited by the current dired buffer has changed on
754 ;; disk. DIRNAME should be the directory name of that directory.
763 "Return non-nil if current dired buffer needs updating.
764 If NOCONFIRM is non-nil, then this function always returns nil
765 for a remote directory. This feature is used by Auto Revert Mode."
771 ;; Do not auto-revert when the dired buffer can be currently
772 ;; written by the user as in `wdired-mode'.
773 buffer-read-only
777 "Automatically revert dired buffer on revisiting.
778 If t, revisiting an existing dired buffer automatically reverts it.
779 If its value is a function, call this function with the directory
780 name as single argument and revert the buffer if it returns non-nil.
781 Otherwise, a message offering to revert the changed dired buffer
782 is displayed.
783 Note that this is not the same as `auto-revert-mode' that
784 periodically reverts at specified time intervals."
794 ;; If there is an existing dired buffer for DIRNAME, just leave
795 ;; buffer as it is (don't even call dired-revert).
796 ;; This saves time especially for deep trees or with ange-ftp.
797 ;; The user can type `g' easily, and it is more consistent with find-file.
798 ;; But if SWITCHES are given they are probably different from the
799 ;; buffer's old value, so call dired-sort-other, which does
800 ;; revert the buffer.
801 ;; A pity we can't possibly do "Directory has changed - refresh? "
802 ;; like find-file does.
803 ;; Optional argument MODE is passed to dired-find-buffer-nocreate,
804 ;; see there.
807 ;; Look for an existing buffer.
809 ;; Note that buffer already is in dired-mode, if found.
816 ;; file list may have changed
818 ;; this calls dired-revert
820 ;; Always revert regardless of whether it has changed or not.
823 ;; Revert when predicate function returns non-nil.
828 ;; If directory has changed on disk, offer to revert.
833 ;; Else a new buffer
835 ;; We can do this unconditionally
836 ;; because dired-noselect ensures that the name
837 ;; is passed in directory name syntax
838 ;; if it was the name of a directory at all.
843 ;; default-directory and dired-actual-switches are set now
844 ;; (buffer-local), so we can call dired-readin:
849 ;; dired-readin can fail if parent directories are inaccessible.
850 ;; Don't leave an empty buffer around in that case.
855 buffer))
858 ;; Enlarged by dired-advertise
859 ;; Queried by function dired-buffers-for-dir. When this detects a
860 ;; killed buffer, it is removed from this list.
865 ;; FIXME add a doc-string, and document dired-x extensions.
867 ;; This differs from dired-buffers-for-dir in that it does not consider
868 ;; subdirs of default-directory and searches for the first match only.
869 ;; Also, the major mode must be MODE.
871 dired-find-subdir
872 ;; Don't try to find a wildcard as a subdirectory.
878 ;; Wildcards must match, too:
880 ;; We don't want to switch to the same buffer---
883 ;; ---unless it's the only possibility:
885 ;; No dired-x, or dired-find-subdir nil.
894 dired-directory ;; nil during find-alternate-file
899 dired-directory))))
901 blist nil)
903 found)))
905 \f
906 ;; Read in a new dired buffer
909 "Read in a new dired buffer.
910 Differs from `dired-insert-subdir' in that it accepts
911 wildcards, erases the buffer, and builds the subdir-alist anew
912 \(including making it buffer-local and clearing it first)."
914 ;; default-directory and dired-actual-switches must be buffer-local
915 ;; and initialized by now.
917 ;; This makes readin much much faster.
918 ;; In particular, it prevents the font lock hook from running
919 ;; until the directory is all read in.
926 ;; This hook which may want to modify dired-actual-switches
927 ;; based on dired-directory, e.g. with ange-ftp to a SysV host
928 ;; where ls won't understand -Al switches.
936 ;; Don't make undo entries for readin.
942 ;; Must first make alist buffer local and set it to nil because
943 ;; dired-build-subdir-alist will call dired-clear-alist first
950 ;; No need to narrow since the whole buffer contains just
951 ;; dired-readin's output, nothing else. The hook can
952 ;; successfully use dired functions (e.g. dired-get-filename)
953 ;; as the subdir-alist has been built in dired-readin.
956 ;; Subroutines of dired-readin
959 ;; Insert listing for the specified dir (and maybe file list)
960 ;; already in dired-directory, assuming a clean buffer.
966 file-list nil))
970 ;; If we are reading a whole single directory...
975 ;; Else treat it as a wildcard spec
976 ;; unless we have an explicit list of files.
981 "Align the fields of a file to the ones of surrounding lines.
982 BEG..END is the line where the file info is located."
983 ;; Some versions of ls try to adjust the size of each field so as to just
984 ;; hold the largest element ("largest" in the current invocation, of
985 ;; course). So when a single line is output, the size of each field is
986 ;; just big enough for that one output. Thus when dired refreshes one
987 ;; line, the alignment if this line w.r.t the rest is messed up because
988 ;; the fields of that one line will generally be smaller.
989 ;;
990 ;; To work around this problem, we here add spaces to try and
991 ;; re-align the fields as needed. Since this is purely aesthetic,
992 ;; it is of utmost importance that it doesn't mess up anything like
993 ;; `dired-move-to-filename'. To this end, we limit ourselves to
994 ;; adding spaces only, and to only add them at places where there
995 ;; was already at least one space. This way, as long as
996 ;; `directory-listing-before-filename-regexp' always matches spaces
997 ;; with "*" or "+", we know we haven't made anything worse. There
998 ;; is one spot where the exact number of spaces is important, which
999 ;; is just before the actual filename, so we refrain from adding
1000 ;; spaces there (and within the filename as well, of course).
1003 ;; Check that there is indeed a file, and that there is anoter adjacent
1004 ;; file with which to align, and that additional spaces are needed to
1005 ;; align the filenames.
1018 ;; Make sure there is some work left to do.
1020 ;; If we've only looked at the line above, check to see if the line
1021 ;; below exists as well and if so, align with the shorter one.
1030 ;; Keep positions uptodate when we insert stuff.
1033 ;; Main loop.
1037 ;; Don't touch anything just before (and after) the
1038 ;; beginning of the filename.
1040 ;; We're now just in front of a field, with a space behind us.
1042 ;; Nums are right-aligned.
1044 ;; Let's look at the other line, in the same column: we
1045 ;; should be either near the end of the previous field, or
1046 ;; in the space between that field and the next.
1047 ;; [ Of course, it's also possible that we're already within
1048 ;; the next field or even past it, but that's unlikely since
1049 ;; other-col > file-col. ]
1050 ;; Let's find the distance to the alignment-point (either
1051 ;; the beginning or the end of the next field, depending on
1052 ;; whether this field is left or right aligned).
1062 ;; Now, the number of spaces to insert is align-pt-offset
1063 ;; minus the distance to the equivalent point on the
1064 ;; current line.
1067 align-pt-offset
1077 ;; Let's just make really sure we did not mess up.
1080 ;; Damn! We messed up: let's revert the change.
1082 ;; Now skip to next field.
1090 "Insert a directory listing of DIR, Dired style.
1091 Use SWITCHES to make the listings.
1092 If FILE-LIST is non-nil, list only those files.
1093 Otherwise, if WILDCARD is non-nil, expand wildcards;
1094 in that case, DIR should be a file name that uses wildcards.
1095 In other cases, DIR should be a directory name or a directory filename.
1096 If HDR is non-nil, insert a header line with the directory name."
1099 end)
1101 ;; Don't try to invoke `ls' if we are on DOS/Windows where
1102 ;; ls-lisp emulation is used, except if they want to use `ls'
1103 ;; as indicated by `ls-lisp-use-insert-directory-program'.
1107 ;; Check whether "ls --dired" gives exit code 0, and
1108 ;; save the answer in `dired-use-ls-dired'.
1112 dired-use-ls-dired)
1115 ;; We used to specify the C locale here, to force English month names;
1116 ;; but this should not be necessary any more,
1117 ;; with the new value of `directory-listing-before-filename-regexp'.
1122 ;; Re-align fields, if necessary.
1125 ;; Quote certain characters, unless ls quoted them for us.
1134 nil t))
1140 nil t))
1143 ;; If we used --dired and it worked, the lines are already indented.
1144 ;; Otherwise, indent them.
1150 ;; Insert text at the beginning to standardize things.
1156 ;; Note that dired-build-subdir-alist will replace the name
1157 ;; by its expansion, so it does not matter whether what we insert
1158 ;; here is fully expanded, but it should be absolute.
1161 ;; Insert "wildcard" line where "total" line would be for a full dir.
1165 "Make the file names highlight when the mouse is on them."
1177 dired-filename t
1181 \f
1182 ;; Reverting a dired buffer
1185 "Reread the dired buffer.
1186 Must also be called after `dired-actual-switches' have changed.
1187 Should not fail even on completely garbaged buffers.
1188 Preserves old cursor, marks/flags, hidden-p.
1190 Dired sets `revert-buffer-function' to this function. The args
1191 ARG and NOCONFIRM, passed from `revert-buffer', are ignored."
1203 ;; treat top level dir extra (it may contain wildcards)
1210 ;; Run dired-after-readin-hook just once, below.
1215 ;; ... run the hook for the whole buffer, and only after markers
1216 ;; have been reinserted (else omitting in dired-x would omit marked files)
1224 ;; outside of the let scope
1225 ;;; Might as well not override the user if the user changed this.
1226 ;;; (setq buffer-read-only t)
1227 )
1229 ;; Subroutines of dired-revert
1230 ;; Some of these are also used when inserting subdirs.
1233 "Return current positions in the buffer and all windows with this directory.
1234 The positions have the form (BUFFER-POSITION WINDOW-POSITIONS).
1236 BUFFER-POSITION is the point position in the current dired buffer.
1237 It has the form (BUFFER DIRED-FILENAME BUFFER-POINT).
1239 WINDOW-POSITIONS are current positions in all windows displaying
1240 this dired buffer. The window positions have the form (WINDOW
1241 DIRED-FILENAME WINDOW-POINT)."
1252 "Restore POSITIONS saved with `dired-save-positions'."
1260 ;; Ensure that window still displays the original buffer.
1269 "Return alist of files and their marks, from BEG to END."
1280 alist))
1283 "Mark all files remembered in ALIST.
1284 Each element of ALIST looks like (FILE . MARKERCHAR)."
1298 "Return a list of names of subdirs currently hidden."
1308 result))
1311 "Try to insert all subdirs that were displayed before.
1312 Do so according to the former subdir alist OLD-SUBDIR-ALIST."
1326 "Remove directory DIR from any directory cache."
1330 \f
1331 ;; dired mode key bindings and initialization
1334 ;; This looks ugly when substitute-command-keys uses C-d instead d:
1335 ;; (define-key dired-mode-map "\C-d" 'dired-flag-file-deletion)
1340 ;; Commands to mark or flag certain categories of files
1344 ;; Upper case keys (except !) for operating on the marked files
1363 ;; Comparison commands
1366 ;; Tree Dired commands
1372 ;; move to marked files
1375 ;; Make all regexp commands share a `%' prefix:
1376 ;; We used to get to the submap via a symbol dired-regexp-prefix,
1377 ;; but that seems to serve little purpose, and copy-keymap
1378 ;; does a better job without it.
1391 ;; Commands for marking and unmarking.
1408 ;; Lower keys for commands not operating on all the marked files
1433 ;; moving
1440 ;; hiding
1443 ;; isearch
1448 ;; misc
1454 ;; thumbnail manipulation (image-dired)
1467 ;; encryption and decryption (epa-dired)
1473 ;; Make menu bar items.
1475 ;; No need to fo this, now that top-level items are fewer.
1476 ;;;;
1477 ;; Get rid of the Edit menu bar item to save space.
1478 ;(define-key map [menu-bar edit] 'undefined)
1583 ;; When running on plain MS-DOS, there's only one
1584 ;; letter-case for file names.
1772 map)
1774 \f
1775 ;; Dired mode is suitable only for specially formatted data.
1778 ;; Autoload cookie needed by desktop.el
1779 ;;;###autoload
1781 "\
1784 \(optionally) its subdirectories, in the format of `ls -lR'.
1787 compress, load or byte-compile them, change their file attributes
1790 by file or all files matching certain criteria.
1792 Letters no longer insert themselves. Digits are prefix arguments.
1795 Most commands operate on the marked files and use the current file
1796 if no files are marked. Use a numeric prefix argument to operate on
1797 the next ARG (or previous -ARG if ARG<0) files, or just `1'
1798 to operate on the current file only. Prefix arguments override marks.
1800 to see why something went wrong.
1805 (or dired it in another buffer, if it is a directory).
1812 This retains all marks and hides subdirs again that were hidden before.
1813 SPC and DEL can be used to move down and up by lines.
1816 to read the
1818 to relist a single or the marked files or a
1820 again for the directory tree.
1823 for more info):
1825 `dired-listing-switches'
1826 `dired-trivial-filenames'
1827 `dired-shrink-to-fit'
1828 `dired-marker-char'
1829 `dired-del-marker'
1830 `dired-keep-marker-rename'
1831 `dired-keep-marker-copy'
1832 `dired-keep-marker-hardlink'
1833 `dired-keep-marker-symlink'
1837 `dired-before-readin-hook'
1838 `dired-after-readin-hook'
1839 `dired-mode-hook'
1840 `dired-load-hook'
1842 Keybindings:
1844 ;; Not to be called interactively (e.g. dired-directory will be set
1845 ;; to default-directory, which is wrong with wildcards).
1850 mode-name "Dired"
1851 ;; case-fold-search nil
1852 buffer-read-only t
1853 selective-display t ; for subdirectory hiding
1854 mode-line-buffer-identification
1864 ;; list-buffers uses this to display the dir being edited in this buffer.
1868 dired-directory)))
1884 \f
1885 ;; Idiosyncratic dired commands that don't deal with marks.
1888 "Summarize basic Dired commands and show recent dired errors."
1891 ;>> this should check the key-bindings and use substitute-command-keys if non-standard
1896 "Undo in a dired buffer.
1897 This doesn't recover lost files, it just undoes changes in the buffer itself.
1898 You can use it to recover marks, killed lines or subdirs."
1907 "Edit dired buffer with Wdired, or set it read-only.
1908 Call `wdired-change-to-wdired-mode' in dired buffers whose editing is
1909 supported by Wdired (the major mode of the dired buffer is `dired-mode').
1910 Otherwise, for buffers inheriting from dired-mode, call `toggle-read-only'."
1917 "Move down lines then position at filename.
1918 Optional prefix ARG says how many lines to move; default is one line."
1924 "Move up lines then position at filename.
1925 Optional prefix ARG says how many lines to move; default is one line."
1931 "Goto ARG'th next directory file line."
1943 "Goto ARG'th previous directory file line."
1948 "Run Dired on parent directory of current directory.
1949 Find the parent directory either in this buffer or another buffer.
1950 Creates a buffer if necessary."
1955 ;; Only try dired-goto-subdir if buffer has more than one dir.
1965 "Get the current line's file name, with an error if file does not exist."
1967 ;; We pass t for second arg so that we don't get error for `.' and `..'.
1969 file-name)
1974 file-name
1979 ;; Force C-m keybinding rather than `f' or `e' in the mode doc:
1982 "In Dired, visit the file or directory named on this line."
1984 ;; Bind `find-file-run-dired' so that the command works on directories
1985 ;; too, independent of the user's setting.
1990 "In Dired, visit this file or directory instead of the dired buffer."
1994 ;; Don't override the setting from .emacs.
1995 ;;;###autoload (put 'dired-find-alternate-file 'disabled t)
1998 "In Dired, visit the file or directory name you click on."
2019 "In Dired, examine a file in view mode, returning to Dired when done.
2020 When file is a directory, show it in this buffer if it is inserted.
2021 Otherwise, display it in another buffer."
2031 "In Dired, visit this file or directory in another window."
2036 "In Dired, display this file or directory in another window."
2039 \f
2040 ;;; Functions for extracting and manipulating file names in Dired buffers.
2043 "In Dired, return name of file mentioned on this line.
2044 Value returned normally includes the directory name.
2045 Optional arg LOCALP with value `no-dir' means don't include directory
2046 name in result. A value of `verbatim' means to return the name exactly as
2047 it occurs in the buffer, and a value of t means construct name relative to
2048 `default-directory', which still may contain slashes if in a subdirectory.
2049 Optional arg NO-ERROR-IF-NOT-FILEP means treat `.' and `..' as
2050 regular filenames and return nil if no filename on this line.
2051 Otherwise, an error occurs in these cases."
2056 ;; nil if no file on this line, but no-error-if-not-filep is t:
2059 ;; Get rid of the mouse-face property that file names have.
2061 ;; Unquote names quoted by ls or by dired-insert-directory.
2062 ;; This code was written using `read' to unquote, because
2063 ;; it's faster than substituting \007 (4 chars) -> ^G (1
2064 ;; char) etc. in a lisp loop. Unfortunately, this decision
2065 ;; has necessitated hacks such as dealing with filenames
2066 ;; with quotation marks in their names.
2078 ;; The above `read' will return a unibyte string if FILE
2079 ;; contains eight-bit-control/graphic characters.
2084 ;; A relative file name can start with ~.
2085 ;; Don't treat it as absolute in this context.
2090 nil)
2092 file)
2100 ;; check for safe-magic property so that we won't
2101 ;; put /: for names that don't really need them.
2102 ;; For instance, .gz files when auto-compression-mode is on.
2105 file)))
2107 file)
2111 ;; check for safe-magic property so that we won't
2112 ;; put /: for names that don't really need them.
2113 ;; For instance, .gz files when auto-compression-mode is on.
2116 file)))
2122 "Replace first match of REGEXP in STRING with NEWTEXT.
2123 If it does not match, nil is returned instead of the new string.
2124 Optional arg LITERAL means to take NEWTEXT literally.
2125 Optional arg GLOBAL means to replace all matches."
2132 ret)
2134 nil
2138 ;;"Convert FILE (a file name relative to DIR) to an absolute file name."
2139 ;; We can't always use expand-file-name as this would get rid of `.'
2140 ;; or expand in / instead default-directory if DIR=="".
2141 ;; This should be good enough for ange-ftp.
2142 ;; It should be reasonably fast, though, as it is called in
2143 ;; dired-get-filename.
2147 "Convert FILE (an absolute file name) to a name relative to DIR.
2148 If this is impossible, return FILE unchanged.
2149 DIR must be a directory name, not a file name."
2151 ;; This case comes into play if default-directory is set to
2152 ;; use ~.
2157 ;;; (or no-error
2158 ;;; (error "%s: not in directory tree growing at %s" file dir))
2159 file))
2160 \f
2161 ;;; Functions for finding the file name in a dired buffer line.
2167 ;; Move to first char of filename on this line.
2168 ;; Returns position (point) or nil if no filename on this line."
2170 "Move to the beginning of the filename on the current line.
2171 Return the position of the beginning of the filename, or nil if none found."
2172 ;; This is the UNIX version.
2175 ;; First try assuming `ls --dired' was used.
2183 ;; Ha! There *is* a file. Our regexp-from-hell just failed to find it.
2187 nil)
2192 ;; Assumes point is at beginning of filename,
2193 ;; thus the rwx bit re-search-backward below will succeed in *this*
2194 ;; line if at all. So, it should be called only after
2195 ;; (dired-move-to-filename t).
2196 ;; On failure, signals an error (with non-nil NO-ERROR just returns nil).
2197 ;; This is the UNIX version.
2201 ;; case-fold-search is nil now, so we can test for capital F:
2208 nil
2210 ;; Restrict perm bits to be non-blank,
2211 ;; otherwise this matches one char to early (looking backward):
2212 ;; "l---------" (some systems make symlinks that way)
2213 ;; "----------" (plain file with zero perms)
2215 dired-permission-flags-regexp nil t)
2218 ;; Only with -F we need to know whether it's an executable
2220 used-F
2228 ;; Move point to end of name:
2234 dired-ls-F-marks-symlinks
2238 ;; ls -lF marks dirs, sockets, fifos and executables with exactly
2239 ;; one trailing character. (Executable bits on symlinks ain't mean
2240 ;; a thing, even to ls, but we know it's not a symlink.)
2243 executable)
2252 nil
2255 \f
2256 ;;; COPY NAMES OF MARKED FILES INTO KILL-RING.
2259 "Copy names of marked (or next ARG) files into the kill ring.
2260 The names are separated by a space.
2261 With a zero prefix arg, use the absolute file name of each marked file.
2263 `default-directory'. (This still may contain slashes if in a subdirectory.)
2265 If on a subdir headerline, use absolute subdirname instead;
2266 prefix arg and marked files are ignored in this case.
2288 \f
2289 ;; Keeping Dired buffers in sync with the filesystem and with each other
2292 ;; Return a list of buffers for DIR (top level or in-situ subdir).
2293 ;; If FILE is non-nil, include only those whose wildcard pattern (if any)
2294 ;; matches FILE.
2295 ;; The list is in reverse order of buffer creation, most recent last.
2296 ;; As a side effect, killed dired buffers for DIR are removed from
2297 ;; dired-buffers.
2304 ;; Buffer is killed - clean up:
2312 dired-directory)))
2315 file)))
2319 result))
2322 "Convert glob-pattern PATTERN to a regular expression."
2324 regexp)
2336 ;; Fails to handle ^ yet ????
2350 regexp
2358 ;;"Advertise in variable `dired-buffers' that we dired `default-directory'."
2359 ;; With wildcards we actually advertise too much.
2362 t ; we have already advertised ourselves
2365 dired-buffers)))))
2368 ;; Remove DIR from the buffer alist in variable dired-buffers.
2369 ;; This has the effect of removing any buffer whose main directory is DIR.
2370 ;; It does not affect buffers in which DIR is a subdir.
2371 ;; Removing is also done as a side-effect in dired-buffer-for-dir.
2374 \f
2375 ;; Tree Dired
2377 ;;; utility functions
2380 ;;"Is FILE part of the directory tree starting at DIR?"
2385 ;; Prepend default-directory to DIR if relative file name.
2386 ;; dired-get-filename must be able to make a valid file name from a
2387 ;; file and its directory DIR.
2390 dir
2394 ;;"Return the subdir name on this line, or nil if not on a headerline."
2395 ;; Look up in the alist whether this is a headerline.
2401 dired-subdir-alist))))
2402 cur-dir))))
2404 ;(defun dired-get-subdir-min (elt)
2405 ; (cdr elt))
2406 ;; can't use macro, must be redefinable for other alist format in dired-nstd.
2420 ;; Return an index into alist for use with nth
2421 ;; for the sake of subdir moving commands.
2430 "Go to next subdirectory, regardless of level."
2431 ;; Use 0 arg to go to this directory's header line.
2432 ;; NO-SKIP prevents moving to end of header line, returning whatever
2433 ;; position was found in dired-subdir-alist.
2436 pos index)
2437 ;; nth with negative arg does not return nil but the first element
2447 nil ; return nil if not found
2451 "Build `dired-subdir-alist' by parsing the buffer.
2452 Returns the new value of the alist.
2453 If optional arg SWITCHES is non-nil, use its value
2454 instead of `dired-actual-switches'."
2462 new-dir-name
2464 ;; Used to expand subdirectory names correctly in recursive
2465 ;; ange-ftp listings.
2472 ;; Avoid taking a file name ending in a colon
2473 ;; as a subdir name.
2483 new-dir-name
2495 ;; Place a sub directory boundary between lines.
2502 ;; We don't need to sort it because it is in buffer order per
2503 ;; constructionem. Return new alist:
2504 dired-subdir-alist))
2507 ;; Add new DIR at NEW-MARKER. Don't sort.
2510 dired-subdir-alist)))
2513 ;; Position point on first nontrivial file after point.
2529 "Go to line describing file FILE in this dired buffer."
2530 ;; Return value of point on success, else nil.
2531 ;; FILE must be an absolute file name.
2532 ;; Loses if FILE contains control chars like "\007" for which ls
2533 ;; either inserts "?" or "\\007" into the buffer, so we won't find
2534 ;; it in the buffer.
2546 ;; The hair here is to get the result of dired-goto-subdir
2547 ;; without really calling it if we don't have any subdirs.
2553 search-string
2560 ;; filenames are preceded by SPC, this makes
2561 ;; the search faster (e.g. for the filename "-"!).
2564 ;; Match could have BASE just as initial substring or
2565 ;; or in permission bits or date or
2566 ;; not be a proper filename at all:
2568 ;; Must move to filename since an (actually
2569 ;; correct) match could have been elsewhere on the
2570 ;; ;; line (e.g. "-" would match somewhere in the
2571 ;; permission bits).
2573 ;; If this isn't the right line, move forward to avoid
2574 ;; trying this line again.
2577 ;; return value of point (i.e., FOUND):
2582 ;; FIXME document whatever dired-x is doing.
2584 "Where point should go in a new listing of DIRNAME.
2585 Point assumed at beginning of new subdir line."
2590 \f
2591 ;; These are hooks which make tree dired work.
2592 ;; They are in this file because other parts of dired need to call them.
2593 ;; But they don't call the rest of tree dired unless there are subdirs loaded.
2595 ;; This function is called for each retrieved filename.
2596 ;; It could stand to be faster, though it's mostly function call
2597 ;; overhead. Avoiding the function call seems to save about 10% in
2598 ;; dired-get-filename. Make it a defsubst?
2600 "Return the name of the subdirectory to which this line belongs.
2601 This returns a string with trailing slash, like `default-directory'.
2602 Optional argument means return a file name relative to `default-directory'."
2605 ;; probably because called in a non-dired buffer
2607 elt dir)
2611 ;; use `<=' (not `<') as subdir line is part of subdir
2613 nil ; found
2617 dir)))
2619 ;; Subdirs start at the beginning of their header lines and end just
2620 ;; before the beginning of the next header line (or end of buffer).
2627 \f
2628 ;; Deleting files
2631 "Decide whether recursive deletes are allowed.
2632 A value of nil means no recursive deletes.
2633 `always' means delete recursively without asking. This is DANGEROUS!
2634 `top' means ask for each directory at top level, but delete its subdirectories
2635 without asking.
2636 Anything else means ask for each directory."
2644 ;; Match anything but `.' and `..'.
2647 ;; Delete file, possibly delete a directory and all its files.
2648 ;; This function is usefull outside of dired. One could change it's name
2649 ;; to e.g. recursive-delete-file and put it somewhere else.
2651 Delete FILE or directory (possibly recursively if optional RECURSIVE is true.)
2652 RECURSIVE determines what to do with a non-empty directory. If RECURSIVE is:
2653 nil, do not delete.
2654 `always', delete recursively without asking.
2655 `top', ask for each directory at top level.
2656 Anything else, ask for each sub-directory."
2657 ;; This test is equivalent to
2658 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
2659 ;; but more efficient
2667 delete-by-moving-to-trash)
2668 "trash"
2676 "In Dired, delete the files flagged for deletion.
2677 If NOMESSAGE is non-nil, we don't display any message
2678 if there are no flagged files.
2679 `dired-recursive-deletes' controls whether deletion of
2680 non-empty directories is allowed."
2684 case-fold-search)
2688 ;; this can't move point since ARG is nil
2690 nil)
2691 nil t)
2696 "Delete all marked (or next ARG) files.
2697 `dired-recursive-deletes' controls whether deletion of
2698 non-empty directories is allowed."
2699 ;; This is more consistent with the file marking feature than
2700 ;; dired-do-flagged-delete.
2703 ;; this may move point if ARG is an integer
2705 arg)
2706 arg t))
2711 ;; L is an alist of files to delete, with their buffer positions.
2712 ;; ARG is the prefix arg.
2713 ;; Filenames are absolute.
2714 ;; (car L) *must* be the *last* (bottommost) file in the dired buffer.
2715 ;; That way as changes are made in the buffer they do not shift the
2716 ;; lines still to be changed, so the (point) values in L stay valid.
2717 ;; Also, for subdirs in natural order, a subdir's files are deleted
2718 ;; before the subdir itself - the other way around would not work.
2726 succ count)))
2727 ;; canonicalize file list for pop up
2742 ;; if we get here, removing worked
2758 failures))))
2763 ;; In all buffers dired'ing DIRECTORY, run FUN with ARGS.
2764 ;; If the buffer has a wildcard pattern, check that it matches FILE.
2765 ;; (FILE does not include a directory component.)
2766 ;; FILE may be nil, in which case ignore it.
2767 ;; Return list of buffers where FUN succeeded (i.e., returned non-nil).
2770 file))
2774 success-list))
2776 ;; Delete the entry for FILE from
2788 "Clean up after a deleted file or directory FN.
2789 Removes any expanded subdirectory of deleted directory.
2790 If `dired-x' is loaded and `dired-clean-up-buffers-too' is non-nil,
2791 also offers to kill buffers visiting deleted files and directories."
2795 ;; Offer to kill buffer of deleted file FN.
2811 \f
2812 ;; Confirmation
2821 "Return a string for use in a prompt, either the current file
2822 name, or the marker and a count of marked files."
2823 ;; distinguish-one-marked can cause the first element to be just t.
2828 ;; more than 1 file:
2830 ;; abs(arg) = count
2831 ;; Perhaps this is nicer, but it also takes more screen space:
2832 ;;(format "[%s %d files]" (if (> arg 0) "next" "previous")
2833 ;; count)
2838 "Pop up buffer BUF in a way suitable for Dired."
2843 ;; Try to split the selected window vertically if
2844 ;; that's possible. (Bug#1806)
2846 ;; Otherwise, try to split WINDOW sensibly.
2848 pop-up-frames)
2850 ;; If dired-shrink-to-fit is t, make its window fit its contents.
2852 ;; Try to not delete window when we want to display less than
2853 ;; `window-min-height' lines.
2857 "A list of symbols for commands Dired should not confirm, or t.
2858 Command symbols are `byte-compile', `chgrp', `chmod', `chown', `compress',
2859 `copy', `delete', `hardlink', `load', `move', `print', `shell', `symlink',
2860 `touch' and `uncompress'.
2861 If t, confirmation is never needed."
2872 "Return FUNCTION's result on ARGS after showing which files are marked.
2873 Displays the file names in a buffer named BUFNAME;
2875 This uses function `dired-pop-to-buffer' to do that.
2877 FUNCTION should not manipulate files, just read input
2878 (an argument or confirmation).
2879 The window is not shown if there is just one file or
2880 OP-SYMBOL is a member of the list in `dired-no-confirm'.
2881 FILES is the list of marked files. It can also be (t FILENAME)
2882 in the case of one marked file, to distinguish that from using
2883 just the current file."
2887 ;; If FILES defaulted to the current line's file.
2892 ;; Handle (t FILE) just like (FILE), here.
2893 ;; That value is used (only in some cases), to mean
2894 ;; just one file that was marked, rather than the current line file.
2906 \f
2907 ;; Commands to mark or flag file(s) at or near current line.
2910 ;; This version skips non-file lines.
2921 ;; Advance to the next line--actually, to the line that *was* next.
2922 ;; (If FUNCTION inserted some new lines in between, skip them.)
2934 ;; This used to be a regexp match of the `total ...' line output by
2935 ;; ls, which is slightly faster, but that is not very robust; notably,
2936 ;; it fails for non-english locales.
2940 "Move to the next marked file, wrapping around the end of the buffer."
2957 "Move to the previous marked file, wrapping around the end of the buffer."
2962 ;; Return FILE's marker, or nil if unmarked.
2976 ;; Skip subdir line and following garbage like the `total' line:
2987 "Mark the current (or next ARG) files.
2988 If on a subdir headerline, mark all its files except `.' and `..'.
2992 this subdir."
3002 "Unmark the current (or next ARG) files.
3003 If looking at a subdir, unmark all its files except `.' and `..'."
3009 "In Dired, flag the current line's file for deletion.
3010 With prefix arg, repeat over several lines.
3012 If on a subdir headerline, mark all its files except `.' and `..'."
3018 "In Dired, move up lines and remove deletion flag there.
3019 Optional prefix ARG says how many lines to unflag; default is one line."
3024 "Toggle marks: marked files become unmarked, and vice versa.
3025 Files marked with other flags (such as `D') are not affected.
3026 `.' and `..' are never toggled.
3027 As always, hidden subdirs are not affected."
3035 ;; use subst instead of insdel because it does not move
3036 ;; the gap and thus should be faster and because
3037 ;; other characters are left alone automatically
3044 \f
3045 ;;; Commands to mark or flag files based on their characteristics or names.
3054 "Mark all files matching REGEXP for use in later commands.
3055 A prefix argument means to unmark them instead.
3056 `.' and `..' are never marked.
3059 object files--just `.o' will mark more than you might think."
3073 "Mark all files with contents containing REGEXP for use in later commands.
3074 A prefix argument means to unmark them instead.
3075 `.' and `..' are never marked."
3089 ;; For now we do it inside emacs
3090 ;; Grep might be better if there are a lot of files
3100 )))
3104 "In Dired, flag all files containing the specified REGEXP for deletion.
3105 The match is against the non-directory part of the filename. Use `^'
3106 and `$' to anchor matches. Exclude subdirs by hiding them.
3107 `.' and `..' are never flagged."
3112 "Mark all symbolic links.
3113 With prefix argument, unflag all those files."
3119 "Mark all directory file lines except `.' and `..'.
3120 With prefix argument, unflag all those files."
3128 "Mark all executable files.
3129 With prefix argument, unflag all those files."
3134 ;; dired-x.el has a dired-mark-sexp interactive command: mark
3135 ;; files for which PREDICATE returns non-nil.
3138 "Flag for deletion files whose names suggest they are auto save files.
3139 A prefix argument says to unflag those files instead."
3143 ;; It is less than general to check for # here,
3144 ;; but it's the only way this runs fast enough.
3148 ;; Handle executables in case of -F option.
3149 ;; We need not worry about the other kinds
3150 ;; of markings that -F makes, since they won't
3151 ;; appear on real auto-save files.
3163 ;; `log' here is dubious, since it's typically used for useful log
3164 ;; files, not just TeX stuff. -- fx
3173 "Flag for deletion all files that match `dired-garbage-files-regexp'."
3178 "Flag all backup files (names ending with `~') for deletion.
3179 With prefix argument, unflag these files."
3183 ;; Don't call backup-file-name-p unless the last character looks like
3184 ;; it might be the end of a backup file name. This isn't very general,
3185 ;; but it's the only way this runs fast enough.
3187 ;; Handle executables in case of -F option.
3188 ;; We need not worry about the other kinds
3189 ;; of markings that -F makes, since they won't
3190 ;; appear on real backup files.
3200 "Change all OLD marks to NEW marks.
3201 OLD and NEW are both characters used to mark files."
3218 t)
3223 "Remove all marks from all files in the dired buffer."
3228 "Remove a specific mark (or any mark) from every file.
3229 After this command, type the mark character to remove,
3230 or type RET to remove all marks.
3231 With prefix arg, query for each marked file.
3239 Type SPC or `y' to unmark one file, DEL or `n' to skip to next,
3249 file))))
3255 count))))
3256 \f
3257 ;; Logging failures operating on files, and showing the results.
3262 "Pop up a buffer with error log output from Dired.
3263 A group of errors from a single command ends with a formfeed.
3279 ;; Log a message or the contents of a buffer.
3280 ;; If LOG is a string and there are more args, it is formatted with
3281 ;; those ARGS. Usually the LOG string ends with a \n.
3282 ;; End each bunch of errors with (dired-log t):
3283 ;; this inserts the current time and buffer at the start of the page,
3284 ;; and \f (formfeed) at the end.
3292 log)))
3305 "State a summary of a command's failures, in echo area and log buffer.
3306 STRING is an overall summary of the failures.
3307 FAILURES is a list of file names that we failed to operate on,
3308 or nil if file names are not applicable."
3318 string failures))
3319 ;; Log a summary describing a bunch of errors.
3322 \f
3323 ;;; Sorting
3325 ;; Most ls can only sort by name or by date (with -t), nothing else.
3326 ;; GNU ls sorts on size with -S, on extension with -X, and unsorted with -U.
3327 ;; So anything that does not contain these is sort "by name".
3332 This indicates to Dired which option switches to watch out for because they
3333 will change the sorting order behavior of `ls'.
3335 To change the default sorting order \(e.g. add a `-v' option\), see the
3336 variable `dired-listing-switches'. To temporarily override the listing
3341 ;; `dired-ls-sorting-switches' after -t overrides -t.
3353 "Non-nil means the Dired sort command is disabled.
3357 ;; Set modeline display according to dired-actual-switches.
3358 ;; Modeline display of "by name" or "by date" guarantees the user a
3359 ;; match with the corresponding regexps. Non-matching switches are
3360 ;; shown literally.
3365 dired-sort-by-name-regexp dired-actual-switches)
3368 dired-sort-by-date-regexp dired-actual-switches)
3375 "Toggle sorting by date, and refresh the Dired buffer.
3376 With a prefix argument, edit the current listing switches instead."
3386 ;; Toggle between sort by date/name. Reverts the buffer.
3388 dired-actual-switches))
3389 ;; Regexp for finding (possibly embedded) -t switches.
3391 case-fold-search)
3392 ;; Remove the -t switch.
3396 ;; Remove a stand-alone -t switch.
3399 ;; Remove a switch of the form -XtY for some X and Y.
3402 ;; Now, if we weren't sorting by date before, add the -t switch.
3408 ;; Some user code loads dired especially for this.
3409 ;; Don't do that--use replace-regexp-in-string instead.
3411 ;; Replace REGEXP with NEWTEXT everywhere in STRING and return result.
3412 ;; NEWTEXT is taken literally---no \\DIGIT escapes will be recognized.
3418 start me))
3422 "Specify new `ls' SWITCHES for current dired buffer.
3423 Values matching `dired-sort-by-date-regexp' or `dired-sort-by-name-regexp'
3424 set the minor mode accordingly, others appear literally in the mode line.
3425 With optional second arg NO-REVERT, don't refresh the listing afterwards."
3436 "Additional processing of -R in ls option string SWITCHES.
3437 Saves `dired-subdir-alist' when R is set and restores saved value
3438 minus any directories explicitly deleted when R is cleared.
3439 To be called first in body of `dired-sort-other', etc."
3443 ;; Adding -R to ls switches -- save `dired-subdir-alist':
3447 ;; Deleting -R from ls switches -- revert to pre-R subdirs
3448 ;; that are still present:
3454 dired-subdir-alist)
3455 ;; subdir still present...
3458 subdirs)))
3462 ;; No pre-R subdir alist, so revert to main directory
3463 ;; listing:
3465 \f
3467 ;;;; Drag and drop support
3470 "Decide whether recursive copies are allowed.
3471 A value of nil means no recursive copies.
3472 `always' means copy recursively without asking.
3473 `top' means ask for each directory at top level.
3474 Anything else means ask for each directory."
3489 ;; No need to get actions and descriptions from the source,
3490 ;; we only have three actions anyway.
3492 t
3498 "--"
3502 nil)))
3507 ;; Only used when (featurep 'dnd).
3512 "Copy, move or link a file to the dired directory.
3513 URI is the file to handle, ACTION is one of copy, move, link or ask.
3514 Ask means pop up a menu for the user to select one of copy, move or link."
3523 ;; If copying a directory and dired-recursive-copies is
3524 ;; nil, dired-copy-file fails. Pop up a notice.
3533 ;; Binding dired-overwrite-confirmed to nil makes
3534 ;; dired-handle-overwrite a no-op. We instead use
3535 ;; y-or-n-p, which pops a graphical menu.
3536 dired-overwrite-confirmed backup-file)
3538 ;; d-b-o is defined in dired-aux.
3540 dired-backup-overwrite
3556 action))))))
3559 "Copy, move or link a file to the dired directory if it is a local file.
3560 URI is the file to handle. If the hostname in the URI isn't local, do nothing.
3561 ACTION is one of copy, move, link or ask.
3562 Ask means pop up a menu for the user to select one of copy, move or link."
3565 nil)))
3566 \f
3568 ;;;; Desktop support
3573 "Auxiliary information to be saved in desktop file."
3575 ;; Value of `dired-directory'.
3577 ;; Directory name followed by list of files.
3580 ;; Directory name, optionally with shell wildcard.
3582 ;; Subdirectories in `dired-subdir-alist'.
3587 dired-subdir-alist)))))
3590 desktop-buffer-name
3591 desktop-buffer-misc)
3592 "Restore a dired buffer specified in a desktop file."
3593 ;; First element of `desktop-buffer-misc' is the value of `dired-directory'.
3594 ;; This value is a directory name, optionally with shell wildcard or
3595 ;; a directory name followed by list of files.
3601 ;; The following elements of `desktop-buffer-misc' are the keys
3602 ;; from `dired-subdir-alist'.
3607 nil)))
3612 \f
3613 ;;; Start of automatically extracted autoloads.
3614 \f
3615 ;;;### (autoloads (dired-show-file-type dired-do-query-replace-regexp
3616 ;;;;;; dired-do-search dired-do-isearch-regexp dired-do-isearch
3617 ;;;;;; dired-isearch-filenames-regexp dired-isearch-filenames dired-isearch-filenames-setup
3618 ;;;;;; dired-hide-all dired-hide-subdir dired-tree-down dired-tree-up
3619 ;;;;;; dired-kill-subdir dired-mark-subdir-files dired-goto-subdir
3620 ;;;;;; dired-prev-subdir dired-insert-subdir dired-maybe-insert-subdir
3621 ;;;;;; dired-downcase dired-upcase dired-do-symlink-regexp dired-do-hardlink-regexp
3622 ;;;;;; dired-do-copy-regexp dired-do-rename-regexp dired-do-rename
3623 ;;;;;; dired-do-hardlink dired-do-symlink dired-do-copy dired-create-directory
3624 ;;;;;; dired-rename-file dired-copy-file dired-relist-file dired-remove-file
3625 ;;;;;; dired-add-file dired-do-redisplay dired-do-load dired-do-byte-compile
3626 ;;;;;; dired-do-compress dired-query dired-compress-file dired-do-kill-lines
3627 ;;;;;; dired-run-shell-command dired-do-shell-command dired-do-async-shell-command
3628 ;;;;;; dired-clean-directory dired-do-print dired-do-touch dired-do-chown
3629 ;;;;;; dired-do-chgrp dired-do-chmod dired-compare-directories dired-backup-diff
3630 ;;;;;; dired-diff) "dired-aux" "dired-aux.el" "2d805d6766bd7970cd446413b4ed4ce0")
3631 ;;; Generated autoloads from dired-aux.el
3634 Compare file at point with file FILE using `diff'.
3635 FILE defaults to the file at the mark. (That's the mark set by
3637 The prompted-for file is the first file given to `diff'.
3638 With prefix arg, prompt for second argument SWITCHES,
3639 which is options for `diff'.
3644 Diff this file with its backup file or vice versa.
3645 Uses the latest backup, if there are several numerical backups.
3646 If this file is a backup, diff it with its original.
3647 The backup file is the first file given to `diff'.
3648 With prefix arg, prompt for argument SWITCHES which is options for `diff'.
3653 Mark files with different file attributes in two dired buffers.
3654 Compare file attributes of files in the current directory
3655 with file attributes in directory DIR2 using PREDICATE on pairs of files
3656 with the same name. Mark files for which PREDICATE returns non-nil.
3657 Mark files with different names if PREDICATE is nil (or interactively
3658 with empty input at the predicate prompt).
3660 PREDICATE is a Lisp expression that can refer to the following variables:
3662 size1, size2 - file size in bytes
3663 mtime1, mtime2 - last modification time in seconds, as a float
3664 fa1, fa2 - list of file attributes
3665 returned by function `file-attributes'
3667 where 1 refers to attribute of file in the current dired buffer
3668 and 2 to attribute of file in second dired buffer.
3670 Examples of PREDICATE:
3672 (> mtime1 mtime2) - mark newer files
3673 (not (= size1 size2)) - mark files with different sizes
3674 (not (string= (nth 8 fa1) (nth 8 fa2))) - mark files with different modes
3675 (not (and (= (nth 2 fa1) (nth 2 fa2)) - mark files with different UID
3676 (= (nth 3 fa1) (nth 3 fa2)))) and GID.
3681 Change the mode of the marked (or next ARG) files.
3682 Symbolic modes like `g+w' are allowed.
3687 Change the group of the marked (or next ARG) files.
3692 Change the owner of the marked (or next ARG) files.
3697 Change the timestamp of the marked (or next ARG) files.
3698 This calls touch.
3703 Print the marked (or next ARG) files.
3704 Uses the shell command coming from variables `lpr-command' and
3705 `lpr-switches' as default.
3710 Flag numerical backups for deletion.
3711 Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
3712 Positive prefix arg KEEP overrides `dired-kept-versions';
3713 Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
3716 with a prefix argument.
3721 Run a shell command COMMAND on the marked files asynchronously.
3723 Like `dired-do-shell-command' but if COMMAND doesn't end in ampersand,
3724 adds `* &' surrounded by whitespace and executes the command asynchronously.
3725 The output appears in the buffer `*Async Shell Command*'.
3730 Run a shell command COMMAND on the marked files.
3731 If no files are marked or a specific numeric prefix arg is given,
3733 The prompt mentions the file(s) or the marker, as appropriate.
3735 If there is a `*' in COMMAND, surrounded by whitespace, this runs
3736 COMMAND just once with the entire file list substituted there.
3738 If there is no `*', but there is a `?' in COMMAND, surrounded by
3739 whitespace, this runs COMMAND on each file individually with the
3740 file name substituted for `?'.
3742 Otherwise, this runs COMMAND on each file individually with the
3743 file name added at the end of COMMAND (separated by a space).
3745 `*' and `?' when not surrounded by whitespace have no special
3746 significance for `dired-do-shell-command', and are passed through
3747 normally to the shell, but you must confirm first. To pass `*' by
3750 If COMMAND produces output, it goes to a separate buffer.
3752 This feature does not try to redisplay Dired buffers afterward, as
3753 there's no telling what files COMMAND may have changed.
3756 When COMMAND runs, its working directory is the top-level directory
3757 of the Dired buffer, so output files usually are created there
3758 instead of in a subdir.
3760 In a noninteractive call (from Lisp code), you must specify
3761 the list of file names explicitly with the FILE-LIST argument, which
3762 can be produced by `dired-get-marked-files', for example.
3767 Not documented
3772 Kill all marked lines (not the files).
3773 With a prefix argument, kill that many lines starting with the current line.
3774 \(A negative argument kills backward.)
3775 If you use this command with a prefix argument to kill the line
3776 for a file that is a directory, which you have inserted in the
3777 Dired buffer as a subdirectory, then it deletes that subdirectory
3778 from the buffer as well.
3779 To kill an entire subdirectory (without killing its line in the
3780 parent directory), go to its directory header line and use this
3781 command with a prefix argument (the value does not matter).
3786 Not documented
3791 Format PROMPT with ARGS, query user, and store the result in SYM.
3792 The return value is either nil or t.
3794 The user may type y or SPC to accept once; n or DEL to skip once;
3795 ! to accept this and subsequent queries; or q or ESC to decline
3796 this and subsequent queries.
3798 If SYM is already bound to a non-nil value, this function may
3799 return automatically without querying the user. If SYM is !,
3800 return t; if SYM is q or ESC, return nil.
3805 Compress or uncompress marked (or next ARG) files.
3810 Byte compile marked (or next ARG) Emacs Lisp files.
3815 Load the marked (or next ARG) Emacs Lisp files.
3820 Redisplay all marked (or next ARG) files.
3821 If on a subdir line, redisplay that subdirectory. In that case,
3822 a prefix arg lets you edit the `ls' switches used for the new listing.
3824 Dired remembers switches specified with a prefix arg, so that reverting
3825 the buffer will not reset them. However, using `dired-undo' to re-insert
3826 or delete subdirectories can bypass this machinery. Hence, you sometimes
3827 may have to reset some subdirectory switches after a `dired-undo'.
3828 You can reset all subdirectory switches to the default using
3830 See Info node `(emacs)Subdir switches' for more details.
3835 Not documented
3840 Not documented
3845 Create or update the line for FILE in all Dired buffers it would belong in.
3850 Not documented
3855 Not documented
3860 Create a directory called DIRECTORY.
3861 If DIRECTORY already exists, signal an error.
3866 Copy all marked (or next ARG) files, or copy the current file.
3867 This normally preserves the last-modified date when copying.
3868 When operating on just the current file, you specify the new name.
3869 When operating on multiple or marked files, you specify a directory,
3870 and new copies of these files are made in that directory
3871 with the same names that the files currently have. The default
3872 suggested for the target directory depends on the value of
3873 `dired-dwim-target', which see.
3875 This command copies symbolic links by creating new ones,
3876 like `cp -d'.
3881 Make symbolic links to 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 symbolic 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.
3894 Add names (hard links) current file or all marked (or next ARG) files.
3895 When operating on just the current file, you specify the new name.
3896 When operating on multiple or marked files, you specify a directory
3897 and new hard links are made in that directory
3898 with the same names that the files currently have. The default
3899 suggested for the target directory depends on the value of
3900 `dired-dwim-target', which see.
3905 Rename current file or all marked (or next ARG) files.
3906 When renaming just the current file, you specify the new name.
3907 When renaming multiple or marked files, you specify a directory.
3908 This command also renames any buffers that are visiting the files.
3909 The default suggested for the target directory depends on the value
3910 of `dired-dwim-target', which see.
3915 Rename selected files whose names match REGEXP to NEWNAME.
3917 With non-zero prefix argument ARG, the command operates on the next ARG
3918 files. Otherwise, it operates on all the marked files, or the current
3919 file if none are marked.
3921 As each match is found, the user must type a character saying
3924 REGEXP defaults to the last regexp used.
3926 With a zero prefix arg, renaming by regexp affects the absolute file name.
3927 Normally, only the non-directory part of the file name is used and changed.
3932 Copy selected files whose names match REGEXP to NEWNAME.
3933 See function `dired-do-rename-regexp' for more info.
3938 Hardlink selected files whose names match REGEXP to NEWNAME.
3939 See function `dired-do-rename-regexp' for more info.
3944 Symlink selected files whose names match REGEXP to NEWNAME.
3945 See function `dired-do-rename-regexp' for more info.
3950 Rename all marked (or next ARG) files to upper case.
3955 Rename all marked (or next ARG) files to lower case.
3960 Insert this subdirectory into the same dired buffer.
3962 else inserts it at its natural place (as `ls -lR' would have done).
3963 With a prefix arg, you may edit the ls switches used for this listing.
3964 You can add `R' to the switches to expand the whole tree starting at
3965 this subdirectory.
3966 This function takes some pains to conform to `ls -lR' output.
3968 Dired remembers switches specified with a prefix arg, so that reverting
3969 the buffer will not reset them. However, using `dired-undo' to re-insert
3970 or delete subdirectories can bypass this machinery. Hence, you sometimes
3971 may have to reset some subdirectory switches after a `dired-undo'.
3972 You can reset all subdirectory switches to the default using
3974 See Info node `(emacs)Subdir switches' for more details.
3979 Insert this subdirectory into the same dired buffer.
3980 If it is already present, overwrites previous entry,
3981 else inserts it at its natural place (as `ls -lR' would have done).
3982 With a prefix arg, you may edit the `ls' switches used for this listing.
3983 You can add `R' to the switches to expand the whole tree starting at
3984 this subdirectory.
3985 This function takes some pains to conform to `ls -lR' output.
3990 Go to previous subdirectory, regardless of level.
3991 When called interactively and not on a subdir line, go to this subdir's line.
3996 Go to end of header line of DIR in this dired buffer.
3997 Return value of point on success, otherwise return nil.
4003 Mark all files except `.' and `..' in current subdirectory.
4004 If the Dired buffer shows multiple directories, this command
4005 marks the files listed in the subdirectory that point is in.
4010 Remove all lines of current subdirectory.
4011 Lower levels are unaffected.
4016 Go up ARG levels in the dired tree.
4021 Go down in the dired tree.
4026 Hide or unhide the current subdirectory and move to next directory.
4027 Optional prefix arg is a repeat factor.
4033 Hide all subdirectories, leaving only their header lines.
4034 If there is already something hidden, make everything visible again.
4040 Set up isearch to search in Dired file names.
4041 Intended to be added to `isearch-mode-hook'.
4046 Search for a string using Isearch only in file names in the Dired buffer.
4051 Search for a regexp using Isearch only in file names in the Dired buffer.
4056 Search for a string through all marked files using Isearch.
4061 Search for a regexp through all marked files using Isearch.
4066 Search through all marked files for a match for REGEXP.
4067 Stops when a match is found.
4073 Do `query-replace-regexp' of FROM with TO, on all marked files.
4074 Third arg DELIMITED (prefix arg) means replace only word-delimited matches.
4081 Print the type of FILE, according to the `file' command.
4082 If FILE is a symbolic link and the optional argument DEREF-SYMLINKS is
4083 true then the type of the file linked to by FILE is printed instead.
4087 ;;;***
4088 \f
4089 ;;;### (autoloads (dired-do-relsymlink dired-jump-other-window dired-jump)
4090 ;;;;;; "dired-x" "dired-x.el" "87fd4ae2fdade7e0f11c4a0b1cfdeda2")
4091 ;;; Generated autoloads from dired-x.el
4094 Jump to dired buffer corresponding to current buffer.
4095 If in a file, dired the current directory and move to file's line.
4096 If in Dired already, pop up a level and goto old directory's line.
4097 In case the proper dired file line cannot be found, refresh the dired
4098 buffer and try again.
4099 When OTHER-WINDOW is non-nil, jump to dired buffer in other window.
4100 Interactively with prefix argument, read FILE-NAME and
4101 move to its line in dired.
4111 Relative symlink all marked (or next ARG) files into a directory.
4112 Otherwise make a relative symbolic link to the current file.
4113 This creates relative symbolic links like
4115 foo -> ../bar/foo
4117 not absolute ones like
4119 foo -> /ugly/file/name/that/may/change/any/day/bar/foo
4125 ;;;***
4126 \f
4127 ;;; End of automatically extracted autoloads.
4133 ;;; dired.el ends here