X-Git-Url: https://code.delx.au/gnu-emacs/blobdiff_plain/5ee8b21202f7ab531aa1d88a3909d8068ffe426e..cd72c39915f4d43a286f1a193ee950c8c8049c10:/man/dired-x.texi diff --git a/man/dired-x.texi b/man/dired-x.texi index ad7711d10a..7a53e5a681 100644 --- a/man/dired-x.texi +++ b/man/dired-x.texi @@ -28,7 +28,8 @@ This documents the ``extra'' features for Dired Mode for GNU Emacs found in the file @file{dired-x.el}. -Copyright @copyright{} 1993, 1994, 2001, 2002 Free Software Foundation, Inc. +Copyright @copyright{} 1993, 1994, 2001, 2002, 2003, 2004, +2005, 2006 Free Software Foundation, Inc. @quotation Permission is granted to make and distribute verbatim copies of this @@ -93,7 +94,7 @@ notice identical to this one except for the removal of this paragraph @page -@ifinfo +@ifnottex @node Top @comment node-name, next, previous, up @@ -144,7 +145,7 @@ For @file{dired-x.el} revision 2 @end menu -@end ifinfo +@end ifnottex @node Introduction, Installation, Top, Top @comment node-name, next, previous, up @@ -161,12 +162,12 @@ the code using @code{gmhist} history functions was replaced with code using the mini-buffer history now built into GNU Emacs. Finally, a few other features have been added and a few more functions have been bound to keys. -@ifinfo +@ifnottex @menu * Features:: * Technical Details:: @end menu -@end ifinfo +@end ifnottex @node Features, Technical Details, , Introduction @comment node-name, next, previous, up @@ -270,7 +271,7 @@ initialization file @file{default.el} in the @file{site-lisp} directory, put (add-hook 'dired-mode-hook (lambda () ;; Set dired-x buffer-local variables here. For example: - ;; (setq dired-omit-files-p t) + ;; (dired-omit-mode 1) )) @end example @@ -278,12 +279,12 @@ initialization file @file{default.el} in the @file{site-lisp} directory, put This will load @file{dired-x.el} when Dired is first invoked (for example, when you first type @kbd{C-x d}). -@ifinfo +@ifnottex @menu * Optional Installation Dired Jump:: * Optional Installation File At Point:: @end menu -@end ifinfo +@end ifnottex @node Optional Installation Dired Jump, Optional Installation File At Point, , Installation @comment node-name, next, previous, up @@ -297,9 +298,9 @@ In order to have @code{dired-jump} and @code{dired-jump-other-window} for these functions. In your @file{.emacs} file put @example -;;; Autoload `dired-jump' and `dired-jump-other-window'. -;;; We autoload from FILE dired.el. This will then load dired-x.el -;;; and hence define `dired-jump' and `dired-jump-other-window'. +;; Autoload `dired-jump' and `dired-jump-other-window'. +;; We autoload from FILE dired.el. This will then load dired-x.el +;; and hence define `dired-jump' and `dired-jump-other-window'. (define-key global-map "\C-x\C-j" 'dired-jump) (define-key global-map "\C-x4\C-j" 'dired-jump-other-window) @@ -394,24 +395,27 @@ Marked files are never omitted. @table @kbd @item M-o @kindex M-o -@findex dired-omit-toggle -(@code{dired-omit-toggle}) Toggle between displaying and omitting -``uninteresting'' files. With a prefix argument, just mark -the files, but don't actually omit them. +@findex dired-omit-mode +(@code{dired-omit-mode}) Toggle between displaying and omitting +``uninteresting'' files. +@item * O +@kindex * O +@findex dired-mark-omitted +(@code{dired-mark-omitted}) Mark ``uninteresting'' files. @end table @noindent In order to make Dired Omit work you first need to load @file{dired-x.el} -inside @code{dired-load-hook} (@pxref{Installation}) and then set -@code{dired-omit-files-p} in some way (@pxref{Omitting Variables}). +inside @code{dired-load-hook} (@pxref{Installation}) and then evaluate +@code{(dired-omit-mode 1)} in some way (@pxref{Omitting Variables}). -@ifinfo +@ifnottex @menu * Omitting Variables:: * Omitting Examples:: * Omitting Technical:: @end menu -@end ifinfo +@end ifnottex @node Omitting Variables, Omitting Examples, , Omitting Files in Dired @comment node-name, next, previous, up @@ -423,8 +427,8 @@ The following variables can be used to customize omitting. @table @code -@vindex dired-omit-files-p -@item dired-omit-files-p +@vindex dired-omit-mode +@item dired-omit-mode Default: @code{nil} @@ -432,11 +436,11 @@ Default: @code{nil} If non-@code{nil}, ``uninteresting'' files are not listed. Uninteresting files are those whose files whose names match regexp @code{dired-omit-files}, plus those ending with extensions in -@code{dired-omit-extensions}. @kbd{M-o} (@code{dired-omit-toggle}) +@code{dired-omit-extensions}. @kbd{M-o} (@code{dired-omit-mode}) toggles its value, which is buffer-local. Put @example -(setq dired-omit-files-p t) +(dired-omit-mode 1) @end example @noindent @@ -449,7 +453,7 @@ Local Variables and put @example Local Variables: -dired-omit-files-p: t +dired-omit-mode: t End: @end example @@ -473,7 +477,7 @@ the directory listing (@pxref{Local Variables}). Default: @code{"^#\\|\\.$"} Files whose names match this buffer-local regexp will not be displayed. -This only has effect when @code{dired-omit-files-p}'s value is @code{t}. +This only has effect when @code{dired-omit-mode}'s value is @code{t}. The default value omits the special directories @file{.} and @file{..} and autosave files (plus other files ending in @file{.}) (@pxref{Omitting Examples}). @@ -604,7 +608,7 @@ For example, if the user puts @example Local Variables: dired-actual-switches: "-lat" -dired-omit-files-p: t +dired-omit-mode: t End: @end example @@ -696,7 +700,7 @@ Each element of the alist looks like @end example @noindent -where each @var{command} can either be a string or a lisp expression +where each @var{command} can either be a string or a Lisp expression that evaluates to a string. If several commands are given, all of them will temporarily be pushed onto the history. @@ -835,13 +839,13 @@ Flag all files with a certain extension for deletion. A @samp{.} is @emph{not} automatically prepended to the string entered. @end table -@ifinfo +@ifnottex @menu * Advanced Cleaning Functions:: * Advanced Cleaning Variables:: * Special Marking Function:: @end menu -@end ifinfo +@end ifnottex @node Advanced Cleaning Functions, Advanced Cleaning Variables, , Advanced Mark Commands @comment node-name, next, previous, up @@ -927,11 +931,11 @@ List of extensions of dispensable files created by Bib@TeX{}. @kindex M-( @findex dired-mark-sexp @cindex Lisp expression, marking files with in Dired -@cindex Mark file by lisp expression +@cindex Mark file by Lisp expression (@code{dired-mark-sexp}) Mark files for which @var{predicate} returns non-@code{nil}. With a prefix argument, unflag those files instead. -The @var{predicate} is a lisp expression that can refer to the following +The @var{predicate} is a Lisp expression that can refer to the following symbols: @table @code @item inode @@ -965,7 +969,7 @@ For example, use @end example to mark all zero length files. -To find out all not yet compiled Emacs lisp files in a directory, Dired +To find out all not yet compiled Emacs Lisp files in a directory, Dired all @file{.el} files in the lisp directory using the wildcard @samp{*.el}. Then use @kbd{M-(} with @example @@ -998,13 +1002,14 @@ directory in special major modes: Default: @code{((dired-mode . (dired-current-directory)))} Alist of major modes and their notion of @code{default-directory}, as a -lisp expression to evaluate. A resulting value of @code{nil} is ignored +Lisp expression to evaluate. A resulting value of @code{nil} is ignored in favor of @code{default-directory}. -@item default-directory -@findex default-directory -Function with usage like variable @code{default-directory}, but knows about the -special cases in variable @code{default-directory-alist}. +@item dired-default-directory +@findex dired-default-directory +Use this function like you would use the variable +@code{default-directory}, except that @code{dired-default-directory} +also consults the variable @code{default-directory-alist}. @end table @node Find File At Point, Miscellaneous Commands, Multiple Dired Directories, Top @@ -1150,8 +1155,8 @@ bound to @kbd{C-x C-j} and @code{dired-jump-other-window} will not be bound to @cindex Reading mail. @kindex V @findex dired-vm -Bound to @kbd{V} if @code{dired-bind-vm} is t. Run VM on this file (assumed -to be a UNIX mail folder). +Bound to @kbd{V} if @code{dired-bind-vm} is @code{t}. Run VM on this +file (assumed to be a UNIX mail folder). @vindex dired-vm-read-only-folders If you give this command a prefix argument, it will visit the folder @@ -1164,8 +1169,8 @@ the symbol @code{if-file-read-only}, only files not writable by you are visited read-only. This is the recommended value if you run VM 5. @vindex dired-bind-vm -If the variable @code{dired-bind-vm} is t, @code{dired-vm} will be bound to -@kbd{V}. Otherwise, @code{dired-bind-rmail} will be bound. +If the variable @code{dired-bind-vm} is @code{t}, @code{dired-vm} will be bound +to @kbd{V}. Otherwise, @code{dired-bind-rmail} will be bound. @item dired-rmail @cindex Reading mail. @@ -1195,10 +1200,10 @@ format). If the variable @code{dired-bind-man} is @code{nil}, @code{dired-man} will not be bound to @kbd{N}. -@item dired-do-relative-symlink +@item dired-do-relsymlink @cindex Relative symbolic links. @kindex Y -@findex dired-do-relative-symlink +@findex dired-do-relsymlink Bound to @kbd{Y}. Relative symlink all marked (or next ARG) files into a directory, or make a relative symbolic link to the current file. This creates relative symbolic links like @@ -1214,9 +1219,9 @@ not absolute ones like foo -> /ugly/path/that/may/change/any/day/bar/foo @end example -@item dired-do-relative-symlink-regexp +@item dired-do-relsymlink-regexp @kindex %Y -@findex dired-do-relative-symlink-regexp +@findex dired-do-relsymlink-regexp Bound to @kbd{%Y}. Relative symlink all marked files containing @var{regexp} to @var{newname}. See functions @code{dired-do-rename-regexp} and @code{dired-do-relsymlink} for more