Mercurial > emacs
changeset 36382:5ecd29c2f552
Lots of markup and wording changes.
author | Eli Zaretskii <eliz@gnu.org> |
---|---|
date | Sun, 25 Feb 2001 13:37:54 +0000 |
parents | 4993e5072bcb |
children | d26ad6e1f13f |
files | man/dired-x.texi |
diffstat | 1 files changed, 130 insertions(+), 109 deletions(-) [+] |
line wrap: on
line diff
--- a/man/dired-x.texi Sun Feb 25 02:02:08 2001 +0000 +++ b/man/dired-x.texi Sun Feb 25 13:37:54 2001 +0000 @@ -5,13 +5,13 @@ @c Author: Sebastian Kremer <sk@thp.uni-koeln.de> @c Lawrence R. Dodd <dodd@roebling.poly.edu> @c [Dodd's address no longer valid.] -@c Version: 2.52 -@c Date: 1994/08/09 16:51:31 +@c Version: 2.53 +@c Date: 2001/02/25 14:05:46 @c Keywords: dired extensions @c dired-x.el REVISION NUMBER: 2 @c State: Released -@c Ident: dired-x.texi,v 2.52 1994/08/09 16:51:31 dodd Released +@c Ident: dired-x.texi,v 2.53 2001/02/25 14:05:46 dodd Released @comment %**start of header (This is for running Texinfo on a region.) @c FOR GNU EMACS USE ../info/dired-x BELOW @@ -41,7 +41,7 @@ This documents the ``extra'' features for Dired Mode for GNU Emacs found in the file @file{dired-x.el}. -Copyright @copyright{} 1993, 1994 Free Software Foundation, Inc. +Copyright @copyright{} 1993, 1994, 2001 Free Software Foundation, Inc. Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice are @@ -80,8 +80,8 @@ @sp 1 @center @titlefont{Directory Editor} @sp 4 -@center Manual Revision: 2.52 -@center 1994/08/09 16:51:31 +@center Manual Revision: 2.53 +@center 2001/02/25 14:05:46 @sp 5 @center Lawrence R@. Dodd @c @center @t{dodd@@roebling.poly.edu} @@ -89,7 +89,7 @@ @center (Based on @file{dired.texi} by Sebastian Kremer <sk@@thp.uni-koeln.de>) @page @vskip 0pt plus 1filll -Copyright @copyright{} 1993, 1994 Free Software Foundation +Copyright @copyright{} 1993, 1994, 2001 Free Software Foundation Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice @@ -132,7 +132,7 @@ For @file{dired-x.el} revision 2 @c @item -@c Revision of this manual: 2.52 (1994/08/09 16:51:31) +@c Revision of this manual: 2.53 (2001/02/25 14:05:46) @c @item @c Bugs to Lawrence R. Dodd <dodd@@roebling.poly.edu>. @emph{Please} type @@ -197,22 +197,22 @@ @enumerate @item -Omitting of uninteresting files from dired listing. +Omitting uninteresting files from Dired listing. @itemize @bullet @xref{Omitting Files in Dired}. @end itemize @item -Local variables for dired directories. +Local variables for Dired directories. @itemize @bullet @xref{Local Variables}. @end itemize @item -Guessing shell commands in dired buffers. +Guessing shell commands in Dired buffers. @itemize @bullet @xref{Shell Command Guessing}. @end itemize @item -Running dired command in non-dired buffers. +Running Dired command in non-Dired buffers. @itemize @bullet @xref{Virtual Dired}. @end itemize @@ -271,7 +271,7 @@ @chapter Installation @noindent -This manual describes the dired features provided by the file +This manual describes the Dired features provided by the file @file{dired-x.el}. To take advantage of these features, you must load the file and (optionally) set some variables. @@ -295,8 +295,8 @@ @end example @noindent -This will load @file{dired-x.el} when dired is first invoked (for example, -when you first do @kbd{C-x d}). +This will load @file{dired-x.el} when Dired is first invoked (for example, +when you first type @kbd{C-x d}). @ifinfo @menu @@ -324,10 +324,10 @@ (define-key global-map "\C-x4\C-j" 'dired-jump-other-window) (autoload (quote dired-jump) "dired" "\ -Jump to dired buffer corresponding to current buffer. -If in a file, dired the current directory and move to file's line. -If in dired already, pop up a level and goto old directory's line. -In case the proper dired file line cannot be found, refresh the dired +Jump to Dired buffer corresponding to current buffer. +If in a file, Dired the current directory and move to file's line. +If in Dired already, pop up a level and goto old directory's line. +In case the proper Dired file line cannot be found, refresh the Dired buffer and try again." t nil) (autoload (quote dired-jump-other-window) "dired" "\ @@ -342,7 +342,8 @@ (define-key global-map "\C-x\C-j" 'dired-jump) @end example -@noindent in your @file{.emacs} file in order to have @kbd{C-x C-j} work +@noindent +in your @file{.emacs} file in order to have @kbd{C-x C-j} work before @code{dired} is loaded. @node Optional Installation File At Point, , Optional Installation Dired Jump, Installation @@ -383,6 +384,7 @@ @chapter Omitting Files in Dired @cindex Omitting Files in Dired +@cindex Uninteresting files @dfn{Omitting} a file means removing it from the directory listing. Omitting is useful for keeping Dired buffers free of ``uninteresting'' files (for instance, auto-save, auxiliary, backup, and revision control files) so that @@ -397,7 +399,7 @@ cannot be omitted (though each of its files could be). @item -Omitting is wholesale; if omitting is turned on for a dired buffer, then all +Omitting is wholesale; if omitting is turned on for a Dired buffer, then all uninteresting files listed in that buffer are omitted. The user does not omit (or unomit) files one at a time. @@ -414,7 +416,7 @@ @kindex M-o @findex dired-omit-toggle (@code{dired-omit-toggle}) Toggle between displaying and omitting -``uninteresting'' files. With a prefix argument, don't toggle and just mark +``uninteresting'' files. With a prefix argument, just mark the files, but don't actually omit them. @end table @@ -436,6 +438,7 @@ @section Omitting Variables +@cindex Customizing file omitting The following variables can be used to customize omitting. @table @code @@ -446,15 +449,17 @@ Default: @code{nil} @cindex How to make omitting the default in Dired -If non-@code{nil}, ``uninteresting'' files are not listed. Uninteresting -files are those whose filenames match regexp @code{dired-omit-files}, plus -those ending with extensions in @code{dired-omit-extensions}. @kbd{M-o} -(@code{dired-omit-toggle}) toggles its value, which is buffer-local. Put +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}) +toggles its value, which is buffer-local. Put @example (setq dired-omit-files-p t) @end example +@noindent inside your @code{dired-mode-hook} to have omitting initially turned on in @emph{every} Dired buffer (@pxref{Installation}). You can then use @kbd{M-o} to unomit in that buffer. @@ -487,17 +492,16 @@ Default: @code{"^#\\|\\.$"} -Filenames matching this buffer-local regexp will not be displayed. -This only has effect when @code{dired-omit-files-p} is t. +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}. The default value omits the special directories @file{.} and @file{..} and -autosave files (plus other files ending in ``.'') (@pxref{Omitting Examples}). +autosave files (plus other files ending in @file{.}) (@pxref{Omitting Examples}). @vindex dired-omit-extensions @item dired-omit-extensions -Default: The elements of @code{completion-ignored-extensions} (as defined in -the file @file{loaddefs.el} of the GNU Emacs distribution), +Default: The elements of @code{completion-ignored-extensions}, @code{dired-latex-unclean-extensions}, @code{dired-bibtex-unclean-extensions} and @code{dired-texinfo-unclean-extensions}. @@ -507,13 +511,13 @@ @vindex dired-omit-localp @item dired-omit-localp -Default: @code{'no-dir} +Default: @code{no-dir} The @var{localp} argument @code{dired-omit-expunge} passes to -@code{dired-get-filename}. If it is @code{'no-dir}, omitting is much faster, -but you can only match against the non-directory part of the filename. Set it -to @code{nil} if you need to match the whole pathname or @code{t} to match the -pathname relative to the buffer's top-level directory. +@code{dired-get-filename}. If it is @code{no-dir}, omitting is much faster, +but you can only match against the non-directory part of the file name. Set it +to @code{nil} if you need to match the whole file name or @code{t} to match the +file name relative to the buffer's top-level directory. @item dired-omit-marker-char @vindex dired-omit-marker-char @@ -522,7 +526,7 @@ Temporary marker used by Dired to implement omitting. Should never be used as marker by the user or other packages. There is one exception to this rule: -by doing +by adding @example (setq dired-mark-keys "\C-o") @@ -530,7 +534,8 @@ ;; (which is not defined yet) @end example -anywhere in your @file{~/.emacs}, you will bind the @kbd{C-o} key to insert a +@noindent +to your @file{~/.emacs}, you can bind the @kbd{C-o} key to insert a @kbd{C-o} marker, thus causing these files to be omitted in addition to the usually omitted files. Unfortunately the files you omitted manually this way will show up again after reverting the buffer, unlike the others. @@ -546,15 +551,16 @@ @item @cindex RCS files, how to omit them in Dired @cindex Omitting RCS files in Dired -If you wish to avoid seeing RCS files and the RCS directory, then put +If you wish to avoid seeing RCS files and the @file{RCS} directory, then put @example (setq dired-omit-files (concat dired-omit-files "\\|^RCS$\\|,v$")) @end example + @noindent in the @code{dired-load-hook} (@pxref{Installation}). This assumes -@code{dired-omit-localp} has its default value of @code{'no-dir} to make the +@code{dired-omit-localp} has its default value of @code{no-dir} to make the @code{^}-anchored matches work. As a slower alternative, with @code{dired-omit-localp} set to @code{nil}, you can use @code{/} instead of @code{^} in the regexp. @@ -562,8 +568,9 @@ @item @cindex Tib files, how to omit them in Dired @cindex Omitting tib files in Dired -If you use tib, the bibliography program for use with @TeX{} and La@TeX{}, you -might want to omit the @file{INDEX} and the @file{-t.tex} files, then put +If you use @code{tib}, the bibliography program for use with @TeX{} and +La@TeX{}, and you +want to omit the @file{INDEX} and the @file{*-t.tex} files, then put @example (setq dired-omit-files @@ -576,7 +583,7 @@ @item @cindex Dot files, how to omit them in Dired @cindex Omitting dot files in Dired -If you do not wish to see @samp{dot} files (files starting with a @samp{.}), +If you do not wish to see @samp{dot} files (files starting with a @file{.}), then put @example @@ -651,15 +658,15 @@ @item dired-local-variables-file Default: @code{".dired"} -If non-@code{nil}, filename for local variables for Dired. If Dired finds a +If non-@code{nil}, file name for local variables for Dired. If Dired finds a file with that name in the current directory, it will temporarily insert it -into the dired buffer and run `hack-local-variables'. +into the Dired buffer and run @code{hack-local-variables}. @vindex dired-enable-local-variables @item dired-enable-local-variables Default: @code{t} -Controls use of local-variables lists in dired. The value can be @code{t}, +Controls the use of local-variables lists in Dired. The value can be @code{t}, @code{nil}, or something else. A value of @code{t} means local-variables lists are obeyed in the @code{dired-local-variables-file}; @code{nil} means they are ignored; anything else means query. This variable temporarily @@ -672,14 +679,14 @@ @chapter Shell Command Guessing @cindex Guessing shell commands for files. -Based upon the name of a filename, Dired tries to guess what shell +Based upon the name of a file, Dired tries to guess what shell command you might want to apply to it. For example, if you have point on a file named @file{foo.tar} and you press @kbd{!}, Dired will guess you want to @samp{tar xvf} it and suggest that as the default shell command. -The default will be mentioned in brackets and you can type @kbd{M-p} to get -the default into the minibuffer so that you can edit it, e.g., changing +The default is mentioned in brackets and you can type @kbd{M-p} to get +the default into the minibuffer and then edit it, e.g., to change @samp{tar xvf} to @samp{tar tvf}. If there are several commands for a given file, e.g., @samp{xtex} and @samp{dvips} for a @file{.dvi} file, you can type @kbd{M-p} several times to see each of the matching commands. @@ -708,9 +715,10 @@ (@var{regexp} @var{command}@dots{}) @end example +@noindent where each @var{command} can either be a string or a lisp expression -that evaluates to a string. If several @var{COMMAND}s are given, all -will temporarily be pushed on the history. +that evaluates to a string. If several commands are given, all of +them will temporarily be pushed onto the history. You can set this variable in your @file{~/.emacs}. For example, to add rules for @samp{.foo} and @samp{.bar} file extensions, write @@ -731,30 +739,31 @@ @item dired-guess-shell-gnutar @vindex dired-guess-shell-gnutar -@cindex Passing GNU tar its `z' switch. +@cindex Passing GNU Tar its @samp{z} switch. Default: @code{nil} -If non-@code{nil}, name of the GNU tar executable (e.g., @samp{"tar"} or -@samp{"gnutar"}). GNU tar's @samp{z} switch is used for compressed tar files. +If non-@code{nil}, this is the name of the GNU Tar executable (e.g., +@samp{tar} or @samp{gnutar}). GNU Tar's @samp{z} switch is used for +compressed tar files. If you don't have GNU tar, set this to @code{nil}: a pipe using @samp{zcat} is then used. @item dired-guess-shell-gzip-quiet @vindex dired-guess-shell-gzip-quiet -@cindex GNU zip. +@cindex @code{gzip} Default: @code{t} -A non-@code{nil} value means that @code{-q} is passed to gzip overriding a -verbose GNU zip's @env{GZIP} environment variable. +A non-@code{nil} value means that @samp{-q} is passed to @code{gzip} +overriding a verbose option in the @env{GZIP} environment variable. @item dired-guess-shell-znew-switches nil @vindex dired-guess-shell-znew-switches nil -@cindex GNU zip. +@cindex @code{znew} Default: @code{nil} -A string of switches passed to GNU zip's @file{znew}. An example is -@samp{"-K"} which will make @file{znew} keep a .Z file when it is smaller than -the .gz file. +A string of switches passed to @code{znew}. An example is +@samp{-K} which will make @code{znew} keep a @file{.Z} file when it is +smaller than the @file{.gz} file. @item dired-shell-command-history nil @vindex dired-shell-command-history nil @@ -767,8 +776,8 @@ @chapter Virtual Dired @cindex Virtual Dired -@cindex Perusing ls listings -@cindex ls listings, how to peruse them in Dired +@cindex Perusing @code{ls} listings +@cindex @code{ls} listings, how to peruse them in Dired Using @dfn{Virtual Dired} means putting a buffer with Dired-like contents in Dired mode. The files described by the buffer contents need not actually exist. This is useful if you want to peruse an @samp{ls -lR} @@ -800,8 +809,9 @@ auto-mode-alist)) @end example -The regexp is a bit more complicated than usual to exclude ".dired" -local variable files. +@noindent +The regexp is a bit more complicated than usual to exclude @file{.dired} +local-variable files. @node Advanced Mark Commands, Advanced Cleaning Functions, Virtual Dired, Top @comment node-name, next, previous, up @@ -814,8 +824,9 @@ @cindex Simultaneous visiting of several files @findex dired-do-find-marked-files (@code{dired-do-find-marked-files}) Find all marked files at once displaying -simultaneously. If optional NOSELECT is non-@code{nil} then just find the -files but do not select. If you want to keep the dired buffer displayed, type +them simultaneously. If optional @var{noselect} is non-@code{nil} then just +find the +files but do not select. If you want to keep the Dired buffer displayed, type @kbd{C-x 2} first. If you want just the marked files displayed and nothing else, type @kbd{C-x 1} first. @@ -829,9 +840,10 @@ @item dired-mark-extension @findex dired-mark-extension Mark all files with a certain extension for use in later commands. A @samp{.} -is not automatically prepended to the string entered. +is not automatically prepended to the string entered, you must type it +explicitly. -When called from lisp, @var{extension} may also be a list of extensions +When called from Lisp, @var{extension} may also be a list of extensions and an optional argument @var{marker-char} specifies the marker used. @item dired-flag-extension @@ -877,8 +889,8 @@ @item dired-very-clean-tex @findex dired-very-clean-tex -Flag dispensable files created by @TeX{}, La@TeX{}, @samp{texinfo}, and ".dvi" -files for deletion. +Flag dispensable files created by @TeX{}, La@TeX{}, @samp{texinfo}, +and @file{*.dvi} files for deletion. @end table @node Advanced Cleaning Variables, Special Marking Function, Advanced Cleaning Functions, Advanced Mark Commands @@ -892,32 +904,32 @@ @table @code @item dired-patch-unclean-extensions @vindex dired-patch-unclean-extensions -Default: @code{'(".rej" ".orig")} +Default: @code{(".rej" ".orig")} List of extensions of dispensable files created by the @samp{patch} program. @item dired-tex-unclean-extensions @vindex dired-tex-unclean-extensions -Default: @code{'(".toc" ".log" ".aux")} +Default: @code{(".toc" ".log" ".aux")} List of extensions of dispensable files created by @TeX{}. @item dired-texinfo-unclean-extensions @vindex dired-texinfo-unclean-extensions -Default: @code{'(".cp" ".cps" ".fn" ".fns" ".ky" ".kys"} +Default: @code{(".cp" ".cps" ".fn" ".fns" ".ky" ".kys"} @code{".pg" ".pgs" ".tp" ".tps" ".vr" ".vrs")} List of extensions of dispensable files created by @samp{texinfo}. @item dired-latex-unclean-extensions @vindex dired-latex-unclean-extensions -Default: @code{'(".idx" ".lof" ".lot" ".glo")} +Default: @code{(".idx" ".lof" ".lot" ".glo")} List of extensions of dispensable files created by La@TeX{}. @item dired-bibtex-unclean-extensions @vindex dired-bibtex-unclean-extensions -Default: @code{'(".blg" ".bbl")} +Default: @code{(".blg" ".bbl")} List of extensions of dispensable files created by Bib@TeX{}. @end table @@ -945,7 +957,7 @@ [@i{integer}] the size of the file for @samp{ls -s} output (usually in blocks or, with @samp{-k}, in KBytes) @item mode -[@i{string}] file permission bits, e.g., @samp{"-rw-r--r--"} +[@i{string}] file permission bits, e.g., @samp{-rw-r--r--} @item nlink [@i{integer}] number of links to file @item uid @@ -956,11 +968,11 @@ @item size [@i{integer}] file size in bytes @item time -[@i{string}] the time that @samp{ls} displays, e.g., @samp{"Feb 12 14:17"} +[@i{string}] the time that @samp{ls} displays, e.g., @samp{Feb 12 14:17} @item name [@i{string}] the name of the file @item sym -[@i{string}] if file is a symbolic link, the linked-to name, else @samp{""} +[@i{string}] if file is a symbolic link, the linked-to name, else @code{""} @end table @noindent @@ -970,7 +982,7 @@ @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 @@ -988,8 +1000,8 @@ @cindex Working directory An Emacs buffer can have but one working directory, stored in the buffer-local variable @code{default-directory}. A Dired buffer may have -several subdirectories inserted, but still has but one working -directory: that of the top level Dired directory in that buffer. For +several subdirectories inserted, but it still has only one working +directory: that of the top-level Dired directory in that buffer. For some commands it is appropriate that they use the current Dired directory instead of @code{default-directory}, e.g., @code{find-file} and @code{compile}. @@ -1002,7 +1014,7 @@ @vindex default-directory-alist Default: @code{((dired-mode . (dired-current-directory)))} -Alist of major modes and their opinion on @code{default-directory}, as a +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 in favor of @code{default-directory}. @@ -1020,9 +1032,9 @@ @cindex Finding a file at point @file{dired-x} provides a method of visiting or editing a file mentioned in -the buffer you are viewing (e.g., a mail buffer, a news article, a README -file, etc.) or to test if that file exists. You can then modify this in the -minibuffer after snatching the filename. +the buffer you are viewing (e.g., a mail buffer, a news article, a +@file{README} file, etc.) or to test if that file exists. You can then modify +this in the minibuffer after snatching the file name. When installed @file{dired-x} will substitute @code{dired-x-find-file} for @code{find-file} (normally bound to @kbd{C-x C-f}) and @@ -1040,7 +1052,7 @@ @code{dired-x-find-file} behaves exactly like @code{find-file} (normally bound to @kbd{C-x C-f}) unless a prefix argument is passed to the function in which -case it will use the filename at point as a guess for the file to visit. +case it will use the file name at point as a guess for the file to visit. For example, if the buffer you were reading contained the words @@ -1050,6 +1062,7 @@ /roebling.poly.edu:/pub/lisp/crypt++.el.gz @end example +@noindent then you could move your cursor to the line containing the ftp address and type @kbd{C-u C-x C-f} (the @kbd{C-u} is a universal argument). The minibuffer would read @@ -1058,7 +1071,8 @@ Find file: /roebling.poly.edu:/pub/lisp/crypt++.el.gz @end example -with the point after the last @code{/}. If you hit return emacs will visit +@noindent +with the point after the last @code{/}. If you hit @key{RET}, emacs will visit the file at that address. This also works with files on your own computer. @item dired-x-find-file-other-window @@ -1076,7 +1090,7 @@ should not bind @code{dired-x-find-file-other-window} over @code{find-file-other-window}. If you change this variable after @file{dired-x.el} is loaded then do @kbd{M-x dired-x-bind-find-file}. The -default value of this variable is @kbd{t}; by default, the binding is not +default value of this variable is @code{t}; by default, the binding is not done. See @xref{Optional Installation File At Point}. @item dired-x-bind-find-file @@ -1114,19 +1128,19 @@ @findex dired-goto-file @kindex M-g @item M-g -(@code{dired-goto-file}) Goto file line of a file (or directory). +(@code{dired-goto-file}) Go to the line of a file (or directory). @findex dired-goto-subdir @kindex M-G @item M-G -(@code{dired-goto-subdir}) Goto headerline of an inserted directory. -This commands reads its argument with completion over the names of the +(@code{dired-goto-subdir}) Go to the header line of an inserted directory. +This command reads its argument, with completion derived from the names of the inserted subdirectories. @end table @table @kbd @item w -@cindex Adding to the kill ring in dired. +@cindex Adding to the kill ring in Dired. @kindex w @findex dired-copy-filename-as-kill (@code{dired-copy-filename-as-kill}) The @kbd{w} command puts the names @@ -1141,12 +1155,12 @@ The list of names is also stored onto the variable @code{dired-marked-files} for use, e.g., in the @kbd{M-:} (@code{eval-expression}) command. -As this command also displays what was pushed onto the kill ring you can +As this command also displays what was pushed onto the kill ring, you can use it to display the list of currently marked files in the echo area (unless you happen to be on a subdirectory headerline). You can then feed the file name to other Emacs commands with @kbd{C-y}. -For example, say you want to rename a long filename to a slightly +For example, say you want to rename a file with a long name to a slightly different name. First type @kbd{w} to push the old name onto the kill ring. Then type @kbd{R} to rename it and use @kbd{C-y} inside @kbd{R}'s minibuffer prompt to insert the old name at a convenient place. @@ -1157,8 +1171,8 @@ @findex dired-do-toggle (@code{dired-do-toggle}) Toggle marks. That is, currently marked files become unmarked and vice versa. Files marked with other flags -(such as `D') are not affected. The special directories `.' and `..' -are never toggled. +(such as @samp{D}) are not affected. The special directories @file{.} +and @file{..} are never toggled. @end table @table @code @@ -1172,10 +1186,10 @@ @item dired-jump @findex dired-jump @kindex C-x C-j -@cindex Jumping to dired listing containing file. -Bound to @kbd{C-x C-j}. Jump back to dired: If in a file, dired the current +@cindex Jumping to Dired listing containing file. +Bound to @kbd{C-x C-j}. Jump back to Dired: If in a file, edit the current directory and move to file's line. If in Dired already, pop up a level and -goto old directory's line. In case the proper Dired file line cannot be +go to old directory's line. In case the proper Dired file line cannot be found, refresh the Dired buffer and try again. @item dired-jump-other-window @@ -1200,11 +1214,12 @@ @vindex dired-vm-read-only-folders If you give this command a prefix argument, it will visit the folder -read-only. This only works in VM~5, not VM~4. +read-only. This only works in VM 5, not VM 4. -If the variable @code{dired-vm-read-only-folders} is t, @code{dired-vm} will +If the variable @code{dired-vm-read-only-folders} is @code{t}, +@code{dired-vm} will visit all folders read-only. If it is neither @code{nil} nor @code{t}, e.g., -the symbol @code{'if-file-read-only}, only files not writable by you are +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 @@ -1226,18 +1241,18 @@ @vindex dired-bind-info If the variable @code{dired-bind-info} is @code{nil}, @code{dired-info} will -not be bound to I. +not be bound to @kbd{I}. @item dired-man @cindex Running man. @kindex N @findex dired-man -Bound to @kbd{N}. Run man on this file (assumed to be a file in nroff +Bound to @kbd{N}. Run man on this file (assumed to be a file in @code{nroff} format). @vindex dired-bind-man If the variable @code{dired-bind-man} is @code{nil}, @code{dired-man} will not -be bound to N. +be bound to @kbd{N}. @item dired-do-relative-symlink @cindex Relative symbolic links. @@ -1247,18 +1262,24 @@ directory, or make a relative symbolic link to the current file. This creates relative symbolic links like +@example foo -> ../bar/foo +@end example +@noindent not absolute ones like +@example foo -> /ugly/path/that/may/change/any/day/bar/foo +@end example @item dired-do-relative-symlink-regexp @kindex %Y @findex dired-do-relative-symlink-regexp -Bound to @kbd{%Y}. Relative symlink all marked files containing REGEXP to -NEWNAME. See functions `dired-do-rename-regexp' and `dired-do-relsymlink' for -more info. +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 +info. @end table @node Bugs, Concept Index, Miscellaneous Commands, Top