nnn/nnn.1

293 lines
7.6 KiB
Groff
Raw Normal View History

2018-10-19 09:54:15 +00:00
.Dd Oct 19, 2018
.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
2017-07-03 04:16:37 +00:00
.Op Ar -c N
.Op Ar -e
.Op Ar -i
2017-07-03 04:16:37 +00:00
.Op Ar -l
.Op Ar -p nlay
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-08-06 23:22:39 +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, bookmarks, disk usage analyzer mode, comprehensive file details 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.
.Pp
.Nm
2018-05-03 12:29:39 +00:00
supports both vi-like and emacs-like key bindings as listed below.
2014-10-22 11:52:45 +00:00
.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
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
.It Ic [Home], g, ^, ^A
2017-03-31 18:05:48 +00:00
Move to the first entry
.It Ic [End], G, $, ^E
2017-03-31 18:05:48 +00:00
Move to the last entry
2017-04-03 17:03:46 +00:00
.It Ic [Right], [Enter], l, ^M
2017-03-31 18:05:48 +00:00
Open file or enter directory
2017-04-03 17:03:46 +00:00
.It Ic [Left], [Backspace], h, ^H
2017-03-31 18:05:48 +00:00
Back up one directory level
2017-12-25 10:25:53 +00:00
.It Ic ^O
Open with a custom application
.It Ic [Insert], ^I
Toggle navigate-as-you-type mode
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 /
2017-03-31 18:05:48 +00:00
Change filter (more information below)
.It Ic ^/
2017-06-05 04:54:28 +00:00
Search directory in desktop search tool
.It Ic \&.
2018-04-01 18:09:51 +00:00
Toggle show hidden . (dot) files
.It Ic ^B
Show bookmark key prompt
2018-01-17 14:02:22 +00:00
.It Ic b
2017-12-25 10:25:53 +00:00
Pin current directory
.It Ic ^V
2017-12-25 10:25:53 +00:00
Visit pinned directory
2014-10-22 11:52:45 +00:00
.It Ic c
2017-12-25 10:25:53 +00:00
Show change directory prompt
2017-03-31 02:52:51 +00:00
.It Ic d
2017-03-31 18:05:48 +00:00
Toggle detail view
.It Ic D
2017-07-03 04:16:37 +00:00
Show current file details screen
2017-04-21 18:26:48 +00:00
.It Ic m
2017-09-10 07:35:25 +00:00
Show brief media info
2017-04-21 18:26:48 +00:00
.It Ic M
2017-07-02 18:27:41 +00:00
Show full media info
2017-09-10 07:35:25 +00:00
.It Ic n
Create a new file or directory
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
2017-03-31 02:52:51 +00:00
.It Ic s
2017-03-31 18:05:48 +00:00
Toggle sort by file size
2018-10-04 18:56:31 +00:00
.It Ic S
Toggle sort by apparent size
.It Ic ^J
Toggle disk usage analyzer mode
.It Ic t
2017-03-31 18:05:48 +00:00
Toggle sort by time modified
.It Ic \&!, ^]
2017-03-31 18:05:48 +00:00
Spawn SHELL in PWD (fallback sh)
2018-03-19 00:02:16 +00:00
.It Ic R
Run a custom script
.It Ic e
2017-03-31 18:05:48 +00:00
Open current entry in EDITOR (fallback vi)
.It Ic o
Open directory in NNN_DE_FILE_MANAGER
2015-11-26 15:03:26 +00:00
.It Ic p
2017-03-31 18:05:48 +00:00
Open current entry in PAGER (fallback less)
2018-04-24 23:34:37 +00:00
.It Ic f
Archive current entry
2017-09-30 22:58:48 +00:00
.It Ic F
2017-09-27 14:49:42 +00:00
List files in archive
.It Ic ^F
2017-09-27 14:49:42 +00:00
Extract archive in current directory
.It Ic Space, ^K
2017-06-06 14:54:04 +00:00
Invoke file path copier
.It Ic ^Y
Toggle multiple file path copy mode
2018-01-28 06:03:12 +00:00
.It Ic ^T
Toggle path quote
.It Ic ^L
2017-08-25 16:39:03 +00:00
Force a redraw, clear rename or filter prompt
2018-03-30 15:53:28 +00:00
.It Ic L
Lock terminal (Linux only)
2017-04-03 17:03:46 +00:00
.It Ic \&?
2017-06-11 13:54:02 +00:00
Toggle help and settings screen
2018-02-24 16:13:41 +00:00
.It Ic Q, ^G
2017-04-19 12:52:30 +00:00
Quit and change directory
.It Ic q, ^X
Quit
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.
.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
2017-07-02 20:56:47 +00:00
.Fl "c N"
specify dir color (default blue), disables if N>7
0-black, 1-red, 2-green, 3-yellow, 4-blue, 5-magenta, 6-cyan, 7-white
.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
2017-07-03 04:16:37 +00:00
.Fl "p nlay"
path to custom nlay
.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
uses \fIxdg-open\fR (on Linux) and \fIopen(1)\fR (on OS X) as the desktop
opener. It invokes
.Pa nlay
to run desktop search utility or screensaver. Read more on
.Pa nlay
at:
.br
.Em https://github.com/jarun/nnn/wiki/all-about-nlay
.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.
2014-10-22 11:52:45 +00:00
.Sh FILTERS
Filters support regexes to instantly (search-as-you-type) list the matching
entries in the current directory.
2014-10-22 11:52:45 +00:00
.Pp
There are 3 ways to reset a filter:
2017-12-26 04:34:10 +00:00
.Pp
(1) pressing \fI^L\fR (at the new/rename prompt \fI^L\fR followed by \fIEnter\fR
discards all changes and exits prompt),
.br
(2) a search with no matches or
.br
(3) an extra backspace at the filter prompt (like vi).
.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
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.
.Sh MULTI-COPY 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 copy multiple file paths the multi-copy mode should be enabled using \fI^Y\fR.
In this mode it's possible to
.Pp
(1) select multiple files one by one by pressing \fI^K\fR on each entry; or,
.br
(2) navigate to another file in the same directory to select a range of files.
.Pp
Pressing \fI^Y\fR again copies the paths to clipboard and exits the multi-copy mode.
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
2015-11-26 15:03:26 +00:00
when dealing with the !, e and p commands respectively.
2016-08-21 08:28:53 +00:00
.Pp
2017-06-11 04:15:50 +00:00
\fBNNN_BMS:\fR bookmark string as \fIkey:location\fR pairs (max 10) separated by
\fI;\fR:
.Bd -literal
2017-09-19 14:25:02 +00:00
export NNN_BMS='doc:~/Documents;u:/home/user/Cam Uploads;D:~/Downloads/'
2017-06-11 04:15:50 +00:00
.Ed
The bookmark prompt also understands the \fI~\fR (HOME), \fI-\fR (last visited directory) and \fI&\fR shortcuts.
2017-06-11 04:15:50 +00:00
.Pp
2017-06-11 13:54:02 +00:00
\fBNNN_USE_EDITOR:\fR use EDITOR (preferably CLI, fallback vi) to handle text
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
\fBNNN_DE_FILE_MANAGER:\fR set to a desktop file manager to open the current
directory with. E.g.:
.Bd -literal
2017-09-19 14:25:02 +00:00
export NNN_DE_FILE_MANAGER=thunar
.Ed
.Pp
\fBNNN_IDLE_TIMEOUT:\fR set idle timeout (in seconds) to invoke terminal
screensaver.
.Pp
\fBNNN_COPIER:\fR set to a clipboard copier script. For example, on Linux:
.Bd -literal
2017-09-19 14:25:02 +00:00
-------------------------------------
#!/bin/sh
# comment the next line to convert newlines to spaces
IFS=
2017-09-19 14:25:02 +00:00
echo -n $1 | xsel --clipboard --input
-------------------------------------
.Ed
.Pp
\fBNNN_NO_X:\fR X display is unavailable. Copy file path(s) to \fI$HOME/.nnncp\fR.
.Bd -literal
export NNN_NO_X=1
.Ed
.Pp
2018-01-28 06:03:12 +00:00
\fBNNN_QUOTE_ON:\fR wrap copied paths within single quotes. Useful for pasting
names in the shell. Note that the filename is not escaped. So copying may still fail
for filenames having quote(s) in them.
2018-03-19 00:02:16 +00:00
.Pp
\fBNNN_SCRIPT:\fR path to a custom script to invoke with currently selected file name as argument 1.
2018-03-19 00:02:16 +00:00
.Bd -literal
2018-06-17 16:17:19 +00:00
export NNN_SCRIPT=/usr/local/bin/nscript
2018-03-19 00:02:16 +00:00
.Ed
2018-06-17 16:17:19 +00:00
.Pp
\fBNNN_MULTISCRIPT:\fR run multiple custom scripts.
.Bd -literal
export NNN_MULTISCRIPT=1
.Ed
.Pp
\fBNNN_SHOW_HIDDEN:\fR show hidden files.
.Bd -literal
export NNN_SHOW_HIDDEN=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