@comment %**end of header (This is for running Texinfo on a region.)
@copying
-Copyright @copyright{} 1994-1995, 1999, 2001-2011
+Copyright @copyright{} 1994--1995, 1999, 2001--2013
Free Software Foundation, Inc.
@quotation
is included in the section entitled ``GNU Free Documentation License''.
(a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
-modify this GNU manual. Buying copies from the FSF supports it in
-developing GNU and promoting software freedom.''
+modify this GNU manual.''
@end quotation
@end copying
@end ifnottex
-@node Introduction, Installation, Top, Top
+@node Introduction
@chapter Introduction
This documents some @emph{extra} features for GNU Emacs's Dired Mode
@end menu
@end ifnottex
-@node Features, Technical Details, , Introduction
+@node Features
@section Features
@cindex Features
-Some features provided by Dired Extra
+Some features provided by Dired Extra:
@enumerate
@item
-Omitting uninteresting files from Dired listing.
-@itemize @bullet
-@xref{Omitting Files in Dired}.
-@end itemize
-@item
-Local variables for Dired directories.
-@itemize @bullet
-@xref{Local Variables}.
-@end itemize
+Omitting uninteresting files from Dired listing
+(@pxref{Omitting Files in Dired}).
@item
-Guessing shell commands in Dired buffers.
-@itemize @bullet
-@xref{Shell Command Guessing}.
-@end itemize
+Guessing shell commands in Dired buffers
+(@pxref{Shell Command Guessing}).
@item
-Running Dired command in non-Dired buffers.
-@itemize @bullet
-@xref{Virtual Dired}.
-@end itemize
+Running Dired command in non-Dired buffers
+(@pxref{Virtual Dired}).
@item
Finding a file mentioned in a buffer
-@itemize @bullet
-@xref{Find File At Point}.
-@end itemize
+(@pxref{Find File At Point}).
@item
-Commands using file marking.
-@itemize @bullet
-@xref{Advanced Mark Commands}.
-@end itemize
+Commands using file marking
+(@pxref{Advanced Mark Commands}).
@end enumerate
@noindent
@file{dired-x.el} binds some functions to keys in Dired Mode (@pxref{Key
Index}) and also binds @kbd{C-x C-j} and @kbd{C-x 4 C-j} @emph{globally} to
-@code{dired-jump} (@pxref{Miscellaneous Commands}). It may also bind @kbd{C-x
-C-f} and @kbd{C-x 4 C-f} to @code{dired-x-find-file} and
-@code{dired-x-find-file-other-window}, respectively (@pxref{Find File At
-Point}).
+@code{dired-jump} (@pxref{Miscellaneous Commands}). Optionally, it
+also binds @kbd{C-x C-f} and @kbd{C-x 4 C-f} to
+@code{dired-x-find-file} and @code{dired-x-find-file-other-window},
+respectively (@pxref{Find File At Point}).
-@node Technical Details, , Features, Introduction
+@node Technical Details
@section Technical Details
@cindex Modified functions
@cindex @file{dired-aux.el}
@code{dired-guess-shell-command} (@pxref{Shell Command Guessing}) to
offer a smarter default command.
-@node Installation, Omitting Files in Dired, Introduction, Top
+@node Installation
@chapter Installation
@noindent
@end menu
@end ifnottex
-@node Optional Installation Dired Jump, Optional Installation File At Point, , Installation
+@node Optional Installation Dired Jump
@section Optional Installation Dired Jump
@cindex Autoloading @code{dired-jump} and @code{dired-jump-other-window}
(define-key global-map "\C-x4\C-j" 'dired-jump-other-window)
@end example
-@node Optional Installation File At Point, , Optional Installation Dired Jump, Installation
+@node Optional Installation File At Point
@section Optional Installation File At Point
@cindex Binding @code{dired-x-find-file}
))
@end example
-@node Omitting Files in Dired, Local Variables, Installation, Top
+@node Omitting Files in Dired
@chapter Omitting Files in Dired
@cindex Omitting Files in Dired
@end menu
@end ifnottex
-@node Omitting Variables, Omitting Examples, , Omitting Files in Dired
+@node Omitting Variables
@section Omitting Variables
@cindex Customizing file omitting
@emph{every} Dired buffer (@pxref{Installation}). You can then use @kbd{M-o} to
unomit in that buffer.
-To enable omitting automatically only in certain directories one can use Dired
-Local Variables and put
+To enable omitting automatically only in certain directories you can add
+a directory local setting
+(@pxref{Directory Variables,,,emacs,The Gnu Emacs manual}) for Dired mode
@example
-Local Variables:
-dired-omit-mode: t
-End:
+((dired-mode . ((dired-omit-mode . t))))
@end example
@noindent
-into a file @file{.dired} (the default value of
-@code{dired-local-variables-file}) in that directory (@pxref{Local Variables}).
-
-@table @code
-@findex dired-omit-here-always
-@item dired-omit-here-always
-
-This is an interactive function that creates a local variables file exactly
-like the example above (if it does not already exist) in the file
-@code{dired-local-variables-file} in the current directory and then refreshes
-the directory listing (@pxref{Local Variables}).
-@end table
+to a @file{.dir-locals.el} file in that directory. You can use the
+command @code{add-dir-local-variable} to do this.
@vindex dired-omit-files
@item dired-omit-files
@end table
-@node Omitting Examples, Omitting Technical, Omitting Variables, Omitting Files in Dired
+@node Omitting Examples
@section Examples of Omitting Various File Types
@itemize @bullet
@cindex Tib files, how to omit them in Dired
@cindex Omitting tib files in Dired
If you use @code{tib}, the bibliography program for use with @TeX{} and
-La@TeX{}, and you
+@LaTeX{}, and you
want to omit the @file{INDEX} and the @file{*-t.tex} files, then put
@example
@end example
@noindent
-in the @code{dired-load-hook} (@pxref{Installation}).
+in the @code{dired-load-hook} (@pxref{Installation}). (Of course, a
+better way to achieve this particular goal is simply to omit @samp{-a} from
+@code{dired-listing-switches}.)
@end itemize
-@node Omitting Technical, , Omitting Examples, Omitting Files in Dired
+@node Omitting Technical
@section Some Technical Details of Omitting
Loading @file{dired-x.el} will install Dired Omit by putting
call @code{dired-extra-startup}, which in turn calls @code{dired-omit-startup}
in your @code{dired-mode-hook}.
-@c FIXME does the standard dir-locals mechanism obsolete this?
-@node Local Variables, Shell Command Guessing, Omitting Files in Dired, Top
+@node Local Variables
@chapter Local Variables for Dired Directories
@cindex Local Variables for Dired Directories
@vindex dired-local-variables-file
@vindex dired-enable-local-variables
@noindent
-When Dired visits a directory, it looks for a file whose name is the value of
-variable @code{dired-local-variables-file} (default: @file{.dired}). If such
-a file is found, Dired will temporarily insert it into the Dired buffer and
-run @code{hack-local-variables}.
+This Dired-X feature is obsolete as of Emacs 24.1. The standard Emacs
+directory local variables mechanism (@pxref{Directory
+Variables,,,emacs,The Gnu Emacs manual}) replaces it. For an example of
+the new mechanisms, @pxref{Omitting Variables}.
+
+When Dired visits a directory, it looks for a file whose name is the
+value of variable @code{dired-local-variables-file} (default: @file{.dired}).
+If such a file is found, Dired will temporarily insert it into the Dired
+buffer and run @code{hack-local-variables}.
@noindent
For example, if the user puts
@noindent
You can set @code{dired-local-variables-file} to @code{nil} to suppress this.
The value of @code{dired-enable-local-variables} controls if and how these
-local variables are read. This variable exists so that if may override the
+local variables are read. This variable exists so that it may override the
default value of @code{enable-local-variables}.
@noindent
@item dired-enable-local-variables
Default: @code{t}
-Controls the use of local-variables lists in Dired. The value can be @code{t},
-@code{nil}, or something else. A value of @code{t} means local-variables
-lists are obeyed in the @code{dired-local-variables-file}; @code{nil} means
-they are ignored; anything else means query. This variable temporarily
-overrides the value of @code{enable-local-variables} when the Dired Local
-Variables are hacked.
+Controls the use of local-variables lists in Dired. This variable
+temporarily overrides the value of @code{enable-local-variables} when
+the Dired Local Variables are hacked. It takes the same values as that
+variable. A value of @code{nil} means to ignore any Dired Local Variables.
@end table
-@node Shell Command Guessing, Virtual Dired, Local Variables, Top
+@node Shell Command Guessing
@chapter Shell Command Guessing
@cindex Guessing shell commands for files.
History list for commands that read dired-shell commands.
@end table
-@node Virtual Dired, Advanced Mark Commands, Shell Command Guessing, Top
+@node Virtual Dired
@chapter Virtual Dired
@cindex Virtual Dired
The regexp is a bit more complicated than usual to exclude @file{.dired}
local-variable files.
-@node Advanced Mark Commands, Multiple Dired Directories, Virtual Dired, Top
+@node Advanced Mark Commands
@chapter Advanced Mark Commands
@table @kbd
@end menu
@end ifnottex
-@node Advanced Cleaning Functions, Advanced Cleaning Variables, , Advanced Mark Commands
+@node Advanced Cleaning Functions
@section Advanced Cleaning Functions
@table @code
@item dired-clean-tex
@findex dired-clean-tex
-Flag dispensable files created by @TeX{}, La@TeX{}, and @samp{texinfo} for
+Flag dispensable files created by @TeX{}, @LaTeX{}, and @samp{texinfo} for
deletion. See the following variables (@pxref{Advanced Cleaning Variables}):
@itemize @bullet
@item dired-very-clean-tex
@findex dired-very-clean-tex
-Flag dispensable files created by @TeX{}, La@TeX{}, @samp{texinfo},
+Flag dispensable files created by @TeX{}, @LaTeX{}, @samp{texinfo},
and @file{*.dvi} files for deletion.
@end table
-@node Advanced Cleaning Variables, Special Marking Function, Advanced Cleaning Functions, Advanced Mark Commands
+@node Advanced Cleaning Variables
@section Advanced Cleaning Variables
@noindent Variables used by the above cleaning commands (and in the default value for
@vindex dired-latex-unclean-extensions
Default: @code{(".idx" ".lof" ".lot" ".glo")}
-List of extensions of dispensable files created by La@TeX{}.
+List of extensions of dispensable files created by @LaTeX{}.
@item dired-bibtex-unclean-extensions
@vindex dired-bibtex-unclean-extensions
List of extensions of dispensable files created by Bib@TeX{}.
@end table
-@node Special Marking Function, , Advanced Cleaning Variables, Advanced Mark Commands
+@node Special Marking Function
@section Special Marking Function
@table @kbd
@end table
-@node Multiple Dired Directories, Find File At Point, Advanced Mark Commands, Top
+@node Multiple Dired Directories
@chapter Multiple Dired Directories and Non-Dired Commands
@cindex Multiple Dired directories
directory instead of @code{default-directory}, e.g., @code{find-file} and
@code{compile}.
-A general mechanism is provided for special handling of the working
-directory in special major modes:
-
-@table @code
-@item dired-default-directory-alist
-@vindex dired-default-directory-alist
-Default: @code{((dired-mode . (dired-current-directory)))}
-
-Alist of major modes and their notion of @code{default-directory}, as a
-Lisp expression to evaluate. A resulting value of @code{nil} is ignored
-in favor of @code{default-directory}.
-
-@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{dired-default-directory-alist}.
-@end table
+@findex dired-smart-shell-command
+@findex shell-command
+@kindex M-!
+The command @code{dired-smart-shell-command}, bound to @kbd{M-!} in
+Dired buffers, is like @code{shell-command}, but it runs with
+@code{default-directory} bound to the current Dired directory.
-@node Find File At Point, Miscellaneous Commands, Multiple Dired Directories, Top
-@section Find File At Point
+@node Find File At Point
+@chapter Find File At Point
@cindex Visiting a file mentioned in a buffer
@cindex Finding a file at point
@file{dired-x} provides a method of visiting or editing a file mentioned in
the buffer you are viewing (e.g., a mail buffer, a news article, a
-@file{README} file, etc.) or to test if that file exists. You can then modify
+@file{README} file, etc.)@: or to test if that file exists. You can then modify
this in the minibuffer after snatching the file name.
When installed @file{dired-x} will substitute @code{dired-x-find-file} for
@code{find-file-other-window}. See @xref{Optional Installation File At Point}.
@end table
-@node Miscellaneous Commands, Bugs, Find File At Point, Top
+@node Miscellaneous Commands
@chapter Miscellaneous Commands
Miscellaneous features not fitting anywhere else:
@end table
@table @code
-@item dired-smart-shell-command
-@findex dired-smart-shell-command
-@findex shell-command
-@kindex M-!
-Like function @code{shell-command}, but in the current Dired directory.
-Bound to @kbd{M-!} in Dired buffers.
@item dired-jump
@findex dired-jump
info.
@end table
-@node Bugs, GNU Free Documentation License, Miscellaneous Commands, Top
+@node Bugs
@chapter Bugs
@cindex Bugs
If you encounter a bug in this package, or wish to suggest an
enhancement, then please use @kbd{M-x report-emacs-bug} to report it.
-@node GNU Free Documentation License, Concept Index, Bugs, Top
+@node GNU Free Documentation License
@appendix GNU Free Documentation License
@include doclicense.texi
-@node Concept Index, Command Index, GNU Free Documentation License, Top
+@node Concept Index
@unnumbered Concept Index
@printindex cp
-@node Command Index, Key Index, Concept Index, Top
+@node Command Index
@unnumbered Function Index
@printindex fn
-@node Key Index, Variable Index, Command Index, Top
+@node Key Index
@unnumbered Key Index
@printindex ky
-@node Variable Index, , Key Index, Top
+@node Variable Index
@unnumbered Variable Index
@printindex vr