| 1 | \input texinfo @comment -*-texinfo-*- |
| 2 | |
| 3 | @c dired-x.texi --- Sebastian Kremer's Extra DIRED hacked up for GNU Emacs19 |
| 4 | @c |
| 5 | @c Author: Sebastian Kremer <sk@thp.uni-koeln.de> |
| 6 | @c Lawrence R. Dodd <dodd@roebling.poly.edu> |
| 7 | @c [Dodd's address no longer valid.] |
| 8 | @c Version: 2.53 |
| 9 | @c Date: 2001/02/25 14:05:46 |
| 10 | @c Keywords: dired extensions |
| 11 | @c dired-x.el REVISION NUMBER: 2 |
| 12 | |
| 13 | @c State: Released |
| 14 | @c Ident: dired-x.texi,v 2.53 2001/02/25 14:05:46 dodd Released |
| 15 | |
| 16 | @comment %**start of header (This is for running Texinfo on a region.) |
| 17 | @c FOR GNU EMACS USE ../info/dired-x BELOW |
| 18 | @setfilename ../info/dired-x |
| 19 | @c dired-x.el REVISION NUMBER |
| 20 | @settitle Dired Extra Version 2 User's Manual |
| 21 | @iftex |
| 22 | @finalout |
| 23 | @end iftex |
| 24 | @c @setchapternewpage odd % For book style double sided manual. |
| 25 | @comment %**end of header (This is for running Texinfo on a region.) |
| 26 | |
| 27 | @copying |
| 28 | This documents the ``extra'' features for Dired Mode for GNU Emacs found in |
| 29 | the file @file{dired-x.el}. |
| 30 | |
| 31 | Copyright @copyright{} 1993, 1994, 2001, 2002 Free Software Foundation, Inc. |
| 32 | |
| 33 | @quotation |
| 34 | Permission is granted to make and distribute verbatim copies of this |
| 35 | manual provided the copyright notice and this permission notice are |
| 36 | preserved on all copies. |
| 37 | |
| 38 | Permission is granted to copy and distribute modified versions of |
| 39 | this manual under the conditions for verbatim copying, provided that |
| 40 | the entire resulting derived work is distributed under the terms of |
| 41 | a permission notice identical to this one. |
| 42 | |
| 43 | Permission is granted to copy and distribute translations of this |
| 44 | manual into another language, under the above conditions for |
| 45 | modified versions, except that this permission notice may be stated |
| 46 | in a translation approved by the Free Software Foundation. |
| 47 | |
| 48 | The file used to create this is called @file{dired-x.texi}, but the |
| 49 | original work that was altered to make that file was called |
| 50 | @file{dired.texi} written by Sebastian Kremer. |
| 51 | |
| 52 | @ignore |
| 53 | Permission is granted to process this file through TeX and print the |
| 54 | results, provided the printed document carries copying permission |
| 55 | notice identical to this one except for the removal of this paragraph |
| 56 | (this paragraph not being relevant to the printed manual). |
| 57 | |
| 58 | @end ignore |
| 59 | @end quotation |
| 60 | @end copying |
| 61 | |
| 62 | @dircategory Emacs |
| 63 | @direntry |
| 64 | * Dired-X: (dired-x). Dired Extra Features. |
| 65 | @end direntry |
| 66 | |
| 67 | @c @smallbook |
| 68 | @tex |
| 69 | \overfullrule=0pt |
| 70 | %\global\baselineskip 30pt % For printing in double spaces |
| 71 | @end tex |
| 72 | |
| 73 | @titlepage |
| 74 | @sp 6 |
| 75 | @c dired-x.el REVISION NUMBER |
| 76 | @center @titlefont{Dired Extra Version 2} |
| 77 | @sp 2 |
| 78 | @center @titlefont{For The GNU Emacs} |
| 79 | @sp 1 |
| 80 | @center @titlefont{Directory Editor} |
| 81 | @sp 4 |
| 82 | @center Manual Revision: 2.53 |
| 83 | @center 2001/02/25 14:05:46 |
| 84 | @sp 5 |
| 85 | @center Lawrence R@. Dodd |
| 86 | @c @center @t{dodd@@roebling.poly.edu} |
| 87 | @sp 5 |
| 88 | @center (Based on @file{dired.texi} by Sebastian Kremer <sk@@thp.uni-koeln.de>) |
| 89 | @page |
| 90 | @vskip 0pt plus 1filll |
| 91 | @insertcopying |
| 92 | @end titlepage |
| 93 | |
| 94 | @page |
| 95 | |
| 96 | @ifinfo |
| 97 | |
| 98 | @node Top |
| 99 | @comment node-name, next, previous, up |
| 100 | |
| 101 | @noindent |
| 102 | This documents the ``extra'' features for Dired Mode for GNU Emacs that are |
| 103 | provided by the file @file{dired-x.el}. |
| 104 | |
| 105 | @itemize @bullet |
| 106 | |
| 107 | @item |
| 108 | Based on @file{dired.texi} by Sebastian Kremer <sk@@thp.uni-koeln.de> |
| 109 | |
| 110 | @c dired-x.el REVISION NUMBER |
| 111 | @item |
| 112 | For @file{dired-x.el} revision 2 |
| 113 | |
| 114 | @c @item |
| 115 | @c Revision of this manual: 2.53 (2001/02/25 14:05:46) |
| 116 | |
| 117 | @c @item |
| 118 | @c Bugs to Lawrence R. Dodd <dodd@@roebling.poly.edu>. @emph{Please} type |
| 119 | @c @kbd{M-x dired-x-submit-report} to submit a bug report (@pxref{Bugs}). |
| 120 | |
| 121 | @c @item |
| 122 | @c You can obtain a copy of this package via anonymous ftp in |
| 123 | @c @t{/roebling.poly.edu:/pub/packages/dired-x.tar.gz} |
| 124 | |
| 125 | @end itemize |
| 126 | |
| 127 | @menu |
| 128 | * Introduction:: |
| 129 | * Installation:: |
| 130 | * Omitting Files in Dired:: |
| 131 | * Local Variables:: |
| 132 | * Shell Command Guessing:: |
| 133 | * Virtual Dired:: |
| 134 | * Advanced Mark Commands:: |
| 135 | * Multiple Dired Directories:: |
| 136 | * Find File At Point:: |
| 137 | * Miscellaneous Commands:: |
| 138 | * Bugs:: |
| 139 | |
| 140 | * Concept Index:: |
| 141 | * Command Index:: |
| 142 | * Key Index:: |
| 143 | * Variable Index:: |
| 144 | |
| 145 | @end menu |
| 146 | |
| 147 | @end ifinfo |
| 148 | |
| 149 | @node Introduction, Installation, Top, Top |
| 150 | @comment node-name, next, previous, up |
| 151 | @chapter Introduction |
| 152 | |
| 153 | This documents the @emph{extra} features for Dired Mode for GNU Emacs. It |
| 154 | is derived from version 1.191 of Sebastian Kremer's @file{dired-x.el}. |
| 155 | |
| 156 | In adopting this @file{dired-x.el} to GNU Emacs v19 some material that has |
| 157 | been incorporated into @file{dired.el} and @file{dired-aux.el} of the GNU Emacs |
| 158 | 19 distribution has been removed and some material was modified for agreement |
| 159 | with the functions in @file{dired.el} and @file{dired-aux.el}. For example, |
| 160 | the code using @code{gmhist} history functions was replaced with code using |
| 161 | the mini-buffer history now built into GNU Emacs. Finally, a few other |
| 162 | features have been added and a few more functions have been bound to keys. |
| 163 | |
| 164 | @ifinfo |
| 165 | @menu |
| 166 | * Features:: |
| 167 | * Technical Details:: |
| 168 | @end menu |
| 169 | @end ifinfo |
| 170 | |
| 171 | @node Features, Technical Details, , Introduction |
| 172 | @comment node-name, next, previous, up |
| 173 | @section Features |
| 174 | @cindex Features |
| 175 | |
| 176 | Some features provided by Dired Extra |
| 177 | |
| 178 | @enumerate |
| 179 | @item |
| 180 | Omitting uninteresting files from Dired listing. |
| 181 | @itemize @bullet |
| 182 | @xref{Omitting Files in Dired}. |
| 183 | @end itemize |
| 184 | @item |
| 185 | Local variables for Dired directories. |
| 186 | @itemize @bullet |
| 187 | @xref{Local Variables}. |
| 188 | @end itemize |
| 189 | @item |
| 190 | Guessing shell commands in Dired buffers. |
| 191 | @itemize @bullet |
| 192 | @xref{Shell Command Guessing}. |
| 193 | @end itemize |
| 194 | @item |
| 195 | Running Dired command in non-Dired buffers. |
| 196 | @itemize @bullet |
| 197 | @xref{Virtual Dired}. |
| 198 | @end itemize |
| 199 | @item |
| 200 | Finding a file mentioned in a buffer |
| 201 | @itemize @bullet |
| 202 | @xref{Find File At Point}. |
| 203 | @end itemize |
| 204 | @item |
| 205 | Commands using file marking. |
| 206 | @itemize @bullet |
| 207 | @xref{Advanced Mark Commands}. |
| 208 | @end itemize |
| 209 | @end enumerate |
| 210 | |
| 211 | @noindent |
| 212 | @file{dired-x.el} binds some functions to keys in Dired Mode (@pxref{Key |
| 213 | Index}) and also binds @kbd{C-x C-j} and @kbd{C-x 4 C-j} @emph{globally} to |
| 214 | @code{dired-jump} (@pxref{Miscellaneous Commands}). It may also bind @kbd{C-x |
| 215 | C-f} and @kbd{C-x 4 C-f} to @code{dired-x-find-file} and |
| 216 | @code{dired-x-find-file-other-window}, respectively (@pxref{Find File At |
| 217 | Point}). |
| 218 | |
| 219 | @node Technical Details, , Features, Introduction |
| 220 | @comment node-name, next, previous, up |
| 221 | @section Technical Details |
| 222 | @cindex Redefined functions |
| 223 | @cindex @file{dired-aux.el} |
| 224 | |
| 225 | When loaded this code @emph{redefines} the following functions of GNU Emacs |
| 226 | from @file{dired.el} |
| 227 | |
| 228 | @itemize @bullet |
| 229 | @item |
| 230 | @code{dired-clean-up-after-deletion} |
| 231 | @item |
| 232 | @code{dired-find-buffer-nocreate} |
| 233 | @item |
| 234 | @code{dired-initial-position} |
| 235 | @item |
| 236 | @code{dired-up-directory} |
| 237 | @end itemize |
| 238 | |
| 239 | @noindent |
| 240 | and the following functions from @file{dired-aux.el} |
| 241 | |
| 242 | @itemize @bullet |
| 243 | @item |
| 244 | @code{dired-add-entry} |
| 245 | @item |
| 246 | @code{dired-read-shell-command} |
| 247 | @end itemize |
| 248 | |
| 249 | @node Installation, Omitting Files in Dired, Introduction, Top |
| 250 | @comment node-name, next, previous, up |
| 251 | @chapter Installation |
| 252 | |
| 253 | @noindent |
| 254 | This manual describes the Dired features provided by the file |
| 255 | @file{dired-x.el}. To take advantage of these features, you must load the |
| 256 | file and (optionally) set some variables. |
| 257 | |
| 258 | @noindent |
| 259 | In your @file{.emacs} file in your home directory, or in the system-wide |
| 260 | initialization file @file{default.el} in the @file{site-lisp} directory, put |
| 261 | |
| 262 | @example |
| 263 | (add-hook 'dired-load-hook |
| 264 | (lambda () |
| 265 | (load "dired-x") |
| 266 | ;; Set dired-x global variables here. For example: |
| 267 | ;; (setq dired-guess-shell-gnutar "gtar") |
| 268 | ;; (setq dired-x-hands-off-my-keys nil) |
| 269 | )) |
| 270 | (add-hook 'dired-mode-hook |
| 271 | (lambda () |
| 272 | ;; Set dired-x buffer-local variables here. For example: |
| 273 | ;; (dired-omit-mode 1) |
| 274 | )) |
| 275 | @end example |
| 276 | |
| 277 | @noindent |
| 278 | This will load @file{dired-x.el} when Dired is first invoked (for example, |
| 279 | when you first type @kbd{C-x d}). |
| 280 | |
| 281 | @ifinfo |
| 282 | @menu |
| 283 | * Optional Installation Dired Jump:: |
| 284 | * Optional Installation File At Point:: |
| 285 | @end menu |
| 286 | @end ifinfo |
| 287 | |
| 288 | @node Optional Installation Dired Jump, Optional Installation File At Point, , Installation |
| 289 | @comment node-name, next, previous, up |
| 290 | @section Optional Installation Dired Jump |
| 291 | |
| 292 | @cindex Autoloading @code{dired-jump} and @code{dired-jump-other-window} |
| 293 | |
| 294 | In order to have @code{dired-jump} and @code{dired-jump-other-window} |
| 295 | (@pxref{Miscellaneous Commands}) work @emph{before} @code{dired} and |
| 296 | @code{dired-x} have been properly loaded the user should set-up an autoload |
| 297 | for these functions. In your @file{.emacs} file put |
| 298 | |
| 299 | @example |
| 300 | ;;; Autoload `dired-jump' and `dired-jump-other-window'. |
| 301 | ;;; We autoload from FILE dired.el. This will then load dired-x.el |
| 302 | ;;; and hence define `dired-jump' and `dired-jump-other-window'. |
| 303 | (define-key global-map "\C-x\C-j" 'dired-jump) |
| 304 | (define-key global-map "\C-x4\C-j" 'dired-jump-other-window) |
| 305 | |
| 306 | (autoload (quote dired-jump) "dired" "\ |
| 307 | Jump to Dired buffer corresponding to current buffer. |
| 308 | If in a file, Dired the current directory and move to file's line. |
| 309 | If in Dired already, pop up a level and goto old directory's line. |
| 310 | In case the proper Dired file line cannot be found, refresh the Dired |
| 311 | buffer and try again." t nil) |
| 312 | |
| 313 | (autoload (quote dired-jump-other-window) "dired" "\ |
| 314 | Like \\[dired-jump] (dired-jump) but in other window." t nil) |
| 315 | @end example |
| 316 | |
| 317 | Note that in recent releases of GNU Emacs 19 (i.e., 19.25 or later) the file |
| 318 | @file{../lisp/loaddefs.el} of the Emacs distribution already contains the |
| 319 | proper auto-loading for @code{dired-jump} so you need only put |
| 320 | |
| 321 | @example |
| 322 | (define-key global-map "\C-x\C-j" 'dired-jump) |
| 323 | @end example |
| 324 | |
| 325 | @noindent |
| 326 | in your @file{.emacs} file in order to have @kbd{C-x C-j} work |
| 327 | before @code{dired} is loaded. |
| 328 | |
| 329 | @node Optional Installation File At Point, , Optional Installation Dired Jump, Installation |
| 330 | @comment node-name, next, previous, up |
| 331 | @section Optional Installation File At Point |
| 332 | |
| 333 | @cindex Binding @code{dired-x-find-file} |
| 334 | If you choose to have @file{dired-x.el} bind @code{dired-x-find-file} over |
| 335 | @code{find-file} (@pxref{Find File At Point}), then you will need to set |
| 336 | @code{dired-x-hands-off-my-keys} and make a call to the function |
| 337 | @code{dired-x-bind-find-file} in the @code{dired-load-hook}: |
| 338 | |
| 339 | @example |
| 340 | (add-hook 'dired-load-hook |
| 341 | (lambda () |
| 342 | (load "dired-x") |
| 343 | ;; Bind dired-x-find-file. |
| 344 | (setq dired-x-hands-off-my-keys nil) |
| 345 | ;; Make sure our binding preference is invoked. |
| 346 | (dired-x-bind-find-file) |
| 347 | )) |
| 348 | @end example |
| 349 | |
| 350 | Alternatively, you can set the variable @emph{before} @file{dired-x.el} is |
| 351 | loaded |
| 352 | |
| 353 | @example |
| 354 | (add-hook 'dired-load-hook |
| 355 | (lambda () |
| 356 | ;; Bind dired-x-find-file. |
| 357 | (setq dired-x-hands-off-my-keys nil) |
| 358 | (load "dired-x") |
| 359 | )) |
| 360 | @end example |
| 361 | |
| 362 | @node Omitting Files in Dired, Local Variables, Installation, Top |
| 363 | @comment node-name, next, previous, up |
| 364 | @chapter Omitting Files in Dired |
| 365 | |
| 366 | @cindex Omitting Files in Dired |
| 367 | @cindex Uninteresting files |
| 368 | @dfn{Omitting} a file means removing it from the directory listing. Omitting |
| 369 | is useful for keeping Dired buffers free of ``uninteresting'' files (for |
| 370 | instance, auto-save, auxiliary, backup, and revision control files) so that |
| 371 | the user can concentrate on the interesting files. Like hidden files, omitted |
| 372 | files are never seen by Dired. Omitting differs from hiding in several |
| 373 | respects: |
| 374 | |
| 375 | @itemize @bullet |
| 376 | |
| 377 | @item |
| 378 | Omitting works on individual files, not on directories; an entire directory |
| 379 | cannot be omitted (though each of its files could be). |
| 380 | |
| 381 | @item |
| 382 | Omitting is wholesale; if omitting is turned on for a Dired buffer, then all |
| 383 | uninteresting files listed in that buffer are omitted. The user does not omit |
| 384 | (or unomit) files one at a time. |
| 385 | |
| 386 | @item |
| 387 | Omitting can be automatic; uninteresting file lines in the buffer can be |
| 388 | removed before the user ever sees them. |
| 389 | |
| 390 | @item |
| 391 | Marked files are never omitted. |
| 392 | @end itemize |
| 393 | |
| 394 | @table @kbd |
| 395 | @item M-o |
| 396 | @kindex M-o |
| 397 | @findex dired-omit-mode |
| 398 | (@code{dired-omit-mode}) Toggle between displaying and omitting |
| 399 | ``uninteresting'' files. |
| 400 | @item * O |
| 401 | @kindex * O |
| 402 | @findex dired-mark-omitted |
| 403 | (@code{dired-mark-omitted}) Mark ``uninteresting'' files. |
| 404 | @end table |
| 405 | |
| 406 | @noindent |
| 407 | In order to make Dired Omit work you first need to load @file{dired-x.el} |
| 408 | inside @code{dired-load-hook} (@pxref{Installation}) and then evaluate |
| 409 | @code{(dired-omit-mode 1)} in some way (@pxref{Omitting Variables}). |
| 410 | |
| 411 | @ifinfo |
| 412 | @menu |
| 413 | * Omitting Variables:: |
| 414 | * Omitting Examples:: |
| 415 | * Omitting Technical:: |
| 416 | @end menu |
| 417 | @end ifinfo |
| 418 | |
| 419 | @node Omitting Variables, Omitting Examples, , Omitting Files in Dired |
| 420 | @comment node-name, next, previous, up |
| 421 | |
| 422 | @section Omitting Variables |
| 423 | |
| 424 | @cindex Customizing file omitting |
| 425 | The following variables can be used to customize omitting. |
| 426 | |
| 427 | @table @code |
| 428 | |
| 429 | @vindex dired-omit-mode |
| 430 | @item dired-omit-mode |
| 431 | |
| 432 | Default: @code{nil} |
| 433 | |
| 434 | @cindex How to make omitting the default in Dired |
| 435 | If non-@code{nil}, ``uninteresting'' files are not listed. |
| 436 | Uninteresting files are those whose files whose names match regexp |
| 437 | @code{dired-omit-files}, plus those ending with extensions in |
| 438 | @code{dired-omit-extensions}. @kbd{M-o} (@code{dired-omit-mode}) |
| 439 | toggles its value, which is buffer-local. Put |
| 440 | |
| 441 | @example |
| 442 | (dired-omit-mode 1) |
| 443 | @end example |
| 444 | |
| 445 | @noindent |
| 446 | inside your @code{dired-mode-hook} to have omitting initially turned on in |
| 447 | @emph{every} Dired buffer (@pxref{Installation}). You can then use @kbd{M-o} to |
| 448 | unomit in that buffer. |
| 449 | |
| 450 | To enable omitting automatically only in certain directories one can use Dired |
| 451 | Local Variables and put |
| 452 | |
| 453 | @example |
| 454 | Local Variables: |
| 455 | dired-omit-mode: t |
| 456 | End: |
| 457 | @end example |
| 458 | |
| 459 | @noindent |
| 460 | into a file @file{.dired} (the default value of |
| 461 | @code{dired-local-variables-file}) in that directory (@pxref{Local Variables}). |
| 462 | |
| 463 | @table @code |
| 464 | @findex dired-omit-here-always |
| 465 | @item dired-omit-here-always |
| 466 | |
| 467 | This is an interactive function that creates a local variables file exactly |
| 468 | like the example above (if it does not already exist) in the file |
| 469 | @code{dired-local-variables-file} in the current directory and then refreshes |
| 470 | the directory listing (@pxref{Local Variables}). |
| 471 | @end table |
| 472 | |
| 473 | @vindex dired-omit-files |
| 474 | @item dired-omit-files |
| 475 | |
| 476 | Default: @code{"^#\\|\\.$"} |
| 477 | |
| 478 | Files whose names match this buffer-local regexp will not be displayed. |
| 479 | This only has effect when @code{dired-omit-mode}'s value is @code{t}. |
| 480 | |
| 481 | The default value omits the special directories @file{.} and @file{..} and |
| 482 | autosave files (plus other files ending in @file{.}) (@pxref{Omitting Examples}). |
| 483 | |
| 484 | @vindex dired-omit-extensions |
| 485 | @item dired-omit-extensions |
| 486 | |
| 487 | Default: The elements of @code{completion-ignored-extensions}, |
| 488 | @code{dired-latex-unclean-extensions}, @code{dired-bibtex-unclean-extensions} |
| 489 | and @code{dired-texinfo-unclean-extensions}. |
| 490 | |
| 491 | If non-@code{nil}, a list of extensions (strings) to omit from Dired listings. |
| 492 | Its format is the same as that of @code{completion-ignored-extensions}. |
| 493 | |
| 494 | @vindex dired-omit-localp |
| 495 | @item dired-omit-localp |
| 496 | |
| 497 | Default: @code{no-dir} |
| 498 | |
| 499 | The @var{localp} argument @code{dired-omit-expunge} passes to |
| 500 | @code{dired-get-filename}. If it is @code{no-dir}, omitting is much faster, |
| 501 | but you can only match against the non-directory part of the file name. Set it |
| 502 | to @code{nil} if you need to match the whole file name or @code{t} to match the |
| 503 | file name relative to the buffer's top-level directory. |
| 504 | |
| 505 | @item dired-omit-marker-char |
| 506 | @vindex dired-omit-marker-char |
| 507 | @cindex Omitting additional files |
| 508 | Default: @kbd{C-o} |
| 509 | |
| 510 | Temporary marker used by Dired to implement omitting. Should never be used |
| 511 | as marker by the user or other packages. There is one exception to this rule: |
| 512 | by adding |
| 513 | |
| 514 | @example |
| 515 | (setq dired-mark-keys "\C-o") |
| 516 | ;; i.e., the value of dired-omit-marker-char |
| 517 | ;; (which is not defined yet) |
| 518 | @end example |
| 519 | |
| 520 | @noindent |
| 521 | to your @file{~/.emacs}, you can bind the @kbd{C-o} key to insert a |
| 522 | @kbd{C-o} marker, thus causing these files to be omitted in addition to the |
| 523 | usually omitted files. Unfortunately the files you omitted manually this way |
| 524 | will show up again after reverting the buffer, unlike the others. |
| 525 | |
| 526 | @end table |
| 527 | |
| 528 | @node Omitting Examples, Omitting Technical, Omitting Variables, Omitting Files in Dired |
| 529 | @comment node-name, next, previous, up |
| 530 | @section Examples of Omitting Various File Types |
| 531 | |
| 532 | @itemize @bullet |
| 533 | |
| 534 | @item |
| 535 | @cindex RCS files, how to omit them in Dired |
| 536 | @cindex Omitting RCS files in Dired |
| 537 | If you wish to avoid seeing RCS files and the @file{RCS} directory, then put |
| 538 | |
| 539 | @example |
| 540 | (setq dired-omit-files |
| 541 | (concat dired-omit-files "\\|^RCS$\\|,v$")) |
| 542 | @end example |
| 543 | |
| 544 | @noindent |
| 545 | in the @code{dired-load-hook} (@pxref{Installation}). This assumes |
| 546 | @code{dired-omit-localp} has its default value of @code{no-dir} to make the |
| 547 | @code{^}-anchored matches work. As a slower alternative, with |
| 548 | @code{dired-omit-localp} set to @code{nil}, you can use @code{/} instead of |
| 549 | @code{^} in the regexp. |
| 550 | |
| 551 | @item |
| 552 | @cindex Tib files, how to omit them in Dired |
| 553 | @cindex Omitting tib files in Dired |
| 554 | If you use @code{tib}, the bibliography program for use with @TeX{} and |
| 555 | La@TeX{}, and you |
| 556 | want to omit the @file{INDEX} and the @file{*-t.tex} files, then put |
| 557 | |
| 558 | @example |
| 559 | (setq dired-omit-files |
| 560 | (concat dired-omit-files "\\|^INDEX$\\|-t\\.tex$")) |
| 561 | @end example |
| 562 | |
| 563 | @noindent |
| 564 | in the @code{dired-load-hook} (@pxref{Installation}). |
| 565 | |
| 566 | @item |
| 567 | @cindex Dot files, how to omit them in Dired |
| 568 | @cindex Omitting dot files in Dired |
| 569 | If you do not wish to see @samp{dot} files (files starting with a @file{.}), |
| 570 | then put |
| 571 | |
| 572 | @example |
| 573 | (setq dired-omit-files |
| 574 | (concat dired-omit-files "\\|^\\..+$")) |
| 575 | @end example |
| 576 | |
| 577 | @noindent |
| 578 | in the @code{dired-load-hook} (@pxref{Installation}). |
| 579 | |
| 580 | @end itemize |
| 581 | |
| 582 | @node Omitting Technical, , Omitting Examples, Omitting Files in Dired |
| 583 | @comment node-name, next, previous, up |
| 584 | @section Some Technical Details of Omitting |
| 585 | |
| 586 | Loading @file{dired-x.el} will install Dired Omit by putting |
| 587 | @code{dired-omit-expunge} on your @code{dired-after-readin-hook}, and will |
| 588 | call @code{dired-extra-startup}, which in turn calls @code{dired-omit-startup} |
| 589 | in your @code{dired-mode-hook}. |
| 590 | |
| 591 | @node Local Variables, Shell Command Guessing, Omitting Files in Dired, Top |
| 592 | @comment node-name, next, previous, up |
| 593 | @chapter Local Variables for Dired Directories |
| 594 | |
| 595 | @cindex Local Variables for Dired Directories |
| 596 | @vindex dired-local-variables-file |
| 597 | @vindex dired-enable-local-variables |
| 598 | @noindent |
| 599 | When Dired visits a directory, it looks for a file whose name is the value of |
| 600 | variable @code{dired-local-variables-file} (default: @file{.dired}). If such |
| 601 | a file is found, Dired will temporarily insert it into the Dired buffer and |
| 602 | run @code{hack-local-variables}. |
| 603 | |
| 604 | @noindent |
| 605 | For example, if the user puts |
| 606 | |
| 607 | @example |
| 608 | Local Variables: |
| 609 | dired-actual-switches: "-lat" |
| 610 | dired-omit-mode: t |
| 611 | End: |
| 612 | @end example |
| 613 | |
| 614 | @noindent |
| 615 | into a file called @file{.dired} in a directory then when that directory is |
| 616 | viewed it will be |
| 617 | |
| 618 | @enumerate |
| 619 | @item |
| 620 | sorted by date |
| 621 | @item |
| 622 | omitted automatically |
| 623 | @end enumerate |
| 624 | |
| 625 | @noindent |
| 626 | You can set @code{dired-local-variables-file} to @code{nil} to suppress this. |
| 627 | The value of @code{dired-enable-local-variables} controls if and how these |
| 628 | local variables are read. This variable exists so that if may override the |
| 629 | default value of @code{enable-local-variables}. |
| 630 | |
| 631 | @noindent |
| 632 | Please see the GNU Emacs Manual to learn more about local variables. |
| 633 | @xref{File Variables,Local Variables in Files,Local Variables in |
| 634 | Files,emacs,The GNU Emacs Manual}. |
| 635 | |
| 636 | @noindent |
| 637 | The following variables affect Dired Local Variables |
| 638 | |
| 639 | @table @code |
| 640 | @vindex dired-local-variables-file |
| 641 | @item dired-local-variables-file |
| 642 | Default: @code{".dired"} |
| 643 | |
| 644 | If non-@code{nil}, file name for local variables for Dired. If Dired finds a |
| 645 | file with that name in the current directory, it will temporarily insert it |
| 646 | into the Dired buffer and run @code{hack-local-variables}. |
| 647 | |
| 648 | @vindex dired-enable-local-variables |
| 649 | @item dired-enable-local-variables |
| 650 | Default: @code{t} |
| 651 | |
| 652 | Controls the use of local-variables lists in Dired. The value can be @code{t}, |
| 653 | @code{nil}, or something else. A value of @code{t} means local-variables |
| 654 | lists are obeyed in the @code{dired-local-variables-file}; @code{nil} means |
| 655 | they are ignored; anything else means query. This variable temporarily |
| 656 | overrides the value of @code{enable-local-variables} when the Dired Local |
| 657 | Variables are hacked. |
| 658 | @end table |
| 659 | |
| 660 | @node Shell Command Guessing, Virtual Dired, Local Variables, Top |
| 661 | @comment node-name, next, previous, up |
| 662 | @chapter Shell Command Guessing |
| 663 | @cindex Guessing shell commands for files. |
| 664 | |
| 665 | Based upon the name of a file, Dired tries to guess what shell |
| 666 | command you might want to apply to it. For example, if you have point |
| 667 | on a file named @file{foo.tar} and you press @kbd{!}, Dired will guess |
| 668 | you want to @samp{tar xvf} it and suggest that as the default shell |
| 669 | command. |
| 670 | |
| 671 | The default is mentioned in brackets and you can type @kbd{M-p} to get |
| 672 | the default into the minibuffer and then edit it, e.g., to change |
| 673 | @samp{tar xvf} to @samp{tar tvf}. If there are several commands for a given |
| 674 | file, e.g., @samp{xtex} and @samp{dvips} for a @file{.dvi} file, you can type |
| 675 | @kbd{M-p} several times to see each of the matching commands. |
| 676 | |
| 677 | Dired only tries to guess a command for a single file, never for a list |
| 678 | of marked files. |
| 679 | |
| 680 | @table @code |
| 681 | @item dired-guess-shell-alist-default |
| 682 | @vindex dired-guess-shell-alist-default |
| 683 | Predefined rules for shell commands. Set this to @code{nil} to turn guessing off. |
| 684 | The elements of @code{dired-guess-shell-alist-user} (defined by the |
| 685 | user) will override these rules.@refill |
| 686 | |
| 687 | @item dired-guess-shell-alist-user |
| 688 | @vindex dired-guess-shell-alist-user |
| 689 | If non-@code{nil}, a user-defined alist of file regexps and their suggested |
| 690 | commands. These rules take precedence over the predefined rules in the |
| 691 | variable @code{dired-guess-shell-alist-default} (to which they are prepended) |
| 692 | when @code{dired-do-shell-command} is run). |
| 693 | @refill |
| 694 | |
| 695 | Each element of the alist looks like |
| 696 | |
| 697 | @example |
| 698 | (@var{regexp} @var{command}@dots{}) |
| 699 | @end example |
| 700 | |
| 701 | @noindent |
| 702 | where each @var{command} can either be a string or a Lisp expression |
| 703 | that evaluates to a string. If several commands are given, all of |
| 704 | them will temporarily be pushed onto the history. |
| 705 | |
| 706 | If @samp{*} in the shell command, that means to substitute the file |
| 707 | name. |
| 708 | |
| 709 | You can set this variable in your @file{~/.emacs}. For example, |
| 710 | to add rules for @samp{.foo} and @samp{.bar} file extensions, write |
| 711 | |
| 712 | @example |
| 713 | (setq dired-guess-shell-alist-user |
| 714 | (list |
| 715 | (list "\\.foo$" "@var{foo-command}");; fixed rule |
| 716 | ;; possibly more rules... |
| 717 | (list "\\.bar$";; rule with condition test |
| 718 | '(if @var{condition} |
| 719 | "@var{bar-command-1}" |
| 720 | "@var{bar-command-2}")))) |
| 721 | @end example |
| 722 | |
| 723 | @noindent |
| 724 | This will override any predefined rules for the same extensions. |
| 725 | |
| 726 | @item dired-guess-shell-gnutar |
| 727 | @vindex dired-guess-shell-gnutar |
| 728 | @cindex Passing GNU Tar its @samp{z} switch. |
| 729 | Default: @code{nil} |
| 730 | |
| 731 | If non-@code{nil}, this is the name of the GNU Tar executable (e.g., |
| 732 | @samp{tar} or @samp{gnutar}). GNU Tar's @samp{z} switch is used for |
| 733 | compressed tar files. |
| 734 | If you don't have GNU tar, set this to @code{nil}: a pipe using @samp{zcat} is |
| 735 | then used. |
| 736 | |
| 737 | @item dired-guess-shell-gzip-quiet |
| 738 | @vindex dired-guess-shell-gzip-quiet |
| 739 | @cindex @code{gzip} |
| 740 | Default: @code{t} |
| 741 | |
| 742 | A non-@code{nil} value means that @samp{-q} is passed to @code{gzip} |
| 743 | overriding a verbose option in the @env{GZIP} environment variable. |
| 744 | |
| 745 | @item dired-guess-shell-znew-switches nil |
| 746 | @vindex dired-guess-shell-znew-switches nil |
| 747 | @cindex @code{znew} |
| 748 | Default: @code{nil} |
| 749 | |
| 750 | A string of switches passed to @code{znew}. An example is |
| 751 | @samp{-K} which will make @code{znew} keep a @file{.Z} file when it is |
| 752 | smaller than the @file{.gz} file. |
| 753 | |
| 754 | @item dired-shell-command-history nil |
| 755 | @vindex dired-shell-command-history nil |
| 756 | |
| 757 | History list for commands that read dired-shell commands. |
| 758 | @end table |
| 759 | |
| 760 | @node Virtual Dired, Advanced Mark Commands, Shell Command Guessing, Top |
| 761 | @comment node-name, next, previous, up |
| 762 | @chapter Virtual Dired |
| 763 | |
| 764 | @cindex Virtual Dired |
| 765 | @cindex Perusing @code{ls} listings |
| 766 | @cindex @code{ls} listings, how to peruse them in Dired |
| 767 | Using @dfn{Virtual Dired} means putting a buffer with Dired-like |
| 768 | contents in Dired mode. The files described by the buffer contents need |
| 769 | not actually exist. This is useful if you want to peruse an @samp{ls -lR} |
| 770 | output file, for example one you got from an FTP server. You can use |
| 771 | all motion commands usually available in Dired. You can also use |
| 772 | it to save a Dired buffer in a file and resume it in a later session. |
| 773 | |
| 774 | @findex dired-virtual |
| 775 | @kindex g |
| 776 | @findex dired-virtual-revert |
| 777 | Type @kbd{M-x dired-virtual} to put the current buffer into virtual |
| 778 | Dired mode. You will be prompted for the top level directory of this |
| 779 | buffer, with a default value guessed from the buffer contents. To |
| 780 | convert the virtual to a real Dired buffer again, type @kbd{g} (which |
| 781 | calls @code{dired-virtual-revert}) in the virtual Dired buffer and |
| 782 | answer @samp{y}. You don't have to do this, though: you can relist |
| 783 | single subdirectories using @kbd{l} (@code{dired-do-redisplay}) on the subdirectory |
| 784 | headerline, leaving the buffer in virtual Dired mode all the time. |
| 785 | |
| 786 | @findex dired-virtual-mode |
| 787 | @vindex auto-mode-alist |
| 788 | The function @samp{dired-virtual-mode} is specially designed to turn on |
| 789 | virtual Dired mode from the @code{auto-mode-alist}. To edit all |
| 790 | @file{*.dired} files automatically in virtual Dired mode, put this into your |
| 791 | @file{~/.emacs}: |
| 792 | |
| 793 | @example |
| 794 | (setq auto-mode-alist (cons '("[^/]\\.dired$" . dired-virtual-mode) |
| 795 | auto-mode-alist)) |
| 796 | @end example |
| 797 | |
| 798 | @noindent |
| 799 | The regexp is a bit more complicated than usual to exclude @file{.dired} |
| 800 | local-variable files. |
| 801 | |
| 802 | @node Advanced Mark Commands, Multiple Dired Directories, Virtual Dired, Top |
| 803 | @comment node-name, next, previous, up |
| 804 | @chapter Advanced Mark Commands |
| 805 | |
| 806 | @table @kbd |
| 807 | @item F |
| 808 | @kindex F |
| 809 | @cindex Visiting several files at once |
| 810 | @cindex Simultaneous visiting of several files |
| 811 | @findex dired-do-find-marked-files |
| 812 | (@code{dired-do-find-marked-files}) Find all marked files at once displaying |
| 813 | them simultaneously. If optional @var{noselect} is non-@code{nil} then just |
| 814 | find the |
| 815 | files but do not select. If you want to keep the Dired buffer displayed, type |
| 816 | @kbd{C-x 2} first. If you want just the marked files displayed and nothing |
| 817 | else, type @kbd{C-x 1} first. |
| 818 | |
| 819 | The current window is split across all files marked, as evenly as possible. |
| 820 | Remaining lines go to the bottom-most window. The number of files that can be |
| 821 | displayed this way is restricted by the height of the current window and the |
| 822 | variable @code{window-min-height}. |
| 823 | @end table |
| 824 | |
| 825 | @table @code |
| 826 | @item dired-mark-extension |
| 827 | @findex dired-mark-extension |
| 828 | Mark all files with a certain extension for use in later commands. A @samp{.} |
| 829 | is not automatically prepended to the string entered, you must type it |
| 830 | explicitly. |
| 831 | |
| 832 | When called from Lisp, @var{extension} may also be a list of extensions |
| 833 | and an optional argument @var{marker-char} specifies the marker used. |
| 834 | |
| 835 | @item dired-flag-extension |
| 836 | @findex dired-flag-extension |
| 837 | Flag all files with a certain extension for deletion. A @samp{.} is |
| 838 | @emph{not} automatically prepended to the string entered. |
| 839 | @end table |
| 840 | |
| 841 | @ifinfo |
| 842 | @menu |
| 843 | * Advanced Cleaning Functions:: |
| 844 | * Advanced Cleaning Variables:: |
| 845 | * Special Marking Function:: |
| 846 | @end menu |
| 847 | @end ifinfo |
| 848 | |
| 849 | @node Advanced Cleaning Functions, Advanced Cleaning Variables, , Advanced Mark Commands |
| 850 | @comment node-name, next, previous, up |
| 851 | |
| 852 | @section Advanced Cleaning Functions |
| 853 | |
| 854 | @table @code |
| 855 | @item dired-clean-patch |
| 856 | @findex dired-clean-patch |
| 857 | Flag dispensable files created by the @samp{patch} program for deletion. See |
| 858 | variable @code{dired-patch-unclean-extensions}. |
| 859 | |
| 860 | @item dired-clean-tex |
| 861 | @findex dired-clean-tex |
| 862 | Flag dispensable files created by @TeX{}, La@TeX{}, and @samp{texinfo} for |
| 863 | deletion. See the following variables (@pxref{Advanced Cleaning Variables}): |
| 864 | |
| 865 | @itemize @bullet |
| 866 | @item |
| 867 | @code{dired-tex-unclean-extensions} |
| 868 | @item |
| 869 | @code{dired-texinfo-unclean-extensions} |
| 870 | @item |
| 871 | @code{dired-latex-unclean-extensions} |
| 872 | @item |
| 873 | @code{dired-bibtex-unclean-extensions} |
| 874 | @end itemize |
| 875 | |
| 876 | @item dired-very-clean-tex |
| 877 | @findex dired-very-clean-tex |
| 878 | Flag dispensable files created by @TeX{}, La@TeX{}, @samp{texinfo}, |
| 879 | and @file{*.dvi} files for deletion. |
| 880 | @end table |
| 881 | |
| 882 | @node Advanced Cleaning Variables, Special Marking Function, Advanced Cleaning Functions, Advanced Mark Commands |
| 883 | @comment node-name, next, previous, up |
| 884 | |
| 885 | @section Advanced Cleaning Variables |
| 886 | |
| 887 | @noindent Variables used by the above cleaning commands (and in the default value for |
| 888 | variable @code{dired-omit-extensions}, @pxref{Omitting Variables}) |
| 889 | |
| 890 | @table @code |
| 891 | @item dired-patch-unclean-extensions |
| 892 | @vindex dired-patch-unclean-extensions |
| 893 | Default: @code{(".rej" ".orig")} |
| 894 | |
| 895 | List of extensions of dispensable files created by the @samp{patch} program. |
| 896 | |
| 897 | @item dired-tex-unclean-extensions |
| 898 | @vindex dired-tex-unclean-extensions |
| 899 | Default: @code{(".toc" ".log" ".aux")} |
| 900 | |
| 901 | List of extensions of dispensable files created by @TeX{}. |
| 902 | |
| 903 | @item dired-texinfo-unclean-extensions |
| 904 | @vindex dired-texinfo-unclean-extensions |
| 905 | Default: @code{(".cp" ".cps" ".fn" ".fns" ".ky" ".kys"} |
| 906 | @code{".pg" ".pgs" ".tp" ".tps" ".vr" ".vrs")} |
| 907 | |
| 908 | List of extensions of dispensable files created by @samp{texinfo}. |
| 909 | |
| 910 | @item dired-latex-unclean-extensions |
| 911 | @vindex dired-latex-unclean-extensions |
| 912 | Default: @code{(".idx" ".lof" ".lot" ".glo")} |
| 913 | |
| 914 | List of extensions of dispensable files created by La@TeX{}. |
| 915 | |
| 916 | @item dired-bibtex-unclean-extensions |
| 917 | @vindex dired-bibtex-unclean-extensions |
| 918 | Default: @code{(".blg" ".bbl")} |
| 919 | |
| 920 | List of extensions of dispensable files created by Bib@TeX{}. |
| 921 | @end table |
| 922 | |
| 923 | @node Special Marking Function, , Advanced Cleaning Variables, Advanced Mark Commands |
| 924 | @comment node-name, next, previous, up |
| 925 | |
| 926 | @section Special Marking Function |
| 927 | |
| 928 | @table @kbd |
| 929 | @item M-( |
| 930 | @kindex M-( |
| 931 | @findex dired-mark-sexp |
| 932 | @cindex Lisp expression, marking files with in Dired |
| 933 | @cindex Mark file by Lisp expression |
| 934 | (@code{dired-mark-sexp}) Mark files for which @var{predicate} returns |
| 935 | non-@code{nil}. With a prefix argument, unflag those files instead. |
| 936 | |
| 937 | The @var{predicate} is a Lisp expression that can refer to the following |
| 938 | symbols: |
| 939 | @table @code |
| 940 | @item inode |
| 941 | [@i{integer}] the inode of the file (only for @samp{ls -i} output) |
| 942 | @item s |
| 943 | [@i{integer}] the size of the file for @samp{ls -s} output (usually in blocks or, |
| 944 | with @samp{-k}, in KBytes) |
| 945 | @item mode |
| 946 | [@i{string}] file permission bits, e.g., @samp{-rw-r--r--} |
| 947 | @item nlink |
| 948 | [@i{integer}] number of links to file |
| 949 | @item uid |
| 950 | [@i{string}] owner |
| 951 | @item gid |
| 952 | [@i{string}] group (If the gid is not displayed by @samp{ls}, this |
| 953 | will still be set (to the same as uid)) |
| 954 | @item size |
| 955 | [@i{integer}] file size in bytes |
| 956 | @item time |
| 957 | [@i{string}] the time that @samp{ls} displays, e.g., @samp{Feb 12 14:17} |
| 958 | @item name |
| 959 | [@i{string}] the name of the file |
| 960 | @item sym |
| 961 | [@i{string}] if file is a symbolic link, the linked-to name, else @code{""} |
| 962 | @end table |
| 963 | |
| 964 | @noindent |
| 965 | For example, use |
| 966 | @example |
| 967 | (equal 0 size) |
| 968 | @end example |
| 969 | to mark all zero length files. |
| 970 | |
| 971 | To find out all not yet compiled Emacs Lisp files in a directory, Dired |
| 972 | all @file{.el} files in the lisp directory using the wildcard |
| 973 | @samp{*.el}. Then use @kbd{M-(} with |
| 974 | @example |
| 975 | (not (file-exists-p (concat name "c"))) |
| 976 | @end example |
| 977 | to mark all @file{.el} files without a corresponding @file{.elc} file. |
| 978 | |
| 979 | @end table |
| 980 | |
| 981 | @node Multiple Dired Directories, Find File At Point, Advanced Mark Commands, Top |
| 982 | @comment node-name, next, previous, up |
| 983 | @chapter Multiple Dired Directories and Non-Dired Commands |
| 984 | |
| 985 | @cindex Multiple Dired directories |
| 986 | @cindex Working directory |
| 987 | An Emacs buffer can have but one working directory, stored in the |
| 988 | buffer-local variable @code{default-directory}. A Dired buffer may have |
| 989 | several subdirectories inserted, but it still has only one working |
| 990 | directory: that of the top-level Dired directory in that buffer. For |
| 991 | some commands it is appropriate that they use the current Dired |
| 992 | directory instead of @code{default-directory}, e.g., @code{find-file} and |
| 993 | @code{compile}. |
| 994 | |
| 995 | A general mechanism is provided for special handling of the working |
| 996 | directory in special major modes: |
| 997 | |
| 998 | @table @code |
| 999 | @item default-directory-alist |
| 1000 | @vindex default-directory-alist |
| 1001 | Default: @code{((dired-mode . (dired-current-directory)))} |
| 1002 | |
| 1003 | Alist of major modes and their notion of @code{default-directory}, as a |
| 1004 | Lisp expression to evaluate. A resulting value of @code{nil} is ignored |
| 1005 | in favor of @code{default-directory}. |
| 1006 | |
| 1007 | @item dired-default-directory |
| 1008 | @findex dired-default-directory |
| 1009 | Use this function like you would use the variable |
| 1010 | @code{default-directory}, except that @code{dired-default-directory} |
| 1011 | also consults the variable @code{default-directory-alist}. |
| 1012 | @end table |
| 1013 | |
| 1014 | @node Find File At Point, Miscellaneous Commands, Multiple Dired Directories, Top |
| 1015 | @comment node-name, next, previous, up |
| 1016 | |
| 1017 | @section Find File At Point |
| 1018 | @cindex Visiting a file mentioned in a buffer |
| 1019 | @cindex Finding a file at point |
| 1020 | |
| 1021 | @file{dired-x} provides a method of visiting or editing a file mentioned in |
| 1022 | the buffer you are viewing (e.g., a mail buffer, a news article, a |
| 1023 | @file{README} file, etc.) or to test if that file exists. You can then modify |
| 1024 | this in the minibuffer after snatching the file name. |
| 1025 | |
| 1026 | When installed @file{dired-x} will substitute @code{dired-x-find-file} for |
| 1027 | @code{find-file} (normally bound to @kbd{C-x C-f}) and |
| 1028 | @code{dired-x-find-file-other-window} for @code{find-file-other-window} |
| 1029 | (normally bound to @kbd{C-x 4 C-f}). |
| 1030 | |
| 1031 | In order to use this feature, you will need to set |
| 1032 | @code{dired-x-hands-off-my-keys} to @code{nil} inside @code{dired-load-hook} |
| 1033 | (@pxref{Optional Installation File At Point}). |
| 1034 | |
| 1035 | @table @code |
| 1036 | @item dired-x-find-file |
| 1037 | @findex dired-x-find-file |
| 1038 | @kindex C-x C-f |
| 1039 | |
| 1040 | @code{dired-x-find-file} behaves exactly like @code{find-file} (normally bound |
| 1041 | to @kbd{C-x C-f}) unless a prefix argument is passed to the function in which |
| 1042 | case it will use the file name at point as a guess for the file to visit. |
| 1043 | |
| 1044 | For example, if the buffer you were reading contained the words |
| 1045 | |
| 1046 | @example |
| 1047 | Available via anonymous ftp in |
| 1048 | |
| 1049 | /roebling.poly.edu:/pub/lisp/crypt++.el.gz |
| 1050 | @end example |
| 1051 | |
| 1052 | @noindent |
| 1053 | then you could move your cursor to the line containing the ftp address and |
| 1054 | type @kbd{C-u C-x C-f} (the @kbd{C-u} is a universal argument). The |
| 1055 | minibuffer would read |
| 1056 | |
| 1057 | @example |
| 1058 | Find file: /roebling.poly.edu:/pub/lisp/crypt++.el.gz |
| 1059 | @end example |
| 1060 | |
| 1061 | @noindent |
| 1062 | with the point after the last @code{/}. If you hit @key{RET}, emacs will visit |
| 1063 | the file at that address. This also works with files on your own computer. |
| 1064 | |
| 1065 | @item dired-x-find-file-other-window |
| 1066 | @findex dired-x-find-file-other-window |
| 1067 | @kindex C-x 4 C-f |
| 1068 | |
| 1069 | @code{dired-x-find-file-other-window} behaves exactly like |
| 1070 | @code{find-file-other-window} (normally bound to @kbd{C-x 4 C-f}) unless a |
| 1071 | prefix argument is used. See @code{dired-x-find-file} for more information. |
| 1072 | |
| 1073 | @item dired-x-hands-off-my-keys |
| 1074 | @vindex dired-x-hands-off-my-keys |
| 1075 | If set to @code{t}, then it means that @file{dired-x} should @emph{not} bind |
| 1076 | @code{dired-x-find-file} over @code{find-file} on keyboard. Similarly, it |
| 1077 | should not bind @code{dired-x-find-file-other-window} over |
| 1078 | @code{find-file-other-window}. If you change this variable after |
| 1079 | @file{dired-x.el} is loaded then do @kbd{M-x dired-x-bind-find-file}. The |
| 1080 | default value of this variable is @code{t}; by default, the binding is not |
| 1081 | done. See @xref{Optional Installation File At Point}. |
| 1082 | |
| 1083 | @item dired-x-bind-find-file |
| 1084 | @findex dired-x-bind-find-file |
| 1085 | A function, which can be called interactively or in your @file{~/.emacs} file, |
| 1086 | that uses the value of @code{dired-x-hands-off-my-keys} to determine if |
| 1087 | @code{dired-x-find-file} should be bound over @code{find-file} and |
| 1088 | @code{dired-x-find-file-other-window} bound over |
| 1089 | @code{find-file-other-window}. See @xref{Optional Installation File At Point}. |
| 1090 | @end table |
| 1091 | |
| 1092 | @node Miscellaneous Commands, Bugs, Find File At Point, Top |
| 1093 | @comment node-name, next, previous, up |
| 1094 | @chapter Miscellaneous Commands |
| 1095 | |
| 1096 | Miscellaneous features not fitting anywhere else: |
| 1097 | |
| 1098 | @table @code |
| 1099 | @item dired-find-subdir |
| 1100 | @vindex dired-find-subdir |
| 1101 | Default: @code{nil} |
| 1102 | |
| 1103 | If non-@code{nil}, Dired does not make a new buffer for a directory if it can |
| 1104 | be found (perhaps as subdirectory) in some existing Dired buffer. |
| 1105 | |
| 1106 | If there are several Dired buffers for a directory, the most recently |
| 1107 | used is chosen. |
| 1108 | |
| 1109 | Dired avoids switching to the current buffer, so that if you have a |
| 1110 | normal and a wildcard buffer for the same directory, @kbd{C-x d RET} |
| 1111 | will toggle between those two. |
| 1112 | @end table |
| 1113 | |
| 1114 | @table @kbd |
| 1115 | @findex dired-goto-subdir |
| 1116 | @kindex M-G |
| 1117 | @item M-G |
| 1118 | (@code{dired-goto-subdir}) Go to the header line of an inserted directory. |
| 1119 | This command reads its argument, with completion derived from the names of the |
| 1120 | inserted subdirectories. |
| 1121 | @end table |
| 1122 | |
| 1123 | @table @code |
| 1124 | @item dired-smart-shell-command |
| 1125 | @findex dired-smart-shell-command |
| 1126 | @findex shell-command |
| 1127 | @kindex M-! |
| 1128 | Like function @code{shell-command}, but in the current Dired directory. |
| 1129 | Bound to @kbd{M-!} in Dired buffers. |
| 1130 | |
| 1131 | @item dired-jump |
| 1132 | @findex dired-jump |
| 1133 | @kindex C-x C-j |
| 1134 | @cindex Jumping to Dired listing containing file. |
| 1135 | Bound to @kbd{C-x C-j}. Jump back to Dired: If in a file, edit the current |
| 1136 | directory and move to file's line. If in Dired already, pop up a level and |
| 1137 | go to old directory's line. In case the proper Dired file line cannot be |
| 1138 | found, refresh the Dired buffer and try again. |
| 1139 | |
| 1140 | @item dired-jump-other-window |
| 1141 | @findex dired-jump-other-window |
| 1142 | @kindex C-x 4 C-j |
| 1143 | Bound to @kbd{C-x 4 C-j}. Like @code{dired-jump}, but to other window. |
| 1144 | |
| 1145 | These functions can be autoloaded so they work even though @file{dired-x.el} |
| 1146 | has not been loaded yet (@pxref{Optional Installation Dired Jump}). |
| 1147 | |
| 1148 | @vindex dired-bind-jump |
| 1149 | If the variable @code{dired-bind-jump} is @code{nil}, @code{dired-jump} will not be |
| 1150 | bound to @kbd{C-x C-j} and @code{dired-jump-other-window} will not be bound to |
| 1151 | @kbd{C-x 4 C-j}. |
| 1152 | |
| 1153 | @item dired-vm |
| 1154 | @cindex Reading mail. |
| 1155 | @kindex V |
| 1156 | @findex dired-vm |
| 1157 | Bound to @kbd{V} if @code{dired-bind-vm} is t. Run VM on this file (assumed |
| 1158 | to be a UNIX mail folder). |
| 1159 | |
| 1160 | @vindex dired-vm-read-only-folders |
| 1161 | If you give this command a prefix argument, it will visit the folder |
| 1162 | read-only. This only works in VM 5, not VM 4. |
| 1163 | |
| 1164 | If the variable @code{dired-vm-read-only-folders} is @code{t}, |
| 1165 | @code{dired-vm} will |
| 1166 | visit all folders read-only. If it is neither @code{nil} nor @code{t}, e.g., |
| 1167 | the symbol @code{if-file-read-only}, only files not writable by you are |
| 1168 | visited read-only. This is the recommended value if you run VM 5. |
| 1169 | |
| 1170 | @vindex dired-bind-vm |
| 1171 | If the variable @code{dired-bind-vm} is t, @code{dired-vm} will be bound to |
| 1172 | @kbd{V}. Otherwise, @code{dired-bind-rmail} will be bound. |
| 1173 | |
| 1174 | @item dired-rmail |
| 1175 | @cindex Reading mail. |
| 1176 | @findex dired-rmail |
| 1177 | Bound to @kbd{V} if @code{dired-bind-vm} is @code{nil}. Run Rmail on this |
| 1178 | file (assumed to be mail folder in Rmail/BABYL format). |
| 1179 | |
| 1180 | @item dired-info |
| 1181 | @kindex I |
| 1182 | @cindex Running info. |
| 1183 | @findex dired-info |
| 1184 | Bound to @kbd{I}. Run Info on this file (assumed to be a file in Info |
| 1185 | format). |
| 1186 | |
| 1187 | @vindex dired-bind-info |
| 1188 | If the variable @code{dired-bind-info} is @code{nil}, @code{dired-info} will |
| 1189 | not be bound to @kbd{I}. |
| 1190 | |
| 1191 | @item dired-man |
| 1192 | @cindex Running man. |
| 1193 | @kindex N |
| 1194 | @findex dired-man |
| 1195 | Bound to @kbd{N}. Run man on this file (assumed to be a file in @code{nroff} |
| 1196 | format). |
| 1197 | |
| 1198 | @vindex dired-bind-man |
| 1199 | If the variable @code{dired-bind-man} is @code{nil}, @code{dired-man} will not |
| 1200 | be bound to @kbd{N}. |
| 1201 | |
| 1202 | @item dired-do-relative-symlink |
| 1203 | @cindex Relative symbolic links. |
| 1204 | @kindex Y |
| 1205 | @findex dired-do-relative-symlink |
| 1206 | Bound to @kbd{Y}. Relative symlink all marked (or next ARG) files into a |
| 1207 | directory, or make a relative symbolic link to the current file. This creates |
| 1208 | relative symbolic links like |
| 1209 | |
| 1210 | @example |
| 1211 | foo -> ../bar/foo |
| 1212 | @end example |
| 1213 | |
| 1214 | @noindent |
| 1215 | not absolute ones like |
| 1216 | |
| 1217 | @example |
| 1218 | foo -> /ugly/path/that/may/change/any/day/bar/foo |
| 1219 | @end example |
| 1220 | |
| 1221 | @item dired-do-relative-symlink-regexp |
| 1222 | @kindex %Y |
| 1223 | @findex dired-do-relative-symlink-regexp |
| 1224 | Bound to @kbd{%Y}. Relative symlink all marked files containing |
| 1225 | @var{regexp} to @var{newname}. See functions |
| 1226 | @code{dired-do-rename-regexp} and @code{dired-do-relsymlink} for more |
| 1227 | info. |
| 1228 | @end table |
| 1229 | |
| 1230 | @node Bugs, Concept Index, Miscellaneous Commands, Top |
| 1231 | @comment node-name, next, previous, up |
| 1232 | @chapter Bugs |
| 1233 | @cindex Bugs |
| 1234 | @findex dired-x-submit-report |
| 1235 | |
| 1236 | @noindent |
| 1237 | If you encounter a bug in this package, wish to suggest an |
| 1238 | enhancement, or want to make a smart remark, then type |
| 1239 | |
| 1240 | @example |
| 1241 | @kbd{M-x dired-x-submit-report} |
| 1242 | @end example |
| 1243 | |
| 1244 | @noindent |
| 1245 | to set up an outgoing mail buffer, with the proper address to the |
| 1246 | @file{dired-x.el} maintainer automatically inserted in the @samp{To:@:} field. |
| 1247 | This command also inserts information that the Dired X maintainer can use to |
| 1248 | recreate your exact setup, making it easier to verify your bug or social |
| 1249 | maladjustment. |
| 1250 | |
| 1251 | Lawrence R. Dodd |
| 1252 | @c <dodd@@roebling.poly.edu> |
| 1253 | |
| 1254 | @node Concept Index, Command Index, Bugs, Top |
| 1255 | @comment node-name, next, previous, up |
| 1256 | @unnumbered Concept Index |
| 1257 | @printindex cp |
| 1258 | |
| 1259 | @node Command Index, Key Index, Concept Index, Top |
| 1260 | @comment node-name, next, previous, up |
| 1261 | @unnumbered Function Index |
| 1262 | @printindex fn |
| 1263 | |
| 1264 | @node Key Index, Variable Index, Command Index, Top |
| 1265 | @comment node-name, next, previous, up |
| 1266 | @unnumbered Key Index |
| 1267 | @printindex ky |
| 1268 | |
| 1269 | @node Variable Index, , Key Index, Top |
| 1270 | @comment node-name, next, previous, up |
| 1271 | @unnumbered Variable Index |
| 1272 | @printindex vr |
| 1273 | |
| 1274 | @setchapternewpage odd |
| 1275 | @c @summarycontents |
| 1276 | @contents |
| 1277 | |
| 1278 | @bye |
| 1279 | @c dired-x.texi ends here. |
| 1280 | |
| 1281 | @ignore |
| 1282 | arch-tag: 201727aa-9318-4c74-a0d7-4f51c550c4de |
| 1283 | @end ignore |