nnn/nnn.1

204 lines
5.1 KiB
Groff
Raw Normal View History

2017-06-29 04:18:11 +00:00
.Dd Jun 29, 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
2017-06-04 17:45:08 +00:00
.Nm
.Op Ar -l
.Op Ar -i
.Op Ar -p custom_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
2017-06-11 04:15:50 +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, bookmarks, 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
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
.It Ic [Insert]
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
.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 \&.
Toggle hide .dot files
2017-06-11 04:15:50 +00:00
.It Ic b
Show bookmark key prompt
2014-10-22 11:52:45 +00:00
.It Ic c
2017-06-11 04:15:50 +00:00
Show change dir 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
Toggle current file details screen
2017-04-21 18:26:48 +00:00
.It Ic m
Show concise mediainfo
2017-04-21 18:26:48 +00:00
.It Ic M
Show full mediainfo
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 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)
2017-04-03 17:03:46 +00:00
.It Ic ^K
2017-06-06 14:54:04 +00:00
Invoke file path copier
2017-06-25 04:33:30 +00:00
.It Ic ^L, [F2]
Force a redraw, exit filter prompt
2017-04-03 17:03:46 +00:00
.It Ic \&?
2017-06-11 13:54:02 +00:00
Toggle help and settings screen
2017-04-19 12:52:30 +00:00
.It Ic Q
Quit and change directory
.It Ic q, ^Q
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
.Nm
2017-04-13 13:43:33 +00:00
supports the following options:
2017-04-01 05:18:18 +00:00
.Pp
.Fl l
start in light mode (fewer details)
.Pp
.Fl i
start in navigate-as-you-type mode
.Pp
.Fl n
disable color for directory entries
.Pp
.Fl "p custom_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
2017-06-25 04:33:30 +00:00
There are 3 ways to reset a filter: \fI^L\fR (or \fIF2\fR), a search with no
matches or an extra backspace at the filter prompt (like vi).
2017-04-28 23:02:47 +00:00
.Pp
Common examples: If you want to list all matches starting with the filter
expression, start the expression with a
2017-04-28 23:02:47 +00:00
.Pa ^
(caret) symbol. Type
.Pa \.mkv
to list all MKV files.
.Pp
If
.Nm
2017-04-19 12:52:30 +00:00
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,
2017-06-04 17:45:08 +00:00
allowing continuous navigation. Works best with the \fBarrow keys\fR.
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
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
export NNN_BMS='doc:~/Documents;u:/home/user/Cam Uploads;D:~/Downloads/'
.Ed
.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
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
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 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