mirror of
https://github.com/jarun/nnn.git
synced 2024-11-18 08:59:14 +00:00
397 lines
12 KiB
Groff
397 lines
12 KiB
Groff
.Dd Feb 12, 2020
|
|
.Dt NNN 1
|
|
.Os
|
|
.Sh NAME
|
|
.Nm nnn
|
|
.Nd the missing terminal file manager for X
|
|
.Sh SYNOPSIS
|
|
.Nm
|
|
.Op Ar -a
|
|
.Op Ar -A
|
|
.Op Ar -b key
|
|
.Op Ar -c
|
|
.Op Ar -d
|
|
.Op Ar -e
|
|
.Op Ar -E
|
|
.Op Ar -g
|
|
.Op Ar -H
|
|
.Op Ar -K
|
|
.Op Ar -n
|
|
.Op Ar -p file
|
|
.Op Ar -Q
|
|
.Op Ar -r
|
|
.Op Ar -R
|
|
.Op Ar -s name
|
|
.Op Ar -S
|
|
.Op Ar -t secs
|
|
.Op Ar -v
|
|
.Op Ar -V
|
|
.Op Ar -x
|
|
.Op Ar -h
|
|
.Op Ar PATH
|
|
.Sh DESCRIPTION
|
|
.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.
|
|
.Pp
|
|
.Nm
|
|
opens the current working directory by default if
|
|
.Ar PATH
|
|
is not specified.
|
|
.Sh KEYBINDS
|
|
.Pp
|
|
Press \fB?\fR in
|
|
.Nm
|
|
to see the list of keybinds.
|
|
.Sh OPTIONS
|
|
.Pp
|
|
.Nm
|
|
supports the following options:
|
|
.Pp
|
|
.Fl a
|
|
use access time for all operations (default: modification time)
|
|
.Pp
|
|
.Fl A
|
|
disable directory auto-select in navigate-as-you-type mode
|
|
.Pp
|
|
.Fl "b key"
|
|
specify bookmark key to open
|
|
.Pp
|
|
.Fl c
|
|
opener opens files in cli utilities only (overrides -e)
|
|
.Pp
|
|
.Fl d
|
|
detail mode
|
|
.Pp
|
|
.Fl e
|
|
open text files in $VISUAL (else $EDITOR, fallback vi) [preferably CLI]
|
|
.Pp
|
|
.Fl E
|
|
use $EDITOR for internal undetached edits
|
|
.Pp
|
|
.Fl g
|
|
use regex filters instead of substring match
|
|
.Pp
|
|
.Fl H
|
|
show hidden files
|
|
.Pp
|
|
.Fl K
|
|
test for keybind collision
|
|
.Pp
|
|
.Fl n
|
|
start in navigate-as-you-type mode
|
|
.Pp
|
|
.Fl o
|
|
open files only on Enter key
|
|
.Pp
|
|
.Fl "p file"
|
|
copy (or \fIpick\fR) selection to file, or stdout if file='-'
|
|
.Pp
|
|
.Fl Q
|
|
disable confirmation on quit with multiple contexts active
|
|
.Pp
|
|
.Fl r
|
|
show cp, mv progress
|
|
(Linux-only, needs advcpmv; '^T' shows the progress on BSD/macOS)
|
|
.Pp
|
|
.Fl R
|
|
disable rollover at edges
|
|
.Pp
|
|
.Fl "s name"
|
|
load a session by name
|
|
.Pp
|
|
.Fl S
|
|
start in disk usage analyzer mode
|
|
.Pp
|
|
.Fl "t secs"
|
|
idle timeout in seconds to lock terminal
|
|
.Pp
|
|
.Fl v
|
|
use case-insensitive version compare to sort files
|
|
.Pp
|
|
.Fl V
|
|
show version and exit
|
|
.Pp
|
|
.Fl x
|
|
show notis on selection cp, mv, rm completion
|
|
copy path to system clipboard on select
|
|
.Pp
|
|
.Fl h
|
|
show program help and exit
|
|
.Sh CONFIGURATION
|
|
There is no configuration file. Associated files are at
|
|
.Pp
|
|
\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
|
|
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:
|
|
.Pp
|
|
- the current context is in reverse video
|
|
.br
|
|
- other active contexts are underlined
|
|
.br
|
|
- rest are inactive
|
|
.Pp
|
|
On context creation, the state of the previous context is copied. Each context
|
|
remembers its last visited directory.
|
|
.Pp
|
|
Each context can have its own directory color specified. See ENVIRONMENT
|
|
section.
|
|
.Sh SESSIONS
|
|
Sessions are a way to save and restore states of work. A session stores the
|
|
settings and contexts.
|
|
.Pp
|
|
Sessions can be loaded dynamically from within a running
|
|
.Nm
|
|
instance, or with a program option.
|
|
.Pp
|
|
When a session is loaded dynamically, the last working session is saved
|
|
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
|
|
"@" is the "last session" file.
|
|
.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. In each context the
|
|
last filter is persisted at runtime or in saved sessions.
|
|
.Pp
|
|
Special keys at filter prompt:
|
|
.Bd -literal
|
|
------ + ---------------------------------------
|
|
Key | Function
|
|
------ + ---------------------------------------
|
|
^char | Usual keybind functionality
|
|
Esc | Exit filter prompt but skip dir refresh
|
|
------ + ---------------------------------------
|
|
.Ed
|
|
.Pp
|
|
Special keys at \fBempty filter prompt\fR:
|
|
.Bd -literal
|
|
------ + ---------------------------------------
|
|
Key | Function
|
|
------ + ---------------------------------------
|
|
? | Show help and config screen
|
|
/ | Toggle between string and regex
|
|
: | Toggle case-sensitivity
|
|
^L | Clear filter (\fIif prompt is non-empty\fR)
|
|
| OR apply last filter
|
|
------ + ---------------------------------------
|
|
.Ed
|
|
.Pp
|
|
Additional special keys at \fBempty filter prompt\fR
|
|
in \fBnav-as-you-type\fR mode:
|
|
.Bd -literal
|
|
------ + ------------------------
|
|
Key | Function
|
|
------ + ------------------------
|
|
' | Go to first non-dir file
|
|
+ | Toggle proceed on open
|
|
, | Pin CWD
|
|
- | Go to last visited dir
|
|
. | Show hidden files
|
|
; | Run a plugin by its key
|
|
= | Launch a GUI application
|
|
@ | Visit start dir
|
|
] | Show command prompt
|
|
` | Visit /
|
|
~ | Go HOME
|
|
------ + ------------------------
|
|
.Ed
|
|
.Pp
|
|
Common regex 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.
|
|
.br
|
|
(3) Use '.*' to match any character (\fIsort of\fR fuzzy search).
|
|
.Pp
|
|
In the \fInavigate-as-you-type\fR mode directories are opened in filter
|
|
mode, allowing continuous navigation. Works best with the \fBarrow keys\fR.
|
|
.br
|
|
When there's a unique match and it's a directory,
|
|
.Nm
|
|
auto selects the directory and enters it in this mode. Use the relevant
|
|
program option to disable this behaviour.
|
|
.Sh SELECTION
|
|
.Nm
|
|
allows file selection across directories and contexts!
|
|
.Pp
|
|
There are 3 groups of keybinds to add files to selection:
|
|
.Pp
|
|
(1) hovered file selection toggle (deselects if '+' is visible before the
|
|
entry, else adds to selection)
|
|
.br
|
|
(2) add a range of files to selection (repeat the range key on the same entry
|
|
twice to clear selection completely)
|
|
.br
|
|
(3) add all files in the current directory to selection
|
|
.Pp
|
|
A selection can be edited, copied, moved, removed, archived or linked.
|
|
.Pp
|
|
Absolute paths of the selected files are copied to \fB.selection\fR file in
|
|
the config directory.
|
|
.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.
|
|
.Sh LIST FILES
|
|
.Nm
|
|
can receive a list of files as input. The paths should be NUL-separated ('\\0')
|
|
but doesn't need to be NUL-terminated. Paths and can be relative to the current
|
|
directory or absolute.
|
|
.Pp
|
|
Input is limited by 65,536 paths or 256 MiB of input.
|
|
.Pp
|
|
Start
|
|
.Nm
|
|
in this mode by writing to its standard input. So the output of another command
|
|
can be piped to it. For example, to list files in current directory larger than
|
|
1M:
|
|
.Bd -literal
|
|
find -maxdepth 1 -size +1M -print0 | nnn
|
|
.Ed
|
|
.Pp
|
|
or you can redirect a list from a file:
|
|
.Bd -literal
|
|
nnn < files.txt
|
|
.Ed
|
|
.Pp
|
|
A temporary directory will be created containing symlinks to the given
|
|
paths. Any action performed on these symlinks will be performed only on their
|
|
targets, after which they might become invalid.
|
|
.Pp
|
|
Though the term "files" is used, any input is valid as long as it's a valid
|
|
path. \fBInvalid paths are ignored.\fR
|
|
.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
|
|
The SHELL, EDITOR (VISUAL, if defined) and PAGER environment variables are
|
|
used. A single combination of arguments is supported for SHELL and PAGER.
|
|
.Pp
|
|
\fBNNN_OPENER:\fR specify a custom file opener.
|
|
.Bd -literal
|
|
export NNN_OPENER=nuke
|
|
|
|
NOTE: `nuke` is a file opener available in plugin repository
|
|
.Ed
|
|
.Pp
|
|
\fBNNN_BMS:\fR bookmark string as \fIkey_char:location\fR pairs
|
|
separated by \fI;\fR:
|
|
.Bd -literal
|
|
export NNN_BMS='d:~/Documents;u:/home/user/Cam Uploads;D:~/Downloads/'
|
|
.Ed
|
|
.Pp
|
|
\fBNNN_PLUG:\fR directly executable plugins as \fIkey_char:location\fR pairs
|
|
separated by \fI;\fR:
|
|
.Bd -literal
|
|
export NNN_PLUG='o:fzopen;p:mocplay;d:diffs;m:nmount;t:imgthumb'
|
|
|
|
NOTES:
|
|
1. To run a plugin directly, press \fI;\fR followed by the plugin key
|
|
2. To skip directory refresh after running a plugin, prefix with \fB-\fR
|
|
|
|
export NNN_PLUG='m:-mediainfo'
|
|
.Ed
|
|
.Pp
|
|
To assign keys to arbitrary non-background non-shell-interpreted cli
|
|
commands and invoke like plugins, add \fI_\fR (underscore) before the
|
|
command.
|
|
.Bd -literal
|
|
export NNN_PLUG='x:_chmod +x $nnn;g:_git log;s:_smplayer $nnn;o:fzopen'
|
|
|
|
NOTES:
|
|
1. Use single quotes for $NNN_PLUG so $nnn is not interpreted
|
|
2. $nnn should be the last argument (IF used)
|
|
3. (Again) add \fB_\fR before the command
|
|
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
|
|
|
|
export NNN_PLUG='y:-_sync*'
|
|
|
|
6. To run a \fIGUI app as plugin\fR, add a \fB|\fR after \fB_\fR
|
|
|
|
export NNN_PLUG='m:-_|mousepad $nnn'
|
|
|
|
EXAMPLES:
|
|
----------------------------------- + -------------------------------------------------
|
|
Key:Command | Description
|
|
----------------------------------- + -------------------------------------------------
|
|
k:-_fuser -kiv $nnn* | Interactively kill process(es) using hovered file
|
|
l:_git log | Show git log
|
|
n:-_vi /home/user/Dropbox/dir/note* | Take quick notes in a synced file/dir of notes
|
|
p:-_less -iR $nnn* | Page through hovered file in less
|
|
s:-_|smplayer -minigui $nnn | Play hovered media file, even unfinished download
|
|
x:_chmod +x $nnn | Make the hovered file executable
|
|
y:-_sync* | Flush cached writes
|
|
----------------------------------- + -------------------------------------------------
|
|
.Ed
|
|
.Pp
|
|
\fBNNN_COLORS:\fR string of color codes for each context, e.g.:
|
|
.Bd -literal
|
|
export NNN_COLORS='1234'
|
|
|
|
codes: 0-black, 1-red, 2-green, 3-yellow, 4-blue (default), 5-magenta, 6-cyan, 7-white
|
|
.Ed
|
|
.Pp
|
|
\fBNNN_SSHFS:\fR pass additional options to sshfs command:
|
|
.Bd -literal
|
|
export NNN_SSHFS='sshfs -o reconnect,idmap=user,cache_timeout=3600'
|
|
|
|
NOTE: The options must be preceded by `sshfs` and comma-separated without any space between them.
|
|
.Ed
|
|
.Pp
|
|
\fBNNN_RCLONE:\fR pass additional options to rclone command:
|
|
.Bd -literal
|
|
export NNN_RCLONE='rclone mount --read-only --no-checksum'
|
|
|
|
NOTE: The options must be preceded by `rclone` and max 5 flags are supported.
|
|
.Ed
|
|
.Pp
|
|
\fBNNN_TRASH:\fR trash (instead of \fIdelete\fR) files to desktop Trash.
|
|
.Bd -literal
|
|
export NNN_TRASH=1
|
|
.Ed
|
|
.Pp
|
|
\fBNNN_MCLICK:\fR key emulated by a middle mouse click.
|
|
.Bd -literal
|
|
export NNN_MCLICK='^R'
|
|
|
|
NOTE: Only the first character is considered if not a \fICtrl+key\fR combo.
|
|
.Ed
|
|
.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.
|
|
.Sh KNOWN ISSUES
|
|
.Nm
|
|
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
|
|
.An Arun Prakash Jana Aq Mt engineerarun@gmail.com ,
|
|
.An Lazaros Koromilas Aq Mt lostd@2f30.org ,
|
|
.An Dimitris Papastamos Aq Mt sin@2f30.org .
|
|
.Sh HOME
|
|
.Em https://github.com/jarun/nnn
|