aboutsummaryrefslogtreecommitdiffstats
path: root/nnn.1
blob: d6eefba02ee393a77a731417ea3fa983b469ab9b (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
.Dd April 13, 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 -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, 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 o
Open directory in NNN_DE_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 m
Show concise mediainfo
.It Ic M
Show full mediainfo
.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
.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 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.
.Pp
Filters do not stack on top of each other.  They are applied anew
every time. There are 3 ways to reset a filter:
.Pp
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.
.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