nnn/nnn.1

.Dd May 12, 2017
.Dt NNN 1
.Os
.Sh NAME
.Nm nnn
.Nd the missing terminal file browser for X
.Sh SYNOPSIS
.Nm
.Op Ar -l
.Op Ar -i
.Op Ar -p custom_nlay
.Op Ar -S
.Op Ar -v
.Op Ar -h
.Op Ar PATH
.Sh DESCRIPTION
.Nm
(Noice is Not Noice) is a performance-optimized fork of the noice terminal file browser with extensive desktop integration, simplified navigation, \fInavigate-as-you-type\fR mode, disk usage analyzer mode, comprehensive file details and much more. It remains a simple and efficient file browser that stays out of your way.
.Pp
.Nm
defaults to the current directory if
.Ar PATH
is not specified.
.Pp
.Nm
supports both vi-like and emacs-like key bindings in the default
configuration. The default key bindings are listed below.
.Pp
.Bl -tag -width "l, [Right], [Return] or C-mXXXX" -offset indent -compact
.It Ic [Up], k, ^P
Move to previous entry
.It Ic [Down], j, ^N
Move to next entry
.It Ic [PgUp], ^U
Scroll up half a page
.It Ic [PgDn], ^D
Scroll down half a page
.It Ic [Home], g, ^, ^A
Move to the first entry
.It Ic [End], G, $, ^E
Move to the last entry
.It Ic [Right], [Enter], l, ^M
Open file or enter directory
.It Ic [Left], [Backspace], h, ^H
Back up one directory level
.It Ic [Insert]
Toggle navigate-as-you-type mode
.It Ic ~
Change to the HOME directory
.It Ic &
Change to initial directory
.It Ic -
Change to the last visited directory
.It Ic /
Change filter (more information below)
.It Ic ^/
Search directory in desktop search tool
.It Ic \&.
Toggle hide .dot files
.It Ic c
Change into the given directory
.It Ic d
Toggle detail view
.It Ic D
Toggle current file details screen
.It Ic m
Show concise mediainfo
.It Ic M
Show full mediainfo
.It Ic s
Toggle sort by file size
.It Ic S
Toggle disk usage analyzer mode
.It Ic t
Toggle sort by time modified
.It Ic \&!
Spawn SHELL in PWD (fallback sh)
.It Ic e
Open current entry in EDITOR (fallback vi)
.It Ic o
Open directory in NNN_DE_FILE_MANAGER
.It Ic p
Open current entry in PAGER (fallback less)
.It Ic ^K
Invoke file path copier
.It Ic ^L
Force a redraw, exit filter prompt
.It Ic \&?
Toggle help screen
.It Ic Q
Quit and change directory
.It Ic q, ^Q
Quit
.El
.Pp
Backing up one directory level will set the cursor position at the
directory you came out of.
.Pp
.Nm
supports the following options:
.Pp
.Fl l
        start in light mode (fewer details)
.Pp
.Fl i
        start in navigate-as-you-type mode
.Pp
.Fl "p custom_nlay"
        path to custom nlay
.Pp
.Fl S
        start in disk usage analyzer mode
.Pp
.Fl v
        show version and exit
.Pp
.Fl h
        show program help and exit
.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
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.
.Sh FILTERS
Filters support regexes to instantly (search-as-you-type) list the matching
entries in the current directory.
.Pp
There are 3 ways to reset a filter: \fI^L\fR, a search with no
matches or an extra backspace at the filter prompt (like vi).
.Pp
Common examples: If you want to list all matches starting with the filter
expression, start the expression with a
.Pa ^
(caret) symbol. Type
.Pa \.mkv
to list all MKV files.
.Pp
If
.Nm
is invoked as root the default filter will also match hidden files.
.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.
.Sh ENVIRONMENT
The SHELL, EDITOR and PAGER environment variables take precedence
when dealing with the !, e and p commands respectively.
.Pp
\fBNNN_USE_EDITOR:\fR use EDITOR (preferably CLI, fallback vi) to handle text
files.
.Bd -literal
        export NNN_USE_EDITOR=1
.Ed
.Pp
\fBNNN_DE_FILE_MANAGER:\fR set to a desktop file manager to open the current
directory with. E.g.:
.Bd -literal
        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
        -------------------------------------
        #!/bin/sh

        echo -n $1 | xsel --clipboard --input
        -------------------------------------
.Ed
.Sh KNOWN ISSUES
If you are using urxvt you might have to set backspacekey to DEC.
.Sh AUTHORS
.An Lazaros Koromilas Aq Mt lostd@2f30.org ,
.An Dimitris Papastamos Aq Mt sin@2f30.org ,
.An Arun Prakash Jana Aq Mt engineerarun@gmail.com .
.Sh HOME
.Em https://github.com/jarun/nnn
Prepare for release v1.1 2017-05-11 16:55:22 +00:00			`.Dd May 12, 2017`
Rename project to nnn (Noice is Not Noice) 2017-03-30 18:25:30 +00:00			`.Dt NNN 1`
Add manpage 2014-10-22 11:52:45 +00:00			`.Os`
			`.Sh NAME`
Rename project to nnn (Noice is Not Noice) 2017-03-30 18:25:30 +00:00			`.Nm nnn`
Add program help 2017-04-14 18:44:25 +00:00			`.Nd the missing terminal file browser for X`
Add manpage 2014-10-22 11:52:45 +00:00			`.Sh SYNOPSIS`
Update documentation 2017-06-04 17:45:08 +00:00			`.Nm`
Set detail view mode as default, introduce light mode 2017-06-06 15:31:28 +00:00			`.Op Ar -l`
Insert key for navigate-as-you-type mode 2017-06-04 06:15:17 +00:00			`.Op Ar -i`
			`.Op Ar -p custom_nlay`
Add program help 2017-04-14 18:44:25 +00:00			`.Op Ar -S`
			`.Op Ar -v`
			`.Op Ar -h`
			`.Op Ar PATH`
Add manpage 2014-10-22 11:52:45 +00:00			`.Sh DESCRIPTION`
			`.Nm`
Optionally use EDITOR (fallback vi) for text files 2017-06-06 14:46:32 +00:00			`(Noice is Not Noice) is a performance-optimized fork of the noice terminal file browser with extensive desktop integration, simplified navigation, \fInavigate-as-you-type\fR mode, disk usage analyzer mode, comprehensive file details and much more. It remains a simple and efficient file browser that stays out of your way.`
Add manpage 2014-10-22 11:52:45 +00:00			`.Pp`
			`.Nm`
Clarify filter semantics when executed as root 2014-10-22 12:28:00 +00:00			`defaults to the current directory if`
Add program help 2017-04-14 18:44:25 +00:00			`.Ar PATH`
Update documentation (man, README) 2017-03-31 02:52:51 +00:00			`is not specified.`
Clarify filter semantics when executed as root 2014-10-22 12:28:00 +00:00			`.Pp`
			`.Nm`
Add manpage 2014-10-22 11:52:45 +00:00			`supports both vi-like and emacs-like key bindings in the default`
Insert key for navigate-as-you-type mode 2017-06-04 06:15:17 +00:00			`configuration. The default key bindings are listed below.`
Add manpage 2014-10-22 11:52:45 +00:00			`.Pp`
Style changes and rephrasing 2014-11-14 14:41:46 +00:00			`.Bl -tag -width "l, [Right], [Return] or C-mXXXX" -offset indent -compact`
Add help screen on keybinds 2017-04-03 17:03:46 +00:00			`.It Ic [Up], k, ^P`
Remove sh as script opener, use vi 2017-03-31 18:05:48 +00:00			`Move to previous entry`
Add help screen on keybinds 2017-04-03 17:03:46 +00:00			`.It Ic [Down], j, ^N`
Remove sh as script opener, use vi 2017-03-31 18:05:48 +00:00			`Move to next entry`
Add help screen on keybinds 2017-04-03 17:03:46 +00:00			`.It Ic [PgUp], ^U`
Remove sh as script opener, use vi 2017-03-31 18:05:48 +00:00			`Scroll up half a page`
Add help screen on keybinds 2017-04-03 17:03:46 +00:00			`.It Ic [PgDn], ^D`
Remove sh as script opener, use vi 2017-03-31 18:05:48 +00:00			`Scroll down half a page`
vim-ish binding for jump to first and last entry It was troubling me. Mimicking 'gg' would have been hacky and would need additional processing... 'g' was free. Who cares even if you press twice? ;) 2017-04-04 03:46:29 +00:00			`.It Ic [Home], g, ^, ^A`
Remove sh as script opener, use vi 2017-03-31 18:05:48 +00:00			`Move to the first entry`
vim-ish binding for jump to first and last entry It was troubling me. Mimicking 'gg' would have been hacky and would need additional processing... 'g' was free. Who cares even if you press twice? ;) 2017-04-04 03:46:29 +00:00			`.It Ic [End], G, $, ^E`
Remove sh as script opener, use vi 2017-03-31 18:05:48 +00:00			`Move to the last entry`
Add help screen on keybinds 2017-04-03 17:03:46 +00:00			`.It Ic [Right], [Enter], l, ^M`
Remove sh as script opener, use vi 2017-03-31 18:05:48 +00:00			`Open file or enter directory`
Add help screen on keybinds 2017-04-03 17:03:46 +00:00			`.It Ic [Left], [Backspace], h, ^H`
Remove sh as script opener, use vi 2017-03-31 18:05:48 +00:00			`Back up one directory level`
Insert key for navigate-as-you-type mode 2017-06-04 06:15:17 +00:00			`.It Ic [Insert]`
			`Toggle navigate-as-you-type mode`
Update documentation (man, README) 2017-03-31 02:52:51 +00:00			`.It Ic ~`
Remove sh as script opener, use vi 2017-03-31 18:05:48 +00:00			`Change to the HOME directory`
Support jump to initial directory This change remaps the & key. However, / is more relevant for filter and & makes more sense wrt. address. 2017-04-23 21:06:49 +00:00			`.It Ic &`
			`Change to initial directory`
Key - to jump to last visited directory 2017-04-08 08:16:03 +00:00			`.It Ic -`
			`Change to the last visited directory`
Support jump to initial directory This change remaps the & key. However, / is more relevant for filter and & makes more sense wrt. address. 2017-04-23 21:06:49 +00:00			`.It Ic /`
Remove sh as script opener, use vi 2017-03-31 18:05:48 +00:00			`Change filter (more information below)`
Fix #27: use catfish as default search utility 2017-05-15 14:44:13 +00:00			`.It Ic ^/`
nlay - support multiple apps 2017-06-05 04:54:28 +00:00			`Search directory in desktop search tool`
Navigate-as-you-type support 1. Open directories in filter mode 2. Fix arrow keys not working after filter selection (due to invalid cur entry) 3. Support `Insert` key to clear filter prompt 4. Update documentation 2017-06-03 23:19:16 +00:00			`.It Ic \&.`
			`Toggle hide .dot files`
Add manpage 2014-10-22 11:52:45 +00:00			`.It Ic c`
Remove sh as script opener, use vi 2017-03-31 18:05:48 +00:00			`Change into the given directory`
Update documentation (man, README) 2017-03-31 02:52:51 +00:00			`.It Ic d`
Remove sh as script opener, use vi 2017-03-31 18:05:48 +00:00			`Toggle detail view`
Show file details We closely follow the output for stat(1). 2017-04-02 23:35:14 +00:00			`.It Ic D`
Toggle help and file details screens with same key 2017-04-10 13:05:30 +00:00			`Toggle current file details screen`
Show media information using mediainfo 2017-04-21 18:26:48 +00:00			`.It Ic m`
Do not wait when spawning DE file manager 2017-04-22 14:19:00 +00:00			`Show concise mediainfo`
Show media information using mediainfo 2017-04-21 18:26:48 +00:00			`.It Ic M`
Do not wait when spawning DE file manager 2017-04-22 14:19:00 +00:00			`Show full mediainfo`
Update documentation (man, README) 2017-03-31 02:52:51 +00:00			`.It Ic s`
Remove sh as script opener, use vi 2017-03-31 18:05:48 +00:00			`Toggle sort by file size`
Initial path: support sort by disk usage 2017-04-09 18:41:29 +00:00			`.It Ic S`
			`Toggle disk usage analyzer mode`
Add 't' command to sort output by entry's mtime 2015-01-31 22:02:59 +00:00			`.It Ic t`
Remove sh as script opener, use vi 2017-03-31 18:05:48 +00:00			`Toggle sort by time modified`
Use proper tags for AUTHORS section in manpage Fix some mandoc -Tlint warnings as well. 2015-07-02 16:49:17 +00:00			`.It Ic \&!`
Remove sh as script opener, use vi 2017-03-31 18:05:48 +00:00			`Spawn SHELL in PWD (fallback sh)`
Key bindings to run user-defined commands 2015-03-12 14:12:01 +00:00			`.It Ic e`
Remove sh as script opener, use vi 2017-03-31 18:05:48 +00:00			`Open current entry in EDITOR (fallback vi)`
Navigate-as-you-type support 1. Open directories in filter mode 2. Fix arrow keys not working after filter selection (due to invalid cur entry) 3. Support `Insert` key to clear filter prompt 4. Update documentation 2017-06-03 23:19:16 +00:00			`.It Ic o`
			`Open directory in NNN_DE_FILE_MANAGER`
Minor fixes for manpage 2015-11-26 15:03:26 +00:00			`.It Ic p`
Remove sh as script opener, use vi 2017-03-31 18:05:48 +00:00			`Open current entry in PAGER (fallback less)`
Add help screen on keybinds 2017-04-03 17:03:46 +00:00			`.It Ic ^K`
We copy the absolute file path 2017-06-06 14:54:04 +00:00			`Invoke file path copier`
Add help screen on keybinds 2017-04-03 17:03:46 +00:00			`.It Ic ^L`
Exit once an app is found. Help, doc updates. 2017-06-06 16:07:16 +00:00			`Force a redraw, exit filter prompt`
Add help screen on keybinds 2017-04-03 17:03:46 +00:00			`.It Ic \&?`
Toggle help and file details screens with same key 2017-04-10 13:05:30 +00:00			`Toggle help screen`
Support cd on quit 2017-04-19 12:52:30 +00:00			`.It Ic Q`
			`Quit and change directory`
Use vlock as locker, add ^Q to quit ^Q would quit even from filter mode 2017-06-04 18:46:43 +00:00			`.It Ic q, ^Q`
			`Quit`
Fix manpage .Bl needs a matching .El 2014-10-22 11:57:22 +00:00			`.El`
Remove history section because it resembles historical notes 2014-11-14 14:45:17 +00:00			`.Pp`
			`Backing up one directory level will set the cursor position at the`
			`directory you came out of.`
Support opening in detail view mode 2017-04-01 05:18:18 +00:00			`.Pp`
			`.Nm`
Prepare for release v1.0 2017-04-13 13:43:33 +00:00			`supports the following options:`
Support opening in detail view mode 2017-04-01 05:18:18 +00:00			`.Pp`
Set detail view mode as default, introduce light mode 2017-06-06 15:31:28 +00:00			`.Fl l`
			`start in light mode (fewer details)`
Option -S: start in disk usage analyzer mode 2017-04-14 11:20:16 +00:00			`.Pp`
Insert key for navigate-as-you-type mode 2017-06-04 06:15:17 +00:00			`.Fl i`
Navigate-as-you-type support 1. Open directories in filter mode 2. Fix arrow keys not working after filter selection (due to invalid cur entry) 3. Support `Insert` key to clear filter prompt 4. Update documentation 2017-06-03 23:19:16 +00:00			`start in navigate-as-you-type mode`
			`.Pp`
Insert key for navigate-as-you-type mode 2017-06-04 06:15:17 +00:00			`.Fl "p custom_nlay"`
Navigate-as-you-type support 1. Open directories in filter mode 2. Fix arrow keys not working after filter selection (due to invalid cur entry) 3. Support `Insert` key to clear filter prompt 4. Update documentation 2017-06-03 23:19:16 +00:00			`path to custom nlay`
			`.Pp`
Option -S: start in disk usage analyzer mode 2017-04-14 11:20:16 +00:00			`.Fl S`
			`start in disk usage analyzer mode`
Prepare for release v1.0 2017-04-13 13:43:33 +00:00			`.Pp`
			`.Fl v`
			`show version and exit`
Add program help 2017-04-14 18:44:25 +00:00			`.Pp`
			`.Fl h`
			`show program help and exit`
Add manpage 2014-10-22 11:52:45 +00:00			`.Sh CONFIGURATION`
			`.Nm`
desktop opener - xdg-open on Linux and open(1) on OS X 2017-06-05 18:26:38 +00:00			`uses \fIxdg-open\fR (on Linux) and \fIopen(1)\fR (on OS X) as the desktop`
Optionally use EDITOR (fallback vi) for text files 2017-06-06 14:46:32 +00:00			`opener. It invokes`
nlay - a highly customizable file handler 2017-04-23 17:42:54 +00:00			`.Pa nlay`
Optionally use EDITOR (fallback vi) for text files 2017-06-06 14:46:32 +00:00			`to run desktop search utility or screensaver. Read more on`
nlay - a highly customizable file handler 2017-04-23 17:42:54 +00:00			`.Pa nlay`
			`at:`
			`.br`
			`.Em https://github.com/jarun/nnn/wiki/all-about-nlay`
			`.Pp`
Support cd on quit 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.`
Add manpage 2014-10-22 11:52:45 +00:00			`.Sh FILTERS`
Suppress output when spawning DE file manager 2017-06-07 05:56:33 +00:00			`Filters support regexes to instantly (search-as-you-type) list the matching`
			`entries in the current directory.`
Add manpage 2014-10-22 11:52:45 +00:00			`.Pp`
Suppress output when spawning DE file manager 2017-06-07 05:56:33 +00:00			`There are 3 ways to reset a filter: \fI^L\fR, a search with no`
When filter is empty, open file on Enter 2017-06-06 21:34:47 +00:00			`matches or an extra backspace at the filter prompt (like vi).`
Support search as you type 2017-04-28 23:02:47 +00:00			`.Pp`
Suppress output when spawning DE file manager 2017-06-07 05:56:33 +00:00			`Common examples: If you want to list all matches starting with the filter`
			`expression, start the expression with a`
Support search as you type 2017-04-28 23:02:47 +00:00			`.Pa ^`
Suppress output when spawning DE file manager 2017-06-07 05:56:33 +00:00			`(caret) symbol. Type`
			`.Pa \.mkv`
			`to list all MKV files.`
Clarify filter semantics when executed as root 2014-10-22 12:28:00 +00:00			`.Pp`
			`If`
			`.Nm`
Support cd on quit 2017-04-19 12:52:30 +00:00			`is invoked as root the default filter will also match hidden files.`
Navigate-as-you-type support 1. Open directories in filter mode 2. Fix arrow keys not working after filter selection (due to invalid cur entry) 3. Support `Insert` key to clear filter prompt 4. Update documentation 2017-06-03 23:19:16 +00:00			`.Pp`
Exit once an app is found. Help, doc updates. 2017-06-06 16:07:16 +00:00			`In the \fInavigate-as-you-type\fR mode directories are opened in filter mode,`
Update documentation 2017-06-04 17:45:08 +00:00			`allowing continuous navigation. Works best with the \fBarrow keys\fR.`
Minor fixes for manpage 2015-11-26 15:03:26 +00:00			`.Sh ENVIRONMENT`
			`The SHELL, EDITOR and PAGER environment variables take precedence`
			`when dealing with the !, e and p commands respectively.`
Doc update on NOICE_OPENER. 2016-08-21 08:28:53 +00:00			`.Pp`
Optionally use EDITOR (fallback vi) for text files 2017-06-06 14:46:32 +00:00			`\fBNNN_USE_EDITOR:\fR use EDITOR (preferably CLI, fallback vi) to handle text`
			`files.`
			`.Bd -literal`
			`export NNN_USE_EDITOR=1`
			`.Ed`
Support open current dir in desktop file manager 2017-04-12 16:48:03 +00:00			`.Pp`
Optionally use EDITOR (fallback vi) for text files 2017-06-06 14:46:32 +00:00			`\fBNNN_DE_FILE_MANAGER:\fR set to a desktop file manager to open the current`
			`directory with. E.g.:`
desktop opener - xdg-open on Linux and open(1) on OS X 2017-06-05 18:26:38 +00:00			`.Bd -literal`
Optionally use EDITOR (fallback vi) for text files 2017-06-06 14:46:32 +00:00			`export NNN_DE_FILE_MANAGER=thunar`
desktop opener - xdg-open on Linux and open(1) on OS X 2017-06-05 18:26:38 +00:00			`.Ed`
Rename project to nnn (Noice is Not Noice) 2017-03-30 18:25:30 +00:00			`.Pp`
Use vlock as locker, add ^Q to quit ^Q would quit even from filter mode 2017-06-04 18:46:43 +00:00			`\fBNNN_IDLE_TIMEOUT:\fR set idle timeout (in seconds) to invoke terminal`
			`screensaver.`
			`.Pp`
Rename project to nnn (Noice is Not Noice) 2017-03-30 18:25:30 +00:00			`\fBNNN_COPIER:\fR set to a clipboard copier script. For example, on Linux:`
			`.Bd -literal`
Update documentation (man, README) 2017-03-31 02:52:51 +00:00			`-------------------------------------`
Rename project to nnn (Noice is Not Noice) 2017-03-30 18:25:30 +00:00			`#!/bin/sh`

			`echo -n $1 \| xsel --clipboard --input`
Update documentation (man, README) 2017-03-31 02:52:51 +00:00			`-------------------------------------`
.Bd directive has no matching .Ed Add .Ed to match with .Bd 2017-04-15 04:00:41 +00:00			`.Ed`
Add a KNOWN ISSUES sections 2014-10-22 13:59:15 +00:00			`.Sh KNOWN ISSUES`
Minor manpage fix 2015-01-31 22:58:08 +00:00			`If you are using urxvt you might have to set backspacekey to DEC.`
Add manpage 2014-10-22 11:52:45 +00:00			`.Sh AUTHORS`
Use proper tags for AUTHORS section in manpage Fix some mandoc -Tlint warnings as well. 2015-07-02 16:49:17 +00:00			`.An Lazaros Koromilas Aq Mt lostd@2f30.org ,`
Update documentation (man, README) 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`
Support opening in detail view mode 2017-04-01 05:18:18 +00:00			`.Em https://github.com/jarun/nnn`