nnn/nnn.1

346 lines
9.4 KiB
Groff
Raw Normal View History

2019-01-01 02:31:48 +00:00
.Dd Jan 01, 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
2018-12-03 16:14:33 +00:00
.Op Ar -C
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
2018-11-23 17:11:47 +00:00
.Op Ar -p file
2017-04-14 18:44:25 +00:00
.Op Ar -S
.Op Ar -v
.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
2018-11-11 10:52:58 +00:00
NAVIGATION
.Pp
2014-11-14 14:41:46 +00:00
.Bl -tag -width "l, [Right], [Return] or C-mXXXX" -offset indent -compact
2017-04-03 17:03:46 +00:00
.It Ic [Up], k, ^P
2017-03-31 18:05:48 +00:00
Move to previous entry
2017-04-03 17:03:46 +00:00
.It Ic [Down], j, ^N
2017-03-31 18:05:48 +00:00
Move to next entry
2019-01-19 08:38:21 +00:00
.It Ic [Left], h, ^H
2019-01-19 07:01:25 +00:00
Go to parent directory
.It Ic [Right], [Enter], l, ^M
Open file or enter directory
2017-04-03 17:03:46 +00:00
.It Ic [PgUp], ^U
2017-03-31 18:05:48 +00:00
Scroll up half a page
2017-04-03 17:03:46 +00:00
.It Ic [PgDn], ^D
2017-03-31 18:05:48 +00:00
Scroll down half a page
2019-01-19 07:01:25 +00:00
.It Ic [Home], g, ^A
2017-03-31 18:05:48 +00:00
Move to the first entry
2019-01-19 07:01:25 +00:00
.It Ic [End], G, ^E
2017-03-31 18:05:48 +00:00
Move to the last entry
2017-03-31 02:52:51 +00:00
.It Ic ~
2017-03-31 18:05:48 +00:00
Change to the HOME directory
.It Ic &
Change to initial directory
2018-04-25 19:11:40 +00:00
.It Ic \-
Change to the last visited directory
.It Ic \&.
2018-04-01 18:09:51 +00:00
Toggle show hidden . (dot) files
2018-11-11 10:52:58 +00:00
.It Ic /
Change filter (more information below)
2018-12-05 00:14:33 +00:00
.It Ic [Insert], ^T
2018-11-11 10:52:58 +00:00
Toggle navigate-as-you-type mode
2018-01-17 14:02:22 +00:00
.It Ic b
2017-12-25 10:25:53 +00:00
Pin current directory
.It Ic ^W
2017-12-25 10:25:53 +00:00
Visit pinned directory
2018-11-27 13:07:31 +00:00
.It Ic d
Toggle detail view
2018-12-05 00:14:33 +00:00
.It Ic Tab, ^I
2018-12-03 03:48:51 +00:00
Next context, ask to create if none
2018-11-11 22:06:37 +00:00
.It Ic `, ^/
2018-11-11 21:34:17 +00:00
Leader key
2019-01-19 07:39:46 +00:00
.It Ic N, LeaderN
2018-11-11 21:34:17 +00:00
Switch to context N
2018-11-11 10:52:58 +00:00
.It Ic Esc
Exit prompt
2018-11-11 21:34:17 +00:00
.It Ic ^L
Force a redraw, clear prompt
2018-11-11 10:52:58 +00:00
.It Ic q
Quit the current context
.It Ic ^G
Quit and change directory
.It Ic Q, ^Q
Quit
.It Ic \&?
2018-11-23 05:14:39 +00:00
Help and configuration screen
2018-11-11 10:52:58 +00:00
.El
.Pp
FILES
.Pp
.Bl -tag -width "l, [Right], [Return] or C-mXXXX" -offset indent -compact
.It Ic ^O
2018-12-06 17:27:59 +00:00
Open with an application (takes 1 combined argument)
2017-09-10 07:35:25 +00:00
.It Ic n
2019-01-20 11:29:55 +00:00
Create a new file, directory or link(s) to selection
2018-11-11 10:52:58 +00:00
.It Ic D
Show entry details
2017-08-22 19:16:58 +00:00
.It Ic ^R
Rename selected entry
2018-03-19 00:02:16 +00:00
.It Ic r
Open directory in vidir
2018-11-23 02:14:32 +00:00
.It Ic Y, ^Y
2018-11-11 00:21:05 +00:00
Toggle selection mode
2018-11-11 10:52:58 +00:00
.It Ic Space, ^K
Copy entry absolute path
.It Ic y
2018-11-11 10:52:58 +00:00
Show selection list
2018-11-11 00:21:05 +00:00
.It Ic P
Copy files from selection
.It Ic V
Move files from selection
.It Ic X
2018-11-17 03:01:47 +00:00
Delete files from selection
.It Ic ^X
2018-11-11 10:52:58 +00:00
Delete entry
.It Ic f
Archive entry
.It Ic F
List files in archive
.It Ic ^F
Extract archive in current directory
.It Ic m, M
Show brief/full media info
.It Ic e
Open entry in EDITOR (fallback vi)
.It Ic p
Open entry in PAGER (fallback less)
.El
.Pp
2018-12-09 02:14:03 +00:00
ORDER TOGGLES
2018-11-11 10:52:58 +00:00
.Pp
.Bl -tag -width "l, [Right], [Return] or C-mXXXX" -offset indent -compact
.It Ic ^J
Toggle disk usage analyzer mode
.It Ic S
Toggle sort by apparent size
.It Ic t
Toggle sort by time modified
2018-12-09 02:14:03 +00:00
.It Ic s
Toggle sort by file size
2018-11-11 10:52:58 +00:00
.El
.Pp
MISC
.Pp
.Bl -tag -width "l, [Right], [Return] or C-mXXXX" -offset indent -compact
.It Ic \&!, ^]
Spawn SHELL in current directory (fallback sh)
2018-12-09 13:48:00 +00:00
.It Ic C
2018-12-08 12:52:06 +00:00
Execute entry
2019-01-05 20:38:07 +00:00
.It Ic R, ^V
2018-12-16 14:59:03 +00:00
Run or choose a custom script
2018-11-11 10:52:58 +00:00
.It Ic L
2018-12-09 13:48:00 +00:00
Lock terminal
2019-01-19 09:08:47 +00:00
.It Ic N
Take note
2018-12-16 14:59:03 +00:00
.It Ic ^S
Run a command
2014-10-22 11:57:22 +00:00
.El
.Pp
Backing up one directory level will set the cursor position at the
directory you came out of.
2017-04-01 05:18:18 +00:00
.Pp
Help & settings, file details, media info and archive listing are shown in the
PAGER. Please use the PAGER-specific keys in these screens.
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
2018-12-03 16:14:33 +00:00
.Fl C
disable directory color
2017-07-02 20:56:47 +00:00
.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
2018-11-23 17:11:47 +00:00
.Fl "p file"
copy (or \fIpick\fR) selection to file, or stdout if file='-'
.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
.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
2017-06-11 13:54:02 +00:00
There is no configuration file. Settings work on environment variables. Please
refer to the ENVIRONMENT section below.
.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
few easy steps. Please visit the project page (linked below) for the
instructions.
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
- other used contexts are underlined
.br
- rest are unused
.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
The first time a context is entered, it copies the state of the last visited context. Each context remembers its start directory and 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.
2014-10-22 11:52:45 +00:00
.Sh FILTERS
2019-01-13 17:19:14 +00:00
Filters support regexes by 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-01-13 17:19:14 +00:00
To filter entries by substring match export the environment variable \fBNNN_PLAIN_FILTER\fR.
.Pp
If
.Nm
is invoked as root or the environment variable \fBNNN_SHOW_HIDDEN\fR is set the default filter will also match hidden files.
.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
In case of only one match and it's a directory, `nnn` auto selects the directory and enters it 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
2018-11-11 00:21:05 +00:00
To copy multiple file paths 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
2018-11-11 00:21:05 +00:00
Pressing \fI^Y\fR again copies the paths and exits the selection mode. The files in the list can now
be copied, moved or removed using respective keyboard shortcuts.
2018-11-10 14:12:09 +00:00
.Pp
To list the file paths copied to memory press \fIy\fR.
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
2019-01-16 14:41:33 +00:00
\fBNNN_OPENER:\fR specify a custom file opener.
.Bd -literal
export NNN_OPENER=mimeopen
.Ed
.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-19 12:47:36 +00:00
\fBNNN_USE_EDITOR:\fR use EDITOR (VISUAL takes preference, preferably CLI, fallback vi) to handle text
2017-06-11 13:54:02 +00:00
files.
.Bd -literal
2017-09-19 14:25:02 +00:00
export NNN_USE_EDITOR=1
2017-06-11 13:54:02 +00:00
.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-01-19 09:08:47 +00:00
\fBNNN_SCRIPT:\fR \fIabsolute\fR path to a directory to select a script from or a single script to invoke with currently selected file name as argument 1.
2018-03-19 00:02:16 +00:00
.Bd -literal
2018-12-15 18:54:45 +00:00
export NNN_SCRIPT=/home/user/scripts
OR
export NNN_SCRIPT=/usr/local/bin/nscript.sh
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
\fBNNN_SHOW_HIDDEN:\fR show hidden files.
.Bd -literal
export NNN_SHOW_HIDDEN=1
.Ed
2018-10-21 18:00:46 +00:00
.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
2019-01-13 17:19:14 +00:00
.Pp
\fBNNN_PLAIN_FILTER:\fR use substring match in filter mode.
.Bd -literal
export NNN_PLAIN_FILTER=1
.Ed
2019-01-19 12:02:43 +00:00
.Pp
\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
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