1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2025-12-15 10:30:25 -08:00

Make dired-virtual doc string less confusing

* lisp/dired-x.el (dired-virtual): Make the doc string less
confusing (bug#20992).
This commit is contained in:
Lars Ingebrigtsen 2021-12-02 10:47:18 +01:00
parent 7ca865dc52
commit 3f98188b86

View file

@ -580,17 +580,16 @@ files in the active region if `dired-mark-region' is non-nil."
(defalias 'virtual-dired 'dired-virtual)
(defun dired-virtual (dirname &optional switches)
"Put this Dired buffer into Virtual Dired mode.
"Try to make the current buffer into a Dired buffer.
This command is rarely useful, but may be convenient if you want
to peruse and move around in the output you got from \"ls
-lR\" (or something similar), without having access to the actual
file system.
In Virtual Dired mode, all commands that do not actually consult the
filesystem will work.
This is useful if you want to peruse and move around in an ls -lR
output file, for example one you got from an ftp server. With
ange-ftp, you can even Dired a directory containing an ls-lR file,
visit that file and turn on Virtual Dired mode. But don't try to save
this file, as `dired-virtual' indents the listing and thus changes the
buffer.
Most Dired commands that don't consult the file system will work
as advertised, but commands that try to alter the file system
will usually fail. (If the output is from the current system,
most of those commands, too, will work fine.)
If you have saved a Dired buffer in a file you can use \\[dired-virtual] to
resume it in a later session.