]> Sergey Matveev's repositories - nnn.git/commitdiff
make the manpage more clear
authorNRK <nrk@disroot.org>
Thu, 23 Dec 2021 22:51:21 +0000 (04:51 +0600)
committerNRK <nrk@disroot.org>
Sat, 25 Dec 2021 02:35:23 +0000 (08:35 +0600)
some of the terms used in the manpage aren't exactly obvious, especially
to a new user. this is an attempt at making the manual more clear and
remove any potential confusion.

here's a couple issues i've noticed where users were confused due to non
clear manpage description:

https://github.com/jarun/nnn/issues/1268
https://github.com/jarun/nnn/issues/1269
https://github.com/jarun/nnn/issues/1209

nnn.1

diff --git a/nnn.1 b/nnn.1
index ba1ac8f5ebc43867ec09b22a44e440c340cecb7e..293f018b0052a5d60bf3f19475e680473f3e9ae9 100644 (file)
--- a/nnn.1
+++ b/nnn.1
@@ -89,6 +89,7 @@ supports the following options:
 .Pp
 .Fl J
         disable auto-proceed on select
+        (eg. making a selection will no longer move cursor to the next entry)
 .Pp
 .Fl K
         test for keybind collision
@@ -113,10 +114,11 @@ supports the following options:
 .Pp
 .Fl r
         show cp, mv progress
-        (Linux-only, needs advcpmv; '^T' shows the progress on BSD/macOS)
+        (Linux-only, needs \fIadvcpmv\fR; '^T' shows the progress on BSD/macOS)
 .Pp
 .Fl R
-        disable rollover at edges
+        disable rollover at edges (eg. pressing \fIdown\fR while on the last
+        entry will no longer move cursor to the first entry and vice\-versa)
 .Pp
 .Fl "s name"
         load a session by name
@@ -142,8 +144,8 @@ supports the following options:
         show version and exit
 .Pp
 .Fl x
-        show notis on selection cp, mv, rm completion
-        copy path to system clipboard on select
+        show notis on selection cp, mv, rm completion (requires \fI.cbcp\fR plugin)
+        copy path to system clipboard on select (requires \fI.ntfy\fR plugin)
         show xterm title (if non-picker mode)
 .Pp
 .Fl h