This documents the ``extra'' features for Dired Mode for GNU Emacs found in
the file @file{dired-x.el}.
-Copyright @copyright{} 1993, 1994, 2001, 2002 Free Software Foundation, Inc.
+Copyright @copyright{} 1993, 1994, 2001, 2002, 2003, 2004,
+2005, 2006 Free Software Foundation, Inc.
@quotation
Permission is granted to make and distribute verbatim copies of this
@page
-@ifinfo
+@ifnottex
@node Top
@comment node-name, next, previous, up
@end menu
-@end ifinfo
+@end ifnottex
@node Introduction, Installation, Top, Top
@comment node-name, next, previous, up
the mini-buffer history now built into GNU Emacs. Finally, a few other
features have been added and a few more functions have been bound to keys.
-@ifinfo
+@ifnottex
@menu
* Features::
* Technical Details::
@end menu
-@end ifinfo
+@end ifnottex
@node Features, Technical Details, , Introduction
@comment node-name, next, previous, up
This will load @file{dired-x.el} when Dired is first invoked (for example,
when you first type @kbd{C-x d}).
-@ifinfo
+@ifnottex
@menu
* Optional Installation Dired Jump::
* Optional Installation File At Point::
@end menu
-@end ifinfo
+@end ifnottex
@node Optional Installation Dired Jump, Optional Installation File At Point, , Installation
@comment node-name, next, previous, up
for these functions. In your @file{.emacs} file put
@example
-;;; Autoload `dired-jump' and `dired-jump-other-window'.
-;;; We autoload from FILE dired.el. This will then load dired-x.el
-;;; and hence define `dired-jump' and `dired-jump-other-window'.
+;; Autoload `dired-jump' and `dired-jump-other-window'.
+;; We autoload from FILE dired.el. This will then load dired-x.el
+;; and hence define `dired-jump' and `dired-jump-other-window'.
(define-key global-map "\C-x\C-j" 'dired-jump)
(define-key global-map "\C-x4\C-j" 'dired-jump-other-window)
@findex dired-omit-mode
(@code{dired-omit-mode}) Toggle between displaying and omitting
``uninteresting'' files.
-@item M-O
-@kindex M-O
+@item * O
+@kindex * O
@findex dired-mark-omitted
(@code{dired-mark-omitted}) Mark ``uninteresting'' files.
@end table
inside @code{dired-load-hook} (@pxref{Installation}) and then evaluate
@code{(dired-omit-mode 1)} in some way (@pxref{Omitting Variables}).
-@ifinfo
+@ifnottex
@menu
* Omitting Variables::
* Omitting Examples::
* Omitting Technical::
@end menu
-@end ifinfo
+@end ifnottex
@node Omitting Variables, Omitting Examples, , Omitting Files in Dired
@comment node-name, next, previous, up
@emph{not} automatically prepended to the string entered.
@end table
-@ifinfo
+@ifnottex
@menu
* Advanced Cleaning Functions::
* Advanced Cleaning Variables::
* Special Marking Function::
@end menu
-@end ifinfo
+@end ifnottex
@node Advanced Cleaning Functions, Advanced Cleaning Variables, , Advanced Mark Commands
@comment node-name, next, previous, up
Lisp expression to evaluate. A resulting value of @code{nil} is ignored
in favor of @code{default-directory}.
-@item default-directory
-@findex default-directory
-Function with usage like variable @code{default-directory}, but knows about the
-special cases in variable @code{default-directory-alist}.
+@item dired-default-directory
+@findex dired-default-directory
+Use this function like you would use the variable
+@code{default-directory}, except that @code{dired-default-directory}
+also consults the variable @code{default-directory-alist}.
@end table
@node Find File At Point, Miscellaneous Commands, Multiple Dired Directories, Top
@cindex Reading mail.
@kindex V
@findex dired-vm
-Bound to @kbd{V} if @code{dired-bind-vm} is t. Run VM on this file (assumed
-to be a UNIX mail folder).
+Bound to @kbd{V} if @code{dired-bind-vm} is @code{t}. Run VM on this
+file (assumed to be a UNIX mail folder).
@vindex dired-vm-read-only-folders
If you give this command a prefix argument, it will visit the folder
visited read-only. This is the recommended value if you run VM 5.
@vindex dired-bind-vm
-If the variable @code{dired-bind-vm} is t, @code{dired-vm} will be bound to
-@kbd{V}. Otherwise, @code{dired-bind-rmail} will be bound.
+If the variable @code{dired-bind-vm} is @code{t}, @code{dired-vm} will be bound
+to @kbd{V}. Otherwise, @code{dired-bind-rmail} will be bound.
@item dired-rmail
@cindex Reading mail.
If the variable @code{dired-bind-man} is @code{nil}, @code{dired-man} will not
be bound to @kbd{N}.
-@item dired-do-relative-symlink
+@item dired-do-relsymlink
@cindex Relative symbolic links.
@kindex Y
-@findex dired-do-relative-symlink
+@findex dired-do-relsymlink
Bound to @kbd{Y}. Relative symlink all marked (or next ARG) files into a
directory, or make a relative symbolic link to the current file. This creates
relative symbolic links like
foo -> /ugly/path/that/may/change/any/day/bar/foo
@end example
-@item dired-do-relative-symlink-regexp
+@item dired-do-relsymlink-regexp
@kindex %Y
-@findex dired-do-relative-symlink-regexp
+@findex dired-do-relsymlink-regexp
Bound to @kbd{%Y}. Relative symlink all marked files containing
@var{regexp} to @var{newname}. See functions
@code{dired-do-rename-regexp} and @code{dired-do-relsymlink} for more