Use shorter lines in man page

This commit is contained in:
Arun Prakash Jana 2020-01-15 11:09:51 +05:30
parent 0222b75c2e
commit 2c6fb0eefc
No known key found for this signature in database
GPG key ID: A75979F35C080412
3 changed files with 107 additions and 53 deletions

View file

@ -23,9 +23,9 @@ nnn v2.9
- visit to pinned dir like bookmarks (Bookmark key followed by <kbd>,</kbd>) - visit to pinned dir like bookmarks (Bookmark key followed by <kbd>,</kbd>)
- toggle executable (key <kbd>*</kbd>) - toggle executable (key <kbd>*</kbd>)
- show mime along with file details - show mime along with file details
- special keys at empty filter prompt: - more special keys at empty filter prompt:
- apply the last filter (key <kbd>^L</kbd>) - apply the last filter (<kbd>^L</kbd>)
- set to string (key <kbd>/</kbd>) or regex (key <kbd>\\</kbd>) - toggle between string and regex (<kbd>/</kbd>)
- toggle case-sensitivity (<kbd>:</kbd>) - toggle case-sensitivity (<kbd>:</kbd>)
- retain filter on <kbd>Esc</kbd>, <kbd>Up</kbd>, <kbd>Down</kbd> - retain filter on <kbd>Esc</kbd>, <kbd>Up</kbd>, <kbd>Down</kbd>
- show filter details when filter is on - show filter details when filter is on

150
nnn.1
View file

@ -29,7 +29,12 @@
.Op Ar PATH .Op Ar PATH
.Sh DESCRIPTION .Sh DESCRIPTION
.Nm .Nm
(Nnn's Not Noice) is a performance-optimized, feature-packed fork of noice (http://git.2f30.org/noice/) with seamless desktop integration, simplified navigation, \fInavigate-as-you-type\fR mode with auto select, disk usage analyzer mode, bookmarks, contexts, application launcher, familiar navigation shortcuts, subshell spawning and much more. It remains a simple and efficient file manager that stays out of your way. (Nnn's Not Noice) is a performance-optimized, feature-packed fork of
noice (http://git.2f30.org/noice/) with seamless desktop integration,
simplified navigation, \fInavigate-as-you-type\fR mode with auto select,
disk usage analyzer mode, bookmarks, contexts, application launcher,
familiar navigation shortcuts, subshell spawning and much more.It
remains a simple and efficient file manager that stays out of your way.
.Pp .Pp
.Nm .Nm
opens the current working directory by default if opens the current working directory by default if
@ -82,10 +87,11 @@ supports the following options:
copy (or \fIpick\fR) selection to file, or stdout if file='-' copy (or \fIpick\fR) selection to file, or stdout if file='-'
.Pp .Pp
.Fl Q .Fl Q
disable confirmation when quitting program with multiple active contexts disable confirmation on quit with multiple contexts active
.Pp .Pp
.Fl r .Fl r
show cp, mv progress (Linux-only, needs advcpmv; '^T' shows the progress on BSD/macOS) show cp, mv progress
(Linux-only, needs advcpmv; '^T' shows the progress on BSD/macOS)
.Pp .Pp
.Fl R .Fl R
disable rollover at edges disable rollover at edges
@ -103,18 +109,27 @@ 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; copy path to system clipboard on select show notis on selection cp, mv, rm completion
copy path to system clipboard on select
.Pp .Pp
.Fl h .Fl h
show program help and exit show program help and exit
.Sh CONFIGURATION .Sh CONFIGURATION
.Nm There is no configuration file. Associated files are at
uses \fIxdg-open\fR (on Linux) and \fIopen(1)\fR (on macOS) as the desktop opener.
.Pp .Pp
There is no configuration file. Associated files are stored in \fB${XDG_CONFIG_HOME:-$HOME/.config}/nnn/\fR. Settings work on environment variables. See ENVIRONMENT section below. \fB${XDG_CONFIG_HOME:-$HOME/.config}/nnn/\fR
.Pp
Configuration is done using a few optional (set if you need) environment
variables. See ENVIRONMENT section.
.Pp
.Nm
uses \fIxdg-open\fR (on Linux), \fIopen(1)\fR (on macOS), \fIcygstart\fR on
(Cygwin) and \fIopen\fR on (Haiku) as the desktop opener. It's also possible
to specify a custom opener. See ENVIRONMENT section.
.Sh CONTEXTS .Sh CONTEXTS
Contexts serve the purpose of exploring multiple directories simultaneously. 4 contexts Contexts serve the purpose of exploring multiple directories simultaneously. 4
are available. The status of the contexts are shown in the top left corner: contexts are available. The status of the contexts are shown in the top left
corner:
.Pp .Pp
- the current context is in reverse video - the current context is in reverse video
.br .br
@ -122,38 +137,61 @@ are available. The status of the contexts are shown in the top left corner:
.br .br
- rest are inactive - rest are inactive
.Pp .Pp
On context creation, the state of the previous context is copied. Each context remembers its last visited directory. On context creation, the state of the previous context is copied. Each context
remembers its last visited directory.
.Pp .Pp
Each context can have its own directory color specified. See ENVIRONMENT section below. Each context can have its own directory color specified. See ENVIRONMENT
section.
.Sh SESSIONS .Sh SESSIONS
Sessions are a way to save and restore states of work. A session stores the settings and contexts. Sessions are a way to save and restore states of work. A session stores the
settings and contexts.
.Pp .Pp
Sessions can be loaded dynamically from within a running Sessions can be loaded dynamically from within a running
.Nm .Nm
instance, or with a program option. instance, or with a program option.
.Pp .Pp
When a session is loaded dynamically, the last working session is saved automatically to a dedicated When a session is loaded dynamically, the last working session is saved
-- "last session" -- session file. automatically to a dedicated -- "last session" -- session file.
.Pp
All the session files are located by session name in the directory
.Pp
\fB${XDG_CONFIG_HOME:-$HOME/.config}/nnn/sessions\fR
.Pp .Pp
All the session files are located in the \fB${XDG_CONFIG_HOME:-$HOME/.config}/nnn/sessions\fR directory by the session name.
"@" is the "last session" file. "@" is the "last session" file.
.Sh FILTERS .Sh FILTERS
Filters are strings to find matching entries in the current directory instantly (\fIsearch-as-you-type\fR). There is a program option to switch to regex filters. Matches are case-insensitive by default. Filters are strings to find matching entries in the current directory
instantly (\fIsearch-as-you-type\fR). There is a program option to switch to
regex filters. Matches are case-insensitive by default. In each context the
last filter is persisted at runtime or in saved sessions.
.Pp .Pp
To modify match criteria at runtime: Special keys at empty filter prompt:
.br
- toggle between string and regex: press '/' at empty filter prompt
.br
- toggle case sensitivity: press ':' at empty filter prompt
.Pp .Pp
In each context the last filter is persisted at runtime or in saved - toggle between string and regex: '/'
sessions, and can be accessed with '^L' at the empty filter prompt. It's .br
possible to change the match criteria and re-apply the last filter. - toggle case sensitivity: ':'
.br
- apply the last filter (or clear filter if non-empty): '^L'
.br
- show help and config screen: '?'
.br
- show command prompt: ']'
.br
- launch an application: '='
.br
- run a plugin by its key: ';'
.br
- pin current directory: ','
.Pp
Other noteworthy keys:
.Pp
- '^char': usual keybind functionality
.br
- 'Esc': exit filter prompt but skip dir refresh
.Pp .Pp
Common regex use cases: Common regex use cases:
.Pp .Pp
(1) To list all matches starting with the filter expression, start the expression (1) To list all matches starting with the filter expression,
with a '^' (caret) symbol. start the expression with a '^' (caret) symbol.
.br .br
(2) Type '\\.mkv' to list all MKV files. (2) Type '\\.mkv' to list all MKV files.
.br .br
@ -164,26 +202,36 @@ allowing continuous navigation. Works best with the \fBarrow keys\fR.
.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 program option to disable this behaviour. auto selects the directory and enters it in this mode. Use the relevant
program option to disable this behaviour.
.Sh SELECTION .Sh SELECTION
There are 3 groups of keybinds to add files to selection: There are 3 groups of keybinds to add files to selection:
.Pp .Pp
(1) hovered file selection toggle (deselects if '+' is visible before the entry, else adds to selection) (1) hovered file selection toggle (deselects if '+' is visible before the
entry, else adds to selection)
.br .br
(2) add a range of files to selection (repeat the range key on the same entry twice to clear selection completely) (2) add a range of files to selection (repeat the range key on the same entry
twice to clear selection completely)
.br .br
(3) add all files in the current directory to selection (3) add all files in the current directory to selection
.Pp .Pp
A selection can be edited, copied, moved, removed, archived or linked. A selection can be edited, copied, moved, removed, archived or linked.
.Pp .Pp
Absolute paths of the selected files are copied to \fB.selection\fR file in the config directory. Absolute paths of the selected files are copied to \fB.selection\fR file in
the config directory.
.Pp .Pp
To edit the selection use the _edit selection_ key. Use this key to remove a file from selection after you navigate away from its directory. Editing doesn't end the selection mode. You can add more files to the selection and edit the list again. If no file is selected in the current session, this option attempts to list the selection file. To edit the selection use the _edit selection_ key. Use this key to remove a
.Sh FILE SIZE file from selection after you navigate away from its directory. Editing doesn't
The minimum file size unit is byte (B). The rest are K, M, G, T, P, E, Z, Y (powers of 1024), same as the default units in \fIls\fR. end the selection mode. You can add more files to the selection and edit the
list again. If no file is selected in the current session, this option attempts
to list the selection file.
.Sh UNITS
The minimum file size unit is byte (B). The rest are K, M, G, T, P, E, Z, Y
(powers of 1024), same as the default units in \fIls\fR.
.Sh ENVIRONMENT .Sh ENVIRONMENT
The SHELL, EDITOR (VISUAL, if defined) and PAGER environment variables take precedence The SHELL, EDITOR (VISUAL, if defined) and PAGER environment variables take
when dealing with the !, e and p commands respectively. A single combination to arguments is supported for SHELL and PAGER. precedence when dealing with the !, e and p commands respectively. A single
combination to arguments is supported for SHELL and PAGER.
.Pp .Pp
\fBNNN_OPENER:\fR specify a custom file opener. \fBNNN_OPENER:\fR specify a custom file opener.
.Bd -literal .Bd -literal
@ -192,18 +240,18 @@ when dealing with the !, e and p commands respectively. A single combination to
NOTE: `nuke` is a file opener available in plugin repository NOTE: `nuke` is a file opener available in plugin repository
.Ed .Ed
.Pp .Pp
\fBNNN_BMS:\fR bookmark string as \fIkey_char:location\fR pairs (max 10) separated by \fBNNN_BMS:\fR bookmark string as \fIkey_char:location\fR pairs
\fI;\fR: (max 10) separated by \fI;\fR:
.Bd -literal .Bd -literal
export NNN_BMS='d:~/Documents;u:/home/user/Cam Uploads;D:~/Downloads/' export NNN_BMS='d:~/Documents;u:/home/user/Cam Uploads;D:~/Downloads/'
NOTE: To go to a bookmark, press the Lead key followed by the bookmark key. NOTE: To go to a bookmark, press the Lead key followed by the bookmark key.
.Ed .Ed
.Pp .Pp
\fBNNN_PLUG:\fR directly executable plugins as \fIkey_char:location\fR pairs (max 10) separated by \fBNNN_PLUG:\fR directly executable plugins as \fIkey_char:location\fR pairs
\fI;\fR: (max 15) separated by \fI;\fR:
.Bd -literal .Bd -literal
export NNN_PLUG='o:fzopen;p:mocplay;d:diffs;m:nmount;t:imgthumb;i:mediainf' export NNN_PLUG='o:fzopen;p:mocplay;d:diffs;m:nmount;t:imgthumb'
NOTES: NOTES:
1. To run a plugin directly, press \fI;\fR followed by the plugin key 1. To run a plugin directly, press \fI;\fR followed by the plugin key
@ -213,15 +261,17 @@ when dealing with the !, e and p commands respectively. A single combination to
.Ed .Ed
.Pp .Pp
To assign keys to arbitrary non-background non-shell-interpreted cli To assign keys to arbitrary non-background non-shell-interpreted cli
commands and invoke like plugins, add \fI_\fR (underscore) before the command. commands and invoke like plugins, add \fI_\fR (underscore) before the
command.
.Bd -literal .Bd -literal
export NNN_PLUG='x:_chmod +x $nnn;g:_git log;s:_smplayer $nnn;o:fzopen;m:nmount' export NNN_PLUG='x:_chmod +x $nnn;g:_git log;s:_smplayer $nnn;o:fzopen'
NOTES: NOTES:
1. Use single quotes for $NNN_PLUG so $nnn is not interpreted 1. Use single quotes for $NNN_PLUG so $nnn is not interpreted
2. $nnn should be the last argument (IF you want to pass the hovered file name) 2. $nnn should be the last argument (IF used)
3. (Again) add \fB_\fR before the command 3. (Again) add \fB_\fR before the command
4. To disable directory refresh after running a \fIcommand as plugin\fR, prefix the command with \fB-_\fR 4. To disable directory refresh after running a \fIcommand as plugin\fR,
prefix with \fB-_\fR
5. To skip user confirmation after command execution, suffix with \fB*\fR 5. To skip user confirmation after command execution, suffix with \fB*\fR
export NNN_PLUG='y:-_sync*' export NNN_PLUG='y:-_sync*'
@ -241,7 +291,8 @@ when dealing with the !, e and p commands respectively. A single combination to
----------------------------------- + ------------------------------------------------- ----------------------------------- + -------------------------------------------------
.Ed .Ed
.Pp .Pp
\fBNNN_USE_EDITOR:\fR use VISUAL (else EDITOR, preferably CLI, fallback vi) to handle text files. \fBNNN_USE_EDITOR:\fR use VISUAL (else EDITOR, preferably CLI, fallback vi)
to handle text files.
.Bd -literal .Bd -literal
export NNN_USE_EDITOR=1 export NNN_USE_EDITOR=1
.Ed .Ed
@ -267,17 +318,20 @@ when dealing with the !, e and p commands respectively. A single combination to
NOTE: The options must be preceded by `rclone` and max 5 flags are supported. NOTE: The options must be preceded by `rclone` and max 5 flags are supported.
.Ed .Ed
.Pp .Pp
\fBNNN_IDLE_TIMEOUT:\fR set idle timeout (in seconds) to invoke terminal locker (default: disabled). \fBNNN_IDLE_TIMEOUT:\fR set idle timeout (in seconds) to invoke terminal locker
(default: disabled).
.Pp .Pp
\fBNNN_TRASH:\fR trash (instead of \fIdelete\fR) files to desktop Trash. \fBNNN_TRASH:\fR trash (instead of \fIdelete\fR) files to desktop Trash.
.Bd -literal .Bd -literal
export NNN_TRASH=1 export NNN_TRASH=1
.Ed .Ed
.Pp .Pp
\fBNNN:\fR this is a special variable set to the hovered entry before executing a command from the command prompt or spawning a shell. \fBnnn:\fR this is a special variable set to the hovered entry before executing
a command from the command prompt or spawning a shell.
.Sh KNOWN ISSUES .Sh KNOWN ISSUES
.Nm .Nm
may not handle keypresses correctly when used with tmux (see issue #104 for more details). Set \fBTERM=xterm-256color\fR to address it. may not handle keypresses correctly when used with tmux (see issue #104 for
more details). Set \fBTERM=xterm-256color\fR to address it.
.Sh AUTHORS .Sh AUTHORS
.An Arun Prakash Jana Aq Mt engineerarun@gmail.com , .An Arun Prakash Jana Aq Mt engineerarun@gmail.com ,
.An Lazaros Koromilas Aq Mt lostd@2f30.org , .An Lazaros Koromilas Aq Mt lostd@2f30.org ,

View file

@ -102,9 +102,9 @@ Now there will be no prompt after <kbd>;s</kbd> and <kbd>;n</kbd>.
Notes: Notes:
1. Use single quotes for `$NNN_PLUG` so `$nnn` is not interpreted 1. Use single quotes for `$NNN_PLUG` so `$nnn` is not interpreted
2. `$nnn` should be the last argument (IF you want to pass the hovered file name) 2. `$nnn` should be the last argument (IF used)
3. (_Again_) add `_` before the command 3. (_Again_) add `_` before the command
4. To disable directory refresh after running a _command as plugin_, prefix the command with `-_` 4. To disable directory refresh after running a _command as plugin_, prefix with `-_`
#### Some useful key-command examples #### Some useful key-command examples