home *** CD-ROM | disk | FTP | other *** search
/ Dream 49 / Amiga_Dream_49.iso / beos / emacs / emacs-19.34-bin / emacs-19 / info / dired-x (.txt) < prev    next >
GNU Info File  |  1997-09-17  |  47KB  |  917 lines
  1. This is Info file ../info/dired-x, produced by Makeinfo-1.64 from the
  2. input file dired-x.texi.
  3. File: dired-x,  Node: Copyright,  Next: Top,  Prev: (dir),  Up: (dir)
  4.    This documents the "extra" features for Dired Mode for GNU Emacs 19
  5. found in the file `dired-x.el'.
  6.    Copyright (C) 1993, 1994 Free Software Foundation, Inc.
  7.    Permission is granted to make and distribute verbatim copies of this
  8. manual provided the copyright notice and this permission notice are
  9. preserved on all copies.
  10.    Permission is granted to copy and distribute modified versions of
  11. this manual under the conditions for verbatim copying, provided that
  12. the entire resulting derived work is distributed under the terms of a
  13. permission notice identical to this one.
  14.    Permission is granted to copy and distribute translations of this
  15. manual into another language, under the above conditions for modified
  16. versions, except that this permission notice may be stated in a
  17. translation approved by the Free Software Foundation.
  18.    The file used to create this is called `dired-x.texi', but the
  19. original work that was altered to make that file was called
  20. `dired.texi' written by Sebastian Kremer.
  21. File: dired-x,  Node: Top,  Next: Introduction,  Prev: Copyright,  Up: (dir)
  22. This documents the "extra" features for Dired Mode for GNU Emacs 19
  23. that are provided by the file `dired-x.el'.
  24.    * Based on `dired.texi' by Sebastian Kremer <sk@thp.uni-koeln.de>
  25.    * For `dired-x.el' revision 2
  26.    * Revision of this manual: 2.52 (1994/08/09 16:51:31)
  27.    * Bugs to Lawrence R. Dodd <dodd@roebling.poly.edu>.  *Please* type
  28.      `M-x dired-x-submit-report' to submit a bug report (*Note Bugs::).
  29.    * You can obtain a copy of this package via anonymous ftp in
  30.      /roebling.poly.edu:/pub/packages/dired-x.tar.gz
  31. * Menu:
  32. * Introduction::
  33. * Installation::
  34. * Omitting Files in Dired::
  35. * Local Variables::
  36. * Shell Command Guessing::
  37. * Virtual Dired::
  38. * Advanced Mark Commands::
  39. * Multiple Dired Directories::
  40. * Find File At Point::
  41. * Miscellaneous Commands::
  42. * Bugs::
  43. * Concept Index::
  44. * Command Index::
  45. * Key Index::
  46. * Variable Index::
  47. File: dired-x,  Node: Introduction,  Next: Features,  Prev: Top,  Up: Top
  48. Introduction
  49. ************
  50.    This documents the *extra* features for Dired Mode for GNU Emacs 19.
  51. It is derived from version 1.191 of Sebastian Kremer's `dired-x.el'
  52. and is GNU Emacs v19 compatible.
  53.    In adopting this `dired-x.el' to GNU Emacs v19 some material that has
  54. been incorporated into `dired.el' and `dired-aux.el' of the GNU Emacs
  55. 19 distribution has been removed and some material was modified for
  56. agreement with the functions in `dired.el' and `dired-aux.el'.  For
  57. example, the code using `gmhist' history functions was replaced with
  58. code using the mini-buffer history now built into GNU Emacs 19.
  59. Finally, a few other features have been added and a few more functions
  60. have been bound to keys.
  61.    Please note that `dired-x.el' and this texinfo file `dired-x.texi'
  62. are bundled with GNU Emacs versions 19.23 and later.
  63. * Menu:
  64. * Features::
  65. * Technical Details::
  66. File: dired-x,  Node: Features,  Next: Technical Details,  Prev: Introduction,  Up: Introduction
  67. Features
  68. ========
  69.    Some features provided by Dired Extra
  70.   1. Omitting of uninteresting files from dired listing.
  71.           *Note Omitting Files in Dired::
  72.   2. Local variables for dired directories.
  73.           *Note Local Variables::
  74.   3. Guessing shell commands in dired buffers.
  75.           *Note Shell Command Guessing::
  76.   4. Running dired command in non-dired buffers.
  77.           *Note Virtual Dired::
  78.   5. Finding a file mentioned in a buffer
  79.           *Note Find File At Point::
  80.   6. Commands using file marking.
  81.           *Note Advanced Mark Commands::
  82. `dired-x.el' binds some functions to keys in Dired Mode (*Note Key
  83. Index::) and also binds `C-x C-j' and `C-x 4 C-j' *globally* to
  84. `dired-jump' (*Note Miscellaneous Commands::).  It may also bind `C-x
  85. C-f' and `C-x 4 C-f' to `dired-x-find-file' and
  86. `dired-x-find-file-other-window', respectively (*Note Find File At
  87. Point::).
  88. File: dired-x,  Node: Technical Details,  Next: Installation,  Prev: Features,  Up: Introduction
  89. Technical Details
  90. =================
  91.    When loaded this code *redefines* the following functions of GNU
  92. Emacs from `dired.el'
  93.    * `dired-clean-up-after-deletion'
  94.    * `dired-find-buffer-nocreate'
  95.    * `dired-initial-position'
  96.    * `dired-up-directory'
  97. and the following functions from `dired-aux.el'
  98.    * `dired-add-entry'
  99.    * `dired-read-shell-command'
  100.    One drawback is that `dired-x.el' will load `dired-aux.el' as soon
  101. as dired is loaded.  Thus, the advantage of separating out
  102. non-essential dired stuff into `dired-aux.el' and only loading when
  103. necessary will be lost when `dired-x.el' is used.
  104. File: dired-x,  Node: Installation,  Next: Optional Installation Dired Jump,  Prev: Technical Details,  Up: Top
  105. Installation
  106. ************
  107. This manual describes the dired features provided by the file
  108. `dired-x.el'.  To take advantage of these features, you must load the
  109. file and (optionally) set some variables.
  110. In your `.emacs' file in your home directory, or in the system-wide
  111. initialization file `default.el' in the `site-lisp' directory, put
  112.      (add-hook 'dired-load-hook
  113.                (function (lambda ()
  114.                            (load "dired-x")
  115.                            ;; Set dired-x global variables here.  For example:
  116.                            ;; (setq dired-guess-shell-gnutar "gtar")
  117.                            ;; (setq dired-x-hands-off-my-keys nil)
  118.                            )))
  119.      (add-hook 'dired-mode-hook
  120.                (function (lambda ()
  121.                            ;; Set dired-x buffer-local variables here.  For example:
  122.                            ;; (setq dired-omit-files-p t)
  123.                            )))
  124. This will load `dired-x.el' when dired is first invoked (for example,
  125. when you first do `C-x d').
  126. * Menu:
  127. * Optional Installation Dired Jump::
  128. * Optional Installation File At Point::
  129. * Special Notes::
  130. File: dired-x,  Node: Optional Installation Dired Jump,  Next: Optional Installation File At Point,  Prev: Installation,  Up: Installation
  131. Optional Installation Dired Jump
  132. ================================
  133.    In order to have `dired-jump' and `dired-jump-other-window' (*Note
  134. Miscellaneous Commands::) work *before* `dired' and `dired-x' have been
  135. properly loaded the user should set-up an autoload for these functions.
  136. In your `.emacs' file put
  137.      ;;; Autoload `dired-jump' and `dired-jump-other-window'.
  138.      ;;; We autoload from FILE dired.el.  This will then load dired-x.el
  139.      ;;; and hence define `dired-jump' and `dired-jump-other-window'.
  140.      (define-key global-map "\C-x\C-j" 'dired-jump)
  141.      (define-key global-map "\C-x4\C-j" 'dired-jump-other-window)
  142.      
  143.      (autoload (quote dired-jump) "dired" "\
  144.      Jump to dired buffer corresponding to current buffer.
  145.      If in a file, dired the current directory and move to file's line.
  146.      If in dired already, pop up a level and goto old directory's line.
  147.      In case the proper dired file line cannot be found, refresh the dired
  148.      buffer and try again." t nil)
  149.      
  150.      (autoload (quote dired-jump-other-window) "dired" "\
  151.      Like \\[dired-jump] (dired-jump) but in other window." t nil)
  152.    Note that in recent releases of GNU Emacs 19 (i.e., 19.25 or later)
  153. the file `../lisp/loaddefs.el' of the Emacs distribution already
  154. contains the proper auto-loading for `dired-jump' so you need only put
  155.      (define-key global-map "\C-x\C-j" 'dired-jump)
  156. in your `.emacs' file in order to have `C-x C-j' work before `dired' is
  157. loaded.
  158. File: dired-x,  Node: Optional Installation File At Point,  Next: Special Notes,  Prev: Optional Installation Dired Jump,  Up: Installation
  159. Optional Installation File At Point
  160. ===================================
  161.    If you choose to have `dired-x.el' bind `dired-x-find-file' over
  162. `find-file' (*Note Find File At Point::), then you will need to set
  163. `dired-x-hands-off-my-keys' and make a call to the function
  164. `dired-x-bind-find-file' in the `dired-load-hook':
  165.      (add-hook 'dired-load-hook
  166.                (function (lambda ()
  167.                            (load "dired-x")
  168.                            ;; Bind dired-x-find-file.
  169.                            (setq dired-x-hands-off-my-keys nil)
  170.                            ;; Make sure our binding preference is invoked.
  171.                            (dired-x-bind-find-file)
  172.                            )))
  173.    Alternatively, you can set the variable *before* `dired-x.el' is
  174. loaded
  175.      (add-hook 'dired-load-hook
  176.                (function (lambda ()
  177.                            ;; Bind dired-x-find-file.
  178.                            (setq dired-x-hands-off-my-keys nil)
  179.                            (load "dired-x")
  180.                            )))
  181. File: dired-x,  Node: Special Notes,  Next: Omitting Files in Dired,  Prev: Optional Installation File At Point,  Up: Installation
  182. Special Notes
  183. =============
  184.    If `dired-x.el' was *not* bundled with the version of GNU Emacs
  185. installed at your site (i.e., not in the default `../lisp' directory)
  186. then you must put the file `dired-x.el' in a directory known to GNU
  187. Emacs.  Examine the variable `load-path' for a list of these
  188. directories.  If you wish to add a new directory on this list of
  189. directories use something like this in your `.emacs' file
  190.      ;;; LOAD PATH
  191.      (setq load-path (append
  192.                       load-path ; default at top
  193.                       (list
  194.                        "/the/directory/where/you/put/dired-x")))
  195. If you wish to put the new directory at the head of the list (where it
  196. will be found first) then you should use instead
  197.      ;;; LOAD PATH
  198.      (setq load-path (append
  199.                       (list
  200.                        "/the/directory/where/you/put/dired-x")
  201.                       load-path)) ; default at bottom
  202.    You must also byte compile the file (for example, hitting `B' in
  203. `dired-mode').  When byte-compiling `dired-x.el' you may get messages
  204. about functions `vm-visit-folder', `Man-notify-when-ready', and
  205. `reporter-submit-bug-report' not being defined.  These are warnings and
  206. should be ignored.
  207. CAUTION: If you are using a version of GNU Emacs earlier than 19.20
  208. than you may have to edit `dired.el'.  The copy of `dired.el' in GNU
  209. Emacs versions earlier than 19.20 incorrectly had the call to
  210. `run-hooks' *before* the call to `provide'.  In such a case, it is
  211. possible that byte-compiling and/or loading dired can cause an infinite
  212. loop.  To prevent this, make sure the line of code
  213.              (run-hooks 'dired-load-hook)
  214. is the *last* executable line in the file `dired.el'.  That is, make
  215. sure it comes *after* the line
  216.              (provide 'dired)
  217. File: dired-x,  Node: Omitting Files in Dired,  Next: Omitting Variables,  Prev: Special Notes,  Up: Top
  218. Omitting Files in Dired
  219. ***********************
  220.    "Omitting" a file means removing it from the directory listing.
  221. Omitting is useful for keeping Dired buffers free of "uninteresting"
  222. files (for instance, auto-save, auxiliary, backup, and revision control
  223. files) so that the user can concentrate on the interesting files.  Like
  224. hidden files, omitted files are never seen by Dired.  Omitting differs
  225. from hiding in several respects:
  226.    * Omitting works on individual files, not on directories; an entire
  227.      directory cannot be omitted (though each of its files could be).
  228.    * Omitting is wholesale; if omitting is turned on for a dired
  229.      buffer, then all uninteresting files listed in that buffer are
  230.      omitted.  The user does not omit (or unomit) files one at a time.
  231.    * Omitting can be automatic; uninteresting file lines in the buffer
  232.      can be removed before the user ever sees them.
  233.    * Marked files are never omitted.
  234. `M-o'
  235.      (`dired-omit-toggle') Toggle between displaying and omitting
  236.      "uninteresting" files.  With a prefix argument, don't toggle and
  237.      just mark the files, but don't actually omit them.
  238. In order to make Dired Omit work you first need to load `dired-x.el'
  239. inside `dired-load-hook' (*Note Installation::) and then set
  240. `dired-omit-files-p' in some way (*Note Omitting Variables::).
  241. * Menu:
  242. * Omitting Variables::
  243. * Omitting Examples::
  244. * Omitting Technical::
  245. File: dired-x,  Node: Omitting Variables,  Next: Omitting Examples,  Prev: Omitting Files in Dired,  Up: Omitting Files in Dired
  246. Omitting Variables
  247. ==================
  248.    The following variables can be used to customize omitting.
  249. `dired-omit-files-p'
  250.      Default: `nil'
  251.      If non-`nil', "uninteresting" files are not listed.  Uninteresting
  252.      files are those whose filenames match regexp `dired-omit-files',
  253.      plus those ending with extensions in `dired-omit-extensions'.
  254.      `M-o' (`dired-omit-toggle') toggles its value, which is
  255.      buffer-local.  Put
  256.           (setq dired-omit-files-p t)
  257.      inside your `dired-mode-hook' to have omitting initially turned on
  258.      in *every* Dired buffer (*Note Installation::).  You can then use
  259.      `M-o' to unomit in that buffer.
  260.      To enable omitting automatically only in certain directories one
  261.      can use Dired Local Variables and put
  262.           Local Variables:
  263.           dired-omit-files-p: t
  264.           End:
  265.      into a file `.dired' (the default value of
  266.      `dired-local-variables-file') in that directory (*Note Local
  267.      Variables::).
  268.     `dired-omit-here-always'
  269.           This is an interactive function that creates a local
  270.           variables file exactly like the example above (if it does not
  271.           already exist) in the file `dired-local-variables-file' in
  272.           the current directory and then refreshes the directory
  273.           listing (*Note Local Variables::).
  274. `dired-omit-files'
  275.      Default: `"^#\\|\\.$"'
  276.      Filenames matching this buffer-local regexp will not be displayed.
  277.      This only has effect when `dired-omit-files-p' is t.
  278.      The default value omits the special directories `.' and `..'  and
  279.      autosave files (plus other files ending in ".") (*Note Omitting
  280.      Examples::).
  281. `dired-omit-extensions'
  282.      Default: The elements of `completion-ignored-extensions' (as
  283.      defined in the file `loaddefs.el' of the GNU Emacs distribution),
  284.      `dired-latex-unclean-extensions', `dired-bibtex-unclean-extensions'
  285.      and `dired-texinfo-unclean-extensions'.
  286.      If non-`nil', a list of extensions (strings) to omit from Dired
  287.      listings.  Its format is the same as that of
  288.      `completion-ignored-extensions'.
  289. `dired-omit-localp'
  290.      Default:  `'no-dir'
  291.      The LOCALP argument `dired-omit-expunge' passes to
  292.      `dired-get-filename'.  If it is `'no-dir', omitting is much faster,
  293.      but you can only match against the non-directory part of the
  294.      filename.  Set it to `nil' if you need to match the whole pathname
  295.      or `t' to match the pathname relative to the buffer's top-level
  296.      directory.
  297. `dired-omit-marker-char'
  298.      Default: `C-o'
  299.      Temporary marker used by by Dired to implement omitting.  Should
  300.      never be used as marker by the user or other packages.  There is
  301.      one exception to this rule: by doing
  302.           (setq dired-mark-keys "\C-o")
  303.           ;; i.e., the value of dired-omit-marker-char
  304.           ;; (which is not defined yet)
  305.      anywhere in your `~/.emacs', you will bind the `C-o' key to insert
  306.      a `C-o' marker, thus causing these files to be omitted in addition
  307.      to the usually omitted files.  Unfortunately the files you omitted
  308.      manually this way will show up again after reverting the buffer,
  309.      unlike the others.
  310. File: dired-x,  Node: Omitting Examples,  Next: Omitting Technical,  Prev: Omitting Variables,  Up: Omitting Files in Dired
  311. Examples of Omitting Various File Types
  312. =======================================
  313.    * If you wish to avoid seeing RCS files and the RCS directory, then
  314.      put
  315.           (setq dired-omit-files
  316.                 (concat dired-omit-files "\\|^RCS$\\|,v$"))
  317.      in the `dired-load-hook' (*Note Installation::).  This assumes
  318.      `dired-omit-localp' has its default value of `'no-dir' to make the
  319.      `^'-anchored matches work.  As a slower alternative, with
  320.      `dired-omit-localp' set to `nil', you can use `/' instead of `^'
  321.      in the regexp.
  322.    * If you use tib, the bibliography program for use with TeX and
  323.      LaTeX, you might want to omit the `INDEX' and the `-t.tex' files,
  324.      then put
  325.           (setq dired-omit-files
  326.                 (concat dired-omit-files "\\|^INDEX$\\|-t\\.tex$"))
  327.      in the `dired-load-hook' (*Note Installation::).
  328.    * If you do not wish to see `dot' files (files starting with a `.'),
  329.      then put
  330.           (setq dired-omit-files
  331.                 (concat dired-omit-files "\\|^\\..+$"))
  332.      in the `dired-load-hook' (*Note Installation::).
  333. File: dired-x,  Node: Omitting Technical,  Next: Local Variables,  Prev: Omitting Examples,  Up: Omitting Files in Dired
  334. Some Technical Details of Omitting
  335. ==================================
  336.    Loading `dired-x.el' will install Dired Omit by putting
  337. `dired-omit-expunge' on your `dired-after-readin-hook', and will call
  338. `dired-extra-startup', which in turn calls `dired-omit-startup' in your
  339. `dired-mode-hook'.
  340. File: dired-x,  Node: Local Variables,  Next: Shell Command Guessing,  Prev: Omitting Technical,  Up: Top
  341. Local Variables for Dired Directories
  342. *************************************
  343. When Dired visits a directory, it looks for a file whose name is the
  344. value of variable `dired-local-variables-file' (default: `.dired').  If
  345. such a file is found, Dired will temporarily insert it into the Dired
  346. buffer and run `hack-local-variables'.
  347. For example, if the user puts
  348.      Local Variables:
  349.      dired-actual-switches: "-lat"
  350.      dired-omit-files-p: t
  351.      End:
  352. into a file called `.dired' in a directory then when that directory is
  353. viewed it will be
  354.   1. sorted by date
  355.   2. omitted automatically
  356. You can set `dired-local-variables-file' to `nil' to suppress this.
  357. The value of `dired-enable-local-variables' controls if and how these
  358. local variables are read.  This variable exists so that if may override
  359. the default value of `enable-local-variables'.
  360. Please see the GNU Emacs Manual to learn more about local variables.
  361. *Note Local Variables in Files: (emacs)File Variables.
  362. The following variables affect Dired Local Variables
  363. `dired-local-variables-file'
  364.      Default: `".dired"'
  365.      If non-`nil', filename for local variables for Dired.  If Dired
  366.      finds a file with that name in the current directory, it will
  367.      temporarily insert it into the dired buffer and run
  368.      `hack-local-variables'.
  369. `dired-enable-local-variables'
  370.      Default: `t'
  371.      Controls use of local-variables lists in dired.  The value can be
  372.      `t', `nil', or something else.  A value of `t' means
  373.      local-variables lists are obeyed in the
  374.      `dired-local-variables-file'; `nil' means they are ignored;
  375.      anything else means query.  This variable temporarily overrides
  376.      the value of `enable-local-variables' when the Dired Local
  377.      Variables are hacked.
  378. File: dired-x,  Node: Shell Command Guessing,  Next: Virtual Dired,  Prev: Local Variables,  Up: Top
  379. Shell Command Guessing
  380. **********************
  381.    Based upon the name of a filename, Dired tries to guess what shell
  382. command you might want to apply to it.  For example, if you have point
  383. on a file named `foo.tar' and you press `!', Dired will guess you want
  384. to `tar xvf' it and suggest that as the default shell command.
  385.    The default will be mentioned in brackets and you can type `M-p' to
  386. get the default into the minibuffer so that you can edit it, e.g.,
  387. changing `tar xvf' to `tar tvf'.  If there are several commands for a
  388. given file, e.g., `xtex' and `dvips' for a `.dvi' file, you can type
  389. `M-p' several times to see each of the matching commands.
  390.    Dired only tries to guess a command for a single file, never for a
  391. list of marked files.
  392. `dired-guess-shell-alist-default'
  393.      Predefined rules for shell commands.  Set this to `nil' to turn
  394.      guessing off.  The elements of `dired-guess-shell-alist-user'
  395.      (defined by the user) will override these rules.
  396. `dired-guess-shell-alist-user'
  397.      If non-`nil', a user-defined alist of file regexps and their
  398.      suggested commands.  These rules take precedence over the
  399.      predefined rules in the variable `dired-guess-shell-alist-default'
  400.      (to which they are prepended) when `dired-do-shell-command' is
  401.      run).
  402.      Each element of the alist looks like
  403.           (REGEXP COMMAND...)
  404.      where each COMMAND can either be a string or a lisp expression
  405.      that evaluates to a string.  If several COMMANDs are given, all
  406.      will temporarily be pushed on the history.
  407.      You can set this variable in your `~/.emacs'.  For example, to add
  408.      rules for `.foo' and `.bar' file extensions, write
  409.           (setq dired-guess-shell-alist-user
  410.                 (list
  411.                  (list "\\.foo$" "FOO-COMMAND");; fixed rule
  412.                  ;; possibly more rules...
  413.                  (list "\\.bar$";; rule with condition test
  414.                         '(if CONDITION
  415.                              "BAR-COMMAND-1"
  416.                            "BAR-COMMAND-2"))))
  417.      This will override any predefined rules for the same extensions.
  418. `dired-guess-shell-gnutar'
  419.      Default: `nil'
  420.      If non-`nil', name of the GNU tar executable (e.g., `"tar"' or
  421.      `"gnutar"').  GNU tar's `z' switch is used for compressed tar
  422.      files.  If you don't have GNU tar, set this to `nil': a pipe using
  423.      `zcat' is then used.
  424. `dired-guess-shell-gzip-quiet'
  425.      Default: `t'
  426.      A non-`nil' value means that `-q' is passed to gzip overriding a
  427.      verbose GNU zip's `GZIP' environment variable.
  428. `dired-guess-shell-znew-switches nil'
  429.      Default: `nil'
  430.      A string of switches passed to GNU zip's `znew'.  An example is
  431.      `"-K"' which will make `znew' keep a .Z file when it is smaller
  432.      than the .gz file.
  433. `dired-shell-command-history nil'
  434.      History list for commands that read dired-shell commands.
  435. File: dired-x,  Node: Virtual Dired,  Next: Advanced Mark Commands,  Prev: Shell Command Guessing,  Up: Top
  436. Virtual Dired
  437. *************
  438.    Using "Virtual Dired" means putting a buffer with Dired-like
  439. contents in Dired mode.  The files described by the buffer contents need
  440. not actually exist.  This is useful if you want to peruse an `ls -lR'
  441. output file, for example one you got from an FTP server.  You can use
  442. all motion commands usually available in Dired.  You can also use it to
  443. save a Dired buffer in a file and resume it in a later session.
  444.    Type `M-x dired-virtual' to put the current buffer into virtual
  445. Dired mode.  You will be prompted for the top level directory of this
  446. buffer, with a default value guessed from the buffer contents.  To
  447. convert the virtual to a real Dired buffer again, type `g' (which calls
  448. `dired-virtual-revert') in the virtual Dired buffer and answer `y'.
  449. You don't have to do this, though: you can relist single subdirectories
  450. using `l' (`dired-do-redisplay') on the subdirectory headerline,
  451. leaving the buffer in virtual Dired mode all the time.
  452.    The function `dired-virtual-mode' is specially designed to turn on
  453. virtual Dired mode from the `auto-mode-alist'.  To edit all `*.dired'
  454. files automatically in virtual Dired mode, put this into your
  455. `~/.emacs':
  456.      (setq auto-mode-alist (cons '("[^/]\\.dired$" . dired-virtual-mode)
  457.                                    auto-mode-alist))
  458.    The regexp is a bit more complicated than usual to exclude ".dired"
  459. local variable files.
  460. File: dired-x,  Node: Advanced Mark Commands,  Next: Advanced Cleaning Functions,  Prev: Virtual Dired,  Up: Top
  461. Advanced Mark Commands
  462. **********************
  463.      (`dired-do-find-marked-files') Find all marked files at once
  464.      displaying simultaneously.  If optional NOSELECT is non-`nil' then
  465.      just find the files but do not select.  If you want to keep the
  466.      dired buffer displayed, type `C-x 2' first.  If you want just the
  467.      marked files displayed and nothing else, type `C-x 1' first.
  468.      The current window is split across all files marked, as evenly as
  469.      possible.  Remaining lines go to the bottom-most window.  The
  470.      number of files that can be displayed this way is restricted by
  471.      the height of the current window and the variable
  472.      `window-min-height'.
  473. `dired-mark-extension'
  474.      Mark all files with a certain extension for use in later commands.
  475.      A `.' is not automatically prepended to the string entered.
  476.      When called from lisp, EXTENSION may also be a list of extensions
  477.      and an optional argument MARKER-CHAR specifies the marker used.
  478. `dired-flag-extension'
  479.      Flag all files with a certain extension for deletion.  A `.' is
  480.      *not* automatically prepended to the string entered.
  481. * Menu:
  482. * Advanced Cleaning Functions::
  483. * Advanced Cleaning Variables::
  484. * Special Marking Function::
  485. File: dired-x,  Node: Advanced Cleaning Functions,  Next: Advanced Cleaning Variables,  Prev: Advanced Mark Commands,  Up: Advanced Mark Commands
  486. Advanced Cleaning Functions
  487. ===========================
  488. `dired-clean-patch'
  489.      Flag dispensable files created by the `patch' program for
  490.      deletion.  See variable `dired-patch-unclean-extensions'.
  491. `dired-clean-tex'
  492.      Flag dispensable files created by TeX, LaTeX, and `texinfo' for
  493.      deletion.  See the following variables (*Note Advanced Cleaning
  494.      Variables::)
  495.         * `dired-tex-unclean-extensions'
  496.         * `dired-texinfo-unclean-extensions'
  497.         * `dired-latex-unclean-extensions'
  498.         * `dired-bibtex-unclean-extensions'
  499. `dired-very-clean-tex'
  500.      Flag dispensable files created by TeX, LaTeX, `texinfo', and ".dvi"
  501.      files for deletion.
  502. File: dired-x,  Node: Advanced Cleaning Variables,  Next: Special Marking Function,  Prev: Advanced Cleaning Functions,  Up: Advanced Mark Commands
  503. Advanced Cleaning Variables
  504. ===========================
  505. Variables used by the above cleaning commands (and in the default value
  506. for variable `dired-omit-extensions', *Note Omitting Variables::)
  507. `dired-patch-unclean-extensions'
  508.      Default: `'(".rej" ".orig")'
  509.      List of extensions of dispensable files created by the `patch'
  510.      program.
  511. `dired-tex-unclean-extensions'
  512.      Default:  `'(".toc" ".log" ".aux")'
  513.      List of extensions of dispensable files created by TeX.
  514. `dired-texinfo-unclean-extensions'
  515.      Default: `'(".cp" ".cps" ".fn" ".fns" ".ky" ".kys"' `".pg" ".pgs"
  516.      ".tp" ".tps" ".vr" ".vrs")'
  517.      List of extensions of dispensable files created by `texinfo'.
  518. `dired-latex-unclean-extensions'
  519.      Default: `'(".idx" ".lof" ".lot" ".glo")'
  520.      List of extensions of dispensable files created by LaTeX.
  521. `dired-bibtex-unclean-extensions'
  522.      Default:  `'(".blg" ".bbl")'
  523.      List of extensions of dispensable files created by BibTeX.
  524. File: dired-x,  Node: Special Marking Function,  Next: Multiple Dired Directories,  Prev: Advanced Cleaning Variables,  Up: Advanced Mark Commands
  525. Special Marking Function
  526. ========================
  527. `M-('
  528.      (`dired-mark-sexp') Mark files for which PREDICATE returns
  529.      non-`nil'.  With a prefix argument, unflag those files instead.
  530.      The PREDICATE is a lisp expression that can refer to the following
  531.      symbols:
  532.     `inode'
  533.           [integer] the inode of the file (only for `ls -i' output)
  534.     `s'
  535.           [integer] the size of the file for `ls -s' output (usually in
  536.           blocks or, with `-k', in KBytes)
  537.     `mode'
  538.           [string]  file permission bits, e.g., `"-rw-r--r--"'
  539.     `nlink'
  540.           [integer] number of links to file
  541.     `uid'
  542.           [string]  owner
  543.     `gid'
  544.           [string]  group  (If the gid is not displayed by `ls', this
  545.           will still be set (to the same as uid))
  546.     `size'
  547.           [integer] file size in bytes
  548.     `time'
  549.           [string]  the time that `ls' displays, e.g., `"Feb 12 14:17"'
  550.     `name'
  551.           [string]  the name of the file
  552.     `sym'
  553.           [string]  if file is a symbolic link, the linked-to name,
  554.           else `""'
  555.      For example, use
  556.           (equal 0 size)
  557.      to mark all zero length files.
  558.      To find out all not yet compiled Emacs lisp files in a directory,
  559.      dired all `.el' files in the lisp directory using the wildcard
  560.      `*.el'.  Then use `M-(' with
  561.           (not (file-exists-p (concat name "c")))
  562.      to mark all `.el' files without a corresponding `.elc' file.
  563. File: dired-x,  Node: Multiple Dired Directories,  Next: Find File At Point,  Prev: Special Marking Function,  Up: Top
  564. Multiple Dired Directories and Non-Dired Commands
  565. *************************************************
  566.    An Emacs buffer can have but one working directory, stored in the
  567. buffer-local variable `default-directory'.  A Dired buffer may have
  568. several subdirectories inserted, but still has but one working
  569. directory: that of the top level Dired directory in that buffer.  For
  570. some commands it is appropriate that they use the current Dired
  571. directory instead of `default-directory', e.g., `find-file' and
  572. `compile'.
  573.    A general mechanism is provided for special handling of the working
  574. directory in special major modes:
  575. `default-directory-alist'
  576.      Default: `((dired-mode . (dired-current-directory)))'
  577.      Alist of major modes and their opinion on `default-directory', as a
  578.      lisp expression to evaluate.  A resulting value of `nil' is ignored
  579.      in favor of `default-directory'.
  580. `default-directory'
  581.      Function with usage like variable `default-directory', but knows
  582.      about the special cases in variable `default-directory-alist'.
  583. File: dired-x,  Node: Find File At Point,  Next: Miscellaneous Commands,  Prev: Multiple Dired Directories,  Up: Top
  584. Find File At Point
  585. ==================
  586.    `dired-x' provides a method of visiting or editing a file mentioned
  587. in the buffer you are viewing (e.g., a mail buffer, a news article, a
  588. README file, etc.) or to test if that file exists.  You can then modify
  589. this in the minibuffer after snatching the filename.
  590.    When installed `dired-x' will substitute `dired-x-find-file' for
  591. `find-file' (normally bound to `C-x C-f') and
  592. `dired-x-find-file-other-window' for `find-file-other-window' (normally
  593. bound to `C-x 4 C-f').
  594.    In order to use this feature, you will need to set
  595. `dired-x-hands-off-my-keys' to `nil' inside `dired-load-hook' (*Note
  596. Optional Installation File At Point::).
  597. `dired-x-find-file'
  598.      `dired-x-find-file' behaves exactly like `find-file' (normally
  599.      bound to `C-x C-f') unless a prefix argument is passed to the
  600.      function in which case it will use the filename at point as a
  601.      guess for the file to visit.
  602.      For example, if the buffer you were reading contained the words
  603.           Available via anonymous ftp in
  604.           
  605.              /roebling.poly.edu:/pub/lisp/crypt++.el.gz
  606.      then you could move your cursor to the line containing the ftp
  607.      address and type `C-u C-x C-f' (the `C-u' is a universal
  608.      argument).  The minibuffer would read
  609.           Find file: /roebling.poly.edu:/pub/lisp/crypt++.el.gz
  610.      with the point after the last `/'.  If you hit return emacs will
  611.      visit the file at that address.  This also works with files on
  612.      your own computer.
  613. `dired-x-find-file-other-window'
  614.      `dired-x-find-file-other-window' behaves exactly like
  615.      `find-file-other-window' (normally bound to `C-x 4 C-f') unless a
  616.      prefix argument is used.  See `dired-x-find-file' for more
  617.      information.
  618. `dired-x-hands-off-my-keys'
  619.      If set to `t', then it means that `dired-x' should *not* bind
  620.      `dired-x-find-file' over `find-file' on keyboard.  Similarly, it
  621.      should not bind `dired-x-find-file-other-window' over
  622.      `find-file-other-window'.  If you change this variable after
  623.      `dired-x.el' is loaded then do `M-x dired-x-bind-find-file'.  The
  624.      default value of this variable is `t'; by default, the binding is
  625.      not done.  See *Note Optional Installation File At Point::.
  626. `dired-x-bind-find-file'
  627.      A function, which can be called interactively or in your
  628.      `~/.emacs' file, that uses the value of
  629.      `dired-x-hands-off-my-keys' to determine if `dired-x-find-file'
  630.      should be bound over `find-file' and
  631.      `dired-x-find-file-other-window' bound over
  632.      `find-file-other-window'.  See *Note Optional Installation File At
  633.      Point::.
  634. File: dired-x,  Node: Miscellaneous Commands,  Next: Bugs,  Prev: Find File At Point,  Up: Top
  635. Miscellaneous Commands
  636. **********************
  637.    Miscellaneous features not fitting anywhere else:
  638. `dired-find-subdir'
  639.      Default: `nil'
  640.      If non-`nil', Dired does not make a new buffer for a directory if
  641.      it can be found (perhaps as subdirectory) in some existing Dired
  642.      buffer.
  643.      If there are several Dired buffers for a directory, the most
  644.      recently used is chosen.
  645.      Dired avoids switching to the current buffer, so that if you have a
  646.      normal and a wildcard buffer for the same directory, `C-x d RET'
  647.      will toggle between those two.
  648. `M-g'
  649.      (`dired-goto-file') Goto file line of a file (or directory).
  650. `M-G'
  651.      (`dired-goto-subdir') Goto headerline of an inserted directory.
  652.      This commands reads its argument with completion over the names of
  653.      the inserted subdirectories.
  654.      (`dired-copy-filename-as-kill') The `w' command puts the names of
  655.      the marked (or next N) files into the kill ring, as if you had
  656.      killed them with `C-w'.  With a zero prefix argument N=0, use the
  657.      complete pathname of each file.  With a raw (just `C-u') prefix
  658.      argument, use the relative pathname of each marked file.  As a
  659.      special case, if no prefix argument is given and point is on a
  660.      directory headerline, it gives you the name of that directory,
  661.      without looking for marked files.
  662.      The list of names is also stored onto the variable
  663.      `dired-marked-files' for use, e.g., in an `ESC ESC'
  664.      (`eval-expression') command.
  665.      As this command also displays what was pushed onto the kill ring
  666.      you can use it to display the list of currently marked files in the
  667.      echo area (unless you happen to be on a subdirectory headerline).
  668.      You can then feed the file name to other Emacs commands with `C-y'.
  669.      For example, say you want to rename a long filename to a slightly
  670.      different name.  First type `w' to push the old name onto the kill
  671.      ring.  Then type `R' to rename it and use `C-y' inside `R''s
  672.      minibuffer prompt to insert the old name at a convenient place.
  673.      (`dired-do-toggle') Toggle marks.  That is, currently marked files
  674.      become unmarked and vice versa.  Files marked with other flags
  675.      (such as `D') are not affected.  The special directories `.' and
  676.      `..' are never toggled.
  677. `dired-smart-shell-command'
  678.      Like function `shell-command', but in the current Dired directory.
  679.      Bound to `M-!' in Dired buffers.
  680. `dired-jump'
  681.      Bound to `C-x C-j'.  Jump back to dired: If in a file, dired the
  682.      current directory and move to file's line.  If in Dired already,
  683.      pop up a level and goto old directory's line.  In case the proper
  684.      Dired file line cannot be found, refresh the Dired buffer and try
  685.      again.
  686. `dired-jump-other-window'
  687.      Bound to `C-x 4 C-j'. Like `dired-jump', but to other window.
  688.      These functions can be autoloaded so they work even though
  689.      `dired-x.el' has not been loaded yet (*Note Optional Installation
  690.      Dired Jump::).
  691.      If the variable `dired-bind-jump' is `nil', `dired-jump' will not
  692.      be bound to `C-x C-j' and `dired-jump-other-window' will not be
  693.      bound to `C-x 4 C-j'.
  694. `dired-vm'
  695.      Bound to `V' if `dired-bind-vm' is t.  Run VM on this file (assumed
  696.      to be a UNIX mail folder).
  697.      If you give this command a prefix argument, it will visit the
  698.      folder read-only.  This only works in VM~5, not VM~4.
  699.      If the variable `dired-vm-read-only-folders' is t, `dired-vm' will
  700.      visit all folders read-only.  If it is neither `nil' nor `t', e.g.,
  701.      the symbol `'if-file-read-only', only files not writable by you are
  702.      visited read-only.  This is the recommended value if you run VM 5.
  703.      If the variable `dired-bind-vm' is t, `dired-vm' will be bound to
  704.      `V'.  Otherwise, `dired-bind-rmail' will be bound.
  705. `dired-rmail'
  706.      Bound to `V' if `dired-bind-vm' is `nil'.  Run Rmail on this file
  707.      (assumed to be mail folder in Rmail/BABYL format).
  708. `dired-info'
  709.      Bound to `I'.  Run Info on this file (assumed to be a file in Info
  710.      format).
  711.      If the variable `dired-bind-info' is `nil', `dired-info' will not
  712.      be bound to I.
  713. `dired-man'
  714.      Bound to `N'.  Run man on this file (assumed to be a file in nroff
  715.      format).
  716.      If the variable `dired-bind-man' is `nil', `dired-man' will not be
  717.      bound to N.
  718. `dired-do-relative-symlink'
  719.      Bound to `Y'.  Relative symlink all marked (or next ARG) files
  720.      into a directory, or make a relative symbolic link to the current
  721.      file.  This creates relative symbolic links like
  722.      foo -> ../bar/foo
  723.      not absolute ones like
  724.      foo -> /ugly/path/that/may/change/any/day/bar/foo
  725. `dired-do-relative-symlink-regexp'
  726.      Bound to `%Y'.  Relative symlink all marked files containing
  727.      REGEXP to NEWNAME.  See functions `dired-do-rename-regexp' and
  728.      `dired-do-relsymlink' for more info.
  729. File: dired-x,  Node: Bugs,  Next: Concept Index,  Prev: Miscellaneous Commands,  Up: Top
  730. If you encounter a bug in this package, wish to suggest an enhancement,
  731. or want to make a smart remark, then type
  732.      `M-x dired-x-submit-report'
  733. to set up an outgoing mail buffer, with the proper address to the
  734. `dired-x.el' maintainer automatically inserted in the `To:' field.
  735. This command also inserts information that the Dired X maintainer can
  736. use to recreate your exact setup, making it easier to verify your bug
  737. or social maladjustment.
  738.    Lawrence R. Dodd <dodd@roebling.poly.edu>
  739. File: dired-x,  Node: Concept Index,  Next: Command Index,  Prev: Bugs,  Up: Top
  740. Concept Index
  741. *************
  742. * Menu:
  743. * dired-aux.el:                         Technical Details.
  744. * Adding to the kill ring in dired.:    Miscellaneous Commands.
  745. * Autoloading dired-jump and dired-jump-other-window: Optional Installation Dired Jump.
  746. * Binding dired-x-find-file:            Optional Installation File At Point.
  747. * Bugs:                                 Bugs.
  748. * Dot files, how to omit them in Dired: Omitting Examples.
  749. * Features:                             Features.
  750. * Finding a file at point:              Find File At Point.
  751. * GNU zip.:                             Shell Command Guessing.
  752. * Guessing shell commands for files.:   Shell Command Guessing.
  753. * How to make omitting the default in Dired: Omitting Variables.
  754. * Jumping to dired listing containing file.: Miscellaneous Commands.
  755. * Lisp expression, marking files with in Dired: Special Marking Function.
  756. * Local Variables for Dired Directories: Local Variables.
  757. * ls listings, how to peruse them in Dired: Virtual Dired.
  758. * Mark file by lisp expression:         Special Marking Function.
  759. * Multiple Dired directories:           Multiple Dired Directories.
  760. * Omitting additional files:            Omitting Variables.
  761. * Omitting dot files in Dired:          Omitting Examples.
  762. * Omitting Files in Dired:              Omitting Files in Dired.
  763. * Omitting RCS files in Dired:          Omitting Examples.
  764. * Omitting tib files in Dired:          Omitting Examples.
  765. * Passing GNU tar its `z' switch.:      Shell Command Guessing.
  766. * Perusing ls listings:                 Virtual Dired.
  767. * RCS files, how to omit them in Dired: Omitting Examples.
  768. * Reading mail.:                        Miscellaneous Commands.
  769. * Redefined functions:                  Technical Details.
  770. * Relative symbolic links.:             Miscellaneous Commands.
  771. * Running info.:                        Miscellaneous Commands.
  772. * Running man.:                         Miscellaneous Commands.
  773. * Simultaneous visiting of several files: Advanced Mark Commands.
  774. * Tib files, how to omit them in Dired: Omitting Examples.
  775. * Toggling marks.:                      Miscellaneous Commands.
  776. * Virtual Dired:                        Virtual Dired.
  777. * Visiting a file mentioned in a buffer: Find File At Point.
  778. * Visiting several files at once:       Advanced Mark Commands.
  779. * Working directory:                    Multiple Dired Directories.
  780. File: dired-x,  Node: Command Index,  Next: Key Index,  Prev: Concept Index,  Up: Top
  781. Function Index
  782. **************
  783. * Menu:
  784. * default-directory:                    Multiple Dired Directories.
  785. * dired-clean-patch:                    Advanced Cleaning Functions.
  786. * dired-clean-tex:                      Advanced Cleaning Functions.
  787. * dired-copy-filename-as-kill:          Miscellaneous Commands.
  788. * dired-do-find-marked-files:           Advanced Mark Commands.
  789. * dired-do-relative-symlink:            Miscellaneous Commands.
  790. * dired-do-relative-symlink-regexp:     Miscellaneous Commands.
  791. * dired-do-toggle:                      Miscellaneous Commands.
  792. * dired-flag-extension:                 Advanced Mark Commands.
  793. * dired-goto-file:                      Miscellaneous Commands.
  794. * dired-goto-subdir:                    Miscellaneous Commands.
  795. * dired-info:                           Miscellaneous Commands.
  796. * dired-jump:                           Miscellaneous Commands.
  797. * dired-jump-other-window:              Miscellaneous Commands.
  798. * dired-man:                            Miscellaneous Commands.
  799. * dired-mark-extension:                 Advanced Mark Commands.
  800. * dired-mark-sexp:                      Special Marking Function.
  801. * dired-omit-here-always:               Omitting Variables.
  802. * dired-omit-toggle:                    Omitting Files in Dired.
  803. * dired-rmail:                          Miscellaneous Commands.
  804. * dired-smart-shell-command:            Miscellaneous Commands.
  805. * dired-very-clean-tex:                 Advanced Cleaning Functions.
  806. * dired-virtual:                        Virtual Dired.
  807. * dired-virtual-mode:                   Virtual Dired.
  808. * dired-virtual-revert:                 Virtual Dired.
  809. * dired-vm:                             Miscellaneous Commands.
  810. * dired-x-bind-find-file:               Find File At Point.
  811. * dired-x-find-file:                    Find File At Point.
  812. * dired-x-find-file-other-window:       Find File At Point.
  813. * dired-x-submit-report:                Bugs.
  814. * shell-command:                        Miscellaneous Commands.
  815. File: dired-x,  Node: Key Index,  Next: Variable Index,  Prev: Command Index,  Up: Top
  816. Key Index
  817. *********
  818. * Menu:
  819. * %Y:                                   Miscellaneous Commands.
  820. * C-x 4 C-f:                            Find File At Point.
  821. * C-x 4 C-j:                            Miscellaneous Commands.
  822. * C-x C-f:                              Find File At Point.
  823. * C-x C-j:                              Miscellaneous Commands.
  824. * F:                                    Advanced Mark Commands.
  825. * g:                                    Virtual Dired.
  826. * I:                                    Miscellaneous Commands.
  827. * M-!:                                  Miscellaneous Commands.
  828. * M-(:                                  Special Marking Function.
  829. * M-g:                                  Miscellaneous Commands.
  830. * M-o:                                  Omitting Files in Dired.
  831. * N:                                    Miscellaneous Commands.
  832. * T:                                    Miscellaneous Commands.
  833. * V:                                    Miscellaneous Commands.
  834. * w:                                    Miscellaneous Commands.
  835. * Y:                                    Miscellaneous Commands.
  836. File: dired-x,  Node: Variable Index,  Prev: Key Index,  Up: Top
  837. Variable Index
  838. **************
  839. * Menu:
  840. * auto-mode-alist:                      Virtual Dired.
  841. * default-directory-alist:              Multiple Dired Directories.
  842. * dired-bibtex-unclean-extensions:      Advanced Cleaning Variables.
  843. * dired-bind-info:                      Miscellaneous Commands.
  844. * dired-bind-jump:                      Miscellaneous Commands.
  845. * dired-bind-man:                       Miscellaneous Commands.
  846. * dired-bind-vm:                        Miscellaneous Commands.
  847. * dired-enable-local-variables:         Local Variables.
  848. * dired-find-subdir:                    Miscellaneous Commands.
  849. * dired-guess-shell-alist-default:      Shell Command Guessing.
  850. * dired-guess-shell-alist-user:         Shell Command Guessing.
  851. * dired-guess-shell-gnutar:             Shell Command Guessing.
  852. * dired-guess-shell-gzip-quiet:         Shell Command Guessing.
  853. * dired-guess-shell-znew-switches nil:  Shell Command Guessing.
  854. * dired-latex-unclean-extensions:       Advanced Cleaning Variables.
  855. * dired-local-variables-file:           Local Variables.
  856. * dired-marked-files:                   Miscellaneous Commands.
  857. * dired-omit-extensions:                Omitting Variables.
  858. * dired-omit-files:                     Omitting Variables.
  859. * dired-omit-files-p:                   Omitting Variables.
  860. * dired-omit-localp:                    Omitting Variables.
  861. * dired-omit-marker-char:               Omitting Variables.
  862. * dired-patch-unclean-extensions:       Advanced Cleaning Variables.
  863. * dired-shell-command-history nil:      Shell Command Guessing.
  864. * dired-tex-unclean-extensions:         Advanced Cleaning Variables.
  865. * dired-texinfo-unclean-extensions:     Advanced Cleaning Variables.
  866. * dired-vm-read-only-folders:           Miscellaneous Commands.
  867. * dired-x-hands-off-my-keys:            Find File At Point.
  868. Tag Table:
  869. Node: Copyright
  870. Node: Top
  871. Node: Introduction
  872. Node: Features
  873. Node: Technical Details
  874. Node: Installation
  875. Node: Optional Installation Dired Jump
  876. Node: Optional Installation File At Point
  877. Node: Special Notes
  878. Node: Omitting Files in Dired
  879. 10758
  880. Node: Omitting Variables
  881. 12280
  882. Node: Omitting Examples
  883. 15589
  884. Node: Omitting Technical
  885. 16808
  886. Node: Local Variables
  887. 17224
  888. Node: Shell Command Guessing
  889. 19091
  890. Node: Virtual Dired
  891. 22082
  892. Node: Advanced Mark Commands
  893. 23609
  894. Node: Advanced Cleaning Functions
  895. 24966
  896. Node: Advanced Cleaning Variables
  897. 25793
  898. Node: Special Marking Function
  899. 26913
  900. Node: Multiple Dired Directories
  901. 28506
  902. Node: Find File At Point
  903. 29675
  904. Node: Miscellaneous Commands
  905. 32436
  906. Node: Bugs
  907. 37443
  908. Node: Concept Index
  909. 38041
  910. Node: Command Index
  911. 40486
  912. Node: Key Index
  913. 42561
  914. Node: Variable Index
  915. 43756
  916. End Tag Table
  917.