nnn/README.md

409 lines
19 KiB
Markdown
Raw Normal View History

2019-08-13 17:12:26 +00:00
<h1 align="center">nnn - <i>type less, do more, way faster</i></h1>
2016-08-20 16:27:14 +00:00
2017-04-14 17:46:01 +00:00
<p align="center">
<a href="https://github.com/jarun/nnn/releases/latest"><img src="https://img.shields.io/github/release/jarun/nnn.svg?maxAge=600" alt="Latest release" /></a>
<a href="http://formulae.brew.sh/formula/nnn"><img src="https://img.shields.io/homebrew/v/nnn.svg?maxAge=600" alt="Homebrew" /></a>
2018-11-03 06:00:21 +00:00
<a href="https://www.archlinux.org/packages/community/x86_64/nnn/"><img src="https://img.shields.io/badge/archlinux-rolling-blue.svg?maxAge=600" alt="Arch Linux" /></a>
2017-11-24 23:18:32 +00:00
<a href="https://packages.debian.org/search?keywords=nnn&searchon=names&exact=1"><img src="https://img.shields.io/badge/debian-10+-blue.svg?maxAge=2592000" alt="Debian Buster+" /></a>
2018-03-18 09:29:42 +00:00
<a href="https://apps.fedoraproject.org/packages/nnn"><img src="https://img.shields.io/badge/fedora-27+-blue.svg?maxAge=2592000" alt="Fedora 27+" /></a>
2018-02-28 11:09:23 +00:00
<a href="https://software.opensuse.org/package/nnn"><img src="https://img.shields.io/badge/opensuse%20leap-15.0+-blue.svg?maxAge=2592000" alt="openSUSE Leap 15.0+" /></a>
2017-11-24 23:18:32 +00:00
<a href="https://packages.ubuntu.com/search?keywords=nnn&searchon=names&exact=1"><img src="https://img.shields.io/badge/ubuntu-17.10+-blue.svg?maxAge=2592000" alt="Ubuntu Artful+" /></a>
2018-03-18 09:29:42 +00:00
</p>
<p align="center">
2019-01-28 19:05:37 +00:00
<a href="https://repology.org/metapackage/nnn"><img src="https://repology.org/badge/tiny-repos/nnn.svg" alt="Availability"></a>
2019-04-13 08:54:59 +00:00
<a href="https://travis-ci.org/jarun/nnn"><img src="https://img.shields.io/travis/jarun/nnn/master.svg?label=travis" alt="Travis Status" /></a>
<a href="https://circleci.com/gh/jarun/workflows/nnn"><img src="https://img.shields.io/circleci/project/github/jarun/nnn.svg?label=circleci" alt="CircleCI Status" /></a>
2017-04-14 17:46:01 +00:00
<a href="https://github.com/jarun/nnn/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-BSD%202--Clause-yellow.svg?maxAge=2592000" alt="License" /></a>
</p>
2017-04-06 00:57:16 +00:00
2017-12-09 06:34:32 +00:00
<p align="center">
2019-07-29 23:27:59 +00:00
<a href="https://www.youtube.com/watch?v=U2n5aGqou9E"><img src="https://i.imgur.com/onpq3vP.png" /></a>
2017-12-09 06:34:32 +00:00
</p>
2019-07-29 23:27:59 +00:00
<p align="center"><i>Modes of nnn (light with filter, detail, du analyzer) with memory usage (click for a demo video)</i></a></p>
2019-05-22 23:24:38 +00:00
2019-08-17 06:29:39 +00:00
## Index
2016-08-20 16:27:14 +00:00
2019-07-29 23:27:59 +00:00
- [Introduction](#introduction)
2017-04-21 03:30:46 +00:00
- [Features](#features)
2017-03-29 05:33:22 +00:00
- [Installation](#installation)
2019-02-10 03:15:13 +00:00
- [Library dependencies](#library-dependencies)
- [Utility dependencies](#utility-dependencies)
2017-08-14 00:13:01 +00:00
- [From a package manager](#from-a-package-manager)
2017-08-13 14:50:37 +00:00
- [Release packages](#release-packages)
2017-08-14 00:13:01 +00:00
- [From source](#from-source)
2018-11-13 03:51:21 +00:00
- [Shell completion](#shell-completion)
2017-03-29 05:33:22 +00:00
- [Usage](#usage)
2019-06-21 02:02:07 +00:00
- [Configuration](#configuration)
2017-04-14 18:44:25 +00:00
- [Cmdline options](#cmdline-options)
2019-05-18 05:25:17 +00:00
- [Keyboard and mouse](#keyboard-and-mouse)
- [Leader key](#leader-key)
2019-08-10 16:34:09 +00:00
- [Help](#help)
2019-08-09 04:58:14 +00:00
- [Concepts](#concepts)
2018-11-08 12:59:38 +00:00
- [Contexts](#contexts)
2019-01-16 15:11:43 +00:00
- [Context-specific color](#context-specific-color)
2019-08-09 04:58:14 +00:00
- [Dual pane](#dual-pane)
- [Selection](#selection)
2017-04-14 18:44:25 +00:00
- [Filters](#filters)
2019-01-19 12:02:43 +00:00
- [Navigate-as-you-type](#navigate-as-you-type)
2018-07-12 14:28:53 +00:00
- [File indicators](#file-indicators)
2017-04-25 16:54:47 +00:00
- [Mentions](#mentions)
2017-04-15 01:21:10 +00:00
- [Developers](#developers)
2016-08-21 12:07:18 +00:00
2019-08-09 04:58:14 +00:00
## Introduction
2019-07-29 23:27:59 +00:00
2019-08-17 06:29:39 +00:00
`nnn` is a full-featured terminal file manager. It's extremely light and fast (**[performance](https://github.com/jarun/nnn/wiki/Performance)**).
2019-07-29 23:27:59 +00:00
`nnn` is also a disk usage analyzer, a fuzzy app launcher, a batch file renamer and a file picker.
2019-08-17 06:29:39 +00:00
It runs smoothly on the Raspberry Pi, Termux on Android ([demo video](https://www.youtube.com/watch?v=AbaauM7gUJw)), Linux, macOS, BSD, Cygwin and Linux subsystem for Windows. `nnn` works seamlessly with DEs and GUI utilities. It's nearly zero-config (with sensible defaults) and can be setup in less than 5 minutes.
2019-07-29 23:27:59 +00:00
2019-08-17 06:29:39 +00:00
**[Plugins](https://github.com/jarun/nnn/tree/master/plugins)** can be run with custom keybinds. There's an independent [(neo)vim plugin](https://github.com/mcchrish/nnn.vim). Custom plugins are easy to add.
2019-07-29 23:27:59 +00:00
2019-08-17 06:29:39 +00:00
Visit the **[Wiki](https://github.com/jarun/nnn/wiki)** for how tos, use cases, chronology and insights.
2019-07-29 23:27:59 +00:00
2019-08-09 04:58:14 +00:00
## Features
2017-04-21 03:30:46 +00:00
2018-11-11 17:50:16 +00:00
- Modes
2019-03-22 23:27:21 +00:00
- Detail (default), light
- Disk usage analyzer (block/apparent)
2019-03-24 16:31:15 +00:00
- File picker, (neo)vim plugin
2017-05-15 16:59:40 +00:00
- Navigation
2019-08-20 14:30:48 +00:00
- *Navigate-as-you-type* with dir auto-select
2019-04-30 03:06:55 +00:00
- 4 contexts (_aka_ tabs/workspaces)
2019-03-14 15:16:57 +00:00
- Bookmarks; pin and visit a directory
2019-03-12 14:05:24 +00:00
- Familiar, easy shortcuts (arrows, <kbd>~</kbd>, <kbd>-</kbd>, <kbd>@</kbd>)
2019-08-19 17:51:34 +00:00
- Change directory at exit (*easy* shell integration)
2018-03-18 10:48:30 +00:00
- Sorting
2019-07-14 17:30:14 +00:00
- Ordered pure numeric names by default (visit _/proc_)
- Case-insensitive version (_aka_ natural) sort
2019-08-01 16:50:40 +00:00
- Sort by file name, modification time, size, file extension
2017-05-15 16:59:40 +00:00
- Search
2018-11-11 17:50:16 +00:00
- Instant filtering with *search-as-you-type*
2019-01-19 07:43:54 +00:00
- Regex and substring match
2019-04-27 12:45:18 +00:00
- Subtree search to open or edit files (using plugin)
2017-05-15 16:59:40 +00:00
- Mimes
2018-11-11 17:50:16 +00:00
- Open with desktop opener or specify a custom app
2019-07-27 11:14:03 +00:00
- Create, list, extract archives
2019-04-30 03:06:55 +00:00
- Option to open all text files in EDITOR
2017-05-15 16:59:40 +00:00
- Information
2019-04-30 03:06:55 +00:00
- Detailed file information
2018-11-11 17:50:16 +00:00
- Media information (needs mediainfo/exiftool)
2017-05-15 16:59:40 +00:00
- Convenience
2019-08-17 06:29:39 +00:00
- Minimal configuration
- Plugin keybinds
2019-01-29 21:28:42 +00:00
- Select files across dirs; all/range selection
2019-03-14 15:16:57 +00:00
- Copy, move, delete, archive, link selection
2019-06-05 15:11:54 +00:00
- Batch rename selection or dir entries
2019-03-09 03:35:32 +00:00
- FreeDesktop compliant trash (needs trash-cli)
2019-04-20 18:54:19 +00:00
- SSHFS mounts (needs sshfs)
2019-08-04 02:02:37 +00:00
- Create, rename, duplicate files and directories
2019-03-16 00:57:05 +00:00
- Per-context directory color (default: blue)
2019-08-19 17:51:34 +00:00
- Spawn a shell, run apps, run commands, execute file
- Take quick notes, lock terminal (needs a locker)
2019-01-30 02:55:02 +00:00
- Shortcut reference a keypress away
2017-05-11 16:55:22 +00:00
- Unicode support
2019-02-23 09:33:22 +00:00
- Follows Linux kernel coding style
2018-11-13 03:51:21 +00:00
- Highly optimized, static analysis integrated code
2019-03-16 00:57:05 +00:00
- Minimal library dependencies
2019-08-19 17:51:34 +00:00
- Widely available
2017-03-29 05:33:22 +00:00
2019-08-09 04:58:14 +00:00
## Installation
2017-03-29 05:33:22 +00:00
2019-02-10 03:15:13 +00:00
#### Library dependencies
2017-08-14 00:13:01 +00:00
2019-02-22 00:05:26 +00:00
`nnn` needs a curses library with wide character support (like ncursesw), libreadline and standard libc. It's possible to drop libreadline using the Makefile target `norl`.
2016-08-20 16:27:14 +00:00
2019-02-10 03:15:13 +00:00
#### Utility dependencies
2019-06-14 03:22:17 +00:00
| Dependency | Installation | Operation |
| --- | --- | --- |
| xdg-open (Linux), open(1) (macOS), cygstart (Cygwin) | base | desktop opener |
| file, coreutils (cp, mv, rm), findutils (xargs) | base | file type, copy, move and remove |
2019-07-27 11:14:03 +00:00
| tar, (un)zip [atool/bsdtar for more formats] | base | create, list, extract tar, gzip, bzip2, zip |
2019-06-14 03:22:17 +00:00
| mediainfo / exiftool | if needed | multimedia file details |
| sshfs, fusermount(3) | if needed | mount, unmount over SSHFS |
2019-06-16 17:08:45 +00:00
| trash-cli | optional | trash files (default action: delete) |
| vlock (Linux), bashlock (macOS), lock(1) (BSD) | optional | terminal locker (fallback: [cmatrix](https://github.com/abishekvashok/cmatrix)) |
2019-08-09 04:58:14 +00:00
| advcpmv (Linux) ([integration](https://github.com/jarun/nnn/wiki#show-cp-mv-progress)) | optional | copy, move progress |
2019-06-14 03:22:17 +00:00
| `$VISUAL` (else `$EDITOR`), `$PAGER`, `$SHELL` | optional | fallback vi, less, sh |
2019-02-10 03:15:13 +00:00
2017-08-14 00:13:01 +00:00
#### From a package manager
2016-08-20 16:27:14 +00:00
2019-08-17 06:29:39 +00:00
`nnn` may be available in the default repos of your distro already. Find a list of known packagers below.
2019-07-31 18:01:37 +00:00
2019-08-20 03:17:48 +00:00
<details><summary>Expand</summary>
<p>
<br>
<a href="https://pkgs.alpinelinux.org/packages?name=nnn">Alpine Linux</a> (<code>apk add nnn</code>)<br>
<a href="https://www.archlinux.org/packages/community/x86_64/nnn/">Arch Linux</a> (<code>pacman -S nnn</code>)<br>
● CentOS (<code>yum --enablerepo=epel install nnn</code>)<br>
<a href="https://crux.nu/portdb/?a=search&q=nnn">CRUX</a> (<code>prt-get depinst nnn</code>)<br>
<a href="https://packages.debian.org/search?keywords=nnn&searchon=names&exact=1">Debian</a> (<code>apt-get install nnn</code>)<br>
<a href="https://github.com/DragonFlyBSD/DPorts/tree/master/misc/nnn">DPorts</a> (<code>pkg install nnn</code>)<br>
<a href="https://apps.fedoraproject.org/packages/nnn">Fedora</a> (<code>dnf install nnn</code>)<br>
<a href="https://svnweb.freebsd.org/ports/head/misc/nnn/">FreeBDS</a> (<code>pkg install nnn</code>)<br>
<a href="https://packages.gentoo.org/packages/app-misc/nnn">Gentoo</a> (<code>emerge nnn</code>)<br>
<a href="http://formulae.brew.sh/formula/nnn">macOS/Homebrew</a> (<code>brew install nnn</code>)<br>
<a href="https://www.macports.org/ports.php?by=name&substr=nnn">MacPorts</a> (<code>port install nnn</code>)<br>
<a href="https://notabug.org/milislinux/milis/src/master/talimatname/genel/n/nnn/talimat">Milis Linux</a> (<code>mps kur nnn</code>)<br>
<a href="https://github.com/NixOS/nixpkgs/tree/master/pkgs/applications/misc/nnn">nixpkgs</a> (<code>nix-env -i nnn</code>)<br>
<a href="https://www.nutyx.org/en/?type=pkg&branch=rolling&arch=x86_64&searchpkg=nnn">NuTyX</a> (<code>cards install nnn</code>)<br>
<a href="https://cvsweb.openbsd.org/cgi-bin/cvsweb/ports/sysutils/nnn/">OpenBSD</a> (<code>pkg_add nnn</code>)<br>
<a href="https://software.opensuse.org/package/nnn">openSUSE (and packages for several other distros)</a> (<code>zypper in nnn</code>)<br>
<a href="http://pkgsrc.se/sysutils/nnn">pkgsrc</a> (<code>pkg_add nnn</code>)<br>
<a href="https://archive.raspbian.org/raspbian/pool/main/n/nnn/">Raspbian Testing</a> (<code>apt-get install nnn</code>)<br>
<a href="http://slackbuilds.org/repository/14.2/system/nnn/">Slackware</a> (<code>slackpkg install nnn</code>)<br>
<a href="http://cook.slitaz.org/index.cgi?pkg=nnn">SliTaz Cooking</a> (<code>cooker pkg nnn</code>)<br>
<a href="https://packages.getsol.us/shannon/n/nnn/">Solus</a> (<code>eopkg install nnn</code>)<br>
<a href="http://codex.sourcemage.org/test/shell-term-fm/nnn/">Source Mage</a> (<code>cast nnn</code>)<br>
<a href="https://github.com/termux/termux-packages/tree/master/packages/nnn">Termux</a> (<code>pkg in nnn</code>)<br>
<a href="https://packages.ubuntu.com/search?keywords=nnn&searchon=names&exact=1">Ubuntu</a> (<code>apt-get install nnn</code>)<br>
<a href="https://github.com/void-linux/void-packages/tree/master/srcpkgs/nnn">Void Linux</a> (<code>xbps-install -S nnn</code>)<br>
</p>
</details>
2019-01-11 09:01:33 +00:00
2017-08-13 14:50:37 +00:00
#### Release packages
2019-03-03 18:54:35 +00:00
Packages for Arch Linux, CentOS, Debian, Fedora and Ubuntu are available with the [latest stable release](https://github.com/jarun/nnn/releases/latest).
2017-08-13 14:50:37 +00:00
2017-08-14 00:13:01 +00:00
#### From source
To cook yourself, download the [latest stable release](https://github.com/jarun/nnn/releases/latest) or clone this repository (*risky*). Then install the dependencies and compile (e.g. on Ubuntu 16.04):
2019-01-24 06:35:13 +00:00
$ sudo apt-get install pkg-config libncursesw5-dev libreadline6-dev
2017-10-02 02:43:36 +00:00
$ make
2019-06-19 16:33:08 +00:00
$ sudo make strip install
2017-08-14 00:13:01 +00:00
`PREFIX` is supported, in case you want to install to a different location.
2019-08-17 06:29:39 +00:00
- Compilation notes on [Raspberry Pi](https://github.com/jarun/nnn/wiki/Compile-for-Pi)
- Instructions for [Cygwin](https://github.com/jarun/nnn/wiki/Compile-on-Cygwin)
2018-12-01 16:15:45 +00:00
2018-11-13 03:51:21 +00:00
#### Shell completion
2017-09-02 06:53:19 +00:00
2019-06-16 16:51:13 +00:00
Option completion scripts for Bash, Fish and Zsh can be found in respective subdirectories of [`misc/auto-completion/`](misc/auto-completion). Please refer to your shell's manual for installation instructions.
2017-09-02 06:53:19 +00:00
2019-08-09 04:58:14 +00:00
## Usage
2016-08-20 16:27:14 +00:00
2019-06-21 02:02:07 +00:00
#### Configuration
`nnn` supports the following environment variables for configuration. All of them are optional (set if you need). There is no config file. Any associated files are stored under `${XDG_CONFIG_HOME:-$HOME/.config}/nnn/`.
| Example `export` | Description |
| --- | --- |
| `NNN_BMS='d:~/Documents;D:~/Docs archive/'` | key-bookmark pairs [max 10] |
| `NNN_PLUG='o:fzy-open;p:mocplay;m:nmount;t:thumb'` | key-plugin pairs (<kbd>x-key</kbd> to run) [max 10] |
2019-06-21 02:02:07 +00:00
| `NNN_USE_EDITOR=1` | open text files in `$VISUAL` (else `$EDITOR`, fallback vi) |
| `NNN_CONTEXT_COLORS='1234'` | specify per context color [default: '4444' (all blue)] |
2019-06-24 16:15:02 +00:00
| `NNN_SSHFS_OPTS='sshfs -o reconnect,idmap=user'` | specify SSHFS options |
2019-08-07 16:49:34 +00:00
| `NNN_NOTE='/home/user/Dropbox/notes'` | absolute path to note file [default: none] |
2019-06-21 02:02:07 +00:00
| `NNN_OPENER=mimeopen` | custom file opener |
| `NNN_IDLE_TIMEOUT=300` | idle seconds before locking terminal [default: disabled] |
2019-08-07 16:49:34 +00:00
| `NNN_COPIER=copier` | clipboard copier script [default: none] |
2019-06-21 02:02:07 +00:00
| `NNN_TRASH=1` | trash files to the desktop Trash [default: delete] |
2019-08-19 17:51:34 +00:00
| `NNN_OPS_PROG=1` | show cp, mv progress on Linux (needs advcpmv) |
2019-06-21 02:02:07 +00:00
2017-04-14 18:44:25 +00:00
#### Cmdline options
2016-08-21 10:32:03 +00:00
2017-10-02 02:43:36 +00:00
```
usage: nnn [-b key] [-d] [-e] [-H] [-i] [-n] [-o]
2019-08-20 14:30:48 +00:00
[-p file] [-s] [-S] [-t] [-v] [-h] [PATH]
2017-10-02 02:43:36 +00:00
2018-08-06 23:22:39 +00:00
The missing terminal file manager for X.
2017-10-02 02:43:36 +00:00
2018-08-16 15:05:57 +00:00
positional args:
2017-12-24 13:16:56 +00:00
PATH start dir [default: current dir]
2017-10-02 02:43:36 +00:00
2018-08-16 15:05:57 +00:00
optional args:
2019-01-17 15:29:30 +00:00
-b key open bookmark key
-d detail mode
2019-01-17 15:29:30 +00:00
-e use exiftool for media info
-H show hidden files
2019-01-17 15:29:30 +00:00
-i nav-as-you-type mode
2019-07-14 17:30:14 +00:00
-n version sort
-o press Enter to open files
2019-01-17 15:29:30 +00:00
-p file selection file (stdout if '-')
2019-02-05 19:08:55 +00:00
-s string filters [default: regex]
2019-02-22 19:32:05 +00:00
-S du mode
2019-08-16 18:37:38 +00:00
-t disable dir auto-select
2019-01-17 15:29:30 +00:00
-v show version
-h show help
2017-10-02 02:43:36 +00:00
```
2017-04-01 05:18:18 +00:00
2019-05-18 05:25:17 +00:00
#### Keyboard and mouse
2016-08-21 10:32:03 +00:00
2018-11-11 10:52:58 +00:00
Press <kbd>?</kbd> in `nnn` to see the list anytime.
2019-04-26 13:22:54 +00:00
```
NAVIGATION
↑ k Up PgUp ^U Scroll up
↓ j Down PgDn ^D Scroll down
← h Parent dir ~ ` @ - HOME, /, start, last
↵ → l Open file/dir . Toggle show hidden
2019-08-07 16:15:32 +00:00
g ^A First entry G ^E Last entry
2019-04-26 13:22:54 +00:00
b Pin current dir ^B Go to pinned dir
Tab ^I Next context d Toggle detail view
2019-08-07 16:15:32 +00:00
, ^/ Lead key N LeadN Context N
2019-08-04 08:57:35 +00:00
/ Filter/Lead Ins ^T Toggle nav-as-you-type
2019-04-26 13:22:54 +00:00
Esc Exit prompt ^L Redraw/clear prompt
2019-08-07 16:15:32 +00:00
q Quit context Lead' First file
Q ^Q Quit ^G QuitCD ? Help, config
2019-04-26 13:22:54 +00:00
FILES
^O Open with... n Create new/link
2019-08-04 02:02:37 +00:00
D File details ^R Rename/duplicate
2019-04-26 13:22:54 +00:00
⎵ ^K / Y Select entry/all r Batch rename
K ^Y Toggle selection y List selection
P Copy selection X Delete selection
V Move selection ^X Delete entry
f Create archive m M Brief/full mediainfo
^F Extract archive F List archive
e Edit in EDITOR p Open in PAGER
ORDER TOGGLES
2019-08-20 14:30:48 +00:00
^J du S Apparent du
s Size E Extn t Time modified
2019-04-26 13:22:54 +00:00
MISC
! ^] Shell L Lock C Execute entry
R ^V Pick plugin xK Run plugin key K
2019-04-26 13:22:54 +00:00
c SSHFS mount u Unmount
^P Prompt ^N Note = Launcher
```
2019-04-21 02:58:58 +00:00
Note: Help & settings, file details, media info and archive listing are shown in the PAGER. Use the PAGER-specific keys in these screens.
2019-05-18 05:25:17 +00:00
| Mouse click | Function |
|---| --- |
| Left single on context number | Visit context |
| Left single on top row after context numbers | Visit parent |
| Left single/double on last 2 rows | Toggle nav-as-you-type |
2019-05-18 05:25:17 +00:00
| Left single | Select context or entry |
| Left double | Select context or open entry |
2019-05-18 05:25:17 +00:00
##### Leader key
2018-11-08 22:57:42 +00:00
2019-08-05 02:06:56 +00:00
The Leader/Lead key provides a powerful multi-functional navigation mechanism. It is case-sensitive and understands contexts, bookmarks and location shortcuts.
2018-11-08 22:57:42 +00:00
| Key | Function |
|:---:| --- |
2018-12-03 03:48:51 +00:00
| <kbd>1-4</kbd> | Go to/create selected context |
2018-11-08 22:57:42 +00:00
| <kbd>></kbd>, <kbd>.</kbd> | Go to next active context |
| <kbd><</kbd>, <kbd>,</kbd> | Go to previous active context |
| key | Go to bookmarked location |
2019-08-07 14:17:17 +00:00
| <kbd>'</kbd> | Go to first file in directory |
2019-04-13 03:00:32 +00:00
| <kbd>~</kbd> <kbd>`</kbd> <kbd>@</kbd> <kbd>-</kbd> | Go to HOME, `/`, start, last visited dir |
2018-11-09 04:21:29 +00:00
| <kbd>q</kbd> | Quit context |
2018-11-08 22:57:42 +00:00
2019-08-04 08:57:35 +00:00
When the filter is on, <kbd>/</kbd> works as an additional Leader key.
2019-08-10 16:34:09 +00:00
#### Help
$ nnn -h
$ man nnn
To lookup keyboard shortcuts at runtime, press <kbd>?</kbd>.
2019-08-09 04:58:14 +00:00
## Concepts
2018-11-08 12:59:38 +00:00
#### Contexts
2018-11-11 17:50:16 +00:00
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:
2018-11-08 12:59:38 +00:00
- the current context is in reverse
2019-03-23 14:14:07 +00:00
- other active contexts are underlined
- rest are inactive
2018-11-08 12:59:38 +00:00
2018-11-11 22:06:37 +00:00
To switch to a context press the Leader key followed by the context number (1-4).
2019-02-27 20:37:16 +00:00
The first time a context is entered, it copies the state of the last visited context. Each context remembers its last visited directory.
2018-11-08 12:59:38 +00:00
2018-11-08 14:46:08 +00:00
When a context is quit, the next active context is selected. If the last active context is quit, the program quits.
2019-01-16 15:11:43 +00:00
##### Context-specific color
2018-12-03 16:14:33 +00:00
2019-03-23 14:14:07 +00:00
Each context can have its own directory color specified:
2018-12-03 16:14:33 +00:00
2019-01-19 09:08:47 +00:00
export NNN_CONTEXT_COLORS='1234'
2018-12-03 16:14:33 +00:00
colors: 0-black, 1-red, 2-green, 3-yellow, 4-blue (default), 5-magenta, 6-cyan, 7-white
2019-08-09 04:58:14 +00:00
##### Dual pane
2019-07-26 19:58:17 +00:00
Any number of `nnn` instances can be opened simultaneously using the lightweight terminal multiplexter [`dvtm`](http://www.brain-dump.org/projects/dvtm/). For example, to open 2 instances or a dual pane mode, have the following alias:
2019-07-27 11:14:03 +00:00
alias n2="dvtm -m '^h' nnn nnn"
2019-07-26 19:58:17 +00:00
2019-07-27 11:14:03 +00:00
Note that the `dvtm` MOD key is redefined to <kbd>^H</kbd> as the default one (<kbd>^G</kbd>) is also an `nnn` shortcut.
2019-07-26 19:58:17 +00:00
#### Selection
2019-04-21 18:37:48 +00:00
Use <kbd>^K</kbd> to select the file under the cursor.
2019-04-21 18:37:48 +00:00
To select multiple files:
2019-03-01 01:21:19 +00:00
- press <kbd>^Y</kbd> to enter selection mode. In this mode it's possible to
- cherry-pick individual files one by one by pressing <kbd>^K</kbd> on each entry (works across directories and contexts); or,
- navigate to another file in the same directory to select a range of files
2019-03-01 01:16:13 +00:00
- press <kbd>^Y</kbd> again to save the selection and exit selection mode.
2019-03-23 14:14:07 +00:00
_NOTE:_ If you are on BSD/macOS, please check the [BSD terminal issue](https://github.com/jarun/nnn#bsd-terminal-issue) with <kbd>^Y</kbd> for workaround.
2019-04-21 18:37:48 +00:00
Selected files are visually indicated by a `+` before the entries.
2019-03-23 14:14:07 +00:00
The selection can now be listed, copied, moved, removed, archived or linked.
Navigate to a target directory then use <kbd>V</kbd> (move) or <kbd>P</kbd> (copy) to have the selected files moved or copied.
2019-06-20 13:40:47 +00:00
Absolute paths of the selected files are copied to the temporary file `.selection` in the config directory. The path is shown in the help and configuration screen. If `$NNN_COPIER` is set the file paths are also copied to the system clipboard.
2017-04-14 18:44:25 +00:00
#### Filters
2017-03-31 02:52:51 +00:00
2019-03-23 14:14:07 +00:00
Filters support regexes (default) to instantly (search-as-you-type) list the matching entries in the current directory.
2017-03-31 02:52:51 +00:00
2017-12-26 04:34:10 +00:00
Common use cases:
- to list all matches starting with the filter expression, start the expression with a `^` (caret) symbol
- type `\.mkv` to list all MKV files
2018-05-01 04:39:10 +00:00
- use `.*` to match any character (_sort of_ fuzzy search)
2017-03-31 02:52:51 +00:00
2019-03-03 18:54:35 +00:00
There is a program option to filter entries by substring match instead of regex.
2019-01-13 17:19:14 +00:00
2019-01-19 12:02:43 +00:00
#### Navigate-as-you-type
2017-06-04 17:45:08 +00:00
In this mode directories are opened in filter mode, allowing continuous navigation. Works best with the **arrow keys**.
2019-08-16 18:37:38 +00:00
When there's a unique match and it's a directory, `nnn` auto selects the directory and enters it in this mode. Use the relevant program option to disable this behaviour.
2019-03-12 14:05:24 +00:00
This mode takes navigation to the next level when short, unique keypress sequences are possible. For example, to reach `nnn` development directory (located at `~/GitHub/nnn`) from my `$HOME` (which is the default directory the terminal starts in), I use the sequence <kbd>g</kbd><kbd>n</kbd>.
2018-07-12 14:28:53 +00:00
#### File indicators
2018-07-12 14:28:53 +00:00
The following indicators are used in the detail view:
2018-07-12 14:28:53 +00:00
| Indicator | File Type |
2018-08-16 14:47:57 +00:00
|:---:| --- |
2017-03-30 13:24:18 +00:00
| `/` | Directory |
| `*` | Executable |
2017-04-12 06:28:30 +00:00
| <code>&#124;</code> | Fifo |
2017-03-30 13:24:18 +00:00
| `=` | Socket |
| `@` | Symbolic Link |
| `b` | Block Device |
| `c` | Character Device |
2019-01-21 14:07:00 +00:00
| `?` | Unknown |
2019-08-09 04:58:14 +00:00
## Mentions
2017-04-25 16:54:47 +00:00
- [FOSSMint](https://www.fossmint.com/nnn-linux-terminal-file-browser/)
2019-05-10 00:09:49 +00:00
- [Hacker News 1](https://news.ycombinator.com/item?id=18520898)
- [Hacker News 2](https://news.ycombinator.com/item?id=19850656)
2018-08-18 07:04:25 +00:00
- [It's FOSS](https://itsfoss.com/nnn-file-browser-linux/)
2019-02-15 03:55:04 +00:00
- [LinuxLinks1](https://www.linuxlinks.com/nnn-fast-and-flexible-file-manager/)
- [LinuxLinks2](https://www.linuxlinks.com/bestconsolefilemanagers/)
2019-01-02 06:31:21 +00:00
- [Suckless Rocks](https://suckless.org/rocks/)
2018-08-18 07:04:25 +00:00
- [Ubuntu Full Circle Magazine - Issue 135](https://fullcirclemagazine.org/issue-135/)
2017-04-25 16:54:47 +00:00
2019-08-09 04:58:14 +00:00
## Developers
2017-04-15 01:21:10 +00:00
1. Copyright © 2014-2016 Lazaros Koromilas
2. Copyright © 2014-2016 Dimitris Papastamos
2019-01-01 02:31:48 +00:00
3. Copyright © 2016-2019 [Arun Prakash Jana](https://github.com/jarun)
2019-01-18 02:08:56 +00:00
2019-08-14 15:39:53 +00:00
Contributions are welcome. Please visit the [ToDo list](https://github.com/jarun/nnn/issues/324).