nnn/nnn.1

.Dd August 21, 2016
.Dt NNN 1
.Os
.Sh NAME
.Nm nnn
.Nd free, fast, friendly file browser
.Sh SYNOPSIS
.Nm nnn
.Op Ar -d
.Op Ar dir
.Sh DESCRIPTION
.Nm
(Noice is Not Noice) is a fork of the noice terminal file browser with improved desktop integration, navigation, 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 dir
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 ~
Change to the HOME directory
.It Ic -
Change to the last visited directory
.It Ic o
Open directory in desktop file manager
.It Ic /, &
Change filter (more information below)
.It Ic c
Change into the given directory
.It Ic d
Toggle detail view
.It Ic D
Toggle current file details screen
.It Ic \&.
Toggle hide .dot files
.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 z
Run the system top utility.
.It Ic e
Open current entry in EDITOR (fallback vi)
.It Ic p
Open current entry in PAGER (fallback less)
.It Ic ^K
Invoke file name copier
.It Ic ^L
Force a redraw
.It Ic \&?
Toggle help screen
.It Ic 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 option:
.Pp
.Fl d
        Open in detail view mode.
.Sh CONFIGURATION
.Nm
is configured by modifying
.Pa config.h
and recompiling the code.
.Pp
See the environment and examples sections below for more options and information.
.Sh FILTERS
Filters support regexes to display only the matched
entries in the current directory view.  This effectively allows
searching through the directory tree for a particular entry.
.Pp
Filters do not stack on top of each other.  They are applied anew
every time.
.Pp
An empty filter expression resets the filter.
.Pp
If
.Nm
is invoked as root the default filter will also match hidden
files.
.Sh ENVIRONMENT
The SHELL, EDITOR and PAGER environment variables take precedence
when dealing with the !, e and p commands respectively.
.Pp
\fBNNN_DE_FILE_MANAGER:\fR set to a desktop file manager to open the current
directory with.
.Pp
\fBNNN_OPENER:\fR set to your desktop environment's default
mime opener to override all custom mime associations.
.br
Examples: xdg-open, gnome-open, gvfs-open.
.Pp
\fBNNN_FALLBACK_OPENER:\fR set to your desktop environment's default
mime opener to use as a fallback when no association is set for a file
type. Custom associations are listed in the EXAMPLES section below.
.Pp
\fBNNN_COPIER:\fR set to a clipboard copier script. For example, on Linux:
.Bd -literal
        -------------------------------------
        #!/bin/sh

        echo -n $1 | xsel --clipboard --input
        -------------------------------------
.Sh EXAMPLES
The following example shows one possible configuration for
file associations which is also the default if environment
variable NNN_OPENER is not set:
.Bd -literal
        -----------------------------------------------
        struct assoc assocs[] = {
	        { "\\.(c|cpp|h|txt|log|sh)$", "vi" },
	        { "\\.(wma|mp3|ogg|flac)$", "mpv" },
	        { "\\.pdf$", "zathura" },
        };
        -----------------------------------------------
Plain text files are opened with vi.
.br
Any other file types are opened with the 'xdg-open' command.
.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
Update man page. 2016-08-21 07:19:42 +00:00			`.Dd August 21, 2016`
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`
Update documentation (man, README) 2017-03-31 02:52:51 +00:00			`.Nd free, fast, friendly file browser`
Add manpage 2014-10-22 11:52:45 +00:00			`.Sh SYNOPSIS`
Rename project to nnn (Noice is Not Noice) 2017-03-30 18:25:30 +00:00			`.Nm nnn`
Support opening in detail view mode 2017-04-01 05:18:18 +00:00			`.Op Ar -d`
Add manpage 2014-10-22 11:52:45 +00:00			`.Op Ar dir`
			`.Sh DESCRIPTION`
			`.Nm`
Update README 2017-04-09 21:50:13 +00:00			`(Noice is Not Noice) is a fork of the noice terminal file browser with improved desktop integration, navigation, 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`
			`.Ar dir`
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`
Update documentation (man, README) 2017-03-31 02:52:51 +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`
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`
Key - to jump to last visited directory 2017-04-08 08:16:03 +00:00			`.It Ic -`
			`Change to the last visited directory`
Support open current dir in desktop file manager 2017-04-12 16:48:03 +00:00			`.It Ic o`
			`Open directory in desktop file manager`
Add help screen on keybinds 2017-04-03 17:03:46 +00:00			`.It Ic /, &`
Remove sh as script opener, use vi 2017-03-31 18:05:48 +00:00			`Change filter (more information below)`
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`
Add command to toggle hide .dot files Patch written by Richard Hyde and taken from https://github.com/RichardHyde/noice 2016-02-25 14:54:41 +00:00			`.It Ic \&.`
Remove sh as script opener, use vi 2017-03-31 18:05:48 +00:00			`Toggle hide .dot files`
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 z`
			`Run the system top utility.`
			`.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)`
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`
Remove sh as script opener, use vi 2017-03-31 18:05:48 +00:00			`Invoke file name copier`
Add help screen on keybinds 2017-04-03 17:03:46 +00:00			`.It Ic ^L`
Remove sh as script opener, use vi 2017-03-31 18:05:48 +00:00			`Force a redraw`
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`
Add manpage 2014-10-22 11:52:45 +00:00			`.It Ic q`
Remove sh as script opener, use vi 2017-03-31 18:05:48 +00:00			`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`
			`supports the following option:`
			`.Pp`
			`.Fl d`
			`Open in detail view mode.`
Add manpage 2014-10-22 11:52:45 +00:00			`.Sh CONFIGURATION`
			`.Nm`
			`is configured by modifying`
			`.Pa config.h`
			`and recompiling the code.`
			`.Pp`
Support open current dir in desktop file manager 2017-04-12 16:48:03 +00:00			`See the environment and examples sections below for more options and information.`
Add manpage 2014-10-22 11:52:45 +00:00			`.Sh FILTERS`
Update documentation (man, README) 2017-03-31 02:52:51 +00:00			`Filters support regexes to display only the matched`
Add manpage 2014-10-22 11:52:45 +00:00			`entries in the current directory view. This effectively allows`
			`searching through the directory tree for a particular entry.`
			`.Pp`
			`Filters do not stack on top of each other. They are applied anew`
			`every time.`
			`.Pp`
Show notifier only for associations 2017-04-04 14:27:44 +00:00			`An empty filter expression resets the filter.`
Clarify filter semantics when executed as root 2014-10-22 12:28:00 +00:00			`.Pp`
			`If`
			`.Nm`
			`is invoked as root the default filter will also match hidden`
			`files.`
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`
Support open current dir in desktop file manager 2017-04-12 16:48:03 +00:00			`\fBNNN_DE_FILE_MANAGER:\fR set to a desktop file manager to open the current`
			`directory with.`
			`.Pp`
Rename project to nnn (Noice is Not Noice) 2017-03-30 18:25:30 +00:00			`\fBNNN_OPENER:\fR set to your desktop environment's default`
Doc update on NOICE_OPENER. 2016-08-21 08:28:53 +00:00			`mime opener to override all custom mime associations.`
			`.br`
			`Examples: xdg-open, gnome-open, gvfs-open.`
Document NOICE_FALLBAK_OPENER. 2016-08-21 10:32:03 +00:00			`.Pp`
Rename project to nnn (Noice is Not Noice) 2017-03-30 18:25:30 +00:00			`\fBNNN_FALLBACK_OPENER:\fR set to your desktop environment's default`
Document NOICE_FALLBAK_OPENER. 2016-08-21 10:32:03 +00:00			`mime opener to use as a fallback when no association is set for a file`
			`type. Custom associations are listed in the EXAMPLES section below.`
Rename project to nnn (Noice is Not Noice) 2017-03-30 18:25:30 +00:00			`.Pp`
			`\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			`-------------------------------------`
Add manpage 2014-10-22 11:52:45 +00:00			`.Sh EXAMPLES`
			`The following example shows one possible configuration for`
Doc update on NOICE_OPENER. 2016-08-21 08:28:53 +00:00			`file associations which is also the default if environment`
Rename project to nnn (Noice is Not Noice) 2017-03-30 18:25:30 +00:00			`variable NNN_OPENER is not set:`
Add manpage 2014-10-22 11:52:45 +00:00			`.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			`struct assoc assocs[] = {`
Remove sh as script opener, use vi 2017-03-31 18:05:48 +00:00			`{ "\\.(c\|cpp\|h\|txt\|log\|sh)$", "vi" },`
Open audio files with mpv 2017-03-31 22:23:49 +00:00			`{ "\\.(wma\|mp3\|ogg\|flac)$", "mpv" },`
Rename project to nnn (Noice is Not Noice) 2017-03-30 18:25:30 +00:00			`{ "\\.pdf$", "zathura" },`
			`};`
Update documentation (man, README) 2017-03-31 02:52:51 +00:00			`-----------------------------------------------`
Change vim to vi 2017-03-31 16:55:56 +00:00			`Plain text files are opened with vi.`
Update man page. 2016-08-21 07:19:42 +00:00			`.br`
			`Any other file types are opened with the 'xdg-open' command.`
Add manpage 2014-10-22 11:52:45 +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`