| blob | be82cb872b76d1917124bbd401382d71af2528cf |
1 ;;; dired.el --- directory-browsing commands
3 ;; Copyright (C) 1985, 1986, 1992, 1993 Free Software Foundation, Inc.
5 ;; Author: Sebastian Kremer <sk@thp.uni-koeln.de>
6 ;; Maintainer: FSF
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
13 ;; any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to
22 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
24 ;;; Commentary:
26 ;; This is a major mode for directory browsing and editing. It is
27 ;; documented in the Emacs manual.
29 ;; Rewritten in 1990/1991 to add tree features, file marking and
30 ;; sorting by Sebastian Kremer <sk@thp.uni-koeln.de>.
31 ;; Finished up by rms in 1992.
33 ;;; Code:
35 ;;; Customizable variables
37 ;;;###autoload
39 "*Switches passed to `ls' for dired. MUST contain the `l' option.
40 May contain all other options that don't contradict `-l';
41 may contain even `F', `b', `i' and `s'. See also the variable
44 ; Don't use absolute paths as /bin should be in any PATH and people
45 ; may prefer /usr/local/gnu/bin or whatever. However, chown is
46 ; usually not in PATH.
48 ;;;###autoload
54 ;;;###autoload
56 "*Informs dired about how `ls -lF' marks symbolic links.
57 Set this to t if `insert-directory-program' with `-lF' marks the symbolic link
58 itself with a trailing @ (usually the case under Ultrix).
60 Example: if `ln -s foo bar; ls -F bar' gives `bar -> foo', set it to
61 nil (the default), if it gives `bar@ -> foo', set it to t.
63 Dired checks if there is really a @ appended. Thus, if you have a
64 marking `ls' program on one host and a non-marking on another host, and
65 don't care about symbolic links which really end in a @, you can
68 ;;;###autoload
70 "*Regexp of files to skip when finding first file of a directory.
71 A value of nil means move to the subdir line.
74 ;;;###autoload
76 ;; Use t as default so that moved files "take their markers with them".
77 "*Controls marking of renamed files.
78 If t, files keep their previous marks when they are renamed.
79 If a character, renamed files (whether previously marked or not)
82 ;;;###autoload
84 "*Controls marking of copied files.
85 If t, copied files are marked if and as the corresponding original files were.
88 ;;;###autoload
90 "*Controls marking of newly made hard links.
91 If t, they are marked if and as the files linked to were marked.
94 ;;;###autoload
96 "*Controls marking of newly made symbolic links.
97 If t, they are marked if and as the files linked to were marked.
100 ;;;###autoload
102 "*If non-nil, dired tries to guess a default target directory.
103 This means: if there is a dired buffer displayed in the next window,
104 use its current subdir, instead of the current subdir of this dired buffer.
108 ;;;###autoload
110 "*If non-nil, Dired preserves the last-modified time in a file copy.
113 ;;; Hook variables
116 "Run after loading dired.
126 "Hook run after each time a file or directory is read by Dired.
127 After each listing of a file or directory, this hook is run
129 ;; Note this can't simply be run inside function `dired-ls' as the hook
130 ;; functions probably depend on the dired-subdir-alist to be OK.
132 ;;; Internal variables
135 ;; so that you can write things like
136 ;; (let ((dired-marker-char ?X))
137 ;; ;; great code using X markers ...
138 ;; )
139 ;; For example, commands operating on two sets of files, A and B.
140 ;; Or marking files with digits 0-9. This could implicate
141 ;; concentric sets or an order for the marked files.
142 ;; The code depends on dynamic scoping on the marker char.
143 "In Dired, the current mark character.
150 t
151 ;; I see no reason ever to make this nil -- rms.
152 ;; (> baud-rate search-slow-speed)
160 "The directory name or shell wildcard that was used as argument to `ls'.
161 Local to each dired buffer. May be a list, in which case the car is the
170 ;; These regexps must be tested at beginning-of-line, but are also
171 ;; used to search for next matches, so neither omitting "^" nor
172 ;; replacing "^" by "\n" (to make it slightly faster) will work.
175 ;; "Regexp matching a marked line.
176 ;; Important: the match ends just after the marker."
185 "-[-r][-w].[-r][-w][xs][-r][-w]."
191 "Association list of subdirectories and their buffer positions.
192 Each subdirectory has an element: (DIRNAME . STARTMARKER).
193 The order of elements is the reverse of the order in the buffer.
197 "Regexp matching a maybe hidden subdirectory line in `ls -lR' output.
198 Subexpression 1 is the subdirectory proper, no trailing colon.
199 The match starts at the beginning of the line and ends after the end
203 \f
204 ;;; Macros must be defined before they are used, for the byte compiler.
206 ;; Mark all files for which CONDITION evals to non-nil.
207 ;; CONDITION is evaluated on each line, with point at beginning of line.
208 ;; MSG is a noun phrase for the type of files being marked.
209 ;; It should end with a noun that can be pluralized by adding `s'.
210 ;; Return value is the number of files marked, or nil if none were marked.
225 count
234 ;; "Macro: Perform BODY with point somewhere on each marked line
235 ;;and return a list of BODY's results.
236 ;;If no marked file could be found, execute BODY on the current line.
237 ;; If ARG is an integer, use the next ARG (or previous -ARG, if ARG<0)
238 ;; files instead of the marked files.
239 ;; In that case point is dragged along. This is so that commands on
240 ;; the next ARG (instead of the marked) files can be chained easily.
241 ;; If ARG is otherwise non-nil, use current file instead.
242 ;;If optional third arg SHOW-PROGRESS evaluates to non-nil,
243 ;; redisplay the dired buffer after each file is processed.
244 ;;No guarantee is made about the position on the marked line.
245 ;; BODY must ensure this itself if it depends on this.
246 ;;Search starts at the beginning of the buffer, thus the car of the list
247 ;; corresponds to the line nearest to the buffer's bottom. This
248 ;; is also true for (positive and negative) integer values of ARG.
249 ;;BODY should not be too long as it is expanded four times."
250 ;;
251 ;;Warning: BODY must not add new lines before point - this may cause an
252 ;;endless loop.
253 ;;This warning should not apply any longer, sk 2-Sep-1991 14:10.
266 results))
267 ;; non-nil, non-integer ARG means use current file:
272 ;; remember position of next marked file before BODY
273 ;; can insert lines before the just found file,
274 ;; confusing us by finding the same marked file again
275 ;; and again and...
283 ;; move after last match
290 results
292 ;; save-excursion loses, again
296 "Return the marked files' names as list of strings.
297 The list is in the same order as the buffer, that is, the car is the
298 first marked file.
299 Values returned are normally absolute pathnames.
300 Optional arg LOCALP as in `dired-get-filename'.
301 Optional second argument ARG forces to use other files. If ARG is an
302 integer, use the next ARG files. If ARG is otherwise non-nil, use
303 current file. Usually ARG comes from the current prefix arg."
307 \f
308 ;; Function dired-ls is redefinable for VMS, ange-ftp, Prospero or
309 ;; other special applications.
310 \f
311 ;; The dired command
314 ;; For use in interactive.
318 dired-listing-switches))
320 nil default-directory nil))))
322 ;;;###autoload (define-key ctl-x-map "d" 'dired)
323 ;;;###autoload
326 Optional second argument SWITCHES specifies the `ls' options used.
327 \(Interactively, use a prefix argument to be able to specify SWITCHES.)
328 Dired displays a list of files in DIRNAME (which may also have
329 shell wildcards appended to select certain files). If DIRNAME is a cons,
330 its first element is taken as the directory name and the resr as an explicit
331 list of files to make directory entries for.
333 You can move around in it with the usual commands.
338 If DIRNAME is already in a dired buffer, that buffer is used without refresh."
339 ;; Cannot use (interactive "D") because of wildcards.
343 ;;;###autoload (define-key ctl-x-4-map "d" 'dired-other-window)
344 ;;;###autoload
350 ;;;###autoload (define-key ctl-x-5-map "d" 'dired-other-frame)
351 ;;;###autoload
357 ;;;###autoload
359 "Like `dired' but returns the dired buffer as value, does not select it."
361 ;; This loses the distinction between "/foo/*/" and "/foo/*" that
362 ;; some shells make:
375 ;; Separate function from dired-noselect for the sake of dired-vms.el.
377 ;; If there is an existing dired buffer for DIRNAME, just leave
378 ;; buffer as it is (don't even call dired-revert).
379 ;; This saves time especially for deep trees or with ange-ftp.
380 ;; The user can type `g'easily, and it is more consistent with find-file.
381 ;; But if SWITCHES are given they are probably different from the
382 ;; buffer's old value, so call dired-sort-other, which does
383 ;; revert the buffer.
384 ;; A pity we can't possibly do "Directory has changed - refresh? "
385 ;; like find-file does.
388 ;; note that buffer already is in dired-mode, if found
393 ;; We don't want default-major-mode to run hooks and set auto-fill
394 ;; or whatever, now that dired-mode does not
395 ;; kill-all-local-variables any longer.
401 ;; Else a new buffer
405 dirname
409 ;; default-directory and dired-actual-switches are set now
410 ;; (buffer-local), so we can call dired-readin:
415 ;; dired-readin can fail if parent directories are inaccessible.
416 ;; Don't leave an empty buffer around in that case.
418 ;; No need to narrow since the whole buffer contains just
419 ;; dired-readin's output, nothing else. The hook can
420 ;; successfully use dired functions (e.g. dired-get-filename)
421 ;; as the subdir-alist has been built in dired-readin.
426 buffer))
428 ;; This differs from dired-buffers-for-dir in that it does not consider
429 ;; subdirs of default-directory and searches for the first match only
438 blist nil)
440 found))
442 \f
443 ;; Read in a new dired buffer
445 ;; dired-readin differs from dired-insert-subdir in that it accepts
446 ;; wildcards, erases the buffer, and builds the subdir-alist anew
447 ;; (including making it buffer-local and clearing it first).
449 ;; default-directory and dired-actual-switches must be buffer-local
450 ;; and initialized by now.
451 ;; Thus we can test (equal default-directory dirname) instead of
452 ;; (file-directory-p dirname) and save a filesystem transaction.
453 ;; Also, we can run this hook which may want to modify the switches
454 ;; based on default-directory, e.g. with ange-ftp to a SysV host
455 ;; where ls won't understand -Al switches.
472 ;; We need this to make the root dir have a header line as all
473 ;; other subdirs have:
476 ;; can't run dired-after-readin-hook here, it may depend on the subdir
477 ;; alist to be OK.
478 )
481 ;; Must first make alist buffer local and set it to nil because
482 ;; dired-build-subdir-alist will call dired-clear-alist first
486 ;; Subroutines of dired-readin
489 ;; Just insert listing for the passed-in directory or
490 ;; directory-and-file list, assuming a clean buffer.
495 ;; Expand before comparing in case one or both have been abbreviated.
499 ;; If we are reading a whole single directory...
504 ;; Else assume it contains wildcards,
505 ;; unless it is an explicit list of files.
513 ;; Do the right thing whether dir-or-list is atomic or not. If it is,
514 ;; inset all files listed in the cdr (the car is the passed-in directory
515 ;; list.
525 ;; Insert DIR's headerline with no trailing slash, exactly like ls
526 ;; would, and put cursor where dired-build-subdir-alist puts subdir
527 ;; boundaries.
530 \f
531 ;; Reverting a dired buffer
534 ;; Reread the dired buffer. Must also be called after
535 ;; dired-actual-switches have changed.
536 ;; Should not fail even on completely garbaged buffers.
537 ;; Preserves old cursor, marks/flags, hidden-p.
545 buffer-read-only)
549 ;; treat top level dir extra (it may contain wildcards)
554 ;; don't run that hook for each subdir...
557 ;; ... run the hook for the whole buffer, and only after markers
558 ;; have been reinserted (else omitting in dired-x would omit marked files)
567 hidden-subdirs)))
568 ;; outside of the let scope
569 ;;; Might as well not override the user if the user changed this.
570 ;;; (setq buffer-read-only t)
571 )
573 ;; Subroutines of dired-revert
574 ;; Some of these are also used when inserting subdirs.
577 ;; Return alist of files and their marks, from BEG to END.
588 alist))
590 ;; Mark all files remembered in ALIST.
591 ;; Each element of ALIST looks like (FILE . MARKERCHAR).
605 ;; Return a list of names of subdirs currently hidden.
616 result))
618 ;; Try to insert all subdirs that were displayed before,
619 ;; according to the former subdir alist OLD-SUBDIR-ALIST.
633 ;; Remove directory DIR from any directory cache.
638 \f
639 ;; dired mode key bindings and initialization
643 nil
644 ;; Force `f' rather than `e' in the mode doc:
646 ;; This looks ugly when substitute-command-keys uses C-d instead d:
647 ;; (define-key dired-mode-map "\C-d" 'dired-flag-file-deletion)
651 ;; Commands to mark or flag certain categories of files
658 ;; Upper case keys (except !) for operating on the marked files
673 ;; Comparison commands
676 ;; Tree Dired commands
682 ;; move to marked files
685 ;; Make all regexp commands share a `%' prefix:
697 ;; Lower keys for commands not operating on all the marked files
718 ;; moving
725 ;; hiding
728 ;; misc
733 )
734 \f
735 ;; Make menu bar items.
737 ;; Get rid of the Edit menu bar item to save space.
861 \f
862 ;; Dired mode is suitable only for specially formatted data.
866 "\
869 \(optionally) its subdirectories, in the format of `ls -lR'.
872 compress, load or byte-compile them, change their file attributes
875 by file or all files matching certain criteria.
877 Letters no longer insert themselves. Digits are prefix arguments.
880 Most commands operate on the marked files and use the current file
881 if no files are marked. Use a numeric prefix argument to operate on
882 the next ARG (or previous -ARG if ARG<0) files, or just `1'
883 to operate on the current file only. Prefix arguments override marks.
885 to see why something went wrong.
890 (or dired it in another buffer, if it is a directory).
897 This retains all marks and hides subdirs again that were hidden before.
898 SPC and DEL can be used to move down and up by lines.
901 to read the
903 to relist a single or the marked files or a
905 again for the directory tree.
908 for more info):
910 dired-listing-switches
911 dired-trivial-filenames
912 dired-shrink-to-fit
913 dired-marker-char
914 dired-del-marker
915 dired-keep-marker-rename
916 dired-keep-marker-copy
917 dired-keep-marker-hardlink
918 dired-keep-marker-symlink
922 dired-before-readin-hook
923 dired-after-readin-hook
924 dired-mode-hook
925 dired-load-hook
927 Keybindings:
929 ;; Not to be called interactively (e.g. dired-directory will be set
930 ;; to default-directory, which is wrong with wildcards).
935 mode-name "Dired"
936 ;; case-fold-search nil
937 buffer-read-only t
938 selective-display t ; for subdirectory hiding
946 ;; list-buffers uses this to display the dir being edited in this buffer.
948 dired-directory)
953 \f
954 ;; Idiosyncratic dired commands that don't deal with marks.
957 "Bury the current dired buffer."
962 "Summarize basic Dired commands and show recent Dired errors."
965 ;>> this should check the key-bindings and use substitute-command-keys if non-standard
970 "Undo in a dired buffer.
971 This doesn't recover lost files, it just undoes changes in the buffer itself.
972 You can use it to recover marks, killed lines or subdirs.
974 parse the buffer again."
980 "Move down lines then position at filename.
981 Optional prefix ARG says how many lines to move; default is one line."
987 "Move up lines then position at filename.
988 Optional prefix ARG says how many lines to move; default is one line."
994 "Goto ARG'th next directory file line."
1006 "Goto ARG'th previous directory file line."
1011 "Run dired on parent directory of current directory.
1012 Find the parent directory either in this buffer or another buffer.
1013 Creates a buffer if necessary."
1018 ;; Only try dired-goto-subdir if buffer has more than one dir.
1023 up)
1027 "In dired, visit the file or directory named on this line."
1032 "In dired, examine a file in view mode, returning to dired when done.
1033 When file is a directory, show it in this buffer if it is inserted;
1034 otherwise, display it in another buffer."
1043 "In dired, visit this file or directory in another window."
1048 "In dired, display this file or directory in another window."
1052 \f
1053 ;;; Functions for extracting and manipulating file names in dired buffers.
1056 "In dired, return name of file mentioned on this line.
1057 Value returned normally includes the directory name.
1058 Optional arg LOCALP with value `no-dir' means don't include directory
1059 name in result. A value of t means construct name relative to
1060 `default-directory', which still may contain slashes if in a subdirectory.
1061 Optional arg NO-ERROR-IF-NOT-FILEP means return nil if no filename on
1062 this line, otherwise an error occurs."
1067 ;; nil if no file on this line, but no-error-if-not-filep is t:
1069 ;; Check if ls quoted the names, and unquote them.
1070 ;; Using read to unquote is much faster than substituting
1071 ;; \007 (4 chars) -> ^G (1 char) etc. in a lisp loop.
1073 ;; This case is about 20% slower than without -b.
1077 ;; some ls -b don't escape quotes, argh!
1078 ;; This is not needed for GNU ls, though.
1081 file)
1083 ;; If you do this, update dired-insert-subdir-validate too
1084 ;; ((string-match "Q" dired-actual-switches) ; GNU ls
1085 ;; (setq file (read file)))
1086 ))
1088 file
1092 ;;"Convert FILE (a pathname relative to DIR) to an absolute pathname."
1093 ;; We can't always use expand-file-name as this would get rid of `.'
1094 ;; or expand in / instead default-directory if DIR=="".
1095 ;; This should be good enough for ange-ftp, but might easily be
1096 ;; redefined (for VMS?).
1097 ;; It should be reasonably fast, though, as it is called in
1098 ;; dired-get-filename.
1102 ;;"Convert FILE (an absolute pathname) to a pathname relative to DIR.
1103 ;; Else error (unless NO-ERROR is non-nil, then FILE is returned unchanged)
1104 ;;DIR defaults to default-directory."
1105 ;; DIR must be file-name-as-directory, as with all directory args in
1106 ;; Emacs Lisp code.
1108 ;; This case comes into play if default-directory is set to
1109 ;; use ~.
1115 file
1117 \f
1118 ;;; Functions for finding the file name in a dired buffer line.
1124 ;; Move to first char of filename on this line.
1125 ;; Returns position (point) or nil if no filename on this line."
1127 ;; This is the UNIX version.
1131 dired-move-to-filename-regexp
1132 eol t)
1137 ;; Actually, if the year instead of clock time is displayed,
1138 ;; there are (only for some ls programs?) two spaces instead
1139 ;; of one before the name.
1140 ;; If we could depend on ls inserting exactly one SPC we
1141 ;; would not bomb on names _starting_ with SPC.
1145 nil)))
1148 ;; Assumes point is at beginning of filename,
1149 ;; thus the rwx bit re-search-backward below will succeed in *this*
1150 ;; line if at all. So, it should be called only after
1151 ;; (dired-move-to-filename t).
1152 ;; On failure, signals an error (with non-nil NO-ERROR just returns nil).
1153 ;; This is the UNIX version.
1155 ;; case-fold-search is nil now, so we can test for capital F:
1162 nil
1164 ;; Restrict perm bits to be non-blank,
1165 ;; otherwise this matches one char to early (looking backward):
1166 ;; "l---------" (some systems make symlinks that way)
1167 ;; "----------" (plain file with zero perms)
1170 nil t)
1173 ;; Only with -F we need to know whether it's an executable
1175 used-F
1186 ;; Move point to end of name:
1192 dired-ls-F-marks-symlinks
1196 ;; ls -lF marks dirs, sockets and executables with exactly one
1197 ;; trailing character. (Executable bits on symlinks ain't mean
1198 ;; a thing, even to ls, but we know it's not a symlink.)
1201 executable)
1210 nil
1213 \f
1214 ;; Keeping Dired buffers in sync with the filesystem and with each other
1217 ;; Enlarged by dired-advertise
1218 ;; Queried by function dired-buffers-for-dir. When this detects a
1219 ;; killed buffer, it is removed from this list.
1223 ;; Return a list of buffers that dired DIR (top level or in-situ subdir).
1224 ;; The list is in reverse order of buffer creation, most recent last.
1225 ;; As a side effect, killed dired buffers for DIR are removed from
1226 ;; dired-buffers.
1236 dired-subdir-alist))
1238 ;; else buffer is killed - clean up:
1241 result))
1244 ;;"Advertise in variable `dired-buffers' that we dired `default-directory'."
1245 ;; With wildcards we actually advertise too much.
1247 t ; we have already advertised ourselves
1250 dired-buffers))))
1253 ;; Remove DIR from the buffer alist in variable dired-buffers.
1254 ;; This has the effect of removing any buffer whose main directory is DIR.
1255 ;; It does not affect buffers in which DIR is a subdir.
1256 ;; Removing is also done as a side-effect in dired-buffer-for-dir.
1259 \f
1260 ;; Tree Dired
1262 ;;; utility functions
1265 ;;"Is FILE part of the directory tree starting at DIR?"
1270 ;; Prepend default-directory to DIR if relative path name.
1271 ;; dired-get-filename must be able to make a valid filename from a
1272 ;; file and its directory DIR.
1275 dir
1279 ;;"Return the subdir name on this line, or nil if not on a headerline."
1280 ;; Look up in the alist whether this is a headerline.
1286 dired-subdir-alist))))
1287 cur-dir))))
1289 ;(defun dired-get-subdir-min (elt)
1290 ; (cdr elt))
1291 ;; can't use macro, must be redefinable for other alist format in dired-nstd.
1305 ;; Return an index into alist for use with nth
1306 ;; for the sake of subdir moving commands.
1315 "Go to next subdirectory, regardless of level."
1316 ;; Use 0 arg to go to this directory's header line.
1317 ;; NO-SKIP prevents moving to end of header line, returning whatever
1318 ;; position was found in dired-subdir-alist.
1321 pos index)
1322 ;; nth with negative arg does not return nil but the first element
1332 nil ; return nil if not found
1336 "Build `dired-subdir-alist' by parsing the buffer.
1337 Returns the new value of the alist."
1343 new-dir-name)
1355 ;; Place a sub directory boundary between lines.
1362 ;; We don't need to sort it because it is in buffer order per
1363 ;; constructionem. Return new alist:
1364 dired-subdir-alist)))
1367 ;; Add new DIR at NEW-MARKER. Don't sort.
1370 dired-subdir-alist)))
1373 ;; Position point on first nontrivial file after point.
1389 "Go to file line of FILE in this dired buffer."
1390 ;; Return value of point on success, else nil.
1391 ;; FILE must be an absolute pathname.
1392 ;; Loses if FILE contains control chars like "\007" for which ls
1393 ;; either inserts "?" or "\\007" into the buffer, so we won't find
1394 ;; it in the buffer.
1406 ;; The hair here is to get the result of dired-goto-subdir
1407 ;; without really calling it if we don't have any subdirs.
1415 ;; filenames are preceded by SPC, this makes
1416 ;; the search faster (e.g. for the filename "-"!).
1418 ;; Match could have BASE just as initial substring or
1419 ;; or in permission bits or date or
1420 ;; not be a proper filename at all:
1422 ;; Must move to filename since an (actually
1423 ;; correct) match could have been elsewhere on the
1424 ;; ;; line (e.g. "-" would match somewhere in the
1425 ;; permission bits).
1427 ;; If this isn't the right line, move forward to avoid
1428 ;; trying this line again.
1431 ;; return value of point (i.e., FOUND):
1435 ;; Where point should go in a new listing of DIRNAME.
1436 ;; Point assumed at beginning of new subdir line.
1437 ;; You may redefine this function as you wish, e.g. like in dired-x.el.
1440 \f
1441 ;; These are hooks which make tree dired work.
1442 ;; They are in this file because other parts of dired need to call them.
1443 ;; But they don't call the rest of tree dired unless there are subdirs loaded.
1445 ;; This function is called for each retrieved filename.
1446 ;; It could stand to be faster, though it's mostly function call
1447 ;; overhead. Avoiding the function call seems to save about 10% in
1448 ;; dired-get-filename. Make it a defsubst?
1450 "Return the name of the subdirectory to which this line belongs.
1451 This returns a string with trailing slash, like `default-directory'.
1452 Optional argument means return a file name relative to `default-directory'."
1455 ;; probably because called in a non-dired buffer
1457 elt dir)
1461 ;; use `<=' (not `<') as subdir line is part of subdir
1463 nil ; found
1467 dir)))
1469 ;; Subdirs start at the beginning of their header lines and end just
1470 ;; before the beginning of the next header line (or end of buffer).
1477 \f
1478 ;; Deleting files
1481 "In dired, delete the files flagged for deletion."
1485 case-fold-search)
1489 ;; this can't move point since ARG is nil
1491 nil)
1492 nil)
1496 "Delete all marked (or next ARG) files."
1497 ;; This is more consistent with the file marking feature than
1498 ;; dired-do-flagged-delete.
1501 ;; this may move point if ARG is an integer
1503 arg)
1504 arg))
1509 ;; L is an alist of files to delete, with their buffer positions.
1510 ;; ARG is the prefix arg.
1511 ;; Filenames are absolute (VMS needs this for logical search paths).
1512 ;; (car L) *must* be the *last* (bottommost) file in the dired buffer.
1513 ;; That way as changes are made in the buffer they do not shift the
1514 ;; lines still to be changed, so the (point) values in L stay valid.
1515 ;; Also, for subdirs in natural order, a subdir's files are deleted
1516 ;; before the subdir itself - the other way around would not work.
1520 ;; canonicalize file list for pop up
1532 ;; This test is equivalent to
1533 ;; (and (file-directory-p fn) (not (file-symlink-p fn)))
1534 ;; but more efficient
1538 ;; if we get here, removing worked
1554 failures))))
1558 ;; This is a separate function for the sake of dired-x.el.
1560 ;; Clean up after a deleted file or directory FN.
1564 \f
1565 ;; Confirmation
1574 ;; Return a string for use in a prompt, either the current file
1575 ;; name, or the marker and a count of marked files.
1579 ;; more than 1 file:
1581 ;; abs(arg) = count
1582 ;; Perhaps this is nicer, but it also takes more screen space:
1583 ;;(format "[%s %d files]" (if (> arg 0) "next" "previous")
1584 ;; count)
1589 ;; Pop up buffer BUF.
1590 ;; If dired-shrink-to-fit is t, make its window fit its contents.
1593 ;; let window shrink to fit:
1595 target-lines w2)
1598 split-height-threshold)
1601 ;; if the least-recently-used window is big enough, use it
1611 ;; Don't forget to count the last line.
1615 ;; At this point, every window on the frame is too small to split.
1627 )))
1630 ;; "If non-nil, list of symbols for commands dired should not confirm.
1631 ;;It can be a sublist of
1632 ;;
1633 ;; '(byte-compile chgrp chmod chown compress copy delete hardlink load
1634 ;; move print shell symlink uncompress)"
1635 )
1638 ;;"Args BUFNAME OP-SYMBOL FILES FUNCTION &rest ARGS.
1639 ;;Return FUNCTION's result on ARGS after popping up a window (in a buffer
1640 ;;named BUFNAME, nil gives \" *Marked Files*\") showing the marked
1641 ;;files. Uses function `dired-pop-to-buffer' to do that.
1642 ;; FUNCTION should not manipulate files.
1643 ;; It should only read input (an argument or confirmation).
1644 ;;The window is not shown if there is just one file or
1645 ;; OP-SYMBOL is a member of the list in `dired-no-confirm'.
1646 ;;FILES is the list of marked files."
1660 ;; Files should be in forward order for this loop.
1661 ;; i.e., (car files) = first file in buffer.
1662 ;; Returns the number of lines used.
1684 rows))
1685 \f
1686 ;; Commands to mark or flag file(s) at or near current line.
1689 ;; This version skips non-file lines.
1700 ;; Advance to the next line--actually, to the line that *was* next.
1701 ;; (If FUNCTION inserted some new lines in between, skip them.)
1713 ;; Point must be at beginning of line
1714 ;; Should be equivalent to (save-excursion (not (dired-move-to-filename)))
1715 ;; but is about 1.5..2.0 times as fast. (Actually that's not worth it)
1720 "Move to the next marked file, wrapping around the end of the buffer."
1737 "Move to the previous marked file, wrapping around the end of the buffer."
1742 ;; Return FILE's marker, or nil if unmarked.
1756 ;; Skip subdir line and following garbage like the `total' line:
1767 "Mark the current (or next ARG) files.
1768 If on a subdir headerline, mark all its files except `.' and `..'.
1772 this subdir."
1782 "Unmark the current (or next ARG) files.
1783 If looking at a subdir, unmark all its files except `.' and `..'."
1789 "In dired, flag the current line's file for deletion.
1790 With prefix arg, repeat over several lines.
1792 If on a subdir headerline, mark all its files except `.' and `..'."
1798 "In dired, move up lines and remove deletion flag there.
1799 Optional prefix ARG says how many lines to unflag; default is one line."
1802 \f
1803 ;;; Commands to mark or flag files based on their characteristics or names.
1812 "Mark all files matching REGEXP for use in later commands.
1813 A prefix argument means to unmark them instead.
1814 `.' and `..' are never marked.
1817 object files--just `.o' will mark more than you might think."
1831 "In dired, flag all files containing the specified REGEXP for deletion.
1832 The match is against the non-directory part of the filename. Use `^'
1833 and `$' to anchor matches. Exclude subdirs by hiding them.
1834 `.' and `..' are never flagged."
1839 "Mark all symbolic links.
1840 With prefix argument, unflag all those files."
1846 "Mark all directory file lines except `.' and `..'.
1847 With prefix argument, unflag all those files."
1855 "Mark all executable files.
1856 With prefix argument, unflag all those files."
1861 ;; dired-x.el has a dired-mark-sexp interactive command: mark
1862 ;; files for which PREDICATE returns non-nil.
1865 "Flag for deletion files whose names suggest they are auto save files.
1866 A prefix argument says to unflag those files instead."
1870 ;; It is less than general to check for # here,
1871 ;; but it's the only way this runs fast enough.
1875 ;; Handle executables in case of -F option.
1876 ;; We need not worry about the other kinds
1877 ;; of markings that -F makes, since they won't
1878 ;; appear on real auto-save files.
1890 "Flag all backup files (names ending with `~') for deletion.
1891 With prefix argument, unflag these files."
1895 ;; It is less than general to check for ~ here,
1896 ;; but it's the only way this runs fast enough.
1900 ;; Handle executables in case of -F option.
1901 ;; We need not worry about the other kinds
1902 ;; of markings that -F makes, since they won't
1903 ;; appear on real backup files.
1914 "Change all OLD marks to NEW marks.
1915 OLD and NEW are both characters used to mark files."
1933 "Remove all marks from all files in the Dired buffer."
1938 "Remove a specific mark (or any mark) from every file.
1939 After this command, type the mark character to remove,
1940 or type RET to remove all marks.
1941 With prefix arg, query for each marked file.
1946 buffer-read-only case-fold-search query
1949 Type SPC or `y' to unmark one file, DEL or `n' to skip to next,
1963 count))))
1964 \f
1965 ;; Logging failures operating on files, and showing the results.
1970 "Pop up a buffer with error log output from Dired.
1971 A group of errors from a single command ends with a formfeed.
1985 ;; Log a message or the contents of a buffer.
1986 ;; If LOG is a string and there are more args, it is formatted with
1987 ;; those ARGS. Usually the LOG string ends with a \n.
1988 ;; End each bunch of errors with (dired-log t): this inserts
1989 ;; current time and buffer, and a \f (formfeed).
1999 log)))
2010 string failures)
2011 ;; Log a summary describing a bunch of errors.
2014 \f
2015 ;;; Sorting
2017 ;; Most ls can only sort by name or by date (with -t), nothing else.
2018 ;; GNU ls sorts on size with -S, on extension with -X, and unsorted with -U.
2019 ;; So anything that does not contain these is sort "by name".
2034 ;; Set modeline display according to dired-actual-switches.
2035 ;; Modeline display of "by name" or "by date" guarantees the user a
2036 ;; match with the corresponding regexps. Non-matching switches are
2037 ;; shown literally.
2046 ;; update mode line:
2050 "Toggle between sort by date/name and refresh the dired buffer.
2051 With a prefix argument you can edit the current listing switches instead."
2059 ;; Toggle between sort by date/name. Reverts the buffer.
2063 "-l"
2066 ""
2067 dired-actual-switches)
2069 dired-actual-switches)
2070 ""
2076 ;; Replace REGEXP with NEWTEXT everywhere in STRING and return result.
2077 ;; NEWTEXT is taken literally---no \\DIGIT escapes will be recognized.
2083 start me))
2087 ;; Specify new ls SWITCHES for current dired buffer. Values matching
2088 ;; `dired-sort-by-date-regexp' or `dired-sort-by-name-regexp' set the
2089 ;; minor mode accordingly, others appear literally in the mode line.
2090 ;; With optional second arg NO-REVERT, don't refresh the listing afterwards.
2094 \f
2095 ;; To make this file smaller, the less common commands
2096 ;; go in a separate file. But autoload them here
2097 ;; to make the separation invisible.
2100 "Compare file at point with file FILE using `diff'.
2101 FILE defaults to the file at the mark.
2102 The prompted-for file is the first file given to `diff'."
2103 t)
2106 "Diff this file with its backup file or vice versa.
2107 Uses the latest backup, if there are several numerical backups.
2108 If this file is a backup, diff it with its original.
2109 The backup file is the first file given to `diff'."
2110 t)
2113 "Flag numerical backups for deletion.
2114 Spares `dired-kept-versions' latest versions, and `kept-old-versions' oldest.
2115 Positive prefix arg KEEP overrides `dired-kept-versions';
2116 Negative prefix arg KEEP overrides `kept-old-versions' with KEEP made positive.
2119 with a prefix argument."
2120 t)
2123 "Change the mode of the marked (or next ARG) files.
2124 This calls chmod, thus symbolic modes like `g+w' are allowed."
2125 t)
2128 "Change the group of the marked (or next ARG) files."
2129 t)
2132 "Change the owner of the marked (or next ARG) files."
2133 t)
2136 "Print the marked (or next ARG) files.
2137 Uses the shell command coming from variables `lpr-command' and
2138 `lpr-switches' as default."
2139 t)
2142 "Run a shell command COMMAND on the marked files.
2143 If no files are marked or a specific numeric prefix arg is given,
2145 The prompt mentions the file(s) or the marker, as appropriate.
2147 If there is output, it goes to a separate buffer.
2149 Normally the command is run on each file individually.
2150 However, if there is a `*' in the command then it is run
2151 just once with the entire file list substituted there.
2153 No automatic redisplay of dired buffers is attempted, as there's no
2154 telling what files the command may have changed. Type
2157 The shell command has the top level directory as working directory, so
2158 output files usually are created there instead of in a subdir."
2159 t)
2162 "Kill all marked lines (not the files).
2163 With a prefix arg, kill all lines not marked or flagged."
2164 t)
2167 "Compress or uncompress marked (or next ARG) files."
2168 t)
2171 "Byte compile marked (or next ARG) Emacs Lisp files."
2172 t)
2175 "Load the marked (or next ARG) Emacs Lisp files."
2176 t)
2179 "Redisplay all marked (or next ARG) files.
2180 If on a subdir line, redisplay that subdirectory. In that case,
2181 a prefix arg lets you edit the `ls' switches used for the new listing."
2182 t)
2185 "Replace first match of REGEXP in STRING with NEWTEXT.
2186 If it does not match, nil is returned instead of the new string.
2187 Optional arg LITERAL means to take NEWTEXT literally.
2188 Optional arg GLOBAL means to replace all matches."
2189 t)
2192 "Create a directory called DIRECTORY."
2193 t)
2196 "Copy all marked (or next ARG) files, or copy the current file.
2197 Thus, a zero prefix argument copies nothing. But it toggles the
2198 variable `dired-copy-preserve-time' (which see)."
2199 t)
2202 "Make symbolic links to current file or all marked (or next ARG) files.
2203 When operating on just the current file, you specify the new name.
2204 When operating on multiple or marked files, you specify a directory
2205 and new symbolic links are made in that directory
2206 with the same names that the files currently have."
2207 t)
2210 "Add names (hard links) current file or all marked (or next ARG) files.
2211 When operating on just the current file, you specify the new name.
2212 When operating on multiple or marked files, you specify a directory
2213 and new hard links are made in that directory
2214 with the same names that the files currently have."
2215 t)
2218 "Rename current file or all marked (or next ARG) files.
2219 When renaming just the current file, you specify the new name.
2220 When renaming multiple or marked files, you specify a directory."
2221 t)
2224 "Rename marked files containing REGEXP to NEWNAME.
2225 As each match is found, the user must type a character saying
2228 REGEXP defaults to the last regexp used.
2229 With a zero prefix arg, renaming by regexp affects the complete
2230 pathname - usually only the non-directory part of file names is used
2231 and changed."
2232 t)
2235 "Copy all marked files containing REGEXP to NEWNAME.
2236 See function `dired-rename-regexp' for more info."
2237 t)
2240 "Hardlink all marked files containing REGEXP to NEWNAME.
2241 See function `dired-rename-regexp' for more info."
2242 t)
2245 "Symlink all marked files containing REGEXP to NEWNAME.
2246 See function `dired-rename-regexp' for more info."
2247 t)
2250 "Rename all marked (or next ARG) files to upper case."
2251 t)
2254 "Rename all marked (or next ARG) files to lower case."
2255 t)
2258 "Insert this subdirectory into the same dired buffer.
2260 else inserts it at its natural place (as `ls -lR' would have done).
2261 With a prefix arg, you may edit the ls switches used for this listing.
2262 You can add `R' to the switches to expand the whole tree starting at
2263 this subdirectory.
2264 This function takes some pains to conform to `ls -lR' output."
2265 t)
2268 "Go to next subdirectory, regardless of level."
2269 t)
2272 "Go to previous subdirectory, regardless of level.
2273 When called interactively and not on a subdir line, go to this subdir's line."
2274 t)
2277 "Go to end of header line of DIR in this dired buffer.
2278 Return value of point on success, otherwise return nil.
2280 t)
2283 "Mark all files except `.' and `..'."
2284 t)
2287 "Remove all lines of current subdirectory.
2288 Lower levels are unaffected."
2289 t)
2292 "Go up ARG levels in the dired tree."
2293 t)
2296 "Go down in the dired tree."
2297 t)
2300 "Hide or unhide the current subdirectory and move to next directory.
2301 Optional prefix arg is a repeat factor.
2303 t)
2306 "Hide all subdirectories, leaving only their header lines.
2307 If there is already something hidden, make everything visible again.
2309 t)
2310 \f
2318 ;;; dired.el ends here