Merge pull request #1270 from N-R-K/doc_improvement

Make the manpage more clear
This commit is contained in:
Arun 2021-12-25 08:17:45 +05:30 committed by GitHub
commit e44f8d3fcc
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 13 additions and 11 deletions

22
nnn.1
View file

@ -23,7 +23,7 @@ is a performance-optimized, feature-packed fork of noice
.Em http://git.2f30.org/noice/ .Em http://git.2f30.org/noice/
with seamless desktop integration, simplified navigation, with seamless desktop integration, simplified navigation,
.Em type-to-nav .Em type-to-nav
mode with auto select, disk usage analyzer mode, bookmarks, mode with dir auto-enter, disk usage analyzer mode, bookmarks,
contexts, application launcher, familiar navigation shortcuts, contexts, application launcher, familiar navigation shortcuts,
subshell spawning and much more. It remains a simple and subshell spawning and much more. It remains a simple and
efficient file manager that stays out of your way. efficient file manager that stays out of your way.
@ -48,7 +48,7 @@ supports the following options:
auto-setup temporary NNN_FIFO (described in ENVIRONMENT section) auto-setup temporary NNN_FIFO (described in ENVIRONMENT section)
.Pp .Pp
.Fl A .Fl A
disable directory auto-select in type-to-nav mode disable directory auto-enter in type-to-nav mode
.Pp .Pp
.Fl "b key" .Fl "b key"
specify bookmark key to open specify bookmark key to open
@ -88,7 +88,8 @@ supports the following options:
show current file information in info bar (may be slow) show current file information in info bar (may be slow)
.Pp .Pp
.Fl J .Fl J
disable auto-proceed on select disable auto-proceed on selection
(eg. selecting an entry will no longer move cursor to the next entry)
.Pp .Pp
.Fl K .Fl K
test for keybind collision test for keybind collision
@ -113,10 +114,11 @@ supports the following options:
.Pp .Pp
.Fl r .Fl r
show cp, mv progress 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 .Pp
.Fl R .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 .Pp
.Fl "s name" .Fl "s name"
load a session by name load a session by name
@ -142,8 +144,8 @@ supports the following options:
show version and exit show version and exit
.Pp .Pp
.Fl x .Fl x
show notis on selection cp, mv, rm completion show notifications on selection cp, mv, rm completion (requires \fI.ntfy\fR plugin)
copy path to system clipboard on select copy path to system clipboard on selection (requires \fI.cbcp\fR plugin)
show xterm title (if non-picker mode) show xterm title (if non-picker mode)
.Pp .Pp
.Fl h .Fl h
@ -233,7 +235,7 @@ in \fBtype-to-nav\fR mode:
Key | Function Key | Function
------ + ------------------------ ------ + ------------------------
' | Go to first non-dir file ' | Go to first non-dir file
+ | Toggle auto-advance + | Toggle auto-proceed on open
, | Mark CWD , | Mark CWD
- | Go to last visited dir - | Go to last visited dir
. | Show hidden files . | Show hidden files
@ -263,8 +265,8 @@ mode, allowing continuous navigation.
.br .br
When there's a unique match and it's a directory, When there's a unique match and it's a directory,
.Nm .Nm
auto selects the directory and enters it in this mode. Use the relevant auto enters it in this mode. Use the relevant program option to disable this
program option to disable this behaviour. behaviour.
.Sh SELECTION .Sh SELECTION
.Nm .Nm
allows file selection across directories and contexts! allows file selection across directories and contexts!

View file

@ -8112,7 +8112,7 @@ static void usage(void)
#ifndef NOFIFO #ifndef NOFIFO
" -a auto NNN_FIFO\n" " -a auto NNN_FIFO\n"
#endif #endif
" -A no dir auto-enter\n" " -A no dir auto-enter in type-to-nav\n"
" -b key open bookmark key (trumps -s/S)\n" " -b key open bookmark key (trumps -s/S)\n"
" -c cli-only NNN_OPENER (trumps -e)\n" " -c cli-only NNN_OPENER (trumps -e)\n"
" -C 8-color scheme\n" " -C 8-color scheme\n"