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