- [Usage](#usage)
- [Cmdline options](#cmdline-options)
- [Keyboard shortcuts](#keyboard-shortcuts)
- - [Key prompt](#key-prompt)
+ - [Leader key](#leader-key)
- [Contexts](#contexts)
- [Filters](#filters)
- [Navigate-as-you-type mode](#navigate-as-you-type-mode)
- Familiar, easy shortcuts (arrows, `~`, `-`, `&`)
- *Navigate-as-you-type* with auto-select directory
- Contexts (_aka_ tabs _aka_ workspaces)
- - Bookmarks, pin and visit directory
+ - Bookmarks
+ - Pin and visit a directory
- Sorting
- Directories always listed on top
- Sort by file name, modification time, size
- Select multiple files; copy, move, delete selection
- Batch rename/move/delete (needs vidir)
- Show directories in custom color (default: blue)
- - Spawn SHELL in the current directory
+ - Spawn a subshell in the current directory
- Run custom scripts in the current directory
- Change directory at exit (*easy* shell integration)
- Edit file in EDITOR or open in PAGER
→, ↵, l, ^M Open file/enter dir . Toggle show hidden
/ Filter Ins, ^I Toggle nav-as-you-type
b Pin current dir ^V Go to pinned dir
- ^B Key prompt ^L Redraw, clear prompt
- Esc Exit prompt ^Bn Switch to context n
+ ^B Leader key LeaderN Switch to context N
+ Esc Exit prompt ^L Redraw, clear prompt
^G Quit and cd q Quit context
Q, ^Q Quit ? Help, settings
FILES
Help & settings, file details, media info and archive listing are shown in the PAGER. Please use the PAGER-specific keys in these screens.
-#### Key prompt
+#### Leader key
-The key prompt, invoked by <kbd>^B</kbd>, provides a powerful multi-functional navigation mechanism. It is case-sensitive and understands contexts, bookmarks and handy location shortcuts.
+The Leader key <kbd>^B</kbd> provides a powerful multi-functional navigation mechanism. It is case-sensitive and understands contexts, bookmarks and handy location shortcuts.
| Key | Function |
|:---:| --- |
| <kbd>&</kbd> | Go to start directory |
| <kbd>q</kbd> | Quit context |
-If all the configured bookmark keys are single character, the prompt is not shown and <kbd>Enter</kbd> is not required; just press <kbd>^B</kbd> followed by the key (like the vim Leader key).
-
#### Contexts
Contexts serve the purpose of exploring multiple directories simultaneously. 4 contexts are available. The status of the contexts are shown in the top left corner:
#### add bookmarks
-Set environment variable `NNN_BMS` as a string of `key:location` pairs (max 10) separated by semicolons (`;`):
+Set environment variable `NNN_BMS` as a string of `key_char:location` pairs (max 10) separated by semicolons (`;`):
+
+ export NNN_BMS='d:~/Documents;u:/home/user/Cam Uploads;D:~/Downloads/'
- export NNN_BMS='doc:~/Documents;u:/home/user/Cam Uploads;D:~/Downloads/'
+NOTE: Bookmark keys should be single-character to use them in combination with the Leader key.
#### copy file paths
.It Ic ^V
Visit pinned directory
.It Ic ^B
-Show key prompt (recognizes bookmark keys, ~, -, & and context IDs)
-.It Ic ^L
-Force a redraw, clear prompt
+Leader key
+.It Ic LeaderN
+Switch to context N
.It Ic Esc
Exit prompt
-.It Ic ^Bn
-Switch to context n
+.It Ic ^L
+Force a redraw, clear prompt
.It Ic q
Quit the current context
.It Ic ^G
The SHELL, EDITOR (VISUAL, if defined) 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
+\fBNNN_BMS:\fR bookmark string as \fIkey_char:location\fR pairs (max 10) separated by
\fI;\fR:
.Bd -literal
- export NNN_BMS='doc:~/Documents;u:/home/user/Cam Uploads;D:~/Downloads/'
+ export NNN_BMS='d:~/Documents;u:/home/user/Cam Uploads;D:~/Downloads/'
+
+ NOTE: Bookmark keys should be single-character to use them in combination with the Leader key.
.Ed
.Pp
\fBNNN_USE_EDITOR:\fR use EDITOR (preferably CLI, fallback vi) to handle text
IFS=
echo -n $1 | xsel --clipboard --input
-------------------------------------
+
+ If it's not set, by default file paths are copied to the tmp file \fBDIR/.nnncp\fR, where 'DIR' (by priority) is: \fI$HOME\fR or, \fI$TMPDIR\fR or, \fI/tmp\fR.
.Ed
-.br
-If it's not set, by default file paths are copied to the tmp file \fBDIR/.nnncp\fR, where 'DIR' (by priority) is: \fI$HOME\fR or, \fI$TMPDIR\fR or, \fI/tmp\fR.
.Pp
\fBNNN_QUOTE_ON:\fR wrap copied paths within single quotes. Useful for pasting
names in the shell. Note that the filename is not escaped. So copying may still fail
uint quote : 1; /* Copy paths within quotes */
uint color : 3; /* Color code for directories */
uint ctxactive : 1; /* Context active or not */
- uint reserved : 12;
+ uint reserved : 13;
/* The following settings are global */
uint curctx : 2; /* Current context number */
- uint char_key : 1; /* All keys are single character long */
} settings;
/* Contexts or workspaces */
/* GLOBALS */
/* Configuration, contexts */
-static settings cfg = {0, 0, 0, 0, 0, 0, 0, 1, 1, 1, 0, 0, 0, 4, 1, 0, 0, 1};
+static settings cfg = {0, 0, 0, 0, 0, 0, 0, 1, 1, 1, 0, 0, 0, 4, 1, 0, 0};
static context g_ctx[MAX_CTX] __attribute__ ((aligned));
static struct entry *dents;
return (xstrlcpy(out + len, name, n - len) + len);
}
-static void parsebmstr()
+static int parsebmstr()
{
int i = 0;
char *bms = getenv("NNN_BMS");
if (!bms)
- return;
+ return 0;
while (*bms && i < BM_MAX) {
bookmark[i].key = bms;
while (*bms && *bms != ':') {
++bms;
- if (cfg.char_key)
- cfg.char_key = 0;
+ /*
+ * Use single-char keys to use ^B like vim Leader key.
+ * Fail here to ensure keys are single char.
+ * To support multiple char keys remove the return
+ * and add appropriate check to enable smart-detect.
+ */
+ return -1;
}
if (!*bms) {
++bms;
++i;
}
+
+ return 0;
}
/*
"4→, ↵, l, ^M Open file/enter dir . Toggle show hidden\n"
"e/ Filter Ins, ^I Toggle nav-as-you-type\n"
"eb Pin current dir ^V Go to pinned dir\n"
- "d^B Key prompt ^L Redraw, clear prompt\n"
- "cEsc Exit prompt ^Bn Switch to context n\n"
+ "d^B Leader key LeaderN Switch to context N\n"
+ "cEsc Exit prompt ^L Redraw, clear prompt\n"
"d^G Quit and cd q Quit context\n"
"aQ, ^Q Quit ? Help, settings\n"
"1FILES\n"
DPRINTF_S(path);
setdirwatch();
goto begin;
- case SEL_CDBM:
- tmp = xreadline(NULL, "key: ", cfg.char_key);
+ case SEL_LEADER:
+ tmp = xreadline(NULL, "key: ", TRUE);
if (tmp == NULL || tmp[0] == '\0')
break;
}
/* Parse bookmarks string */
- parsebmstr();
+ if (parsebmstr() < 0) {
+ fprintf(stderr, "ERROR parsing NNN_BMS: set single-char bookmark keys only\n");
+ exit(1);
+ }
if (ipath) { /* Open a bookmark directly */
if (get_bm_loc(ipath, cwd) == NULL) {
SEL_CDHOME,
SEL_CDBEGIN,
SEL_CDLAST,
- SEL_CDBM,
+ SEL_LEADER,
SEL_PIN,
SEL_VISIT,
SEL_FLTR,
{ '&', SEL_CDBEGIN, "", "" },
/* Last visited dir */
{ '-', SEL_CDLAST, "", "" },
- /* Change dir using bookmark */
- { CONTROL('B'), SEL_CDBM, "", "" },
+ /* Leader key */
+ { CONTROL('B'), SEL_LEADER, "", "" },
/* Mark a path to visit later */
{ 'b', SEL_PIN, "", "" },
/* Visit marked directory */