aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEli Zaretskii2001-02-25 13:37:54 +0000
committerEli Zaretskii2001-02-25 13:37:54 +0000
commit36e10400f9378536afeaa014985f9957403d0cff (patch)
tree2980ea58bd8b4da8249a86139358731b02fda2a7
parentb4c0dae9813a3125514a968855c6780eb09e9038 (diff)
downloademacs-36e10400f9378536afeaa014985f9957403d0cff.tar.gz
emacs-36e10400f9378536afeaa014985f9957403d0cff.zip
Lots of markup and wording changes.
-rw-r--r--man/dired-x.texi239
1 files changed, 130 insertions, 109 deletions
diff --git a/man/dired-x.texi b/man/dired-x.texi
index c43360feba1..fd40b65aeb1 100644
--- a/man/dired-x.texi
+++ b/man/dired-x.texi
@@ -5,13 +5,13 @@
5@c Author: Sebastian Kremer <sk@thp.uni-koeln.de> 5@c Author: Sebastian Kremer <sk@thp.uni-koeln.de>
6@c Lawrence R. Dodd <dodd@roebling.poly.edu> 6@c Lawrence R. Dodd <dodd@roebling.poly.edu>
7@c [Dodd's address no longer valid.] 7@c [Dodd's address no longer valid.]
8@c Version: 2.52 8@c Version: 2.53
9@c Date: 1994/08/09 16:51:31 9@c Date: 2001/02/25 14:05:46
10@c Keywords: dired extensions 10@c Keywords: dired extensions
11@c dired-x.el REVISION NUMBER: 2 11@c dired-x.el REVISION NUMBER: 2
12 12
13@c State: Released 13@c State: Released
14@c Ident: dired-x.texi,v 2.52 1994/08/09 16:51:31 dodd Released 14@c Ident: dired-x.texi,v 2.53 2001/02/25 14:05:46 dodd Released
15 15
16@comment %**start of header (This is for running Texinfo on a region.) 16@comment %**start of header (This is for running Texinfo on a region.)
17@c FOR GNU EMACS USE ../info/dired-x BELOW 17@c FOR GNU EMACS USE ../info/dired-x BELOW
@@ -41,7 +41,7 @@
41This documents the ``extra'' features for Dired Mode for GNU Emacs found in 41This documents the ``extra'' features for Dired Mode for GNU Emacs found in
42the file @file{dired-x.el}. 42the file @file{dired-x.el}.
43 43
44Copyright @copyright{} 1993, 1994 Free Software Foundation, Inc. 44Copyright @copyright{} 1993, 1994, 2001 Free Software Foundation, Inc.
45 45
46Permission is granted to make and distribute verbatim copies of this 46Permission is granted to make and distribute verbatim copies of this
47manual provided the copyright notice and this permission notice are 47manual provided the copyright notice and this permission notice are
@@ -80,8 +80,8 @@ notice identical to this one except for the removal of this paragraph
80@sp 1 80@sp 1
81@center @titlefont{Directory Editor} 81@center @titlefont{Directory Editor}
82@sp 4 82@sp 4
83@center Manual Revision: 2.52 83@center Manual Revision: 2.53
84@center 1994/08/09 16:51:31 84@center 2001/02/25 14:05:46
85@sp 5 85@sp 5
86@center Lawrence R@. Dodd 86@center Lawrence R@. Dodd
87@c @center @t{dodd@@roebling.poly.edu} 87@c @center @t{dodd@@roebling.poly.edu}
@@ -89,7 +89,7 @@ notice identical to this one except for the removal of this paragraph
89@center (Based on @file{dired.texi} by Sebastian Kremer <sk@@thp.uni-koeln.de>) 89@center (Based on @file{dired.texi} by Sebastian Kremer <sk@@thp.uni-koeln.de>)
90@page 90@page
91@vskip 0pt plus 1filll 91@vskip 0pt plus 1filll
92Copyright @copyright{} 1993, 1994 Free Software Foundation 92Copyright @copyright{} 1993, 1994, 2001 Free Software Foundation
93 93
94Permission is granted to make and distribute verbatim copies of 94Permission is granted to make and distribute verbatim copies of
95this manual provided the copyright notice and this permission notice 95this manual provided the copyright notice and this permission notice
@@ -132,7 +132,7 @@ Based on @file{dired.texi} by Sebastian Kremer <sk@@thp.uni-koeln.de>
132For @file{dired-x.el} revision 2 132For @file{dired-x.el} revision 2
133 133
134@c @item 134@c @item
135@c Revision of this manual: 2.52 (1994/08/09 16:51:31) 135@c Revision of this manual: 2.53 (2001/02/25 14:05:46)
136 136
137@c @item 137@c @item
138@c Bugs to Lawrence R. Dodd <dodd@@roebling.poly.edu>. @emph{Please} type 138@c Bugs to Lawrence R. Dodd <dodd@@roebling.poly.edu>. @emph{Please} type
@@ -197,22 +197,22 @@ Some features provided by Dired Extra
197 197
198@enumerate 198@enumerate
199@item 199@item
200Omitting of uninteresting files from dired listing. 200Omitting uninteresting files from Dired listing.
201@itemize @bullet 201@itemize @bullet
202@xref{Omitting Files in Dired}. 202@xref{Omitting Files in Dired}.
203@end itemize 203@end itemize
204@item 204@item
205Local variables for dired directories. 205Local variables for Dired directories.
206@itemize @bullet 206@itemize @bullet
207@xref{Local Variables}. 207@xref{Local Variables}.
208@end itemize 208@end itemize
209@item 209@item
210Guessing shell commands in dired buffers. 210Guessing shell commands in Dired buffers.
211@itemize @bullet 211@itemize @bullet
212@xref{Shell Command Guessing}. 212@xref{Shell Command Guessing}.
213@end itemize 213@end itemize
214@item 214@item
215Running dired command in non-dired buffers. 215Running Dired command in non-Dired buffers.
216@itemize @bullet 216@itemize @bullet
217@xref{Virtual Dired}. 217@xref{Virtual Dired}.
218@end itemize 218@end itemize
@@ -271,7 +271,7 @@ and the following functions from @file{dired-aux.el}
271@chapter Installation 271@chapter Installation
272 272
273@noindent 273@noindent
274This manual describes the dired features provided by the file 274This manual describes the Dired features provided by the file
275@file{dired-x.el}. To take advantage of these features, you must load the 275@file{dired-x.el}. To take advantage of these features, you must load the
276file and (optionally) set some variables. 276file and (optionally) set some variables.
277 277
@@ -295,8 +295,8 @@ initialization file @file{default.el} in the @file{site-lisp} directory, put
295@end example 295@end example
296 296
297@noindent 297@noindent
298This will load @file{dired-x.el} when dired is first invoked (for example, 298This will load @file{dired-x.el} when Dired is first invoked (for example,
299when you first do @kbd{C-x d}). 299when you first type @kbd{C-x d}).
300 300
301@ifinfo 301@ifinfo
302@menu 302@menu
@@ -324,10 +324,10 @@ for these functions. In your @file{.emacs} file put
324(define-key global-map "\C-x4\C-j" 'dired-jump-other-window) 324(define-key global-map "\C-x4\C-j" 'dired-jump-other-window)
325 325
326(autoload (quote dired-jump) "dired" "\ 326(autoload (quote dired-jump) "dired" "\
327Jump to dired buffer corresponding to current buffer. 327Jump to Dired buffer corresponding to current buffer.
328If in a file, dired the current directory and move to file's line. 328If in a file, Dired the current directory and move to file's line.
329If in dired already, pop up a level and goto old directory's line. 329If in Dired already, pop up a level and goto old directory's line.
330In case the proper dired file line cannot be found, refresh the dired 330In case the proper Dired file line cannot be found, refresh the Dired
331buffer and try again." t nil) 331buffer and try again." t nil)
332 332
333(autoload (quote dired-jump-other-window) "dired" "\ 333(autoload (quote dired-jump-other-window) "dired" "\
@@ -342,7 +342,8 @@ proper auto-loading for @code{dired-jump} so you need only put
342(define-key global-map "\C-x\C-j" 'dired-jump) 342(define-key global-map "\C-x\C-j" 'dired-jump)
343@end example 343@end example
344 344
345@noindent in your @file{.emacs} file in order to have @kbd{C-x C-j} work 345@noindent
346in your @file{.emacs} file in order to have @kbd{C-x C-j} work
346before @code{dired} is loaded. 347before @code{dired} is loaded.
347 348
348@node Optional Installation File At Point, , Optional Installation Dired Jump, Installation 349@node Optional Installation File At Point, , Optional Installation Dired Jump, Installation
@@ -383,6 +384,7 @@ loaded
383@chapter Omitting Files in Dired 384@chapter Omitting Files in Dired
384 385
385@cindex Omitting Files in Dired 386@cindex Omitting Files in Dired
387@cindex Uninteresting files
386@dfn{Omitting} a file means removing it from the directory listing. Omitting 388@dfn{Omitting} a file means removing it from the directory listing. Omitting
387is useful for keeping Dired buffers free of ``uninteresting'' files (for 389is useful for keeping Dired buffers free of ``uninteresting'' files (for
388instance, auto-save, auxiliary, backup, and revision control files) so that 390instance, auto-save, auxiliary, backup, and revision control files) so that
@@ -397,7 +399,7 @@ Omitting works on individual files, not on directories; an entire directory
397cannot be omitted (though each of its files could be). 399cannot be omitted (though each of its files could be).
398 400
399@item 401@item
400Omitting is wholesale; if omitting is turned on for a dired buffer, then all 402Omitting is wholesale; if omitting is turned on for a Dired buffer, then all
401uninteresting files listed in that buffer are omitted. The user does not omit 403uninteresting files listed in that buffer are omitted. The user does not omit
402(or unomit) files one at a time. 404(or unomit) files one at a time.
403 405
@@ -414,7 +416,7 @@ Marked files are never omitted.
414@kindex M-o 416@kindex M-o
415@findex dired-omit-toggle 417@findex dired-omit-toggle
416(@code{dired-omit-toggle}) Toggle between displaying and omitting 418(@code{dired-omit-toggle}) Toggle between displaying and omitting
417``uninteresting'' files. With a prefix argument, don't toggle and just mark 419``uninteresting'' files. With a prefix argument, just mark
418the files, but don't actually omit them. 420the files, but don't actually omit them.
419@end table 421@end table
420 422
@@ -436,6 +438,7 @@ inside @code{dired-load-hook} (@pxref{Installation}) and then set
436 438
437@section Omitting Variables 439@section Omitting Variables
438 440
441@cindex Customizing file omitting
439The following variables can be used to customize omitting. 442The following variables can be used to customize omitting.
440 443
441@table @code 444@table @code
@@ -446,15 +449,17 @@ The following variables can be used to customize omitting.
446Default: @code{nil} 449Default: @code{nil}
447 450
448@cindex How to make omitting the default in Dired 451@cindex How to make omitting the default in Dired
449If non-@code{nil}, ``uninteresting'' files are not listed. Uninteresting 452If non-@code{nil}, ``uninteresting'' files are not listed.
450files are those whose filenames match regexp @code{dired-omit-files}, plus 453Uninteresting files are those whose files whose names match regexp
451those ending with extensions in @code{dired-omit-extensions}. @kbd{M-o} 454@code{dired-omit-files}, plus those ending with extensions in
452(@code{dired-omit-toggle}) toggles its value, which is buffer-local. Put 455@code{dired-omit-extensions}. @kbd{M-o} (@code{dired-omit-toggle})
456toggles its value, which is buffer-local. Put
453 457
454@example 458@example
455(setq dired-omit-files-p t) 459(setq dired-omit-files-p t)
456@end example 460@end example
457 461
462@noindent
458inside your @code{dired-mode-hook} to have omitting initially turned on in 463inside your @code{dired-mode-hook} to have omitting initially turned on in
459@emph{every} Dired buffer (@pxref{Installation}). You can then use @kbd{M-o} to 464@emph{every} Dired buffer (@pxref{Installation}). You can then use @kbd{M-o} to
460unomit in that buffer. 465unomit in that buffer.
@@ -487,17 +492,16 @@ the directory listing (@pxref{Local Variables}).
487 492
488Default: @code{"^#\\|\\.$"} 493Default: @code{"^#\\|\\.$"}
489 494
490Filenames matching this buffer-local regexp will not be displayed. 495Files whose names match this buffer-local regexp will not be displayed.
491This only has effect when @code{dired-omit-files-p} is t. 496This only has effect when @code{dired-omit-files-p}'s value is @code{t}.
492 497
493The default value omits the special directories @file{.} and @file{..} and 498The default value omits the special directories @file{.} and @file{..} and
494autosave files (plus other files ending in ``.'') (@pxref{Omitting Examples}). 499autosave files (plus other files ending in @file{.}) (@pxref{Omitting Examples}).
495 500
496@vindex dired-omit-extensions 501@vindex dired-omit-extensions
497@item dired-omit-extensions 502@item dired-omit-extensions
498 503
499Default: The elements of @code{completion-ignored-extensions} (as defined in 504Default: The elements of @code{completion-ignored-extensions},
500the file @file{loaddefs.el} of the GNU Emacs distribution),
501@code{dired-latex-unclean-extensions}, @code{dired-bibtex-unclean-extensions} 505@code{dired-latex-unclean-extensions}, @code{dired-bibtex-unclean-extensions}
502and @code{dired-texinfo-unclean-extensions}. 506and @code{dired-texinfo-unclean-extensions}.
503 507
@@ -507,13 +511,13 @@ Its format is the same as that of @code{completion-ignored-extensions}.
507@vindex dired-omit-localp 511@vindex dired-omit-localp
508@item dired-omit-localp 512@item dired-omit-localp
509 513
510Default: @code{'no-dir} 514Default: @code{no-dir}
511 515
512The @var{localp} argument @code{dired-omit-expunge} passes to 516The @var{localp} argument @code{dired-omit-expunge} passes to
513@code{dired-get-filename}. If it is @code{'no-dir}, omitting is much faster, 517@code{dired-get-filename}. If it is @code{no-dir}, omitting is much faster,
514but you can only match against the non-directory part of the filename. Set it 518but you can only match against the non-directory part of the file name. Set it
515to @code{nil} if you need to match the whole pathname or @code{t} to match the 519to @code{nil} if you need to match the whole file name or @code{t} to match the
516pathname relative to the buffer's top-level directory. 520file name relative to the buffer's top-level directory.
517 521
518@item dired-omit-marker-char 522@item dired-omit-marker-char
519@vindex dired-omit-marker-char 523@vindex dired-omit-marker-char
@@ -522,7 +526,7 @@ Default: @kbd{C-o}
522 526
523Temporary marker used by Dired to implement omitting. Should never be used 527Temporary marker used by Dired to implement omitting. Should never be used
524as marker by the user or other packages. There is one exception to this rule: 528as marker by the user or other packages. There is one exception to this rule:
525by doing 529by adding
526 530
527@example 531@example
528(setq dired-mark-keys "\C-o") 532(setq dired-mark-keys "\C-o")
@@ -530,7 +534,8 @@ by doing
530;; (which is not defined yet) 534;; (which is not defined yet)
531@end example 535@end example
532 536
533anywhere in your @file{~/.emacs}, you will bind the @kbd{C-o} key to insert a 537@noindent
538to your @file{~/.emacs}, you can bind the @kbd{C-o} key to insert a
534@kbd{C-o} marker, thus causing these files to be omitted in addition to the 539@kbd{C-o} marker, thus causing these files to be omitted in addition to the
535usually omitted files. Unfortunately the files you omitted manually this way 540usually omitted files. Unfortunately the files you omitted manually this way
536will show up again after reverting the buffer, unlike the others. 541will show up again after reverting the buffer, unlike the others.
@@ -546,15 +551,16 @@ will show up again after reverting the buffer, unlike the others.
546@item 551@item
547@cindex RCS files, how to omit them in Dired 552@cindex RCS files, how to omit them in Dired
548@cindex Omitting RCS files in Dired 553@cindex Omitting RCS files in Dired
549If you wish to avoid seeing RCS files and the RCS directory, then put 554If you wish to avoid seeing RCS files and the @file{RCS} directory, then put
550 555
551@example 556@example
552(setq dired-omit-files 557(setq dired-omit-files
553 (concat dired-omit-files "\\|^RCS$\\|,v$")) 558 (concat dired-omit-files "\\|^RCS$\\|,v$"))
554@end example 559@end example
560
555@noindent 561@noindent
556in the @code{dired-load-hook} (@pxref{Installation}). This assumes 562in the @code{dired-load-hook} (@pxref{Installation}). This assumes
557@code{dired-omit-localp} has its default value of @code{'no-dir} to make the 563@code{dired-omit-localp} has its default value of @code{no-dir} to make the
558@code{^}-anchored matches work. As a slower alternative, with 564@code{^}-anchored matches work. As a slower alternative, with
559@code{dired-omit-localp} set to @code{nil}, you can use @code{/} instead of 565@code{dired-omit-localp} set to @code{nil}, you can use @code{/} instead of
560@code{^} in the regexp. 566@code{^} in the regexp.
@@ -562,8 +568,9 @@ in the @code{dired-load-hook} (@pxref{Installation}). This assumes
562@item 568@item
563@cindex Tib files, how to omit them in Dired 569@cindex Tib files, how to omit them in Dired
564@cindex Omitting tib files in Dired 570@cindex Omitting tib files in Dired
565If you use tib, the bibliography program for use with @TeX{} and La@TeX{}, you 571If you use @code{tib}, the bibliography program for use with @TeX{} and
566might want to omit the @file{INDEX} and the @file{-t.tex} files, then put 572La@TeX{}, and you
573want to omit the @file{INDEX} and the @file{*-t.tex} files, then put
567 574
568@example 575@example
569(setq dired-omit-files 576(setq dired-omit-files
@@ -576,7 +583,7 @@ in the @code{dired-load-hook} (@pxref{Installation}).
576@item 583@item
577@cindex Dot files, how to omit them in Dired 584@cindex Dot files, how to omit them in Dired
578@cindex Omitting dot files in Dired 585@cindex Omitting dot files in Dired
579If you do not wish to see @samp{dot} files (files starting with a @samp{.}), 586If you do not wish to see @samp{dot} files (files starting with a @file{.}),
580then put 587then put
581 588
582@example 589@example
@@ -651,15 +658,15 @@ The following variables affect Dired Local Variables
651@item dired-local-variables-file 658@item dired-local-variables-file
652Default: @code{".dired"} 659Default: @code{".dired"}
653 660
654If non-@code{nil}, filename for local variables for Dired. If Dired finds a 661If non-@code{nil}, file name for local variables for Dired. If Dired finds a
655file with that name in the current directory, it will temporarily insert it 662file with that name in the current directory, it will temporarily insert it
656into the dired buffer and run `hack-local-variables'. 663into the Dired buffer and run @code{hack-local-variables}.
657 664
658@vindex dired-enable-local-variables 665@vindex dired-enable-local-variables
659@item dired-enable-local-variables 666@item dired-enable-local-variables
660Default: @code{t} 667Default: @code{t}
661 668
662Controls use of local-variables lists in dired. The value can be @code{t}, 669Controls the use of local-variables lists in Dired. The value can be @code{t},
663@code{nil}, or something else. A value of @code{t} means local-variables 670@code{nil}, or something else. A value of @code{t} means local-variables
664lists are obeyed in the @code{dired-local-variables-file}; @code{nil} means 671lists are obeyed in the @code{dired-local-variables-file}; @code{nil} means
665they are ignored; anything else means query. This variable temporarily 672they are ignored; anything else means query. This variable temporarily
@@ -672,14 +679,14 @@ Variables are hacked.
672@chapter Shell Command Guessing 679@chapter Shell Command Guessing
673@cindex Guessing shell commands for files. 680@cindex Guessing shell commands for files.
674 681
675Based upon the name of a filename, Dired tries to guess what shell 682Based upon the name of a file, Dired tries to guess what shell
676command you might want to apply to it. For example, if you have point 683command you might want to apply to it. For example, if you have point
677on a file named @file{foo.tar} and you press @kbd{!}, Dired will guess 684on a file named @file{foo.tar} and you press @kbd{!}, Dired will guess
678you want to @samp{tar xvf} it and suggest that as the default shell 685you want to @samp{tar xvf} it and suggest that as the default shell
679command. 686command.
680 687
681The default will be mentioned in brackets and you can type @kbd{M-p} to get 688The default is mentioned in brackets and you can type @kbd{M-p} to get
682the default into the minibuffer so that you can edit it, e.g., changing 689the default into the minibuffer and then edit it, e.g., to change
683@samp{tar xvf} to @samp{tar tvf}. If there are several commands for a given 690@samp{tar xvf} to @samp{tar tvf}. If there are several commands for a given
684file, e.g., @samp{xtex} and @samp{dvips} for a @file{.dvi} file, you can type 691file, e.g., @samp{xtex} and @samp{dvips} for a @file{.dvi} file, you can type
685@kbd{M-p} several times to see each of the matching commands. 692@kbd{M-p} several times to see each of the matching commands.
@@ -708,9 +715,10 @@ Each element of the alist looks like
708(@var{regexp} @var{command}@dots{}) 715(@var{regexp} @var{command}@dots{})
709@end example 716@end example
710 717
718@noindent
711where each @var{command} can either be a string or a lisp expression 719where each @var{command} can either be a string or a lisp expression
712that evaluates to a string. If several @var{COMMAND}s are given, all 720that evaluates to a string. If several commands are given, all of
713will temporarily be pushed on the history. 721them will temporarily be pushed onto the history.
714 722
715You can set this variable in your @file{~/.emacs}. For example, 723You can set this variable in your @file{~/.emacs}. For example,
716to add rules for @samp{.foo} and @samp{.bar} file extensions, write 724to add rules for @samp{.foo} and @samp{.bar} file extensions, write
@@ -731,30 +739,31 @@ This will override any predefined rules for the same extensions.
731 739
732@item dired-guess-shell-gnutar 740@item dired-guess-shell-gnutar
733@vindex dired-guess-shell-gnutar 741@vindex dired-guess-shell-gnutar
734@cindex Passing GNU tar its `z' switch. 742@cindex Passing GNU Tar its @samp{z} switch.
735Default: @code{nil} 743Default: @code{nil}
736 744
737If non-@code{nil}, name of the GNU tar executable (e.g., @samp{"tar"} or 745If non-@code{nil}, this is the name of the GNU Tar executable (e.g.,
738@samp{"gnutar"}). GNU tar's @samp{z} switch is used for compressed tar files. 746@samp{tar} or @samp{gnutar}). GNU Tar's @samp{z} switch is used for
747compressed tar files.
739If you don't have GNU tar, set this to @code{nil}: a pipe using @samp{zcat} is 748If you don't have GNU tar, set this to @code{nil}: a pipe using @samp{zcat} is
740then used. 749then used.
741 750
742@item dired-guess-shell-gzip-quiet 751@item dired-guess-shell-gzip-quiet
743@vindex dired-guess-shell-gzip-quiet 752@vindex dired-guess-shell-gzip-quiet
744@cindex GNU zip. 753@cindex @code{gzip}
745Default: @code{t} 754Default: @code{t}
746 755
747A non-@code{nil} value means that @code{-q} is passed to gzip overriding a 756A non-@code{nil} value means that @samp{-q} is passed to @code{gzip}
748verbose GNU zip's @env{GZIP} environment variable. 757overriding a verbose option in the @env{GZIP} environment variable.
749 758
750@item dired-guess-shell-znew-switches nil 759@item dired-guess-shell-znew-switches nil
751@vindex dired-guess-shell-znew-switches nil 760@vindex dired-guess-shell-znew-switches nil
752@cindex GNU zip. 761@cindex @code{znew}
753Default: @code{nil} 762Default: @code{nil}
754 763
755A string of switches passed to GNU zip's @file{znew}. An example is 764A string of switches passed to @code{znew}. An example is
756@samp{"-K"} which will make @file{znew} keep a .Z file when it is smaller than 765@samp{-K} which will make @code{znew} keep a @file{.Z} file when it is
757the .gz file. 766smaller than the @file{.gz} file.
758 767
759@item dired-shell-command-history nil 768@item dired-shell-command-history nil
760@vindex dired-shell-command-history nil 769@vindex dired-shell-command-history nil
@@ -767,8 +776,8 @@ History list for commands that read dired-shell commands.
767@chapter Virtual Dired 776@chapter Virtual Dired
768 777
769@cindex Virtual Dired 778@cindex Virtual Dired
770@cindex Perusing ls listings 779@cindex Perusing @code{ls} listings
771@cindex ls listings, how to peruse them in Dired 780@cindex @code{ls} listings, how to peruse them in Dired
772Using @dfn{Virtual Dired} means putting a buffer with Dired-like 781Using @dfn{Virtual Dired} means putting a buffer with Dired-like
773contents in Dired mode. The files described by the buffer contents need 782contents in Dired mode. The files described by the buffer contents need
774not actually exist. This is useful if you want to peruse an @samp{ls -lR} 783not actually exist. This is useful if you want to peruse an @samp{ls -lR}
@@ -800,8 +809,9 @@ virtual Dired mode from the @code{auto-mode-alist}. To edit all
800 auto-mode-alist)) 809 auto-mode-alist))
801@end example 810@end example
802 811
803The regexp is a bit more complicated than usual to exclude ".dired" 812@noindent
804local variable files. 813The regexp is a bit more complicated than usual to exclude @file{.dired}
814local-variable files.
805 815
806@node Advanced Mark Commands, Advanced Cleaning Functions, Virtual Dired, Top 816@node Advanced Mark Commands, Advanced Cleaning Functions, Virtual Dired, Top
807@comment node-name, next, previous, up 817@comment node-name, next, previous, up
@@ -814,8 +824,9 @@ local variable files.
814@cindex Simultaneous visiting of several files 824@cindex Simultaneous visiting of several files
815@findex dired-do-find-marked-files 825@findex dired-do-find-marked-files
816(@code{dired-do-find-marked-files}) Find all marked files at once displaying 826(@code{dired-do-find-marked-files}) Find all marked files at once displaying
817simultaneously. If optional NOSELECT is non-@code{nil} then just find the 827them simultaneously. If optional @var{noselect} is non-@code{nil} then just
818files but do not select. If you want to keep the dired buffer displayed, type 828find the
829files but do not select. If you want to keep the Dired buffer displayed, type
819@kbd{C-x 2} first. If you want just the marked files displayed and nothing 830@kbd{C-x 2} first. If you want just the marked files displayed and nothing
820else, type @kbd{C-x 1} first. 831else, type @kbd{C-x 1} first.
821 832
@@ -829,9 +840,10 @@ variable @code{window-min-height}.
829@item dired-mark-extension 840@item dired-mark-extension
830@findex dired-mark-extension 841@findex dired-mark-extension
831Mark all files with a certain extension for use in later commands. A @samp{.} 842Mark all files with a certain extension for use in later commands. A @samp{.}
832is not automatically prepended to the string entered. 843is not automatically prepended to the string entered, you must type it
844explicitly.
833 845
834When called from lisp, @var{extension} may also be a list of extensions 846When called from Lisp, @var{extension} may also be a list of extensions
835and an optional argument @var{marker-char} specifies the marker used. 847and an optional argument @var{marker-char} specifies the marker used.
836 848
837@item dired-flag-extension 849@item dired-flag-extension
@@ -877,8 +889,8 @@ deletion. See the following variables (@pxref{Advanced Cleaning Variables}):
877 889
878@item dired-very-clean-tex 890@item dired-very-clean-tex
879@findex dired-very-clean-tex 891@findex dired-very-clean-tex
880Flag dispensable files created by @TeX{}, La@TeX{}, @samp{texinfo}, and ".dvi" 892Flag dispensable files created by @TeX{}, La@TeX{}, @samp{texinfo},
881files for deletion. 893and @file{*.dvi} files for deletion.
882@end table 894@end table
883 895
884@node Advanced Cleaning Variables, Special Marking Function, Advanced Cleaning Functions, Advanced Mark Commands 896@node Advanced Cleaning Variables, Special Marking Function, Advanced Cleaning Functions, Advanced Mark Commands
@@ -892,32 +904,32 @@ variable @code{dired-omit-extensions}, @pxref{Omitting Variables})
892@table @code 904@table @code
893@item dired-patch-unclean-extensions 905@item dired-patch-unclean-extensions
894@vindex dired-patch-unclean-extensions 906@vindex dired-patch-unclean-extensions
895Default: @code{'(".rej" ".orig")} 907Default: @code{(".rej" ".orig")}
896 908
897List of extensions of dispensable files created by the @samp{patch} program. 909List of extensions of dispensable files created by the @samp{patch} program.
898 910
899@item dired-tex-unclean-extensions 911@item dired-tex-unclean-extensions
900@vindex dired-tex-unclean-extensions 912@vindex dired-tex-unclean-extensions
901Default: @code{'(".toc" ".log" ".aux")} 913Default: @code{(".toc" ".log" ".aux")}
902 914
903List of extensions of dispensable files created by @TeX{}. 915List of extensions of dispensable files created by @TeX{}.
904 916
905@item dired-texinfo-unclean-extensions 917@item dired-texinfo-unclean-extensions
906@vindex dired-texinfo-unclean-extensions 918@vindex dired-texinfo-unclean-extensions
907Default: @code{'(".cp" ".cps" ".fn" ".fns" ".ky" ".kys"} 919Default: @code{(".cp" ".cps" ".fn" ".fns" ".ky" ".kys"}
908@code{".pg" ".pgs" ".tp" ".tps" ".vr" ".vrs")} 920@code{".pg" ".pgs" ".tp" ".tps" ".vr" ".vrs")}
909 921
910List of extensions of dispensable files created by @samp{texinfo}. 922List of extensions of dispensable files created by @samp{texinfo}.
911 923
912@item dired-latex-unclean-extensions 924@item dired-latex-unclean-extensions
913@vindex dired-latex-unclean-extensions 925@vindex dired-latex-unclean-extensions
914Default: @code{'(".idx" ".lof" ".lot" ".glo")} 926Default: @code{(".idx" ".lof" ".lot" ".glo")}
915 927
916List of extensions of dispensable files created by La@TeX{}. 928List of extensions of dispensable files created by La@TeX{}.
917 929
918@item dired-bibtex-unclean-extensions 930@item dired-bibtex-unclean-extensions
919@vindex dired-bibtex-unclean-extensions 931@vindex dired-bibtex-unclean-extensions
920Default: @code{'(".blg" ".bbl")} 932Default: @code{(".blg" ".bbl")}
921 933
922List of extensions of dispensable files created by Bib@TeX{}. 934List of extensions of dispensable files created by Bib@TeX{}.
923@end table 935@end table
@@ -945,7 +957,7 @@ symbols:
945[@i{integer}] the size of the file for @samp{ls -s} output (usually in blocks or, 957[@i{integer}] the size of the file for @samp{ls -s} output (usually in blocks or,
946with @samp{-k}, in KBytes) 958with @samp{-k}, in KBytes)
947@item mode 959@item mode
948[@i{string}] file permission bits, e.g., @samp{"-rw-r--r--"} 960[@i{string}] file permission bits, e.g., @samp{-rw-r--r--}
949@item nlink 961@item nlink
950[@i{integer}] number of links to file 962[@i{integer}] number of links to file
951@item uid 963@item uid
@@ -956,11 +968,11 @@ will still be set (to the same as uid))
956@item size 968@item size
957[@i{integer}] file size in bytes 969[@i{integer}] file size in bytes
958@item time 970@item time
959[@i{string}] the time that @samp{ls} displays, e.g., @samp{"Feb 12 14:17"} 971[@i{string}] the time that @samp{ls} displays, e.g., @samp{Feb 12 14:17}
960@item name 972@item name
961[@i{string}] the name of the file 973[@i{string}] the name of the file
962@item sym 974@item sym
963[@i{string}] if file is a symbolic link, the linked-to name, else @samp{""} 975[@i{string}] if file is a symbolic link, the linked-to name, else @code{""}
964@end table 976@end table
965 977
966@noindent 978@noindent
@@ -970,7 +982,7 @@ For example, use
970@end example 982@end example
971to mark all zero length files. 983to mark all zero length files.
972 984
973To find out all not yet compiled Emacs lisp files in a directory, dired 985To find out all not yet compiled Emacs lisp files in a directory, Dired
974all @file{.el} files in the lisp directory using the wildcard 986all @file{.el} files in the lisp directory using the wildcard
975@samp{*.el}. Then use @kbd{M-(} with 987@samp{*.el}. Then use @kbd{M-(} with
976@example 988@example
@@ -988,8 +1000,8 @@ to mark all @file{.el} files without a corresponding @file{.elc} file.
988@cindex Working directory 1000@cindex Working directory
989An Emacs buffer can have but one working directory, stored in the 1001An Emacs buffer can have but one working directory, stored in the
990buffer-local variable @code{default-directory}. A Dired buffer may have 1002buffer-local variable @code{default-directory}. A Dired buffer may have
991several subdirectories inserted, but still has but one working 1003several subdirectories inserted, but it still has only one working
992directory: that of the top level Dired directory in that buffer. For 1004directory: that of the top-level Dired directory in that buffer. For
993some commands it is appropriate that they use the current Dired 1005some commands it is appropriate that they use the current Dired
994directory instead of @code{default-directory}, e.g., @code{find-file} and 1006directory instead of @code{default-directory}, e.g., @code{find-file} and
995@code{compile}. 1007@code{compile}.
@@ -1002,7 +1014,7 @@ directory in special major modes:
1002@vindex default-directory-alist 1014@vindex default-directory-alist
1003Default: @code{((dired-mode . (dired-current-directory)))} 1015Default: @code{((dired-mode . (dired-current-directory)))}
1004 1016
1005Alist of major modes and their opinion on @code{default-directory}, as a 1017Alist of major modes and their notion of @code{default-directory}, as a
1006lisp expression to evaluate. A resulting value of @code{nil} is ignored 1018lisp expression to evaluate. A resulting value of @code{nil} is ignored
1007in favor of @code{default-directory}. 1019in favor of @code{default-directory}.
1008 1020
@@ -1020,9 +1032,9 @@ special cases in variable @code{default-directory-alist}.
1020@cindex Finding a file at point 1032@cindex Finding a file at point
1021 1033
1022@file{dired-x} provides a method of visiting or editing a file mentioned in 1034@file{dired-x} provides a method of visiting or editing a file mentioned in
1023the buffer you are viewing (e.g., a mail buffer, a news article, a README 1035the buffer you are viewing (e.g., a mail buffer, a news article, a
1024file, etc.) or to test if that file exists. You can then modify this in the 1036@file{README} file, etc.) or to test if that file exists. You can then modify
1025minibuffer after snatching the filename. 1037this in the minibuffer after snatching the file name.
1026 1038
1027When installed @file{dired-x} will substitute @code{dired-x-find-file} for 1039When installed @file{dired-x} will substitute @code{dired-x-find-file} for
1028@code{find-file} (normally bound to @kbd{C-x C-f}) and 1040@code{find-file} (normally bound to @kbd{C-x C-f}) and
@@ -1040,7 +1052,7 @@ In order to use this feature, you will need to set
1040 1052
1041@code{dired-x-find-file} behaves exactly like @code{find-file} (normally bound 1053@code{dired-x-find-file} behaves exactly like @code{find-file} (normally bound
1042to @kbd{C-x C-f}) unless a prefix argument is passed to the function in which 1054to @kbd{C-x C-f}) unless a prefix argument is passed to the function in which
1043case it will use the filename at point as a guess for the file to visit. 1055case it will use the file name at point as a guess for the file to visit.
1044 1056
1045For example, if the buffer you were reading contained the words 1057For example, if the buffer you were reading contained the words
1046 1058
@@ -1050,6 +1062,7 @@ Available via anonymous ftp in
1050 /roebling.poly.edu:/pub/lisp/crypt++.el.gz 1062 /roebling.poly.edu:/pub/lisp/crypt++.el.gz
1051@end example 1063@end example
1052 1064
1065@noindent
1053then you could move your cursor to the line containing the ftp address and 1066then you could move your cursor to the line containing the ftp address and
1054type @kbd{C-u C-x C-f} (the @kbd{C-u} is a universal argument). The 1067type @kbd{C-u C-x C-f} (the @kbd{C-u} is a universal argument). The
1055minibuffer would read 1068minibuffer would read
@@ -1058,7 +1071,8 @@ minibuffer would read
1058Find file: /roebling.poly.edu:/pub/lisp/crypt++.el.gz 1071Find file: /roebling.poly.edu:/pub/lisp/crypt++.el.gz
1059@end example 1072@end example
1060 1073
1061with the point after the last @code{/}. If you hit return emacs will visit 1074@noindent
1075with the point after the last @code{/}. If you hit @key{RET}, emacs will visit
1062the file at that address. This also works with files on your own computer. 1076the file at that address. This also works with files on your own computer.
1063 1077
1064@item dired-x-find-file-other-window 1078@item dired-x-find-file-other-window
@@ -1076,7 +1090,7 @@ If set to @code{t}, then it means that @file{dired-x} should @emph{not} bind
1076should not bind @code{dired-x-find-file-other-window} over 1090should not bind @code{dired-x-find-file-other-window} over
1077@code{find-file-other-window}. If you change this variable after 1091@code{find-file-other-window}. If you change this variable after
1078@file{dired-x.el} is loaded then do @kbd{M-x dired-x-bind-find-file}. The 1092@file{dired-x.el} is loaded then do @kbd{M-x dired-x-bind-find-file}. The
1079default value of this variable is @kbd{t}; by default, the binding is not 1093default value of this variable is @code{t}; by default, the binding is not
1080done. See @xref{Optional Installation File At Point}. 1094done. See @xref{Optional Installation File At Point}.
1081 1095
1082@item dired-x-bind-find-file 1096@item dired-x-bind-find-file
@@ -1114,19 +1128,19 @@ will toggle between those two.
1114@findex dired-goto-file 1128@findex dired-goto-file
1115@kindex M-g 1129@kindex M-g
1116@item M-g 1130@item M-g
1117(@code{dired-goto-file}) Goto file line of a file (or directory). 1131(@code{dired-goto-file}) Go to the line of a file (or directory).
1118 1132
1119@findex dired-goto-subdir 1133@findex dired-goto-subdir
1120@kindex M-G 1134@kindex M-G
1121@item M-G 1135@item M-G
1122(@code{dired-goto-subdir}) Goto headerline of an inserted directory. 1136(@code{dired-goto-subdir}) Go to the header line of an inserted directory.
1123This commands reads its argument with completion over the names of the 1137This command reads its argument, with completion derived from the names of the
1124inserted subdirectories. 1138inserted subdirectories.
1125@end table 1139@end table
1126 1140
1127@table @kbd 1141@table @kbd
1128@item w 1142@item w
1129@cindex Adding to the kill ring in dired. 1143@cindex Adding to the kill ring in Dired.
1130@kindex w 1144@kindex w
1131@findex dired-copy-filename-as-kill 1145@findex dired-copy-filename-as-kill
1132(@code{dired-copy-filename-as-kill}) The @kbd{w} command puts the names 1146(@code{dired-copy-filename-as-kill}) The @kbd{w} command puts the names
@@ -1141,12 +1155,12 @@ gives you the name of that directory, without looking for marked files.
1141The list of names is also stored onto the variable @code{dired-marked-files} 1155The list of names is also stored onto the variable @code{dired-marked-files}
1142for use, e.g., in the @kbd{M-:} (@code{eval-expression}) command. 1156for use, e.g., in the @kbd{M-:} (@code{eval-expression}) command.
1143 1157
1144As this command also displays what was pushed onto the kill ring you can 1158As this command also displays what was pushed onto the kill ring, you can
1145use it to display the list of currently marked files in the 1159use it to display the list of currently marked files in the
1146echo area (unless you happen to be on a subdirectory headerline). 1160echo area (unless you happen to be on a subdirectory headerline).
1147 1161
1148You can then feed the file name to other Emacs commands with @kbd{C-y}. 1162You can then feed the file name to other Emacs commands with @kbd{C-y}.
1149For example, say you want to rename a long filename to a slightly 1163For example, say you want to rename a file with a long name to a slightly
1150different name. First type @kbd{w} to push the old name onto the kill 1164different name. First type @kbd{w} to push the old name onto the kill
1151ring. Then type @kbd{R} to rename it and use @kbd{C-y} inside @kbd{R}'s 1165ring. Then type @kbd{R} to rename it and use @kbd{C-y} inside @kbd{R}'s
1152minibuffer prompt to insert the old name at a convenient place. 1166minibuffer prompt to insert the old name at a convenient place.
@@ -1157,8 +1171,8 @@ minibuffer prompt to insert the old name at a convenient place.
1157@findex dired-do-toggle 1171@findex dired-do-toggle
1158(@code{dired-do-toggle}) Toggle marks. That is, currently marked 1172(@code{dired-do-toggle}) Toggle marks. That is, currently marked
1159files become unmarked and vice versa. Files marked with other flags 1173files become unmarked and vice versa. Files marked with other flags
1160(such as `D') are not affected. The special directories `.' and `..' 1174(such as @samp{D}) are not affected. The special directories @file{.}
1161are never toggled. 1175and @file{..} are never toggled.
1162@end table 1176@end table
1163 1177
1164@table @code 1178@table @code
@@ -1172,10 +1186,10 @@ Bound to @kbd{M-!} in Dired buffers.
1172@item dired-jump 1186@item dired-jump
1173@findex dired-jump 1187@findex dired-jump
1174@kindex C-x C-j 1188@kindex C-x C-j
1175@cindex Jumping to dired listing containing file. 1189@cindex Jumping to Dired listing containing file.
1176Bound to @kbd{C-x C-j}. Jump back to dired: If in a file, dired the current 1190Bound to @kbd{C-x C-j}. Jump back to Dired: If in a file, edit the current
1177directory and move to file's line. If in Dired already, pop up a level and 1191directory and move to file's line. If in Dired already, pop up a level and
1178goto old directory's line. In case the proper Dired file line cannot be 1192go to old directory's line. In case the proper Dired file line cannot be
1179found, refresh the Dired buffer and try again. 1193found, refresh the Dired buffer and try again.
1180 1194
1181@item dired-jump-other-window 1195@item dired-jump-other-window
@@ -1200,11 +1214,12 @@ to be a UNIX mail folder).
1200 1214
1201@vindex dired-vm-read-only-folders 1215@vindex dired-vm-read-only-folders
1202If you give this command a prefix argument, it will visit the folder 1216If you give this command a prefix argument, it will visit the folder
1203read-only. This only works in VM~5, not VM~4. 1217read-only. This only works in VM 5, not VM 4.
1204 1218
1205If the variable @code{dired-vm-read-only-folders} is t, @code{dired-vm} will 1219If the variable @code{dired-vm-read-only-folders} is @code{t},
1220@code{dired-vm} will
1206visit all folders read-only. If it is neither @code{nil} nor @code{t}, e.g., 1221visit all folders read-only. If it is neither @code{nil} nor @code{t}, e.g.,
1207the symbol @code{'if-file-read-only}, only files not writable by you are 1222the symbol @code{if-file-read-only}, only files not writable by you are
1208visited read-only. This is the recommended value if you run VM 5. 1223visited read-only. This is the recommended value if you run VM 5.
1209 1224
1210@vindex dired-bind-vm 1225@vindex dired-bind-vm
@@ -1226,18 +1241,18 @@ format).
1226 1241
1227@vindex dired-bind-info 1242@vindex dired-bind-info
1228If the variable @code{dired-bind-info} is @code{nil}, @code{dired-info} will 1243If the variable @code{dired-bind-info} is @code{nil}, @code{dired-info} will
1229not be bound to I. 1244not be bound to @kbd{I}.
1230 1245
1231@item dired-man 1246@item dired-man
1232@cindex Running man. 1247@cindex Running man.
1233@kindex N 1248@kindex N
1234@findex dired-man 1249@findex dired-man
1235Bound to @kbd{N}. Run man on this file (assumed to be a file in nroff 1250Bound to @kbd{N}. Run man on this file (assumed to be a file in @code{nroff}
1236format). 1251format).
1237 1252
1238@vindex dired-bind-man 1253@vindex dired-bind-man
1239If the variable @code{dired-bind-man} is @code{nil}, @code{dired-man} will not 1254If the variable @code{dired-bind-man} is @code{nil}, @code{dired-man} will not
1240be bound to N. 1255be bound to @kbd{N}.
1241 1256
1242@item dired-do-relative-symlink 1257@item dired-do-relative-symlink
1243@cindex Relative symbolic links. 1258@cindex Relative symbolic links.
@@ -1247,18 +1262,24 @@ Bound to @kbd{Y}. Relative symlink all marked (or next ARG) files into a
1247directory, or make a relative symbolic link to the current file. This creates 1262directory, or make a relative symbolic link to the current file. This creates
1248relative symbolic links like 1263relative symbolic links like
1249 1264
1265@example
1250 foo -> ../bar/foo 1266 foo -> ../bar/foo
1267@end example
1251 1268
1269@noindent
1252not absolute ones like 1270not absolute ones like
1253 1271
1272@example
1254 foo -> /ugly/path/that/may/change/any/day/bar/foo 1273 foo -> /ugly/path/that/may/change/any/day/bar/foo
1274@end example
1255 1275
1256@item dired-do-relative-symlink-regexp 1276@item dired-do-relative-symlink-regexp
1257@kindex %Y 1277@kindex %Y
1258@findex dired-do-relative-symlink-regexp 1278@findex dired-do-relative-symlink-regexp
1259Bound to @kbd{%Y}. Relative symlink all marked files containing REGEXP to 1279Bound to @kbd{%Y}. Relative symlink all marked files containing
1260NEWNAME. See functions `dired-do-rename-regexp' and `dired-do-relsymlink' for 1280@var{regexp} to @var{newname}. See functions
1261more info. 1281@code{dired-do-rename-regexp} and @code{dired-do-relsymlink} for more
1282info.
1262@end table 1283@end table
1263 1284
1264@node Bugs, Concept Index, Miscellaneous Commands, Top 1285@node Bugs, Concept Index, Miscellaneous Commands, Top