mirror of https://github.com/jarun/nnn.git
201 lines
5.0 KiB
Groff
201 lines
5.0 KiB
Groff
.Dd Jun 29, 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, 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.
|
|
.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 b
|
|
Show bookmark key prompt
|
|
.It Ic c
|
|
Show change dir prompt
|
|
.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, [F2]
|
|
Force a redraw, exit filter prompt
|
|
.It Ic \&?
|
|
Toggle help and settings 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
|
|
There is no configuration file. Settings work on environment variables. Please
|
|
refer to the ENVIRONMENT section below.
|
|
.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 (or \fIF2\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_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
|
|
\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
|