nnn/nnn.1

230 lines
7.3 KiB
Groff
Raw Normal View History

2019-03-18 21:44:35 +00:00
.Dd Mar 19, 2019
.Dt NNN 1
2014-10-22 11:52:45 +00:00
.Os
.Sh NAME
.Nm nnn
2018-08-06 23:22:39 +00:00
.Nd the missing terminal file manager for X
2014-10-22 11:52:45 +00:00
.Sh SYNOPSIS
2017-06-04 17:45:08 +00:00
.Nm
.Op Ar -b key
.Op Ar -d
2017-07-03 04:16:37 +00:00
.Op Ar -e
.Op Ar -i
2017-07-03 04:16:37 +00:00
.Op Ar -l
2019-02-05 19:08:55 +00:00
.Op Ar -n
2018-11-23 17:11:47 +00:00
.Op Ar -p file
2019-02-05 19:08:55 +00:00
.Op Ar -s
2017-04-14 18:44:25 +00:00
.Op Ar -S
.Op Ar -v
2019-02-27 15:33:14 +00:00
.Op Ar -w
2017-04-14 18:44:25 +00:00
.Op Ar -h
.Op Ar PATH
2014-10-22 11:52:45 +00:00
.Sh DESCRIPTION
.Nm
2018-12-16 14:59:03 +00:00
(Noice is 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.
2014-10-22 11:52:45 +00:00
.Pp
.Nm
2017-12-24 13:16:56 +00:00
opens the current working directory by default if
2017-04-14 18:44:25 +00:00
.Ar PATH
2017-03-31 02:52:51 +00:00
is not specified.
2018-11-11 10:52:58 +00:00
.Sh KEYBINDS
.Pp
Press \fB?\fR in
.Nm
to see the list of keybinds.
2018-11-11 10:52:58 +00:00
.Sh OPTIONS
.Pp
2017-04-01 05:18:18 +00:00
.Nm
2017-04-13 13:43:33 +00:00
supports the following options:
2017-04-01 05:18:18 +00:00
.Pp
.Fl "b key"
specify bookmark key to open
.Pp
.Fl d
show hidden files
.Pp
2017-07-02 18:27:41 +00:00
.Fl e
use exiftool instead of mediainfo
.Pp
.Fl i
start in navigate-as-you-type mode
.Pp
2017-07-02 18:27:41 +00:00
.Fl l
start in light mode (fewer details)
.Pp
.Fl n
use version compare to sort files
.Pp
2018-11-23 17:11:47 +00:00
.Fl "p file"
copy (or \fIpick\fR) selection to file, or stdout if file='-'
.Pp
2019-02-05 19:08:55 +00:00
.Fl s
use substring match for filters instead of regex
.Pp
.Fl S
start in disk usage analyzer mode
2017-04-13 13:43:33 +00:00
.Pp
.Fl v
show version and exit
2017-04-14 18:44:25 +00:00
.Pp
2019-02-27 15:33:14 +00:00
.Fl w
2019-03-20 03:44:39 +00:00
wild load - entries unsorted on directory load
2019-02-27 15:33:14 +00:00
.Pp
2017-04-14 18:44:25 +00:00
.Fl h
show program help and exit
2014-10-22 11:52:45 +00:00
.Sh CONFIGURATION
.Nm
2018-12-01 23:40:19 +00:00
uses \fIxdg-open\fR (on Linux) and \fIopen(1)\fR (on macOS) as the desktop opener.
.Pp
2019-03-23 14:14:07 +00:00
There is no configuration file. Settings work on environment variables. See ENVIRONMENT section below.
2017-06-11 13:54:02 +00:00
.Pp
2017-04-19 12:52:30 +00:00
Configuring
.Nm
to change to the last visited directory on quit requires shell integration in a
2019-03-23 14:14:07 +00:00
few easy steps. Look up NNN_TMPFILE in the ENVIRONMENT section below.
2018-11-08 12:59:38 +00:00
.Sh CONTEXTS
2018-11-11 22:06:37 +00:00
Contexts serve the purpose of exploring multiple directories simultaneously. 4 contexts
are available. The status of the contexts are shown in the top left corner:
2018-11-08 12:59:38 +00:00
.Pp
- the current context is in reverse
.br
2019-03-23 14:14:07 +00:00
- other active contexts are underlined
2018-11-08 12:59:38 +00:00
.br
2019-03-23 14:14:07 +00:00
- rest are inactive
2018-11-08 12:59:38 +00:00
.Pp
2018-11-11 22:06:37 +00:00
To switch to a context press the Leader key followed by the context number (1-4).
2018-11-08 12:59:38 +00:00
.Pp
2019-02-27 20:37:16 +00:00
The first time a context is entered, it copies the state of the last visited context. Each context remembers its last visited directory.
2018-11-08 14:46:08 +00:00
.Pp
When a context is quit, the next active context is selected. If the last active context is quit, the program quits.
2019-03-23 14:14:07 +00:00
.Pp
Each context can have its own directory color specified. See ENVIRONMENT section below.
2014-10-22 11:52:45 +00:00
.Sh FILTERS
2019-03-23 14:14:07 +00:00
Filters support regexes (default) to instantly (search-as-you-type) list the matching
entries in the current directory.
2014-10-22 11:52:45 +00:00
.Pp
Common use cases:
.Pp
(1) To list all matches starting with the filter expression, start the expression
with a '^' (caret) symbol.
.br
(2) Type '\\.mkv' to list all MKV files.
2018-05-01 04:39:10 +00:00
.br
(3) Use '.*' to match any character (\fIsort of\fR fuzzy search).
.Pp
2019-03-03 18:54:35 +00:00
There is a program option to filter entries by substring match instead of regex.
2019-01-13 17:19:14 +00:00
.Pp
In the \fInavigate-as-you-type\fR mode directories are opened in filter mode,
2017-06-04 17:45:08 +00:00
allowing continuous navigation. Works best with the \fBarrow keys\fR.
.br
2019-03-12 14:05:24 +00:00
When there's a unique match and it's a directory, `nnn` auto selects the directory and enters it in this mode.
2019-02-27 15:33:14 +00:00
.br
2019-03-20 03:44:39 +00:00
The \fIwild load\fR option can be extremely handy for users who use the \fInavigate-as-you-type\fR mode constantly. The entries are unsorted when the directory loads. Applying filters sorts the entries (with directories on top). Directory color is disabled in this mode.
2018-11-11 00:21:05 +00:00
.Sh SELECTION MODE
The absolute path of a single file can be copied to clipboard by pressing \fI^K\fR if
NNN_COPIER is set (see ENVIRONMENT section below).
.Pp
To select multiple files the selection mode should be enabled using \fI^Y\fR.
In this mode it's possible to
.Pp
(1) cherry-pick individual files one by one by pressing <kbd>^K</kbd> on each entry (works across directories and contexts); or,
.br
(2) navigate to another file in the same directory to select a range of files.
.Pp
2019-03-01 01:16:13 +00:00
Press \fI^Y\fR again to save the selection and exit selection mode.
.Pp
Selected files are visually indicated by a \fB+\fR.
.br
2019-03-23 14:14:07 +00:00
The files in the list can now be listed, copied, moved, removed, archived or linked.
2015-11-26 15:03:26 +00:00
.Sh ENVIRONMENT
2018-04-08 00:43:33 +00:00
The SHELL, EDITOR (VISUAL, if defined) and PAGER environment variables take precedence
2019-01-04 18:26:02 +00:00
when dealing with the !, e and p commands respectively. A single combination to arguments is supported for SHELL and PAGER.
2016-08-21 08:28:53 +00:00
.Pp
2018-11-11 21:34:17 +00:00
\fBNNN_BMS:\fR bookmark string as \fIkey_char:location\fR pairs (max 10) separated by
2017-06-11 04:15:50 +00:00
\fI;\fR:
.Bd -literal
2018-11-11 21:34:17 +00:00
export NNN_BMS='d:~/Documents;u:/home/user/Cam Uploads;D:~/Downloads/'
NOTE: Bookmark keys should be single-character to use them in combination with the Leader key.
2017-06-11 04:15:50 +00:00
.Ed
.Pp
2019-01-20 18:21:45 +00:00
\fBNNN_OPENER:\fR specify a custom file opener.
2017-06-11 13:54:02 +00:00
.Bd -literal
2019-01-20 18:21:45 +00:00
export NNN_OPENER=mimeopen
2017-06-11 13:54:02 +00:00
.Ed
.Pp
2019-03-22 13:59:36 +00:00
\fBNNN_OPENER_DETACH:\fR do not block when invoking file opener.
.Bd -literal
export NNN_OPENER_DETACH=1
.Ed
.Pp
2018-12-03 16:14:33 +00:00
\fBNNN_CONTEXT_COLORS:\fR string of color codes for each context, e.g.:
.Bd -literal
2019-01-19 09:08:47 +00:00
export NNN_CONTEXT_COLORS='1234'
2018-12-03 16:14:33 +00:00
codes: 0-black, 1-red, 2-green, 3-yellow, 4-blue (default), 5-magenta, 6-cyan, 7-white
.Ed
.Pp
2018-12-09 02:48:30 +00:00
\fBNNN_IDLE_TIMEOUT:\fR set idle timeout (in seconds) to invoke terminal locker (default: disabled).
.Pp
2019-01-19 12:47:36 +00:00
\fBNNN_COPIER:\fR system clipboard copier script.
.Bd -literal
2019-01-19 12:47:36 +00:00
NOTE: File paths are copied to the tmp file \fBDIR/.nnncp\fR, where 'DIR' (by priority) is:
2018-12-01 16:12:51 +00:00
\fI$HOME\fR or, \fI$TMPDIR\fR or, \fI/tmp\fR.
The path is shown in the help and configuration screen.
.Ed
.Pp
2019-04-18 14:57:35 +00:00
\fBNNN_PLUGIN_DIR:\fR \fIabsolute\fR path to plugin directory. Selected plugin is invoked with currently selected file name as argument 1.
2018-03-19 00:02:16 +00:00
.Bd -literal
2019-04-18 14:57:35 +00:00
export NNN_PLUGIN_DIR=/absolute/path/to/plugins_dir
2018-06-17 16:17:19 +00:00
.Ed
.Pp
2019-01-19 09:08:47 +00:00
\fBNNN_NOTE:\fR \fIabsolute\fR path to a note file.
.Bd -literal
export NNN_NOTE='/home/user/.mynotes'
.Ed
.Pp
2019-01-20 18:21:45 +00:00
\fBNNN_TMPFILE:\fR when cd on quit is pressed, the absolute path of the current open directory is written to this file. A wrapper script can read this file and cd into it once the program quits.
.Bd -literal
export NNN_TMPFILE=/tmp/nnn
.Ed
.Pp
\fBNNN_USE_EDITOR:\fR use EDITOR (VISUAL takes preference, preferably CLI, fallback vi) to handle text
files.
.Bd -literal
export NNN_USE_EDITOR=1
.Ed
.Pp
2018-12-09 02:48:30 +00:00
\fBNNN_NO_AUTOSELECT:\fR disable directory auto-selection in \fInavigate-as-you-type\fR mode.
2018-10-21 18:00:46 +00:00
.Bd -literal
export NNN_NO_AUTOSELECT=1
2018-10-21 18:00:46 +00:00
.Ed
.Pp
2019-01-15 05:21:06 +00:00
\fBNNN_RESTRICT_NAV_OPEN:\fR disable file open on \fBRight\fR or \fBl\fR keys (\fBEnter\fR opens files).
.Bd -literal
2019-01-15 05:21:06 +00:00
export NNN_RESTRICT_NAV_OPEN=1
.Ed
.Pp
\fBNNN_RESTRICT_0B:\fR restrict opening 0-byte files due to unexpected behaviour; use \fIedit\fR or \fIopen with\fR to open the file.
.Bd -literal
export NNN_RESTRICT_0B=1
.Ed
.Pp
2019-03-09 03:13:56 +00:00
\fBNNN_TRASH:\fR trash (instead of \fIdelete\fR) files to desktop Trash.
2019-03-02 11:23:16 +00:00
.Bd -literal
export NNN_TRASH=1
.Ed
.Pp
2019-03-09 08:16:18 +00:00
\fBNNN_OPS_PROG:\fR show progress of copy, move operations (Linux-only, needs advcpmv).
.Bd -literal
2019-03-09 08:16:18 +00:00
export NNN_OPS_PROG=1
.Ed
2014-10-22 13:59:15 +00:00
.Sh KNOWN ISSUES
2018-10-19 09:54:15 +00:00
If you are using urxvt you might have to set backspace key to DEC.
2014-10-22 11:52:45 +00:00
.Sh AUTHORS
.An Lazaros Koromilas Aq Mt lostd@2f30.org ,
2017-03-31 02:52:51 +00:00
.An Dimitris Papastamos Aq Mt sin@2f30.org ,
.An Arun Prakash Jana Aq Mt engineerarun@gmail.com .
.Sh HOME
2017-04-01 05:18:18 +00:00
.Em https://github.com/jarun/nnn