| blob | ecc3b5bd47e2309b38564a7c37b5dc389446e166 |
1 ;;; dired.el --- directory-browsing commands
3 ;; Copyright (C) 1985, 1986, 1992, 1993, 1994, 1995, 1996, 1997, 2000,
4 ;; 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
5 ;; Free Software Foundation, Inc.
7 ;; Author: Sebastian Kremer <sk@thp.uni-koeln.de>
8 ;; Maintainer: FSF
9 ;; Keywords: files
10 ;; Package: emacs
12 ;; This file is part of GNU Emacs.
14 ;; GNU Emacs is free software: you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published by
16 ;; the Free Software Foundation, either version 3 of the License, or
17 ;; (at your option) any later version.
19 ;; GNU Emacs is distributed in the hope that it will be useful,
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ;; GNU General Public License for more details.
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
27 ;;; Commentary:
29 ;; This is a major mode for directory browsing and editing. It is
30 ;; documented in the Emacs manual.
32 ;; Rewritten in 1990/1991 to add tree features, file marking and
33 ;; sorting by Sebastian Kremer <sk@thp.uni-koeln.de>.
34 ;; Finished up by rms in 1992.
36 ;;; Code:
40 ;;; Customizable variables
43 "Directory editing."
48 "Handling marks in Dired."
53 ;;;###autoload
55 "Switches passed to `ls' for Dired. MUST contain the `l' option.
56 May contain all other options that don't contradict `-l';
57 may contain even `F', `b', `i' and `s'. See also the variable
58 `dired-ls-F-marks-symlinks' concerning the `F' switch.
59 On systems such as MS-DOS and MS-Windows, which use `ls' emulation in Lisp,
60 some of the `ls' switches are not supported; see the doc string of
61 `insert-directory' in `ls-lisp.el' for more details."
66 "If non-nil, switches passed to `ls' for inserting subdirectories.
69 ; Don't use absolute file names as /bin should be in any PATH and people
70 ; may prefer /usr/local/gnu/bin or whatever. However, chown is
71 ; usually not in PATH.
73 ;;;###autoload
77 "chown"
79 "/usr/sbin/chown"
93 "Informs Dired about how `ls -lF' marks symbolic links.
94 Set this to t if `ls' (or whatever program is specified by
95 `insert-directory-program') with `-lF' marks the symbolic link
96 itself with a trailing @ (usually the case under Ultrix).
98 Example: if `ln -s foo bar; ls -F bar' gives `bar -> foo', set it to
99 nil (the default), if it gives `bar@ -> foo', set it to t.
101 Dired checks if there is really a @ appended. Thus, if you have a
102 marking `ls' program on one host and a non-marking on another host, and
103 don't care about symbolic links which really end in a @, you can
104 always set this variable to t."
108 ;;;###autoload
110 "Regexp of files to skip when finding first file of a directory.
111 A value of nil means move to the subdir line.
112 A value of t means move to first file."
115 regexp)
119 ;; Use t as default so that moved files "take their markers with them".
120 "Controls marking of renamed files.
121 If t, files keep their previous marks when they are renamed.
122 If a character, renamed files (whether previously marked or not)
123 are afterward marked with that character."
129 "Controls marking of copied files.
130 If t, copied files are marked if and as the corresponding original files were.
131 If a character, copied files are unconditionally marked with that character."
137 "Controls marking of newly made hard links.
138 If t, they are marked if and as the files linked to were marked.
139 If a character, new links are unconditionally marked with that character."
145 "Controls marking of newly made symbolic links.
146 If t, they are marked if and as the files linked to were marked.
147 If a character, new links are unconditionally marked with that character."
153 "If non-nil, Dired tries to guess a default target directory.
154 This means: if there is a dired buffer displayed in the next window,
155 use its current subdir, instead of the current subdir of this dired buffer.
157 The target is used in the prompt for file copy, rename etc."
162 "If non-nil, Dired preserves the last-modified time in a file copy.
163 \(This works on only some systems.)"
167 ; These variables were deleted and the replacements are on files.el.
168 ; We leave aliases behind for back-compatibility.
172 ;;; Hook variables
175 "Run after loading Dired.
176 You can customize key bindings or load extensions with this."
181 "Run at the very end of `dired-mode'."
186 "This hook is run before a dired buffer is read in (created or reverted)."
191 "Hook run after each time a file or directory is read by Dired.
192 After each listing of a file or directory, this hook is run
193 with the buffer narrowed to the listing."
196 ;; Note this can't simply be run inside function `dired-ls' as the hook
197 ;; functions probably depend on the dired-subdir-alist to be OK.
203 "The functions to call when a drop in `dired-mode' is made.
204 See `dnd-protocol-alist' for more information. When nil, behave
205 as in other buffers. Changing this option is effective only for
206 new dired buffers."
212 ;; Internal variables
215 ;; so that you can write things like
216 ;; (let ((dired-marker-char ?X))
217 ;; ;; great code using X markers ...
218 ;; )
219 ;; For example, commands operating on two sets of files, A and B.
220 ;; Or marking files with digits 0-9. This could implicate
221 ;; concentric sets or an order for the marked files.
222 ;; The code depends on dynamic scoping on the marker char.
223 "In Dired, the current mark character.
230 ;; I see no reason ever to make this nil -- rms.
231 ;; (> baud-rate search-slow-speed)
238 ;;;###autoload
240 "The directory name or wildcard spec that this dired directory lists.
241 Local to each dired buffer. May be a list, in which case the car is the
242 directory name and the cdr is the list of files to mention.
251 ;; These regexps must be tested at beginning-of-line, but are also
252 ;; used to search for next matches, so neither omitting "^" nor
253 ;; replacing "^" by "\n" (to make it slightly faster) will work.
256 ;; "Regexp matching a marked line.
257 ;; Important: the match ends just after the marker."
259 ;; The [^:] part after "d" and "l" is to avoid confusion with the
260 ;; DOS/Windows-style drive letters in directory names, like in "d:/foo".
268 "-[-r][-w].[-r][-w][xs][-r][-w]."
274 ;; The subdirectory names in the next two lists are expanded.
276 "Association list of subdirectories and their buffer positions.
277 Each subdirectory has an element: (DIRNAME . STARTMARKER).
278 The order of elements is the reverse of the order in the buffer.
282 "Keeps track of which switches to use for inserted subdirectories.
290 "Regexp matching a maybe hidden subdirectory line in `ls -lR' output.
291 Subexpression 1 is the subdirectory proper, no trailing colon.
292 The match starts at the beginning of the line and ends after the end
297 "Faces used by Dired."
303 "Face used for directory headers."
311 "Face used for dired marks."
319 "Face used for marked files."
327 "Face used for flagged files."
334 ;; Inherit from font-lock-warning-face since with min-colors 8
335 ;; font-lock-comment-face is not colored any more.
337 "Face used to highlight a part of a buffer that needs user attention."
345 ;; Inherit from font-lock-comment-delimiter-face since with min-colors 8
346 ;; font-lock-comment-face is not colored any more.
348 "Face used to highlight permissions of group- and world-writable files."
356 "Face used for subdirectories."
364 "Face used for symbolic links."
372 "Face used for files suffixed with `completion-ignored-extensions'."
380 ;;
381 ;; Dired marks.
383 ;;
384 ;; We make heavy use of MATCH-ANCHORED, since the regexps don't identify the
385 ;; file name itself. We search for Dired defined regexps, and then use the
386 ;; Dired defined function `dired-move-to-filename' before searching for the
387 ;; simple regexp ".+". It is that regexp which matches the file name.
388 ;;
389 ;; Marked files.
392 ;;
393 ;; Flagged files.
396 ;; People who are paranoid about security would consider this more
397 ;; important than other things such as whether it is a directory.
398 ;; But we don't want to encourage paranoia, so our default
399 ;; should be what's most useful for non-paranoids. -- rms.
400 ;;; ;;
401 ;;; ;; Files that are group or world writable.
402 ;;; (list (concat dired-re-maybe-mark dired-re-inode-size
403 ;;; "\\([-d]\\(....w....\\|.......w.\\)\\)")
404 ;;; '(1 dired-warning-face)
405 ;;; '(".+" (dired-move-to-filename) nil (0 dired-warning-face)))
406 ;; However, we don't need to highlight the file name, only the
407 ;; permissions, to win generally. -- fx.
408 ;; Fixme: we could also put text properties on the permission
409 ;; fields with keymaps to frob the permissions, somewhat a la XEmacs.
416 ;;
417 ;; Subdirectories.
420 ;;
421 ;; Symbolic links.
424 ;;
425 ;; Files suffixed with `completion-ignored-extensions'.
427 ;; It is quicker to first find just an extension, then go back to the
428 ;; start of that file name. So we do this complex MATCH-ANCHORED form.
431 ;;
432 ;; Files suffixed with `completion-ignored-extensions'
433 ;; plus a character put in by -F.
439 ;; If the last character is not part of the filename,
440 ;; move back to the start of the filename
441 ;; so it can be fontified.
442 ;; Otherwise, leave point at the end of the line;
443 ;; that way, nothing is fontified.
447 ;;
448 ;; Explicitly put the default face on file names ending in a colon to
449 ;; avoid fontifying them as directory header.
452 ;;
453 ;; Directory headers.
455 )
459 \f
460 ;;; Macros must be defined before they are used, for the byte compiler.
463 "Mark all files for which PREDICATE evals to non-nil.
464 PREDICATE is evaluated on each line, with point at beginning of line.
465 MSG is a noun phrase for the type of files being marked.
466 It should end with a noun that can be pluralized by adding `s'.
467 Return value is the number of files marked, or nil if none were marked."
481 count
482 ,msg
490 distinguish-one-marked)
491 "Eval BODY with point on each marked line. Return a list of BODY's results.
492 If no marked file could be found, execute BODY on the current line.
493 ARG, if non-nil, specifies the files to use instead of the marked files.
494 If ARG is an integer, use the next ARG (or previous -ARG, if
495 ARG<0) files. In that case, point is dragged along. This is
496 so that commands on the next ARG (instead of the marked) files
497 can be chained easily.
498 For any other non-nil value of ARG, use the current file.
499 If optional third arg SHOW-PROGRESS evaluates to non-nil,
500 redisplay the dired buffer after each file is processed.
501 No guarantee is made about the position on the marked line.
502 BODY must ensure this itself if it depends on this.
503 Search starts at the beginning of the buffer, thus the car of the list
504 corresponds to the line nearest to the buffer's bottom. This
505 is also true for (positive and negative) integer values of ARG.
506 BODY should not be too long as it is expanded four times.
508 If DISTINGUISH-ONE-MARKED is non-nil, then if we find just one marked file,
509 return (t FILENAME) instead of (FILENAME)."
510 ;;
511 ;;Warning: BODY must not add new lines before point - this may cause an
512 ;;endless loop.
513 ;;This warning should not apply any longer, sk 2-Sep-1991 14:10.
520 ,arg
526 results))
527 ;; non-nil, non-integer ARG means use current file:
532 ;; remember position of next marked file before BODY
533 ;; can insert lines before the just found file,
534 ;; confusing us by finding the same marked file again
535 ;; and again and...
543 ;; move after last match
552 results
554 ;; save-excursion loses, again
558 "Return the marked files' names as list of strings.
559 The list is in the same order as the buffer, that is, the car is the
560 first marked file.
561 Values returned are normally absolute file names.
562 Optional arg LOCALP as in `dired-get-filename'.
563 Optional second argument ARG, if non-nil, specifies files near
564 point instead of marked files. It usually comes from the prefix
565 argument.
566 If ARG is an integer, use the next ARG files.
567 Any other non-nil value means to use the current file instead.
568 Optional third argument FILTER, if non-nil, is a function to select
569 some of the files--those for which (funcall FILTER FILENAME) is non-nil.
571 If DISTINGUISH-ONE-MARKED is non-nil, then if we find just one marked file,
572 return (t FILENAME) instead of (FILENAME).
573 Don't use that together with FILTER."
578 arg nil distinguish-one-marked)))
579 result)
582 all-of-them
587 result)))
588 \f
589 ;; The dired command
592 ;; For use in interactive.
596 dired-listing-switches))
597 ;; If a dialog is about to be used, call read-directory-name so
598 ;; the dialog code knows we want directories. Some dialogs can
599 ;; only select directories or files when popped up, not both.
602 nil default-directory nil)
604 nil default-directory nil)))))
606 ;; We want to switch to a more sophisticated version of
607 ;; dired-read-dir-and-switches like the following, if there is a way
608 ;; to make it more intuitive. See bug#1285.
610 ;; (defun dired-read-dir-and-switches (str)
611 ;; ;; For use in interactive.
612 ;; (reverse
613 ;; (list
614 ;; (if current-prefix-arg
615 ;; (read-string "Dired listing switches: "
616 ;; dired-listing-switches))
617 ;; ;; If a dialog is about to be used, call read-directory-name so
618 ;; ;; the dialog code knows we want directories. Some dialogs can
619 ;; ;; only select directories or files when popped up, not both.
620 ;; (if (next-read-file-uses-dialog-p)
621 ;; (read-directory-name (format "Dired %s(directory): " str)
622 ;; nil default-directory nil)
623 ;; (let ((cie ()))
624 ;; (dolist (ext completion-ignored-extensions)
625 ;; (if (eq ?/ (aref ext (1- (length ext)))) (push ext cie)))
626 ;; (setq cie (concat (regexp-opt cie "\\(?:") "\\'"))
627 ;; (lexical-let* ((default (and buffer-file-name
628 ;; (abbreviate-file-name buffer-file-name)))
629 ;; (cie cie)
630 ;; (completion-table
631 ;; ;; We need a mix of read-file-name and
632 ;; ;; read-directory-name so that completion to directories
633 ;; ;; is preferred, but if the user wants to enter a global
634 ;; ;; pattern, he can still use completion on filenames to
635 ;; ;; help him write the pattern.
636 ;; ;; Essentially, we want to use
637 ;; ;; (completion-table-with-predicate
638 ;; ;; 'read-file-name-internal 'file-directory-p nil)
639 ;; ;; but that doesn't work because read-file-name-internal
640 ;; ;; does not obey its `predicate' argument.
641 ;; (completion-table-in-turn
642 ;; (lambda (str pred action)
643 ;; (let ((read-file-name-predicate
644 ;; (lambda (f)
645 ;; (and (not (member f '("./" "../")))
646 ;; ;; Hack! Faster than file-directory-p!
647 ;; (eq (aref f (1- (length f))) ?/)
648 ;; (not (string-match cie f))))))
649 ;; (complete-with-action
650 ;; action 'read-file-name-internal str nil)))
651 ;; 'read-file-name-internal)))
652 ;; (minibuffer-with-setup-hook
653 ;; (lambda ()
654 ;; (setq minibuffer-default default)
655 ;; (setq minibuffer-completion-table completion-table))
656 ;; (read-file-name (format "Dired %s(directory): " str)
657 ;; nil default-directory nil))))))))
660 "Try to get a file name at point in the current dired buffer.
661 This hook is inteneded to be put in `file-name-at-point-functions'."
668 ;;;###autoload (define-key ctl-x-map "d" 'dired)
669 ;;;###autoload
672 Optional second argument SWITCHES specifies the `ls' options used.
673 \(Interactively, use a prefix argument to be able to specify SWITCHES.)
674 Dired displays a list of files in DIRNAME (which may also have
675 shell wildcards appended to select certain files). If DIRNAME is a cons,
676 its first element is taken as the directory name and the rest as an explicit
677 list of files to make directory entries for.
679 You can move around in it with the usual commands.
684 If DIRNAME is already in a dired buffer, that buffer is used without refresh."
685 ;; Cannot use (interactive "D") because of wildcards.
689 ;;;###autoload (define-key ctl-x-4-map "d" 'dired-other-window)
690 ;;;###autoload
696 ;;;###autoload (define-key ctl-x-5-map "d" 'dired-other-frame)
697 ;;;###autoload
703 ;;;###autoload
705 "Like `dired' but returns the dired buffer as value, does not select it."
707 ;; This loses the distinction between "/foo/*/" and "/foo/*" that
708 ;; some shells make:
719 ;; If the argument was syntactically a directory name not a file name,
720 ;; or if it happens to name a file that is a directory,
721 ;; convert it syntactically to a directory name.
722 ;; The reason for checking initially-was-dirname
723 ;; and not just file-directory-p
724 ;; is that file-directory-p is slow over ftp.
732 ;; The following is an internal dired function. It returns non-nil if
733 ;; the directory visited by the current dired buffer has changed on
734 ;; disk. DIRNAME should be the directory name of that directory.
743 "Return non-nil if current dired buffer needs updating.
744 If NOCONFIRM is non-nil, then this function always returns nil
745 for a remote directory. This feature is used by Auto Revert Mode."
751 ;; Do not auto-revert when the dired buffer can be currently
752 ;; written by the user as in `wdired-mode'.
753 buffer-read-only
756 ;;;###autoload
758 "Automatically revert dired buffer on revisiting.
759 If t, revisiting an existing dired buffer automatically reverts it.
760 If its value is a function, call this function with the directory
761 name as single argument and revert the buffer if it returns non-nil.
762 Otherwise, a message offering to revert the changed dired buffer
763 is displayed.
764 Note that this is not the same as `auto-revert-mode' that
765 periodically reverts at specified time intervals."
775 ;; If there is an existing dired buffer for DIRNAME, just leave
776 ;; buffer as it is (don't even call dired-revert).
777 ;; This saves time especially for deep trees or with ange-ftp.
778 ;; The user can type `g' easily, and it is more consistent with find-file.
779 ;; But if SWITCHES are given they are probably different from the
780 ;; buffer's old value, so call dired-sort-other, which does
781 ;; revert the buffer.
782 ;; A pity we can't possibly do "Directory has changed - refresh? "
783 ;; like find-file does.
784 ;; Optional argument MODE is passed to dired-find-buffer-nocreate,
785 ;; see there.
788 ;; Look for an existing buffer.
790 ;; Note that buffer already is in dired-mode, if found.
797 ;; file list may have changed
799 ;; this calls dired-revert
801 ;; Always revert regardless of whether it has changed or not.
804 ;; Revert when predicate function returns non-nil.
809 ;; If directory has changed on disk, offer to revert.
814 ;; Else a new buffer
816 ;; We can do this unconditionally
817 ;; because dired-noselect ensures that the name
818 ;; is passed in directory name syntax
819 ;; if it was the name of a directory at all.
824 ;; default-directory and dired-actual-switches are set now
825 ;; (buffer-local), so we can call dired-readin:
830 ;; dired-readin can fail if parent directories are inaccessible.
831 ;; Don't leave an empty buffer around in that case.
836 buffer))
839 ;; Enlarged by dired-advertise
840 ;; Queried by function dired-buffers-for-dir. When this detects a
841 ;; killed buffer, it is removed from this list.
845 ;; This differs from dired-buffers-for-dir in that it does not consider
846 ;; subdirs of default-directory and searches for the first match only.
847 ;; Also, the major mode must be MODE.
856 dired-directory ;; nil during find-alternate-file
861 dired-directory))))
863 blist nil)
865 found))
867 \f
868 ;; Read in a new dired buffer
871 "Read in a new dired buffer.
872 Differs from `dired-insert-subdir' in that it accepts
873 wildcards, erases the buffer, and builds the subdir-alist anew
874 \(including making it buffer-local and clearing it first)."
876 ;; default-directory and dired-actual-switches must be buffer-local
877 ;; and initialized by now.
879 ;; This makes readin much much faster.
880 ;; In particular, it prevents the font lock hook from running
881 ;; until the directory is all read in.
888 ;; This hook which may want to modify dired-actual-switches
889 ;; based on dired-directory, e.g. with ange-ftp to a SysV host
890 ;; where ls won't understand -Al switches.
898 ;; Don't make undo entries for readin.
904 ;; Must first make alist buffer local and set it to nil because
905 ;; dired-build-subdir-alist will call dired-clear-alist first
912 ;; No need to narrow since the whole buffer contains just
913 ;; dired-readin's output, nothing else. The hook can
914 ;; successfully use dired functions (e.g. dired-get-filename)
915 ;; as the subdir-alist has been built in dired-readin.
918 ;; Subroutines of dired-readin
921 ;; Insert listing for the specified dir (and maybe file list)
922 ;; already in dired-directory, assuming a clean buffer.
928 file-list nil))
932 ;; If we are reading a whole single directory...
937 ;; Else treat it as a wildcard spec
938 ;; unless we have an explicit list of files.
943 "Align the fields of a file to the ones of surrounding lines.
944 BEG..END is the line where the file info is located."
945 ;; Some versions of ls try to adjust the size of each field so as to just
946 ;; hold the largest element ("largest" in the current invocation, of
947 ;; course). So when a single line is output, the size of each field is
948 ;; just big enough for that one output. Thus when dired refreshes one
949 ;; line, the alignment if this line w.r.t the rest is messed up because
950 ;; the fields of that one line will generally be smaller.
951 ;;
952 ;; To work around this problem, we here add spaces to try and
953 ;; re-align the fields as needed. Since this is purely aesthetic,
954 ;; it is of utmost importance that it doesn't mess up anything like
955 ;; `dired-move-to-filename'. To this end, we limit ourselves to
956 ;; adding spaces only, and to only add them at places where there
957 ;; was already at least one space. This way, as long as
958 ;; `directory-listing-before-filename-regexp' always matches spaces
959 ;; with "*" or "+", we know we haven't made anything worse. There
960 ;; is one spot where the exact number of spaces is important, which
961 ;; is just before the actual filename, so we refrain from adding
962 ;; spaces there (and within the filename as well, of course).
965 ;; Check that there is indeed a file, and that there is anoter adjacent
966 ;; file with which to align, and that additional spaces are needed to
967 ;; align the filenames.
980 ;; Make sure there is some work left to do.
982 ;; If we've only looked at the line above, check to see if the line
983 ;; below exists as well and if so, align with the shorter one.
992 ;; Keep positions uptodate when we insert stuff.
995 ;; Main loop.
999 ;; Don't touch anything just before (and after) the
1000 ;; beginning of the filename.
1002 ;; We're now just in front of a field, with a space behind us.
1004 ;; Nums are right-aligned.
1006 ;; Let's look at the other line, in the same column: we
1007 ;; should be either near the end of the previous field, or
1008 ;; in the space between that field and the next.
1009 ;; [ Of course, it's also possible that we're already within
1010 ;; the next field or even past it, but that's unlikely since
1011 ;; other-col > file-col. ]
1012 ;; Let's find the distance to the alignment-point (either
1013 ;; the beginning or the end of the next field, depending on
1014 ;; whether this field is left or right aligned).
1024 ;; Now, the number of spaces to insert is align-pt-offset
1025 ;; minus the distance to the equivalent point on the
1026 ;; current line.
1029 align-pt-offset
1039 ;; Let's just make really sure we did not mess up.
1042 ;; Damn! We messed up: let's revert the change.
1044 ;; Now skip to next field.
1050 "Insert a directory listing of DIR, Dired style.
1051 Use SWITCHES to make the listings.
1052 If FILE-LIST is non-nil, list only those files.
1053 Otherwise, if WILDCARD is non-nil, expand wildcards;
1054 in that case, DIR should be a file name that uses wildcards.
1055 In other cases, DIR should be a directory name or a directory filename.
1056 If HDR is non-nil, insert a header line with the directory name."
1059 end)
1062 ;; We used to specify the C locale here, to force English month names;
1063 ;; but this should not be necessary any more,
1064 ;; with the new value of `directory-listing-before-filename-regexp'.
1069 ;; Re-align fields, if necessary.
1072 ;; Quote certain characters, unless ls quoted them for us.
1081 nil t))
1087 nil t))
1090 ;; If we used --dired and it worked, the lines are already indented.
1091 ;; Otherwise, indent them.
1097 ;; Insert text at the beginning to standardize things.
1103 ;; Note that dired-build-subdir-alist will replace the name
1104 ;; by its expansion, so it does not matter whether what we insert
1105 ;; here is fully expanded, but it should be absolute.
1108 ;; Insert "wildcard" line where "total" line would be for a full dir.
1112 "Make the file names highlight when the mouse is on them."
1124 dired-filename t
1128 \f
1129 ;; Reverting a dired buffer
1132 "Reread the dired buffer.
1133 Must also be called after `dired-actual-switches' have changed.
1134 Should not fail even on completely garbaged buffers.
1135 Preserves old cursor, marks/flags, hidden-p."
1147 ;; treat top level dir extra (it may contain wildcards)
1154 ;; Run dired-after-readin-hook just once, below.
1159 ;; ... run the hook for the whole buffer, and only after markers
1160 ;; have been reinserted (else omitting in dired-x would omit marked files)
1168 ;; outside of the let scope
1169 ;;; Might as well not override the user if the user changed this.
1170 ;;; (setq buffer-read-only t)
1171 )
1173 ;; Subroutines of dired-revert
1174 ;; Some of these are also used when inserting subdirs.
1177 "Return current positions in the buffer and all windows with this directory.
1178 The positions have the form (BUFFER-POSITION WINDOW-POSITIONS).
1180 BUFFER-POSITION is the point position in the current dired buffer.
1181 The buffer position have the form (BUFFER DIRED-FILENAME BUFFER-POINT).
1183 WINDOW-POSITIONS are current positions in all windows displaying
1184 this dired buffer. The window positions have the form (WINDOW
1185 DIRED-FILENAME WINDOW-POINT)."
1196 "Restore POSITIONS saved with `dired-save-positions'."
1204 ;; Ensure that window still displays the original buffer.
1213 "Return alist of files and their marks, from BEG to END."
1224 alist))
1227 "Mark all files remembered in ALIST.
1228 Each element of ALIST looks like (FILE . MARKERCHAR)."
1242 "Return a list of names of subdirs currently hidden."
1252 result))
1255 "Try to insert all subdirs that were displayed before.
1256 Do so according to the former subdir alist OLD-SUBDIR-ALIST."
1270 "Remove directory DIR from any directory cache."
1274 \f
1275 ;; dired mode key bindings and initialization
1278 ;; This looks ugly when substitute-command-keys uses C-d instead d:
1279 ;; (define-key dired-mode-map "\C-d" 'dired-flag-file-deletion)
1284 ;; Commands to mark or flag certain categories of files
1288 ;; Upper case keys (except !) for operating on the marked files
1307 ;; Comparison commands
1310 ;; Tree Dired commands
1316 ;; move to marked files
1319 ;; Make all regexp commands share a `%' prefix:
1320 ;; We used to get to the submap via a symbol dired-regexp-prefix,
1321 ;; but that seems to serve little purpose, and copy-keymap
1322 ;; does a better job without it.
1335 ;; Commands for marking and unmarking.
1352 ;; Lower keys for commands not operating on all the marked files
1379 ;; moving
1386 ;; hiding
1389 ;; isearch
1394 ;; misc
1400 ;; thumbnail manipulation (image-dired)
1413 ;; encryption and decryption (epa-dired)
1419 ;; Make menu bar items.
1421 ;; No need to fo this, now that top-level items are fewer.
1422 ;;;;
1423 ;; Get rid of the Edit menu bar item to save space.
1424 ;(define-key map [menu-bar edit] 'undefined)
1529 ;; When running on plain MS-DOS, there's only one
1530 ;; letter-case for file names.
1718 map)
1720 \f
1721 ;; Dired mode is suitable only for specially formatted data.
1724 ;; Autoload cookie needed by desktop.el
1725 ;;;###autoload
1727 "\
1730 \(optionally) its subdirectories, in the format of `ls -lR'.
1733 compress, load or byte-compile them, change their file attributes
1736 by file or all files matching certain criteria.
1738 Letters no longer insert themselves. Digits are prefix arguments.
1741 Most commands operate on the marked files and use the current file
1742 if no files are marked. Use a numeric prefix argument to operate on
1743 the next ARG (or previous -ARG if ARG<0) files, or just `1'
1744 to operate on the current file only. Prefix arguments override marks.
1746 to see why something went wrong.
1751 (or dired it in another buffer, if it is a directory).
1758 This retains all marks and hides subdirs again that were hidden before.
1759 SPC and DEL can be used to move down and up by lines.
1762 to read the
1764 to relist a single or the marked files or a
1766 again for the directory tree.
1769 for more info):
1771 `dired-listing-switches'
1772 `dired-trivial-filenames'
1773 `dired-shrink-to-fit'
1774 `dired-marker-char'
1775 `dired-del-marker'
1776 `dired-keep-marker-rename'
1777 `dired-keep-marker-copy'
1778 `dired-keep-marker-hardlink'
1779 `dired-keep-marker-symlink'
1783 `dired-before-readin-hook'
1784 `dired-after-readin-hook'
1785 `dired-mode-hook'
1786 `dired-load-hook'
1788 Keybindings:
1790 ;; Not to be called interactively (e.g. dired-directory will be set
1791 ;; to default-directory, which is wrong with wildcards).
1796 mode-name "Dired"
1797 ;; case-fold-search nil
1798 buffer-read-only t
1799 selective-display t ; for subdirectory hiding
1800 mode-line-buffer-identification
1810 ;; list-buffers uses this to display the dir being edited in this buffer.
1814 dired-directory)))
1829 \f
1830 ;; Idiosyncratic dired commands that don't deal with marks.
1833 "Summarize basic Dired commands and show recent dired errors."
1836 ;>> this should check the key-bindings and use substitute-command-keys if non-standard
1841 "Undo in a dired buffer.
1842 This doesn't recover lost files, it just undoes changes in the buffer itself.
1843 You can use it to recover marks, killed lines or subdirs."
1852 "Edit dired buffer with Wdired, or set it read-only.
1853 Call `wdired-change-to-wdired-mode' in dired buffers whose editing is
1854 supported by Wdired (the major mode of the dired buffer is `dired-mode').
1855 Otherwise, for buffers inheriting from dired-mode, call `toggle-read-only'."
1862 "Move down lines then position at filename.
1863 Optional prefix ARG says how many lines to move; default is one line."
1869 "Move up lines then position at filename.
1870 Optional prefix ARG says how many lines to move; default is one line."
1876 "Goto ARG'th next directory file line."
1888 "Goto ARG'th previous directory file line."
1893 "Run Dired on parent directory of current directory.
1894 Find the parent directory either in this buffer or another buffer.
1895 Creates a buffer if necessary."
1900 ;; Only try dired-goto-subdir if buffer has more than one dir.
1910 "Get the current line's file name, with an error if file does not exist."
1912 ;; We pass t for second arg so that we don't get error for `.' and `..'.
1914 file-name)
1919 file-name
1924 ;; Force C-m keybinding rather than `f' or `e' in the mode doc:
1927 "In Dired, visit the file or directory named on this line."
1929 ;; Bind `find-file-run-dired' so that the command works on directories
1930 ;; too, independent of the user's setting.
1935 "In Dired, visit this file or directory instead of the dired buffer."
1939 ;; Don't override the setting from .emacs.
1940 ;;;###autoload (put 'dired-find-alternate-file 'disabled t)
1943 "In Dired, visit the file or directory name you click on."
1964 "In Dired, examine a file in view mode, returning to Dired when done.
1965 When file is a directory, show it in this buffer if it is inserted.
1966 Otherwise, display it in another buffer."
1976 "In Dired, visit this file or directory in another window."
1981 "In Dired, display this file or directory in another window."
1984 \f
1985 ;;; Functions for extracting and manipulating file names in Dired buffers.
1988 "In Dired, return name of file mentioned on this line.
1989 Value returned normally includes the directory name.
1990 Optional arg LOCALP with value `no-dir' means don't include directory
1991 name in result. A value of `verbatim' means to return the name exactly as
1992 it occurs in the buffer, and a value of t means construct name relative to
1993 `default-directory', which still may contain slashes if in a subdirectory.
1994 Optional arg NO-ERROR-IF-NOT-FILEP means treat `.' and `..' as
1995 regular filenames and return nil if no filename on this line.
1996 Otherwise, an error occurs in these cases."
2001 ;; nil if no file on this line, but no-error-if-not-filep is t:
2004 ;; Get rid of the mouse-face property that file names have.
2006 ;; Unquote names quoted by ls or by dired-insert-directory.
2007 ;; This code was written using `read' to unquote, because
2008 ;; it's faster than substituting \007 (4 chars) -> ^G (1
2009 ;; char) etc. in a lisp loop. Unfortunately, this decision
2010 ;; has necessitated hacks such as dealing with filenames
2011 ;; with quotation marks in their names.
2015 ;; The above `read' will return a unibyte string if FILE
2016 ;; contains eight-bit-control/graphic characters.
2021 ;; A relative file name can start with ~.
2022 ;; Don't treat it as absolute in this context.
2027 nil)
2029 file)
2037 ;; check for safe-magic property so that we won't
2038 ;; put /: for names that don't really need them.
2039 ;; For instance, .gz files when auto-compression-mode is on.
2042 file)))
2044 file)
2048 ;; check for safe-magic property so that we won't
2049 ;; put /: for names that don't really need them.
2050 ;; For instance, .gz files when auto-compression-mode is on.
2053 file)))
2059 "Replace first match of REGEXP in STRING with NEWTEXT.
2060 If it does not match, nil is returned instead of the new string.
2061 Optional arg LITERAL means to take NEWTEXT literally.
2062 Optional arg GLOBAL means to replace all matches."
2069 ret)
2071 nil
2075 ;;"Convert FILE (a file name relative to DIR) to an absolute file name."
2076 ;; We can't always use expand-file-name as this would get rid of `.'
2077 ;; or expand in / instead default-directory if DIR=="".
2078 ;; This should be good enough for ange-ftp.
2079 ;; It should be reasonably fast, though, as it is called in
2080 ;; dired-get-filename.
2084 "Convert FILE (an absolute file name) to a name relative to DIR.
2085 If this is impossible, return FILE unchanged.
2086 DIR must be a directory name, not a file name."
2088 ;; This case comes into play if default-directory is set to
2089 ;; use ~.
2094 ;;; (or no-error
2095 ;;; (error "%s: not in directory tree growing at %s" file dir))
2096 file))
2097 \f
2098 ;;; Functions for finding the file name in a dired buffer line.
2104 ;; Move to first char of filename on this line.
2105 ;; Returns position (point) or nil if no filename on this line."
2107 "Move to the beginning of the filename on the current line.
2108 Return the position of the beginning of the filename, or nil if none found."
2109 ;; This is the UNIX version.
2112 ;; First try assuming `ls --dired' was used.
2120 ;; Ha! There *is* a file. Our regexp-from-hell just failed to find it.
2124 nil)
2129 ;; Assumes point is at beginning of filename,
2130 ;; thus the rwx bit re-search-backward below will succeed in *this*
2131 ;; line if at all. So, it should be called only after
2132 ;; (dired-move-to-filename t).
2133 ;; On failure, signals an error (with non-nil NO-ERROR just returns nil).
2134 ;; This is the UNIX version.
2138 ;; case-fold-search is nil now, so we can test for capital F:
2145 nil
2147 ;; Restrict perm bits to be non-blank,
2148 ;; otherwise this matches one char to early (looking backward):
2149 ;; "l---------" (some systems make symlinks that way)
2150 ;; "----------" (plain file with zero perms)
2152 dired-permission-flags-regexp nil t)
2155 ;; Only with -F we need to know whether it's an executable
2157 used-F
2165 ;; Move point to end of name:
2171 dired-ls-F-marks-symlinks
2175 ;; ls -lF marks dirs, sockets, fifos and executables with exactly
2176 ;; one trailing character. (Executable bits on symlinks ain't mean
2177 ;; a thing, even to ls, but we know it's not a symlink.)
2180 executable)
2189 nil
2192 \f
2193 ;;; COPY NAMES OF MARKED FILES INTO KILL-RING.
2196 "Copy names of marked (or next ARG) files into the kill ring.
2197 The names are separated by a space.
2198 With a zero prefix arg, use the absolute file name of each marked file.
2200 `default-directory'. (This still may contain slashes if in a subdirectory.)
2202 If on a subdir headerline, use absolute subdirname instead;
2203 prefix arg and marked files are ignored in this case.
2225 \f
2226 ;; Keeping Dired buffers in sync with the filesystem and with each other
2229 ;; Return a list of buffers for DIR (top level or in-situ subdir).
2230 ;; If FILE is non-nil, include only those whose wildcard pattern (if any)
2231 ;; matches FILE.
2232 ;; The list is in reverse order of buffer creation, most recent last.
2233 ;; As a side effect, killed dired buffers for DIR are removed from
2234 ;; dired-buffers.
2241 ;; Buffer is killed - clean up:
2249 dired-directory)))
2252 file)))
2256 result))
2259 "Convert glob-pattern PATTERN to a regular expression."
2261 regexp)
2273 ;; Fails to handle ^ yet ????
2287 regexp
2295 ;;"Advertise in variable `dired-buffers' that we dired `default-directory'."
2296 ;; With wildcards we actually advertise too much.
2299 t ; we have already advertised ourselves
2302 dired-buffers)))))
2305 ;; Remove DIR from the buffer alist in variable dired-buffers.
2306 ;; This has the effect of removing any buffer whose main directory is DIR.
2307 ;; It does not affect buffers in which DIR is a subdir.
2308 ;; Removing is also done as a side-effect in dired-buffer-for-dir.
2311 \f
2312 ;; Tree Dired
2314 ;;; utility functions
2317 ;;"Is FILE part of the directory tree starting at DIR?"
2322 ;; Prepend default-directory to DIR if relative file name.
2323 ;; dired-get-filename must be able to make a valid file name from a
2324 ;; file and its directory DIR.
2327 dir
2331 ;;"Return the subdir name on this line, or nil if not on a headerline."
2332 ;; Look up in the alist whether this is a headerline.
2338 dired-subdir-alist))))
2339 cur-dir))))
2341 ;(defun dired-get-subdir-min (elt)
2342 ; (cdr elt))
2343 ;; can't use macro, must be redefinable for other alist format in dired-nstd.
2357 ;; Return an index into alist for use with nth
2358 ;; for the sake of subdir moving commands.
2367 "Go to next subdirectory, regardless of level."
2368 ;; Use 0 arg to go to this directory's header line.
2369 ;; NO-SKIP prevents moving to end of header line, returning whatever
2370 ;; position was found in dired-subdir-alist.
2373 pos index)
2374 ;; nth with negative arg does not return nil but the first element
2384 nil ; return nil if not found
2388 "Build `dired-subdir-alist' by parsing the buffer.
2389 Returns the new value of the alist.
2390 If optional arg SWITCHES is non-nil, use its value
2391 instead of `dired-actual-switches'."
2399 new-dir-name
2401 ;; Used to expand subdirectory names correctly in recursive
2402 ;; ange-ftp listings.
2409 ;; Avoid taking a file name ending in a colon
2410 ;; as a subdir name.
2420 new-dir-name
2432 ;; Place a sub directory boundary between lines.
2439 ;; We don't need to sort it because it is in buffer order per
2440 ;; constructionem. Return new alist:
2441 dired-subdir-alist))
2444 ;; Add new DIR at NEW-MARKER. Don't sort.
2447 dired-subdir-alist)))
2450 ;; Position point on first nontrivial file after point.
2466 "Go to line describing file FILE in this dired buffer."
2467 ;; Return value of point on success, else nil.
2468 ;; FILE must be an absolute file name.
2469 ;; Loses if FILE contains control chars like "\007" for which ls
2470 ;; either inserts "?" or "\\007" into the buffer, so we won't find
2471 ;; it in the buffer.
2483 ;; The hair here is to get the result of dired-goto-subdir
2484 ;; without really calling it if we don't have any subdirs.
2490 search-string
2497 ;; filenames are preceded by SPC, this makes
2498 ;; the search faster (e.g. for the filename "-"!).
2501 ;; Match could have BASE just as initial substring or
2502 ;; or in permission bits or date or
2503 ;; not be a proper filename at all:
2505 ;; Must move to filename since an (actually
2506 ;; correct) match could have been elsewhere on the
2507 ;; ;; line (e.g. "-" would match somewhere in the
2508 ;; permission bits).
2510 ;; If this isn't the right line, move forward to avoid
2511 ;; trying this line again.
2514 ;; return value of point (i.e., FOUND):
2518 ;; Where point should go in a new listing of DIRNAME.
2519 ;; Point assumed at beginning of new subdir line.
2520 ;; You may redefine this function as you wish, e.g. like in dired-x.el.
2523 \f
2524 ;; These are hooks which make tree dired work.
2525 ;; They are in this file because other parts of dired need to call them.
2526 ;; But they don't call the rest of tree dired unless there are subdirs loaded.
2528 ;; This function is called for each retrieved filename.
2529 ;; It could stand to be faster, though it's mostly function call
2530 ;; overhead. Avoiding the function call seems to save about 10% in
2531 ;; dired-get-filename. Make it a defsubst?
2533 "Return the name of the subdirectory to which this line belongs.
2534 This returns a string with trailing slash, like `default-directory'.
2535 Optional argument means return a file name relative to `default-directory'."
2538 ;; probably because called in a non-dired buffer
2540 elt dir)
2544 ;; use `<=' (not `<') as subdir line is part of subdir
2546 nil ; found
2550 dir)))
2552 ;; Subdirs start at the beginning of their header lines and end just
2553 ;; before the beginning of the next header line (or end of buffer).
2560 \f
2561 ;; Deleting files
2564 "Decide whether recursive deletes are allowed.
2565 A value of nil means no recursive deletes.
2566 `always' means delete recursively without asking. This is DANGEROUS!
2567 `top' means ask for each directory at top level, but delete its subdirectories
2568 without asking.
2569 Anything else means ask for each directory."
2577 ;; Match anything but `.' and `..'.
2580 ;; Delete file, possibly delete a directory and all its files.
2581 ;; This function is usefull outside of dired. One could change it's name
2582 ;; to e.g. recursive-delete-file and put it somewhere else.
2584 Delete FILE or directory (possibly recursively if optional RECURSIVE is true.)
2585 RECURSIVE determines what to do with a non-empty directory. If RECURSIVE is:
2586 nil, do not delete.
2587 `always', delete recursively without asking.
2588 `top', ask for each directory at top level.
2589 Anything else, ask for each sub-directory."
2590 ;; This test is equivalent to
2591 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
2592 ;; but more efficient
2600 delete-by-moving-to-trash)
2601 "trash"
2609 "In Dired, delete the files flagged for deletion.
2610 If NOMESSAGE is non-nil, we don't display any message
2611 if there are no flagged files.
2612 `dired-recursive-deletes' controls whether deletion of
2613 non-empty directories is allowed."
2617 case-fold-search)
2621 ;; this can't move point since ARG is nil
2623 nil)
2624 nil t)
2629 "Delete all marked (or next ARG) files.
2630 `dired-recursive-deletes' controls whether deletion of
2631 non-empty directories is allowed."
2632 ;; This is more consistent with the file marking feature than
2633 ;; dired-do-flagged-delete.
2636 ;; this may move point if ARG is an integer
2638 arg)
2639 arg t))
2644 ;; L is an alist of files to delete, with their buffer positions.
2645 ;; ARG is the prefix arg.
2646 ;; Filenames are absolute.
2647 ;; (car L) *must* be the *last* (bottommost) file in the dired buffer.
2648 ;; That way as changes are made in the buffer they do not shift the
2649 ;; lines still to be changed, so the (point) values in L stay valid.
2650 ;; Also, for subdirs in natural order, a subdir's files are deleted
2651 ;; before the subdir itself - the other way around would not work.
2659 succ count)))
2660 ;; canonicalize file list for pop up
2675 ;; if we get here, removing worked
2691 failures))))
2696 ;; In all buffers dired'ing DIRECTORY, run FUN with ARGS.
2697 ;; If the buffer has a wildcard pattern, check that it matches FILE.
2698 ;; (FILE does not include a directory component.)
2699 ;; FILE may be nil, in which case ignore it.
2700 ;; Return list of buffers where FUN succeeded (i.e., returned non-nil).
2703 file))
2707 success-list))
2709 ;; Delete the entry for FILE from
2718 ;; This is a separate function for the sake of dired-x.el.
2720 ;; Clean up after a deleted file or directory FN.
2724 \f
2725 ;; Confirmation
2734 "Return a string for use in a prompt, either the current file
2735 name, or the marker and a count of marked files."
2736 ;; distinguish-one-marked can cause the first element to be just t.
2741 ;; more than 1 file:
2743 ;; abs(arg) = count
2744 ;; Perhaps this is nicer, but it also takes more screen space:
2745 ;;(format "[%s %d files]" (if (> arg 0) "next" "previous")
2746 ;; count)
2751 "Pop up buffer BUF in a way suitable for Dired."
2756 ;; Try to split the selected window vertically if
2757 ;; that's possible. (Bug#1806)
2759 ;; Otherwise, try to split WINDOW sensibly.
2762 ;; If dired-shrink-to-fit is t, make its window fit its contents.
2764 ;; Try to not delete window when we want to display less than
2765 ;; `window-min-height' lines.
2769 "A list of symbols for commands Dired should not confirm, or t.
2770 Command symbols are `byte-compile', `chgrp', `chmod', `chown', `compress',
2771 `copy', `delete', `hardlink', `load', `move', `print', `shell', `symlink',
2772 `touch' and `uncompress'.
2773 If t, confirmation is never needed."
2784 "Return FUNCTION's result on ARGS after showing which files are marked.
2785 Displays the file names in a buffer named BUFNAME;
2787 This uses function `dired-pop-to-buffer' to do that.
2789 FUNCTION should not manipulate files, just read input
2790 (an argument or confirmation).
2791 The window is not shown if there is just one file or
2792 OP-SYMBOL is a member of the list in `dired-no-confirm'.
2793 FILES is the list of marked files. It can also be (t FILENAME)
2794 in the case of one marked file, to distinguish that from using
2795 just the current file."
2799 ;; If FILES defaulted to the current line's file.
2804 ;; Handle (t FILE) just like (FILE), here.
2805 ;; That value is used (only in some cases), to mean
2806 ;; just one file that was marked, rather than the current line file.
2818 \f
2819 ;; Commands to mark or flag file(s) at or near current line.
2822 ;; This version skips non-file lines.
2833 ;; Advance to the next line--actually, to the line that *was* next.
2834 ;; (If FUNCTION inserted some new lines in between, skip them.)
2846 ;; This used to be a regexp match of the `total ...' line output by
2847 ;; ls, which is slightly faster, but that is not very robust; notably,
2848 ;; it fails for non-english locales.
2852 "Move to the next marked file, wrapping around the end of the buffer."
2869 "Move to the previous marked file, wrapping around the end of the buffer."
2874 ;; Return FILE's marker, or nil if unmarked.
2888 ;; Skip subdir line and following garbage like the `total' line:
2899 "Mark the current (or next ARG) files.
2900 If on a subdir headerline, mark all its files except `.' and `..'.
2904 this subdir."
2914 "Unmark the current (or next ARG) files.
2915 If looking at a subdir, unmark all its files except `.' and `..'."
2921 "In Dired, flag the current line's file for deletion.
2922 With prefix arg, repeat over several lines.
2924 If on a subdir headerline, mark all its files except `.' and `..'."
2930 "In Dired, move up lines and remove deletion flag there.
2931 Optional prefix ARG says how many lines to unflag; default is one line."
2936 "Toggle marks: marked files become unmarked, and vice versa.
2937 Files marked with other flags (such as `D') are not affected.
2938 `.' and `..' are never toggled.
2939 As always, hidden subdirs are not affected."
2947 ;; use subst instead of insdel because it does not move
2948 ;; the gap and thus should be faster and because
2949 ;; other characters are left alone automatically
2956 \f
2957 ;;; Commands to mark or flag files based on their characteristics or names.
2966 "Mark all files matching REGEXP for use in later commands.
2967 A prefix argument means to unmark them instead.
2968 `.' and `..' are never marked.
2971 object files--just `.o' will mark more than you might think."
2985 "Mark all files with contents containing REGEXP for use in later commands.
2986 A prefix argument means to unmark them instead.
2987 `.' and `..' are never marked."
3001 ;; For now we do it inside emacs
3002 ;; Grep might be better if there are a lot of files
3012 )))
3016 "In Dired, flag all files containing the specified REGEXP for deletion.
3017 The match is against the non-directory part of the filename. Use `^'
3018 and `$' to anchor matches. Exclude subdirs by hiding them.
3019 `.' and `..' are never flagged."
3024 "Mark all symbolic links.
3025 With prefix argument, unflag all those files."
3031 "Mark all directory file lines except `.' and `..'.
3032 With prefix argument, unflag all those files."
3040 "Mark all executable files.
3041 With prefix argument, unflag all those files."
3046 ;; dired-x.el has a dired-mark-sexp interactive command: mark
3047 ;; files for which PREDICATE returns non-nil.
3050 "Flag for deletion files whose names suggest they are auto save files.
3051 A prefix argument says to unflag those files instead."
3055 ;; It is less than general to check for # here,
3056 ;; but it's the only way this runs fast enough.
3060 ;; Handle executables in case of -F option.
3061 ;; We need not worry about the other kinds
3062 ;; of markings that -F makes, since they won't
3063 ;; appear on real auto-save files.
3075 ;; `log' here is dubious, since it's typically used for useful log
3076 ;; files, not just TeX stuff. -- fx
3085 "Flag for deletion all files that match `dired-garbage-files-regexp'."
3090 "Flag all backup files (names ending with `~') for deletion.
3091 With prefix argument, unflag these files."
3095 ;; Don't call backup-file-name-p unless the last character looks like
3096 ;; it might be the end of a backup file name. This isn't very general,
3097 ;; but it's the only way this runs fast enough.
3099 ;; Handle executables in case of -F option.
3100 ;; We need not worry about the other kinds
3101 ;; of markings that -F makes, since they won't
3102 ;; appear on real backup files.
3112 "Change all OLD marks to NEW marks.
3113 OLD and NEW are both characters used to mark files."
3130 t)
3135 "Remove all marks from all files in the dired buffer."
3140 "Remove a specific mark (or any mark) from every file.
3141 After this command, type the mark character to remove,
3142 or type RET to remove all marks.
3143 With prefix arg, query for each marked file.
3151 Type SPC or `y' to unmark one file, DEL or `n' to skip to next,
3161 file))))
3167 count))))
3168 \f
3169 ;; Logging failures operating on files, and showing the results.
3174 "Pop up a buffer with error log output from Dired.
3175 A group of errors from a single command ends with a formfeed.
3191 ;; Log a message or the contents of a buffer.
3192 ;; If LOG is a string and there are more args, it is formatted with
3193 ;; those ARGS. Usually the LOG string ends with a \n.
3194 ;; End each bunch of errors with (dired-log t):
3195 ;; this inserts the current time and buffer at the start of the page,
3196 ;; and \f (formfeed) at the end.
3204 log)))
3217 "State a summary of a command's failures, in echo area and log buffer.
3218 STRING is an overall summary of the failures.
3219 FAILURES is a list of file names that we failed to operate on,
3220 or nil if file names are not applicable."
3230 string failures))
3231 ;; Log a summary describing a bunch of errors.
3234 \f
3235 ;;; Sorting
3237 ;; Most ls can only sort by name or by date (with -t), nothing else.
3238 ;; GNU ls sorts on size with -S, on extension with -X, and unsorted with -U.
3239 ;; So anything that does not contain these is sort "by name".
3244 This indicates to Dired which option switches to watch out for because they
3245 will change the sorting order behavior of `ls'.
3247 To change the default sorting order \(e.g. add a `-v' option\), see the
3248 variable `dired-listing-switches'. To temporarily override the listing
3261 "Non-nil means the Dired sort command is disabled.
3265 ;; Set modeline display according to dired-actual-switches.
3266 ;; Modeline display of "by name" or "by date" guarantees the user a
3267 ;; match with the corresponding regexps. Non-matching switches are
3268 ;; shown literally.
3273 dired-sort-by-name-regexp dired-actual-switches)
3276 dired-sort-by-date-regexp dired-actual-switches)
3283 "Toggle between sort by date/name and refresh the dired buffer.
3284 With a prefix argument you can edit the current listing switches instead."
3294 ;; Toggle between sort by date/name. Reverts the buffer.
3298 ;; New toggle scheme: add/remove a trailing " -t"
3302 ;; old toggle scheme: look for some 't' switch and add/remove it
3304 "-l"
3307 ""
3308 dired-actual-switches)
3310 dired-actual-switches)
3311 ""
3316 ;; Some user code loads dired especially for this.
3317 ;; Don't do that--use replace-regexp-in-string instead.
3319 ;; Replace REGEXP with NEWTEXT everywhere in STRING and return result.
3320 ;; NEWTEXT is taken literally---no \\DIGIT escapes will be recognized.
3326 start me))
3330 "Specify new `ls' SWITCHES for current dired buffer.
3331 Values matching `dired-sort-by-date-regexp' or `dired-sort-by-name-regexp'
3332 set the minor mode accordingly, others appear literally in the mode line.
3333 With optional second arg NO-REVERT, don't refresh the listing afterwards."
3344 "Additional processing of -R in ls option string SWITCHES.
3345 Saves `dired-subdir-alist' when R is set and restores saved value
3346 minus any directories explicitly deleted when R is cleared.
3347 To be called first in body of `dired-sort-other', etc."
3351 ;; Adding -R to ls switches -- save `dired-subdir-alist':
3355 ;; Deleting -R from ls switches -- revert to pre-R subdirs
3356 ;; that are still present:
3362 dired-subdir-alist)
3363 ;; subdir still present...
3366 subdirs)))
3370 ;; No pre-R subdir alist, so revert to main directory
3371 ;; listing:
3373 \f
3375 ;;;; Drag and drop support
3378 "Decide whether recursive copies are allowed.
3379 A value of nil means no recursive copies.
3380 `always' means copy recursively without asking.
3381 `top' means ask for each directory at top level.
3382 Anything else means ask for each directory."
3397 ;; No need to get actions and descriptions from the source,
3398 ;; we only have three actions anyway.
3400 t
3406 "--"
3410 nil)))
3415 ;; Only used when (featurep 'dnd).
3420 "Copy, move or link a file to the dired directory.
3421 URI is the file to handle, ACTION is one of copy, move, link or ask.
3422 Ask means pop up a menu for the user to select one of copy, move or link."
3431 ;; If copying a directory and dired-recursive-copies is
3432 ;; nil, dired-copy-file fails. Pop up a notice.
3441 ;; Binding dired-overwrite-confirmed to nil makes
3442 ;; dired-handle-overwrite a no-op. We instead use
3443 ;; y-or-n-p, which pops a graphical menu.
3444 dired-overwrite-confirmed backup-file)
3446 ;; d-b-o is defined in dired-aux.
3448 dired-backup-overwrite
3464 action))))))
3467 "Copy, move or link a file to the dired directory if it is a local file.
3468 URI is the file to handle. If the hostname in the URI isn't local, do nothing.
3469 ACTION is one of copy, move, link or ask.
3470 Ask means pop up a menu for the user to select one of copy, move or link."
3473 nil)))
3474 \f
3476 ;;;; Desktop support
3481 "Auxiliary information to be saved in desktop file."
3483 ;; Value of `dired-directory'.
3485 ;; Directory name followed by list of files.
3488 ;; Directory name, optionally with shell wildcard.
3490 ;; Subdirectories in `dired-subdir-alist'.
3495 dired-subdir-alist)))))
3498 desktop-buffer-name
3499 desktop-buffer-misc)
3500 "Restore a dired buffer specified in a desktop file."
3501 ;; First element of `desktop-buffer-misc' is the value of `dired-directory'.
3502 ;; This value is a directory name, optionally with shell wildcard or
3503 ;; a directory name followed by list of files.
3509 ;; The following elements of `desktop-buffer-misc' are the keys
3510 ;; from `dired-subdir-alist'.
3515 nil)))
3520 \f
3521 ;;; Start of automatically extracted autoloads.
3522 \f
3523 ;;;### (autoloads (dired-show-file-type dired-do-query-replace-regexp
3524 ;;;;;; dired-do-search dired-do-isearch-regexp dired-do-isearch
3525 ;;;;;; dired-isearch-filenames-regexp dired-isearch-filenames dired-isearch-filenames-setup
3526 ;;;;;; dired-hide-all dired-hide-subdir dired-tree-down dired-tree-up
3527 ;;;;;; dired-kill-subdir dired-mark-subdir-files dired-goto-subdir
3528 ;;;;;; dired-prev-subdir dired-insert-subdir dired-maybe-insert-subdir
3529 ;;;;;; dired-downcase dired-upcase dired-do-symlink-regexp dired-do-hardlink-regexp
3530 ;;;;;; dired-do-copy-regexp dired-do-rename-regexp dired-do-rename
3531 ;;;;;; dired-do-hardlink dired-do-symlink dired-do-copy dired-create-directory
3532 ;;;;;; dired-rename-file dired-copy-file dired-relist-file dired-remove-file
3533 ;;;;;; dired-add-file dired-do-redisplay dired-do-load dired-do-byte-compile
3534 ;;;;;; dired-do-compress dired-query dired-compress-file dired-do-kill-lines
3535 ;;;;;; dired-run-shell-command dired-do-shell-command dired-do-async-shell-command
3536 ;;;;;; dired-clean-directory dired-do-print dired-do-touch dired-do-chown
3537 ;;;;;; dired-do-chgrp dired-do-chmod dired-compare-directories dired-backup-diff
3538 ;;;;;; dired-diff) "dired-aux" "dired-aux.el" "416d272299fd4774c47c2f677ee640a4")
3539 ;;; Generated autoloads from dired-aux.el
3542 Compare file at point with file FILE using `diff'.
3543 FILE defaults to the file at the mark. (That's the mark set by
3545 The prompted-for file is the first file given to `diff'.
3546 With prefix arg, prompt for second argument SWITCHES,
3547 which is options for `diff'.
3552 Diff this file with its backup file or vice versa.
3553 Uses the latest backup, if there are several numerical backups.
3554 If this file is a backup, diff it with its original.
3555 The backup file is the first file given to `diff'.
3556 With prefix arg, prompt for argument SWITCHES which is options for `diff'.
3561 Mark files with different file attributes in two dired buffers.
3562 Compare file attributes of files in the current directory
3563 with file attributes in directory DIR2 using PREDICATE on pairs of files
3564 with the same name. Mark files for which PREDICATE returns non-nil.
3565 Mark files with different names if PREDICATE is nil (or interactively
3566 with empty input at the predicate prompt).
3568 PREDICATE is a Lisp expression that can refer to the following variables:
3570 size1, size2 - file size in bytes
3571 mtime1, mtime2 - last modification time in seconds, as a float
3572 fa1, fa2 - list of file attributes
3573 returned by function `file-attributes'
3575 where 1 refers to attribute of file in the current dired buffer
3576 and 2 to attribute of file in second dired buffer.
3578 Examples of PREDICATE:
3580 (> mtime1 mtime2) - mark newer files
3581 (not (= size1 size2)) - mark files with different sizes
3582 (not (string= (nth 8 fa1) (nth 8 fa2))) - mark files with different modes
3583 (not (and (= (nth 2 fa1) (nth 2 fa2)) - mark files with different UID
3584 (= (nth 3 fa1) (nth 3 fa2)))) and GID.
3589 Change the mode of the marked (or next ARG) files.
3590 Symbolic modes like `g+w' are allowed.
3595 Change the group of the marked (or next ARG) files.
3600 Change the owner of the marked (or next ARG) files.
3605 Change the timestamp of the marked (or next ARG) files.
3606 This calls touch.
3611 Print the marked (or next ARG) files.
3612 Uses the shell command coming from variables `lpr-command' and
3613 `lpr-switches' as default.
3618 Flag numerical backups for deletion.
3619 Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
3620 Positive prefix arg KEEP overrides `dired-kept-versions';
3621 Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
3624 with a prefix argument.
3629 Run a shell command COMMAND on the marked files asynchronously.
3631 Like `dired-do-shell-command' but if COMMAND doesn't end in ampersand,
3632 adds `* &' surrounded by whitespace and executes the command asynchronously.
3633 The output appears in the buffer `*Async Shell Command*'.
3638 Run a shell command COMMAND on the marked files.
3639 If no files are marked or a specific numeric prefix arg is given,
3641 The prompt mentions the file(s) or the marker, as appropriate.
3643 If there is a `*' in COMMAND, surrounded by whitespace, this runs
3644 COMMAND just once with the entire file list substituted there.
3646 If there is no `*', but there is a `?' in COMMAND, surrounded by
3647 whitespace, this runs COMMAND on each file individually with the
3648 file name substituted for `?'.
3650 Otherwise, this runs COMMAND on each file individually with the
3651 file name added at the end of COMMAND (separated by a space).
3653 `*' and `?' when not surrounded by whitespace have no special
3654 significance for `dired-do-shell-command', and are passed through
3655 normally to the shell, but you must confirm first. To pass `*' by
3658 If COMMAND produces output, it goes to a separate buffer.
3660 This feature does not try to redisplay Dired buffers afterward, as
3661 there's no telling what files COMMAND may have changed.
3664 When COMMAND runs, its working directory is the top-level directory
3665 of the Dired buffer, so output files usually are created there
3666 instead of in a subdir.
3668 In a noninteractive call (from Lisp code), you must specify
3669 the list of file names explicitly with the FILE-LIST argument, which
3670 can be produced by `dired-get-marked-files', for example.
3675 Not documented
3680 Kill all marked lines (not the files).
3681 With a prefix argument, kill that many lines starting with the current line.
3682 \(A negative argument kills backward.)
3683 If you use this command with a prefix argument to kill the line
3684 for a file that is a directory, which you have inserted in the
3685 Dired buffer as a subdirectory, then it deletes that subdirectory
3686 from the buffer as well.
3687 To kill an entire subdirectory (without killing its line in the
3688 parent directory), go to its directory header line and use this
3689 command with a prefix argument (the value does not matter).
3694 Not documented
3699 Query user and return nil or t.
3700 Store answer in symbol VAR (which must initially be bound to nil).
3701 Format PROMPT with ARGS.
3702 Binding variable `help-form' will help the user who types the help key.
3707 Compress or uncompress marked (or next ARG) files.
3712 Byte compile marked (or next ARG) Emacs Lisp files.
3717 Load the marked (or next ARG) Emacs Lisp files.
3722 Redisplay all marked (or next ARG) files.
3723 If on a subdir line, redisplay that subdirectory. In that case,
3724 a prefix arg lets you edit the `ls' switches used for the new listing.
3726 Dired remembers switches specified with a prefix arg, so that reverting
3727 the buffer will not reset them. However, using `dired-undo' to re-insert
3728 or delete subdirectories can bypass this machinery. Hence, you sometimes
3729 may have to reset some subdirectory switches after a `dired-undo'.
3730 You can reset all subdirectory switches to the default using
3732 See Info node `(emacs)Subdir switches' for more details.
3737 Not documented
3742 Not documented
3747 Create or update the line for FILE in all Dired buffers it would belong in.
3752 Not documented
3757 Not documented
3762 Create a directory called DIRECTORY.
3767 Copy all marked (or next ARG) files, or copy the current file.
3768 This normally preserves the last-modified date when copying.
3769 When operating on just the current file, you specify the new name.
3770 When operating on multiple or marked files, you specify a directory,
3771 and new copies of these files are made in that directory
3772 with the same names that the files currently have. The default
3773 suggested for the target directory depends on the value of
3774 `dired-dwim-target', which see.
3776 This command copies symbolic links by creating new ones,
3777 like `cp -d'.
3782 Make symbolic links to current file or all marked (or next ARG) files.
3783 When operating on just the current file, you specify the new name.
3784 When operating on multiple or marked files, you specify a directory
3785 and new symbolic links are made in that directory
3786 with the same names that the files currently have. The default
3787 suggested for the target directory depends on the value of
3788 `dired-dwim-target', which see.
3795 Add names (hard links) current file or all marked (or next ARG) files.
3796 When operating on just the current file, you specify the new name.
3797 When operating on multiple or marked files, you specify a directory
3798 and new hard links are made in that directory
3799 with the same names that the files currently have. The default
3800 suggested for the target directory depends on the value of
3801 `dired-dwim-target', which see.
3806 Rename current file or all marked (or next ARG) files.
3807 When renaming just the current file, you specify the new name.
3808 When renaming multiple or marked files, you specify a directory.
3809 This command also renames any buffers that are visiting the files.
3810 The default suggested for the target directory depends on the value
3811 of `dired-dwim-target', which see.
3816 Rename selected files whose names match REGEXP to NEWNAME.
3818 With non-zero prefix argument ARG, the command operates on the next ARG
3819 files. Otherwise, it operates on all the marked files, or the current
3820 file if none are marked.
3822 As each match is found, the user must type a character saying
3825 REGEXP defaults to the last regexp used.
3827 With a zero prefix arg, renaming by regexp affects the absolute file name.
3828 Normally, only the non-directory part of the file name is used and changed.
3833 Copy selected files whose names match REGEXP to NEWNAME.
3834 See function `dired-do-rename-regexp' for more info.
3839 Hardlink selected files whose names match REGEXP to NEWNAME.
3840 See function `dired-do-rename-regexp' for more info.
3845 Symlink selected files whose names match REGEXP to NEWNAME.
3846 See function `dired-do-rename-regexp' for more info.
3851 Rename all marked (or next ARG) files to upper case.
3856 Rename all marked (or next ARG) files to lower case.
3861 Insert this subdirectory into the same dired buffer.
3863 else inserts it at its natural place (as `ls -lR' would have done).
3864 With a prefix arg, you may edit the ls switches used for this listing.
3865 You can add `R' to the switches to expand the whole tree starting at
3866 this subdirectory.
3867 This function takes some pains to conform to `ls -lR' output.
3869 Dired remembers switches specified with a prefix arg, so that reverting
3870 the buffer will not reset them. However, using `dired-undo' to re-insert
3871 or delete subdirectories can bypass this machinery. Hence, you sometimes
3872 may have to reset some subdirectory switches after a `dired-undo'.
3873 You can reset all subdirectory switches to the default using
3875 See Info node `(emacs)Subdir switches' for more details.
3880 Insert this subdirectory into the same dired buffer.
3881 If it is already present, overwrites previous entry,
3882 else inserts it at its natural place (as `ls -lR' would have done).
3883 With a prefix arg, you may edit the `ls' switches used for this listing.
3884 You can add `R' to the switches to expand the whole tree starting at
3885 this subdirectory.
3886 This function takes some pains to conform to `ls -lR' output.
3891 Go to previous subdirectory, regardless of level.
3892 When called interactively and not on a subdir line, go to this subdir's line.
3897 Go to end of header line of DIR in this dired buffer.
3898 Return value of point on success, otherwise return nil.
3904 Mark all files except `.' and `..' in current subdirectory.
3905 If the Dired buffer shows multiple directories, this command
3906 marks the files listed in the subdirectory that point is in.
3911 Remove all lines of current subdirectory.
3912 Lower levels are unaffected.
3917 Go up ARG levels in the dired tree.
3922 Go down in the dired tree.
3927 Hide or unhide the current subdirectory and move to next directory.
3928 Optional prefix arg is a repeat factor.
3934 Hide all subdirectories, leaving only their header lines.
3935 If there is already something hidden, make everything visible again.
3941 Set up isearch to search in Dired file names.
3942 Intended to be added to `isearch-mode-hook'.
3947 Search for a string using Isearch only in file names in the Dired buffer.
3952 Search for a regexp using Isearch only in file names in the Dired buffer.
3957 Search for a string through all marked files using Isearch.
3962 Search for a regexp through all marked files using Isearch.
3967 Search through all marked files for a match for REGEXP.
3968 Stops when a match is found.
3974 Do `query-replace-regexp' of FROM with TO, on all marked files.
3975 Third arg DELIMITED (prefix arg) means replace only word-delimited matches.
3982 Print the type of FILE, according to the `file' command.
3983 If FILE is a symbolic link and the optional argument DEREF-SYMLINKS is
3984 true then the type of the file linked to by FILE is printed instead.
3988 ;;;***
3989 \f
3990 ;;;### (autoloads (dired-do-relsymlink dired-jump) "dired-x" "dired-x.el"
3991 ;;;;;; "27c312d6d5d40d8cb4ef8d62e30d5f4a")
3992 ;;; Generated autoloads from dired-x.el
3995 Jump to dired buffer corresponding to current buffer.
3996 If in a file, dired the current directory and move to file's line.
3997 If in Dired already, pop up a level and goto old directory's line.
3998 In case the proper dired file line cannot be found, refresh the dired
3999 buffer and try again.
4000 When OTHER-WINDOW is non-nil, jump to dired buffer in other window.
4001 Interactively with prefix argument, read FILE-NAME and
4002 move to its line in dired.
4007 Relative symlink all marked (or next ARG) files into a directory.
4008 Otherwise make a relative symbolic link to the current file.
4009 This creates relative symbolic links like
4011 foo -> ../bar/foo
4013 not absolute ones like
4015 foo -> /ugly/file/name/that/may/change/any/day/bar/foo
4021 ;;;***
4022 \f
4023 ;;; End of automatically extracted autoloads.
4029 ;; arch-tag: e1af7a8f-691c-41a0-aac1-ddd4d3c87517
4030 ;;; dired.el ends here