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 nnn
.Op Ar -d
.Op Ar -f
.Op Ar -p
.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 improved desktop integration, navigation, navigate-as-you-type 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 ~
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 gnome-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 f
Toggle navigate-as-you-type mode
.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 z
Run the system top utility.
.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 name copier
.It Ic ^L
Force a redraw
.It Ic \&?
Toggle help screen
.It Ic q
Quit
.It Ic Q
Quit and change directory
.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 d
        start in detail view mode
.Pp
.Fl f
        start in navigate-as-you-type mode
.Pp
.Fl p
        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
invokes
.Pa nlay
to play a file if it recognizes a file by extension.
.Pa nlay
is a
highly customizable bash shell script which invokes a player depending on the
type of file. Read more on
.Pa nlay
at:
.br
.Em https://github.com/jarun/nnn/wiki/all-about-nlay
.Pp
.Nm
is configured by modifying
.Pa config.def.h
and recompiling the code. config.h is generated as a backup of config.def.h.
.Pp
See the environment and examples sections below for more options and information.
.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 display only the matched
entries in the current directory view.  This effectively allows
searching through the directory tree for a particular entry. Matching entries
are shown instantly (search-as-you-type).
.Pp
Filters do not stack on top of each other.  They are applied anew
every time. There are 4 ways to reset a filter:
.Pp
The \fIInsert\fR key, an empty filter expression, a search with no results or an
extra backspace at the filter prompt (like vi).
.Pp
If you want to list all matches starting with the filter expression (a common
use case), start the expression with a
.Pa ^
(caret) symbol.
.Pp
If
.Nm
is invoked as root the default filter will also match hidden files.
.Pp
In the navigate-as-you-type mode directories are opened in filter mode,
allowing instant navigation. Works best with the arrow keys.
.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, gio 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
        -------------------------------------
.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