| blob | 8369d4897be1192173776096715c7d2ec46e6cb4 |
1 ;;; dired.el --- directory-browsing commands -*- lexical-binding: t -*-
3 ;; Copyright (C) 1985-1986, 1992-1997, 2000-2011
4 ;; Free Software Foundation, Inc.
6 ;; Author: Sebastian Kremer <sk@thp.uni-koeln.de>
7 ;; Maintainer: FSF
8 ;; Keywords: files
9 ;; Package: emacs
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
26 ;;; Commentary:
28 ;; This is a major mode for directory browsing and editing.
29 ;; It is documented in the Emacs manual.
31 ;; Rewritten in 1990/1991 to add tree features, file marking and
32 ;; sorting by Sebastian Kremer <sk@thp.uni-koeln.de>.
33 ;; Finished up by rms in 1992.
35 ;;; Code:
39 ;;; Customizable variables
42 "Directory editing."
47 "Handling marks in Dired."
52 ;;;###autoload
54 "Switches passed to `ls' for Dired. MUST contain the `l' option.
55 May contain all other options that don't contradict `-l';
56 may contain even `F', `b', `i' and `s'. See also the variable
57 `dired-ls-F-marks-symlinks' concerning the `F' switch.
58 On systems such as MS-DOS and MS-Windows, which use `ls' emulation in Lisp,
59 some of the `ls' switches are not supported; see the doc string of
60 `insert-directory' in `ls-lisp.el' for more details."
65 "If non-nil, switches passed to `ls' for inserting subdirectories.
66 If nil, `dired-listing-switches' is used."
76 "Name of chown command (usually `chown')."
82 The special value of `unspecified' means to check explicitly, and
83 save the result in this variable. This is performed the first
84 time `dired-insert-directory' is called."
91 "Name of chmod command (usually `chmod')."
96 "Name of touch command (usually `touch')."
101 "Informs Dired about how `ls -lF' marks symbolic links.
102 Set this to t if `ls' (or whatever program is specified by
103 `insert-directory-program') with `-lF' marks the symbolic link
104 itself with a trailing @ (usually the case under Ultrix).
106 Example: if `ln -s foo bar; ls -F bar' gives `bar -> foo', set it to
107 nil (the default), if it gives `bar@ -> foo', set it to t.
109 Dired checks if there is really a @ appended. Thus, if you have a
110 marking `ls' program on one host and a non-marking on another host, and
111 don't care about symbolic links which really end in a @, you can
112 always set this variable to t."
117 "Regexp of files to skip when finding first file of a directory.
118 A value of nil means move to the subdir line.
119 A value of t means move to first file."
122 regexp)
126 ;; Use t as default so that moved files "take their markers with them".
127 "Controls marking of renamed files.
128 If t, files keep their previous marks when they are renamed.
129 If a character, renamed files (whether previously marked or not)
130 are afterward marked with that character."
136 "Controls marking of copied files.
137 If t, copied files are marked if and as the corresponding original files were.
138 If a character, copied files are unconditionally marked with that character."
144 "Controls marking of newly made hard links.
145 If t, they are marked if and as the files linked to were marked.
146 If a character, new links are unconditionally marked with that character."
152 "Controls marking of newly made symbolic links.
153 If t, they are marked if and as the files linked to were marked.
154 If a character, new links are unconditionally marked with that character."
160 "If non-nil, Dired tries to guess a default target directory.
161 This means: if there is a dired buffer displayed in the next window,
162 use its current subdir, instead of the current subdir of this dired buffer.
164 The target is used in the prompt for file copy, rename etc."
169 "If non-nil, Dired preserves the last-modified time in a file copy.
170 \(This works on only some systems.)"
174 ; These variables were deleted and the replacements are on files.el.
175 ; We leave aliases behind for back-compatibility.
179 ;;; Hook variables
182 "Run after loading Dired.
183 You can customize key bindings or load extensions with this."
188 "Run at the very end of `dired-mode'."
193 "This hook is run before a dired buffer is read in (created or reverted)."
198 "Hook run after each time a file or directory is read by Dired.
199 After each listing of a file or directory, this hook is run
200 with the buffer narrowed to the listing."
203 ;; Note this can't simply be run inside function `dired-ls' as the hook
204 ;; functions probably depend on the dired-subdir-alist to be OK.
210 "The functions to call when a drop in `dired-mode' is made.
211 See `dnd-protocol-alist' for more information. When nil, behave
212 as in other buffers. Changing this option is effective only for
213 new dired buffers."
219 ;; Internal variables
222 ;; so that you can write things like
223 ;; (let ((dired-marker-char ?X))
224 ;; ;; great code using X markers ...
225 ;; )
226 ;; For example, commands operating on two sets of files, A and B.
227 ;; Or marking files with digits 0-9. This could implicate
228 ;; concentric sets or an order for the marked files.
229 ;; The code depends on dynamic scoping on the marker char.
230 "In Dired, the current mark character.
237 ;; I see no reason ever to make this nil -- rms.
238 ;; (> baud-rate search-slow-speed)
243 ;;;###autoload
245 "The directory name or wildcard spec that this dired directory lists.
246 Local to each dired buffer. May be a list, in which case the car is the
247 directory name and the cdr is the list of files to mention.
250 ;; Beware of "-l;reboot" etc. See bug#3230.
252 "Return non-nil if string SWITCHES does not look risky for dired."
266 ;; These regexps must be tested at beginning-of-line, but are also
267 ;; used to search for next matches, so neither omitting "^" nor
268 ;; replacing "^" by "\n" (to make it slightly faster) will work.
271 ;; "Regexp matching a marked line.
272 ;; Important: the match ends just after the marker."
274 ;; The [^:] part after "d" and "l" is to avoid confusion with the
275 ;; DOS/Windows-style drive letters in directory names, like in "d:/foo".
283 "-[-r][-w].[-r][-w][xs][-r][-w]."
289 ;; The subdirectory names in the next two lists are expanded.
291 "Association list of subdirectories and their buffer positions.
292 Each subdirectory has an element: (DIRNAME . STARTMARKER).
293 The order of elements is the reverse of the order in the buffer.
297 "Keeps track of which switches to use for inserted subdirectories.
305 "Regexp matching a maybe hidden subdirectory line in `ls -lR' output.
306 Subexpression 1 is the subdirectory proper, no trailing colon.
307 The match starts at the beginning of the line and ends after the end
312 "Faces used by Dired."
318 "Face used for directory headers."
326 "Face used for dired marks."
334 "Face used for marked files."
342 "Face used for flagged files."
349 ;; Inherit from font-lock-warning-face since with min-colors 8
350 ;; font-lock-comment-face is not colored any more.
352 "Face used to highlight a part of a buffer that needs user attention."
360 ;; Inherit from font-lock-comment-delimiter-face since with min-colors 8
361 ;; font-lock-comment-face is not colored any more.
363 "Face used to highlight permissions of group- and world-writable files."
371 "Face used for subdirectories."
379 "Face used for symbolic links."
387 "Face used for files suffixed with `completion-ignored-extensions'."
395 ;;
396 ;; Dired marks.
398 ;;
399 ;; We make heavy use of MATCH-ANCHORED, since the regexps don't identify the
400 ;; file name itself. We search for Dired defined regexps, and then use the
401 ;; Dired defined function `dired-move-to-filename' before searching for the
402 ;; simple regexp ".+". It is that regexp which matches the file name.
403 ;;
404 ;; Marked files.
407 ;;
408 ;; Flagged files.
411 ;; People who are paranoid about security would consider this more
412 ;; important than other things such as whether it is a directory.
413 ;; But we don't want to encourage paranoia, so our default
414 ;; should be what's most useful for non-paranoids. -- rms.
415 ;;; ;;
416 ;;; ;; Files that are group or world writable.
417 ;;; (list (concat dired-re-maybe-mark dired-re-inode-size
418 ;;; "\\([-d]\\(....w....\\|.......w.\\)\\)")
419 ;;; '(1 dired-warning-face)
420 ;;; '(".+" (dired-move-to-filename) nil (0 dired-warning-face)))
421 ;; However, we don't need to highlight the file name, only the
422 ;; permissions, to win generally. -- fx.
423 ;; Fixme: we could also put text properties on the permission
424 ;; fields with keymaps to frob the permissions, somewhat a la XEmacs.
431 ;;
432 ;; Subdirectories.
435 ;;
436 ;; Symbolic links.
439 ;;
440 ;; Files suffixed with `completion-ignored-extensions'.
442 ;; It is quicker to first find just an extension, then go back to the
443 ;; start of that file name. So we do this complex MATCH-ANCHORED form.
446 ;;
447 ;; Files suffixed with `completion-ignored-extensions'
448 ;; plus a character put in by -F.
454 ;; If the last character is not part of the filename,
455 ;; move back to the start of the filename
456 ;; so it can be fontified.
457 ;; Otherwise, leave point at the end of the line;
458 ;; that way, nothing is fontified.
462 ;;
463 ;; Explicitly put the default face on file names ending in a colon to
464 ;; avoid fontifying them as directory header.
467 ;;
468 ;; Directory headers.
470 )
474 \f
475 ;;; Macros must be defined before they are used, for the byte compiler.
478 "Mark all files for which PREDICATE evals to non-nil.
479 PREDICATE is evaluated on each line, with point at beginning of line.
480 MSG is a noun phrase for the type of files being marked.
481 It should end with a noun that can be pluralized by adding `s'.
482 Return value is the number of files marked, or nil if none were marked."
492 ,msg
494 " for deletion"
505 count
506 ,msg
514 distinguish-one-marked)
515 "Eval BODY with point on each marked line. Return a list of BODY's results.
516 If no marked file could be found, execute BODY on the current
517 line. ARG, if non-nil, specifies the files to use instead of the
518 marked files.
520 If ARG is an integer, use the next ARG (or previous -ARG, if
521 ARG<0) files. In that case, point is dragged along. This is so
522 that commands on the next ARG (instead of the marked) files can
523 be chained easily.
524 For any other non-nil value of ARG, use the current file.
526 If optional third arg SHOW-PROGRESS evaluates to non-nil,
527 redisplay the dired buffer after each file is processed.
529 No guarantee is made about the position on the marked line. BODY
530 must ensure this itself if it depends on this.
532 Search starts at the beginning of the buffer, thus the car of the
533 list corresponds to the line nearest to the buffer's bottom.
534 This is also true for (positive and negative) integer values of
535 ARG.
537 BODY should not be too long as it is expanded four times.
539 If DISTINGUISH-ONE-MARKED is non-nil, then if we find just one
540 marked file, return (t FILENAME) instead of (FILENAME)."
541 ;;
542 ;;Warning: BODY must not add new lines before point - this may cause an
543 ;;endless loop.
544 ;;This warning should not apply any longer, sk 2-Sep-1991 14:10.
551 ,arg
557 results))
558 ;; non-nil, non-integer ARG means use current file:
563 ;; remember position of next marked file before BODY
564 ;; can insert lines before the just found file,
565 ;; confusing us by finding the same marked file again
566 ;; and again and...
574 ;; move after last match
583 results
585 ;; save-excursion loses, again
589 "Return the marked files' names as list of strings.
590 The list is in the same order as the buffer, that is, the car is the
591 first marked file.
592 Values returned are normally absolute file names.
593 Optional arg LOCALP as in `dired-get-filename'.
594 Optional second argument ARG, if non-nil, specifies files near
595 point instead of marked files. It usually comes from the prefix
596 argument.
597 If ARG is an integer, use the next ARG files.
598 Any other non-nil value means to use the current file instead.
599 Optional third argument FILTER, if non-nil, is a function to select
600 some of the files--those for which (funcall FILTER FILENAME) is non-nil.
602 If DISTINGUISH-ONE-MARKED is non-nil, then if we find just one marked file,
603 return (t FILENAME) instead of (FILENAME).
604 Don't use that together with FILTER."
609 arg nil distinguish-one-marked)))
610 result)
613 all-of-them
618 result)))
619 \f
620 ;; The dired command
623 ;; For use in interactive.
627 dired-listing-switches))
628 ;; If a dialog is used, call `read-directory-name' so the
629 ;; dialog code knows we want directories. Some dialogs
630 ;; can only select directories or files when popped up,
631 ;; not both. If no dialog is used, call `read-file-name'
632 ;; because the user may want completion of file names for
633 ;; use in a wildcard pattern.
636 nil default-directory nil)
638 nil default-directory nil)))))
640 ;; We want to switch to a more sophisticated version of
641 ;; dired-read-dir-and-switches like the following, if there is a way
642 ;; to make it more intuitive. See bug#1285.
644 ;; (defun dired-read-dir-and-switches (str)
645 ;; ;; For use in interactive.
646 ;; (reverse
647 ;; (list
648 ;; (if current-prefix-arg
649 ;; (read-string "Dired listing switches: "
650 ;; dired-listing-switches))
651 ;; ;; If a dialog is about to be used, call read-directory-name so
652 ;; ;; the dialog code knows we want directories. Some dialogs can
653 ;; ;; only select directories or files when popped up, not both.
654 ;; (if (next-read-file-uses-dialog-p)
655 ;; (read-directory-name (format "Dired %s(directory): " str)
656 ;; nil default-directory nil)
657 ;; (let ((cie ()))
658 ;; (dolist (ext completion-ignored-extensions)
659 ;; (if (eq ?/ (aref ext (1- (length ext)))) (push ext cie)))
660 ;; (setq cie (concat (regexp-opt cie "\\(?:") "\\'"))
661 ;; (lexical-let* ((default (and buffer-file-name
662 ;; (abbreviate-file-name buffer-file-name)))
663 ;; (cie cie)
664 ;; (completion-table
665 ;; ;; We need a mix of read-file-name and
666 ;; ;; read-directory-name so that completion to directories
667 ;; ;; is preferred, but if the user wants to enter a global
668 ;; ;; pattern, he can still use completion on filenames to
669 ;; ;; help him write the pattern.
670 ;; ;; Essentially, we want to use
671 ;; ;; (completion-table-with-predicate
672 ;; ;; 'read-file-name-internal 'file-directory-p nil)
673 ;; ;; but that doesn't work because read-file-name-internal
674 ;; ;; does not obey its `predicate' argument.
675 ;; (completion-table-in-turn
676 ;; (lambda (str pred action)
677 ;; (let ((read-file-name-predicate
678 ;; (lambda (f)
679 ;; (and (not (member f '("./" "../")))
680 ;; ;; Hack! Faster than file-directory-p!
681 ;; (eq (aref f (1- (length f))) ?/)
682 ;; (not (string-match cie f))))))
683 ;; (complete-with-action
684 ;; action 'read-file-name-internal str nil)))
685 ;; 'read-file-name-internal)))
686 ;; (minibuffer-with-setup-hook
687 ;; (lambda ()
688 ;; (setq minibuffer-default default)
689 ;; (setq minibuffer-completion-table completion-table))
690 ;; (read-file-name (format "Dired %s(directory): " str)
691 ;; nil default-directory nil))))))))
694 "Try to get a file name at point in the current dired buffer.
695 This hook is inteneded to be put in `file-name-at-point-functions'."
702 ;;;###autoload (define-key ctl-x-map "d" 'dired)
703 ;;;###autoload
706 Optional second argument SWITCHES specifies the `ls' options used.
707 \(Interactively, use a prefix argument to be able to specify SWITCHES.)
708 Dired displays a list of files in DIRNAME (which may also have
709 shell wildcards appended to select certain files). If DIRNAME is a cons,
710 its first element is taken as the directory name and the rest as an explicit
711 list of files to make directory entries for.
717 If DIRNAME is already in a dired buffer, that buffer is used without refresh."
718 ;; Cannot use (interactive "D") because of wildcards.
722 ;;;###autoload (define-key ctl-x-4-map "d" 'dired-other-window)
723 ;;;###autoload
729 ;;;###autoload (define-key ctl-x-5-map "d" 'dired-other-frame)
730 ;;;###autoload
736 ;;;###autoload
738 "Like `dired' but returns the dired buffer as value, does not select it."
740 ;; This loses the distinction between "/foo/*/" and "/foo/*" that
741 ;; some shells make:
752 ;; If the argument was syntactically a directory name not a file name,
753 ;; or if it happens to name a file that is a directory,
754 ;; convert it syntactically to a directory name.
755 ;; The reason for checking initially-was-dirname
756 ;; and not just file-directory-p
757 ;; is that file-directory-p is slow over ftp.
765 ;; The following is an internal dired function. It returns non-nil if
766 ;; the directory visited by the current dired buffer has changed on
767 ;; disk. DIRNAME should be the directory name of that directory.
776 "Return non-nil if current dired buffer needs updating.
777 If NOCONFIRM is non-nil, then this function always returns nil
778 for a remote directory. This feature is used by Auto Revert Mode."
784 ;; Do not auto-revert when the dired buffer can be currently
785 ;; written by the user as in `wdired-mode'.
786 buffer-read-only
790 "Automatically revert dired buffer on revisiting.
791 If t, revisiting an existing dired buffer automatically reverts it.
792 If its value is a function, call this function with the directory
793 name as single argument and revert the buffer if it returns non-nil.
794 Otherwise, a message offering to revert the changed dired buffer
795 is displayed.
796 Note that this is not the same as `auto-revert-mode' that
797 periodically reverts at specified time intervals."
807 ;; If there is an existing dired buffer for DIRNAME, just leave
808 ;; buffer as it is (don't even call dired-revert).
809 ;; This saves time especially for deep trees or with ange-ftp.
810 ;; The user can type `g' easily, and it is more consistent with find-file.
811 ;; But if SWITCHES are given they are probably different from the
812 ;; buffer's old value, so call dired-sort-other, which does
813 ;; revert the buffer.
814 ;; A pity we can't possibly do "Directory has changed - refresh? "
815 ;; like find-file does.
816 ;; Optional argument MODE is passed to dired-find-buffer-nocreate,
817 ;; see there.
820 ;; Look for an existing buffer.
822 ;; Note that buffer already is in dired-mode, if found.
829 ;; file list may have changed
831 ;; this calls dired-revert
833 ;; Always revert regardless of whether it has changed or not.
836 ;; Revert when predicate function returns non-nil.
841 ;; If directory has changed on disk, offer to revert.
846 ;; Else a new buffer
848 ;; We can do this unconditionally
849 ;; because dired-noselect ensures that the name
850 ;; is passed in directory name syntax
851 ;; if it was the name of a directory at all.
856 ;; default-directory and dired-actual-switches are set now
857 ;; (buffer-local), so we can call dired-readin:
862 ;; dired-readin can fail if parent directories are inaccessible.
863 ;; Don't leave an empty buffer around in that case.
868 buffer))
871 ;; Enlarged by dired-advertise
872 ;; Queried by function dired-buffers-for-dir. When this detects a
873 ;; killed buffer, it is removed from this list.
878 ;; FIXME add a doc-string, and document dired-x extensions.
880 ;; This differs from dired-buffers-for-dir in that it does not consider
881 ;; subdirs of default-directory and searches for the first match only.
882 ;; Also, the major mode must be MODE.
884 dired-find-subdir
885 ;; Don't try to find a wildcard as a subdirectory.
891 ;; Wildcards must match, too:
893 ;; We don't want to switch to the same buffer---
896 ;; ---unless it's the only possibility:
898 ;; No dired-x, or dired-find-subdir nil.
907 dired-directory ;; nil during find-alternate-file
912 dired-directory))))
914 blist nil)
916 found)))
918 \f
919 ;; Read in a new dired buffer
922 "Read in a new dired buffer.
923 Differs from `dired-insert-subdir' in that it accepts
924 wildcards, erases the buffer, and builds the subdir-alist anew
925 \(including making it buffer-local and clearing it first)."
927 ;; default-directory and dired-actual-switches must be buffer-local
928 ;; and initialized by now.
930 ;; This makes readin much much faster.
931 ;; In particular, it prevents the font lock hook from running
932 ;; until the directory is all read in.
939 ;; This hook which may want to modify dired-actual-switches
940 ;; based on dired-directory, e.g. with ange-ftp to a SysV host
941 ;; where ls won't understand -Al switches.
949 ;; Don't make undo entries for readin.
955 ;; Must first make alist buffer local and set it to nil because
956 ;; dired-build-subdir-alist will call dired-clear-alist first
963 ;; No need to narrow since the whole buffer contains just
964 ;; dired-readin's output, nothing else. The hook can
965 ;; successfully use dired functions (e.g. dired-get-filename)
966 ;; as the subdir-alist has been built in dired-readin.
969 ;; Subroutines of dired-readin
972 ;; Insert listing for the specified dir (and maybe file list)
973 ;; already in dired-directory, assuming a clean buffer.
979 file-list nil))
983 ;; If we are reading a whole single directory...
988 ;; Else treat it as a wildcard spec
989 ;; unless we have an explicit list of files.
994 "Align the fields of a file to the ones of surrounding lines.
995 BEG..END is the line where the file info is located."
996 ;; Some versions of ls try to adjust the size of each field so as to just
997 ;; hold the largest element ("largest" in the current invocation, of
998 ;; course). So when a single line is output, the size of each field is
999 ;; just big enough for that one output. Thus when dired refreshes one
1000 ;; line, the alignment if this line w.r.t the rest is messed up because
1001 ;; the fields of that one line will generally be smaller.
1002 ;;
1003 ;; To work around this problem, we here add spaces to try and
1004 ;; re-align the fields as needed. Since this is purely aesthetic,
1005 ;; it is of utmost importance that it doesn't mess up anything like
1006 ;; `dired-move-to-filename'. To this end, we limit ourselves to
1007 ;; adding spaces only, and to only add them at places where there
1008 ;; was already at least one space. This way, as long as
1009 ;; `directory-listing-before-filename-regexp' always matches spaces
1010 ;; with "*" or "+", we know we haven't made anything worse. There
1011 ;; is one spot where the exact number of spaces is important, which
1012 ;; is just before the actual filename, so we refrain from adding
1013 ;; spaces there (and within the filename as well, of course).
1016 ;; Check that there is indeed a file, and that there is anoter adjacent
1017 ;; file with which to align, and that additional spaces are needed to
1018 ;; align the filenames.
1031 ;; Make sure there is some work left to do.
1033 ;; If we've only looked at the line above, check to see if the line
1034 ;; below exists as well and if so, align with the shorter one.
1043 ;; Keep positions uptodate when we insert stuff.
1046 ;; Main loop.
1050 ;; Don't touch anything just before (and after) the
1051 ;; beginning of the filename.
1053 ;; We're now just in front of a field, with a space behind us.
1055 ;; Nums are right-aligned.
1057 ;; Let's look at the other line, in the same column: we
1058 ;; should be either near the end of the previous field, or
1059 ;; in the space between that field and the next.
1060 ;; [ Of course, it's also possible that we're already within
1061 ;; the next field or even past it, but that's unlikely since
1062 ;; other-col > file-col. ]
1063 ;; Let's find the distance to the alignment-point (either
1064 ;; the beginning or the end of the next field, depending on
1065 ;; whether this field is left or right aligned).
1075 ;; Now, the number of spaces to insert is align-pt-offset
1076 ;; minus the distance to the equivalent point on the
1077 ;; current line.
1080 align-pt-offset
1090 ;; Let's just make really sure we did not mess up.
1093 ;; Damn! We messed up: let's revert the change.
1095 ;; Now skip to next field.
1103 "Insert a directory listing of DIR, Dired style.
1104 Use SWITCHES to make the listings.
1105 If FILE-LIST is non-nil, list only those files.
1106 Otherwise, if WILDCARD is non-nil, expand wildcards;
1107 in that case, DIR should be a file name that uses wildcards.
1108 In other cases, DIR should be a directory name or a directory filename.
1109 If HDR is non-nil, insert a header line with the directory name."
1112 end)
1114 ;; Don't try to invoke `ls' if we are on DOS/Windows where
1115 ;; ls-lisp emulation is used, except if they want to use `ls'
1116 ;; as indicated by `ls-lisp-use-insert-directory-program'.
1120 ;; Check whether "ls --dired" gives exit code 0, and
1121 ;; save the answer in `dired-use-ls-dired'.
1125 dired-use-ls-dired)
1128 ;; We used to specify the C locale here, to force English month names;
1129 ;; but this should not be necessary any more,
1130 ;; with the new value of `directory-listing-before-filename-regexp'.
1135 ;; Re-align fields, if necessary.
1138 ;; Quote certain characters, unless ls quoted them for us.
1147 nil t))
1153 nil t))
1156 ;; If we used --dired and it worked, the lines are already indented.
1157 ;; Otherwise, indent them.
1163 ;; Insert text at the beginning to standardize things.
1169 ;; Note that dired-build-subdir-alist will replace the name
1170 ;; by its expansion, so it does not matter whether what we insert
1171 ;; here is fully expanded, but it should be absolute.
1174 ;; Insert "wildcard" line where "total" line would be for a full dir.
1178 "Make the file names highlight when the mouse is on them."
1190 dired-filename t
1194 \f
1195 ;; Reverting a dired buffer
1198 "Reread the dired buffer.
1199 Must also be called after `dired-actual-switches' have changed.
1200 Should not fail even on completely garbaged buffers.
1201 Preserves old cursor, marks/flags, hidden-p.
1203 Dired sets `revert-buffer-function' to this function. The args
1204 ARG and NOCONFIRM, passed from `revert-buffer', are ignored."
1216 ;; treat top level dir extra (it may contain wildcards)
1223 ;; Run dired-after-readin-hook just once, below.
1228 ;; ... run the hook for the whole buffer, and only after markers
1229 ;; have been reinserted (else omitting in dired-x would omit marked files)
1237 ;; outside of the let scope
1238 ;;; Might as well not override the user if the user changed this.
1239 ;;; (setq buffer-read-only t)
1240 )
1242 ;; Subroutines of dired-revert
1243 ;; Some of these are also used when inserting subdirs.
1246 "Return current positions in the buffer and all windows with this directory.
1247 The positions have the form (BUFFER-POSITION WINDOW-POSITIONS).
1249 BUFFER-POSITION is the point position in the current dired buffer.
1250 It has the form (BUFFER DIRED-FILENAME BUFFER-POINT).
1252 WINDOW-POSITIONS are current positions in all windows displaying
1253 this dired buffer. The window positions have the form (WINDOW
1254 DIRED-FILENAME WINDOW-POINT)."
1265 "Restore POSITIONS saved with `dired-save-positions'."
1273 ;; Ensure that window still displays the original buffer.
1282 "Return alist of files and their marks, from BEG to END."
1293 alist))
1296 "Mark all files remembered in ALIST.
1297 Each element of ALIST looks like (FILE . MARKERCHAR)."
1311 "Return a list of names of subdirs currently hidden."
1321 result))
1324 "Try to insert all subdirs that were displayed before.
1325 Do so according to the former subdir alist OLD-SUBDIR-ALIST."
1339 "Remove directory DIR from any directory cache."
1343 \f
1344 ;; dired mode key bindings and initialization
1347 ;; This looks ugly when substitute-command-keys uses C-d instead d:
1348 ;; (define-key dired-mode-map "\C-d" 'dired-flag-file-deletion)
1353 ;; Commands to mark or flag certain categories of files
1357 ;; Upper case keys (except !) for operating on the marked files
1376 ;; Comparison commands
1379 ;; Tree Dired commands
1385 ;; move to marked files
1388 ;; Make all regexp commands share a `%' prefix:
1389 ;; We used to get to the submap via a symbol dired-regexp-prefix,
1390 ;; but that seems to serve little purpose, and copy-keymap
1391 ;; does a better job without it.
1404 ;; Commands for marking and unmarking.
1421 ;; Lower keys for commands not operating on all the marked files
1446 ;; moving
1453 ;; hiding
1456 ;; isearch
1461 ;; misc
1467 ;; thumbnail manipulation (image-dired)
1480 ;; encryption and decryption (epa-dired)
1486 ;; Make menu bar items.
1488 ;; No need to fo this, now that top-level items are fewer.
1489 ;;;;
1490 ;; Get rid of the Edit menu bar item to save space.
1491 ;(define-key map [menu-bar edit] 'undefined)
1596 ;; When running on plain MS-DOS, there's only one
1597 ;; letter-case for file names.
1785 map)
1787 \f
1788 ;; Dired mode is suitable only for specially formatted data.
1791 ;; Autoload cookie needed by desktop.el
1792 ;;;###autoload
1794 "\
1797 \(optionally) its subdirectories, in the format of `ls -lR'.
1800 compress, load or byte-compile them, change their file attributes
1803 by file or all files matching certain criteria.
1805 The buffer is read-only. Digits are prefix arguments.
1808 Most commands operate on the marked files and use the current file
1809 if no files are marked. Use a numeric prefix argument to operate on
1810 the next ARG (or previous -ARG if ARG<0) files, or just `1'
1811 to operate on the current file only. Prefix arguments override marks.
1813 to see why something went wrong.
1818 (or dired it in another buffer, if it is a directory).
1825 This retains all marks and hides subdirs again that were hidden before.
1826 Use `SPC' and `DEL' to move down and up by lines.
1829 to read the
1831 to relist the file at point or the marked files or a
1833 again for the directory tree.
1836 for more info):
1838 `dired-listing-switches'
1839 `dired-trivial-filenames'
1840 `dired-shrink-to-fit'
1841 `dired-marker-char'
1842 `dired-del-marker'
1843 `dired-keep-marker-rename'
1844 `dired-keep-marker-copy'
1845 `dired-keep-marker-hardlink'
1846 `dired-keep-marker-symlink'
1850 `dired-before-readin-hook'
1851 `dired-after-readin-hook'
1852 `dired-mode-hook'
1853 `dired-load-hook'
1855 Keybindings:
1857 ;; Not to be called interactively (e.g. dired-directory will be set
1858 ;; to default-directory, which is wrong with wildcards).
1863 mode-name "Dired"
1864 ;; case-fold-search nil
1865 buffer-read-only t
1866 selective-display t ; for subdirectory hiding
1867 mode-line-buffer-identification
1877 ;; list-buffers uses this to display the dir being edited in this buffer.
1881 dired-directory)))
1897 \f
1898 ;; Idiosyncratic dired commands that don't deal with marks.
1901 "Summarize basic Dired commands and show recent dired errors."
1904 ;>> this should check the key-bindings and use substitute-command-keys if non-standard
1909 "Undo in a dired buffer.
1910 This doesn't recover lost files, it just undoes changes in the buffer itself.
1911 You can use it to recover marks, killed lines or subdirs."
1920 "Edit dired buffer with Wdired, or set it read-only.
1921 Call `wdired-change-to-wdired-mode' in dired buffers whose editing is
1922 supported by Wdired (the major mode of the dired buffer is `dired-mode').
1923 Otherwise, for buffers inheriting from dired-mode, call `toggle-read-only'."
1930 "Move down lines then position at filename.
1931 Optional prefix ARG says how many lines to move; default is one line."
1937 "Move up lines then position at filename.
1938 Optional prefix ARG says how many lines to move; default is one line."
1944 "Goto ARG'th next directory file line."
1956 "Goto ARG'th previous directory file line."
1961 "Run Dired on parent directory of current directory.
1962 Find the parent directory either in this buffer or another buffer.
1963 Creates a buffer if necessary."
1968 ;; Only try dired-goto-subdir if buffer has more than one dir.
1978 "Get the current line's file name, with an error if file does not exist."
1980 ;; We pass t for second arg so that we don't get error for `.' and `..'.
1982 file-name)
1987 file-name
1992 ;; Force C-m keybinding rather than `f' or `e' in the mode doc:
1995 "In Dired, visit the file or directory named on this line."
1997 ;; Bind `find-file-run-dired' so that the command works on directories
1998 ;; too, independent of the user's setting.
2003 "In Dired, visit this file or directory instead of the dired buffer."
2007 ;; Don't override the setting from .emacs.
2008 ;;;###autoload (put 'dired-find-alternate-file 'disabled t)
2011 "In Dired, visit the file or directory name you click on."
2032 "In Dired, examine a file in view mode, returning to Dired when done.
2033 When file is a directory, show it in this buffer if it is inserted.
2034 Otherwise, display it in another buffer."
2044 "In Dired, visit this file or directory in another window."
2049 "In Dired, display this file or directory in another window."
2052 \f
2053 ;;; Functions for extracting and manipulating file names in Dired buffers.
2056 "In Dired, return name of file mentioned on this line.
2057 Value returned normally includes the directory name.
2058 Optional arg LOCALP with value `no-dir' means don't include directory
2059 name in result. A value of `verbatim' means to return the name exactly as
2060 it occurs in the buffer, and a value of t means construct name relative to
2061 `default-directory', which still may contain slashes if in a subdirectory.
2062 Optional arg NO-ERROR-IF-NOT-FILEP means treat `.' and `..' as
2063 regular filenames and return nil if no filename on this line.
2064 Otherwise, an error occurs in these cases."
2069 ;; nil if no file on this line, but no-error-if-not-filep is t:
2072 ;; Get rid of the mouse-face property that file names have.
2074 ;; Unquote names quoted by ls or by dired-insert-directory.
2075 ;; This code was written using `read' to unquote, because
2076 ;; it's faster than substituting \007 (4 chars) -> ^G (1
2077 ;; char) etc. in a lisp loop. Unfortunately, this decision
2078 ;; has necessitated hacks such as dealing with filenames
2079 ;; with quotation marks in their names.
2091 ;; The above `read' will return a unibyte string if FILE
2092 ;; contains eight-bit-control/graphic characters.
2097 ;; A relative file name can start with ~.
2098 ;; Don't treat it as absolute in this context.
2103 nil)
2105 file)
2113 ;; check for safe-magic property so that we won't
2114 ;; put /: for names that don't really need them.
2115 ;; For instance, .gz files when auto-compression-mode is on.
2118 file)))
2120 file)
2124 ;; check for safe-magic property so that we won't
2125 ;; put /: for names that don't really need them.
2126 ;; For instance, .gz files when auto-compression-mode is on.
2129 file)))
2135 "Replace first match of REGEXP in STRING with NEWTEXT.
2136 If it does not match, nil is returned instead of the new string.
2137 Optional arg LITERAL means to take NEWTEXT literally.
2138 Optional arg GLOBAL means to replace all matches."
2145 ret)
2147 nil
2151 ;;"Convert FILE (a file name relative to DIR) to an absolute file name."
2152 ;; We can't always use expand-file-name as this would get rid of `.'
2153 ;; or expand in / instead default-directory if DIR=="".
2154 ;; This should be good enough for ange-ftp.
2155 ;; It should be reasonably fast, though, as it is called in
2156 ;; dired-get-filename.
2160 "Convert FILE (an absolute file name) to a name relative to DIR.
2161 If this is impossible, return FILE unchanged.
2162 DIR must be a directory name, not a file name."
2164 ;; This case comes into play if default-directory is set to
2165 ;; use ~.
2170 ;;; (or no-error
2171 ;;; (error "%s: not in directory tree growing at %s" file dir))
2172 file))
2173 \f
2174 ;;; Functions for finding the file name in a dired buffer line.
2180 ;; Move to first char of filename on this line.
2181 ;; Returns position (point) or nil if no filename on this line."
2183 "Move to the beginning of the filename on the current line.
2184 Return the position of the beginning of the filename, or nil if none found."
2185 ;; This is the UNIX version.
2188 ;; First try assuming `ls --dired' was used.
2196 ;; Ha! There *is* a file. Our regexp-from-hell just failed to find it.
2200 nil)
2205 ;; Assumes point is at beginning of filename,
2206 ;; thus the rwx bit re-search-backward below will succeed in *this*
2207 ;; line if at all. So, it should be called only after
2208 ;; (dired-move-to-filename t).
2209 ;; On failure, signals an error (with non-nil NO-ERROR just returns nil).
2210 ;; This is the UNIX version.
2214 ;; case-fold-search is nil now, so we can test for capital F:
2221 nil
2223 ;; Restrict perm bits to be non-blank,
2224 ;; otherwise this matches one char to early (looking backward):
2225 ;; "l---------" (some systems make symlinks that way)
2226 ;; "----------" (plain file with zero perms)
2228 dired-permission-flags-regexp nil t)
2231 ;; Only with -F we need to know whether it's an executable
2233 used-F
2241 ;; Move point to end of name:
2247 dired-ls-F-marks-symlinks
2251 ;; ls -lF marks dirs, sockets, fifos and executables with exactly
2252 ;; one trailing character. (Executable bits on symlinks ain't mean
2253 ;; a thing, even to ls, but we know it's not a symlink.)
2256 executable)
2265 nil
2268 \f
2269 ;;; COPY NAMES OF MARKED FILES INTO KILL-RING.
2272 "Copy names of marked (or next ARG) files into the kill ring.
2273 The names are separated by a space.
2274 With a zero prefix arg, use the absolute file name of each marked file.
2276 `default-directory'. (This still may contain slashes if in a subdirectory.)
2278 If on a subdir headerline, use absolute subdirname instead;
2279 prefix arg and marked files are ignored in this case.
2301 \f
2302 ;; Keeping Dired buffers in sync with the filesystem and with each other
2305 ;; Return a list of buffers for DIR (top level or in-situ subdir).
2306 ;; If FILE is non-nil, include only those whose wildcard pattern (if any)
2307 ;; matches FILE.
2308 ;; The list is in reverse order of buffer creation, most recent last.
2309 ;; As a side effect, killed dired buffers for DIR are removed from
2310 ;; dired-buffers.
2317 ;; Buffer is killed - clean up:
2325 dired-directory)))
2328 file)))
2332 result))
2335 "Convert glob-pattern PATTERN to a regular expression."
2337 regexp)
2349 ;; Fails to handle ^ yet ????
2363 regexp
2371 ;;"Advertise in variable `dired-buffers' that we dired `default-directory'."
2372 ;; With wildcards we actually advertise too much.
2375 t ; we have already advertised ourselves
2378 dired-buffers)))))
2381 ;; Remove DIR from the buffer alist in variable dired-buffers.
2382 ;; This has the effect of removing any buffer whose main directory is DIR.
2383 ;; It does not affect buffers in which DIR is a subdir.
2384 ;; Removing is also done as a side-effect in dired-buffer-for-dir.
2387 \f
2388 ;; Tree Dired
2390 ;;; utility functions
2393 ;;"Is FILE part of the directory tree starting at DIR?"
2398 ;; Prepend default-directory to DIR if relative file name.
2399 ;; dired-get-filename must be able to make a valid file name from a
2400 ;; file and its directory DIR.
2403 dir
2407 ;;"Return the subdir name on this line, or nil if not on a headerline."
2408 ;; Look up in the alist whether this is a headerline.
2414 dired-subdir-alist))))
2415 cur-dir))))
2417 ;(defun dired-get-subdir-min (elt)
2418 ; (cdr elt))
2419 ;; can't use macro, must be redefinable for other alist format in dired-nstd.
2433 ;; Return an index into alist for use with nth
2434 ;; for the sake of subdir moving commands.
2443 "Go to next subdirectory, regardless of level."
2444 ;; Use 0 arg to go to this directory's header line.
2445 ;; NO-SKIP prevents moving to end of header line, returning whatever
2446 ;; position was found in dired-subdir-alist.
2449 pos index)
2450 ;; nth with negative arg does not return nil but the first element
2460 nil ; return nil if not found
2464 "Build `dired-subdir-alist' by parsing the buffer.
2465 Returns the new value of the alist.
2466 If optional arg SWITCHES is non-nil, use its value
2467 instead of `dired-actual-switches'."
2475 new-dir-name
2477 ;; Used to expand subdirectory names correctly in recursive
2478 ;; ange-ftp listings.
2485 ;; Avoid taking a file name ending in a colon
2486 ;; as a subdir name.
2496 new-dir-name
2508 ;; Place a sub directory boundary between lines.
2515 ;; We don't need to sort it because it is in buffer order per
2516 ;; constructionem. Return new alist:
2517 dired-subdir-alist))
2520 ;; Add new DIR at NEW-MARKER. Don't sort.
2523 dired-subdir-alist)))
2526 ;; Position point on first nontrivial file after point.
2542 "Go to line describing file FILE in this dired buffer."
2543 ;; Return value of point on success, else nil.
2544 ;; FILE must be an absolute file name.
2545 ;; Loses if FILE contains control chars like "\007" for which ls
2546 ;; either inserts "?" or "\\007" into the buffer, so we won't find
2547 ;; it in the buffer.
2559 ;; The hair here is to get the result of dired-goto-subdir
2560 ;; without really calling it if we don't have any subdirs.
2566 search-string
2573 ;; filenames are preceded by SPC, this makes
2574 ;; the search faster (e.g. for the filename "-"!).
2577 ;; Match could have BASE just as initial substring or
2578 ;; or in permission bits or date or
2579 ;; not be a proper filename at all:
2581 ;; Must move to filename since an (actually
2582 ;; correct) match could have been elsewhere on the
2583 ;; ;; line (e.g. "-" would match somewhere in the
2584 ;; permission bits).
2586 ;; If this isn't the right line, move forward to avoid
2587 ;; trying this line again.
2590 ;; return value of point (i.e., FOUND):
2595 ;; FIXME document whatever dired-x is doing.
2597 "Where point should go in a new listing of DIRNAME.
2598 Point assumed at beginning of new subdir line."
2603 \f
2604 ;; These are hooks which make tree dired work.
2605 ;; They are in this file because other parts of dired need to call them.
2606 ;; But they don't call the rest of tree dired unless there are subdirs loaded.
2608 ;; This function is called for each retrieved filename.
2609 ;; It could stand to be faster, though it's mostly function call
2610 ;; overhead. Avoiding the function call seems to save about 10% in
2611 ;; dired-get-filename. Make it a defsubst?
2613 "Return the name of the subdirectory to which this line belongs.
2614 This returns a string with trailing slash, like `default-directory'.
2615 Optional argument means return a file name relative to `default-directory'."
2618 ;; probably because called in a non-dired buffer
2620 elt dir)
2624 ;; use `<=' (not `<') as subdir line is part of subdir
2626 nil ; found
2630 dir)))
2632 ;; Subdirs start at the beginning of their header lines and end just
2633 ;; before the beginning of the next header line (or end of buffer).
2640 \f
2641 ;; Deleting files
2644 "Decide whether recursive deletes are allowed.
2645 A value of nil means no recursive deletes.
2646 `always' means delete recursively without asking. This is DANGEROUS!
2647 `top' means ask for each directory at top level, but delete its subdirectories
2648 without asking.
2649 Anything else means ask for each directory."
2657 ;; Match anything but `.' and `..'.
2660 ;; Delete file, possibly delete a directory and all its files.
2661 ;; This function is usefull outside of dired. One could change it's name
2662 ;; to e.g. recursive-delete-file and put it somewhere else.
2664 Delete FILE or directory (possibly recursively if optional RECURSIVE is true.)
2665 RECURSIVE determines what to do with a non-empty directory. If RECURSIVE is:
2666 nil, do not delete.
2667 `always', delete recursively without asking.
2668 `top', ask for each directory at top level.
2669 Anything else, ask for each sub-directory."
2670 ;; This test is equivalent to
2671 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
2672 ;; but more efficient
2680 delete-by-moving-to-trash)
2681 "trash"
2689 "In Dired, delete the files flagged for deletion.
2690 If NOMESSAGE is non-nil, we don't display any message
2691 if there are no flagged files.
2692 `dired-recursive-deletes' controls whether deletion of
2693 non-empty directories is allowed."
2697 case-fold-search)
2701 ;; this can't move point since ARG is nil
2703 nil)
2704 nil t)
2709 "Delete all marked (or next ARG) files.
2710 `dired-recursive-deletes' controls whether deletion of
2711 non-empty directories is allowed."
2712 ;; This is more consistent with the file marking feature than
2713 ;; dired-do-flagged-delete.
2716 ;; this may move point if ARG is an integer
2718 arg)
2719 arg t))
2724 ;; L is an alist of files to delete, with their buffer positions.
2725 ;; ARG is the prefix arg.
2726 ;; Filenames are absolute.
2727 ;; (car L) *must* be the *last* (bottommost) file in the dired buffer.
2728 ;; That way as changes are made in the buffer they do not shift the
2729 ;; lines still to be changed, so the (point) values in L stay valid.
2730 ;; Also, for subdirs in natural order, a subdir's files are deleted
2731 ;; before the subdir itself - the other way around would not work.
2739 succ count)))
2740 ;; canonicalize file list for pop up
2755 ;; if we get here, removing worked
2771 failures))))
2776 ;; In all buffers dired'ing DIRECTORY, run FUN with ARGS.
2777 ;; If the buffer has a wildcard pattern, check that it matches FILE.
2778 ;; (FILE does not include a directory component.)
2779 ;; FILE may be nil, in which case ignore it.
2780 ;; Return list of buffers where FUN succeeded (i.e., returned non-nil).
2783 file))
2787 success-list))
2789 ;; Delete the entry for FILE from
2801 "Clean up after a deleted file or directory FN.
2802 Removes any expanded subdirectory of deleted directory.
2803 If `dired-x' is loaded and `dired-clean-up-buffers-too' is non-nil,
2804 also offers to kill buffers visiting deleted files and directories."
2808 ;; Offer to kill buffer of deleted file FN.
2824 \f
2825 ;; Confirmation
2834 "Return a string for use in a prompt, either the current file
2835 name, or the marker and a count of marked files."
2836 ;; distinguish-one-marked can cause the first element to be just t.
2841 ;; more than 1 file:
2843 ;; abs(arg) = count
2844 ;; Perhaps this is nicer, but it also takes more screen space:
2845 ;;(format "[%s %d files]" (if (> arg 0) "next" "previous")
2846 ;; count)
2851 "Pop up buffer BUF in a way suitable for Dired."
2856 ;; Try to split the selected window vertically if
2857 ;; that's possible. (Bug#1806)
2859 ;; Otherwise, try to split WINDOW sensibly.
2861 pop-up-frames)
2863 ;; If dired-shrink-to-fit is t, make its window fit its contents.
2865 ;; Try to not delete window when we want to display less than
2866 ;; `window-min-height' lines.
2870 "A list of symbols for commands Dired should not confirm, or t.
2871 Command symbols are `byte-compile', `chgrp', `chmod', `chown', `compress',
2872 `copy', `delete', `hardlink', `load', `move', `print', `shell', `symlink',
2873 `touch' and `uncompress'.
2874 If t, confirmation is never needed."
2885 "Return FUNCTION's result on ARGS after showing which files are marked.
2886 Displays the file names in a buffer named BUFNAME;
2888 This uses function `dired-pop-to-buffer' to do that.
2890 FUNCTION should not manipulate files, just read input
2891 (an argument or confirmation).
2892 The window is not shown if there is just one file or
2893 OP-SYMBOL is a member of the list in `dired-no-confirm'.
2894 FILES is the list of marked files. It can also be (t FILENAME)
2895 in the case of one marked file, to distinguish that from using
2896 just the current file."
2900 ;; If FILES defaulted to the current line's file.
2905 ;; Handle (t FILE) just like (FILE), here.
2906 ;; That value is used (only in some cases), to mean
2907 ;; just one file that was marked, rather than the current line file.
2919 \f
2920 ;; Commands to mark or flag file(s) at or near current line.
2923 ;; This version skips non-file lines.
2934 ;; Advance to the next line--actually, to the line that *was* next.
2935 ;; (If FUNCTION inserted some new lines in between, skip them.)
2947 ;; This used to be a regexp match of the `total ...' line output by
2948 ;; ls, which is slightly faster, but that is not very robust; notably,
2949 ;; it fails for non-english locales.
2953 "Move to the next marked file, wrapping around the end of the buffer."
2970 "Move to the previous marked file, wrapping around the end of the buffer."
2975 ;; Return FILE's marker, or nil if unmarked.
2989 ;; Skip subdir line and following garbage like the `total' line:
3000 "Mark the current (or next ARG) files.
3001 If on a subdir headerline, mark all its files except `.' and `..'.
3005 this subdir."
3015 "Unmark the current (or next ARG) files.
3016 If looking at a subdir, unmark all its files except `.' and `..'."
3022 "In Dired, flag the current line's file for deletion.
3023 With prefix arg, repeat over several lines.
3025 If on a subdir headerline, mark all its files except `.' and `..'."
3031 "In Dired, move up lines and remove marks or deletion flags there.
3032 Optional prefix ARG says how many lines to unmark/unflag; default
3033 is one line."
3038 "Toggle marks: marked files become unmarked, and vice versa.
3039 Files marked with other flags (such as `D') are not affected.
3040 `.' and `..' are never toggled.
3041 As always, hidden subdirs are not affected."
3049 ;; use subst instead of insdel because it does not move
3050 ;; the gap and thus should be faster and because
3051 ;; other characters are left alone automatically
3058 \f
3059 ;;; Commands to mark or flag files based on their characteristics or names.
3068 "Mark all files matching REGEXP for use in later commands.
3069 A prefix argument means to unmark them instead.
3070 `.' and `..' are never marked.
3073 object files--just `.o' will mark more than you might think."
3087 "Mark all files with contents containing REGEXP for use in later commands.
3088 A prefix argument means to unmark them instead.
3089 `.' and `..' are never marked."
3103 ;; For now we do it inside emacs
3104 ;; Grep might be better if there are a lot of files
3114 )))
3118 "In Dired, flag all files containing the specified REGEXP for deletion.
3119 The match is against the non-directory part of the filename. Use `^'
3120 and `$' to anchor matches. Exclude subdirs by hiding them.
3121 `.' and `..' are never flagged."
3126 "Mark all symbolic links.
3127 With prefix argument, unmark or unflag all those files."
3133 "Mark all directory file lines except `.' and `..'.
3134 With prefix argument, unmark or unflag all those files."
3142 "Mark all executable files.
3143 With prefix argument, unmark or unflag all those files."
3148 ;; dired-x.el has a dired-mark-sexp interactive command: mark
3149 ;; files for which PREDICATE returns non-nil.
3152 "Flag for deletion files whose names suggest they are auto save files.
3153 A prefix argument says to unmark or unflag those files instead."
3157 ;; It is less than general to check for # here,
3158 ;; but it's the only way this runs fast enough.
3162 ;; Handle executables in case of -F option.
3163 ;; We need not worry about the other kinds
3164 ;; of markings that -F makes, since they won't
3165 ;; appear on real auto-save files.
3177 ;; `log' here is dubious, since it's typically used for useful log
3178 ;; files, not just TeX stuff. -- fx
3187 "Flag for deletion all files that match `dired-garbage-files-regexp'."
3192 "Flag all backup files (names ending with `~') for deletion.
3193 With prefix argument, unmark or unflag these files."
3197 ;; Don't call backup-file-name-p unless the last character looks like
3198 ;; it might be the end of a backup file name. This isn't very general,
3199 ;; but it's the only way this runs fast enough.
3201 ;; Handle executables in case of -F option.
3202 ;; We need not worry about the other kinds
3203 ;; of markings that -F makes, since they won't
3204 ;; appear on real backup files.
3214 "Change all OLD marks to NEW marks.
3215 OLD and NEW are both characters used to mark files."
3232 t)
3237 "Remove all marks from all files in the dired buffer."
3242 "Remove a specific mark (or any mark) from every file.
3243 After this command, type the mark character to remove,
3244 or type RET to remove all marks.
3245 With prefix arg, query for each marked file.
3253 Type SPC or `y' to unmark one file, DEL or `n' to skip to next,
3263 file))))
3269 count))))
3270 \f
3271 ;; Logging failures operating on files, and showing the results.
3276 "Pop up a buffer with error log output from Dired.
3277 A group of errors from a single command ends with a formfeed.
3293 ;; Log a message or the contents of a buffer.
3294 ;; If LOG is a string and there are more args, it is formatted with
3295 ;; those ARGS. Usually the LOG string ends with a \n.
3296 ;; End each bunch of errors with (dired-log t):
3297 ;; this inserts the current time and buffer at the start of the page,
3298 ;; and \f (formfeed) at the end.
3306 log)))
3319 "State a summary of a command's failures, in echo area and log buffer.
3320 STRING is an overall summary of the failures.
3321 FAILURES is a list of file names that we failed to operate on,
3322 or nil if file names are not applicable."
3332 string failures))
3333 ;; Log a summary describing a bunch of errors.
3336 \f
3337 ;;; Sorting
3339 ;; Most ls can only sort by name or by date (with -t), nothing else.
3340 ;; GNU ls sorts on size with -S, on extension with -X, and unsorted with -U.
3341 ;; So anything that does not contain these is sort "by name".
3346 This indicates to Dired which option switches to watch out for because they
3347 will change the sorting order behavior of `ls'.
3349 To change the default sorting order \(e.g. add a `-v' option\), see the
3350 variable `dired-listing-switches'. To temporarily override the listing
3355 ;; `dired-ls-sorting-switches' after -t overrides -t.
3367 "Non-nil means the Dired sort command is disabled.
3371 ;; Set modeline display according to dired-actual-switches.
3372 ;; Modeline display of "by name" or "by date" guarantees the user a
3373 ;; match with the corresponding regexps. Non-matching switches are
3374 ;; shown literally.
3379 dired-sort-by-name-regexp dired-actual-switches)
3382 dired-sort-by-date-regexp dired-actual-switches)
3389 "Toggle sorting by date, and refresh the Dired buffer.
3390 With a prefix argument, edit the current listing switches instead."
3400 ;; Toggle between sort by date/name. Reverts the buffer.
3402 dired-actual-switches))
3403 ;; Regexp for finding (possibly embedded) -t switches.
3405 case-fold-search)
3406 ;; Remove the -t switch.
3410 ;; Remove a stand-alone -t switch.
3413 ;; Remove a switch of the form -XtY for some X and Y.
3416 ;; Now, if we weren't sorting by date before, add the -t switch.
3422 ;; Some user code loads dired especially for this.
3423 ;; Don't do that--use replace-regexp-in-string instead.
3425 ;; Replace REGEXP with NEWTEXT everywhere in STRING and return result.
3426 ;; NEWTEXT is taken literally---no \\DIGIT escapes will be recognized.
3432 start me))
3436 "Specify new `ls' SWITCHES for current dired buffer.
3437 Values matching `dired-sort-by-date-regexp' or `dired-sort-by-name-regexp'
3438 set the minor mode accordingly, others appear literally in the mode line.
3439 With optional second arg NO-REVERT, don't refresh the listing afterwards."
3450 "Additional processing of -R in ls option string SWITCHES.
3451 Saves `dired-subdir-alist' when R is set and restores saved value
3452 minus any directories explicitly deleted when R is cleared.
3453 To be called first in body of `dired-sort-other', etc."
3457 ;; Adding -R to ls switches -- save `dired-subdir-alist':
3461 ;; Deleting -R from ls switches -- revert to pre-R subdirs
3462 ;; that are still present:
3468 dired-subdir-alist)
3469 ;; subdir still present...
3472 subdirs)))
3476 ;; No pre-R subdir alist, so revert to main directory
3477 ;; listing:
3479 \f
3481 ;;;; Drag and drop support
3484 "Decide whether recursive copies are allowed.
3485 A value of nil means no recursive copies.
3486 `always' means copy recursively without asking.
3487 `top' means ask for each directory at top level.
3488 Anything else means ask for each directory."
3503 ;; No need to get actions and descriptions from the source,
3504 ;; we only have three actions anyway.
3506 t
3512 "--"
3516 nil)))
3521 ;; Only used when (featurep 'dnd).
3528 "Copy, move or link a file to the dired directory.
3529 URI is the file to handle, ACTION is one of copy, move, link or ask.
3530 Ask means pop up a menu for the user to select one of copy, move or link."
3539 ;; If copying a directory and dired-recursive-copies is
3540 ;; nil, dired-copy-file fails. Pop up a notice.
3549 ;; Binding dired-overwrite-confirmed to nil makes
3550 ;; dired-handle-overwrite a no-op. We instead use
3551 ;; y-or-n-p, which pops a graphical menu.
3552 dired-overwrite-confirmed backup-file)
3554 ;; d-b-o is defined in dired-aux.
3556 dired-backup-overwrite
3572 action))))))
3575 "Copy, move or link a file to the dired directory if it is a local file.
3576 URI is the file to handle. If the hostname in the URI isn't local, do nothing.
3577 ACTION is one of copy, move, link or ask.
3578 Ask means pop up a menu for the user to select one of copy, move or link."
3581 nil)))
3582 \f
3584 ;;;; Desktop support
3589 "Auxiliary information to be saved in desktop file."
3591 ;; Value of `dired-directory'.
3593 ;; Directory name followed by list of files.
3596 ;; Directory name, optionally with shell wildcard.
3598 ;; Subdirectories in `dired-subdir-alist'.
3603 dired-subdir-alist)))))
3606 _buffer-name
3607 misc-data)
3608 "Restore a dired buffer specified in a desktop file."
3609 ;; First element of `misc-data' is the value of `dired-directory'.
3610 ;; This value is a directory name, optionally with shell wildcard or
3611 ;; a directory name followed by list of files.
3617 ;; The following elements of `misc-data' are the keys
3618 ;; from `dired-subdir-alist'.
3623 nil)))
3628 \f
3629 ;;; Start of automatically extracted autoloads.
3630 \f
3631 ;;;### (autoloads (dired-show-file-type dired-do-query-replace-regexp
3632 ;;;;;; dired-do-search dired-do-isearch-regexp dired-do-isearch
3633 ;;;;;; dired-isearch-filenames-regexp dired-isearch-filenames dired-isearch-filenames-setup
3634 ;;;;;; dired-hide-all dired-hide-subdir dired-tree-down dired-tree-up
3635 ;;;;;; dired-kill-subdir dired-mark-subdir-files dired-goto-subdir
3636 ;;;;;; dired-prev-subdir dired-insert-subdir dired-maybe-insert-subdir
3637 ;;;;;; dired-downcase dired-upcase dired-do-symlink-regexp dired-do-hardlink-regexp
3638 ;;;;;; dired-do-copy-regexp dired-do-rename-regexp dired-do-rename
3639 ;;;;;; dired-do-hardlink dired-do-symlink dired-do-copy dired-create-directory
3640 ;;;;;; dired-rename-file dired-copy-file dired-relist-file dired-remove-file
3641 ;;;;;; dired-add-file dired-do-redisplay dired-do-load dired-do-byte-compile
3642 ;;;;;; dired-do-compress dired-query dired-compress-file dired-do-kill-lines
3643 ;;;;;; dired-run-shell-command dired-do-shell-command dired-do-async-shell-command
3644 ;;;;;; dired-clean-directory dired-do-print dired-do-touch dired-do-chown
3645 ;;;;;; dired-do-chgrp dired-do-chmod dired-compare-directories dired-backup-diff
3646 ;;;;;; dired-diff) "dired-aux" "dired-aux.el" "198ca311b49f0b6354f915502bba4ab6")
3647 ;;; Generated autoloads from dired-aux.el
3650 Compare file at point with file FILE using `diff'.
3651 FILE defaults to the file at the mark. (That's the mark set by
3653 The prompted-for FILE is the first file given to `diff'.
3654 With prefix arg, prompt for second argument SWITCHES,
3655 which is the string of command switches for `diff'.
3660 Diff this file with its backup file or vice versa.
3661 Uses the latest backup, if there are several numerical backups.
3662 If this file is a backup, diff it with its original.
3663 The backup file is the first file given to `diff'.
3664 With prefix arg, prompt for argument SWITCHES which is options for `diff'.
3669 Mark files with different file attributes in two dired buffers.
3670 Compare file attributes of files in the current directory
3671 with file attributes in directory DIR2 using PREDICATE on pairs of files
3672 with the same name. Mark files for which PREDICATE returns non-nil.
3673 Mark files with different names if PREDICATE is nil (or interactively
3674 with empty input at the predicate prompt).
3676 PREDICATE is a Lisp expression that can refer to the following variables:
3678 size1, size2 - file size in bytes
3679 mtime1, mtime2 - last modification time in seconds, as a float
3680 fa1, fa2 - list of file attributes
3681 returned by function `file-attributes'
3683 where 1 refers to attribute of file in the current dired buffer
3684 and 2 to attribute of file in second dired buffer.
3686 Examples of PREDICATE:
3688 (> mtime1 mtime2) - mark newer files
3689 (not (= size1 size2)) - mark files with different sizes
3690 (not (string= (nth 8 fa1) (nth 8 fa2))) - mark files with different modes
3691 (not (and (= (nth 2 fa1) (nth 2 fa2)) - mark files with different UID
3692 (= (nth 3 fa1) (nth 3 fa2)))) and GID.
3697 Change the mode of the marked (or next ARG) files.
3698 Symbolic modes like `g+w' are allowed.
3703 Change the group of the marked (or next ARG) files.
3708 Change the owner of the marked (or next ARG) files.
3713 Change the timestamp of the marked (or next ARG) files.
3714 This calls touch.
3719 Print the marked (or next ARG) files.
3720 Uses the shell command coming from variables `lpr-command' and
3721 `lpr-switches' as default.
3726 Flag numerical backups for deletion.
3727 Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
3728 Positive prefix arg KEEP overrides `dired-kept-versions';
3729 Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
3732 with a prefix argument.
3737 Run a shell command COMMAND on the marked files asynchronously.
3739 Like `dired-do-shell-command' but if COMMAND doesn't end in ampersand,
3740 adds `* &' surrounded by whitespace and executes the command asynchronously.
3741 The output appears in the buffer `*Async Shell Command*'.
3746 Run a shell command COMMAND on the marked files.
3747 If no files are marked or a specific numeric prefix arg is given,
3749 The prompt mentions the file(s) or the marker, as appropriate.
3751 If there is a `*' in COMMAND, surrounded by whitespace, this runs
3752 COMMAND just once with the entire file list substituted there.
3754 If there is no `*', but there is a `?' in COMMAND, surrounded by
3755 whitespace, this runs COMMAND on each file individually with the
3756 file name substituted for `?'.
3758 Otherwise, this runs COMMAND on each file individually with the
3759 file name added at the end of COMMAND (separated by a space).
3761 `*' and `?' when not surrounded by whitespace have no special
3762 significance for `dired-do-shell-command', and are passed through
3763 normally to the shell, but you must confirm first. To pass `*' by
3766 If COMMAND produces output, it goes to a separate buffer.
3768 This feature does not try to redisplay Dired buffers afterward, as
3769 there's no telling what files COMMAND may have changed.
3772 When COMMAND runs, its working directory is the top-level directory
3773 of the Dired buffer, so output files usually are created there
3774 instead of in a subdir.
3776 In a noninteractive call (from Lisp code), you must specify
3777 the list of file names explicitly with the FILE-LIST argument, which
3778 can be produced by `dired-get-marked-files', for example.
3788 Kill all marked lines (not the files).
3789 With a prefix argument, kill that many lines starting with the current line.
3790 \(A negative argument kills backward.)
3791 If you use this command with a prefix argument to kill the line
3792 for a file that is a directory, which you have inserted in the
3793 Dired buffer as a subdirectory, then it deletes that subdirectory
3794 from the buffer as well.
3795 To kill an entire subdirectory (without killing its line in the
3796 parent directory), go to its directory header line and use this
3797 command with a prefix argument (the value does not matter).
3807 Format PROMPT with ARGS, query user, and store the result in SYM.
3808 The return value is either nil or t.
3810 The user may type y or SPC to accept once; n or DEL to skip once;
3811 ! to accept this and subsequent queries; or q or ESC to decline
3812 this and subsequent queries.
3814 If SYM is already bound to a non-nil value, this function may
3815 return automatically without querying the user. If SYM is !,
3816 return t; if SYM is q or ESC, return nil.
3821 Compress or uncompress marked (or next ARG) files.
3826 Byte compile marked (or next ARG) Emacs Lisp files.
3831 Load the marked (or next ARG) Emacs Lisp files.
3836 Redisplay all marked (or next ARG) files.
3837 If on a subdir line, redisplay that subdirectory. In that case,
3838 a prefix arg lets you edit the `ls' switches used for the new listing.
3840 Dired remembers switches specified with a prefix arg, so that reverting
3841 the buffer will not reset them. However, using `dired-undo' to re-insert
3842 or delete subdirectories can bypass this machinery. Hence, you sometimes
3843 may have to reset some subdirectory switches after a `dired-undo'.
3844 You can reset all subdirectory switches to the default using
3846 See Info node `(emacs)Subdir switches' for more details.
3861 Create or update the line for FILE in all Dired buffers it would belong in.
3876 Create a directory called DIRECTORY.
3877 If DIRECTORY already exists, signal an error.
3882 Copy all marked (or next ARG) files, or copy the current file.
3883 This normally preserves the last-modified date when copying.
3884 When operating on just the current file, you specify the new name.
3885 When operating on multiple or marked files, you specify a directory,
3886 and new copies of these files are made in that directory
3887 with the same names that the files currently have. The default
3888 suggested for the target directory depends on the value of
3889 `dired-dwim-target', which see.
3891 This command copies symbolic links by creating new ones,
3892 like `cp -d'.
3897 Make symbolic links to current file or all marked (or next ARG) files.
3898 When operating on just the current file, you specify the new name.
3899 When operating on multiple or marked files, you specify a directory
3900 and new symbolic links are made in that directory
3901 with the same names that the files currently have. The default
3902 suggested for the target directory depends on the value of
3903 `dired-dwim-target', which see.
3910 Add names (hard links) current file or all marked (or next ARG) files.
3911 When operating on just the current file, you specify the new name.
3912 When operating on multiple or marked files, you specify a directory
3913 and new hard links are made in that directory
3914 with the same names that the files currently have. The default
3915 suggested for the target directory depends on the value of
3916 `dired-dwim-target', which see.
3921 Rename current file or all marked (or next ARG) files.
3922 When renaming just the current file, you specify the new name.
3923 When renaming multiple or marked files, you specify a directory.
3924 This command also renames any buffers that are visiting the files.
3925 The default suggested for the target directory depends on the value
3926 of `dired-dwim-target', which see.
3931 Rename selected files whose names match REGEXP to NEWNAME.
3933 With non-zero prefix argument ARG, the command operates on the next ARG
3934 files. Otherwise, it operates on all the marked files, or the current
3935 file if none are marked.
3937 As each match is found, the user must type a character saying
3940 REGEXP defaults to the last regexp used.
3942 With a zero prefix arg, renaming by regexp affects the absolute file name.
3943 Normally, only the non-directory part of the file name is used and changed.
3948 Copy selected files whose names match REGEXP to NEWNAME.
3949 See function `dired-do-rename-regexp' for more info.
3954 Hardlink selected files whose names match REGEXP to NEWNAME.
3955 See function `dired-do-rename-regexp' for more info.
3960 Symlink selected files whose names match REGEXP to NEWNAME.
3961 See function `dired-do-rename-regexp' for more info.
3966 Rename all marked (or next ARG) files to upper case.
3971 Rename all marked (or next ARG) files to lower case.
3976 Insert this subdirectory into the same dired buffer.
3978 else inserts it at its natural place (as `ls -lR' would have done).
3979 With a prefix arg, you may edit the ls switches used for this listing.
3980 You can add `R' to the switches to expand the whole tree starting at
3981 this subdirectory.
3982 This function takes some pains to conform to `ls -lR' output.
3984 Dired remembers switches specified with a prefix arg, so that reverting
3985 the buffer will not reset them. However, using `dired-undo' to re-insert
3986 or delete subdirectories can bypass this machinery. Hence, you sometimes
3987 may have to reset some subdirectory switches after a `dired-undo'.
3988 You can reset all subdirectory switches to the default using
3990 See Info node `(emacs)Subdir switches' for more details.
3995 Insert this subdirectory into the same dired buffer.
3996 If it is already present, overwrites previous entry,
3997 else inserts it at its natural place (as `ls -lR' would have done).
3998 With a prefix arg, you may edit the `ls' switches used for this listing.
3999 You can add `R' to the switches to expand the whole tree starting at
4000 this subdirectory.
4001 This function takes some pains to conform to `ls -lR' output.
4006 Go to previous subdirectory, regardless of level.
4007 When called interactively and not on a subdir line, go to this subdir's line.
4012 Go to end of header line of DIR in this dired buffer.
4013 Return value of point on success, otherwise return nil.
4019 Mark all files except `.' and `..' in current subdirectory.
4020 If the Dired buffer shows multiple directories, this command
4021 marks the files listed in the subdirectory that point is in.
4026 Remove all lines of current subdirectory.
4027 Lower levels are unaffected.
4032 Go up ARG levels in the dired tree.
4037 Go down in the dired tree.
4042 Hide or unhide the current subdirectory and move to next directory.
4043 Optional prefix arg is a repeat factor.
4049 Hide all subdirectories, leaving only their header lines.
4050 If there is already something hidden, make everything visible again.
4056 Set up isearch to search in Dired file names.
4057 Intended to be added to `isearch-mode-hook'.
4062 Search for a string using Isearch only in file names in the Dired buffer.
4067 Search for a regexp using Isearch only in file names in the Dired buffer.
4072 Search for a string through all marked files using Isearch.
4077 Search for a regexp through all marked files using Isearch.
4082 Search through all marked files for a match for REGEXP.
4083 Stops when a match is found.
4089 Do `query-replace-regexp' of FROM with TO, on all marked files.
4090 Third arg DELIMITED (prefix arg) means replace only word-delimited matches.
4097 Print the type of FILE, according to the `file' command.
4098 If you give a prefix to this command, and FILE is a symbolic
4099 link, then the type of the file linked to by FILE is printed
4100 instead.
4104 ;;;***
4105 \f
4106 ;;;### (autoloads (dired-do-relsymlink dired-jump-other-window dired-jump)
4107 ;;;;;; "dired-x" "dired-x.el" "90459fb5998296fc67986945701b2bfc")
4108 ;;; Generated autoloads from dired-x.el
4111 Jump to dired buffer corresponding to current buffer.
4112 If in a file, dired the current directory and move to file's line.
4113 If in Dired already, pop up a level and goto old directory's line.
4114 In case the proper dired file line cannot be found, refresh the dired
4115 buffer and try again.
4116 When OTHER-WINDOW is non-nil, jump to dired buffer in other window.
4117 Interactively with prefix argument, read FILE-NAME and
4118 move to its line in dired.
4128 Relative symlink all marked (or next ARG) files into a directory.
4129 Otherwise make a relative symbolic link to the current file.
4130 This creates relative symbolic links like
4132 foo -> ../bar/foo
4134 not absolute ones like
4136 foo -> /ugly/file/name/that/may/change/any/day/bar/foo
4142 ;;;***
4143 \f
4144 ;;; End of automatically extracted autoloads.
4150 ;;; dired.el ends here