about summary refs log tree commit diff
path: root/pkgs/profpatsch
diff options
context:
space:
mode:
authorsternenseemann <0rpkxez4ksa01gb3typccl0i@systemli.org>2021-02-20 16:52:37 +0100
committersternenseemann <sternenseemann@systemli.org>2021-02-25 19:52:33 +0100
commit0b549ad875ac6b0d67c7222b46bd8ad49ad46db9 (patch)
tree3516d981ef0bd9d1f44f9b8c6ef5b82202ed8a1b /pkgs/profpatsch
parente55e41bd2b3c674d47d66b84f9ad7e4d23384245 (diff)
pkgs/profpatsch/nman(1): reorder invocation descriptions
Now shortest is listed first.
Diffstat (limited to 'pkgs/profpatsch')
-rw-r--r--pkgs/profpatsch/nman/nman.151
1 files changed, 26 insertions, 25 deletions
diff --git a/pkgs/profpatsch/nman/nman.1 b/pkgs/profpatsch/nman/nman.1
index b2248201..c2011ae4 100644
--- a/pkgs/profpatsch/nman/nman.1
+++ b/pkgs/profpatsch/nman/nman.1
@@ -28,46 +28,47 @@ You can invoke
 .Nm
 in four different ways:
 .Bl -ohang -offset 2n
-.It Nm Ar ATTR SECTION PAGE
+.It Nm Ar ATTR
 Evaluates the attribute
 .Ar ATTR
 of
 .Ql <nixpkgs>
-and searches all its outputs for a man page of name
-.Ar PAGE
-in man section
-.Ar SECTION .
-.Ar PAGE
-and
-.Ar SECTION
-work just like with
-.Xr man 1 .
+and searches all its outputs for a man page named
+.Ar ATTR
+which may be in any section.
+If multiple matches are found, the one that is alphanumerically
+lower is preferred:
+For example,
+.Xr lowdown 1
+is preferred over
+.Xr lowdown 3 .
 .It Nm Ar ATTR SECTION
 Like above, but
-.Ar ATTR
-is also used as the name of the man page.
+.Nm
+will only look for the man page in the given section
+.Ar SECTION .
 Note that
 .Ar SECTION
 must be a number or
-.Ql 3p .
-Otherwise the next invocation is assumed.
+.Ql 3p ,
+otherwise the next invocation is assumed.
 .It Nm Ar ATTR PAGE
 Opens the man page
 .Ar PAGE
 from package
 .Ar ATTR .
-If multiple matches are found, pages from lower
-man sections are preferred, for example
-.Ql nman lowdown lowdown
-opens
-.Xr lowdown 1
-and not
-.Xr lowdown 3 .
-.It Nm Ar ATTR
-Uses the described method to find the man page
-.Ar ATTR
-from package
+Man section precedence works like described above.
+.It Nm Ar ATTR SECTION PAGE
+Opens man page
+.Ar PAGE
+in section
+.Ar SECTION
+from the package described by
 .Ar ATTR .
+This is the invocation with the least magic and works
+just like invoking
+.Xr man 1
+with two arguments.
 .El
 .Sh DISCLAIMER
 .Nm