diff options
| author | Juanma Barranquero | 2005-07-20 14:54:27 +0000 |
|---|---|---|
| committer | Juanma Barranquero | 2005-07-20 14:54:27 +0000 |
| commit | 6fbad7afb1ad8bd00de61208ea61e15cdfcc4450 (patch) | |
| tree | b19e2e3f7fffb1532ad927bb38b826a3c3b38f0e /lisp | |
| parent | ebfe97a2d40fa1726e429fd76750d910ade3e871 (diff) | |
| download | emacs-6fbad7afb1ad8bd00de61208ea61e15cdfcc4450.tar.gz emacs-6fbad7afb1ad8bd00de61208ea61e15cdfcc4450.zip | |
(virtual-dired): Declare with `defalias'.
(dired-mark-unmarked-files, dired-local-variables-file, dired-omit-here-always):
Doc fix.
(dired-omit-mode, dired-find-subdir, dired-enable-local-variables,
dired-clean-up-buffers-too, dired-extra-startup, dired-mark-extension,
dired-jump, dired-jump-other-window, dired-omit-localp, dired-virtual-mode,
dired-smart-shell-command, dired-guess-shell-alist-user, dired-man,
dired-initial-position, dired-x-hands-off-my-keys, dired-x-bind-find-file,
dired-x-submit-report): Fix typos in docstrings.
(dired-mark-unmarked-files): "?\ " -> "?\s".
Diffstat (limited to 'lisp')
| -rw-r--r-- | lisp/dired-x.el | 73 |
1 files changed, 37 insertions, 36 deletions
diff --git a/lisp/dired-x.el b/lisp/dired-x.el index bb536525951..006186a562e 100644 --- a/lisp/dired-x.el +++ b/lisp/dired-x.el | |||
| @@ -157,7 +157,7 @@ Read-only folders only work in VM 5, not in VM 4." | |||
| 157 | (define-minor-mode dired-omit-mode | 157 | (define-minor-mode dired-omit-mode |
| 158 | "Toggle Dired-Omit mode. | 158 | "Toggle Dired-Omit mode. |
| 159 | With numeric ARG, enable Dired-Omit mode if ARG is positive, disable | 159 | With numeric ARG, enable Dired-Omit mode if ARG is positive, disable |
| 160 | otherwise. Enabling and disabling is buffer-local. | 160 | otherwise. Enabling and disabling is buffer-local. |
| 161 | If enabled, \"uninteresting\" files are not listed. | 161 | If enabled, \"uninteresting\" files are not listed. |
| 162 | Uninteresting files are those whose filenames match regexp `dired-omit-files', | 162 | Uninteresting files are those whose filenames match regexp `dired-omit-files', |
| 163 | plus those ending with extensions in `dired-omit-extensions'." | 163 | plus those ending with extensions in `dired-omit-extensions'." |
| @@ -185,7 +185,7 @@ files and lock files." | |||
| 185 | If nil, Dired finds the directory as a subdirectory in some other buffer | 185 | If nil, Dired finds the directory as a subdirectory in some other buffer |
| 186 | if it is present as one. | 186 | if it is present as one. |
| 187 | 187 | ||
| 188 | If there are several Dired buffers for a directory, the most recently | 188 | If there are several dired buffers for a directory, the most recently |
| 189 | used is chosen. | 189 | used is chosen. |
| 190 | 190 | ||
| 191 | Dired avoids switching to the current buffer, so that if you have | 191 | Dired avoids switching to the current buffer, so that if you have |
| @@ -201,7 +201,7 @@ If nil, there is no maximum size." | |||
| 201 | :group 'dired-x) | 201 | :group 'dired-x) |
| 202 | 202 | ||
| 203 | (defcustom dired-enable-local-variables t | 203 | (defcustom dired-enable-local-variables t |
| 204 | "*Control use of local-variables lists in dired. | 204 | "*Control use of local-variables lists in Dired. |
| 205 | The value can be t, nil or something else. | 205 | The value can be t, nil or something else. |
| 206 | A value of t means local-variables lists are obeyed; | 206 | A value of t means local-variables lists are obeyed; |
| 207 | nil means they are ignored; anything else means query. | 207 | nil means they are ignored; anything else means query. |
| @@ -232,7 +232,7 @@ to nil: a pipe using `zcat' or `gunzip -c' will be used." | |||
| 232 | :group 'dired-x) | 232 | :group 'dired-x) |
| 233 | 233 | ||
| 234 | (defcustom dired-clean-up-buffers-too t | 234 | (defcustom dired-clean-up-buffers-too t |
| 235 | "*Non-nil means offer to kill buffers visiting files and dirs deleted in dired." | 235 | "*Non-nil means offer to kill buffers visiting files and dirs deleted in Dired." |
| 236 | :type 'boolean | 236 | :type 'boolean |
| 237 | :group 'dired-x) | 237 | :group 'dired-x) |
| 238 | 238 | ||
| @@ -271,7 +271,7 @@ to nil: a pipe using `zcat' or `gunzip -c' will be used." | |||
| 271 | (add-hook 'dired-after-readin-hook 'dired-omit-expunge) | 271 | (add-hook 'dired-after-readin-hook 'dired-omit-expunge) |
| 272 | 272 | ||
| 273 | (defun dired-extra-startup () | 273 | (defun dired-extra-startup () |
| 274 | "Automatically put on `dired-mode-hook' to get extra dired features: | 274 | "Automatically put on `dired-mode-hook' to get extra Dired features: |
| 275 | \\<dired-mode-map> | 275 | \\<dired-mode-map> |
| 276 | \\[dired-do-run-mail]\t-- run mail on folder (see `dired-bind-vm') | 276 | \\[dired-do-run-mail]\t-- run mail on folder (see `dired-bind-vm') |
| 277 | \\[dired-info]\t-- run info on file | 277 | \\[dired-info]\t-- run info on file |
| @@ -279,8 +279,8 @@ to nil: a pipe using `zcat' or `gunzip -c' will be used." | |||
| 279 | \\[dired-do-find-marked-files]\t-- visit all marked files simultaneously | 279 | \\[dired-do-find-marked-files]\t-- visit all marked files simultaneously |
| 280 | \\[dired-omit-mode]\t-- toggle omitting of files | 280 | \\[dired-omit-mode]\t-- toggle omitting of files |
| 281 | \\[dired-mark-sexp]\t-- mark by Lisp expression | 281 | \\[dired-mark-sexp]\t-- mark by Lisp expression |
| 282 | \\[dired-copy-filename-as-kill]\t-- copy the file or subdir names into the kill ring. | 282 | \\[dired-copy-filename-as-kill]\t-- copy the file or subdir names into the kill ring; |
| 283 | \t You can feed it to other commands using \\[yank]. | 283 | \t you can feed it to other commands using \\[yank] |
| 284 | 284 | ||
| 285 | For more features, see variables | 285 | For more features, see variables |
| 286 | 286 | ||
| @@ -357,7 +357,7 @@ Remove expanded subdir of deleted dir, if any." | |||
| 357 | ;;; Mark files with some extension. | 357 | ;;; Mark files with some extension. |
| 358 | (defun dired-mark-extension (extension &optional marker-char) | 358 | (defun dired-mark-extension (extension &optional marker-char) |
| 359 | "Mark all files with a certain EXTENSION for use in later commands. | 359 | "Mark all files with a certain EXTENSION for use in later commands. |
| 360 | A `.' is not automatically prepended to the string entered." | 360 | A `.' is *not* automatically prepended to the string entered." |
| 361 | ;; EXTENSION may also be a list of extensions instead of a single one. | 361 | ;; EXTENSION may also be a list of extensions instead of a single one. |
| 362 | ;; Optional MARKER-CHAR is marker to use. | 362 | ;; Optional MARKER-CHAR is marker to use. |
| 363 | (interactive "sMarking extension: \nP") | 363 | (interactive "sMarking extension: \nP") |
| @@ -434,7 +434,7 @@ See variables `dired-texinfo-unclean-extensions', | |||
| 434 | (defun dired-jump (&optional other-window) | 434 | (defun dired-jump (&optional other-window) |
| 435 | "Jump to dired buffer corresponding to current buffer. | 435 | "Jump to dired buffer corresponding to current buffer. |
| 436 | If in a file, dired the current directory and move to file's line. | 436 | If in a file, dired the current directory and move to file's line. |
| 437 | If in dired already, pop up a level and goto old directory's line. | 437 | If in Dired already, pop up a level and goto old directory's line. |
| 438 | In case the proper dired file line cannot be found, refresh the dired | 438 | In case the proper dired file line cannot be found, refresh the dired |
| 439 | buffer and try again." | 439 | buffer and try again." |
| 440 | (interactive "P") | 440 | (interactive "P") |
| @@ -465,7 +465,7 @@ buffer and try again." | |||
| 465 | (dired-goto-file file)))))))) | 465 | (dired-goto-file file)))))))) |
| 466 | 466 | ||
| 467 | (defun dired-jump-other-window () | 467 | (defun dired-jump-other-window () |
| 468 | "Like \\[dired-jump] (dired-jump) but in other window." | 468 | "Like \\[dired-jump] (`dired-jump') but in other window." |
| 469 | (interactive) | 469 | (interactive) |
| 470 | (dired-jump t)) | 470 | (dired-jump t)) |
| 471 | 471 | ||
| @@ -478,7 +478,7 @@ buffer and try again." | |||
| 478 | ;; sk 28-Aug-1991 09:37 | 478 | ;; sk 28-Aug-1991 09:37 |
| 479 | (defvar dired-omit-localp 'no-dir | 479 | (defvar dired-omit-localp 'no-dir |
| 480 | "The LOCALP argument `dired-omit-expunge' passes to `dired-get-filename'. | 480 | "The LOCALP argument `dired-omit-expunge' passes to `dired-get-filename'. |
| 481 | If it is 'no-dir, omitting is much faster, but you can only match | 481 | If it is `no-dir', omitting is much faster, but you can only match |
| 482 | against the non-directory part of the file name. Set it to nil if you | 482 | against the non-directory part of the file name. Set it to nil if you |
| 483 | need to match the entire file name.") | 483 | need to match the entire file name.") |
| 484 | 484 | ||
| @@ -569,9 +569,9 @@ This functions works by temporarily binding `dired-marker-char' to | |||
| 569 | REGEXP is matched against the entire file name. | 569 | REGEXP is matched against the entire file name. |
| 570 | Does not re-mark files which already have a mark. | 570 | Does not re-mark files which already have a mark. |
| 571 | With prefix argument, unflag all those files. | 571 | With prefix argument, unflag all those files. |
| 572 | Second optional argument LOCALP is as in `dired-get-filename'." | 572 | Optional fourth argument LOCALP is as in `dired-get-filename'." |
| 573 | (interactive "P") | 573 | (interactive "P") |
| 574 | (let ((dired-marker-char (if unflag-p ?\ dired-marker-char))) | 574 | (let ((dired-marker-char (if unflag-p ?\s dired-marker-char))) |
| 575 | (dired-mark-if | 575 | (dired-mark-if |
| 576 | (and | 576 | (and |
| 577 | ;; not already marked | 577 | ;; not already marked |
| @@ -621,7 +621,7 @@ Second optional argument LOCALP is as in `dired-get-filename'." | |||
| 621 | 621 | ||
| 622 | ;;; For browsing `ls -lR' listings in a dired-like fashion. | 622 | ;;; For browsing `ls -lR' listings in a dired-like fashion. |
| 623 | 623 | ||
| 624 | (fset 'virtual-dired 'dired-virtual) | 624 | (defalias 'virtual-dired 'dired-virtual) |
| 625 | (defun dired-virtual (dirname &optional switches) | 625 | (defun dired-virtual (dirname &optional switches) |
| 626 | "Put this buffer into Virtual Dired mode. | 626 | "Put this buffer into Virtual Dired mode. |
| 627 | 627 | ||
| @@ -638,10 +638,10 @@ buffer. | |||
| 638 | If you have save a Dired buffer in a file you can use \\[dired-virtual] to | 638 | If you have save a Dired buffer in a file you can use \\[dired-virtual] to |
| 639 | resume it in a later session. | 639 | resume it in a later session. |
| 640 | 640 | ||
| 641 | Type \\<dired-mode-map>\\[revert-buffer] in the | 641 | Type \\<dired-mode-map>\\[revert-buffer] \ |
| 642 | Virtual Dired buffer and answer `y' to convert the virtual to a real | 642 | in the Virtual Dired buffer and answer `y' to convert |
| 643 | dired buffer again. You don't have to do this, though: you can relist | 643 | the virtual to a real dired buffer again. You don't have to do this, though: |
| 644 | single subdirs using \\[dired-do-redisplay]." | 644 | you can relist single subdirs using \\[dired-do-redisplay]." |
| 645 | 645 | ||
| 646 | ;; DIRNAME is the top level directory of the buffer. It will become | 646 | ;; DIRNAME is the top level directory of the buffer. It will become |
| 647 | ;; its `default-directory'. If nil, the old value of | 647 | ;; its `default-directory'. If nil, the old value of |
| @@ -725,12 +725,12 @@ nil." | |||
| 725 | ;; `buffer-contents-mode-alist'. | 725 | ;; `buffer-contents-mode-alist'. |
| 726 | ;; Or you use infer-mode.el and infer-mode-alist, same syntax. | 726 | ;; Or you use infer-mode.el and infer-mode-alist, same syntax. |
| 727 | (defun dired-virtual-mode () | 727 | (defun dired-virtual-mode () |
| 728 | "Put current buffer into virtual dired mode (see `dired-virtual'). | 728 | "Put current buffer into Virtual Dired mode (see `dired-virtual'). |
| 729 | Useful on `buffer-contents-mode-alist' (which see) with the regexp | 729 | Useful on `buffer-contents-mode-alist' (which see) with the regexp |
| 730 | 730 | ||
| 731 | \"^ \\(/[^ /]+\\)/?+:$\" | 731 | \"^ \\(/[^ /]+\\)/?+:$\" |
| 732 | 732 | ||
| 733 | to put saved dired buffers automatically into virtual dired mode. | 733 | to put saved dired buffers automatically into Virtual Dired mode. |
| 734 | 734 | ||
| 735 | Also useful for `auto-mode-alist' (which see) like this: | 735 | Also useful for `auto-mode-alist' (which see) like this: |
| 736 | 736 | ||
| @@ -768,7 +768,7 @@ Knows about the special cases in variable `default-directory-alist'." | |||
| 768 | default-directory)) | 768 | default-directory)) |
| 769 | 769 | ||
| 770 | (defun dired-smart-shell-command (cmd &optional insert) | 770 | (defun dired-smart-shell-command (cmd &optional insert) |
| 771 | "Like function `shell-command', but in the current Tree Dired directory." | 771 | "Like function `shell-command', but in the current Virtual Dired directory." |
| 772 | (interactive (list (read-from-minibuffer "Shell command: " | 772 | (interactive (list (read-from-minibuffer "Shell command: " |
| 773 | nil nil nil 'shell-command-history) | 773 | nil nil nil 'shell-command-history) |
| 774 | current-prefix-arg)) | 774 | current-prefix-arg)) |
| @@ -800,8 +800,9 @@ Knows about the special cases in variable `default-directory-alist'." | |||
| 800 | (defvar dired-local-variables-file (convert-standard-filename ".dired") | 800 | (defvar dired-local-variables-file (convert-standard-filename ".dired") |
| 801 | "Filename, as string, containing local dired buffer variables to be hacked. | 801 | "Filename, as string, containing local dired buffer variables to be hacked. |
| 802 | If this file found in current directory, then it will be inserted into dired | 802 | If this file found in current directory, then it will be inserted into dired |
| 803 | buffer and `hack-local-variables' will be run. See Emacs Info pages for more | 803 | buffer and `hack-local-variables' will be run. See Info node |
| 804 | information on local variables. See also `dired-enable-local-variables'.") | 804 | `(emacs)File Variables' for more information on local variables. |
| 805 | See also `dired-enable-local-variables'.") | ||
| 805 | 806 | ||
| 806 | (defun dired-hack-local-variables () | 807 | (defun dired-hack-local-variables () |
| 807 | "Evaluate local variables in `dired-local-variables-file' for dired buffer." | 808 | "Evaluate local variables in `dired-local-variables-file' for dired buffer." |
| @@ -828,7 +829,7 @@ information on local variables. See also `dired-enable-local-variables'.") | |||
| 828 | 829 | ||
| 829 | (defun dired-omit-here-always () | 830 | (defun dired-omit-here-always () |
| 830 | "Create `dired-local-variables-file' for omitting and reverts directory. | 831 | "Create `dired-local-variables-file' for omitting and reverts directory. |
| 831 | Sets dired-omit-file-p to t in a local variables file that is readable by | 832 | Sets `dired-omit-mode' to t in a local variables file that is readable by |
| 832 | dired." | 833 | dired." |
| 833 | (interactive) | 834 | (interactive) |
| 834 | (if (file-exists-p dired-local-variables-file) | 835 | (if (file-exists-p dired-local-variables-file) |
| @@ -1024,7 +1025,7 @@ Each element of this list looks like | |||
| 1024 | 1025 | ||
| 1025 | \(REGEXP COMMAND...\) | 1026 | \(REGEXP COMMAND...\) |
| 1026 | 1027 | ||
| 1027 | where each COMMAND can either be a string or a lisp expression that evaluates | 1028 | where each COMMAND can either be a string or a Lisp expression that evaluates |
| 1028 | to a string. If several COMMANDs are given, the first one will be the default | 1029 | to a string. If several COMMANDs are given, the first one will be the default |
| 1029 | and the rest will be added temporarily to the history and can be retrieved | 1030 | and the rest will be added temporarily to the history and can be retrieved |
| 1030 | with \\[previous-history-element] (M-p) . | 1031 | with \\[previous-history-element] (M-p) . |
| @@ -1321,7 +1322,7 @@ NOSELECT the files are merely found but not selected." | |||
| 1321 | 1322 | ||
| 1322 | (defun dired-man () | 1323 | (defun dired-man () |
| 1323 | "Run man on this file. Display old buffer if buffer name matches filename. | 1324 | "Run man on this file. Display old buffer if buffer name matches filename. |
| 1324 | Uses ../lisp/man.el of \\[manual-entry] fame." | 1325 | Uses `man.el' of \\[manual-entry] fame." |
| 1325 | (interactive) | 1326 | (interactive) |
| 1326 | (require 'man) | 1327 | (require 'man) |
| 1327 | (let* ((file (dired-get-filename)) | 1328 | (let* ((file (dired-get-filename)) |
| @@ -1441,7 +1442,7 @@ See also variable `dired-vm-read-only-folders'." | |||
| 1441 | (defun dired-initial-position (dirname) | 1442 | (defun dired-initial-position (dirname) |
| 1442 | "Where point should go in a new listing of DIRNAME. | 1443 | "Where point should go in a new listing of DIRNAME. |
| 1443 | Point assumed at beginning of new subdir line. | 1444 | Point assumed at beginning of new subdir line. |
| 1444 | You may redefine this function as you wish, e.g. like in dired-x.el." | 1445 | You may redefine this function as you wish, e.g. like in `dired-x.el'." |
| 1445 | (end-of-line) | 1446 | (end-of-line) |
| 1446 | (if dired-find-subdir (dired-goto-subdir dirname)) ; new | 1447 | (if dired-find-subdir (dired-goto-subdir dirname)) ; new |
| 1447 | (if dired-trivial-filenames (dired-goto-next-nontrivial-file))) | 1448 | (if dired-trivial-filenames (dired-goto-next-nontrivial-file))) |
| @@ -1550,7 +1551,7 @@ to mark all zero length files." | |||
| 1550 | (defvar dired-x-hands-off-my-keys t | 1551 | (defvar dired-x-hands-off-my-keys t |
| 1551 | "*Non-nil means don't bind `dired-x-find-file' over `find-file' on keyboard. | 1552 | "*Non-nil means don't bind `dired-x-find-file' over `find-file' on keyboard. |
| 1552 | Similarly for `dired-x-find-file-other-window' over `find-file-other-window'. | 1553 | Similarly for `dired-x-find-file-other-window' over `find-file-other-window'. |
| 1553 | If you change this variable after dired-x.el is loaded then do | 1554 | If you change this variable after `dired-x.el' is loaded then do |
| 1554 | \\[dired-x-bind-find-file].") | 1555 | \\[dired-x-bind-find-file].") |
| 1555 | 1556 | ||
| 1556 | ;;; Bind `dired-x-find-file{-other-window}' over wherever | 1557 | ;;; Bind `dired-x-find-file{-other-window}' over wherever |
| @@ -1559,7 +1560,7 @@ If you change this variable after dired-x.el is loaded then do | |||
| 1559 | "Bind `dired-x-find-file' in place of `find-file' \(or reverse\). | 1560 | "Bind `dired-x-find-file' in place of `find-file' \(or reverse\). |
| 1560 | Similarly for `dired-x-find-file-other-window' and `find-file-other-window'. | 1561 | Similarly for `dired-x-find-file-other-window' and `find-file-other-window'. |
| 1561 | Binding direction based on `dired-x-hands-off-my-keys'. | 1562 | Binding direction based on `dired-x-hands-off-my-keys'. |
| 1562 | This function part of `after-init-hook'." | 1563 | This function is part of `after-init-hook'." |
| 1563 | (interactive) | 1564 | (interactive) |
| 1564 | (if (interactive-p) | 1565 | (if (interactive-p) |
| 1565 | (setq dired-x-hands-off-my-keys | 1566 | (setq dired-x-hands-off-my-keys |
| @@ -1592,9 +1593,9 @@ May create a new window, or reuse an existing one. | |||
| 1592 | See the function `display-buffer'. | 1593 | See the function `display-buffer'. |
| 1593 | 1594 | ||
| 1594 | Identical to `find-file' except when called interactively, with a prefix arg | 1595 | Identical to `find-file' except when called interactively, with a prefix arg |
| 1595 | \(e.g., \\[universal-argument]\), in which case it guesses filename near | 1596 | \(e.g., \\[universal-argument]\), in which case it guesses filename near point. |
| 1596 | point. Useful for editing file mentioned in buffer you are viewing, or to | 1597 | Useful for editing file mentioned in buffer you are viewing, |
| 1597 | test if that file exists. Use minibuffer after snatching filename." | 1598 | or to test if that file exists. Use minibuffer after snatching filename." |
| 1598 | (interactive (list (read-filename-at-point "Find file: "))) | 1599 | (interactive (list (read-filename-at-point "Find file: "))) |
| 1599 | (find-file (expand-file-name filename))) | 1600 | (find-file (expand-file-name filename))) |
| 1600 | 1601 | ||
| @@ -1604,9 +1605,9 @@ May create a new window, or reuse an existing one. | |||
| 1604 | See the function `display-buffer'. | 1605 | See the function `display-buffer'. |
| 1605 | 1606 | ||
| 1606 | Identical to `find-file-other-window' except when called interactively, with a | 1607 | Identical to `find-file-other-window' except when called interactively, with a |
| 1607 | prefix arg \(e.g., \\[universal-argument]\), in which case it guesses filename | 1608 | prefix arg \(e.g., \\[universal-argument]\), in which case it guesses filename near point. |
| 1608 | near point. Useful for editing file mentioned in buffer you are viewing, or | 1609 | Useful for editing file mentioned in buffer you are viewing, |
| 1609 | to test if that file exists. Use minibuffer after snatching filename." | 1610 | or to test if that file exists. Use minibuffer after snatching filename." |
| 1610 | (interactive (list (read-filename-at-point "Find file: "))) | 1611 | (interactive (list (read-filename-at-point "Find file: "))) |
| 1611 | (find-file-other-window (expand-file-name filename))) | 1612 | (find-file-other-window (expand-file-name filename))) |
| 1612 | 1613 | ||
| @@ -1695,7 +1696,7 @@ If `current-prefix-arg' is non-nil, uses name at point as guess." | |||
| 1695 | "List of variables to be appended to reports sent by `dired-x-submit-report'.") | 1696 | "List of variables to be appended to reports sent by `dired-x-submit-report'.") |
| 1696 | 1697 | ||
| 1697 | (defun dired-x-submit-report () | 1698 | (defun dired-x-submit-report () |
| 1698 | "Submit via reporter.el a bug report on program. | 1699 | "Submit via `reporter.el' a bug report on program. |
| 1699 | Send report on `dired-x-file' version `dired-x-version,' to | 1700 | Send report on `dired-x-file' version `dired-x-version,' to |
| 1700 | `dired-x-maintainer' at address `dired-x-help-address' listing | 1701 | `dired-x-maintainer' at address `dired-x-help-address' listing |
| 1701 | variables `dired-x-variable-list' in the message." | 1702 | variables `dired-x-variable-list' in the message." |