From 07ca555579fd4210c6ac6b487b6a491dc8c66562 Mon Sep 17 00:00:00 2001 From: Glenn Morris Date: Sun, 13 Feb 2011 17:37:55 -0800 Subject: Misc updates for dired-x.texi. * doc/misc/dired-x.texi: Drop meaningless version number. (Introduction): Remove old info. (Optional Installation Dired Jump): Autoload from dired-x. Remove incorrect info about loaddefs.el. (Bugs): Just refer to M-x report-emacs-bug. --- doc/misc/ChangeLog | 8 ++++ doc/misc/dired-x.texi | 123 ++++++++------------------------------------------ 2 files changed, 27 insertions(+), 104 deletions(-) diff --git a/doc/misc/ChangeLog b/doc/misc/ChangeLog index d87bb9f8dc..172c618767 100644 --- a/doc/misc/ChangeLog +++ b/doc/misc/ChangeLog @@ -1,3 +1,11 @@ +2011-02-14 Glenn Morris + + * dired-x.texi: Drop meaningless version number. + (Introduction): Remove old info. + (Optional Installation Dired Jump): Autoload from dired-x. + Remove incorrect info about loaddefs.el. + (Bugs): Just refer to M-x report-emacs-bug. + 2011-02-12 Glenn Morris * sc.texi (Getting Connected): Remove old index entries. diff --git a/doc/misc/dired-x.texi b/doc/misc/dired-x.texi index 58fcc9ecbc..a31a3dac31 100644 --- a/doc/misc/dired-x.texi +++ b/doc/misc/dired-x.texi @@ -7,10 +7,9 @@ @c [Dodd's address no longer valid.] @comment %**start of header (This is for running Texinfo on a region.) -@c FOR GNU EMACS USE ../info/dired-x BELOW @setfilename ../../info/dired-x -@c dired-x.el REVISION NUMBER -@settitle Dired Extra Version 2 User's Manual +@settitle Dired Extra User's Manual + @iftex @finalout @end iftex @@ -48,8 +47,7 @@ developing GNU and promoting software freedom.'' @titlepage @sp 6 -@c dired-x.el REVISION NUMBER -@center @titlefont{Dired Extra Version 2} +@center @titlefont{Dired Extra} @sp 2 @center @titlefont{For The GNU Emacs} @sp 1 @@ -70,10 +68,9 @@ developing GNU and promoting software freedom.'' @ifnottex @node Top -@comment node-name, next, previous, up @noindent -This documents the ``extra'' features for Dired Mode for GNU Emacs that are +This documents the ``extra'' features for GNU Emacs's Dired Mode that are provided by the file @file{dired-x.el}. @itemize @bullet @@ -81,20 +78,8 @@ provided by the file @file{dired-x.el}. @item Based on @file{dired.texi} by Sebastian Kremer -@c dired-x.el REVISION NUMBER @item -For @file{dired-x.el} revision 2 - -@c @item -@c Revision of this manual: 2.53 (2001/02/25 14:05:46) - -@c @item -@c Bugs to Lawrence R. Dodd . @emph{Please} type -@c @kbd{M-x dired-x-submit-report} to submit a bug report (@pxref{Bugs}). - -@c @item -@c You can obtain a copy of this package via anonymous ftp in -@c @t{/roebling.poly.edu:/pub/packages/dired-x.tar.gz} +For @file{dired-x.el} as distributed with GNU Emacs 23. @end itemize @@ -124,19 +109,11 @@ For @file{dired-x.el} revision 2 @end ifnottex @node Introduction, Installation, Top, Top -@comment node-name, next, previous, up @chapter Introduction -This documents the @emph{extra} features for Dired Mode for GNU Emacs. It -is derived from version 1.191 of Sebastian Kremer's @file{dired-x.el}. - -In adopting this @file{dired-x.el} to GNU Emacs v19 some material that has -been incorporated into @file{dired.el} and @file{dired-aux.el} of the GNU Emacs -19 distribution has been removed and some material was modified for agreement -with the functions in @file{dired.el} and @file{dired-aux.el}. For example, -the code using @code{gmhist} history functions was replaced with code using -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. +This documents some @emph{extra} features for GNU Emacs's Dired Mode +that are provided by @file{dired-x.el} (derived from Sebastian Kremer's +original @file{dired-x.el}). @ifnottex @menu @@ -146,7 +123,6 @@ features have been added and a few more functions have been bound to keys. @end ifnottex @node Features, Technical Details, , Introduction -@comment node-name, next, previous, up @section Features @cindex Features @@ -194,7 +170,6 @@ C-f} and @kbd{C-x 4 C-f} to @code{dired-x-find-file} and Point}). @node Technical Details, , Features, Introduction -@comment node-name, next, previous, up @section Technical Details @cindex Redefined functions @cindex @file{dired-aux.el} @@ -222,7 +197,6 @@ and the following functions from @file{dired-aux.el} @end itemize @node Installation, Omitting Files in Dired, Introduction, Top -@comment node-name, next, previous, up @chapter Installation @noindent @@ -231,8 +205,8 @@ This manual describes the Dired features provided by the file file and (optionally) set some variables. @noindent -In your @file{.emacs} file in your home directory, or in the system-wide -initialization file @file{default.el} in the @file{site-lisp} directory, put +In your @file{~/.emacs} file, or in the system-wide initialization file +@file{default.el} in the @file{site-lisp} directory, put @example (add-hook 'dired-load-hook @@ -261,48 +235,27 @@ when you first type @kbd{C-x d}). @end ifnottex @node Optional Installation Dired Jump, Optional Installation File At Point, , Installation -@comment node-name, next, previous, up @section Optional Installation Dired Jump @cindex Autoloading @code{dired-jump} and @code{dired-jump-other-window} In order to have @code{dired-jump} and @code{dired-jump-other-window} (@pxref{Miscellaneous Commands}) work @emph{before} @code{dired} and -@code{dired-x} have been properly loaded the user should set-up an autoload +@code{dired-x} have been properly loaded you should set-up an autoload 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'. -(define-key global-map "\C-x\C-j" 'dired-jump) -(define-key global-map "\C-x4\C-j" 'dired-jump-other-window) +(autoload 'dired-jump "dired-x" + "Jump to Dired buffer corresponding to current buffer." t) -(autoload (quote dired-jump) "dired" "\ -Jump to Dired buffer corresponding to current buffer. -If in a file, Dired the current directory and move to file's line. -If in Dired already, pop up a level and goto old directory's line. -In case the proper Dired file line cannot be found, refresh the Dired -buffer and try again." t nil) +(autoload 'dired-jump-other-window "dired-x" + "Like \\[dired-jump] (dired-jump) but in other window." t) -(autoload (quote dired-jump-other-window) "dired" "\ -Like \\[dired-jump] (dired-jump) but in other window." t nil) -@end example - -Note that in recent releases of GNU Emacs 19 (i.e., 19.25 or later) the file -@file{../lisp/loaddefs.el} of the Emacs distribution already contains the -proper auto-loading for @code{dired-jump} so you need only put - -@example (define-key global-map "\C-x\C-j" 'dired-jump) +(define-key global-map "\C-x4\C-j" 'dired-jump-other-window) @end example -@noindent -in your @file{.emacs} file in order to have @kbd{C-x C-j} work -before @code{dired} is loaded. - @node Optional Installation File At Point, , Optional Installation Dired Jump, Installation -@comment node-name, next, previous, up @section Optional Installation File At Point @cindex Binding @code{dired-x-find-file} @@ -335,7 +288,6 @@ loaded @end example @node Omitting Files in Dired, Local Variables, Installation, Top -@comment node-name, next, previous, up @chapter Omitting Files in Dired @cindex Omitting Files in Dired @@ -392,8 +344,6 @@ inside @code{dired-load-hook} (@pxref{Installation}) and then evaluate @end ifnottex @node Omitting Variables, Omitting Examples, , Omitting Files in Dired -@comment node-name, next, previous, up - @section Omitting Variables @cindex Customizing file omitting @@ -501,7 +451,6 @@ will show up again after reverting the buffer, unlike the others. @end table @node Omitting Examples, Omitting Technical, Omitting Variables, Omitting Files in Dired -@comment node-name, next, previous, up @section Examples of Omitting Various File Types @itemize @bullet @@ -555,7 +504,6 @@ in the @code{dired-load-hook} (@pxref{Installation}). @end itemize @node Omitting Technical, , Omitting Examples, Omitting Files in Dired -@comment node-name, next, previous, up @section Some Technical Details of Omitting Loading @file{dired-x.el} will install Dired Omit by putting @@ -563,8 +511,8 @@ 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 -@comment node-name, next, previous, up @chapter Local Variables for Dired Directories @cindex Local Variables for Dired Directories @@ -633,7 +581,6 @@ Variables are hacked. @end table @node Shell Command Guessing, Virtual Dired, Local Variables, Top -@comment node-name, next, previous, up @chapter Shell Command Guessing @cindex Guessing shell commands for files. @@ -740,7 +687,6 @@ History list for commands that read dired-shell commands. @end table @node Virtual Dired, Advanced Mark Commands, Shell Command Guessing, Top -@comment node-name, next, previous, up @chapter Virtual Dired @cindex Virtual Dired @@ -782,7 +728,6 @@ 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 -@comment node-name, next, previous, up @chapter Advanced Mark Commands @table @kbd @@ -829,8 +774,6 @@ Flag all files with a certain extension for deletion. A @samp{.} is @end ifnottex @node Advanced Cleaning Functions, Advanced Cleaning Variables, , Advanced Mark Commands -@comment node-name, next, previous, up - @section Advanced Cleaning Functions @table @code @@ -862,8 +805,6 @@ and @file{*.dvi} files for deletion. @end table @node Advanced Cleaning Variables, Special Marking Function, Advanced Cleaning Functions, Advanced Mark Commands -@comment node-name, next, previous, up - @section Advanced Cleaning Variables @noindent Variables used by the above cleaning commands (and in the default value for @@ -903,8 +844,6 @@ List of extensions of dispensable files created by Bib@TeX{}. @end table @node Special Marking Function, , Advanced Cleaning Variables, Advanced Mark Commands -@comment node-name, next, previous, up - @section Special Marking Function @table @kbd @@ -961,7 +900,6 @@ to mark all @file{.el} files without a corresponding @file{.elc} file. @end table @node Multiple Dired Directories, Find File At Point, Advanced Mark Commands, Top -@comment node-name, next, previous, up @chapter Multiple Dired Directories and Non-Dired Commands @cindex Multiple Dired directories @@ -994,8 +932,6 @@ also consults the variable @code{default-directory-alist}. @end table @node Find File At Point, Miscellaneous Commands, Multiple Dired Directories, Top -@comment node-name, next, previous, up - @section Find File At Point @cindex Visiting a file mentioned in a buffer @cindex Finding a file at point @@ -1072,7 +1008,6 @@ that uses the value of @code{dired-x-hands-off-my-keys} to determine if @end table @node Miscellaneous Commands, Bugs, Find File At Point, Top -@comment node-name, next, previous, up @chapter Miscellaneous Commands Miscellaneous features not fitting anywhere else: @@ -1210,50 +1145,30 @@ info. @end table @node Bugs, GNU Free Documentation License, Miscellaneous Commands, Top -@comment node-name, next, previous, up @chapter Bugs @cindex Bugs -@findex dired-x-submit-report @noindent -If you encounter a bug in this package, wish to suggest an -enhancement, or want to make a smart remark, then type - -@example -@kbd{M-x dired-x-submit-report} -@end example - -@noindent -to set up an outgoing mail buffer, with the proper address to the -@file{dired-x.el} maintainer automatically inserted in the @samp{To:@:} field. -This command also inserts information that the Dired X maintainer can use to -recreate your exact setup, making it easier to verify your bug or social -maladjustment. - -Lawrence R. Dodd -@c +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 @appendix GNU Free Documentation License @include doclicense.texi @node Concept Index, Command Index, GNU Free Documentation License, Top -@comment node-name, next, previous, up @unnumbered Concept Index @printindex cp @node Command Index, Key Index, Concept Index, Top -@comment node-name, next, previous, up @unnumbered Function Index @printindex fn @node Key Index, Variable Index, Command Index, Top -@comment node-name, next, previous, up @unnumbered Key Index @printindex ky @node Variable Index, , Key Index, Top -@comment node-name, next, previous, up @unnumbered Variable Index @printindex vr -- cgit v1.2.3