| blob | 1f38b5bfb749393f6a77f3999a9ef6ae3846779c |
1 ;;; dired.el --- directory-browsing commands
3 ;; Copyright (C) 1985, 1986, 1992, 1993, 1994, 1995, 1996, 1997, 2000,
4 ;; 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
5 ;; Free Software Foundation, Inc.
7 ;; Author: Sebastian Kremer <sk@thp.uni-koeln.de>
8 ;; Maintainer: FSF
9 ;; Keywords: files
10 ;; Package: emacs
12 ;; This file is part of GNU Emacs.
14 ;; GNU Emacs is free software: you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published by
16 ;; the Free Software Foundation, either version 3 of the License, or
17 ;; (at your option) any later version.
19 ;; GNU Emacs is distributed in the hope that it will be useful,
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ;; GNU General Public License for more details.
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
27 ;;; Commentary:
29 ;; This is a major mode for directory browsing and editing.
30 ;; It is documented in the Emacs manual.
32 ;; Rewritten in 1990/1991 to add tree features, file marking and
33 ;; sorting by Sebastian Kremer <sk@thp.uni-koeln.de>.
34 ;; Finished up by rms in 1992.
36 ;;; Code:
40 ;;; Customizable variables
43 "Directory editing."
48 "Handling marks in Dired."
53 ;;;###autoload
55 "Switches passed to `ls' for Dired. MUST contain the `l' option.
56 May contain all other options that don't contradict `-l';
57 may contain even `F', `b', `i' and `s'. See also the variable
58 `dired-ls-F-marks-symlinks' concerning the `F' switch.
59 On systems such as MS-DOS and MS-Windows, which use `ls' emulation in Lisp,
60 some of the `ls' switches are not supported; see the doc string of
61 `insert-directory' in `ls-lisp.el' for more details."
66 "If non-nil, switches passed to `ls' for inserting subdirectories.
67 If nil, `dired-listing-switches' is used."
77 "Name of chown command (usually `chown')."
83 The special value of `unspecified' means to check explicitly, and
84 save the result in this variable. This is performed the first
85 time `dired-insert-directory' is called."
92 "Name of chmod command (usually `chmod')."
97 "Name of touch command (usually `touch')."
102 "Informs Dired about how `ls -lF' marks symbolic links.
103 Set this to t if `ls' (or whatever program is specified by
104 `insert-directory-program') with `-lF' marks the symbolic link
105 itself with a trailing @ (usually the case under Ultrix).
107 Example: if `ln -s foo bar; ls -F bar' gives `bar -> foo', set it to
108 nil (the default), if it gives `bar@ -> foo', set it to t.
110 Dired checks if there is really a @ appended. Thus, if you have a
111 marking `ls' program on one host and a non-marking on another host, and
112 don't care about symbolic links which really end in a @, you can
113 always set this variable to t."
118 "Regexp of files to skip when finding first file of a directory.
119 A value of nil means move to the subdir line.
120 A value of t means move to first file."
123 regexp)
127 ;; Use t as default so that moved files "take their markers with them".
128 "Controls marking of renamed files.
129 If t, files keep their previous marks when they are renamed.
130 If a character, renamed files (whether previously marked or not)
131 are afterward marked with that character."
137 "Controls marking of copied files.
138 If t, copied files are marked if and as the corresponding original files were.
139 If a character, copied files are unconditionally marked with that character."
145 "Controls marking of newly made hard links.
146 If t, they are marked if and as the files linked to were marked.
147 If a character, new links are unconditionally marked with that character."
153 "Controls marking of newly made symbolic links.
154 If t, they are marked if and as the files linked to were marked.
155 If a character, new links are unconditionally marked with that character."
161 "If non-nil, Dired tries to guess a default target directory.
162 This means: if there is a dired buffer displayed in the next window,
163 use its current subdir, instead of the current subdir of this dired buffer.
165 The target is used in the prompt for file copy, rename etc."
170 "If non-nil, Dired preserves the last-modified time in a file copy.
171 \(This works on only some systems.)"
175 ; These variables were deleted and the replacements are on files.el.
176 ; We leave aliases behind for back-compatibility.
180 ;;; Hook variables
183 "Run after loading Dired.
184 You can customize key bindings or load extensions with this."
189 "Run at the very end of `dired-mode'."
194 "This hook is run before a dired buffer is read in (created or reverted)."
199 "Hook run after each time a file or directory is read by Dired.
200 After each listing of a file or directory, this hook is run
201 with the buffer narrowed to the listing."
204 ;; Note this can't simply be run inside function `dired-ls' as the hook
205 ;; functions probably depend on the dired-subdir-alist to be OK.
211 "The functions to call when a drop in `dired-mode' is made.
212 See `dnd-protocol-alist' for more information. When nil, behave
213 as in other buffers. Changing this option is effective only for
214 new dired buffers."
220 ;; Internal variables
223 ;; so that you can write things like
224 ;; (let ((dired-marker-char ?X))
225 ;; ;; great code using X markers ...
226 ;; )
227 ;; For example, commands operating on two sets of files, A and B.
228 ;; Or marking files with digits 0-9. This could implicate
229 ;; concentric sets or an order for the marked files.
230 ;; The code depends on dynamic scoping on the marker char.
231 "In Dired, the current mark character.
238 ;; I see no reason ever to make this nil -- rms.
239 ;; (> baud-rate search-slow-speed)
246 ;;;###autoload
248 "The directory name or wildcard spec that this dired directory lists.
249 Local to each dired buffer. May be a list, in which case the car is the
250 directory name and the cdr is the list of files to mention.
259 ;; These regexps must be tested at beginning-of-line, but are also
260 ;; used to search for next matches, so neither omitting "^" nor
261 ;; replacing "^" by "\n" (to make it slightly faster) will work.
264 ;; "Regexp matching a marked line.
265 ;; Important: the match ends just after the marker."
267 ;; The [^:] part after "d" and "l" is to avoid confusion with the
268 ;; DOS/Windows-style drive letters in directory names, like in "d:/foo".
276 "-[-r][-w].[-r][-w][xs][-r][-w]."
282 ;; The subdirectory names in the next two lists are expanded.
284 "Association list of subdirectories and their buffer positions.
285 Each subdirectory has an element: (DIRNAME . STARTMARKER).
286 The order of elements is the reverse of the order in the buffer.
290 "Keeps track of which switches to use for inserted subdirectories.
298 "Regexp matching a maybe hidden subdirectory line in `ls -lR' output.
299 Subexpression 1 is the subdirectory proper, no trailing colon.
300 The match starts at the beginning of the line and ends after the end
305 "Faces used by Dired."
311 "Face used for directory headers."
319 "Face used for dired marks."
327 "Face used for marked files."
335 "Face used for flagged files."
342 ;; Inherit from font-lock-warning-face since with min-colors 8
343 ;; font-lock-comment-face is not colored any more.
345 "Face used to highlight a part of a buffer that needs user attention."
353 ;; Inherit from font-lock-comment-delimiter-face since with min-colors 8
354 ;; font-lock-comment-face is not colored any more.
356 "Face used to highlight permissions of group- and world-writable files."
364 "Face used for subdirectories."
372 "Face used for symbolic links."
380 "Face used for files suffixed with `completion-ignored-extensions'."
388 ;;
389 ;; Dired marks.
391 ;;
392 ;; We make heavy use of MATCH-ANCHORED, since the regexps don't identify the
393 ;; file name itself. We search for Dired defined regexps, and then use the
394 ;; Dired defined function `dired-move-to-filename' before searching for the
395 ;; simple regexp ".+". It is that regexp which matches the file name.
396 ;;
397 ;; Marked files.
400 ;;
401 ;; Flagged files.
404 ;; People who are paranoid about security would consider this more
405 ;; important than other things such as whether it is a directory.
406 ;; But we don't want to encourage paranoia, so our default
407 ;; should be what's most useful for non-paranoids. -- rms.
408 ;;; ;;
409 ;;; ;; Files that are group or world writable.
410 ;;; (list (concat dired-re-maybe-mark dired-re-inode-size
411 ;;; "\\([-d]\\(....w....\\|.......w.\\)\\)")
412 ;;; '(1 dired-warning-face)
413 ;;; '(".+" (dired-move-to-filename) nil (0 dired-warning-face)))
414 ;; However, we don't need to highlight the file name, only the
415 ;; permissions, to win generally. -- fx.
416 ;; Fixme: we could also put text properties on the permission
417 ;; fields with keymaps to frob the permissions, somewhat a la XEmacs.
424 ;;
425 ;; Subdirectories.
428 ;;
429 ;; Symbolic links.
432 ;;
433 ;; Files suffixed with `completion-ignored-extensions'.
435 ;; It is quicker to first find just an extension, then go back to the
436 ;; start of that file name. So we do this complex MATCH-ANCHORED form.
439 ;;
440 ;; Files suffixed with `completion-ignored-extensions'
441 ;; plus a character put in by -F.
447 ;; If the last character is not part of the filename,
448 ;; move back to the start of the filename
449 ;; so it can be fontified.
450 ;; Otherwise, leave point at the end of the line;
451 ;; that way, nothing is fontified.
455 ;;
456 ;; Explicitly put the default face on file names ending in a colon to
457 ;; avoid fontifying them as directory header.
460 ;;
461 ;; Directory headers.
463 )
467 \f
468 ;;; Macros must be defined before they are used, for the byte compiler.
471 "Mark all files for which PREDICATE evals to non-nil.
472 PREDICATE is evaluated on each line, with point at beginning of line.
473 MSG is a noun phrase for the type of files being marked.
474 It should end with a noun that can be pluralized by adding `s'.
475 Return value is the number of files marked, or nil if none were marked."
489 count
490 ,msg
498 distinguish-one-marked)
499 "Eval BODY with point on each marked line. Return a list of BODY's results.
500 If no marked file could be found, execute BODY on the current line.
501 ARG, if non-nil, specifies the files to use instead of the marked files.
502 If ARG is an integer, use the next ARG (or previous -ARG, if
503 ARG<0) files. In that case, point is dragged along. This is
504 so that commands on the next ARG (instead of the marked) files
505 can be chained easily.
506 For any other non-nil value of ARG, use the current file.
507 If optional third arg SHOW-PROGRESS evaluates to non-nil,
508 redisplay the dired buffer after each file is processed.
509 No guarantee is made about the position on the marked line.
510 BODY must ensure this itself if it depends on this.
511 Search starts at the beginning of the buffer, thus the car of the list
512 corresponds to the line nearest to the buffer's bottom. This
513 is also true for (positive and negative) integer values of ARG.
514 BODY should not be too long as it is expanded four times.
516 If DISTINGUISH-ONE-MARKED is non-nil, then if we find just one marked file,
517 return (t FILENAME) instead of (FILENAME)."
518 ;;
519 ;;Warning: BODY must not add new lines before point - this may cause an
520 ;;endless loop.
521 ;;This warning should not apply any longer, sk 2-Sep-1991 14:10.
528 ,arg
534 results))
535 ;; non-nil, non-integer ARG means use current file:
540 ;; remember position of next marked file before BODY
541 ;; can insert lines before the just found file,
542 ;; confusing us by finding the same marked file again
543 ;; and again and...
551 ;; move after last match
560 results
562 ;; save-excursion loses, again
566 "Return the marked files' names as list of strings.
567 The list is in the same order as the buffer, that is, the car is the
568 first marked file.
569 Values returned are normally absolute file names.
570 Optional arg LOCALP as in `dired-get-filename'.
571 Optional second argument ARG, if non-nil, specifies files near
572 point instead of marked files. It usually comes from the prefix
573 argument.
574 If ARG is an integer, use the next ARG files.
575 Any other non-nil value means to use the current file instead.
576 Optional third argument FILTER, if non-nil, is a function to select
577 some of the files--those for which (funcall FILTER FILENAME) is non-nil.
579 If DISTINGUISH-ONE-MARKED is non-nil, then if we find just one marked file,
580 return (t FILENAME) instead of (FILENAME).
581 Don't use that together with FILTER."
586 arg nil distinguish-one-marked)))
587 result)
590 all-of-them
595 result)))
596 \f
597 ;; The dired command
600 ;; For use in interactive.
604 dired-listing-switches))
605 ;; If a dialog is about to be used, call read-directory-name so
606 ;; the dialog code knows we want directories. Some dialogs can
607 ;; only select directories or files when popped up, not both.
610 nil default-directory nil)
612 nil default-directory nil)))))
614 ;; We want to switch to a more sophisticated version of
615 ;; dired-read-dir-and-switches like the following, if there is a way
616 ;; to make it more intuitive. See bug#1285.
618 ;; (defun dired-read-dir-and-switches (str)
619 ;; ;; For use in interactive.
620 ;; (reverse
621 ;; (list
622 ;; (if current-prefix-arg
623 ;; (read-string "Dired listing switches: "
624 ;; dired-listing-switches))
625 ;; ;; If a dialog is about to be used, call read-directory-name so
626 ;; ;; the dialog code knows we want directories. Some dialogs can
627 ;; ;; only select directories or files when popped up, not both.
628 ;; (if (next-read-file-uses-dialog-p)
629 ;; (read-directory-name (format "Dired %s(directory): " str)
630 ;; nil default-directory nil)
631 ;; (let ((cie ()))
632 ;; (dolist (ext completion-ignored-extensions)
633 ;; (if (eq ?/ (aref ext (1- (length ext)))) (push ext cie)))
634 ;; (setq cie (concat (regexp-opt cie "\\(?:") "\\'"))
635 ;; (lexical-let* ((default (and buffer-file-name
636 ;; (abbreviate-file-name buffer-file-name)))
637 ;; (cie cie)
638 ;; (completion-table
639 ;; ;; We need a mix of read-file-name and
640 ;; ;; read-directory-name so that completion to directories
641 ;; ;; is preferred, but if the user wants to enter a global
642 ;; ;; pattern, he can still use completion on filenames to
643 ;; ;; help him write the pattern.
644 ;; ;; Essentially, we want to use
645 ;; ;; (completion-table-with-predicate
646 ;; ;; 'read-file-name-internal 'file-directory-p nil)
647 ;; ;; but that doesn't work because read-file-name-internal
648 ;; ;; does not obey its `predicate' argument.
649 ;; (completion-table-in-turn
650 ;; (lambda (str pred action)
651 ;; (let ((read-file-name-predicate
652 ;; (lambda (f)
653 ;; (and (not (member f '("./" "../")))
654 ;; ;; Hack! Faster than file-directory-p!
655 ;; (eq (aref f (1- (length f))) ?/)
656 ;; (not (string-match cie f))))))
657 ;; (complete-with-action
658 ;; action 'read-file-name-internal str nil)))
659 ;; 'read-file-name-internal)))
660 ;; (minibuffer-with-setup-hook
661 ;; (lambda ()
662 ;; (setq minibuffer-default default)
663 ;; (setq minibuffer-completion-table completion-table))
664 ;; (read-file-name (format "Dired %s(directory): " str)
665 ;; nil default-directory nil))))))))
668 "Try to get a file name at point in the current dired buffer.
669 This hook is inteneded to be put in `file-name-at-point-functions'."
676 ;;;###autoload (define-key ctl-x-map "d" 'dired)
677 ;;;###autoload
680 Optional second argument SWITCHES specifies the `ls' options used.
681 \(Interactively, use a prefix argument to be able to specify SWITCHES.)
682 Dired displays a list of files in DIRNAME (which may also have
683 shell wildcards appended to select certain files). If DIRNAME is a cons,
684 its first element is taken as the directory name and the rest as an explicit
685 list of files to make directory entries for.
687 You can move around in it with the usual commands.
692 If DIRNAME is already in a dired buffer, that buffer is used without refresh."
693 ;; Cannot use (interactive "D") because of wildcards.
697 ;;;###autoload (define-key ctl-x-4-map "d" 'dired-other-window)
698 ;;;###autoload
704 ;;;###autoload (define-key ctl-x-5-map "d" 'dired-other-frame)
705 ;;;###autoload
711 ;;;###autoload
713 "Like `dired' but returns the dired buffer as value, does not select it."
715 ;; This loses the distinction between "/foo/*/" and "/foo/*" that
716 ;; some shells make:
727 ;; If the argument was syntactically a directory name not a file name,
728 ;; or if it happens to name a file that is a directory,
729 ;; convert it syntactically to a directory name.
730 ;; The reason for checking initially-was-dirname
731 ;; and not just file-directory-p
732 ;; is that file-directory-p is slow over ftp.
740 ;; The following is an internal dired function. It returns non-nil if
741 ;; the directory visited by the current dired buffer has changed on
742 ;; disk. DIRNAME should be the directory name of that directory.
751 "Return non-nil if current dired buffer needs updating.
752 If NOCONFIRM is non-nil, then this function always returns nil
753 for a remote directory. This feature is used by Auto Revert Mode."
759 ;; Do not auto-revert when the dired buffer can be currently
760 ;; written by the user as in `wdired-mode'.
761 buffer-read-only
765 "Automatically revert dired buffer on revisiting.
766 If t, revisiting an existing dired buffer automatically reverts it.
767 If its value is a function, call this function with the directory
768 name as single argument and revert the buffer if it returns non-nil.
769 Otherwise, a message offering to revert the changed dired buffer
770 is displayed.
771 Note that this is not the same as `auto-revert-mode' that
772 periodically reverts at specified time intervals."
782 ;; If there is an existing dired buffer for DIRNAME, just leave
783 ;; buffer as it is (don't even call dired-revert).
784 ;; This saves time especially for deep trees or with ange-ftp.
785 ;; The user can type `g' easily, and it is more consistent with find-file.
786 ;; But if SWITCHES are given they are probably different from the
787 ;; buffer's old value, so call dired-sort-other, which does
788 ;; revert the buffer.
789 ;; A pity we can't possibly do "Directory has changed - refresh? "
790 ;; like find-file does.
791 ;; Optional argument MODE is passed to dired-find-buffer-nocreate,
792 ;; see there.
795 ;; Look for an existing buffer.
797 ;; Note that buffer already is in dired-mode, if found.
804 ;; file list may have changed
806 ;; this calls dired-revert
808 ;; Always revert regardless of whether it has changed or not.
811 ;; Revert when predicate function returns non-nil.
816 ;; If directory has changed on disk, offer to revert.
821 ;; Else a new buffer
823 ;; We can do this unconditionally
824 ;; because dired-noselect ensures that the name
825 ;; is passed in directory name syntax
826 ;; if it was the name of a directory at all.
831 ;; default-directory and dired-actual-switches are set now
832 ;; (buffer-local), so we can call dired-readin:
837 ;; dired-readin can fail if parent directories are inaccessible.
838 ;; Don't leave an empty buffer around in that case.
843 buffer))
846 ;; Enlarged by dired-advertise
847 ;; Queried by function dired-buffers-for-dir. When this detects a
848 ;; killed buffer, it is removed from this list.
852 ;; This differs from dired-buffers-for-dir in that it does not consider
853 ;; subdirs of default-directory and searches for the first match only.
854 ;; Also, the major mode must be MODE.
863 dired-directory ;; nil during find-alternate-file
868 dired-directory))))
870 blist nil)
872 found))
874 \f
875 ;; Read in a new dired buffer
878 "Read in a new dired buffer.
879 Differs from `dired-insert-subdir' in that it accepts
880 wildcards, erases the buffer, and builds the subdir-alist anew
881 \(including making it buffer-local and clearing it first)."
883 ;; default-directory and dired-actual-switches must be buffer-local
884 ;; and initialized by now.
886 ;; This makes readin much much faster.
887 ;; In particular, it prevents the font lock hook from running
888 ;; until the directory is all read in.
895 ;; This hook which may want to modify dired-actual-switches
896 ;; based on dired-directory, e.g. with ange-ftp to a SysV host
897 ;; where ls won't understand -Al switches.
905 ;; Don't make undo entries for readin.
911 ;; Must first make alist buffer local and set it to nil because
912 ;; dired-build-subdir-alist will call dired-clear-alist first
919 ;; No need to narrow since the whole buffer contains just
920 ;; dired-readin's output, nothing else. The hook can
921 ;; successfully use dired functions (e.g. dired-get-filename)
922 ;; as the subdir-alist has been built in dired-readin.
925 ;; Subroutines of dired-readin
928 ;; Insert listing for the specified dir (and maybe file list)
929 ;; already in dired-directory, assuming a clean buffer.
935 file-list nil))
939 ;; If we are reading a whole single directory...
944 ;; Else treat it as a wildcard spec
945 ;; unless we have an explicit list of files.
950 "Align the fields of a file to the ones of surrounding lines.
951 BEG..END is the line where the file info is located."
952 ;; Some versions of ls try to adjust the size of each field so as to just
953 ;; hold the largest element ("largest" in the current invocation, of
954 ;; course). So when a single line is output, the size of each field is
955 ;; just big enough for that one output. Thus when dired refreshes one
956 ;; line, the alignment if this line w.r.t the rest is messed up because
957 ;; the fields of that one line will generally be smaller.
958 ;;
959 ;; To work around this problem, we here add spaces to try and
960 ;; re-align the fields as needed. Since this is purely aesthetic,
961 ;; it is of utmost importance that it doesn't mess up anything like
962 ;; `dired-move-to-filename'. To this end, we limit ourselves to
963 ;; adding spaces only, and to only add them at places where there
964 ;; was already at least one space. This way, as long as
965 ;; `directory-listing-before-filename-regexp' always matches spaces
966 ;; with "*" or "+", we know we haven't made anything worse. There
967 ;; is one spot where the exact number of spaces is important, which
968 ;; is just before the actual filename, so we refrain from adding
969 ;; spaces there (and within the filename as well, of course).
972 ;; Check that there is indeed a file, and that there is anoter adjacent
973 ;; file with which to align, and that additional spaces are needed to
974 ;; align the filenames.
987 ;; Make sure there is some work left to do.
989 ;; If we've only looked at the line above, check to see if the line
990 ;; below exists as well and if so, align with the shorter one.
999 ;; Keep positions uptodate when we insert stuff.
1002 ;; Main loop.
1006 ;; Don't touch anything just before (and after) the
1007 ;; beginning of the filename.
1009 ;; We're now just in front of a field, with a space behind us.
1011 ;; Nums are right-aligned.
1013 ;; Let's look at the other line, in the same column: we
1014 ;; should be either near the end of the previous field, or
1015 ;; in the space between that field and the next.
1016 ;; [ Of course, it's also possible that we're already within
1017 ;; the next field or even past it, but that's unlikely since
1018 ;; other-col > file-col. ]
1019 ;; Let's find the distance to the alignment-point (either
1020 ;; the beginning or the end of the next field, depending on
1021 ;; whether this field is left or right aligned).
1031 ;; Now, the number of spaces to insert is align-pt-offset
1032 ;; minus the distance to the equivalent point on the
1033 ;; current line.
1036 align-pt-offset
1046 ;; Let's just make really sure we did not mess up.
1049 ;; Damn! We messed up: let's revert the change.
1051 ;; Now skip to next field.
1057 "Insert a directory listing of DIR, Dired style.
1058 Use SWITCHES to make the listings.
1059 If FILE-LIST is non-nil, list only those files.
1060 Otherwise, if WILDCARD is non-nil, expand wildcards;
1061 in that case, DIR should be a file name that uses wildcards.
1062 In other cases, DIR should be a directory name or a directory filename.
1063 If HDR is non-nil, insert a header line with the directory name."
1066 end)
1068 ;; Check whether "ls --dired" gives exit code 0, and
1069 ;; save the answer in `dired-use-ls-dired'.
1073 dired-use-ls-dired)
1076 ;; We used to specify the C locale here, to force English month names;
1077 ;; but this should not be necessary any more,
1078 ;; with the new value of `directory-listing-before-filename-regexp'.
1083 ;; Re-align fields, if necessary.
1086 ;; Quote certain characters, unless ls quoted them for us.
1095 nil t))
1101 nil t))
1104 ;; If we used --dired and it worked, the lines are already indented.
1105 ;; Otherwise, indent them.
1111 ;; Insert text at the beginning to standardize things.
1117 ;; Note that dired-build-subdir-alist will replace the name
1118 ;; by its expansion, so it does not matter whether what we insert
1119 ;; here is fully expanded, but it should be absolute.
1122 ;; Insert "wildcard" line where "total" line would be for a full dir.
1126 "Make the file names highlight when the mouse is on them."
1138 dired-filename t
1142 \f
1143 ;; Reverting a dired buffer
1146 "Reread the dired buffer.
1147 Must also be called after `dired-actual-switches' have changed.
1148 Should not fail even on completely garbaged buffers.
1149 Preserves old cursor, marks/flags, hidden-p.
1151 Dired sets `revert-buffer-function' to this function. The args
1152 ARG and NOCONFIRM, passed from `revert-buffer', are ignored."
1164 ;; treat top level dir extra (it may contain wildcards)
1171 ;; Run dired-after-readin-hook just once, below.
1176 ;; ... run the hook for the whole buffer, and only after markers
1177 ;; have been reinserted (else omitting in dired-x would omit marked files)
1185 ;; outside of the let scope
1186 ;;; Might as well not override the user if the user changed this.
1187 ;;; (setq buffer-read-only t)
1188 )
1190 ;; Subroutines of dired-revert
1191 ;; Some of these are also used when inserting subdirs.
1194 "Return current positions in the buffer and all windows with this directory.
1195 The positions have the form (BUFFER-POSITION WINDOW-POSITIONS).
1197 BUFFER-POSITION is the point position in the current dired buffer.
1198 It has the form (BUFFER DIRED-FILENAME BUFFER-POINT).
1200 WINDOW-POSITIONS are current positions in all windows displaying
1201 this dired buffer. The window positions have the form (WINDOW
1202 DIRED-FILENAME WINDOW-POINT)."
1213 "Restore POSITIONS saved with `dired-save-positions'."
1221 ;; Ensure that window still displays the original buffer.
1230 "Return alist of files and their marks, from BEG to END."
1241 alist))
1244 "Mark all files remembered in ALIST.
1245 Each element of ALIST looks like (FILE . MARKERCHAR)."
1259 "Return a list of names of subdirs currently hidden."
1269 result))
1272 "Try to insert all subdirs that were displayed before.
1273 Do so according to the former subdir alist OLD-SUBDIR-ALIST."
1287 "Remove directory DIR from any directory cache."
1291 \f
1292 ;; dired mode key bindings and initialization
1295 ;; This looks ugly when substitute-command-keys uses C-d instead d:
1296 ;; (define-key dired-mode-map "\C-d" 'dired-flag-file-deletion)
1301 ;; Commands to mark or flag certain categories of files
1305 ;; Upper case keys (except !) for operating on the marked files
1324 ;; Comparison commands
1327 ;; Tree Dired commands
1333 ;; move to marked files
1336 ;; Make all regexp commands share a `%' prefix:
1337 ;; We used to get to the submap via a symbol dired-regexp-prefix,
1338 ;; but that seems to serve little purpose, and copy-keymap
1339 ;; does a better job without it.
1352 ;; Commands for marking and unmarking.
1369 ;; Lower keys for commands not operating on all the marked files
1396 ;; moving
1403 ;; hiding
1406 ;; isearch
1411 ;; misc
1417 ;; thumbnail manipulation (image-dired)
1430 ;; encryption and decryption (epa-dired)
1436 ;; Make menu bar items.
1438 ;; No need to fo this, now that top-level items are fewer.
1439 ;;;;
1440 ;; Get rid of the Edit menu bar item to save space.
1441 ;(define-key map [menu-bar edit] 'undefined)
1546 ;; When running on plain MS-DOS, there's only one
1547 ;; letter-case for file names.
1735 map)
1737 \f
1738 ;; Dired mode is suitable only for specially formatted data.
1741 ;; Autoload cookie needed by desktop.el
1742 ;;;###autoload
1744 "\
1747 \(optionally) its subdirectories, in the format of `ls -lR'.
1750 compress, load or byte-compile them, change their file attributes
1753 by file or all files matching certain criteria.
1755 Letters no longer insert themselves. Digits are prefix arguments.
1758 Most commands operate on the marked files and use the current file
1759 if no files are marked. Use a numeric prefix argument to operate on
1760 the next ARG (or previous -ARG if ARG<0) files, or just `1'
1761 to operate on the current file only. Prefix arguments override marks.
1763 to see why something went wrong.
1768 (or dired it in another buffer, if it is a directory).
1775 This retains all marks and hides subdirs again that were hidden before.
1776 SPC and DEL can be used to move down and up by lines.
1779 to read the
1781 to relist a single or the marked files or a
1783 again for the directory tree.
1786 for more info):
1788 `dired-listing-switches'
1789 `dired-trivial-filenames'
1790 `dired-shrink-to-fit'
1791 `dired-marker-char'
1792 `dired-del-marker'
1793 `dired-keep-marker-rename'
1794 `dired-keep-marker-copy'
1795 `dired-keep-marker-hardlink'
1796 `dired-keep-marker-symlink'
1800 `dired-before-readin-hook'
1801 `dired-after-readin-hook'
1802 `dired-mode-hook'
1803 `dired-load-hook'
1805 Keybindings:
1807 ;; Not to be called interactively (e.g. dired-directory will be set
1808 ;; to default-directory, which is wrong with wildcards).
1813 mode-name "Dired"
1814 ;; case-fold-search nil
1815 buffer-read-only t
1816 selective-display t ; for subdirectory hiding
1817 mode-line-buffer-identification
1827 ;; list-buffers uses this to display the dir being edited in this buffer.
1831 dired-directory)))
1846 \f
1847 ;; Idiosyncratic dired commands that don't deal with marks.
1850 "Summarize basic Dired commands and show recent dired errors."
1853 ;>> this should check the key-bindings and use substitute-command-keys if non-standard
1858 "Undo in a dired buffer.
1859 This doesn't recover lost files, it just undoes changes in the buffer itself.
1860 You can use it to recover marks, killed lines or subdirs."
1869 "Edit dired buffer with Wdired, or set it read-only.
1870 Call `wdired-change-to-wdired-mode' in dired buffers whose editing is
1871 supported by Wdired (the major mode of the dired buffer is `dired-mode').
1872 Otherwise, for buffers inheriting from dired-mode, call `toggle-read-only'."
1879 "Move down lines then position at filename.
1880 Optional prefix ARG says how many lines to move; default is one line."
1886 "Move up lines then position at filename.
1887 Optional prefix ARG says how many lines to move; default is one line."
1893 "Goto ARG'th next directory file line."
1905 "Goto ARG'th previous directory file line."
1910 "Run Dired on parent directory of current directory.
1911 Find the parent directory either in this buffer or another buffer.
1912 Creates a buffer if necessary."
1917 ;; Only try dired-goto-subdir if buffer has more than one dir.
1927 "Get the current line's file name, with an error if file does not exist."
1929 ;; We pass t for second arg so that we don't get error for `.' and `..'.
1931 file-name)
1936 file-name
1941 ;; Force C-m keybinding rather than `f' or `e' in the mode doc:
1944 "In Dired, visit the file or directory named on this line."
1946 ;; Bind `find-file-run-dired' so that the command works on directories
1947 ;; too, independent of the user's setting.
1952 "In Dired, visit this file or directory instead of the dired buffer."
1956 ;; Don't override the setting from .emacs.
1957 ;;;###autoload (put 'dired-find-alternate-file 'disabled t)
1960 "In Dired, visit the file or directory name you click on."
1981 "In Dired, examine a file in view mode, returning to Dired when done.
1982 When file is a directory, show it in this buffer if it is inserted.
1983 Otherwise, display it in another buffer."
1993 "In Dired, visit this file or directory in another window."
1998 "In Dired, display this file or directory in another window."
2001 \f
2002 ;;; Functions for extracting and manipulating file names in Dired buffers.
2005 "In Dired, return name of file mentioned on this line.
2006 Value returned normally includes the directory name.
2007 Optional arg LOCALP with value `no-dir' means don't include directory
2008 name in result. A value of `verbatim' means to return the name exactly as
2009 it occurs in the buffer, and a value of t means construct name relative to
2010 `default-directory', which still may contain slashes if in a subdirectory.
2011 Optional arg NO-ERROR-IF-NOT-FILEP means treat `.' and `..' as
2012 regular filenames and return nil if no filename on this line.
2013 Otherwise, an error occurs in these cases."
2018 ;; nil if no file on this line, but no-error-if-not-filep is t:
2021 ;; Get rid of the mouse-face property that file names have.
2023 ;; Unquote names quoted by ls or by dired-insert-directory.
2024 ;; This code was written using `read' to unquote, because
2025 ;; it's faster than substituting \007 (4 chars) -> ^G (1
2026 ;; char) etc. in a lisp loop. Unfortunately, this decision
2027 ;; has necessitated hacks such as dealing with filenames
2028 ;; with quotation marks in their names.
2040 ;; The above `read' will return a unibyte string if FILE
2041 ;; contains eight-bit-control/graphic characters.
2046 ;; A relative file name can start with ~.
2047 ;; Don't treat it as absolute in this context.
2052 nil)
2054 file)
2062 ;; check for safe-magic property so that we won't
2063 ;; put /: for names that don't really need them.
2064 ;; For instance, .gz files when auto-compression-mode is on.
2067 file)))
2069 file)
2073 ;; check for safe-magic property so that we won't
2074 ;; put /: for names that don't really need them.
2075 ;; For instance, .gz files when auto-compression-mode is on.
2078 file)))
2084 "Replace first match of REGEXP in STRING with NEWTEXT.
2085 If it does not match, nil is returned instead of the new string.
2086 Optional arg LITERAL means to take NEWTEXT literally.
2087 Optional arg GLOBAL means to replace all matches."
2094 ret)
2096 nil
2100 ;;"Convert FILE (a file name relative to DIR) to an absolute file name."
2101 ;; We can't always use expand-file-name as this would get rid of `.'
2102 ;; or expand in / instead default-directory if DIR=="".
2103 ;; This should be good enough for ange-ftp.
2104 ;; It should be reasonably fast, though, as it is called in
2105 ;; dired-get-filename.
2109 "Convert FILE (an absolute file name) to a name relative to DIR.
2110 If this is impossible, return FILE unchanged.
2111 DIR must be a directory name, not a file name."
2113 ;; This case comes into play if default-directory is set to
2114 ;; use ~.
2119 ;;; (or no-error
2120 ;;; (error "%s: not in directory tree growing at %s" file dir))
2121 file))
2122 \f
2123 ;;; Functions for finding the file name in a dired buffer line.
2129 ;; Move to first char of filename on this line.
2130 ;; Returns position (point) or nil if no filename on this line."
2132 "Move to the beginning of the filename on the current line.
2133 Return the position of the beginning of the filename, or nil if none found."
2134 ;; This is the UNIX version.
2137 ;; First try assuming `ls --dired' was used.
2145 ;; Ha! There *is* a file. Our regexp-from-hell just failed to find it.
2149 nil)
2154 ;; Assumes point is at beginning of filename,
2155 ;; thus the rwx bit re-search-backward below will succeed in *this*
2156 ;; line if at all. So, it should be called only after
2157 ;; (dired-move-to-filename t).
2158 ;; On failure, signals an error (with non-nil NO-ERROR just returns nil).
2159 ;; This is the UNIX version.
2163 ;; case-fold-search is nil now, so we can test for capital F:
2170 nil
2172 ;; Restrict perm bits to be non-blank,
2173 ;; otherwise this matches one char to early (looking backward):
2174 ;; "l---------" (some systems make symlinks that way)
2175 ;; "----------" (plain file with zero perms)
2177 dired-permission-flags-regexp nil t)
2180 ;; Only with -F we need to know whether it's an executable
2182 used-F
2190 ;; Move point to end of name:
2196 dired-ls-F-marks-symlinks
2200 ;; ls -lF marks dirs, sockets, fifos and executables with exactly
2201 ;; one trailing character. (Executable bits on symlinks ain't mean
2202 ;; a thing, even to ls, but we know it's not a symlink.)
2205 executable)
2214 nil
2217 \f
2218 ;;; COPY NAMES OF MARKED FILES INTO KILL-RING.
2221 "Copy names of marked (or next ARG) files into the kill ring.
2222 The names are separated by a space.
2223 With a zero prefix arg, use the absolute file name of each marked file.
2225 `default-directory'. (This still may contain slashes if in a subdirectory.)
2227 If on a subdir headerline, use absolute subdirname instead;
2228 prefix arg and marked files are ignored in this case.
2250 \f
2251 ;; Keeping Dired buffers in sync with the filesystem and with each other
2254 ;; Return a list of buffers for DIR (top level or in-situ subdir).
2255 ;; If FILE is non-nil, include only those whose wildcard pattern (if any)
2256 ;; matches FILE.
2257 ;; The list is in reverse order of buffer creation, most recent last.
2258 ;; As a side effect, killed dired buffers for DIR are removed from
2259 ;; dired-buffers.
2266 ;; Buffer is killed - clean up:
2274 dired-directory)))
2277 file)))
2281 result))
2284 "Convert glob-pattern PATTERN to a regular expression."
2286 regexp)
2298 ;; Fails to handle ^ yet ????
2312 regexp
2320 ;;"Advertise in variable `dired-buffers' that we dired `default-directory'."
2321 ;; With wildcards we actually advertise too much.
2324 t ; we have already advertised ourselves
2327 dired-buffers)))))
2330 ;; Remove DIR from the buffer alist in variable dired-buffers.
2331 ;; This has the effect of removing any buffer whose main directory is DIR.
2332 ;; It does not affect buffers in which DIR is a subdir.
2333 ;; Removing is also done as a side-effect in dired-buffer-for-dir.
2336 \f
2337 ;; Tree Dired
2339 ;;; utility functions
2342 ;;"Is FILE part of the directory tree starting at DIR?"
2347 ;; Prepend default-directory to DIR if relative file name.
2348 ;; dired-get-filename must be able to make a valid file name from a
2349 ;; file and its directory DIR.
2352 dir
2356 ;;"Return the subdir name on this line, or nil if not on a headerline."
2357 ;; Look up in the alist whether this is a headerline.
2363 dired-subdir-alist))))
2364 cur-dir))))
2366 ;(defun dired-get-subdir-min (elt)
2367 ; (cdr elt))
2368 ;; can't use macro, must be redefinable for other alist format in dired-nstd.
2382 ;; Return an index into alist for use with nth
2383 ;; for the sake of subdir moving commands.
2392 "Go to next subdirectory, regardless of level."
2393 ;; Use 0 arg to go to this directory's header line.
2394 ;; NO-SKIP prevents moving to end of header line, returning whatever
2395 ;; position was found in dired-subdir-alist.
2398 pos index)
2399 ;; nth with negative arg does not return nil but the first element
2409 nil ; return nil if not found
2413 "Build `dired-subdir-alist' by parsing the buffer.
2414 Returns the new value of the alist.
2415 If optional arg SWITCHES is non-nil, use its value
2416 instead of `dired-actual-switches'."
2424 new-dir-name
2426 ;; Used to expand subdirectory names correctly in recursive
2427 ;; ange-ftp listings.
2434 ;; Avoid taking a file name ending in a colon
2435 ;; as a subdir name.
2445 new-dir-name
2457 ;; Place a sub directory boundary between lines.
2464 ;; We don't need to sort it because it is in buffer order per
2465 ;; constructionem. Return new alist:
2466 dired-subdir-alist))
2469 ;; Add new DIR at NEW-MARKER. Don't sort.
2472 dired-subdir-alist)))
2475 ;; Position point on first nontrivial file after point.
2491 "Go to line describing file FILE in this dired buffer."
2492 ;; Return value of point on success, else nil.
2493 ;; FILE must be an absolute file name.
2494 ;; Loses if FILE contains control chars like "\007" for which ls
2495 ;; either inserts "?" or "\\007" into the buffer, so we won't find
2496 ;; it in the buffer.
2508 ;; The hair here is to get the result of dired-goto-subdir
2509 ;; without really calling it if we don't have any subdirs.
2515 search-string
2522 ;; filenames are preceded by SPC, this makes
2523 ;; the search faster (e.g. for the filename "-"!).
2526 ;; Match could have BASE just as initial substring or
2527 ;; or in permission bits or date or
2528 ;; not be a proper filename at all:
2530 ;; Must move to filename since an (actually
2531 ;; correct) match could have been elsewhere on the
2532 ;; ;; line (e.g. "-" would match somewhere in the
2533 ;; permission bits).
2535 ;; If this isn't the right line, move forward to avoid
2536 ;; trying this line again.
2539 ;; return value of point (i.e., FOUND):
2543 ;; Where point should go in a new listing of DIRNAME.
2544 ;; Point assumed at beginning of new subdir line.
2545 ;; You may redefine this function as you wish, e.g. like in dired-x.el.
2548 \f
2549 ;; These are hooks which make tree dired work.
2550 ;; They are in this file because other parts of dired need to call them.
2551 ;; But they don't call the rest of tree dired unless there are subdirs loaded.
2553 ;; This function is called for each retrieved filename.
2554 ;; It could stand to be faster, though it's mostly function call
2555 ;; overhead. Avoiding the function call seems to save about 10% in
2556 ;; dired-get-filename. Make it a defsubst?
2558 "Return the name of the subdirectory to which this line belongs.
2559 This returns a string with trailing slash, like `default-directory'.
2560 Optional argument means return a file name relative to `default-directory'."
2563 ;; probably because called in a non-dired buffer
2565 elt dir)
2569 ;; use `<=' (not `<') as subdir line is part of subdir
2571 nil ; found
2575 dir)))
2577 ;; Subdirs start at the beginning of their header lines and end just
2578 ;; before the beginning of the next header line (or end of buffer).
2585 \f
2586 ;; Deleting files
2589 "Decide whether recursive deletes are allowed.
2590 A value of nil means no recursive deletes.
2591 `always' means delete recursively without asking. This is DANGEROUS!
2592 `top' means ask for each directory at top level, but delete its subdirectories
2593 without asking.
2594 Anything else means ask for each directory."
2602 ;; Match anything but `.' and `..'.
2605 ;; Delete file, possibly delete a directory and all its files.
2606 ;; This function is usefull outside of dired. One could change it's name
2607 ;; to e.g. recursive-delete-file and put it somewhere else.
2609 Delete FILE or directory (possibly recursively if optional RECURSIVE is true.)
2610 RECURSIVE determines what to do with a non-empty directory. If RECURSIVE is:
2611 nil, do not delete.
2612 `always', delete recursively without asking.
2613 `top', ask for each directory at top level.
2614 Anything else, ask for each sub-directory."
2615 ;; This test is equivalent to
2616 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
2617 ;; but more efficient
2625 delete-by-moving-to-trash)
2626 "trash"
2634 "In Dired, delete the files flagged for deletion.
2635 If NOMESSAGE is non-nil, we don't display any message
2636 if there are no flagged files.
2637 `dired-recursive-deletes' controls whether deletion of
2638 non-empty directories is allowed."
2642 case-fold-search)
2646 ;; this can't move point since ARG is nil
2648 nil)
2649 nil t)
2654 "Delete all marked (or next ARG) files.
2655 `dired-recursive-deletes' controls whether deletion of
2656 non-empty directories is allowed."
2657 ;; This is more consistent with the file marking feature than
2658 ;; dired-do-flagged-delete.
2661 ;; this may move point if ARG is an integer
2663 arg)
2664 arg t))
2669 ;; L is an alist of files to delete, with their buffer positions.
2670 ;; ARG is the prefix arg.
2671 ;; Filenames are absolute.
2672 ;; (car L) *must* be the *last* (bottommost) file in the dired buffer.
2673 ;; That way as changes are made in the buffer they do not shift the
2674 ;; lines still to be changed, so the (point) values in L stay valid.
2675 ;; Also, for subdirs in natural order, a subdir's files are deleted
2676 ;; before the subdir itself - the other way around would not work.
2684 succ count)))
2685 ;; canonicalize file list for pop up
2700 ;; if we get here, removing worked
2716 failures))))
2721 ;; In all buffers dired'ing DIRECTORY, run FUN with ARGS.
2722 ;; If the buffer has a wildcard pattern, check that it matches FILE.
2723 ;; (FILE does not include a directory component.)
2724 ;; FILE may be nil, in which case ignore it.
2725 ;; Return list of buffers where FUN succeeded (i.e., returned non-nil).
2728 file))
2732 success-list))
2734 ;; Delete the entry for FILE from
2743 ;; This is a separate function for the sake of dired-x.el.
2745 ;; Clean up after a deleted file or directory FN.
2749 \f
2750 ;; Confirmation
2759 "Return a string for use in a prompt, either the current file
2760 name, or the marker and a count of marked files."
2761 ;; distinguish-one-marked can cause the first element to be just t.
2766 ;; more than 1 file:
2768 ;; abs(arg) = count
2769 ;; Perhaps this is nicer, but it also takes more screen space:
2770 ;;(format "[%s %d files]" (if (> arg 0) "next" "previous")
2771 ;; count)
2776 "Pop up buffer BUF in a way suitable for Dired."
2781 ;; Try to split the selected window vertically if
2782 ;; that's possible. (Bug#1806)
2784 ;; Otherwise, try to split WINDOW sensibly.
2786 pop-up-frames)
2788 ;; If dired-shrink-to-fit is t, make its window fit its contents.
2790 ;; Try to not delete window when we want to display less than
2791 ;; `window-min-height' lines.
2795 "A list of symbols for commands Dired should not confirm, or t.
2796 Command symbols are `byte-compile', `chgrp', `chmod', `chown', `compress',
2797 `copy', `delete', `hardlink', `load', `move', `print', `shell', `symlink',
2798 `touch' and `uncompress'.
2799 If t, confirmation is never needed."
2810 "Return FUNCTION's result on ARGS after showing which files are marked.
2811 Displays the file names in a buffer named BUFNAME;
2813 This uses function `dired-pop-to-buffer' to do that.
2815 FUNCTION should not manipulate files, just read input
2816 (an argument or confirmation).
2817 The window is not shown if there is just one file or
2818 OP-SYMBOL is a member of the list in `dired-no-confirm'.
2819 FILES is the list of marked files. It can also be (t FILENAME)
2820 in the case of one marked file, to distinguish that from using
2821 just the current file."
2825 ;; If FILES defaulted to the current line's file.
2830 ;; Handle (t FILE) just like (FILE), here.
2831 ;; That value is used (only in some cases), to mean
2832 ;; just one file that was marked, rather than the current line file.
2844 \f
2845 ;; Commands to mark or flag file(s) at or near current line.
2848 ;; This version skips non-file lines.
2859 ;; Advance to the next line--actually, to the line that *was* next.
2860 ;; (If FUNCTION inserted some new lines in between, skip them.)
2872 ;; This used to be a regexp match of the `total ...' line output by
2873 ;; ls, which is slightly faster, but that is not very robust; notably,
2874 ;; it fails for non-english locales.
2878 "Move to the next marked file, wrapping around the end of the buffer."
2895 "Move to the previous marked file, wrapping around the end of the buffer."
2900 ;; Return FILE's marker, or nil if unmarked.
2914 ;; Skip subdir line and following garbage like the `total' line:
2925 "Mark the current (or next ARG) files.
2926 If on a subdir headerline, mark all its files except `.' and `..'.
2930 this subdir."
2940 "Unmark the current (or next ARG) files.
2941 If looking at a subdir, unmark all its files except `.' and `..'."
2947 "In Dired, flag the current line's file for deletion.
2948 With prefix arg, repeat over several lines.
2950 If on a subdir headerline, mark all its files except `.' and `..'."
2956 "In Dired, move up lines and remove deletion flag there.
2957 Optional prefix ARG says how many lines to unflag; default is one line."
2962 "Toggle marks: marked files become unmarked, and vice versa.
2963 Files marked with other flags (such as `D') are not affected.
2964 `.' and `..' are never toggled.
2965 As always, hidden subdirs are not affected."
2973 ;; use subst instead of insdel because it does not move
2974 ;; the gap and thus should be faster and because
2975 ;; other characters are left alone automatically
2982 \f
2983 ;;; Commands to mark or flag files based on their characteristics or names.
2992 "Mark all files matching REGEXP for use in later commands.
2993 A prefix argument means to unmark them instead.
2994 `.' and `..' are never marked.
2997 object files--just `.o' will mark more than you might think."
3011 "Mark all files with contents containing REGEXP for use in later commands.
3012 A prefix argument means to unmark them instead.
3013 `.' and `..' are never marked."
3027 ;; For now we do it inside emacs
3028 ;; Grep might be better if there are a lot of files
3038 )))
3042 "In Dired, flag all files containing the specified REGEXP for deletion.
3043 The match is against the non-directory part of the filename. Use `^'
3044 and `$' to anchor matches. Exclude subdirs by hiding them.
3045 `.' and `..' are never flagged."
3050 "Mark all symbolic links.
3051 With prefix argument, unflag all those files."
3057 "Mark all directory file lines except `.' and `..'.
3058 With prefix argument, unflag all those files."
3066 "Mark all executable files.
3067 With prefix argument, unflag all those files."
3072 ;; dired-x.el has a dired-mark-sexp interactive command: mark
3073 ;; files for which PREDICATE returns non-nil.
3076 "Flag for deletion files whose names suggest they are auto save files.
3077 A prefix argument says to unflag those files instead."
3081 ;; It is less than general to check for # here,
3082 ;; but it's the only way this runs fast enough.
3086 ;; Handle executables in case of -F option.
3087 ;; We need not worry about the other kinds
3088 ;; of markings that -F makes, since they won't
3089 ;; appear on real auto-save files.
3101 ;; `log' here is dubious, since it's typically used for useful log
3102 ;; files, not just TeX stuff. -- fx
3111 "Flag for deletion all files that match `dired-garbage-files-regexp'."
3116 "Flag all backup files (names ending with `~') for deletion.
3117 With prefix argument, unflag these files."
3121 ;; Don't call backup-file-name-p unless the last character looks like
3122 ;; it might be the end of a backup file name. This isn't very general,
3123 ;; but it's the only way this runs fast enough.
3125 ;; Handle executables in case of -F option.
3126 ;; We need not worry about the other kinds
3127 ;; of markings that -F makes, since they won't
3128 ;; appear on real backup files.
3138 "Change all OLD marks to NEW marks.
3139 OLD and NEW are both characters used to mark files."
3156 t)
3161 "Remove all marks from all files in the dired buffer."
3166 "Remove a specific mark (or any mark) from every file.
3167 After this command, type the mark character to remove,
3168 or type RET to remove all marks.
3169 With prefix arg, query for each marked file.
3177 Type SPC or `y' to unmark one file, DEL or `n' to skip to next,
3187 file))))
3193 count))))
3194 \f
3195 ;; Logging failures operating on files, and showing the results.
3200 "Pop up a buffer with error log output from Dired.
3201 A group of errors from a single command ends with a formfeed.
3217 ;; Log a message or the contents of a buffer.
3218 ;; If LOG is a string and there are more args, it is formatted with
3219 ;; those ARGS. Usually the LOG string ends with a \n.
3220 ;; End each bunch of errors with (dired-log t):
3221 ;; this inserts the current time and buffer at the start of the page,
3222 ;; and \f (formfeed) at the end.
3230 log)))
3243 "State a summary of a command's failures, in echo area and log buffer.
3244 STRING is an overall summary of the failures.
3245 FAILURES is a list of file names that we failed to operate on,
3246 or nil if file names are not applicable."
3256 string failures))
3257 ;; Log a summary describing a bunch of errors.
3260 \f
3261 ;;; Sorting
3263 ;; Most ls can only sort by name or by date (with -t), nothing else.
3264 ;; GNU ls sorts on size with -S, on extension with -X, and unsorted with -U.
3265 ;; So anything that does not contain these is sort "by name".
3270 This indicates to Dired which option switches to watch out for because they
3271 will change the sorting order behavior of `ls'.
3273 To change the default sorting order \(e.g. add a `-v' option\), see the
3274 variable `dired-listing-switches'. To temporarily override the listing
3279 ;; `dired-ls-sorting-switches' after -t overrides -t.
3291 "Non-nil means the Dired sort command is disabled.
3295 ;; Set modeline display according to dired-actual-switches.
3296 ;; Modeline display of "by name" or "by date" guarantees the user a
3297 ;; match with the corresponding regexps. Non-matching switches are
3298 ;; shown literally.
3303 dired-sort-by-name-regexp dired-actual-switches)
3306 dired-sort-by-date-regexp dired-actual-switches)
3313 "Toggle sorting by date, and refresh the Dired buffer.
3314 With a prefix argument, edit the current listing switches instead."
3324 ;; Toggle between sort by date/name. Reverts the buffer.
3326 dired-actual-switches))
3327 ;; Regexp for finding (possibly embedded) -t switches.
3329 case-fold-search)
3330 ;; Remove the -t switch.
3334 ;; Remove a stand-alone -t switch.
3337 ;; Remove a switch of the form -XtY for some X and Y.
3340 ;; Now, if we weren't sorting by date before, add the -t switch.
3346 ;; Some user code loads dired especially for this.
3347 ;; Don't do that--use replace-regexp-in-string instead.
3349 ;; Replace REGEXP with NEWTEXT everywhere in STRING and return result.
3350 ;; NEWTEXT is taken literally---no \\DIGIT escapes will be recognized.
3356 start me))
3360 "Specify new `ls' SWITCHES for current dired buffer.
3361 Values matching `dired-sort-by-date-regexp' or `dired-sort-by-name-regexp'
3362 set the minor mode accordingly, others appear literally in the mode line.
3363 With optional second arg NO-REVERT, don't refresh the listing afterwards."
3374 "Additional processing of -R in ls option string SWITCHES.
3375 Saves `dired-subdir-alist' when R is set and restores saved value
3376 minus any directories explicitly deleted when R is cleared.
3377 To be called first in body of `dired-sort-other', etc."
3381 ;; Adding -R to ls switches -- save `dired-subdir-alist':
3385 ;; Deleting -R from ls switches -- revert to pre-R subdirs
3386 ;; that are still present:
3392 dired-subdir-alist)
3393 ;; subdir still present...
3396 subdirs)))
3400 ;; No pre-R subdir alist, so revert to main directory
3401 ;; listing:
3403 \f
3405 ;;;; Drag and drop support
3408 "Decide whether recursive copies are allowed.
3409 A value of nil means no recursive copies.
3410 `always' means copy recursively without asking.
3411 `top' means ask for each directory at top level.
3412 Anything else means ask for each directory."
3427 ;; No need to get actions and descriptions from the source,
3428 ;; we only have three actions anyway.
3430 t
3436 "--"
3440 nil)))
3445 ;; Only used when (featurep 'dnd).
3450 "Copy, move or link a file to the dired directory.
3451 URI is the file to handle, ACTION is one of copy, move, link or ask.
3452 Ask means pop up a menu for the user to select one of copy, move or link."
3461 ;; If copying a directory and dired-recursive-copies is
3462 ;; nil, dired-copy-file fails. Pop up a notice.
3471 ;; Binding dired-overwrite-confirmed to nil makes
3472 ;; dired-handle-overwrite a no-op. We instead use
3473 ;; y-or-n-p, which pops a graphical menu.
3474 dired-overwrite-confirmed backup-file)
3476 ;; d-b-o is defined in dired-aux.
3478 dired-backup-overwrite
3494 action))))))
3497 "Copy, move or link a file to the dired directory if it is a local file.
3498 URI is the file to handle. If the hostname in the URI isn't local, do nothing.
3499 ACTION is one of copy, move, link or ask.
3500 Ask means pop up a menu for the user to select one of copy, move or link."
3503 nil)))
3504 \f
3506 ;;;; Desktop support
3511 "Auxiliary information to be saved in desktop file."
3513 ;; Value of `dired-directory'.
3515 ;; Directory name followed by list of files.
3518 ;; Directory name, optionally with shell wildcard.
3520 ;; Subdirectories in `dired-subdir-alist'.
3525 dired-subdir-alist)))))
3528 desktop-buffer-name
3529 desktop-buffer-misc)
3530 "Restore a dired buffer specified in a desktop file."
3531 ;; First element of `desktop-buffer-misc' is the value of `dired-directory'.
3532 ;; This value is a directory name, optionally with shell wildcard or
3533 ;; a directory name followed by list of files.
3539 ;; The following elements of `desktop-buffer-misc' are the keys
3540 ;; from `dired-subdir-alist'.
3545 nil)))
3550 \f
3551 ;;; Start of automatically extracted autoloads.
3552 \f
3553 ;;;### (autoloads (dired-show-file-type dired-do-query-replace-regexp
3554 ;;;;;; dired-do-search dired-do-isearch-regexp dired-do-isearch
3555 ;;;;;; dired-isearch-filenames-regexp dired-isearch-filenames dired-isearch-filenames-setup
3556 ;;;;;; dired-hide-all dired-hide-subdir dired-tree-down dired-tree-up
3557 ;;;;;; dired-kill-subdir dired-mark-subdir-files dired-goto-subdir
3558 ;;;;;; dired-prev-subdir dired-insert-subdir dired-maybe-insert-subdir
3559 ;;;;;; dired-downcase dired-upcase dired-do-symlink-regexp dired-do-hardlink-regexp
3560 ;;;;;; dired-do-copy-regexp dired-do-rename-regexp dired-do-rename
3561 ;;;;;; dired-do-hardlink dired-do-symlink dired-do-copy dired-create-directory
3562 ;;;;;; dired-rename-file dired-copy-file dired-relist-file dired-remove-file
3563 ;;;;;; dired-add-file dired-do-redisplay dired-do-load dired-do-byte-compile
3564 ;;;;;; dired-do-compress dired-query dired-compress-file dired-do-kill-lines
3565 ;;;;;; dired-run-shell-command dired-do-shell-command dired-do-async-shell-command
3566 ;;;;;; dired-clean-directory dired-do-print dired-do-touch dired-do-chown
3567 ;;;;;; dired-do-chgrp dired-do-chmod dired-compare-directories dired-backup-diff
3568 ;;;;;; dired-diff) "dired-aux" "dired-aux.el" "b30af1396920c8bf22f3c83746bb73f9")
3569 ;;; Generated autoloads from dired-aux.el
3572 Compare file at point with file FILE using `diff'.
3573 FILE defaults to the file at the mark. (That's the mark set by
3575 The prompted-for file is the first file given to `diff'.
3576 With prefix arg, prompt for second argument SWITCHES,
3577 which is options for `diff'.
3582 Diff this file with its backup file or vice versa.
3583 Uses the latest backup, if there are several numerical backups.
3584 If this file is a backup, diff it with its original.
3585 The backup file is the first file given to `diff'.
3586 With prefix arg, prompt for argument SWITCHES which is options for `diff'.
3591 Mark files with different file attributes in two dired buffers.
3592 Compare file attributes of files in the current directory
3593 with file attributes in directory DIR2 using PREDICATE on pairs of files
3594 with the same name. Mark files for which PREDICATE returns non-nil.
3595 Mark files with different names if PREDICATE is nil (or interactively
3596 with empty input at the predicate prompt).
3598 PREDICATE is a Lisp expression that can refer to the following variables:
3600 size1, size2 - file size in bytes
3601 mtime1, mtime2 - last modification time in seconds, as a float
3602 fa1, fa2 - list of file attributes
3603 returned by function `file-attributes'
3605 where 1 refers to attribute of file in the current dired buffer
3606 and 2 to attribute of file in second dired buffer.
3608 Examples of PREDICATE:
3610 (> mtime1 mtime2) - mark newer files
3611 (not (= size1 size2)) - mark files with different sizes
3612 (not (string= (nth 8 fa1) (nth 8 fa2))) - mark files with different modes
3613 (not (and (= (nth 2 fa1) (nth 2 fa2)) - mark files with different UID
3614 (= (nth 3 fa1) (nth 3 fa2)))) and GID.
3619 Change the mode of the marked (or next ARG) files.
3620 Symbolic modes like `g+w' are allowed.
3625 Change the group of the marked (or next ARG) files.
3630 Change the owner of the marked (or next ARG) files.
3635 Change the timestamp of the marked (or next ARG) files.
3636 This calls touch.
3641 Print the marked (or next ARG) files.
3642 Uses the shell command coming from variables `lpr-command' and
3643 `lpr-switches' as default.
3648 Flag numerical backups for deletion.
3649 Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
3650 Positive prefix arg KEEP overrides `dired-kept-versions';
3651 Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
3654 with a prefix argument.
3659 Run a shell command COMMAND on the marked files asynchronously.
3661 Like `dired-do-shell-command' but if COMMAND doesn't end in ampersand,
3662 adds `* &' surrounded by whitespace and executes the command asynchronously.
3663 The output appears in the buffer `*Async Shell Command*'.
3668 Run a shell command COMMAND on the marked files.
3669 If no files are marked or a specific numeric prefix arg is given,
3671 The prompt mentions the file(s) or the marker, as appropriate.
3673 If there is a `*' in COMMAND, surrounded by whitespace, this runs
3674 COMMAND just once with the entire file list substituted there.
3676 If there is no `*', but there is a `?' in COMMAND, surrounded by
3677 whitespace, this runs COMMAND on each file individually with the
3678 file name substituted for `?'.
3680 Otherwise, this runs COMMAND on each file individually with the
3681 file name added at the end of COMMAND (separated by a space).
3683 `*' and `?' when not surrounded by whitespace have no special
3684 significance for `dired-do-shell-command', and are passed through
3685 normally to the shell, but you must confirm first. To pass `*' by
3688 If COMMAND produces output, it goes to a separate buffer.
3690 This feature does not try to redisplay Dired buffers afterward, as
3691 there's no telling what files COMMAND may have changed.
3694 When COMMAND runs, its working directory is the top-level directory
3695 of the Dired buffer, so output files usually are created there
3696 instead of in a subdir.
3698 In a noninteractive call (from Lisp code), you must specify
3699 the list of file names explicitly with the FILE-LIST argument, which
3700 can be produced by `dired-get-marked-files', for example.
3705 Not documented
3710 Kill all marked lines (not the files).
3711 With a prefix argument, kill that many lines starting with the current line.
3712 \(A negative argument kills backward.)
3713 If you use this command with a prefix argument to kill the line
3714 for a file that is a directory, which you have inserted in the
3715 Dired buffer as a subdirectory, then it deletes that subdirectory
3716 from the buffer as well.
3717 To kill an entire subdirectory (without killing its line in the
3718 parent directory), go to its directory header line and use this
3719 command with a prefix argument (the value does not matter).
3724 Not documented
3729 Format PROMPT with ARGS, query user, and store the result in SYM.
3730 The return value is either nil or t.
3732 The user may type y or SPC to accept once; n or DEL to skip once;
3733 ! to accept this and subsequent queries; or q or ESC to decline
3734 this and subsequent queries.
3736 If SYM is already bound to a non-nil value, this function may
3737 return automatically without querying the user. If SYM is !,
3738 return t; if SYM is q or ESC, return nil.
3743 Compress or uncompress marked (or next ARG) files.
3748 Byte compile marked (or next ARG) Emacs Lisp files.
3753 Load the marked (or next ARG) Emacs Lisp files.
3758 Redisplay all marked (or next ARG) files.
3759 If on a subdir line, redisplay that subdirectory. In that case,
3760 a prefix arg lets you edit the `ls' switches used for the new listing.
3762 Dired remembers switches specified with a prefix arg, so that reverting
3763 the buffer will not reset them. However, using `dired-undo' to re-insert
3764 or delete subdirectories can bypass this machinery. Hence, you sometimes
3765 may have to reset some subdirectory switches after a `dired-undo'.
3766 You can reset all subdirectory switches to the default using
3768 See Info node `(emacs)Subdir switches' for more details.
3773 Not documented
3778 Not documented
3783 Create or update the line for FILE in all Dired buffers it would belong in.
3788 Not documented
3793 Not documented
3798 Create a directory called DIRECTORY.
3803 Copy all marked (or next ARG) files, or copy the current file.
3804 This normally preserves the last-modified date when copying.
3805 When operating on just the current file, you specify the new name.
3806 When operating on multiple or marked files, you specify a directory,
3807 and new copies of these files are made in that directory
3808 with the same names that the files currently have. The default
3809 suggested for the target directory depends on the value of
3810 `dired-dwim-target', which see.
3812 This command copies symbolic links by creating new ones,
3813 like `cp -d'.
3818 Make symbolic links to current file or all marked (or next ARG) files.
3819 When operating on just the current file, you specify the new name.
3820 When operating on multiple or marked files, you specify a directory
3821 and new symbolic links are made in that directory
3822 with the same names that the files currently have. The default
3823 suggested for the target directory depends on the value of
3824 `dired-dwim-target', which see.
3831 Add names (hard links) current file or all marked (or next ARG) files.
3832 When operating on just the current file, you specify the new name.
3833 When operating on multiple or marked files, you specify a directory
3834 and new hard links are made in that directory
3835 with the same names that the files currently have. The default
3836 suggested for the target directory depends on the value of
3837 `dired-dwim-target', which see.
3842 Rename current file or all marked (or next ARG) files.
3843 When renaming just the current file, you specify the new name.
3844 When renaming multiple or marked files, you specify a directory.
3845 This command also renames any buffers that are visiting the files.
3846 The default suggested for the target directory depends on the value
3847 of `dired-dwim-target', which see.
3852 Rename selected files whose names match REGEXP to NEWNAME.
3854 With non-zero prefix argument ARG, the command operates on the next ARG
3855 files. Otherwise, it operates on all the marked files, or the current
3856 file if none are marked.
3858 As each match is found, the user must type a character saying
3861 REGEXP defaults to the last regexp used.
3863 With a zero prefix arg, renaming by regexp affects the absolute file name.
3864 Normally, only the non-directory part of the file name is used and changed.
3869 Copy selected files whose names match REGEXP to NEWNAME.
3870 See function `dired-do-rename-regexp' for more info.
3875 Hardlink selected files whose names match REGEXP to NEWNAME.
3876 See function `dired-do-rename-regexp' for more info.
3881 Symlink selected files whose names match REGEXP to NEWNAME.
3882 See function `dired-do-rename-regexp' for more info.
3887 Rename all marked (or next ARG) files to upper case.
3892 Rename all marked (or next ARG) files to lower case.
3897 Insert this subdirectory into the same dired buffer.
3899 else inserts it at its natural place (as `ls -lR' would have done).
3900 With a prefix arg, you may edit the ls switches used for this listing.
3901 You can add `R' to the switches to expand the whole tree starting at
3902 this subdirectory.
3903 This function takes some pains to conform to `ls -lR' output.
3905 Dired remembers switches specified with a prefix arg, so that reverting
3906 the buffer will not reset them. However, using `dired-undo' to re-insert
3907 or delete subdirectories can bypass this machinery. Hence, you sometimes
3908 may have to reset some subdirectory switches after a `dired-undo'.
3909 You can reset all subdirectory switches to the default using
3911 See Info node `(emacs)Subdir switches' for more details.
3916 Insert this subdirectory into the same dired buffer.
3917 If it is already present, overwrites previous entry,
3918 else inserts it at its natural place (as `ls -lR' would have done).
3919 With a prefix arg, you may edit the `ls' switches used for this listing.
3920 You can add `R' to the switches to expand the whole tree starting at
3921 this subdirectory.
3922 This function takes some pains to conform to `ls -lR' output.
3927 Go to previous subdirectory, regardless of level.
3928 When called interactively and not on a subdir line, go to this subdir's line.
3933 Go to end of header line of DIR in this dired buffer.
3934 Return value of point on success, otherwise return nil.
3940 Mark all files except `.' and `..' in current subdirectory.
3941 If the Dired buffer shows multiple directories, this command
3942 marks the files listed in the subdirectory that point is in.
3947 Remove all lines of current subdirectory.
3948 Lower levels are unaffected.
3953 Go up ARG levels in the dired tree.
3958 Go down in the dired tree.
3963 Hide or unhide the current subdirectory and move to next directory.
3964 Optional prefix arg is a repeat factor.
3970 Hide all subdirectories, leaving only their header lines.
3971 If there is already something hidden, make everything visible again.
3977 Set up isearch to search in Dired file names.
3978 Intended to be added to `isearch-mode-hook'.
3983 Search for a string using Isearch only in file names in the Dired buffer.
3988 Search for a regexp using Isearch only in file names in the Dired buffer.
3993 Search for a string through all marked files using Isearch.
3998 Search for a regexp through all marked files using Isearch.
4003 Search through all marked files for a match for REGEXP.
4004 Stops when a match is found.
4010 Do `query-replace-regexp' of FROM with TO, on all marked files.
4011 Third arg DELIMITED (prefix arg) means replace only word-delimited matches.
4018 Print the type of FILE, according to the `file' command.
4019 If FILE is a symbolic link and the optional argument DEREF-SYMLINKS is
4020 true then the type of the file linked to by FILE is printed instead.
4024 ;;;***
4025 \f
4026 ;;;### (autoloads (dired-do-relsymlink dired-jump) "dired-x" "dired-x.el"
4027 ;;;;;; "6d47e23fbd9236014786c50618e99f09")
4028 ;;; Generated autoloads from dired-x.el
4031 Jump to dired buffer corresponding to current buffer.
4032 If in a file, dired the current directory and move to file's line.
4033 If in Dired already, pop up a level and goto old directory's line.
4034 In case the proper dired file line cannot be found, refresh the dired
4035 buffer and try again.
4036 When OTHER-WINDOW is non-nil, jump to dired buffer in other window.
4037 Interactively with prefix argument, read FILE-NAME and
4038 move to its line in dired.
4043 Relative symlink all marked (or next ARG) files into a directory.
4044 Otherwise make a relative symbolic link to the current file.
4045 This creates relative symbolic links like
4047 foo -> ../bar/foo
4049 not absolute ones like
4051 foo -> /ugly/file/name/that/may/change/any/day/bar/foo
4057 ;;;***
4058 \f
4059 ;;; End of automatically extracted autoloads.
4065 ;;; dired.el ends here