mirror of
https://github.com/jarun/nnn.git
synced 2024-11-18 00:49:15 +00:00
cf388649b9
- replace bools for internal non-persistent binary states with an uchar - do not store path to session, derive from config path in tmp buffer - program option to load session is not `-s` - remove auto-stored session "@" on restore - minor help update
254 lines
8.1 KiB
Groff
254 lines
8.1 KiB
Groff
.Dd Dec 05, 2019
|
|
.Dt NNN 1
|
|
.Os
|
|
.Sh NAME
|
|
.Nm nnn
|
|
.Nd the missing terminal file manager for X
|
|
.Sh SYNOPSIS
|
|
.Nm
|
|
.Op Ar -a
|
|
.Op Ar -b key
|
|
.Op Ar -c
|
|
.Op Ar -d
|
|
.Op Ar -E
|
|
.Op Ar -g
|
|
.Op Ar -H
|
|
.Op Ar -i
|
|
.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 -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 "b key"
|
|
specify bookmark key to open
|
|
.Pp
|
|
.Fl c
|
|
opener opens files in cli utilities only
|
|
.Pp
|
|
.Fl d
|
|
detail mode
|
|
.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 i
|
|
start in navigate-as-you-type mode
|
|
.Pp
|
|
.Fl K
|
|
test for keybind collision
|
|
.Pp
|
|
.Fl n
|
|
use case-insensitive version compare to sort files
|
|
.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 when quitting program with multiple active contexts
|
|
.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
|
|
disable directory auto-select in navigate-as-you-type mode
|
|
.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
|
|
.Nm
|
|
uses \fIxdg-open\fR (on Linux) and \fIopen(1)\fR (on macOS) as the desktop opener.
|
|
.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.
|
|
.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 below.
|
|
.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 in the \fB${XDG_CONFIG_HOME:-$HOME/.config}/nnn/sessions\fR directory by the session name.
|
|
"@" is the "last session" file.
|
|
.Sh FILTERS
|
|
Filters are substrings to find matching entries in the current directory instantly (search-as-you-type). There is a program option to use regex filters.
|
|
.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
|
|
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 listed, 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.
|
|
.Sh FILE SIZE
|
|
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 take precedence
|
|
when dealing with the !, e and p commands respectively. A single combination to arguments is supported for SHELL and PAGER.
|
|
.Pp
|
|
\fBNNN_BMS:\fR bookmark string as \fIkey_char:location\fR pairs (max 10) separated by
|
|
\fI;\fR:
|
|
.Bd -literal
|
|
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.
|
|
.Ed
|
|
.Pp
|
|
\fBNNN_PLUG:\fR directly executable plugins as \fIkey_char:location\fR pairs (max 10) separated by
|
|
\fI;\fR:
|
|
.Bd -literal
|
|
export NNN_PLUG='o:fzopen;p:mocplay;d:diffs;m:nmount;t:imgthumb;i:mediainf'
|
|
|
|
NOTE: To run a plugin directly, press \fI:\fR followed by the plugin key.
|
|
.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;m:nmount'
|
|
|
|
NOTES:
|
|
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)
|
|
3. (Again) add \fI_\fR before the command
|
|
.Ed
|
|
.Pp
|
|
\fBNNN_USE_EDITOR:\fR use VISUAL (else EDITOR, preferably CLI, fallback vi) to handle text files.
|
|
.Bd -literal
|
|
export NNN_USE_EDITOR=1
|
|
.Ed
|
|
.Pp
|
|
\fBNNN_CONTEXT_COLORS:\fR string of color codes for each context, e.g.:
|
|
.Bd -literal
|
|
export NNN_CONTEXT_COLORS='1234'
|
|
|
|
codes: 0-black, 1-red, 2-green, 3-yellow, 4-blue (default), 5-magenta, 6-cyan, 7-white
|
|
.Ed
|
|
.Pp
|
|
\fBNNN_SSHFS_OPTS:\fR pass additional options to sshfs command:
|
|
.Bd -literal
|
|
export NNN_SSHFS_OPTS='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_OPTS:\fR pass additional options to rclone command:
|
|
.Bd -literal
|
|
export NNN_RCLONE_OPTS='rclone mount --read-only --no-checksum'
|
|
|
|
NOTE: The options must be preceded by `rclone` and max 5 flags are supported.
|
|
.Ed
|
|
.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_IDLE_TIMEOUT:\fR set idle timeout (in seconds) to invoke terminal locker (default: disabled).
|
|
.Pp
|
|
\fBNNN_TRASH:\fR trash (instead of \fIdelete\fR) files to desktop Trash.
|
|
.Bd -literal
|
|
export NNN_TRASH=1
|
|
.Ed
|
|
.Pp
|
|
\fBNNN:\fR this is a special variable set to the current 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
|