about summary refs log tree commit diff
path: root/pkgs/profpatsch/nman
diff options
context:
space:
mode:
authorsternenseemann <0rpkxez4ksa01gb3typccl0i@systemli.org>2021-02-17 18:38:21 +0100
committersternenseemann <sternenseemann@systemli.org>2021-02-25 19:52:33 +0100
commitc2040d76326efd4c2e7f6e9480c0b41794438c73 (patch)
tree866ceea242405a07c31b5eaf1e51bae97367e9a5 /pkgs/profpatsch/nman
parent2ae38412ed6f775dc41fb3fcf91ffe85d1e45c20 (diff)
pkgs/profpatsch/nman(1): misc clarifications
(as suggested by Profpatsch)
Diffstat (limited to 'pkgs/profpatsch/nman')
-rw-r--r--pkgs/profpatsch/nman/nman.112
1 files changed, 7 insertions, 5 deletions
diff --git a/pkgs/profpatsch/nman/nman.1 b/pkgs/profpatsch/nman/nman.1
index 4c8e2805..1bcf5a8f 100644
--- a/pkgs/profpatsch/nman/nman.1
+++ b/pkgs/profpatsch/nman/nman.1
@@ -20,7 +20,9 @@ page and opens it directly using
 .Xr man 1 ,
 essentially implementing what you would expect
 .Ql nix-shell -p foo --run 'man foo'
-to do.
+to do, but
+.Nm
+will only download the minimum amount of data necessary to read the man page.
 .Pp
 You can invoke
 .Nm
@@ -74,16 +76,16 @@ uses
 to first evaluate all the derivation outputs of the given attribute.
 It then utilizes
 .Xr nix-store 1
-to realise the outputs one by one until it finds the desired man page
-or runs out of outputs.
+to realise (that is to download or build) the outputs one by one until
+it finds the desired man page or runs out of outputs.
 When the man page is found, it is opened using
 .Xr man 1 .
 .Pp
 The outputs are checked in order of likelihood to contain man pages.
 This means that
 .Nm
-is as fast as possible for packages that follow good conventions
-like having their man pages in
+is as fast as possible and downloads the least amount of data possible for packages
+that follow good conventions, like having their man pages in
 .Ql man ,
 .Ql devman
 or