nnn/README.md

285 lines
13 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>
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>
<a href="https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RMLTQ76JSXJ4Q"><img src="https://img.shields.io/badge/PayPal-donate-1eb0fc.svg" alt="Donate via PayPal!" /></a>
</p>
2019-09-30 23:00:58 +00:00
<p align="center"><a href="https://www.youtube.com/watch?v=U2n5aGqou9E"><img src="https://i.imgur.com/MPWpmos.png" /></a></p>
<p align="center"><i>navigate-as-you-type & du (click to see demo video)</i></p>
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-09-30 23:00:58 +00:00
`nnn` is a full-featured terminal file manager. It's tiny, [extremely light and fast](https://github.com/jarun/nnn/wiki/Performance).
2019-07-29 23:27:59 +00:00
2019-11-17 17:58:32 +00:00
`nnn` is also a disk usage analyzer, a fuzzy app launcher, a batch file renamer and a file picker. The [plugin repository](https://github.com/jarun/nnn/tree/master/plugins#nnn-plugins) has tons of plugins and plugin-specific documentation to extend the capabilities further. There's an independent [(neo)vim plugin](https://github.com/mcchrish/nnn.vim).
2019-09-30 23:00:58 +00:00
It runs smoothly on the Raspberry Pi, Termux [on Android](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-09-27 03:14:52 +00:00
2019-09-30 23:00:58 +00:00
Add to that an awesome [Wiki](https://github.com/jarun/nnn/wiki)!
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-09-15 17:02:44 +00:00
- Light (default), detail
2019-03-22 23:27:21 +00:00
- 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-10-24 07:18:12 +00:00
- Contexts (_aka_ tabs/workspaces) with custom colors
2019-10-18 22:31:46 +00:00
- Sessions, bookmarks; pin and visit a dir
2019-10-12 04:18:58 +00:00
- Familiar shortcuts (arrows, <kbd>~</kbd>, <kbd>-</kbd>, <kbd>@</kbd>), quick reference
2019-09-26 16:21:38 +00:00
- CD on quit (*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-30 15:25:23 +00:00
- By file name, modification/access time, size, 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-10-11 20:43:08 +00:00
- Create, list, extract, mount (FUSE based) 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
2019-08-27 18:30:52 +00:00
- Media information (using plugin)
2017-05-15 16:59:40 +00:00
- Convenience
2019-10-24 07:18:12 +00:00
- Run plugins and commands with custom keybinds
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-10-24 01:26:15 +00:00
- Cross-dir file/all/range selection
2019-09-27 03:14:52 +00:00
- Batch rename selection or dir entries
2019-10-14 22:17:57 +00:00
- Copy (as), move (as), delete, archive, link selection
- Create (with parents), rename, duplicate (anywhere) files and dirs
2019-08-19 17:51:34 +00:00
- Spawn a shell, run apps, run commands, execute file
2019-09-26 14:26:43 +00:00
- Lock terminal (needs a locker)
2019-09-27 03:14:52 +00:00
- Minimal deps, minimal config
2019-09-29 02:32:40 +00:00
- Widely available
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
2017-03-29 05:33:22 +00:00
2019-09-26 00:16:06 +00:00
## Quickstart
1. Install the [utilities you may need](https://github.com/jarun/nnn#utility-dependencies) based on your regular workflows.
2. Configure [cd on quit](https://github.com/jarun/nnn/wiki/Basic-use-cases#configure-cd-on-quit).
3. Optionally open all text files in `$EDITOR` (fallback vi): `export NNN_USE_EDITOR=1`.
2019-09-26 00:16:06 +00:00
4. For additional functionality [install plugins](https://github.com/jarun/nnn/tree/master/plugins#installing-plugins) and the GUI app launcher [`nlaunch`](https://github.com/jarun/nnn/tree/master/misc/nlaunch).
2019-09-28 01:05:38 +00:00
Notes:
1. Don't memorize keys. Arrows, <kbd>/</kbd> and <kbd>q</kbd> suffice. Press <kbd>?</kbd> for help on keyboard shortcuts anytime.
2. To set `nnn` as the default file manager, follow these [instructions](https://github.com/jarun/nnn/wiki/Advanced-use-cases#configure-as-default-fm).
2019-09-26 00:16:06 +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
A curses library with wide char support (e.g. ncursesw), libreadline (`make O_NORL=1` to drop) and standard libc.
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 |
2019-11-21 15:00:38 +00:00
| file, coreutils (cp, mv, rm), 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-10-12 04:18:58 +00:00
| archivemount, fusermount(3) | optional | mount, unmount archives |
| sshfs, fusermount(3) | optional | mount, unmount remotes |
2019-11-06 10:56:49 +00:00
| trash-cli | optional | trash files (default action: rm) |
| vlock (Linux), bashlock (macOS), lock(1) (BSD) | optional | terminal locker (fallback: [cmatrix](https://github.com/abishekvashok/cmatrix)) |
2019-08-24 05:59:29 +00:00
| advcpmv (Linux) ([integration](https://github.com/jarun/nnn/wiki/Advanced-use-cases#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-09-27 13:33:19 +00:00
Install `nnn` from your package manager. If the version available is dated try an alternative installation method.
2019-07-31 18:01:37 +00:00
2019-09-29 04:18:51 +00:00
<details><summary>Packaging status (expand)</summary>
2019-09-26 13:28:29 +00:00
<p>
<br>
<a href="https://repology.org/metapackage/nnn/versions"><img src="https://repology.org/badge/vertical-allrepos/nnn.svg" alt="Packaging status"></a>
</p>
Unlisted distros:
2019-08-20 03:17:48 +00:00
<p>
<br>
● CentOS (<code>yum --enablerepo=epel 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://www.nutyx.org/en/?type=pkg&branch=rolling&arch=x86_64&searchpkg=nnn">NuTyX</a> (<code>cards install nnn</code>)<br>
<a href="http://codex.sourcemage.org/test/shell-term-fm/nnn/">Source Mage</a> (<code>cast nnn</code>)<br>
</p>
</details>
2019-01-11 09:01:33 +00:00
2017-08-13 14:50:37 +00:00
#### Release packages
2019-09-27 13:33:19 +00:00
Packages for Arch Linux, CentOS, Debian, Fedora and Ubuntu are auto-generated 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
Download the latest stable release or clone this repository (*risky*), install deps and compile. On Ubuntu 18.04:
2017-08-14 00:13:01 +00:00
$ sudo apt-get install pkg-config libncursesw5-dev libreadline-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-09-27 03:14:52 +00:00
Visit the [developer guides](https://github.com/jarun/nnn/wiki/Developer-guides) for compilation notes on the Pi, Cygwin and other compilation modes.
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-09-27 13:33:19 +00:00
Completion scripts for Bash, Fish and Zsh are [available](misc/auto-completion). 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
2019-09-28 15:08:41 +00:00
There is no config file. Associated files are stored under `${XDG_CONFIG_HOME:-$HOME/.config}/nnn/`.
`nnn` supports the following optional (set if you need) environment variables.
2019-06-21 02:02:07 +00:00
| Example `export` | Description |
| --- | --- |
| `NNN_BMS='d:~/Documents;D:~/Docs archive/'` | key-bookmark pairs [max 10] |
2019-11-22 12:21:13 +00:00
| `NNN_PLUG='m:nmount;t:imgthumb;x:_chmod +x $NNN'` | key-plugin (or cmd) pairs (<kbd>:key</kbd> to run) [max 15] |
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-06-21 02:02:07 +00:00
| `NNN_OPENER=mimeopen` | custom file opener |
2019-08-24 05:59:29 +00:00
| `NNN_IDLE_TIMEOUT=300` | idle seconds to lock 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] |
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
```
2019-09-28 14:34:24 +00:00
usage: nnn [OPTIONS] [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:
2019-09-28 14:34:24 +00:00
PATH start dir [default: .]
2017-10-02 02:43:36 +00:00
2018-08-16 15:05:57 +00:00
optional args:
2019-08-30 15:25:23 +00:00
-a use access time
2019-01-17 15:29:30 +00:00
-b key open bookmark key
-c cli-only opener
-d detail mode
2019-10-18 22:31:46 +00:00
-e name load session by name
-f run filter as cmd on prompt key
-H show hidden files
2019-01-17 15:29:30 +00:00
-i nav-as-you-type mode
2019-10-11 15:29:22 +00:00
-K detect key collision
2019-07-14 17:30:14 +00:00
-n version sort
2019-10-02 17:04:11 +00:00
-o open files on Enter
-p file selection file [stdout if '-']
-r use advcpmv patched cp, mv
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
2019-09-30 23:00:58 +00:00
The list below is from the **dev branch**. Press <kbd>?</kbd> in `nnn` to see the keybinds in your installed version.
2018-11-11 10:52:58 +00:00
2019-04-26 13:22:54 +00:00
```
NAVIGATION
2019-10-21 14:43:52 +00:00
Up k Up PgUp ^U Scroll up
Down j Down PgDn ^D Scroll down
Left h Parent ~ ` @ - HOME, /, start, last
Ret Right l Open . 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
2019-10-05 01:29:43 +00:00
(Sh)Tab Cycle context d Toggle detail view
2019-08-07 16:15:32 +00:00
, ^/ Lead key N LeadN Context N
2019-10-05 01:36:32 +00:00
/ Filter/Lead Ins ^N Toggle nav-as-you-type
2019-08-24 23:55:29 +00:00
Esc Exit prompt ^L F5 Redraw/clear prompt
2019-10-05 01:29:43 +00:00
? Help, conf ' Lead' First file
2019-09-28 16:45:49 +00:00
Q ^Q Quit ^G QuitCD q Quit context
2019-04-26 13:22:54 +00:00
FILES
^O Open with... n Create new/link
2019-11-17 00:00:14 +00:00
D File details ^R F2 Rename/duplicate
2019-10-21 14:43:52 +00:00
Space ^J/a Select entry/all r Batch rename
2019-10-02 06:44:38 +00:00
m ^K Sel range, clear M List selection
2019-11-16 15:09:05 +00:00
P Copy selection K Edit, flush sel
2019-10-19 03:31:23 +00:00
V Move selection w Copy/move sel as
2019-10-14 22:17:57 +00:00
X Del selection ^X Del entry
2019-10-11 20:43:08 +00:00
f Create archive T Mount archive
2019-04-26 13:22:54 +00:00
^F Extract archive F List archive
e Edit in EDITOR p Open in PAGER
ORDER TOGGLES
2019-09-28 16:45:49 +00:00
A Apparent du S du
2019-11-16 22:41:27 +00:00
z Size E Extn t Time
2019-04-26 13:22:54 +00:00
MISC
2019-11-17 19:00:00 +00:00
! ^] Shell ;K :K xK Execute plugin K
C Execute entry R ^V Pick plugin
2019-10-18 22:31:46 +00:00
U Manage session = Launch
2019-04-26 13:22:54 +00:00
c SSHFS mount u Unmount
2019-11-18 14:51:00 +00:00
] ^P Prompt/run cmd L Lock
2019-04-26 13:22:54 +00:00
```
2019-09-30 23:00:58 +00:00
Notes:
1. Help & settings, file details and archive listing are shown in the `$PAGER`.
2. To change shortcuts modify key bindings in `nnn.h` and compile.
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
2019-10-10 03:00:17 +00:00
#### Lead key
2018-11-08 22:57:42 +00:00
2019-10-10 03:00:17 +00:00
The Lead/Leader 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
2019-10-10 03:00:17 +00:00
| Follower key | Function |
2018-11-08 22:57:42 +00:00
|:---:| --- |
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
| key | Go to bookmarked location |
2019-08-07 14:17:17 +00:00
| <kbd>'</kbd> | Go to first file in directory |
2019-09-28 16:45:49 +00:00
| <kbd>~</kbd> <kbd>`</kbd> <kbd>@</kbd> <kbd>-</kbd> | Visit HOME, `/`, start, last visited dir |
| <kbd>.</kbd> | Toggle show hidden files |
2018-11-08 22:57:42 +00:00
2019-10-10 03:00:17 +00:00
When the filter is on, <kbd>/</kbd> works as an additional Lead key.
2019-08-04 08:57:35 +00:00
2019-08-10 16:34:09 +00:00
#### Help
$ nnn -h
$ man nnn
To lookup keyboard shortcuts at runtime, press <kbd>?</kbd>.
2019-10-06 14:22:30 +00:00
## Elsewhere
2017-04-25 16:54:47 +00:00
2019-10-06 14:22:30 +00:00
- [Wikipedia](https://en.wikipedia.org/wiki/Nnn_(file_manager))
- [ArchWiki](https://wiki.archlinux.org/index.php/Nnn)
2017-04-25 16:54:47 +00:00
- [FOSSMint](https://www.fossmint.com/nnn-linux-terminal-file-browser/)
2019-11-11 21:31:53 +00:00
- [gHacks Tech News](https://www.ghacks.net/2019/11/01/nnn-is-an-excellent-command-line-based-file-manager-for-linux-macos-and-bsds/)
2019-09-29 04:18:51 +00:00
- Hacker News [[1](https://news.ycombinator.com/item?id=18520898)] [[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-09-29 04:18:51 +00:00
- LinuxLinks [[1](https://www.linuxlinks.com/nnn-fast-and-flexible-file-manager/)] [[2](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
2019-10-18 23:44:18 +00:00
- [Arun Prakash Jana](https://github.com/jarun) (Copyright © 2016-2019)
- [0xACE](https://github.com/0xACE)
- [Anna Arad](https://github.com/annagrram)
- [KlzXS](https://github.com/KlzXS)
- [Sijmen J. Mulder](https://github.com/sjmulder)
- and other contributors
2019-01-18 02:08:56 +00:00
2019-11-17 22:34:04 +00:00
Visit the to the [ToDo list](https://github.com/jarun/nnn/issues/386) to contribute or see the current development status.