branch: elpa/hyperdrive
commit a26e5e5b0a5134759b80820177794b1a06d107bf
Author: Joseph Turner <jos...@ushin.org>
Commit: Joseph Turner <jos...@ushin.org>
Docs: Document meaning of directory view file size color
---
doc/hyperdrive.org | 19 +++++++++++++++----
doc/hyperdrive.texi | 25 +++++++++++++++++++++----
2 files changed, 36 insertions(+), 8 deletions(-)
diff --git a/doc/hyperdrive.org b/doc/hyperdrive.org
index 320fe36026..ff9bce7c2f 100644
--- a/doc/hyperdrive.org
+++ b/doc/hyperdrive.org
@@ -221,9 +221,18 @@ hyperdrives you've already created or visited:
*** Directory view
-~hyperdrive.el~ offers a Dired-like (see [[info:emacs#Dired]]) interface for
-exploring hyperdrive directories. The following keybindings are
-available inside the directory view by default:
+~hyperdrive.el~ offers a Dired-like (see [[info:emacs#Dired]]) interface
+for exploring hyperdrive directories. In the directory view, the file
+size color indicates how much of a file you have already downloaded:
+
+- green :: fully downloaded (~hyperdrive-size-fully-downloaded~)
+- yellow :: partially downloaded (~hyperdrive-size-partially-downloaded~)
+- red :: not downloaded (~hyperdrive-size-not-downloaded~)
+
+Mouse over the file size to see exactly how many blocks make up the
+file and how many of them you have downloaded.
+
+The following bindings are available in the directory view by default:
#+attr_texinfo: :compact t
- Key: n (hyperdrive-ewoc-next) ::
@@ -473,7 +482,9 @@ version number.
Delete your local copy of the file for the current buffer.
This command also has a keybinding in the directory view (see
-[[*Directory view]]).
+[[*Directory view]]). When you forget a file, the file size of its
+directory listing will turn red, indicating that you no longer have a
+copy of the file.
** View the hyperdrive version history
diff --git a/doc/hyperdrive.texi b/doc/hyperdrive.texi
index f787d9c931..1e1f2653a4 100644
--- a/doc/hyperdrive.texi
+++ b/doc/hyperdrive.texi
@@ -46,6 +46,7 @@ Repository: @uref{https://git.sr.ht/~ushin/hyperdrive.el}
@end itemize
This manual is for @code{hyperdrive.el} version 0.4-pre.
+
@end ifnottex
@menu
@@ -444,9 +445,23 @@ Like @code{hyperdrive-find-file}, but open the file in
@ref{View Mode,view-mode,
@node Directory view
@subsection Directory view
-@code{hyperdrive.el} offers a Dired-like (see @ref{Dired,,,emacs,}) interface
for
-exploring hyperdrive directories. The following keybindings are
-available inside the directory view by default:
+@code{hyperdrive.el} offers a Dired-like (see @ref{Dired,,,emacs,}) interface
+for exploring hyperdrive directories. In the directory view, the file
+size color indicates how much of a file you have already downloaded:
+
+@table @asis
+@item green
+fully downloaded (@code{hyperdrive-size-fully-downloaded})
+@item yellow
+partially downloaded (@code{hyperdrive-size-partially-downloaded})
+@item red
+not downloaded (@code{hyperdrive-size-not-downloaded})
+@end table
+
+Mouse over the file size to see exactly how many blocks make up the
+file and how many of them you have downloaded.
+
+The following bindings are available in the directory view by default:
@table @asis
@item @kbd{n} (@code{hyperdrive-ewoc-next})
@@ -747,7 +762,9 @@ Delete your local copy of the file for the current buffer.
@end deffn
This command also has a keybinding in the directory view (see
-@ref{Directory view}).
+@ref{Directory view}). When you forget a file, the file size of its
+directory listing will turn red, indicating that you no longer have a
+copy of the file.
@node View the hyperdrive version history
@section View the hyperdrive version history
