| blob | 4b9bc19c8d9affb86f3a4ddeb609d267338ac579 |
1 ;;; dired.el --- directory-browsing commands
3 ;; Copyright (C) 1985-1986, 1992-1997, 2000-2011
4 ;; Free Software Foundation, Inc.
6 ;; Author: Sebastian Kremer <sk@thp.uni-koeln.de>
7 ;; Maintainer: FSF
8 ;; Keywords: files
9 ;; Package: emacs
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
26 ;;; Commentary:
28 ;; This is a major mode for directory browsing and editing.
29 ;; It is documented in the Emacs manual.
31 ;; Rewritten in 1990/1991 to add tree features, file marking and
32 ;; sorting by Sebastian Kremer <sk@thp.uni-koeln.de>.
33 ;; Finished up by rms in 1992.
35 ;;; Code:
39 ;;; Customizable variables
42 "Directory editing."
47 "Handling marks in Dired."
52 ;;;###autoload
54 "Switches passed to `ls' for Dired. MUST contain the `l' option.
55 May contain all other options that don't contradict `-l';
56 may contain even `F', `b', `i' and `s'. See also the variable
57 `dired-ls-F-marks-symlinks' concerning the `F' switch.
58 On systems such as MS-DOS and MS-Windows, which use `ls' emulation in Lisp,
59 some of the `ls' switches are not supported; see the doc string of
60 `insert-directory' in `ls-lisp.el' for more details."
65 "If non-nil, switches passed to `ls' for inserting subdirectories.
66 If nil, `dired-listing-switches' is used."
76 "Name of chown command (usually `chown')."
82 The special value of `unspecified' means to check explicitly, and
83 save the result in this variable. This is performed the first
84 time `dired-insert-directory' is called."
91 "Name of chmod command (usually `chmod')."
96 "Name of touch command (usually `touch')."
101 "Informs Dired about how `ls -lF' marks symbolic links.
102 Set this to t if `ls' (or whatever program is specified by
103 `insert-directory-program') with `-lF' marks the symbolic link
104 itself with a trailing @ (usually the case under Ultrix).
106 Example: if `ln -s foo bar; ls -F bar' gives `bar -> foo', set it to
107 nil (the default), if it gives `bar@ -> foo', set it to t.
109 Dired checks if there is really a @ appended. Thus, if you have a
110 marking `ls' program on one host and a non-marking on another host, and
111 don't care about symbolic links which really end in a @, you can
112 always set this variable to t."
117 "Regexp of files to skip when finding first file of a directory.
118 A value of nil means move to the subdir line.
119 A value of t means move to first file."
122 regexp)
126 ;; Use t as default so that moved files "take their markers with them".
127 "Controls marking of renamed files.
128 If t, files keep their previous marks when they are renamed.
129 If a character, renamed files (whether previously marked or not)
130 are afterward marked with that character."
136 "Controls marking of copied files.
137 If t, copied files are marked if and as the corresponding original files were.
138 If a character, copied files are unconditionally marked with that character."
144 "Controls marking of newly made hard links.
145 If t, they are marked if and as the files linked to were marked.
146 If a character, new links are unconditionally marked with that character."
152 "Controls marking of newly made symbolic links.
153 If t, they are marked if and as the files linked to were marked.
154 If a character, new links are unconditionally marked with that character."
160 "If non-nil, Dired tries to guess a default target directory.
161 This means: if there is a dired buffer displayed in the next window,
162 use its current subdir, instead of the current subdir of this dired buffer.
164 The target is used in the prompt for file copy, rename etc."
169 "If non-nil, Dired preserves the last-modified time in a file copy.
170 \(This works on only some systems.)"
174 ; These variables were deleted and the replacements are on files.el.
175 ; We leave aliases behind for back-compatibility.
179 ;;; Hook variables
182 "Run after loading Dired.
183 You can customize key bindings or load extensions with this."
188 "Run at the very end of `dired-mode'."
193 "This hook is run before a dired buffer is read in (created or reverted)."
198 "Hook run after each time a file or directory is read by Dired.
199 After each listing of a file or directory, this hook is run
200 with the buffer narrowed to the listing."
203 ;; Note this can't simply be run inside function `dired-ls' as the hook
204 ;; functions probably depend on the dired-subdir-alist to be OK.
210 "The functions to call when a drop in `dired-mode' is made.
211 See `dnd-protocol-alist' for more information. When nil, behave
212 as in other buffers. Changing this option is effective only for
213 new dired buffers."
219 ;; Internal variables
222 ;; so that you can write things like
223 ;; (let ((dired-marker-char ?X))
224 ;; ;; great code using X markers ...
225 ;; )
226 ;; For example, commands operating on two sets of files, A and B.
227 ;; Or marking files with digits 0-9. This could implicate
228 ;; concentric sets or an order for the marked files.
229 ;; The code depends on dynamic scoping on the marker char.
230 "In Dired, the current mark character.
237 ;; I see no reason ever to make this nil -- rms.
238 ;; (> baud-rate search-slow-speed)
245 ;;;###autoload
247 "The directory name or wildcard spec that this dired directory lists.
248 Local to each dired buffer. May be a list, in which case the car is the
249 directory name and the cdr is the list of files to mention.
261 ;; These regexps must be tested at beginning-of-line, but are also
262 ;; used to search for next matches, so neither omitting "^" nor
263 ;; replacing "^" by "\n" (to make it slightly faster) will work.
266 ;; "Regexp matching a marked line.
267 ;; Important: the match ends just after the marker."
269 ;; The [^:] part after "d" and "l" is to avoid confusion with the
270 ;; DOS/Windows-style drive letters in directory names, like in "d:/foo".
278 "-[-r][-w].[-r][-w][xs][-r][-w]."
284 ;; The subdirectory names in the next two lists are expanded.
286 "Association list of subdirectories and their buffer positions.
287 Each subdirectory has an element: (DIRNAME . STARTMARKER).
288 The order of elements is the reverse of the order in the buffer.
292 "Keeps track of which switches to use for inserted subdirectories.
300 "Regexp matching a maybe hidden subdirectory line in `ls -lR' output.
301 Subexpression 1 is the subdirectory proper, no trailing colon.
302 The match starts at the beginning of the line and ends after the end
307 "Faces used by Dired."
313 "Face used for directory headers."
321 "Face used for dired marks."
329 "Face used for marked files."
337 "Face used for flagged files."
344 ;; Inherit from font-lock-warning-face since with min-colors 8
345 ;; font-lock-comment-face is not colored any more.
347 "Face used to highlight a part of a buffer that needs user attention."
355 ;; Inherit from font-lock-comment-delimiter-face since with min-colors 8
356 ;; font-lock-comment-face is not colored any more.
358 "Face used to highlight permissions of group- and world-writable files."
366 "Face used for subdirectories."
374 "Face used for symbolic links."
382 "Face used for files suffixed with `completion-ignored-extensions'."
390 ;;
391 ;; Dired marks.
393 ;;
394 ;; We make heavy use of MATCH-ANCHORED, since the regexps don't identify the
395 ;; file name itself. We search for Dired defined regexps, and then use the
396 ;; Dired defined function `dired-move-to-filename' before searching for the
397 ;; simple regexp ".+". It is that regexp which matches the file name.
398 ;;
399 ;; Marked files.
402 ;;
403 ;; Flagged files.
406 ;; People who are paranoid about security would consider this more
407 ;; important than other things such as whether it is a directory.
408 ;; But we don't want to encourage paranoia, so our default
409 ;; should be what's most useful for non-paranoids. -- rms.
410 ;;; ;;
411 ;;; ;; Files that are group or world writable.
412 ;;; (list (concat dired-re-maybe-mark dired-re-inode-size
413 ;;; "\\([-d]\\(....w....\\|.......w.\\)\\)")
414 ;;; '(1 dired-warning-face)
415 ;;; '(".+" (dired-move-to-filename) nil (0 dired-warning-face)))
416 ;; However, we don't need to highlight the file name, only the
417 ;; permissions, to win generally. -- fx.
418 ;; Fixme: we could also put text properties on the permission
419 ;; fields with keymaps to frob the permissions, somewhat a la XEmacs.
426 ;;
427 ;; Subdirectories.
430 ;;
431 ;; Symbolic links.
434 ;;
435 ;; Files suffixed with `completion-ignored-extensions'.
437 ;; It is quicker to first find just an extension, then go back to the
438 ;; start of that file name. So we do this complex MATCH-ANCHORED form.
441 ;;
442 ;; Files suffixed with `completion-ignored-extensions'
443 ;; plus a character put in by -F.
449 ;; If the last character is not part of the filename,
450 ;; move back to the start of the filename
451 ;; so it can be fontified.
452 ;; Otherwise, leave point at the end of the line;
453 ;; that way, nothing is fontified.
457 ;;
458 ;; Explicitly put the default face on file names ending in a colon to
459 ;; avoid fontifying them as directory header.
462 ;;
463 ;; Directory headers.
465 )
469 \f
470 ;;; Macros must be defined before they are used, for the byte compiler.
473 "Mark all files for which PREDICATE evals to non-nil.
474 PREDICATE is evaluated on each line, with point at beginning of line.
475 MSG is a noun phrase for the type of files being marked.
476 It should end with a noun that can be pluralized by adding `s'.
477 Return value is the number of files marked, or nil if none were marked."
491 count
492 ,msg
500 distinguish-one-marked)
501 "Eval BODY with point on each marked line. Return a list of BODY's results.
502 If no marked file could be found, execute BODY on the current line.
503 ARG, if non-nil, specifies the files to use instead of the marked files.
504 If ARG is an integer, use the next ARG (or previous -ARG, if
505 ARG<0) files. In that case, point is dragged along. This is
506 so that commands on the next ARG (instead of the marked) files
507 can be chained easily.
508 For any other non-nil value of ARG, use the current file.
509 If optional third arg SHOW-PROGRESS evaluates to non-nil,
510 redisplay the dired buffer after each file is processed.
511 No guarantee is made about the position on the marked line.
512 BODY must ensure this itself if it depends on this.
513 Search starts at the beginning of the buffer, thus the car of the list
514 corresponds to the line nearest to the buffer's bottom. This
515 is also true for (positive and negative) integer values of ARG.
516 BODY should not be too long as it is expanded four times.
518 If DISTINGUISH-ONE-MARKED is non-nil, then if we find just one marked file,
519 return (t FILENAME) instead of (FILENAME)."
520 ;;
521 ;;Warning: BODY must not add new lines before point - this may cause an
522 ;;endless loop.
523 ;;This warning should not apply any longer, sk 2-Sep-1991 14:10.
530 ,arg
536 results))
537 ;; non-nil, non-integer ARG means use current file:
542 ;; remember position of next marked file before BODY
543 ;; can insert lines before the just found file,
544 ;; confusing us by finding the same marked file again
545 ;; and again and...
553 ;; move after last match
562 results
564 ;; save-excursion loses, again
568 "Return the marked files' names as list of strings.
569 The list is in the same order as the buffer, that is, the car is the
570 first marked file.
571 Values returned are normally absolute file names.
572 Optional arg LOCALP as in `dired-get-filename'.
573 Optional second argument ARG, if non-nil, specifies files near
574 point instead of marked files. It usually comes from the prefix
575 argument.
576 If ARG is an integer, use the next ARG files.
577 Any other non-nil value means to use the current file instead.
578 Optional third argument FILTER, if non-nil, is a function to select
579 some of the files--those for which (funcall FILTER FILENAME) is non-nil.
581 If DISTINGUISH-ONE-MARKED is non-nil, then if we find just one marked file,
582 return (t FILENAME) instead of (FILENAME).
583 Don't use that together with FILTER."
588 arg nil distinguish-one-marked)))
589 result)
592 all-of-them
597 result)))
598 \f
599 ;; The dired command
602 ;; For use in interactive.
606 dired-listing-switches))
607 ;; If a dialog is about to be used, call read-directory-name so
608 ;; the dialog code knows we want directories. Some dialogs can
609 ;; only select directories or files when popped up, not both.
612 nil default-directory nil)
614 nil default-directory nil)))))
616 ;; We want to switch to a more sophisticated version of
617 ;; dired-read-dir-and-switches like the following, if there is a way
618 ;; to make it more intuitive. See bug#1285.
620 ;; (defun dired-read-dir-and-switches (str)
621 ;; ;; For use in interactive.
622 ;; (reverse
623 ;; (list
624 ;; (if current-prefix-arg
625 ;; (read-string "Dired listing switches: "
626 ;; dired-listing-switches))
627 ;; ;; If a dialog is about to be used, call read-directory-name so
628 ;; ;; the dialog code knows we want directories. Some dialogs can
629 ;; ;; only select directories or files when popped up, not both.
630 ;; (if (next-read-file-uses-dialog-p)
631 ;; (read-directory-name (format "Dired %s(directory): " str)
632 ;; nil default-directory nil)
633 ;; (let ((cie ()))
634 ;; (dolist (ext completion-ignored-extensions)
635 ;; (if (eq ?/ (aref ext (1- (length ext)))) (push ext cie)))
636 ;; (setq cie (concat (regexp-opt cie "\\(?:") "\\'"))
637 ;; (lexical-let* ((default (and buffer-file-name
638 ;; (abbreviate-file-name buffer-file-name)))
639 ;; (cie cie)
640 ;; (completion-table
641 ;; ;; We need a mix of read-file-name and
642 ;; ;; read-directory-name so that completion to directories
643 ;; ;; is preferred, but if the user wants to enter a global
644 ;; ;; pattern, he can still use completion on filenames to
645 ;; ;; help him write the pattern.
646 ;; ;; Essentially, we want to use
647 ;; ;; (completion-table-with-predicate
648 ;; ;; 'read-file-name-internal 'file-directory-p nil)
649 ;; ;; but that doesn't work because read-file-name-internal
650 ;; ;; does not obey its `predicate' argument.
651 ;; (completion-table-in-turn
652 ;; (lambda (str pred action)
653 ;; (let ((read-file-name-predicate
654 ;; (lambda (f)
655 ;; (and (not (member f '("./" "../")))
656 ;; ;; Hack! Faster than file-directory-p!
657 ;; (eq (aref f (1- (length f))) ?/)
658 ;; (not (string-match cie f))))))
659 ;; (complete-with-action
660 ;; action 'read-file-name-internal str nil)))
661 ;; 'read-file-name-internal)))
662 ;; (minibuffer-with-setup-hook
663 ;; (lambda ()
664 ;; (setq minibuffer-default default)
665 ;; (setq minibuffer-completion-table completion-table))
666 ;; (read-file-name (format "Dired %s(directory): " str)
667 ;; nil default-directory nil))))))))
670 "Try to get a file name at point in the current dired buffer.
671 This hook is inteneded to be put in `file-name-at-point-functions'."
678 ;;;###autoload (define-key ctl-x-map "d" 'dired)
679 ;;;###autoload
682 Optional second argument SWITCHES specifies the `ls' options used.
683 \(Interactively, use a prefix argument to be able to specify SWITCHES.)
684 Dired displays a list of files in DIRNAME (which may also have
685 shell wildcards appended to select certain files). If DIRNAME is a cons,
686 its first element is taken as the directory name and the rest as an explicit
687 list of files to make directory entries for.
689 You can move around in it with the usual commands.
694 If DIRNAME is already in a dired buffer, that buffer is used without refresh."
695 ;; Cannot use (interactive "D") because of wildcards.
699 ;;;###autoload (define-key ctl-x-4-map "d" 'dired-other-window)
700 ;;;###autoload
706 ;;;###autoload (define-key ctl-x-5-map "d" 'dired-other-frame)
707 ;;;###autoload
713 ;;;###autoload
715 "Like `dired' but returns the dired buffer as value, does not select it."
717 ;; This loses the distinction between "/foo/*/" and "/foo/*" that
718 ;; some shells make:
729 ;; If the argument was syntactically a directory name not a file name,
730 ;; or if it happens to name a file that is a directory,
731 ;; convert it syntactically to a directory name.
732 ;; The reason for checking initially-was-dirname
733 ;; and not just file-directory-p
734 ;; is that file-directory-p is slow over ftp.
742 ;; The following is an internal dired function. It returns non-nil if
743 ;; the directory visited by the current dired buffer has changed on
744 ;; disk. DIRNAME should be the directory name of that directory.
753 "Return non-nil if current dired buffer needs updating.
754 If NOCONFIRM is non-nil, then this function always returns nil
755 for a remote directory. This feature is used by Auto Revert Mode."
761 ;; Do not auto-revert when the dired buffer can be currently
762 ;; written by the user as in `wdired-mode'.
763 buffer-read-only
767 "Automatically revert dired buffer on revisiting.
768 If t, revisiting an existing dired buffer automatically reverts it.
769 If its value is a function, call this function with the directory
770 name as single argument and revert the buffer if it returns non-nil.
771 Otherwise, a message offering to revert the changed dired buffer
772 is displayed.
773 Note that this is not the same as `auto-revert-mode' that
774 periodically reverts at specified time intervals."
784 ;; If there is an existing dired buffer for DIRNAME, just leave
785 ;; buffer as it is (don't even call dired-revert).
786 ;; This saves time especially for deep trees or with ange-ftp.
787 ;; The user can type `g' easily, and it is more consistent with find-file.
788 ;; But if SWITCHES are given they are probably different from the
789 ;; buffer's old value, so call dired-sort-other, which does
790 ;; revert the buffer.
791 ;; A pity we can't possibly do "Directory has changed - refresh? "
792 ;; like find-file does.
793 ;; Optional argument MODE is passed to dired-find-buffer-nocreate,
794 ;; see there.
797 ;; Look for an existing buffer.
799 ;; Note that buffer already is in dired-mode, if found.
806 ;; file list may have changed
808 ;; this calls dired-revert
810 ;; Always revert regardless of whether it has changed or not.
813 ;; Revert when predicate function returns non-nil.
818 ;; If directory has changed on disk, offer to revert.
823 ;; Else a new buffer
825 ;; We can do this unconditionally
826 ;; because dired-noselect ensures that the name
827 ;; is passed in directory name syntax
828 ;; if it was the name of a directory at all.
833 ;; default-directory and dired-actual-switches are set now
834 ;; (buffer-local), so we can call dired-readin:
839 ;; dired-readin can fail if parent directories are inaccessible.
840 ;; Don't leave an empty buffer around in that case.
845 buffer))
848 ;; Enlarged by dired-advertise
849 ;; Queried by function dired-buffers-for-dir. When this detects a
850 ;; killed buffer, it is removed from this list.
855 ;; FIXME add a doc-string, and document dired-x extensions.
857 ;; This differs from dired-buffers-for-dir in that it does not consider
858 ;; subdirs of default-directory and searches for the first match only.
859 ;; Also, the major mode must be MODE.
861 dired-find-subdir
862 ;; Don't try to find a wildcard as a subdirectory.
868 ;; Wildcards must match, too:
870 ;; We don't want to switch to the same buffer---
873 ;; ---unless it's the only possibility:
875 ;; No dired-x, or dired-find-subdir nil.
884 dired-directory ;; nil during find-alternate-file
889 dired-directory))))
891 blist nil)
893 found)))
895 \f
896 ;; Read in a new dired buffer
899 "Read in a new dired buffer.
900 Differs from `dired-insert-subdir' in that it accepts
901 wildcards, erases the buffer, and builds the subdir-alist anew
902 \(including making it buffer-local and clearing it first)."
904 ;; default-directory and dired-actual-switches must be buffer-local
905 ;; and initialized by now.
907 ;; This makes readin much much faster.
908 ;; In particular, it prevents the font lock hook from running
909 ;; until the directory is all read in.
916 ;; This hook which may want to modify dired-actual-switches
917 ;; based on dired-directory, e.g. with ange-ftp to a SysV host
918 ;; where ls won't understand -Al switches.
926 ;; Don't make undo entries for readin.
932 ;; Must first make alist buffer local and set it to nil because
933 ;; dired-build-subdir-alist will call dired-clear-alist first
940 ;; No need to narrow since the whole buffer contains just
941 ;; dired-readin's output, nothing else. The hook can
942 ;; successfully use dired functions (e.g. dired-get-filename)
943 ;; as the subdir-alist has been built in dired-readin.
946 ;; Subroutines of dired-readin
949 ;; Insert listing for the specified dir (and maybe file list)
950 ;; already in dired-directory, assuming a clean buffer.
956 file-list nil))
960 ;; If we are reading a whole single directory...
965 ;; Else treat it as a wildcard spec
966 ;; unless we have an explicit list of files.
971 "Align the fields of a file to the ones of surrounding lines.
972 BEG..END is the line where the file info is located."
973 ;; Some versions of ls try to adjust the size of each field so as to just
974 ;; hold the largest element ("largest" in the current invocation, of
975 ;; course). So when a single line is output, the size of each field is
976 ;; just big enough for that one output. Thus when dired refreshes one
977 ;; line, the alignment if this line w.r.t the rest is messed up because
978 ;; the fields of that one line will generally be smaller.
979 ;;
980 ;; To work around this problem, we here add spaces to try and
981 ;; re-align the fields as needed. Since this is purely aesthetic,
982 ;; it is of utmost importance that it doesn't mess up anything like
983 ;; `dired-move-to-filename'. To this end, we limit ourselves to
984 ;; adding spaces only, and to only add them at places where there
985 ;; was already at least one space. This way, as long as
986 ;; `directory-listing-before-filename-regexp' always matches spaces
987 ;; with "*" or "+", we know we haven't made anything worse. There
988 ;; is one spot where the exact number of spaces is important, which
989 ;; is just before the actual filename, so we refrain from adding
990 ;; spaces there (and within the filename as well, of course).
993 ;; Check that there is indeed a file, and that there is anoter adjacent
994 ;; file with which to align, and that additional spaces are needed to
995 ;; align the filenames.
1008 ;; Make sure there is some work left to do.
1010 ;; If we've only looked at the line above, check to see if the line
1011 ;; below exists as well and if so, align with the shorter one.
1020 ;; Keep positions uptodate when we insert stuff.
1023 ;; Main loop.
1027 ;; Don't touch anything just before (and after) the
1028 ;; beginning of the filename.
1030 ;; We're now just in front of a field, with a space behind us.
1032 ;; Nums are right-aligned.
1034 ;; Let's look at the other line, in the same column: we
1035 ;; should be either near the end of the previous field, or
1036 ;; in the space between that field and the next.
1037 ;; [ Of course, it's also possible that we're already within
1038 ;; the next field or even past it, but that's unlikely since
1039 ;; other-col > file-col. ]
1040 ;; Let's find the distance to the alignment-point (either
1041 ;; the beginning or the end of the next field, depending on
1042 ;; whether this field is left or right aligned).
1052 ;; Now, the number of spaces to insert is align-pt-offset
1053 ;; minus the distance to the equivalent point on the
1054 ;; current line.
1057 align-pt-offset
1067 ;; Let's just make really sure we did not mess up.
1070 ;; Damn! We messed up: let's revert the change.
1072 ;; Now skip to next field.
1080 "Insert a directory listing of DIR, Dired style.
1081 Use SWITCHES to make the listings.
1082 If FILE-LIST is non-nil, list only those files.
1083 Otherwise, if WILDCARD is non-nil, expand wildcards;
1084 in that case, DIR should be a file name that uses wildcards.
1085 In other cases, DIR should be a directory name or a directory filename.
1086 If HDR is non-nil, insert a header line with the directory name."
1089 end)
1091 ;; Don't try to invoke `ls' if we are on DOS/Windows where
1092 ;; ls-lisp emulation is used, except if they want to use `ls'
1093 ;; as indicated by `ls-lisp-use-insert-directory-program'.
1097 ;; Check whether "ls --dired" gives exit code 0, and
1098 ;; save the answer in `dired-use-ls-dired'.
1102 dired-use-ls-dired)
1105 ;; We used to specify the C locale here, to force English month names;
1106 ;; but this should not be necessary any more,
1107 ;; with the new value of `directory-listing-before-filename-regexp'.
1112 ;; Re-align fields, if necessary.
1115 ;; Quote certain characters, unless ls quoted them for us.
1124 nil t))
1130 nil t))
1133 ;; If we used --dired and it worked, the lines are already indented.
1134 ;; Otherwise, indent them.
1140 ;; Insert text at the beginning to standardize things.
1146 ;; Note that dired-build-subdir-alist will replace the name
1147 ;; by its expansion, so it does not matter whether what we insert
1148 ;; here is fully expanded, but it should be absolute.
1151 ;; Insert "wildcard" line where "total" line would be for a full dir.
1155 "Make the file names highlight when the mouse is on them."
1167 dired-filename t
1171 \f
1172 ;; Reverting a dired buffer
1175 "Reread the dired buffer.
1176 Must also be called after `dired-actual-switches' have changed.
1177 Should not fail even on completely garbaged buffers.
1178 Preserves old cursor, marks/flags, hidden-p.
1180 Dired sets `revert-buffer-function' to this function. The args
1181 ARG and NOCONFIRM, passed from `revert-buffer', are ignored."
1193 ;; treat top level dir extra (it may contain wildcards)
1200 ;; Run dired-after-readin-hook just once, below.
1205 ;; ... run the hook for the whole buffer, and only after markers
1206 ;; have been reinserted (else omitting in dired-x would omit marked files)
1214 ;; outside of the let scope
1215 ;;; Might as well not override the user if the user changed this.
1216 ;;; (setq buffer-read-only t)
1217 )
1219 ;; Subroutines of dired-revert
1220 ;; Some of these are also used when inserting subdirs.
1223 "Return current positions in the buffer and all windows with this directory.
1224 The positions have the form (BUFFER-POSITION WINDOW-POSITIONS).
1226 BUFFER-POSITION is the point position in the current dired buffer.
1227 It has the form (BUFFER DIRED-FILENAME BUFFER-POINT).
1229 WINDOW-POSITIONS are current positions in all windows displaying
1230 this dired buffer. The window positions have the form (WINDOW
1231 DIRED-FILENAME WINDOW-POINT)."
1242 "Restore POSITIONS saved with `dired-save-positions'."
1250 ;; Ensure that window still displays the original buffer.
1259 "Return alist of files and their marks, from BEG to END."
1270 alist))
1273 "Mark all files remembered in ALIST.
1274 Each element of ALIST looks like (FILE . MARKERCHAR)."
1288 "Return a list of names of subdirs currently hidden."
1298 result))
1301 "Try to insert all subdirs that were displayed before.
1302 Do so according to the former subdir alist OLD-SUBDIR-ALIST."
1316 "Remove directory DIR from any directory cache."
1320 \f
1321 ;; dired mode key bindings and initialization
1324 ;; This looks ugly when substitute-command-keys uses C-d instead d:
1325 ;; (define-key dired-mode-map "\C-d" 'dired-flag-file-deletion)
1330 ;; Commands to mark or flag certain categories of files
1334 ;; Upper case keys (except !) for operating on the marked files
1353 ;; Comparison commands
1356 ;; Tree Dired commands
1362 ;; move to marked files
1365 ;; Make all regexp commands share a `%' prefix:
1366 ;; We used to get to the submap via a symbol dired-regexp-prefix,
1367 ;; but that seems to serve little purpose, and copy-keymap
1368 ;; does a better job without it.
1381 ;; Commands for marking and unmarking.
1398 ;; Lower keys for commands not operating on all the marked files
1423 ;; moving
1430 ;; hiding
1433 ;; isearch
1438 ;; misc
1444 ;; thumbnail manipulation (image-dired)
1457 ;; encryption and decryption (epa-dired)
1463 ;; Make menu bar items.
1465 ;; No need to fo this, now that top-level items are fewer.
1466 ;;;;
1467 ;; Get rid of the Edit menu bar item to save space.
1468 ;(define-key map [menu-bar edit] 'undefined)
1573 ;; When running on plain MS-DOS, there's only one
1574 ;; letter-case for file names.
1762 map)
1764 \f
1765 ;; Dired mode is suitable only for specially formatted data.
1768 ;; Autoload cookie needed by desktop.el
1769 ;;;###autoload
1771 "\
1774 \(optionally) its subdirectories, in the format of `ls -lR'.
1777 compress, load or byte-compile them, change their file attributes
1780 by file or all files matching certain criteria.
1782 Letters no longer insert themselves. Digits are prefix arguments.
1785 Most commands operate on the marked files and use the current file
1786 if no files are marked. Use a numeric prefix argument to operate on
1787 the next ARG (or previous -ARG if ARG<0) files, or just `1'
1788 to operate on the current file only. Prefix arguments override marks.
1790 to see why something went wrong.
1795 (or dired it in another buffer, if it is a directory).
1802 This retains all marks and hides subdirs again that were hidden before.
1803 SPC and DEL can be used to move down and up by lines.
1806 to read the
1808 to relist a single or the marked files or a
1810 again for the directory tree.
1813 for more info):
1815 `dired-listing-switches'
1816 `dired-trivial-filenames'
1817 `dired-shrink-to-fit'
1818 `dired-marker-char'
1819 `dired-del-marker'
1820 `dired-keep-marker-rename'
1821 `dired-keep-marker-copy'
1822 `dired-keep-marker-hardlink'
1823 `dired-keep-marker-symlink'
1827 `dired-before-readin-hook'
1828 `dired-after-readin-hook'
1829 `dired-mode-hook'
1830 `dired-load-hook'
1832 Keybindings:
1834 ;; Not to be called interactively (e.g. dired-directory will be set
1835 ;; to default-directory, which is wrong with wildcards).
1840 mode-name "Dired"
1841 ;; case-fold-search nil
1842 buffer-read-only t
1843 selective-display t ; for subdirectory hiding
1844 mode-line-buffer-identification
1854 ;; list-buffers uses this to display the dir being edited in this buffer.
1858 dired-directory)))
1874 \f
1875 ;; Idiosyncratic dired commands that don't deal with marks.
1878 "Summarize basic Dired commands and show recent dired errors."
1881 ;>> this should check the key-bindings and use substitute-command-keys if non-standard
1886 "Undo in a dired buffer.
1887 This doesn't recover lost files, it just undoes changes in the buffer itself.
1888 You can use it to recover marks, killed lines or subdirs."
1897 "Edit dired buffer with Wdired, or set it read-only.
1898 Call `wdired-change-to-wdired-mode' in dired buffers whose editing is
1899 supported by Wdired (the major mode of the dired buffer is `dired-mode').
1900 Otherwise, for buffers inheriting from dired-mode, call `toggle-read-only'."
1907 "Move down lines then position at filename.
1908 Optional prefix ARG says how many lines to move; default is one line."
1914 "Move up lines then position at filename.
1915 Optional prefix ARG says how many lines to move; default is one line."
1921 "Goto ARG'th next directory file line."
1933 "Goto ARG'th previous directory file line."
1938 "Run Dired on parent directory of current directory.
1939 Find the parent directory either in this buffer or another buffer.
1940 Creates a buffer if necessary."
1945 ;; Only try dired-goto-subdir if buffer has more than one dir.
1955 "Get the current line's file name, with an error if file does not exist."
1957 ;; We pass t for second arg so that we don't get error for `.' and `..'.
1959 file-name)
1964 file-name
1969 ;; Force C-m keybinding rather than `f' or `e' in the mode doc:
1972 "In Dired, visit the file or directory named on this line."
1974 ;; Bind `find-file-run-dired' so that the command works on directories
1975 ;; too, independent of the user's setting.
1980 "In Dired, visit this file or directory instead of the dired buffer."
1984 ;; Don't override the setting from .emacs.
1985 ;;;###autoload (put 'dired-find-alternate-file 'disabled t)
1988 "In Dired, visit the file or directory name you click on."
2009 "In Dired, examine a file in view mode, returning to Dired when done.
2010 When file is a directory, show it in this buffer if it is inserted.
2011 Otherwise, display it in another buffer."
2021 "In Dired, visit this file or directory in another window."
2026 "In Dired, display this file or directory in another window."
2029 \f
2030 ;;; Functions for extracting and manipulating file names in Dired buffers.
2033 "In Dired, return name of file mentioned on this line.
2034 Value returned normally includes the directory name.
2035 Optional arg LOCALP with value `no-dir' means don't include directory
2036 name in result. A value of `verbatim' means to return the name exactly as
2037 it occurs in the buffer, and a value of t means construct name relative to
2038 `default-directory', which still may contain slashes if in a subdirectory.
2039 Optional arg NO-ERROR-IF-NOT-FILEP means treat `.' and `..' as
2040 regular filenames and return nil if no filename on this line.
2041 Otherwise, an error occurs in these cases."
2046 ;; nil if no file on this line, but no-error-if-not-filep is t:
2049 ;; Get rid of the mouse-face property that file names have.
2051 ;; Unquote names quoted by ls or by dired-insert-directory.
2052 ;; This code was written using `read' to unquote, because
2053 ;; it's faster than substituting \007 (4 chars) -> ^G (1
2054 ;; char) etc. in a lisp loop. Unfortunately, this decision
2055 ;; has necessitated hacks such as dealing with filenames
2056 ;; with quotation marks in their names.
2068 ;; The above `read' will return a unibyte string if FILE
2069 ;; contains eight-bit-control/graphic characters.
2074 ;; A relative file name can start with ~.
2075 ;; Don't treat it as absolute in this context.
2080 nil)
2082 file)
2090 ;; check for safe-magic property so that we won't
2091 ;; put /: for names that don't really need them.
2092 ;; For instance, .gz files when auto-compression-mode is on.
2095 file)))
2097 file)
2101 ;; check for safe-magic property so that we won't
2102 ;; put /: for names that don't really need them.
2103 ;; For instance, .gz files when auto-compression-mode is on.
2106 file)))
2112 "Replace first match of REGEXP in STRING with NEWTEXT.
2113 If it does not match, nil is returned instead of the new string.
2114 Optional arg LITERAL means to take NEWTEXT literally.
2115 Optional arg GLOBAL means to replace all matches."
2122 ret)
2124 nil
2128 ;;"Convert FILE (a file name relative to DIR) to an absolute file name."
2129 ;; We can't always use expand-file-name as this would get rid of `.'
2130 ;; or expand in / instead default-directory if DIR=="".
2131 ;; This should be good enough for ange-ftp.
2132 ;; It should be reasonably fast, though, as it is called in
2133 ;; dired-get-filename.
2137 "Convert FILE (an absolute file name) to a name relative to DIR.
2138 If this is impossible, return FILE unchanged.
2139 DIR must be a directory name, not a file name."
2141 ;; This case comes into play if default-directory is set to
2142 ;; use ~.
2147 ;;; (or no-error
2148 ;;; (error "%s: not in directory tree growing at %s" file dir))
2149 file))
2150 \f
2151 ;;; Functions for finding the file name in a dired buffer line.
2157 ;; Move to first char of filename on this line.
2158 ;; Returns position (point) or nil if no filename on this line."
2160 "Move to the beginning of the filename on the current line.
2161 Return the position of the beginning of the filename, or nil if none found."
2162 ;; This is the UNIX version.
2165 ;; First try assuming `ls --dired' was used.
2173 ;; Ha! There *is* a file. Our regexp-from-hell just failed to find it.
2177 nil)
2182 ;; Assumes point is at beginning of filename,
2183 ;; thus the rwx bit re-search-backward below will succeed in *this*
2184 ;; line if at all. So, it should be called only after
2185 ;; (dired-move-to-filename t).
2186 ;; On failure, signals an error (with non-nil NO-ERROR just returns nil).
2187 ;; This is the UNIX version.
2191 ;; case-fold-search is nil now, so we can test for capital F:
2198 nil
2200 ;; Restrict perm bits to be non-blank,
2201 ;; otherwise this matches one char to early (looking backward):
2202 ;; "l---------" (some systems make symlinks that way)
2203 ;; "----------" (plain file with zero perms)
2205 dired-permission-flags-regexp nil t)
2208 ;; Only with -F we need to know whether it's an executable
2210 used-F
2218 ;; Move point to end of name:
2224 dired-ls-F-marks-symlinks
2228 ;; ls -lF marks dirs, sockets, fifos and executables with exactly
2229 ;; one trailing character. (Executable bits on symlinks ain't mean
2230 ;; a thing, even to ls, but we know it's not a symlink.)
2233 executable)
2242 nil
2245 \f
2246 ;;; COPY NAMES OF MARKED FILES INTO KILL-RING.
2249 "Copy names of marked (or next ARG) files into the kill ring.
2250 The names are separated by a space.
2251 With a zero prefix arg, use the absolute file name of each marked file.
2253 `default-directory'. (This still may contain slashes if in a subdirectory.)
2255 If on a subdir headerline, use absolute subdirname instead;
2256 prefix arg and marked files are ignored in this case.
2278 \f
2279 ;; Keeping Dired buffers in sync with the filesystem and with each other
2282 ;; Return a list of buffers for DIR (top level or in-situ subdir).
2283 ;; If FILE is non-nil, include only those whose wildcard pattern (if any)
2284 ;; matches FILE.
2285 ;; The list is in reverse order of buffer creation, most recent last.
2286 ;; As a side effect, killed dired buffers for DIR are removed from
2287 ;; dired-buffers.
2294 ;; Buffer is killed - clean up:
2302 dired-directory)))
2305 file)))
2309 result))
2312 "Convert glob-pattern PATTERN to a regular expression."
2314 regexp)
2326 ;; Fails to handle ^ yet ????
2340 regexp
2348 ;;"Advertise in variable `dired-buffers' that we dired `default-directory'."
2349 ;; With wildcards we actually advertise too much.
2352 t ; we have already advertised ourselves
2355 dired-buffers)))))
2358 ;; Remove DIR from the buffer alist in variable dired-buffers.
2359 ;; This has the effect of removing any buffer whose main directory is DIR.
2360 ;; It does not affect buffers in which DIR is a subdir.
2361 ;; Removing is also done as a side-effect in dired-buffer-for-dir.
2364 \f
2365 ;; Tree Dired
2367 ;;; utility functions
2370 ;;"Is FILE part of the directory tree starting at DIR?"
2375 ;; Prepend default-directory to DIR if relative file name.
2376 ;; dired-get-filename must be able to make a valid file name from a
2377 ;; file and its directory DIR.
2380 dir
2384 ;;"Return the subdir name on this line, or nil if not on a headerline."
2385 ;; Look up in the alist whether this is a headerline.
2391 dired-subdir-alist))))
2392 cur-dir))))
2394 ;(defun dired-get-subdir-min (elt)
2395 ; (cdr elt))
2396 ;; can't use macro, must be redefinable for other alist format in dired-nstd.
2410 ;; Return an index into alist for use with nth
2411 ;; for the sake of subdir moving commands.
2420 "Go to next subdirectory, regardless of level."
2421 ;; Use 0 arg to go to this directory's header line.
2422 ;; NO-SKIP prevents moving to end of header line, returning whatever
2423 ;; position was found in dired-subdir-alist.
2426 pos index)
2427 ;; nth with negative arg does not return nil but the first element
2437 nil ; return nil if not found
2441 "Build `dired-subdir-alist' by parsing the buffer.
2442 Returns the new value of the alist.
2443 If optional arg SWITCHES is non-nil, use its value
2444 instead of `dired-actual-switches'."
2452 new-dir-name
2454 ;; Used to expand subdirectory names correctly in recursive
2455 ;; ange-ftp listings.
2462 ;; Avoid taking a file name ending in a colon
2463 ;; as a subdir name.
2473 new-dir-name
2485 ;; Place a sub directory boundary between lines.
2492 ;; We don't need to sort it because it is in buffer order per
2493 ;; constructionem. Return new alist:
2494 dired-subdir-alist))
2497 ;; Add new DIR at NEW-MARKER. Don't sort.
2500 dired-subdir-alist)))
2503 ;; Position point on first nontrivial file after point.
2519 "Go to line describing file FILE in this dired buffer."
2520 ;; Return value of point on success, else nil.
2521 ;; FILE must be an absolute file name.
2522 ;; Loses if FILE contains control chars like "\007" for which ls
2523 ;; either inserts "?" or "\\007" into the buffer, so we won't find
2524 ;; it in the buffer.
2536 ;; The hair here is to get the result of dired-goto-subdir
2537 ;; without really calling it if we don't have any subdirs.
2543 search-string
2550 ;; filenames are preceded by SPC, this makes
2551 ;; the search faster (e.g. for the filename "-"!).
2554 ;; Match could have BASE just as initial substring or
2555 ;; or in permission bits or date or
2556 ;; not be a proper filename at all:
2558 ;; Must move to filename since an (actually
2559 ;; correct) match could have been elsewhere on the
2560 ;; ;; line (e.g. "-" would match somewhere in the
2561 ;; permission bits).
2563 ;; If this isn't the right line, move forward to avoid
2564 ;; trying this line again.
2567 ;; return value of point (i.e., FOUND):
2572 ;; FIXME document whatever dired-x is doing.
2574 "Where point should go in a new listing of DIRNAME.
2575 Point assumed at beginning of new subdir line."
2580 \f
2581 ;; These are hooks which make tree dired work.
2582 ;; They are in this file because other parts of dired need to call them.
2583 ;; But they don't call the rest of tree dired unless there are subdirs loaded.
2585 ;; This function is called for each retrieved filename.
2586 ;; It could stand to be faster, though it's mostly function call
2587 ;; overhead. Avoiding the function call seems to save about 10% in
2588 ;; dired-get-filename. Make it a defsubst?
2590 "Return the name of the subdirectory to which this line belongs.
2591 This returns a string with trailing slash, like `default-directory'.
2592 Optional argument means return a file name relative to `default-directory'."
2595 ;; probably because called in a non-dired buffer
2597 elt dir)
2601 ;; use `<=' (not `<') as subdir line is part of subdir
2603 nil ; found
2607 dir)))
2609 ;; Subdirs start at the beginning of their header lines and end just
2610 ;; before the beginning of the next header line (or end of buffer).
2617 \f
2618 ;; Deleting files
2621 "Decide whether recursive deletes are allowed.
2622 A value of nil means no recursive deletes.
2623 `always' means delete recursively without asking. This is DANGEROUS!
2624 `top' means ask for each directory at top level, but delete its subdirectories
2625 without asking.
2626 Anything else means ask for each directory."
2634 ;; Match anything but `.' and `..'.
2637 ;; Delete file, possibly delete a directory and all its files.
2638 ;; This function is usefull outside of dired. One could change it's name
2639 ;; to e.g. recursive-delete-file and put it somewhere else.
2641 Delete FILE or directory (possibly recursively if optional RECURSIVE is true.)
2642 RECURSIVE determines what to do with a non-empty directory. If RECURSIVE is:
2643 nil, do not delete.
2644 `always', delete recursively without asking.
2645 `top', ask for each directory at top level.
2646 Anything else, ask for each sub-directory."
2647 ;; This test is equivalent to
2648 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
2649 ;; but more efficient
2657 delete-by-moving-to-trash)
2658 "trash"
2666 "In Dired, delete the files flagged for deletion.
2667 If NOMESSAGE is non-nil, we don't display any message
2668 if there are no flagged files.
2669 `dired-recursive-deletes' controls whether deletion of
2670 non-empty directories is allowed."
2674 case-fold-search)
2678 ;; this can't move point since ARG is nil
2680 nil)
2681 nil t)
2686 "Delete all marked (or next ARG) files.
2687 `dired-recursive-deletes' controls whether deletion of
2688 non-empty directories is allowed."
2689 ;; This is more consistent with the file marking feature than
2690 ;; dired-do-flagged-delete.
2693 ;; this may move point if ARG is an integer
2695 arg)
2696 arg t))
2701 ;; L is an alist of files to delete, with their buffer positions.
2702 ;; ARG is the prefix arg.
2703 ;; Filenames are absolute.
2704 ;; (car L) *must* be the *last* (bottommost) file in the dired buffer.
2705 ;; That way as changes are made in the buffer they do not shift the
2706 ;; lines still to be changed, so the (point) values in L stay valid.
2707 ;; Also, for subdirs in natural order, a subdir's files are deleted
2708 ;; before the subdir itself - the other way around would not work.
2716 succ count)))
2717 ;; canonicalize file list for pop up
2732 ;; if we get here, removing worked
2748 failures))))
2753 ;; In all buffers dired'ing DIRECTORY, run FUN with ARGS.
2754 ;; If the buffer has a wildcard pattern, check that it matches FILE.
2755 ;; (FILE does not include a directory component.)
2756 ;; FILE may be nil, in which case ignore it.
2757 ;; Return list of buffers where FUN succeeded (i.e., returned non-nil).
2760 file))
2764 success-list))
2766 ;; Delete the entry for FILE from
2778 "Clean up after a deleted file or directory FN.
2779 Removes any expanded subdirectory of deleted directory.
2780 If `dired-x' is loaded and `dired-clean-up-buffers-too' is non-nil,
2781 also offers to kill buffers visiting deleted files and directories."
2785 ;; Offer to kill buffer of deleted file FN.
2801 \f
2802 ;; Confirmation
2811 "Return a string for use in a prompt, either the current file
2812 name, or the marker and a count of marked files."
2813 ;; distinguish-one-marked can cause the first element to be just t.
2818 ;; more than 1 file:
2820 ;; abs(arg) = count
2821 ;; Perhaps this is nicer, but it also takes more screen space:
2822 ;;(format "[%s %d files]" (if (> arg 0) "next" "previous")
2823 ;; count)
2828 "Pop up buffer BUF in a way suitable for Dired."
2833 ;; Try to split the selected window vertically if
2834 ;; that's possible. (Bug#1806)
2836 ;; Otherwise, try to split WINDOW sensibly.
2838 pop-up-frames)
2840 ;; If dired-shrink-to-fit is t, make its window fit its contents.
2842 ;; Try to not delete window when we want to display less than
2843 ;; `window-min-height' lines.
2847 "A list of symbols for commands Dired should not confirm, or t.
2848 Command symbols are `byte-compile', `chgrp', `chmod', `chown', `compress',
2849 `copy', `delete', `hardlink', `load', `move', `print', `shell', `symlink',
2850 `touch' and `uncompress'.
2851 If t, confirmation is never needed."
2862 "Return FUNCTION's result on ARGS after showing which files are marked.
2863 Displays the file names in a buffer named BUFNAME;
2865 This uses function `dired-pop-to-buffer' to do that.
2867 FUNCTION should not manipulate files, just read input
2868 (an argument or confirmation).
2869 The window is not shown if there is just one file or
2870 OP-SYMBOL is a member of the list in `dired-no-confirm'.
2871 FILES is the list of marked files. It can also be (t FILENAME)
2872 in the case of one marked file, to distinguish that from using
2873 just the current file."
2877 ;; If FILES defaulted to the current line's file.
2882 ;; Handle (t FILE) just like (FILE), here.
2883 ;; That value is used (only in some cases), to mean
2884 ;; just one file that was marked, rather than the current line file.
2896 \f
2897 ;; Commands to mark or flag file(s) at or near current line.
2900 ;; This version skips non-file lines.
2911 ;; Advance to the next line--actually, to the line that *was* next.
2912 ;; (If FUNCTION inserted some new lines in between, skip them.)
2924 ;; This used to be a regexp match of the `total ...' line output by
2925 ;; ls, which is slightly faster, but that is not very robust; notably,
2926 ;; it fails for non-english locales.
2930 "Move to the next marked file, wrapping around the end of the buffer."
2947 "Move to the previous marked file, wrapping around the end of the buffer."
2952 ;; Return FILE's marker, or nil if unmarked.
2966 ;; Skip subdir line and following garbage like the `total' line:
2977 "Mark the current (or next ARG) files.
2978 If on a subdir headerline, mark all its files except `.' and `..'.
2982 this subdir."
2992 "Unmark the current (or next ARG) files.
2993 If looking at a subdir, unmark all its files except `.' and `..'."
2999 "In Dired, flag the current line's file for deletion.
3000 With prefix arg, repeat over several lines.
3002 If on a subdir headerline, mark all its files except `.' and `..'."
3008 "In Dired, move up lines and remove deletion flag there.
3009 Optional prefix ARG says how many lines to unflag; default is one line."
3014 "Toggle marks: marked files become unmarked, and vice versa.
3015 Files marked with other flags (such as `D') are not affected.
3016 `.' and `..' are never toggled.
3017 As always, hidden subdirs are not affected."
3025 ;; use subst instead of insdel because it does not move
3026 ;; the gap and thus should be faster and because
3027 ;; other characters are left alone automatically
3034 \f
3035 ;;; Commands to mark or flag files based on their characteristics or names.
3044 "Mark all files matching REGEXP for use in later commands.
3045 A prefix argument means to unmark them instead.
3046 `.' and `..' are never marked.
3049 object files--just `.o' will mark more than you might think."
3063 "Mark all files with contents containing REGEXP for use in later commands.
3064 A prefix argument means to unmark them instead.
3065 `.' and `..' are never marked."
3079 ;; For now we do it inside emacs
3080 ;; Grep might be better if there are a lot of files
3090 )))
3094 "In Dired, flag all files containing the specified REGEXP for deletion.
3095 The match is against the non-directory part of the filename. Use `^'
3096 and `$' to anchor matches. Exclude subdirs by hiding them.
3097 `.' and `..' are never flagged."
3102 "Mark all symbolic links.
3103 With prefix argument, unflag all those files."
3109 "Mark all directory file lines except `.' and `..'.
3110 With prefix argument, unflag all those files."
3118 "Mark all executable files.
3119 With prefix argument, unflag all those files."
3124 ;; dired-x.el has a dired-mark-sexp interactive command: mark
3125 ;; files for which PREDICATE returns non-nil.
3128 "Flag for deletion files whose names suggest they are auto save files.
3129 A prefix argument says to unflag those files instead."
3133 ;; It is less than general to check for # here,
3134 ;; but it's the only way this runs fast enough.
3138 ;; Handle executables in case of -F option.
3139 ;; We need not worry about the other kinds
3140 ;; of markings that -F makes, since they won't
3141 ;; appear on real auto-save files.
3153 ;; `log' here is dubious, since it's typically used for useful log
3154 ;; files, not just TeX stuff. -- fx
3163 "Flag for deletion all files that match `dired-garbage-files-regexp'."
3168 "Flag all backup files (names ending with `~') for deletion.
3169 With prefix argument, unflag these files."
3173 ;; Don't call backup-file-name-p unless the last character looks like
3174 ;; it might be the end of a backup file name. This isn't very general,
3175 ;; but it's the only way this runs fast enough.
3177 ;; Handle executables in case of -F option.
3178 ;; We need not worry about the other kinds
3179 ;; of markings that -F makes, since they won't
3180 ;; appear on real backup files.
3190 "Change all OLD marks to NEW marks.
3191 OLD and NEW are both characters used to mark files."
3208 t)
3213 "Remove all marks from all files in the dired buffer."
3218 "Remove a specific mark (or any mark) from every file.
3219 After this command, type the mark character to remove,
3220 or type RET to remove all marks.
3221 With prefix arg, query for each marked file.
3229 Type SPC or `y' to unmark one file, DEL or `n' to skip to next,
3239 file))))
3245 count))))
3246 \f
3247 ;; Logging failures operating on files, and showing the results.
3252 "Pop up a buffer with error log output from Dired.
3253 A group of errors from a single command ends with a formfeed.
3269 ;; Log a message or the contents of a buffer.
3270 ;; If LOG is a string and there are more args, it is formatted with
3271 ;; those ARGS. Usually the LOG string ends with a \n.
3272 ;; End each bunch of errors with (dired-log t):
3273 ;; this inserts the current time and buffer at the start of the page,
3274 ;; and \f (formfeed) at the end.
3282 log)))
3295 "State a summary of a command's failures, in echo area and log buffer.
3296 STRING is an overall summary of the failures.
3297 FAILURES is a list of file names that we failed to operate on,
3298 or nil if file names are not applicable."
3308 string failures))
3309 ;; Log a summary describing a bunch of errors.
3312 \f
3313 ;;; Sorting
3315 ;; Most ls can only sort by name or by date (with -t), nothing else.
3316 ;; GNU ls sorts on size with -S, on extension with -X, and unsorted with -U.
3317 ;; So anything that does not contain these is sort "by name".
3322 This indicates to Dired which option switches to watch out for because they
3323 will change the sorting order behavior of `ls'.
3325 To change the default sorting order \(e.g. add a `-v' option\), see the
3326 variable `dired-listing-switches'. To temporarily override the listing
3331 ;; `dired-ls-sorting-switches' after -t overrides -t.
3343 "Non-nil means the Dired sort command is disabled.
3347 ;; Set modeline display according to dired-actual-switches.
3348 ;; Modeline display of "by name" or "by date" guarantees the user a
3349 ;; match with the corresponding regexps. Non-matching switches are
3350 ;; shown literally.
3355 dired-sort-by-name-regexp dired-actual-switches)
3358 dired-sort-by-date-regexp dired-actual-switches)
3365 "Toggle sorting by date, and refresh the Dired buffer.
3366 With a prefix argument, edit the current listing switches instead."
3376 ;; Toggle between sort by date/name. Reverts the buffer.
3378 dired-actual-switches))
3379 ;; Regexp for finding (possibly embedded) -t switches.
3381 case-fold-search)
3382 ;; Remove the -t switch.
3386 ;; Remove a stand-alone -t switch.
3389 ;; Remove a switch of the form -XtY for some X and Y.
3392 ;; Now, if we weren't sorting by date before, add the -t switch.
3398 ;; Some user code loads dired especially for this.
3399 ;; Don't do that--use replace-regexp-in-string instead.
3401 ;; Replace REGEXP with NEWTEXT everywhere in STRING and return result.
3402 ;; NEWTEXT is taken literally---no \\DIGIT escapes will be recognized.
3408 start me))
3412 "Specify new `ls' SWITCHES for current dired buffer.
3413 Values matching `dired-sort-by-date-regexp' or `dired-sort-by-name-regexp'
3414 set the minor mode accordingly, others appear literally in the mode line.
3415 With optional second arg NO-REVERT, don't refresh the listing afterwards."
3426 "Additional processing of -R in ls option string SWITCHES.
3427 Saves `dired-subdir-alist' when R is set and restores saved value
3428 minus any directories explicitly deleted when R is cleared.
3429 To be called first in body of `dired-sort-other', etc."
3433 ;; Adding -R to ls switches -- save `dired-subdir-alist':
3437 ;; Deleting -R from ls switches -- revert to pre-R subdirs
3438 ;; that are still present:
3444 dired-subdir-alist)
3445 ;; subdir still present...
3448 subdirs)))
3452 ;; No pre-R subdir alist, so revert to main directory
3453 ;; listing:
3455 \f
3457 ;;;; Drag and drop support
3460 "Decide whether recursive copies are allowed.
3461 A value of nil means no recursive copies.
3462 `always' means copy recursively without asking.
3463 `top' means ask for each directory at top level.
3464 Anything else means ask for each directory."
3479 ;; No need to get actions and descriptions from the source,
3480 ;; we only have three actions anyway.
3482 t
3488 "--"
3492 nil)))
3497 ;; Only used when (featurep 'dnd).
3502 "Copy, move or link a file to the dired directory.
3503 URI is the file to handle, ACTION is one of copy, move, link or ask.
3504 Ask means pop up a menu for the user to select one of copy, move or link."
3513 ;; If copying a directory and dired-recursive-copies is
3514 ;; nil, dired-copy-file fails. Pop up a notice.
3523 ;; Binding dired-overwrite-confirmed to nil makes
3524 ;; dired-handle-overwrite a no-op. We instead use
3525 ;; y-or-n-p, which pops a graphical menu.
3526 dired-overwrite-confirmed backup-file)
3528 ;; d-b-o is defined in dired-aux.
3530 dired-backup-overwrite
3546 action))))))
3549 "Copy, move or link a file to the dired directory if it is a local file.
3550 URI is the file to handle. If the hostname in the URI isn't local, do nothing.
3551 ACTION is one of copy, move, link or ask.
3552 Ask means pop up a menu for the user to select one of copy, move or link."
3555 nil)))
3556 \f
3558 ;;;; Desktop support
3563 "Auxiliary information to be saved in desktop file."
3565 ;; Value of `dired-directory'.
3567 ;; Directory name followed by list of files.
3570 ;; Directory name, optionally with shell wildcard.
3572 ;; Subdirectories in `dired-subdir-alist'.
3577 dired-subdir-alist)))))
3580 desktop-buffer-name
3581 desktop-buffer-misc)
3582 "Restore a dired buffer specified in a desktop file."
3583 ;; First element of `desktop-buffer-misc' is the value of `dired-directory'.
3584 ;; This value is a directory name, optionally with shell wildcard or
3585 ;; a directory name followed by list of files.
3591 ;; The following elements of `desktop-buffer-misc' are the keys
3592 ;; from `dired-subdir-alist'.
3597 nil)))
3602 \f
3603 ;;; Start of automatically extracted autoloads.
3604 \f
3605 ;;;### (autoloads (dired-show-file-type dired-do-query-replace-regexp
3606 ;;;;;; dired-do-search dired-do-isearch-regexp dired-do-isearch
3607 ;;;;;; dired-isearch-filenames-regexp dired-isearch-filenames dired-isearch-filenames-setup
3608 ;;;;;; dired-hide-all dired-hide-subdir dired-tree-down dired-tree-up
3609 ;;;;;; dired-kill-subdir dired-mark-subdir-files dired-goto-subdir
3610 ;;;;;; dired-prev-subdir dired-insert-subdir dired-maybe-insert-subdir
3611 ;;;;;; dired-downcase dired-upcase dired-do-symlink-regexp dired-do-hardlink-regexp
3612 ;;;;;; dired-do-copy-regexp dired-do-rename-regexp dired-do-rename
3613 ;;;;;; dired-do-hardlink dired-do-symlink dired-do-copy dired-create-directory
3614 ;;;;;; dired-rename-file dired-copy-file dired-relist-file dired-remove-file
3615 ;;;;;; dired-add-file dired-do-redisplay dired-do-load dired-do-byte-compile
3616 ;;;;;; dired-do-compress dired-query dired-compress-file dired-do-kill-lines
3617 ;;;;;; dired-run-shell-command dired-do-shell-command dired-do-async-shell-command
3618 ;;;;;; dired-clean-directory dired-do-print dired-do-touch dired-do-chown
3619 ;;;;;; dired-do-chgrp dired-do-chmod dired-compare-directories dired-backup-diff
3620 ;;;;;; dired-diff) "dired-aux" "dired-aux.el" "9d6333fab9c0f1b49e0bf2a536b8f245")
3621 ;;; Generated autoloads from dired-aux.el
3624 Compare file at point with file FILE using `diff'.
3625 FILE defaults to the file at the mark. (That's the mark set by
3627 The prompted-for file is the first file given to `diff'.
3628 With prefix arg, prompt for second argument SWITCHES,
3629 which is options for `diff'.
3634 Diff this file with its backup file or vice versa.
3635 Uses the latest backup, if there are several numerical backups.
3636 If this file is a backup, diff it with its original.
3637 The backup file is the first file given to `diff'.
3638 With prefix arg, prompt for argument SWITCHES which is options for `diff'.
3643 Mark files with different file attributes in two dired buffers.
3644 Compare file attributes of files in the current directory
3645 with file attributes in directory DIR2 using PREDICATE on pairs of files
3646 with the same name. Mark files for which PREDICATE returns non-nil.
3647 Mark files with different names if PREDICATE is nil (or interactively
3648 with empty input at the predicate prompt).
3650 PREDICATE is a Lisp expression that can refer to the following variables:
3652 size1, size2 - file size in bytes
3653 mtime1, mtime2 - last modification time in seconds, as a float
3654 fa1, fa2 - list of file attributes
3655 returned by function `file-attributes'
3657 where 1 refers to attribute of file in the current dired buffer
3658 and 2 to attribute of file in second dired buffer.
3660 Examples of PREDICATE:
3662 (> mtime1 mtime2) - mark newer files
3663 (not (= size1 size2)) - mark files with different sizes
3664 (not (string= (nth 8 fa1) (nth 8 fa2))) - mark files with different modes
3665 (not (and (= (nth 2 fa1) (nth 2 fa2)) - mark files with different UID
3666 (= (nth 3 fa1) (nth 3 fa2)))) and GID.
3671 Change the mode of the marked (or next ARG) files.
3672 Symbolic modes like `g+w' are allowed.
3677 Change the group of the marked (or next ARG) files.
3682 Change the owner of the marked (or next ARG) files.
3687 Change the timestamp of the marked (or next ARG) files.
3688 This calls touch.
3693 Print the marked (or next ARG) files.
3694 Uses the shell command coming from variables `lpr-command' and
3695 `lpr-switches' as default.
3700 Flag numerical backups for deletion.
3701 Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
3702 Positive prefix arg KEEP overrides `dired-kept-versions';
3703 Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
3706 with a prefix argument.
3711 Run a shell command COMMAND on the marked files asynchronously.
3713 Like `dired-do-shell-command' but if COMMAND doesn't end in ampersand,
3714 adds `* &' surrounded by whitespace and executes the command asynchronously.
3715 The output appears in the buffer `*Async Shell Command*'.
3720 Run a shell command COMMAND on the marked files.
3721 If no files are marked or a specific numeric prefix arg is given,
3723 The prompt mentions the file(s) or the marker, as appropriate.
3725 If there is a `*' in COMMAND, surrounded by whitespace, this runs
3726 COMMAND just once with the entire file list substituted there.
3728 If there is no `*', but there is a `?' in COMMAND, surrounded by
3729 whitespace, this runs COMMAND on each file individually with the
3730 file name substituted for `?'.
3732 Otherwise, this runs COMMAND on each file individually with the
3733 file name added at the end of COMMAND (separated by a space).
3735 `*' and `?' when not surrounded by whitespace have no special
3736 significance for `dired-do-shell-command', and are passed through
3737 normally to the shell, but you must confirm first. To pass `*' by
3740 If COMMAND produces output, it goes to a separate buffer.
3742 This feature does not try to redisplay Dired buffers afterward, as
3743 there's no telling what files COMMAND may have changed.
3746 When COMMAND runs, its working directory is the top-level directory
3747 of the Dired buffer, so output files usually are created there
3748 instead of in a subdir.
3750 In a noninteractive call (from Lisp code), you must specify
3751 the list of file names explicitly with the FILE-LIST argument, which
3752 can be produced by `dired-get-marked-files', for example.
3757 Not documented
3762 Kill all marked lines (not the files).
3763 With a prefix argument, kill that many lines starting with the current line.
3764 \(A negative argument kills backward.)
3765 If you use this command with a prefix argument to kill the line
3766 for a file that is a directory, which you have inserted in the
3767 Dired buffer as a subdirectory, then it deletes that subdirectory
3768 from the buffer as well.
3769 To kill an entire subdirectory (without killing its line in the
3770 parent directory), go to its directory header line and use this
3771 command with a prefix argument (the value does not matter).
3776 Not documented
3781 Format PROMPT with ARGS, query user, and store the result in SYM.
3782 The return value is either nil or t.
3784 The user may type y or SPC to accept once; n or DEL to skip once;
3785 ! to accept this and subsequent queries; or q or ESC to decline
3786 this and subsequent queries.
3788 If SYM is already bound to a non-nil value, this function may
3789 return automatically without querying the user. If SYM is !,
3790 return t; if SYM is q or ESC, return nil.
3795 Compress or uncompress marked (or next ARG) files.
3800 Byte compile marked (or next ARG) Emacs Lisp files.
3805 Load the marked (or next ARG) Emacs Lisp files.
3810 Redisplay all marked (or next ARG) files.
3811 If on a subdir line, redisplay that subdirectory. In that case,
3812 a prefix arg lets you edit the `ls' switches used for the new listing.
3814 Dired remembers switches specified with a prefix arg, so that reverting
3815 the buffer will not reset them. However, using `dired-undo' to re-insert
3816 or delete subdirectories can bypass this machinery. Hence, you sometimes
3817 may have to reset some subdirectory switches after a `dired-undo'.
3818 You can reset all subdirectory switches to the default using
3820 See Info node `(emacs)Subdir switches' for more details.
3825 Not documented
3830 Not documented
3835 Create or update the line for FILE in all Dired buffers it would belong in.
3840 Not documented
3845 Not documented
3850 Create a directory called DIRECTORY.
3855 Copy all marked (or next ARG) files, or copy the current file.
3856 This normally preserves the last-modified date when copying.
3857 When operating on just the current file, you specify the new name.
3858 When operating on multiple or marked files, you specify a directory,
3859 and new copies of these files are made in that directory
3860 with the same names that the files currently have. The default
3861 suggested for the target directory depends on the value of
3862 `dired-dwim-target', which see.
3864 This command copies symbolic links by creating new ones,
3865 like `cp -d'.
3870 Make symbolic links to current file or all marked (or next ARG) files.
3871 When operating on just the current file, you specify the new name.
3872 When operating on multiple or marked files, you specify a directory
3873 and new symbolic links are made in that directory
3874 with the same names that the files currently have. The default
3875 suggested for the target directory depends on the value of
3876 `dired-dwim-target', which see.
3883 Add names (hard links) current file or all marked (or next ARG) files.
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 hard links 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.
3894 Rename current file or all marked (or next ARG) files.
3895 When renaming just the current file, you specify the new name.
3896 When renaming multiple or marked files, you specify a directory.
3897 This command also renames any buffers that are visiting the files.
3898 The default suggested for the target directory depends on the value
3899 of `dired-dwim-target', which see.
3904 Rename selected files whose names match REGEXP to NEWNAME.
3906 With non-zero prefix argument ARG, the command operates on the next ARG
3907 files. Otherwise, it operates on all the marked files, or the current
3908 file if none are marked.
3910 As each match is found, the user must type a character saying
3913 REGEXP defaults to the last regexp used.
3915 With a zero prefix arg, renaming by regexp affects the absolute file name.
3916 Normally, only the non-directory part of the file name is used and changed.
3921 Copy selected files whose names match REGEXP to NEWNAME.
3922 See function `dired-do-rename-regexp' for more info.
3927 Hardlink selected files whose names match REGEXP to NEWNAME.
3928 See function `dired-do-rename-regexp' for more info.
3933 Symlink selected files whose names match REGEXP to NEWNAME.
3934 See function `dired-do-rename-regexp' for more info.
3939 Rename all marked (or next ARG) files to upper case.
3944 Rename all marked (or next ARG) files to lower case.
3949 Insert this subdirectory into the same dired buffer.
3951 else inserts it at its natural place (as `ls -lR' would have done).
3952 With a prefix arg, you may edit the ls switches used for this listing.
3953 You can add `R' to the switches to expand the whole tree starting at
3954 this subdirectory.
3955 This function takes some pains to conform to `ls -lR' output.
3957 Dired remembers switches specified with a prefix arg, so that reverting
3958 the buffer will not reset them. However, using `dired-undo' to re-insert
3959 or delete subdirectories can bypass this machinery. Hence, you sometimes
3960 may have to reset some subdirectory switches after a `dired-undo'.
3961 You can reset all subdirectory switches to the default using
3963 See Info node `(emacs)Subdir switches' for more details.
3968 Insert this subdirectory into the same dired buffer.
3969 If it is already present, overwrites previous entry,
3970 else inserts it at its natural place (as `ls -lR' would have done).
3971 With a prefix arg, you may edit the `ls' switches used for this listing.
3972 You can add `R' to the switches to expand the whole tree starting at
3973 this subdirectory.
3974 This function takes some pains to conform to `ls -lR' output.
3979 Go to previous subdirectory, regardless of level.
3980 When called interactively and not on a subdir line, go to this subdir's line.
3985 Go to end of header line of DIR in this dired buffer.
3986 Return value of point on success, otherwise return nil.
3992 Mark all files except `.' and `..' in current subdirectory.
3993 If the Dired buffer shows multiple directories, this command
3994 marks the files listed in the subdirectory that point is in.
3999 Remove all lines of current subdirectory.
4000 Lower levels are unaffected.
4005 Go up ARG levels in the dired tree.
4010 Go down in the dired tree.
4015 Hide or unhide the current subdirectory and move to next directory.
4016 Optional prefix arg is a repeat factor.
4022 Hide all subdirectories, leaving only their header lines.
4023 If there is already something hidden, make everything visible again.
4029 Set up isearch to search in Dired file names.
4030 Intended to be added to `isearch-mode-hook'.
4035 Search for a string using Isearch only in file names in the Dired buffer.
4040 Search for a regexp using Isearch only in file names in the Dired buffer.
4045 Search for a string through all marked files using Isearch.
4050 Search for a regexp through all marked files using Isearch.
4055 Search through all marked files for a match for REGEXP.
4056 Stops when a match is found.
4062 Do `query-replace-regexp' of FROM with TO, on all marked files.
4063 Third arg DELIMITED (prefix arg) means replace only word-delimited matches.
4070 Print the type of FILE, according to the `file' command.
4071 If FILE is a symbolic link and the optional argument DEREF-SYMLINKS is
4072 true then the type of the file linked to by FILE is printed instead.
4076 ;;;***
4077 \f
4078 ;;;### (autoloads (dired-do-relsymlink dired-jump) "dired-x" "dired-x.el"
4079 ;;;;;; "c24f202ea049990539accfd4c2c73fe9")
4080 ;;; Generated autoloads from dired-x.el
4083 Jump to dired buffer corresponding to current buffer.
4084 If in a file, dired the current directory and move to file's line.
4085 If in Dired already, pop up a level and goto old directory's line.
4086 In case the proper dired file line cannot be found, refresh the dired
4087 buffer and try again.
4088 When OTHER-WINDOW is non-nil, jump to dired buffer in other window.
4089 Interactively with prefix argument, read FILE-NAME and
4090 move to its line in dired.
4095 Relative symlink all marked (or next ARG) files into a directory.
4096 Otherwise make a relative symbolic link to the current file.
4097 This creates relative symbolic links like
4099 foo -> ../bar/foo
4101 not absolute ones like
4103 foo -> /ugly/file/name/that/may/change/any/day/bar/foo
4109 ;;;***
4110 \f
4111 ;;; End of automatically extracted autoloads.
4117 ;;; dired.el ends here