nnn/nnn.1

177 lines
4.6 KiB
Groff
Raw Normal View History

2017-04-13 13:43:33 +00:00
.Dd April 13, 2017
.Dt NNN 1
2014-10-22 11:52:45 +00:00
.Os
.Sh NAME
.Nm nnn
2017-04-14 18:44:25 +00:00
.Nd the missing terminal file browser for X
2014-10-22 11:52:45 +00:00
.Sh SYNOPSIS
.Nm nnn
2017-04-01 05:18:18 +00:00
.Op Ar -d
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
(Noice is Not Noice) is a performance-optimized 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.
2014-10-22 11:52:45 +00:00
.Pp
.Nm
defaults to the current directory if
2017-04-14 18:44:25 +00:00
.Ar PATH
2017-03-31 02:52:51 +00:00
is not specified.
.Pp
.Nm
2014-10-22 11:52:45 +00:00
supports both vi-like and emacs-like key bindings in the default
2017-03-31 02:52:51 +00:00
configuration. The default key bindings are 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-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 the last visited directory
.It Ic o
Open directory in desktop file manager
2017-04-03 17:03:46 +00:00
.It Ic /, &
2017-03-31 18:05:48 +00:00
Change filter (more information below)
2014-10-22 11:52:45 +00:00
.It Ic c
2017-03-31 18:05:48 +00:00
Change into the given directory
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
Toggle current file details screen
.It Ic \&.
2017-03-31 18:05:48 +00:00
Toggle hide .dot files
2017-03-31 02:52:51 +00:00
.It Ic s
2017-03-31 18:05:48 +00:00
Toggle sort by file size
.It Ic S
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)
.It Ic z
Run the system top utility.
.It Ic e
2017-03-31 18:05:48 +00:00
Open current entry in EDITOR (fallback vi)
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)
2017-04-03 17:03:46 +00:00
.It Ic ^K
2017-03-31 18:05:48 +00:00
Invoke file name copier
2017-04-03 17:03:46 +00:00
.It Ic ^L
2017-03-31 18:05:48 +00:00
Force a redraw
2017-04-03 17:03:46 +00:00
.It Ic \&?
Toggle help screen
2014-10-22 11:52:45 +00:00
.It Ic q
2017-03-31 18:05:48 +00:00
Quit
2017-04-19 12:52:30 +00:00
.It Ic Q
Quit and change directory
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
.Nm
2017-04-13 13:43:33 +00:00
supports the following options:
2017-04-01 05:18:18 +00:00
.Pp
.Fl d
start in detail view mode
.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
is configured by modifying
.Pa config.h
and recompiling the code.
.Pp
See the environment and examples sections below for more options and information.
2017-04-19 12:52:30 +00:00
.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.
2014-10-22 11:52:45 +00:00
.Sh FILTERS
2017-03-31 02:52:51 +00:00
Filters support regexes to display only the matched
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
2017-04-04 14:27:44 +00:00
An empty filter expression resets the filter.
.Pp
If
.Nm
2017-04-19 12:52:30 +00:00
is invoked as root the default filter will also match hidden files.
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.
2016-08-21 08:28:53 +00:00
.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
2016-08-21 08:28:53 +00:00
mime opener to override all custom mime associations.
.br
2017-04-13 15:44:30 +00:00
Examples: xdg-open, gio open, gvfs-open.
2016-08-21 10:32:03 +00:00
.Pp
\fBNNN_FALLBACK_OPENER:\fR set to your desktop environment's default
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.
.Pp
\fBNNN_COPIER:\fR set to a clipboard copier script. For example, on Linux:
.Bd -literal
2017-03-31 02:52:51 +00:00
-------------------------------------
#!/bin/sh
echo -n $1 | xsel --clipboard --input
2017-03-31 02:52:51 +00:00
-------------------------------------
.Ed
2014-10-22 11:52:45 +00:00
.Sh EXAMPLES
The following example shows one possible configuration for
2016-08-21 08:28:53 +00:00
file associations which is also the default if environment
variable NNN_OPENER is not set:
2014-10-22 11:52:45 +00:00
.Bd -literal
2017-03-31 02:52:51 +00:00
-----------------------------------------------
struct assoc assocs[] = {
2017-03-31 18:05:48 +00:00
{ "\\.(c|cpp|h|txt|log|sh)$", "vi" },
2017-03-31 22:23:49 +00:00
{ "\\.(wma|mp3|ogg|flac)$", "mpv" },
{ "\\.pdf$", "zathura" },
};
2017-03-31 02:52:51 +00:00
-----------------------------------------------
2017-03-31 16:55:56 +00:00
Plain text files are opened with vi.
2016-08-21 07:19:42 +00:00
.br
Any other file types are opened with the 'xdg-open' command.
2014-10-22 11:52:45 +00:00
.Ed
2014-10-22 13:59:15 +00:00
.Sh KNOWN ISSUES
2015-01-31 22:58:08 +00:00
If you are using urxvt you might have to set backspacekey 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