Skip to content

Commit 489c1c0

Browse files
committed
Update man page
1 parent dfdef9d commit 489c1c0

File tree

1 file changed

+51
-54
lines changed

1 file changed

+51
-54
lines changed

nnn.1

+51-54
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.Dd February 22, 2025
1+
.Dd Aug 26, 2024
22
.Dt NNN 1
33
.Os
44
.Sh NAME
@@ -49,7 +49,7 @@ the base filename.
4949
.Sh KEYBINDS
5050
.Pp
5151
Press
52-
.Ql \&?
52+
.Ql \fB?\fR
5353
in
5454
.Nm
5555
to see the list of keybinds.
@@ -59,7 +59,7 @@ to see the list of keybinds.
5959
supports the following options:
6060
.Pp
6161
.Fl a
62-
auto-setup temporary \fBNNN_FIFO\fR (described in \fIENVIRONMENT\fR section)
62+
auto-setup temporary \fBNNN_FIFO\fR (refer to the \fBENVIRONMENT\fR section)
6363
.Pp
6464
.Fl A
6565
disable directory auto-enter on unique filter match
@@ -71,7 +71,7 @@ supports the following options:
7171
use bsdtar for archives (default: atool)
7272
.Pp
7373
.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)
7575
.Pp
7676
.Fl C
7777
8-color scheme - color directories by context, disable file colors
@@ -131,10 +131,10 @@ supports the following options:
131131
.Pp
132132
.Fl r
133133
show cp, mv progress
134-
(Linux-only, needs \fIadvcpmv\fR; '^T' shows the progress on BSD/macOS)
134+
(Linux-only, needs \fIadvcpmv\fR; \fB^T\fR shows the progress on BSD/macOS)
135135
.Pp
136136
.Fl R
137-
disable rollover at edges (eg. pressing \fIdown\fR while on the last
137+
disable rollover at edges (eg. pressing \fBdown\fR while on the last
138138
entry will no longer move cursor to the first entry and vice\-versa)
139139
.Pp
140140
.Fl "s name"
@@ -147,7 +147,7 @@ supports the following options:
147147
idle timeout in seconds to lock terminal
148148
.Pp
149149
.Fl "T key"
150-
sort order
150+
sort order (refer to the \fBSORTING\fR section)
151151
keys: 'a'pparent disk usage / 'd'isk usage / 'e'xtension / 'r'everse / 's'ize / 't'ime / 'v'ersion
152152
capitalize to reverse (except 'r')
153153
.Pp
@@ -161,8 +161,8 @@ supports the following options:
161161
show version and exit
162162
.Pp
163163
.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)
166166
show xterm title (if non-picker mode)
167167
.Pp
168168
.Fl 0
@@ -176,12 +176,12 @@ There is no configuration file. Associated files are at
176176
.Pa ${XDG_CONFIG_HOME:-$HOME/.config}/nnn/
177177
.Pp
178178
Configuration is done using a few optional (set if you need) environment
179-
variables. See ENVIRONMENT section.
179+
variables. Refer to the \fBENVIRONMENT\fR section.
180180
.Pp
181181
.Nm
182-
uses \fIxdg-open\fR (on Linux), \fIopen(1)\fR (on macOS), \fIcygstart\fR on
183-
(Cygwin) and \fIopen\fR on (Haiku) as the desktop opener. It's also possible
184-
to specify a custom opener. See ENVIRONMENT section.
182+
uses \fBxdg-open\fR (on Linux), \fBopen(1)\fR (on macOS), \fBcygstart\fR on
183+
(Cygwin) and \fBopen\fR on (Haiku) as the desktop opener. It's also possible
184+
to specify a custom opener. Refer to the \fBENVIRONMENT\fR section.
185185
.Sh CONTEXTS
186186
Open multiple locations with 4 contexts. The status is shown in the top left
187187
corner:
@@ -193,7 +193,7 @@ corner:
193193
- rest are inactive
194194
.Pp
195195
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 \fBENVIRONMENT\fR section.
197197
.Sh SESSIONS
198198
Sessions are a way to save and restore states of work. A session stores the
199199
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.
209209
- The "auto session" is used in persistent session mode if no session is active.
210210
.br
211211
- 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).
213213
.Pp
214214
All the session files are located by session name in the directory
215215
.Pp
@@ -237,15 +237,15 @@ Special keys at filter prompt:
237237
-------- + ---------------------------------------
238238
.Ed
239239
.Pp
240-
Special keys at \fBempty filter prompt\fR:
240+
Special keys at \fBempty\fR filter prompt:
241241
.Bd -literal
242242
------ + ---------------------------------------
243243
Key | Function
244244
------ + ---------------------------------------
245245
? | Show help and config screen
246246
/ | Toggle between string and regex
247247
: | Toggle case-sensitivity
248-
^L | Clear filter (\fIif prompt is non-empty\fR)
248+
^L | Clear filter (if prompt is \fBnon-empty\fR)
249249
| OR apply last filter
250250
Bksp | Stay at filter prompt and refresh dir
251251
Del | Stay at filter prompt and refresh dir
@@ -263,11 +263,11 @@ Common regex use cases:
263263
.br
264264
(4) Exclude filenames having 'nnn' (compiled with PCRE lib): '^(?!nnn)'
265265
.Pp
266-
In the \fBtype-to-nav\fR mode directories are opened in filter
266+
In the \fItype-to-nav\fR mode directories are opened in filter
267267
mode, allowing continuous navigation.
268268
.Pp
269-
Additional special keys at \fBempty filter prompt\fR
270-
in \fBtype-to-nav\fR mode:
269+
Additional special keys at \fBempty\fR filter prompt
270+
in \fItype-to-nav\fR mode:
271271
.Bd -literal
272272
------ + ------------------------
273273
Key | Function
@@ -286,14 +286,13 @@ in \fBtype-to-nav\fR mode:
286286
~ | Go HOME
287287
------ + ------------------------
288288
.Ed
289-
.Sh SORT
289+
.Sh SORTING
290290
.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.
293293
.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 \fBt\fR or \fB^T\fR. The following options are available:
297296
.Bl -tag -width 2n
298297
.It Ic a
299298
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.
303302
.It Ic e
304303
extension of the file.
305304
.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).
307306
.It Ic s
308307
size of file, amount of data stored in the file.
309308
.It Ic t
310309
time, this depends on the currently selected time type which can be changed
311-
using the 'T' key.
310+
using the \fBT\fR key.
312311
Options are:
313312
.Bl -tag -compact -width 1n
314313
.It Ic a
@@ -322,19 +321,18 @@ modified, last time the content of the file was changed (default).
322321
version, sorts by filename while treating digit characters numerically.
323322
For example: j1.png, j02.png, j3.png.
324323
.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).
326325
.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).
328327
.El
329328
.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 \fBr\fR) reverses the default order.
332330
By default, time and size sort keys are ordered in descending order, and
333331
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 \fBe\fR option, the entries will be ordered by
335333
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 \fBE\fR would result in descending order of the extensions.
335+
This means that \fBe\fR followed by \fBr\fR is the same as \fBE\fR.
338336
.Sh SELECTION
339337
.Nm
340338
allows file selection across directories and contexts!
@@ -379,7 +377,7 @@ There are two ways to search and list:
379377
.Pp
380378
- feed a list of file paths as input
381379
.br
382-
- search using a plugin (e.g. \fIfinder\fR) and list the results
380+
- search using a plugin (e.g. \fBfinder\fR) and list the results
383381
.Pp
384382
File paths must be NUL-separated ('\\0'). Paths and can be relative to the
385383
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
413411
paths. Any action performed on these symlinks will be performed only on their
414412
targets, after which they might become invalid.
415413
.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 \fBl\fR on a symlink in the listing dir takes to the target
415+
file. Press \fB-\fR to return to the listing dir. Press \fBEnter\fR to open the symlink.
418416
.Pp
419417
Listing input stream can be scripted. It can be extended to pick (option -p)
420418
selected entries from the listed results.
421419
.Sh BOOKMARKS
422420
There are 2 ways (can be used together) to manage bookmarks.
423421
.Pp
424-
(1) Bookmark keys: See \fBNNN_BMS\fR under \fIENVIRONMENT\fR section on how to set
422+
(1) Bookmark keys: See \fBNNN_BMS\fR under \fBENVIRONMENT\fR section on how to set
425423
bookmark keys.
426424

427-
The select bookmark key \fIb\fR lists all the bookmark keys set in \fBNNN_BMS\fR
425+
The select bookmark key \fBb\fR lists all the bookmark keys set in \fBNNN_BMS\fR
428426
in the bookmarks prompt.
429427
.Pp
430428
(2) Symlinked bookmarks: A symlinked bookmark to the current directory can
431-
be created with the \fIB\fR key (or manually under ~/.config/nnn/bookmarks).
429+
be created with the \fBB\fR key (or manually under ~/.config/nnn/bookmarks).
432430

433-
Pressing 'Enter' at the bookmarks prompt takes to this directory.
431+
Pressing \fBEnter\fR at the bookmarks prompt takes to this directory.
434432
If \fBNNN_BMS\fR is not set, the select bookmark key directly opens it.
435433
.Pp
436434
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.
438436
.Pp
439437
.Sh UNITS
440438
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 \fIls\fR.
439+
(powers of 1024), same as the default units in \fBls\fR.
442440
.Sh ENVIRONMENT
443441
The SHELL, VISUAL (else EDITOR) and PAGER environment variables are
444442
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.
453451
.Bd -literal
454452
export NNN_OPENER=nuke
455453

456-
NOTE: 'nuke' is a file opener available in the plugin repository.
454+
NOTE: \fBnuke\fR is a file opener available in the plugin repository.
457455
.Ed
458456
.Pp
459457
\fBNNN_BMS:\fR bookmark string as \fIkey_char:location\fR pairs
460-
separated by \fI;\fR:
458+
separated by \fB;\fR:
461459
.Bd -literal
462460
export NNN_BMS="d:$HOME/Docs;u:/home/user/Cam Uploads;D:$HOME/Downloads/"
463461
.Ed
464462
.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).
466464
.Pp
467465
\fBNNN_PLUG:\fR directly executable plugins as \fIkey_char:plugin\fR pairs
468-
separated by \fI;\fR:
466+
separated by \fB;\fR:
469467
.Bd -literal
470468
export NNN_PLUG='f:finder;o:fzopen;p:mocplay;d:diffs;t:nmount;v:imgview'
471469

472470
NOTES:
473-
1. To run a plugin directly, press \fI;\fR followed by the key.
474-
2. Alternatively, combine with \fIAlt\fR (i.e. \fIAlt+key\fR).
471+
1. To run a plugin directly, press \fB;\fR followed by the key.
472+
2. Alternatively, combine with \fBAlt\fR (i.e. \fBAlt+key\fR).
475473
3. To skip directory refresh after running a plugin, prefix with \fB-\fR.
476474

477475
export NNN_PLUG='p:-plugin'
@@ -533,8 +531,7 @@ separated by \fI;\fR:
533531
.Bd -literal
534532
export NNN_ORDER='t:/home/user/Downloads;S:/tmp'
535533

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 \fBSORTING\fR section).
538535
Path must be absolute.
539536

540537
Timestamps for entries modified/created within 5 minutes are shown in reverse.
@@ -611,7 +608,7 @@ separated by \fI;\fR:
611608
NOTE: The options must be preceded by "rclone" and max 5 flags are supported.
612609
.Ed
613610
.Pp
614-
\fBNNN_TRASH:\fR trash (instead of \fIrm -rf\fR) files to desktop Trash.
611+
\fBNNN_TRASH:\fR trash (instead of \fBrm -rf\fR) files to desktop Trash.
615612
.Bd -literal
616613
export NNN_TRASH=cmd
617614

@@ -660,7 +657,7 @@ separated by \fI;\fR:
660657
.Bd -literal
661658
export NNN_MCLICK='^R'
662659

663-
NOTE: Only the first character is considered if not a \fICtrl+key\fR combo.
660+
NOTE: Only the first character is considered if not a \fBCtrl+key\fR combo.
664661
.Ed
665662
.Pp
666663
\fBnnn:\fR this is a special variable.

0 commit comments

Comments
 (0)