1
- .Dd February 22, 2025
1
+ .Dd Aug 26, 2024
2
2
.Dt NNN 1
3
3
.Os
4
4
.Sh NAME
@@ -49,7 +49,7 @@ the base filename.
49
49
.Sh KEYBINDS
50
50
.Pp
51
51
Press
52
- .Ql \& ?
52
+ .Ql \fB ? \fR
53
53
in
54
54
.Nm
55
55
to see the list of keybinds.
@@ -59,7 +59,7 @@ to see the list of keybinds.
59
59
supports the following options:
60
60
.Pp
61
61
.Fl a
62
- auto-setup temporary \fB NNN_FIFO \fR (described in \fI ENVIRONMENT \fR section)
62
+ auto-setup temporary \fB NNN_FIFO \fR (refer to the \fB ENVIRONMENT \fR section)
63
63
.Pp
64
64
.Fl A
65
65
disable directory auto-enter on unique filter match
@@ -71,7 +71,7 @@ supports the following options:
71
71
use bsdtar for archives (default: atool)
72
72
.Pp
73
73
.Fl c
74
- indicates that the opener is a cli-only opener (overrides -e )
74
+ indicates that the opener is a cli-only opener (overrides \fB -e \fR )
75
75
.Pp
76
76
.Fl C
77
77
8-color scheme - color directories by context, disable file colors
@@ -131,10 +131,10 @@ supports the following options:
131
131
.Pp
132
132
.Fl r
133
133
show cp, mv progress
134
- (Linux-only, needs \fI advcpmv \fR ; '^T' shows the progress on BSD/macOS)
134
+ (Linux-only, needs \fI advcpmv \fR ; \fB ^T \fR shows the progress on BSD/macOS)
135
135
.Pp
136
136
.Fl R
137
- disable rollover at edges (eg. pressing \fI down \fR while on the last
137
+ disable rollover at edges (eg. pressing \fB down \fR while on the last
138
138
entry will no longer move cursor to the first entry and vice\- versa)
139
139
.Pp
140
140
.Fl " s name"
@@ -147,7 +147,7 @@ supports the following options:
147
147
idle timeout in seconds to lock terminal
148
148
.Pp
149
149
.Fl " T key"
150
- sort order
150
+ sort order (refer to the \fB SORTING \fR section)
151
151
keys: 'a'pparent disk usage / 'd'isk usage / 'e'xtension / 'r'everse / 's'ize / 't'ime / 'v'ersion
152
152
capitalize to reverse (except 'r')
153
153
.Pp
@@ -161,8 +161,8 @@ supports the following options:
161
161
show version and exit
162
162
.Pp
163
163
.Fl x
164
- show notifications on selection cp, mv, rm completion (requires \fI .ntfy \fR plugin)
165
- copy path to system clipboard on selection (requires \fI .cbcp \fR plugin)
164
+ show notifications on selection cp, mv, rm completion (requires the \fB .ntfy \fR plugin)
165
+ copy path to system clipboard on selection (requires the \fB .cbcp \fR plugin)
166
166
show xterm title (if non-picker mode)
167
167
.Pp
168
168
.Fl 0
@@ -176,12 +176,12 @@ There is no configuration file. Associated files are at
176
176
.Pa ${XDG_CONFIG_HOME:-$HOME/.config}/nnn/
177
177
.Pp
178
178
Configuration is done using a few optional (set if you need) environment
179
- variables. See ENVIRONMENT section.
179
+ variables. Refer to the \fB ENVIRONMENT \fR section.
180
180
.Pp
181
181
.Nm
182
- uses \fI xdg -open\fR (on Linux), \fI open (1)\fR (on macOS), \fI cygstart \fR on
183
- (Cygwin) and \fI open \fR on (Haiku) as the desktop opener. It's also possible
184
- to specify a custom opener. See ENVIRONMENT section.
182
+ uses \fB xdg -open\fR (on Linux), \fB open (1)\fR (on macOS), \fB cygstart \fR on
183
+ (Cygwin) and \fB open \fR on (Haiku) as the desktop opener. It's also possible
184
+ to specify a custom opener. Refer to the \fB ENVIRONMENT \fR section.
185
185
.Sh CONTEXTS
186
186
Open multiple locations with 4 contexts. The status is shown in the top left
187
187
corner:
@@ -193,7 +193,7 @@ corner:
193
193
- rest are inactive
194
194
.Pp
195
195
A new context copies the state of the previous context. Each context can have
196
- its own color. See ENVIRONMENT section.
196
+ its own color. Refer to the \fB ENVIRONMENT \fR section.
197
197
.Sh SESSIONS
198
198
Sessions are a way to save and restore states of work. A session stores the
199
199
settings and contexts. Sessions can be loaded at runtime or with a program
@@ -209,7 +209,7 @@ will be updated with the final state at program quit.
209
209
- The "auto session" is used in persistent session mode if no session is active.
210
210
.br
211
211
- Listing input stream and opening a bookmark by key have a higher priority to
212
- session options (-s/-S ).
212
+ session options (\fB -s \fR / \fB -S \fR ).
213
213
.Pp
214
214
All the session files are located by session name in the directory
215
215
.Pp
@@ -237,15 +237,15 @@ Special keys at filter prompt:
237
237
-------- + ---------------------------------------
238
238
.Ed
239
239
.Pp
240
- Special keys at \fB empty filter prompt \fR :
240
+ Special keys at \fB empty \fR filter prompt:
241
241
.Bd -literal
242
242
------ + ---------------------------------------
243
243
Key | Function
244
244
------ + ---------------------------------------
245
245
? | Show help and config screen
246
246
/ | Toggle between string and regex
247
247
: | Toggle case-sensitivity
248
- ^L | Clear filter (\fI if prompt is non -empty\fR )
248
+ ^L | Clear filter (if prompt is \fB non -empty\fR )
249
249
| OR apply last filter
250
250
Bksp | Stay at filter prompt and refresh dir
251
251
Del | Stay at filter prompt and refresh dir
@@ -263,11 +263,11 @@ Common regex use cases:
263
263
.br
264
264
(4) Exclude filenames having 'nnn' (compiled with PCRE lib): '^(?!nnn)'
265
265
.Pp
266
- In the \fB type -to-nav\fR mode directories are opened in filter
266
+ In the \fI type -to-nav\fR mode directories are opened in filter
267
267
mode, allowing continuous navigation.
268
268
.Pp
269
- Additional special keys at \fB empty filter prompt \fR
270
- in \fB type -to-nav\fR mode:
269
+ Additional special keys at \fB empty \fR filter prompt
270
+ in \fI type -to-nav\fR mode:
271
271
.Bd -literal
272
272
------ + ------------------------
273
273
Key | Function
@@ -286,14 +286,13 @@ in \fBtype-to-nav\fR mode:
286
286
~ | Go HOME
287
287
------ + ------------------------
288
288
.Ed
289
- .Sh SORT
289
+ .Sh SORTING
290
290
.Nm
291
- will always show the directories first, followed by the files.
292
- String order is always case-insensitive.
291
+ will always show the directories first, followed by the files. String
292
+ order is always case-insensitive.
293
293
.Pp
294
- The sort key can be set; either on start with the -T flag, or interactively
295
- using 't' or '^T'.
296
- The following options exist:
294
+ The sort key can be set either with the \fB -T \fR program option, or
295
+ interactively using \fB t \fR or \fB ^T \fR . The following options are available:
297
296
.Bl -tag -width 2n
298
297
.It Ic a
299
298
apparent disk usage, how large the file appears to be, can be bigger than actual
@@ -303,12 +302,12 @@ disk usage, amount of data taken on disk, a multiple of the block size.
303
302
.It Ic e
304
303
extension of the file.
305
304
.It Ic r
306
- reverse the current order (not available for the -T flag ).
305
+ reverse the current order (not available with \fB -T \fR ).
307
306
.It Ic s
308
307
size of file, amount of data stored in the file.
309
308
.It Ic t
310
309
time, this depends on the currently selected time type which can be changed
311
- using the 'T' key.
310
+ using the \fB T \fR key.
312
311
Options are:
313
312
.Bl -tag -compact -width 1n
314
313
.It Ic a
@@ -322,19 +321,18 @@ modified, last time the content of the file was changed (default).
322
321
version, sorts by filename while treating digit characters numerically.
323
322
For example: j1.png, j02.png, j3.png.
324
323
.It Ic c
325
- clear, revert to filename order (not available for the -T flag ).
324
+ clear, revert to filename order (not available with \fB -T \fR ).
326
325
.It Ic ^T
327
- cycle between filename/size/time order (not available for the -T flag ).
326
+ cycle between filename/size/time order (not available with \fB -T \fR ).
328
327
.El
329
328
.Pp
330
- The uppercase version of the option can be used to specify the opposite of the
331
- default order.
329
+ The uppercase version of the option (except \fB r \fR ) reverses the default order.
332
330
By default, time and size sort keys are ordered in descending order, and
333
331
alphabetical fields are ordered in ascending order.
334
- For example, when using the 'e' option, the entries will be ordered by
332
+ For example, when using the \fB e \fR option, the entries will be ordered by
335
333
extension, in ascending order.
336
- Using 'E' would result in descending order of the extensions.
337
- This means that 'e' followed by 'r' is the same as 'E' .
334
+ Using \fB E \fR would result in descending order of the extensions.
335
+ This means that \fB e \fR followed by \fB r \fR is the same as \fB E \fR .
338
336
.Sh SELECTION
339
337
.Nm
340
338
allows file selection across directories and contexts!
@@ -379,7 +377,7 @@ There are two ways to search and list:
379
377
.Pp
380
378
- feed a list of file paths as input
381
379
.br
382
- - search using a plugin (e.g. \fI finder \fR ) and list the results
380
+ - search using a plugin (e.g. \fB finder \fR ) and list the results
383
381
.Pp
384
382
File paths must be NUL-separated ('\\0 '). Paths and can be relative to the
385
383
current directory or absolute. Invalid paths in the input are ignored. Input
@@ -413,32 +411,32 @@ A temporary directory will be created containing symlinks to the given
413
411
paths. Any action performed on these symlinks will be performed only on their
414
412
targets, after which they might become invalid.
415
413
.Pp
416
- Right arrow or 'l' on a symlink in the listing dir takes to the target
417
- file. Press '-' to return to the listing dir. Press 'Enter' to open the symlink.
414
+ \fB > \fR or \fB l \fR on a symlink in the listing dir takes to the target
415
+ file. Press \fB - \fR to return to the listing dir. Press \fB Enter \fR to open the symlink.
418
416
.Pp
419
417
Listing input stream can be scripted. It can be extended to pick (option -p)
420
418
selected entries from the listed results.
421
419
.Sh BOOKMARKS
422
420
There are 2 ways (can be used together) to manage bookmarks.
423
421
.Pp
424
- (1) Bookmark keys: See \fB NNN_BMS \fR under \fI ENVIRONMENT \fR section on how to set
422
+ (1) Bookmark keys: See \fB NNN_BMS \fR under \fB ENVIRONMENT \fR section on how to set
425
423
bookmark keys.
426
424
427
- The select bookmark key \fI b \fR lists all the bookmark keys set in \fB NNN_BMS \fR
425
+ The select bookmark key \fB b \fR lists all the bookmark keys set in \fB NNN_BMS \fR
428
426
in the bookmarks prompt.
429
427
.Pp
430
428
(2) Symlinked bookmarks: A symlinked bookmark to the current directory can
431
- be created with the \fI B \fR key (or manually under ~/.config/nnn/bookmarks).
429
+ be created with the \fB B \fR key (or manually under ~/.config/nnn/bookmarks).
432
430
433
- Pressing 'Enter' at the bookmarks prompt takes to this directory.
431
+ Pressing \fB Enter \fR at the bookmarks prompt takes to this directory.
434
432
If \fB NNN_BMS \fR is not set, the select bookmark key directly opens it.
435
433
.Pp
436
434
On entering a bookmark, the directory where the select bookmark key was
437
- pressed is set as the previous directory. Press '-' to return to it.
435
+ pressed is set as the previous directory. Press \fB - \fR to return to it.
438
436
.Pp
439
437
.Sh UNITS
440
438
The minimum file size unit is byte (B). The rest are K, M, G, T, P, E, Z, Y
441
- (powers of 1024), same as the default units in \fI ls \fR .
439
+ (powers of 1024), same as the default units in \fB ls \fR .
442
440
.Sh ENVIRONMENT
443
441
The SHELL, VISUAL (else EDITOR) and PAGER environment variables are
444
442
used. A single combination of arguments is supported for SHELL and PAGER.
@@ -453,25 +451,25 @@ used. A single combination of arguments is supported for SHELL and PAGER.
453
451
.Bd -literal
454
452
export NNN_OPENER=nuke
455
453
456
- NOTE: 'nuke' is a file opener available in the plugin repository.
454
+ NOTE: \fB nuke \fR is a file opener available in the plugin repository.
457
455
.Ed
458
456
.Pp
459
457
\fB NNN_BMS: \fR bookmark string as \fI key_char:location \fR pairs
460
- separated by \fI ; \fR :
458
+ separated by \fB ; \fR :
461
459
.Bd -literal
462
460
export NNN_BMS="d:$HOME/Docs;u:/home/user/Cam Uploads;D:$HOME/Downloads/"
463
461
.Ed
464
462
.Pp
465
- These bookmarks are listed in the help and config screen (key ? ).
463
+ These bookmarks are listed in the help and config screen (key \fB ? \fR ).
466
464
.Pp
467
465
\fB NNN_PLUG: \fR directly executable plugins as \fI key_char:plugin \fR pairs
468
- separated by \fI ; \fR :
466
+ separated by \fB ; \fR :
469
467
.Bd -literal
470
468
export NNN_PLUG='f:finder;o:fzopen;p:mocplay;d:diffs;t:nmount;v:imgview'
471
469
472
470
NOTES:
473
- 1. To run a plugin directly, press \fI ; \fR followed by the key.
474
- 2. Alternatively, combine with \fI Alt \fR (i.e. \fI Alt +key\fR ).
471
+ 1. To run a plugin directly, press \fB ; \fR followed by the key.
472
+ 2. Alternatively, combine with \fB Alt \fR (i.e. \fB Alt +key\fR ).
475
473
3. To skip directory refresh after running a plugin, prefix with \fB - \fR .
476
474
477
475
export NNN_PLUG='p:-plugin'
@@ -533,8 +531,7 @@ separated by \fI;\fR:
533
531
.Bd -literal
534
532
export NNN_ORDER='t:/home/user/Downloads;S:/tmp'
535
533
536
- NOTE: Sort keys can be a/d/e/r/s/t/v (see program option -T).
537
- Capitalize to reverse (except 'r').
534
+ NOTE: Sort keys can be a/d/e/r/s/t/v (refer to the \fB SORTING \fR section).
538
535
Path must be absolute.
539
536
540
537
Timestamps for entries modified/created within 5 minutes are shown in reverse.
@@ -611,7 +608,7 @@ separated by \fI;\fR:
611
608
NOTE: The options must be preceded by "rclone" and max 5 flags are supported.
612
609
.Ed
613
610
.Pp
614
- \fB NNN_TRASH: \fR trash (instead of \fI rm -rf \fR ) files to desktop Trash.
611
+ \fB NNN_TRASH: \fR trash (instead of \fB rm -rf \fR ) files to desktop Trash.
615
612
.Bd -literal
616
613
export NNN_TRASH=cmd
617
614
@@ -660,7 +657,7 @@ separated by \fI;\fR:
660
657
.Bd -literal
661
658
export NNN_MCLICK='^R'
662
659
663
- NOTE: Only the first character is considered if not a \fI Ctrl +key\fR combo.
660
+ NOTE: Only the first character is considered if not a \fB Ctrl +key\fR combo.
664
661
.Ed
665
662
.Pp
666
663
\fB nnn: \fR this is a special variable.
0 commit comments