| blob | 02d855a0d33e0e6a1bc202f4489626e1904d5e12 |
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.
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.
851 ;; This differs from dired-buffers-for-dir in that it does not consider
852 ;; subdirs of default-directory and searches for the first match only.
853 ;; Also, the major mode must be MODE.
862 dired-directory ;; nil during find-alternate-file
867 dired-directory))))
869 blist nil)
871 found))
873 \f
874 ;; Read in a new dired buffer
877 "Read in a new dired buffer.
878 Differs from `dired-insert-subdir' in that it accepts
879 wildcards, erases the buffer, and builds the subdir-alist anew
880 \(including making it buffer-local and clearing it first)."
882 ;; default-directory and dired-actual-switches must be buffer-local
883 ;; and initialized by now.
885 ;; This makes readin much much faster.
886 ;; In particular, it prevents the font lock hook from running
887 ;; until the directory is all read in.
894 ;; This hook which may want to modify dired-actual-switches
895 ;; based on dired-directory, e.g. with ange-ftp to a SysV host
896 ;; where ls won't understand -Al switches.
904 ;; Don't make undo entries for readin.
910 ;; Must first make alist buffer local and set it to nil because
911 ;; dired-build-subdir-alist will call dired-clear-alist first
918 ;; No need to narrow since the whole buffer contains just
919 ;; dired-readin's output, nothing else. The hook can
920 ;; successfully use dired functions (e.g. dired-get-filename)
921 ;; as the subdir-alist has been built in dired-readin.
924 ;; Subroutines of dired-readin
927 ;; Insert listing for the specified dir (and maybe file list)
928 ;; already in dired-directory, assuming a clean buffer.
934 file-list nil))
938 ;; If we are reading a whole single directory...
943 ;; Else treat it as a wildcard spec
944 ;; unless we have an explicit list of files.
949 "Align the fields of a file to the ones of surrounding lines.
950 BEG..END is the line where the file info is located."
951 ;; Some versions of ls try to adjust the size of each field so as to just
952 ;; hold the largest element ("largest" in the current invocation, of
953 ;; course). So when a single line is output, the size of each field is
954 ;; just big enough for that one output. Thus when dired refreshes one
955 ;; line, the alignment if this line w.r.t the rest is messed up because
956 ;; the fields of that one line will generally be smaller.
957 ;;
958 ;; To work around this problem, we here add spaces to try and
959 ;; re-align the fields as needed. Since this is purely aesthetic,
960 ;; it is of utmost importance that it doesn't mess up anything like
961 ;; `dired-move-to-filename'. To this end, we limit ourselves to
962 ;; adding spaces only, and to only add them at places where there
963 ;; was already at least one space. This way, as long as
964 ;; `directory-listing-before-filename-regexp' always matches spaces
965 ;; with "*" or "+", we know we haven't made anything worse. There
966 ;; is one spot where the exact number of spaces is important, which
967 ;; is just before the actual filename, so we refrain from adding
968 ;; spaces there (and within the filename as well, of course).
971 ;; Check that there is indeed a file, and that there is anoter adjacent
972 ;; file with which to align, and that additional spaces are needed to
973 ;; align the filenames.
986 ;; Make sure there is some work left to do.
988 ;; If we've only looked at the line above, check to see if the line
989 ;; below exists as well and if so, align with the shorter one.
998 ;; Keep positions uptodate when we insert stuff.
1001 ;; Main loop.
1005 ;; Don't touch anything just before (and after) the
1006 ;; beginning of the filename.
1008 ;; We're now just in front of a field, with a space behind us.
1010 ;; Nums are right-aligned.
1012 ;; Let's look at the other line, in the same column: we
1013 ;; should be either near the end of the previous field, or
1014 ;; in the space between that field and the next.
1015 ;; [ Of course, it's also possible that we're already within
1016 ;; the next field or even past it, but that's unlikely since
1017 ;; other-col > file-col. ]
1018 ;; Let's find the distance to the alignment-point (either
1019 ;; the beginning or the end of the next field, depending on
1020 ;; whether this field is left or right aligned).
1030 ;; Now, the number of spaces to insert is align-pt-offset
1031 ;; minus the distance to the equivalent point on the
1032 ;; current line.
1035 align-pt-offset
1045 ;; Let's just make really sure we did not mess up.
1048 ;; Damn! We messed up: let's revert the change.
1050 ;; Now skip to next field.
1056 "Insert a directory listing of DIR, Dired style.
1057 Use SWITCHES to make the listings.
1058 If FILE-LIST is non-nil, list only those files.
1059 Otherwise, if WILDCARD is non-nil, expand wildcards;
1060 in that case, DIR should be a file name that uses wildcards.
1061 In other cases, DIR should be a directory name or a directory filename.
1062 If HDR is non-nil, insert a header line with the directory name."
1065 end)
1067 ;; Check whether "ls --dired" gives exit code 0, and
1068 ;; save the answer in `dired-use-ls-dired'.
1072 dired-use-ls-dired)
1075 ;; We used to specify the C locale here, to force English month names;
1076 ;; but this should not be necessary any more,
1077 ;; with the new value of `directory-listing-before-filename-regexp'.
1082 ;; Re-align fields, if necessary.
1085 ;; Quote certain characters, unless ls quoted them for us.
1094 nil t))
1100 nil t))
1103 ;; If we used --dired and it worked, the lines are already indented.
1104 ;; Otherwise, indent them.
1110 ;; Insert text at the beginning to standardize things.
1116 ;; Note that dired-build-subdir-alist will replace the name
1117 ;; by its expansion, so it does not matter whether what we insert
1118 ;; here is fully expanded, but it should be absolute.
1121 ;; Insert "wildcard" line where "total" line would be for a full dir.
1125 "Make the file names highlight when the mouse is on them."
1137 dired-filename t
1141 \f
1142 ;; Reverting a dired buffer
1145 "Reread the dired buffer.
1146 Must also be called after `dired-actual-switches' have changed.
1147 Should not fail even on completely garbaged buffers.
1148 Preserves old cursor, marks/flags, hidden-p.
1150 Dired sets `revert-buffer-function' to this function. The args
1151 ARG and NOCONFIRM, passed from `revert-buffer', are ignored."
1163 ;; treat top level dir extra (it may contain wildcards)
1170 ;; Run dired-after-readin-hook just once, below.
1175 ;; ... run the hook for the whole buffer, and only after markers
1176 ;; have been reinserted (else omitting in dired-x would omit marked files)
1184 ;; outside of the let scope
1185 ;;; Might as well not override the user if the user changed this.
1186 ;;; (setq buffer-read-only t)
1187 )
1189 ;; Subroutines of dired-revert
1190 ;; Some of these are also used when inserting subdirs.
1193 "Return current positions in the buffer and all windows with this directory.
1194 The positions have the form (BUFFER-POSITION WINDOW-POSITIONS).
1196 BUFFER-POSITION is the point position in the current dired buffer.
1197 It has the form (BUFFER DIRED-FILENAME BUFFER-POINT).
1199 WINDOW-POSITIONS are current positions in all windows displaying
1200 this dired buffer. The window positions have the form (WINDOW
1201 DIRED-FILENAME WINDOW-POINT)."
1212 "Restore POSITIONS saved with `dired-save-positions'."
1220 ;; Ensure that window still displays the original buffer.
1229 "Return alist of files and their marks, from BEG to END."
1240 alist))
1243 "Mark all files remembered in ALIST.
1244 Each element of ALIST looks like (FILE . MARKERCHAR)."
1258 "Return a list of names of subdirs currently hidden."
1268 result))
1271 "Try to insert all subdirs that were displayed before.
1272 Do so according to the former subdir alist OLD-SUBDIR-ALIST."
1286 "Remove directory DIR from any directory cache."
1290 \f
1291 ;; dired mode key bindings and initialization
1294 ;; This looks ugly when substitute-command-keys uses C-d instead d:
1295 ;; (define-key dired-mode-map "\C-d" 'dired-flag-file-deletion)
1300 ;; Commands to mark or flag certain categories of files
1304 ;; Upper case keys (except !) for operating on the marked files
1323 ;; Comparison commands
1326 ;; Tree Dired commands
1332 ;; move to marked files
1335 ;; Make all regexp commands share a `%' prefix:
1336 ;; We used to get to the submap via a symbol dired-regexp-prefix,
1337 ;; but that seems to serve little purpose, and copy-keymap
1338 ;; does a better job without it.
1351 ;; Commands for marking and unmarking.
1368 ;; Lower keys for commands not operating on all the marked files
1395 ;; moving
1402 ;; hiding
1405 ;; isearch
1410 ;; misc
1416 ;; thumbnail manipulation (image-dired)
1429 ;; encryption and decryption (epa-dired)
1435 ;; Make menu bar items.
1437 ;; No need to fo this, now that top-level items are fewer.
1438 ;;;;
1439 ;; Get rid of the Edit menu bar item to save space.
1440 ;(define-key map [menu-bar edit] 'undefined)
1545 ;; When running on plain MS-DOS, there's only one
1546 ;; letter-case for file names.
1734 map)
1736 \f
1737 ;; Dired mode is suitable only for specially formatted data.
1740 ;; Autoload cookie needed by desktop.el
1741 ;;;###autoload
1743 "\
1746 \(optionally) its subdirectories, in the format of `ls -lR'.
1749 compress, load or byte-compile them, change their file attributes
1752 by file or all files matching certain criteria.
1754 Letters no longer insert themselves. Digits are prefix arguments.
1757 Most commands operate on the marked files and use the current file
1758 if no files are marked. Use a numeric prefix argument to operate on
1759 the next ARG (or previous -ARG if ARG<0) files, or just `1'
1760 to operate on the current file only. Prefix arguments override marks.
1762 to see why something went wrong.
1767 (or dired it in another buffer, if it is a directory).
1774 This retains all marks and hides subdirs again that were hidden before.
1775 SPC and DEL can be used to move down and up by lines.
1778 to read the
1780 to relist a single or the marked files or a
1782 again for the directory tree.
1785 for more info):
1787 `dired-listing-switches'
1788 `dired-trivial-filenames'
1789 `dired-shrink-to-fit'
1790 `dired-marker-char'
1791 `dired-del-marker'
1792 `dired-keep-marker-rename'
1793 `dired-keep-marker-copy'
1794 `dired-keep-marker-hardlink'
1795 `dired-keep-marker-symlink'
1799 `dired-before-readin-hook'
1800 `dired-after-readin-hook'
1801 `dired-mode-hook'
1802 `dired-load-hook'
1804 Keybindings:
1806 ;; Not to be called interactively (e.g. dired-directory will be set
1807 ;; to default-directory, which is wrong with wildcards).
1812 mode-name "Dired"
1813 ;; case-fold-search nil
1814 buffer-read-only t
1815 selective-display t ; for subdirectory hiding
1816 mode-line-buffer-identification
1826 ;; list-buffers uses this to display the dir being edited in this buffer.
1830 dired-directory)))
1845 \f
1846 ;; Idiosyncratic dired commands that don't deal with marks.
1849 "Summarize basic Dired commands and show recent dired errors."
1852 ;>> this should check the key-bindings and use substitute-command-keys if non-standard
1857 "Undo in a dired buffer.
1858 This doesn't recover lost files, it just undoes changes in the buffer itself.
1859 You can use it to recover marks, killed lines or subdirs."
1868 "Edit dired buffer with Wdired, or set it read-only.
1869 Call `wdired-change-to-wdired-mode' in dired buffers whose editing is
1870 supported by Wdired (the major mode of the dired buffer is `dired-mode').
1871 Otherwise, for buffers inheriting from dired-mode, call `toggle-read-only'."
1878 "Move down lines then position at filename.
1879 Optional prefix ARG says how many lines to move; default is one line."
1885 "Move up lines then position at filename.
1886 Optional prefix ARG says how many lines to move; default is one line."
1892 "Goto ARG'th next directory file line."
1904 "Goto ARG'th previous directory file line."
1909 "Run Dired on parent directory of current directory.
1910 Find the parent directory either in this buffer or another buffer.
1911 Creates a buffer if necessary."
1916 ;; Only try dired-goto-subdir if buffer has more than one dir.
1926 "Get the current line's file name, with an error if file does not exist."
1928 ;; We pass t for second arg so that we don't get error for `.' and `..'.
1930 file-name)
1935 file-name
1940 ;; Force C-m keybinding rather than `f' or `e' in the mode doc:
1943 "In Dired, visit the file or directory named on this line."
1945 ;; Bind `find-file-run-dired' so that the command works on directories
1946 ;; too, independent of the user's setting.
1951 "In Dired, visit this file or directory instead of the dired buffer."
1955 ;; Don't override the setting from .emacs.
1956 ;;;###autoload (put 'dired-find-alternate-file 'disabled t)
1959 "In Dired, visit the file or directory name you click on."
1980 "In Dired, examine a file in view mode, returning to Dired when done.
1981 When file is a directory, show it in this buffer if it is inserted.
1982 Otherwise, display it in another buffer."
1992 "In Dired, visit this file or directory in another window."
1997 "In Dired, display this file or directory in another window."
2000 \f
2001 ;;; Functions for extracting and manipulating file names in Dired buffers.
2004 "In Dired, return name of file mentioned on this line.
2005 Value returned normally includes the directory name.
2006 Optional arg LOCALP with value `no-dir' means don't include directory
2007 name in result. A value of `verbatim' means to return the name exactly as
2008 it occurs in the buffer, and a value of t means construct name relative to
2009 `default-directory', which still may contain slashes if in a subdirectory.
2010 Optional arg NO-ERROR-IF-NOT-FILEP means treat `.' and `..' as
2011 regular filenames and return nil if no filename on this line.
2012 Otherwise, an error occurs in these cases."
2017 ;; nil if no file on this line, but no-error-if-not-filep is t:
2020 ;; Get rid of the mouse-face property that file names have.
2022 ;; Unquote names quoted by ls or by dired-insert-directory.
2023 ;; This code was written using `read' to unquote, because
2024 ;; it's faster than substituting \007 (4 chars) -> ^G (1
2025 ;; char) etc. in a lisp loop. Unfortunately, this decision
2026 ;; has necessitated hacks such as dealing with filenames
2027 ;; with quotation marks in their names.
2039 ;; The above `read' will return a unibyte string if FILE
2040 ;; contains eight-bit-control/graphic characters.
2045 ;; A relative file name can start with ~.
2046 ;; Don't treat it as absolute in this context.
2051 nil)
2053 file)
2061 ;; check for safe-magic property so that we won't
2062 ;; put /: for names that don't really need them.
2063 ;; For instance, .gz files when auto-compression-mode is on.
2066 file)))
2068 file)
2072 ;; check for safe-magic property so that we won't
2073 ;; put /: for names that don't really need them.
2074 ;; For instance, .gz files when auto-compression-mode is on.
2077 file)))
2083 "Replace first match of REGEXP in STRING with NEWTEXT.
2084 If it does not match, nil is returned instead of the new string.
2085 Optional arg LITERAL means to take NEWTEXT literally.
2086 Optional arg GLOBAL means to replace all matches."
2093 ret)
2095 nil
2099 ;;"Convert FILE (a file name relative to DIR) to an absolute file name."
2100 ;; We can't always use expand-file-name as this would get rid of `.'
2101 ;; or expand in / instead default-directory if DIR=="".
2102 ;; This should be good enough for ange-ftp.
2103 ;; It should be reasonably fast, though, as it is called in
2104 ;; dired-get-filename.
2108 "Convert FILE (an absolute file name) to a name relative to DIR.
2109 If this is impossible, return FILE unchanged.
2110 DIR must be a directory name, not a file name."
2112 ;; This case comes into play if default-directory is set to
2113 ;; use ~.
2118 ;;; (or no-error
2119 ;;; (error "%s: not in directory tree growing at %s" file dir))
2120 file))
2121 \f
2122 ;;; Functions for finding the file name in a dired buffer line.
2128 ;; Move to first char of filename on this line.
2129 ;; Returns position (point) or nil if no filename on this line."
2131 "Move to the beginning of the filename on the current line.
2132 Return the position of the beginning of the filename, or nil if none found."
2133 ;; This is the UNIX version.
2136 ;; First try assuming `ls --dired' was used.
2144 ;; Ha! There *is* a file. Our regexp-from-hell just failed to find it.
2148 nil)
2153 ;; Assumes point is at beginning of filename,
2154 ;; thus the rwx bit re-search-backward below will succeed in *this*
2155 ;; line if at all. So, it should be called only after
2156 ;; (dired-move-to-filename t).
2157 ;; On failure, signals an error (with non-nil NO-ERROR just returns nil).
2158 ;; This is the UNIX version.
2162 ;; case-fold-search is nil now, so we can test for capital F:
2169 nil
2171 ;; Restrict perm bits to be non-blank,
2172 ;; otherwise this matches one char to early (looking backward):
2173 ;; "l---------" (some systems make symlinks that way)
2174 ;; "----------" (plain file with zero perms)
2176 dired-permission-flags-regexp nil t)
2179 ;; Only with -F we need to know whether it's an executable
2181 used-F
2189 ;; Move point to end of name:
2195 dired-ls-F-marks-symlinks
2199 ;; ls -lF marks dirs, sockets, fifos and executables with exactly
2200 ;; one trailing character. (Executable bits on symlinks ain't mean
2201 ;; a thing, even to ls, but we know it's not a symlink.)
2204 executable)
2213 nil
2216 \f
2217 ;;; COPY NAMES OF MARKED FILES INTO KILL-RING.
2220 "Copy names of marked (or next ARG) files into the kill ring.
2221 The names are separated by a space.
2222 With a zero prefix arg, use the absolute file name of each marked file.
2224 `default-directory'. (This still may contain slashes if in a subdirectory.)
2226 If on a subdir headerline, use absolute subdirname instead;
2227 prefix arg and marked files are ignored in this case.
2249 \f
2250 ;; Keeping Dired buffers in sync with the filesystem and with each other
2253 ;; Return a list of buffers for DIR (top level or in-situ subdir).
2254 ;; If FILE is non-nil, include only those whose wildcard pattern (if any)
2255 ;; matches FILE.
2256 ;; The list is in reverse order of buffer creation, most recent last.
2257 ;; As a side effect, killed dired buffers for DIR are removed from
2258 ;; dired-buffers.
2265 ;; Buffer is killed - clean up:
2273 dired-directory)))
2276 file)))
2280 result))
2283 "Convert glob-pattern PATTERN to a regular expression."
2285 regexp)
2297 ;; Fails to handle ^ yet ????
2311 regexp
2319 ;;"Advertise in variable `dired-buffers' that we dired `default-directory'."
2320 ;; With wildcards we actually advertise too much.
2323 t ; we have already advertised ourselves
2326 dired-buffers)))))
2329 ;; Remove DIR from the buffer alist in variable dired-buffers.
2330 ;; This has the effect of removing any buffer whose main directory is DIR.
2331 ;; It does not affect buffers in which DIR is a subdir.
2332 ;; Removing is also done as a side-effect in dired-buffer-for-dir.
2335 \f
2336 ;; Tree Dired
2338 ;;; utility functions
2341 ;;"Is FILE part of the directory tree starting at DIR?"
2346 ;; Prepend default-directory to DIR if relative file name.
2347 ;; dired-get-filename must be able to make a valid file name from a
2348 ;; file and its directory DIR.
2351 dir
2355 ;;"Return the subdir name on this line, or nil if not on a headerline."
2356 ;; Look up in the alist whether this is a headerline.
2362 dired-subdir-alist))))
2363 cur-dir))))
2365 ;(defun dired-get-subdir-min (elt)
2366 ; (cdr elt))
2367 ;; can't use macro, must be redefinable for other alist format in dired-nstd.
2381 ;; Return an index into alist for use with nth
2382 ;; for the sake of subdir moving commands.
2391 "Go to next subdirectory, regardless of level."
2392 ;; Use 0 arg to go to this directory's header line.
2393 ;; NO-SKIP prevents moving to end of header line, returning whatever
2394 ;; position was found in dired-subdir-alist.
2397 pos index)
2398 ;; nth with negative arg does not return nil but the first element
2408 nil ; return nil if not found
2412 "Build `dired-subdir-alist' by parsing the buffer.
2413 Returns the new value of the alist.
2414 If optional arg SWITCHES is non-nil, use its value
2415 instead of `dired-actual-switches'."
2423 new-dir-name
2425 ;; Used to expand subdirectory names correctly in recursive
2426 ;; ange-ftp listings.
2433 ;; Avoid taking a file name ending in a colon
2434 ;; as a subdir name.
2444 new-dir-name
2456 ;; Place a sub directory boundary between lines.
2463 ;; We don't need to sort it because it is in buffer order per
2464 ;; constructionem. Return new alist:
2465 dired-subdir-alist))
2468 ;; Add new DIR at NEW-MARKER. Don't sort.
2471 dired-subdir-alist)))
2474 ;; Position point on first nontrivial file after point.
2490 "Go to line describing file FILE in this dired buffer."
2491 ;; Return value of point on success, else nil.
2492 ;; FILE must be an absolute file name.
2493 ;; Loses if FILE contains control chars like "\007" for which ls
2494 ;; either inserts "?" or "\\007" into the buffer, so we won't find
2495 ;; it in the buffer.
2507 ;; The hair here is to get the result of dired-goto-subdir
2508 ;; without really calling it if we don't have any subdirs.
2514 search-string
2521 ;; filenames are preceded by SPC, this makes
2522 ;; the search faster (e.g. for the filename "-"!).
2525 ;; Match could have BASE just as initial substring or
2526 ;; or in permission bits or date or
2527 ;; not be a proper filename at all:
2529 ;; Must move to filename since an (actually
2530 ;; correct) match could have been elsewhere on the
2531 ;; ;; line (e.g. "-" would match somewhere in the
2532 ;; permission bits).
2534 ;; If this isn't the right line, move forward to avoid
2535 ;; trying this line again.
2538 ;; return value of point (i.e., FOUND):
2542 ;; Where point should go in a new listing of DIRNAME.
2543 ;; Point assumed at beginning of new subdir line.
2544 ;; You may redefine this function as you wish, e.g. like in dired-x.el.
2547 \f
2548 ;; These are hooks which make tree dired work.
2549 ;; They are in this file because other parts of dired need to call them.
2550 ;; But they don't call the rest of tree dired unless there are subdirs loaded.
2552 ;; This function is called for each retrieved filename.
2553 ;; It could stand to be faster, though it's mostly function call
2554 ;; overhead. Avoiding the function call seems to save about 10% in
2555 ;; dired-get-filename. Make it a defsubst?
2557 "Return the name of the subdirectory to which this line belongs.
2558 This returns a string with trailing slash, like `default-directory'.
2559 Optional argument means return a file name relative to `default-directory'."
2562 ;; probably because called in a non-dired buffer
2564 elt dir)
2568 ;; use `<=' (not `<') as subdir line is part of subdir
2570 nil ; found
2574 dir)))
2576 ;; Subdirs start at the beginning of their header lines and end just
2577 ;; before the beginning of the next header line (or end of buffer).
2584 \f
2585 ;; Deleting files
2588 "Decide whether recursive deletes are allowed.
2589 A value of nil means no recursive deletes.
2590 `always' means delete recursively without asking. This is DANGEROUS!
2591 `top' means ask for each directory at top level, but delete its subdirectories
2592 without asking.
2593 Anything else means ask for each directory."
2601 ;; Match anything but `.' and `..'.
2604 ;; Delete file, possibly delete a directory and all its files.
2605 ;; This function is usefull outside of dired. One could change it's name
2606 ;; to e.g. recursive-delete-file and put it somewhere else.
2608 Delete FILE or directory (possibly recursively if optional RECURSIVE is true.)
2609 RECURSIVE determines what to do with a non-empty directory. If RECURSIVE is:
2610 nil, do not delete.
2611 `always', delete recursively without asking.
2612 `top', ask for each directory at top level.
2613 Anything else, ask for each sub-directory."
2614 ;; This test is equivalent to
2615 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
2616 ;; but more efficient
2624 delete-by-moving-to-trash)
2625 "trash"
2633 "In Dired, delete the files flagged for deletion.
2634 If NOMESSAGE is non-nil, we don't display any message
2635 if there are no flagged files.
2636 `dired-recursive-deletes' controls whether deletion of
2637 non-empty directories is allowed."
2641 case-fold-search)
2645 ;; this can't move point since ARG is nil
2647 nil)
2648 nil t)
2653 "Delete all marked (or next ARG) files.
2654 `dired-recursive-deletes' controls whether deletion of
2655 non-empty directories is allowed."
2656 ;; This is more consistent with the file marking feature than
2657 ;; dired-do-flagged-delete.
2660 ;; this may move point if ARG is an integer
2662 arg)
2663 arg t))
2668 ;; L is an alist of files to delete, with their buffer positions.
2669 ;; ARG is the prefix arg.
2670 ;; Filenames are absolute.
2671 ;; (car L) *must* be the *last* (bottommost) file in the dired buffer.
2672 ;; That way as changes are made in the buffer they do not shift the
2673 ;; lines still to be changed, so the (point) values in L stay valid.
2674 ;; Also, for subdirs in natural order, a subdir's files are deleted
2675 ;; before the subdir itself - the other way around would not work.
2683 succ count)))
2684 ;; canonicalize file list for pop up
2699 ;; if we get here, removing worked
2715 failures))))
2720 ;; In all buffers dired'ing DIRECTORY, run FUN with ARGS.
2721 ;; If the buffer has a wildcard pattern, check that it matches FILE.
2722 ;; (FILE does not include a directory component.)
2723 ;; FILE may be nil, in which case ignore it.
2724 ;; Return list of buffers where FUN succeeded (i.e., returned non-nil).
2727 file))
2731 success-list))
2733 ;; Delete the entry for FILE from
2742 ;; This is a separate function for the sake of dired-x.el.
2744 ;; Clean up after a deleted file or directory FN.
2748 \f
2749 ;; Confirmation
2758 "Return a string for use in a prompt, either the current file
2759 name, or the marker and a count of marked files."
2760 ;; distinguish-one-marked can cause the first element to be just t.
2765 ;; more than 1 file:
2767 ;; abs(arg) = count
2768 ;; Perhaps this is nicer, but it also takes more screen space:
2769 ;;(format "[%s %d files]" (if (> arg 0) "next" "previous")
2770 ;; count)
2775 "Pop up buffer BUF in a way suitable for Dired."
2780 ;; Try to split the selected window vertically if
2781 ;; that's possible. (Bug#1806)
2783 ;; Otherwise, try to split WINDOW sensibly.
2785 pop-up-frames)
2787 ;; If dired-shrink-to-fit is t, make its window fit its contents.
2789 ;; Try to not delete window when we want to display less than
2790 ;; `window-min-height' lines.
2794 "A list of symbols for commands Dired should not confirm, or t.
2795 Command symbols are `byte-compile', `chgrp', `chmod', `chown', `compress',
2796 `copy', `delete', `hardlink', `load', `move', `print', `shell', `symlink',
2797 `touch' and `uncompress'.
2798 If t, confirmation is never needed."
2809 "Return FUNCTION's result on ARGS after showing which files are marked.
2810 Displays the file names in a buffer named BUFNAME;
2812 This uses function `dired-pop-to-buffer' to do that.
2814 FUNCTION should not manipulate files, just read input
2815 (an argument or confirmation).
2816 The window is not shown if there is just one file or
2817 OP-SYMBOL is a member of the list in `dired-no-confirm'.
2818 FILES is the list of marked files. It can also be (t FILENAME)
2819 in the case of one marked file, to distinguish that from using
2820 just the current file."
2824 ;; If FILES defaulted to the current line's file.
2829 ;; Handle (t FILE) just like (FILE), here.
2830 ;; That value is used (only in some cases), to mean
2831 ;; just one file that was marked, rather than the current line file.
2843 \f
2844 ;; Commands to mark or flag file(s) at or near current line.
2847 ;; This version skips non-file lines.
2858 ;; Advance to the next line--actually, to the line that *was* next.
2859 ;; (If FUNCTION inserted some new lines in between, skip them.)
2871 ;; This used to be a regexp match of the `total ...' line output by
2872 ;; ls, which is slightly faster, but that is not very robust; notably,
2873 ;; it fails for non-english locales.
2877 "Move to the next marked file, wrapping around the end of the buffer."
2894 "Move to the previous marked file, wrapping around the end of the buffer."
2899 ;; Return FILE's marker, or nil if unmarked.
2913 ;; Skip subdir line and following garbage like the `total' line:
2924 "Mark the current (or next ARG) files.
2925 If on a subdir headerline, mark all its files except `.' and `..'.
2929 this subdir."
2939 "Unmark the current (or next ARG) files.
2940 If looking at a subdir, unmark all its files except `.' and `..'."
2946 "In Dired, flag the current line's file for deletion.
2947 With prefix arg, repeat over several lines.
2949 If on a subdir headerline, mark all its files except `.' and `..'."
2955 "In Dired, move up lines and remove deletion flag there.
2956 Optional prefix ARG says how many lines to unflag; default is one line."
2961 "Toggle marks: marked files become unmarked, and vice versa.
2962 Files marked with other flags (such as `D') are not affected.
2963 `.' and `..' are never toggled.
2964 As always, hidden subdirs are not affected."
2972 ;; use subst instead of insdel because it does not move
2973 ;; the gap and thus should be faster and because
2974 ;; other characters are left alone automatically
2981 \f
2982 ;;; Commands to mark or flag files based on their characteristics or names.
2991 "Mark all files matching REGEXP for use in later commands.
2992 A prefix argument means to unmark them instead.
2993 `.' and `..' are never marked.
2996 object files--just `.o' will mark more than you might think."
3010 "Mark all files with contents containing REGEXP for use in later commands.
3011 A prefix argument means to unmark them instead.
3012 `.' and `..' are never marked."
3026 ;; For now we do it inside emacs
3027 ;; Grep might be better if there are a lot of files
3037 )))
3041 "In Dired, flag all files containing the specified REGEXP for deletion.
3042 The match is against the non-directory part of the filename. Use `^'
3043 and `$' to anchor matches. Exclude subdirs by hiding them.
3044 `.' and `..' are never flagged."
3049 "Mark all symbolic links.
3050 With prefix argument, unflag all those files."
3056 "Mark all directory file lines except `.' and `..'.
3057 With prefix argument, unflag all those files."
3065 "Mark all executable files.
3066 With prefix argument, unflag all those files."
3071 ;; dired-x.el has a dired-mark-sexp interactive command: mark
3072 ;; files for which PREDICATE returns non-nil.
3075 "Flag for deletion files whose names suggest they are auto save files.
3076 A prefix argument says to unflag those files instead."
3080 ;; It is less than general to check for # here,
3081 ;; but it's the only way this runs fast enough.
3085 ;; Handle executables in case of -F option.
3086 ;; We need not worry about the other kinds
3087 ;; of markings that -F makes, since they won't
3088 ;; appear on real auto-save files.
3100 ;; `log' here is dubious, since it's typically used for useful log
3101 ;; files, not just TeX stuff. -- fx
3110 "Flag for deletion all files that match `dired-garbage-files-regexp'."
3115 "Flag all backup files (names ending with `~') for deletion.
3116 With prefix argument, unflag these files."
3120 ;; Don't call backup-file-name-p unless the last character looks like
3121 ;; it might be the end of a backup file name. This isn't very general,
3122 ;; but it's the only way this runs fast enough.
3124 ;; Handle executables in case of -F option.
3125 ;; We need not worry about the other kinds
3126 ;; of markings that -F makes, since they won't
3127 ;; appear on real backup files.
3137 "Change all OLD marks to NEW marks.
3138 OLD and NEW are both characters used to mark files."
3155 t)
3160 "Remove all marks from all files in the dired buffer."
3165 "Remove a specific mark (or any mark) from every file.
3166 After this command, type the mark character to remove,
3167 or type RET to remove all marks.
3168 With prefix arg, query for each marked file.
3176 Type SPC or `y' to unmark one file, DEL or `n' to skip to next,
3186 file))))
3192 count))))
3193 \f
3194 ;; Logging failures operating on files, and showing the results.
3199 "Pop up a buffer with error log output from Dired.
3200 A group of errors from a single command ends with a formfeed.
3216 ;; Log a message or the contents of a buffer.
3217 ;; If LOG is a string and there are more args, it is formatted with
3218 ;; those ARGS. Usually the LOG string ends with a \n.
3219 ;; End each bunch of errors with (dired-log t):
3220 ;; this inserts the current time and buffer at the start of the page,
3221 ;; and \f (formfeed) at the end.
3229 log)))
3242 "State a summary of a command's failures, in echo area and log buffer.
3243 STRING is an overall summary of the failures.
3244 FAILURES is a list of file names that we failed to operate on,
3245 or nil if file names are not applicable."
3255 string failures))
3256 ;; Log a summary describing a bunch of errors.
3259 \f
3260 ;;; Sorting
3262 ;; Most ls can only sort by name or by date (with -t), nothing else.
3263 ;; GNU ls sorts on size with -S, on extension with -X, and unsorted with -U.
3264 ;; So anything that does not contain these is sort "by name".
3269 This indicates to Dired which option switches to watch out for because they
3270 will change the sorting order behavior of `ls'.
3272 To change the default sorting order \(e.g. add a `-v' option\), see the
3273 variable `dired-listing-switches'. To temporarily override the listing
3278 ;; `dired-ls-sorting-switches' after -t overrides -t.
3290 "Non-nil means the Dired sort command is disabled.
3294 ;; Set modeline display according to dired-actual-switches.
3295 ;; Modeline display of "by name" or "by date" guarantees the user a
3296 ;; match with the corresponding regexps. Non-matching switches are
3297 ;; shown literally.
3302 dired-sort-by-name-regexp dired-actual-switches)
3305 dired-sort-by-date-regexp dired-actual-switches)
3312 "Toggle sorting by date, and refresh the Dired buffer.
3313 With a prefix argument, edit the current listing switches instead."
3323 ;; Toggle between sort by date/name. Reverts the buffer.
3325 dired-actual-switches))
3326 ;; Regexp for finding (possibly embedded) -t switches.
3328 case-fold-search)
3329 ;; Remove the -t switch.
3333 ;; Remove a stand-alone -t switch.
3336 ;; Remove a switch of the form -XtY for some X and Y.
3339 ;; Now, if we weren't sorting by date before, add the -t switch.
3345 ;; Some user code loads dired especially for this.
3346 ;; Don't do that--use replace-regexp-in-string instead.
3348 ;; Replace REGEXP with NEWTEXT everywhere in STRING and return result.
3349 ;; NEWTEXT is taken literally---no \\DIGIT escapes will be recognized.
3355 start me))
3359 "Specify new `ls' SWITCHES for current dired buffer.
3360 Values matching `dired-sort-by-date-regexp' or `dired-sort-by-name-regexp'
3361 set the minor mode accordingly, others appear literally in the mode line.
3362 With optional second arg NO-REVERT, don't refresh the listing afterwards."
3373 "Additional processing of -R in ls option string SWITCHES.
3374 Saves `dired-subdir-alist' when R is set and restores saved value
3375 minus any directories explicitly deleted when R is cleared.
3376 To be called first in body of `dired-sort-other', etc."
3380 ;; Adding -R to ls switches -- save `dired-subdir-alist':
3384 ;; Deleting -R from ls switches -- revert to pre-R subdirs
3385 ;; that are still present:
3391 dired-subdir-alist)
3392 ;; subdir still present...
3395 subdirs)))
3399 ;; No pre-R subdir alist, so revert to main directory
3400 ;; listing:
3402 \f
3404 ;;;; Drag and drop support
3407 "Decide whether recursive copies are allowed.
3408 A value of nil means no recursive copies.
3409 `always' means copy recursively without asking.
3410 `top' means ask for each directory at top level.
3411 Anything else means ask for each directory."
3426 ;; No need to get actions and descriptions from the source,
3427 ;; we only have three actions anyway.
3429 t
3435 "--"
3439 nil)))
3444 ;; Only used when (featurep 'dnd).
3449 "Copy, move or link a file to the dired directory.
3450 URI is the file to handle, ACTION is one of copy, move, link or ask.
3451 Ask means pop up a menu for the user to select one of copy, move or link."
3460 ;; If copying a directory and dired-recursive-copies is
3461 ;; nil, dired-copy-file fails. Pop up a notice.
3470 ;; Binding dired-overwrite-confirmed to nil makes
3471 ;; dired-handle-overwrite a no-op. We instead use
3472 ;; y-or-n-p, which pops a graphical menu.
3473 dired-overwrite-confirmed backup-file)
3475 ;; d-b-o is defined in dired-aux.
3477 dired-backup-overwrite
3493 action))))))
3496 "Copy, move or link a file to the dired directory if it is a local file.
3497 URI is the file to handle. If the hostname in the URI isn't local, do nothing.
3498 ACTION is one of copy, move, link or ask.
3499 Ask means pop up a menu for the user to select one of copy, move or link."
3502 nil)))
3503 \f
3505 ;;;; Desktop support
3510 "Auxiliary information to be saved in desktop file."
3512 ;; Value of `dired-directory'.
3514 ;; Directory name followed by list of files.
3517 ;; Directory name, optionally with shell wildcard.
3519 ;; Subdirectories in `dired-subdir-alist'.
3524 dired-subdir-alist)))))
3527 desktop-buffer-name
3528 desktop-buffer-misc)
3529 "Restore a dired buffer specified in a desktop file."
3530 ;; First element of `desktop-buffer-misc' is the value of `dired-directory'.
3531 ;; This value is a directory name, optionally with shell wildcard or
3532 ;; a directory name followed by list of files.
3538 ;; The following elements of `desktop-buffer-misc' are the keys
3539 ;; from `dired-subdir-alist'.
3544 nil)))
3549 \f
3550 ;;; Start of automatically extracted autoloads.
3551 \f
3552 ;;;### (autoloads (dired-show-file-type dired-do-query-replace-regexp
3553 ;;;;;; dired-do-search dired-do-isearch-regexp dired-do-isearch
3554 ;;;;;; dired-isearch-filenames-regexp dired-isearch-filenames dired-isearch-filenames-setup
3555 ;;;;;; dired-hide-all dired-hide-subdir dired-tree-down dired-tree-up
3556 ;;;;;; dired-kill-subdir dired-mark-subdir-files dired-goto-subdir
3557 ;;;;;; dired-prev-subdir dired-insert-subdir dired-maybe-insert-subdir
3558 ;;;;;; dired-downcase dired-upcase dired-do-symlink-regexp dired-do-hardlink-regexp
3559 ;;;;;; dired-do-copy-regexp dired-do-rename-regexp dired-do-rename
3560 ;;;;;; dired-do-hardlink dired-do-symlink dired-do-copy dired-create-directory
3561 ;;;;;; dired-rename-file dired-copy-file dired-relist-file dired-remove-file
3562 ;;;;;; dired-add-file dired-do-redisplay dired-do-load dired-do-byte-compile
3563 ;;;;;; dired-do-compress dired-query dired-compress-file dired-do-kill-lines
3564 ;;;;;; dired-run-shell-command dired-do-shell-command dired-do-async-shell-command
3565 ;;;;;; dired-clean-directory dired-do-print dired-do-touch dired-do-chown
3566 ;;;;;; dired-do-chgrp dired-do-chmod dired-compare-directories dired-backup-diff
3567 ;;;;;; dired-diff) "dired-aux" "dired-aux.el" "9f5fc434fa6c2607b6e66060862c9caf")
3568 ;;; Generated autoloads from dired-aux.el
3571 Compare file at point with file FILE using `diff'.
3572 FILE defaults to the file at the mark. (That's the mark set by
3574 The prompted-for file is the first file given to `diff'.
3575 With prefix arg, prompt for second argument SWITCHES,
3576 which is options for `diff'.
3581 Diff this file with its backup file or vice versa.
3582 Uses the latest backup, if there are several numerical backups.
3583 If this file is a backup, diff it with its original.
3584 The backup file is the first file given to `diff'.
3585 With prefix arg, prompt for argument SWITCHES which is options for `diff'.
3590 Mark files with different file attributes in two dired buffers.
3591 Compare file attributes of files in the current directory
3592 with file attributes in directory DIR2 using PREDICATE on pairs of files
3593 with the same name. Mark files for which PREDICATE returns non-nil.
3594 Mark files with different names if PREDICATE is nil (or interactively
3595 with empty input at the predicate prompt).
3597 PREDICATE is a Lisp expression that can refer to the following variables:
3599 size1, size2 - file size in bytes
3600 mtime1, mtime2 - last modification time in seconds, as a float
3601 fa1, fa2 - list of file attributes
3602 returned by function `file-attributes'
3604 where 1 refers to attribute of file in the current dired buffer
3605 and 2 to attribute of file in second dired buffer.
3607 Examples of PREDICATE:
3609 (> mtime1 mtime2) - mark newer files
3610 (not (= size1 size2)) - mark files with different sizes
3611 (not (string= (nth 8 fa1) (nth 8 fa2))) - mark files with different modes
3612 (not (and (= (nth 2 fa1) (nth 2 fa2)) - mark files with different UID
3613 (= (nth 3 fa1) (nth 3 fa2)))) and GID.
3618 Change the mode of the marked (or next ARG) files.
3619 Symbolic modes like `g+w' are allowed.
3624 Change the group of the marked (or next ARG) files.
3629 Change the owner of the marked (or next ARG) files.
3634 Change the timestamp of the marked (or next ARG) files.
3635 This calls touch.
3640 Print the marked (or next ARG) files.
3641 Uses the shell command coming from variables `lpr-command' and
3642 `lpr-switches' as default.
3647 Flag numerical backups for deletion.
3648 Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
3649 Positive prefix arg KEEP overrides `dired-kept-versions';
3650 Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
3653 with a prefix argument.
3658 Run a shell command COMMAND on the marked files asynchronously.
3660 Like `dired-do-shell-command' but if COMMAND doesn't end in ampersand,
3661 adds `* &' surrounded by whitespace and executes the command asynchronously.
3662 The output appears in the buffer `*Async Shell Command*'.
3667 Run a shell command COMMAND on the marked files.
3668 If no files are marked or a specific numeric prefix arg is given,
3670 The prompt mentions the file(s) or the marker, as appropriate.
3672 If there is a `*' in COMMAND, surrounded by whitespace, this runs
3673 COMMAND just once with the entire file list substituted there.
3675 If there is no `*', but there is a `?' in COMMAND, surrounded by
3676 whitespace, this runs COMMAND on each file individually with the
3677 file name substituted for `?'.
3679 Otherwise, this runs COMMAND on each file individually with the
3680 file name added at the end of COMMAND (separated by a space).
3682 `*' and `?' when not surrounded by whitespace have no special
3683 significance for `dired-do-shell-command', and are passed through
3684 normally to the shell, but you must confirm first. To pass `*' by
3687 If COMMAND produces output, it goes to a separate buffer.
3689 This feature does not try to redisplay Dired buffers afterward, as
3690 there's no telling what files COMMAND may have changed.
3693 When COMMAND runs, its working directory is the top-level directory
3694 of the Dired buffer, so output files usually are created there
3695 instead of in a subdir.
3697 In a noninteractive call (from Lisp code), you must specify
3698 the list of file names explicitly with the FILE-LIST argument, which
3699 can be produced by `dired-get-marked-files', for example.
3704 Not documented
3709 Kill all marked lines (not the files).
3710 With a prefix argument, kill that many lines starting with the current line.
3711 \(A negative argument kills backward.)
3712 If you use this command with a prefix argument to kill the line
3713 for a file that is a directory, which you have inserted in the
3714 Dired buffer as a subdirectory, then it deletes that subdirectory
3715 from the buffer as well.
3716 To kill an entire subdirectory (without killing its line in the
3717 parent directory), go to its directory header line and use this
3718 command with a prefix argument (the value does not matter).
3723 Not documented
3728 Format PROMPT with ARGS, query user, and store the result in SYM.
3729 The return value is either nil or t.
3731 The user may type y or SPC to accept once; n or DEL to skip once;
3732 ! to accept this and subsequent queries; or q or ESC to decline
3733 this and subsequent queries.
3735 If SYM is already bound to a non-nil value, this function may
3736 return automatically without querying the user. If SYM is !,
3737 return t; if SYM is q or ESC, return nil.
3742 Compress or uncompress marked (or next ARG) files.
3747 Byte compile marked (or next ARG) Emacs Lisp files.
3752 Load the marked (or next ARG) Emacs Lisp files.
3757 Redisplay all marked (or next ARG) files.
3758 If on a subdir line, redisplay that subdirectory. In that case,
3759 a prefix arg lets you edit the `ls' switches used for the new listing.
3761 Dired remembers switches specified with a prefix arg, so that reverting
3762 the buffer will not reset them. However, using `dired-undo' to re-insert
3763 or delete subdirectories can bypass this machinery. Hence, you sometimes
3764 may have to reset some subdirectory switches after a `dired-undo'.
3765 You can reset all subdirectory switches to the default using
3767 See Info node `(emacs)Subdir switches' for more details.
3772 Not documented
3777 Not documented
3782 Create or update the line for FILE in all Dired buffers it would belong in.
3787 Not documented
3792 Not documented
3797 Create a directory called DIRECTORY.
3802 Copy all marked (or next ARG) files, or copy the current file.
3803 This normally preserves the last-modified date when copying.
3804 When operating on just the current file, you specify the new name.
3805 When operating on multiple or marked files, you specify a directory,
3806 and new copies of these files are made in that directory
3807 with the same names that the files currently have. The default
3808 suggested for the target directory depends on the value of
3809 `dired-dwim-target', which see.
3811 This command copies symbolic links by creating new ones,
3812 like `cp -d'.
3817 Make symbolic links to current file or all marked (or next ARG) files.
3818 When operating on just the current file, you specify the new name.
3819 When operating on multiple or marked files, you specify a directory
3820 and new symbolic links are made in that directory
3821 with the same names that the files currently have. The default
3822 suggested for the target directory depends on the value of
3823 `dired-dwim-target', which see.
3830 Add names (hard links) current file or all marked (or next ARG) files.
3831 When operating on just the current file, you specify the new name.
3832 When operating on multiple or marked files, you specify a directory
3833 and new hard links are made in that directory
3834 with the same names that the files currently have. The default
3835 suggested for the target directory depends on the value of
3836 `dired-dwim-target', which see.
3841 Rename current file or all marked (or next ARG) files.
3842 When renaming just the current file, you specify the new name.
3843 When renaming multiple or marked files, you specify a directory.
3844 This command also renames any buffers that are visiting the files.
3845 The default suggested for the target directory depends on the value
3846 of `dired-dwim-target', which see.
3851 Rename selected files whose names match REGEXP to NEWNAME.
3853 With non-zero prefix argument ARG, the command operates on the next ARG
3854 files. Otherwise, it operates on all the marked files, or the current
3855 file if none are marked.
3857 As each match is found, the user must type a character saying
3860 REGEXP defaults to the last regexp used.
3862 With a zero prefix arg, renaming by regexp affects the absolute file name.
3863 Normally, only the non-directory part of the file name is used and changed.
3868 Copy selected files whose names match REGEXP to NEWNAME.
3869 See function `dired-do-rename-regexp' for more info.
3874 Hardlink selected files whose names match REGEXP to NEWNAME.
3875 See function `dired-do-rename-regexp' for more info.
3880 Symlink selected files whose names match REGEXP to NEWNAME.
3881 See function `dired-do-rename-regexp' for more info.
3886 Rename all marked (or next ARG) files to upper case.
3891 Rename all marked (or next ARG) files to lower case.
3896 Insert this subdirectory into the same dired buffer.
3898 else inserts it at its natural place (as `ls -lR' would have done).
3899 With a prefix arg, you may edit the ls switches used for this listing.
3900 You can add `R' to the switches to expand the whole tree starting at
3901 this subdirectory.
3902 This function takes some pains to conform to `ls -lR' output.
3904 Dired remembers switches specified with a prefix arg, so that reverting
3905 the buffer will not reset them. However, using `dired-undo' to re-insert
3906 or delete subdirectories can bypass this machinery. Hence, you sometimes
3907 may have to reset some subdirectory switches after a `dired-undo'.
3908 You can reset all subdirectory switches to the default using
3910 See Info node `(emacs)Subdir switches' for more details.
3915 Insert this subdirectory into the same dired buffer.
3916 If it is already present, overwrites previous entry,
3917 else inserts it at its natural place (as `ls -lR' would have done).
3918 With a prefix arg, you may edit the `ls' switches used for this listing.
3919 You can add `R' to the switches to expand the whole tree starting at
3920 this subdirectory.
3921 This function takes some pains to conform to `ls -lR' output.
3926 Go to previous subdirectory, regardless of level.
3927 When called interactively and not on a subdir line, go to this subdir's line.
3932 Go to end of header line of DIR in this dired buffer.
3933 Return value of point on success, otherwise return nil.
3939 Mark all files except `.' and `..' in current subdirectory.
3940 If the Dired buffer shows multiple directories, this command
3941 marks the files listed in the subdirectory that point is in.
3946 Remove all lines of current subdirectory.
3947 Lower levels are unaffected.
3952 Go up ARG levels in the dired tree.
3957 Go down in the dired tree.
3962 Hide or unhide the current subdirectory and move to next directory.
3963 Optional prefix arg is a repeat factor.
3969 Hide all subdirectories, leaving only their header lines.
3970 If there is already something hidden, make everything visible again.
3976 Set up isearch to search in Dired file names.
3977 Intended to be added to `isearch-mode-hook'.
3982 Search for a string using Isearch only in file names in the Dired buffer.
3987 Search for a regexp using Isearch only in file names in the Dired buffer.
3992 Search for a string through all marked files using Isearch.
3997 Search for a regexp through all marked files using Isearch.
4002 Search through all marked files for a match for REGEXP.
4003 Stops when a match is found.
4009 Do `query-replace-regexp' of FROM with TO, on all marked files.
4010 Third arg DELIMITED (prefix arg) means replace only word-delimited matches.
4017 Print the type of FILE, according to the `file' command.
4018 If FILE is a symbolic link and the optional argument DEREF-SYMLINKS is
4019 true then the type of the file linked to by FILE is printed instead.
4023 ;;;***
4024 \f
4025 ;;;### (autoloads (dired-do-relsymlink dired-jump) "dired-x" "dired-x.el"
4026 ;;;;;; "fbac6ae123aaa2b2e9df8bb2cde61ceb")
4027 ;;; Generated autoloads from dired-x.el
4030 Jump to dired buffer corresponding to current buffer.
4031 If in a file, dired the current directory and move to file's line.
4032 If in Dired already, pop up a level and goto old directory's line.
4033 In case the proper dired file line cannot be found, refresh the dired
4034 buffer and try again.
4035 When OTHER-WINDOW is non-nil, jump to dired buffer in other window.
4036 Interactively with prefix argument, read FILE-NAME and
4037 move to its line in dired.
4042 Relative symlink all marked (or next ARG) files into a directory.
4043 Otherwise make a relative symbolic link to the current file.
4044 This creates relative symbolic links like
4046 foo -> ../bar/foo
4048 not absolute ones like
4050 foo -> /ugly/file/name/that/may/change/any/day/bar/foo
4056 ;;;***
4057 \f
4058 ;;; End of automatically extracted autoloads.
4064 ;;; dired.el ends here