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