nnn/README.md

472 lines
22 KiB
Markdown
Raw Normal View History

## nnn
2016-08-20 16:27:14 +00:00
Noice is Not Noice, a noicer fork...
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>
2018-11-03 06:42:19 +00:00
<a href="https://travis-ci.org/jarun/nnn"><img src="https://img.shields.io/travis/jarun/nnn/master.svg" alt="Build 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
2019-01-18 00:51:58 +00:00
[![nnn video](https://i.imgur.com/ZB5UdQ8.jpg)](https://www.youtube.com/watch?v=U2n5aGqou9E "Click to see nnn in action!")
2017-04-06 00:57:16 +00:00
2019-01-01 02:34:20 +00:00
<p align="center"><i>nnn in action! (Thanks Luke Smith for the video!)</i></a></p>
2018-12-04 16:43:54 +00:00
2019-03-09 03:43:36 +00:00
`nnn` is smooth... like butter. It's also one of the fastest and most lightweight file managers you have ever used. It comes in a `~50KB` binary using `~3.5MB` resident memory at runtime.
2019-01-20 02:38:54 +00:00
2019-03-16 00:57:05 +00:00
Runs on Linux, macOS, Raspberry Pi, BSD, Cygwin, Linux subsystem for Windows and Termux on Android.
2017-12-09 06:34:32 +00:00
2019-03-16 00:57:05 +00:00
`nnn` works with your DE and favourite GUI utilities, has a unique _navigate-as-you-type_ mode with auto-select, disk usage analyzer mode, bookmarks, contexts, application launcher, familiar navigation shortcuts, shell spawning, quick notes and much more.
2017-12-09 06:34:32 +00:00
2019-03-17 15:05:55 +00:00
It supports as many scripts as you need! Integrate utilities like sxiv (view images in directory) or fzy (fuzzy search subtree) with available scripts (or your own), transfer selected files using lftp or use it as a (neo)vim plugin. Refer to the wiki page [hacking `nnn`](https://github.com/jarun/nnn/wiki/hacking-nnn) for more such use cases.
2018-06-18 12:52:04 +00:00
2018-12-04 16:43:54 +00:00
[Quickstart](#quickstart) and see how `nnn` simplifies those long desktop sessions.
2017-12-09 06:34:32 +00:00
2018-07-17 20:20:22 +00:00
*Love smart and efficient utilities? Explore [my repositories](https://github.com/jarun?tab=repositories). Buy me a cup of coffee if they help you.*
2017-12-09 06:34:32 +00:00
<p align="center">
2019-02-01 14:23:22 +00:00
<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>
2017-12-09 06:34:32 +00:00
</p>
2018-11-11 17:50:16 +00:00
#### TABLE OF CONTENTS
2016-08-20 16:27:14 +00:00
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)
2017-04-14 18:44:25 +00:00
- [Cmdline options](#cmdline-options)
- [Keyboard shortcuts](#keyboard-shortcuts)
2018-11-11 21:34:17 +00:00
- [Leader key](#leader-key)
2018-11-08 12:59:38 +00:00
- [Contexts](#contexts)
2019-01-16 15:11:43 +00:00
- [Context-specific color](#context-specific-color)
- [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)
2019-01-19 12:47:36 +00:00
- [Configuration](#configuration)
2017-04-14 18:44:25 +00:00
- [Help](#help)
2017-04-21 03:30:46 +00:00
- [Quickstart](#quickstart)
2019-03-10 18:58:28 +00:00
- [User scripts](#user-scripts)
2019-02-23 01:34:42 +00:00
- [Troubleshooting](#troubleshooting)
2019-02-23 15:52:56 +00:00
- [Tmux configuration](#tmux-configuration)
2019-02-23 01:34:42 +00:00
- [BSD terminal issue](#bsd-terminal-issue)
2019-02-23 15:52:56 +00:00
- [Restrict file open](#restrict-file-open)
- [Restrict 0-byte files](#restrict-0-byte-files)
2017-04-21 03:30:46 +00:00
- [Why fork?](#why-fork)
2017-04-25 16:54:47 +00:00
- [Mentions](#mentions)
2017-04-15 01:21:10 +00:00
- [Developers](#developers)
2019-01-18 02:08:56 +00:00
- [Contributions](#contributions)
2016-08-21 12:07:18 +00:00
2018-11-11 17:50:16 +00:00
#### FEATURES
2017-04-21 03:30:46 +00:00
2018-11-11 17:50:16 +00:00
- Modes
2019-03-14 15:16:57 +00:00
- Detail (default), light, disk usage analyzer (du)
2019-01-15 10:21:56 +00:00
- File picker, vim (or neovim) plugin
2017-05-15 16:59:40 +00:00
- Navigation
2019-02-02 20:16:28 +00:00
- *Navigate-as-you-type* with auto-select directory
2019-03-20 03:44:39 +00:00
- *Wild load* for *navigate-as-you-type*
2019-03-14 15:16:57 +00:00
- 4 contexts (_aka_ tabs _aka_ workspaces)
- Bookmarks; pin and visit a directory
2019-03-12 14:05:24 +00:00
- Familiar, easy shortcuts (arrows, <kbd>~</kbd>, <kbd>-</kbd>, <kbd>@</kbd>)
2018-03-18 10:48:30 +00:00
- Sorting
2019-02-06 14:25:15 +00:00
- Ordered pure numeric names by default (visit _/proc_)
2019-03-14 15:16:57 +00:00
- Sort by file name, modification time, size
2019-02-23 15:52:56 +00:00
- Version (_aka_ natural) sort
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
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-03-14 15:16:57 +00:00
- Create, list, extract archive (needs (p)atool)
2018-11-11 17:50:16 +00:00
- Open all text files in EDITOR (optional)
2017-05-15 16:59:40 +00:00
- Information
2019-03-14 15:16:57 +00:00
- Detailed file information (stat and file)
2018-11-11 17:50:16 +00:00
- Media information (needs mediainfo/exiftool)
2017-05-15 16:59:40 +00:00
- Convenience
2017-09-10 07:35:25 +00:00
- Create, rename files and directories
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-03-09 03:35:32 +00:00
- FreeDesktop compliant trash (needs trash-cli)
- Show copy, move progress on Linux (needs avdcpmv)
2018-12-06 19:44:43 +00:00
- Transfer files using lftp
2019-03-02 11:23:16 +00:00
- Batch rename (needs vidir)
2019-03-16 00:57:05 +00:00
- Per-context directory color (default: blue)
- Spawn a shell in the current directory
- Launch applications, run a command
2018-06-17 16:17:19 +00:00
- Run custom scripts in the current directory
2019-01-15 10:21:56 +00:00
- Repository of custom scripts
2018-12-08 12:52:06 +00:00
- Run current file as executable
2017-05-15 16:59:40 +00:00
- Change directory at exit (*easy* shell integration)
2018-11-11 17:50:16 +00:00
- Edit file in EDITOR or open in PAGER
2019-01-19 09:08:47 +00:00
- Take quick notes
2018-11-11 17:50:16 +00:00
- Terminal locker integration
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
2018-11-11 17:50:16 +00:00
- Available on many distros
2017-03-29 05:33:22 +00:00
2018-11-11 17:50:16 +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
| External dependency | Operation |
| --- | --- |
| xdg-open (Linux), open(1) (macOS), cygstart (Cygwin) | desktop opener |
| file | determine file type |
2019-03-03 18:54:35 +00:00
| coreutils (cp, mv, rm), findutils (xargs) | copy, move and remove files |
2019-03-09 03:35:32 +00:00
| trash-cli | trash files (instead of delete) |
2019-03-03 18:54:35 +00:00
| mediainfo or exiftool | multimedia file details |
2019-03-17 15:05:55 +00:00
| atool, patool ([integration](https://github.com/jarun/nnn/wiki/hacking-nnn#integrate-patool)) | create, list and extract archives |
2019-03-12 14:05:24 +00:00
| fzy | app launcher with drop-down menu |
2019-03-02 11:23:16 +00:00
| vidir (from moreutils) | batch rename dir entries |
2019-02-10 03:15:13 +00:00
| vlock (Linux), bashlock (macOS), lock(1) (BSD) | terminal locker |
2019-03-17 15:05:55 +00:00
| advcpmv (Linux) ([integration](https://github.com/jarun/nnn/wiki/hacking-nnn#show-cp-mv-progress)) | copy, move progress |
2019-02-10 03:15:13 +00:00
| $EDITOR (overridden by $VISUAL, if defined) | edit files (fallback vi) |
| $PAGER (less, most) | page through files (fallback less) |
2019-03-11 16:19:35 +00:00
| $SHELL | spawn a shell, run script (fallback 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-01-18 01:03:38 +00:00
- [Alpine Linux](https://pkgs.alpinelinux.org/packages?name=nnn) (`apk add nnn`)
2018-11-03 06:00:21 +00:00
- [Arch Linux](https://www.archlinux.org/packages/community/x86_64/nnn/) (`pacman -S nnn`)
- [CRUX](https://github.com/TimB87/crux-ports/tree/master/nnn) (`prt-get depinst nnn`)
- [Debian](https://packages.debian.org/search?keywords=nnn&searchon=names&exact=1) (`apt-get install nnn`)
2018-03-18 09:29:42 +00:00
- [Fedora](https://apps.fedoraproject.org/packages/nnn) (`dnf install nnn`)
- [FreeBSD](https://www.freshports.org/misc/nnn) (`pkg install nnn`)
- [Gentoo](https://packages.gentoo.org/packages/app-misc/nnn) (`emerge nnn`)
- [macOS/Homebrew](http://formulae.brew.sh/formula/nnn) (`brew install nnn`)
2019-03-01 08:31:14 +00:00
- [MacPorts](https://www.macports.org/ports.php?by=name&substr=nnn) (`port install nnn`)
2019-01-11 09:01:33 +00:00
- [Milis Linux](https://notabug.org/milislinux/milis/src/master/talimatname/genel/n/nnn/talimat) (`mps kur nnn`)
- [NixOS](https://github.com/NixOS/nixpkgs/tree/master/pkgs/applications/misc/nnn) (`nix-env -i nnn`)
2018-05-15 00:36:12 +00:00
- [OpenBSD](https://cvsweb.openbsd.org/cgi-bin/cvsweb/ports/sysutils/nnn/) (`pkg_add nnn`)
- [openSUSE](https://software.opensuse.org/package/nnn) (and packages for several other distros) (`zypper in nnn`)
2018-12-17 16:14:07 +00:00
- [pkgrsc](http://pkgsrc.se/sysutils/nnn) (`pkg_add nnn`)
2018-10-27 19:14:19 +00:00
- [Raspbian Testing](https://archive.raspbian.org/raspbian/pool/main/n/nnn/) (`apt-get install nnn`)
- [Slackware](http://slackbuilds.org/repository/14.2/system/nnn/) (`slackpkg install nnn`)
- [Solus](https://packages.getsol.us/shannon/n/nnn/) (`eopkg install nnn`)
2017-11-25 13:03:04 +00:00
- [Source Mage](http://codex.sourcemage.org/test/shell-term-fm/nnn/) (`cast nnn`)
2018-11-10 00:33:30 +00:00
- [Termux](https://github.com/termux/termux-packages/tree/master/packages/nnn) (`pkg in nnn`)
- [Ubuntu](https://packages.ubuntu.com/search?keywords=nnn&searchon=names&exact=1) (`apt-get install nnn`)
2018-10-05 02:15:44 +00:00
- [Void Linux](https://github.com/void-linux/void-packages/tree/master/srcpkgs/nnn) (`xbps-install -S nnn`)
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
$ sudo make install
2017-08-14 00:13:01 +00:00
`PREFIX` is supported, in case you want to install to a different location.
- Compilation information for [Raspberry Pi](https://github.com/jarun/nnn/issues/182)
- Instructions for [Cygwin](https://github.com/jarun/nnn/wiki/Cygwin-instructions)
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-03-03 18:54:35 +00:00
Option completion scripts for Bash, Fish and Zsh can be found in respective subdirectories of [`scripts/auto-completion/`](scripts/auto-completion). Please refer to your shell's manual for installation instructions.
2017-09-02 06:53:19 +00:00
2018-11-11 17:50:16 +00:00
#### USAGE
2016-08-20 16:27:14 +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
```
2019-03-12 11:13:17 +00:00
usage: nnn [-b key] [-d] [-e] [-i] [-l] [-n]
2019-02-27 15:33:14 +00:00
[-p file] [-s] [-S] [-v] [-w] [-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 show hidden files
2019-01-17 15:29:30 +00:00
-e use exiftool for media info
-i nav-as-you-type mode
-l light mode
-n use version compare to sort
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-01-17 15:29:30 +00:00
-v show version
2019-03-20 03:44:39 +00:00
-w wild load
2019-01-17 15:29:30 +00:00
-h show help
2017-10-02 02:43:36 +00:00
```
2017-04-01 05:18:18 +00:00
2017-04-14 18:44:25 +00:00
#### Keyboard shortcuts
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.
2017-04-23 21:45:06 +00:00
```
2018-11-11 10:52:58 +00:00
NAVIGATION
2019-01-31 17:26:00 +00:00
↑ k Up PgUp ^U Scroll up
↓ j Down PgDn ^D Scroll down
← h Parent dir ~ Go HOME
2019-03-12 11:13:17 +00:00
↵ → l Open file/dir @ Start dir
2019-01-31 17:26:00 +00:00
Home g ^A First entry - Last visited dir
End G ^E Last entry . Toggle show hidden
/ Filter Ins ^T Toggle nav-as-you-type
b Pin current dir ^B Go to pinned dir
Tab ^I Next context d Toggle detail view
2019-02-24 03:20:30 +00:00
, ^/ Leader key N LeadN Enter context N
2019-01-31 17:26:00 +00:00
Esc Exit prompt ^L Redraw/clear prompt
^G Quit and cd q Quit context
Q ^Q Quit ? Help, config
2018-11-11 10:52:58 +00:00
FILES
2019-01-31 17:26:00 +00:00
^O Open with... n Create new/link
D File details ^R Rename entry
2019-03-02 11:23:16 +00:00
⎵ ^K / Y Select entry/all r Batch rename
2019-02-23 14:43:04 +00:00
K ^Y Toggle selection y List selection
2019-01-31 17:26:00 +00:00
P Copy selection X Delete selection
V Move selection ^X Delete entry
2019-02-24 03:20:30 +00:00
f Create archive m M Brief/full mediainfo
2019-01-31 17:26:00 +00:00
^F Extract archive F List archive
e Edit in EDITOR p Open in PAGER
2018-12-09 02:14:03 +00:00
ORDER TOGGLES
2019-01-31 17:26:00 +00:00
^J Disk usage S Apparent du
2019-02-27 15:33:14 +00:00
^W Random s Size t Time modified
2018-11-11 10:52:58 +00:00
MISC
2019-01-31 17:26:00 +00:00
! ^] Spawn SHELL C Execute entry
R ^V Run/pick script L Lock terminal
^P Prompt ^N Note = Launcher
2017-04-23 21:45:06 +00:00
```
2017-03-29 05:33:22 +00:00
2019-03-03 18:54:35 +00:00
Help & settings, file details, media info and archive listing are shown in the PAGER. Use the PAGER-specific keys in these screens.
2018-11-11 21:34:17 +00:00
#### Leader key
2018-11-08 22:57:42 +00:00
2018-11-11 22:06:37 +00:00
The Leader key (<kbd>`</kbd> or <kbd>^/</kbd>) provides a powerful multi-functional navigation mechanism. It is case-sensitive and understands contexts, bookmarks and handy 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 |
| <kbd>~</kbd> | Go to HOME directory |
| <kbd>-</kbd> | Go to last visited directory |
2019-03-12 11:13:17 +00:00
| <kbd>@</kbd> | Go to start directory |
2018-11-09 04:21:29 +00:00
| <kbd>q</kbd> | Quit context |
2018-11-08 22:57:42 +00:00
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
- other used contexts are underlined
- rest are unused
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
Each context can have its own color for directories specified:
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
#### Selection
Use <kbd>^K</kbd> to copy the absolute path of the file under the cursor.
To copy multiple absolute file paths:
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.
Selected files are visually indicated by a `+`.
The files in the list can now be copied (<kbd>P</kbd>), moved (<kbd>V</kbd>) or removed (<kbd>X</kbd>).
To list the file paths copied to memory press <kbd>y</kbd>.
File paths are copied to the temporary file `DIR/.nnncp`, where `DIR` (by priority) is:
$HOME or,
/tmp
2019-03-17 14:51:34 +00:00
$TMPDIR or,
The path is shown in the help and configuration screen.
2019-03-22 01:38:23 +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.
2017-04-14 18:44:25 +00:00
#### Filters
2017-03-31 02:52:51 +00:00
2019-01-13 17:19:14 +00:00
Filters support regexes by 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-03-12 14:05:24 +00:00
When there's a unique match and it's a directory, `nnn` auto selects the directory and enters it in this mode. To disable this behaviour,
2018-10-21 18:00:46 +00:00
export NNN_NO_AUTOSELECT=1
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>.
2019-03-20 03:44:39 +00:00
The **_wild load_** option can be extremely handy for users who use this mode constantly. The entries are unsorted when the directory loads. Applying filters sorts the entries (with directories on top). Directory color is disabled in this mode.
2019-02-27 15:33:14 +00:00
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 |
| `@/` | Symbolic Link to directory |
2017-03-30 13:24:18 +00:00
| `b` | Block Device |
| `c` | Character Device |
2019-01-21 14:07:00 +00:00
| `?` | Unknown |
2019-01-19 12:47:36 +00:00
#### Configuration
`nnn` supports the following environment variables for configuration.
| Example `export` | Description |
| --- | --- |
| `NNN_BMS='d:~/Documents;D:~/Docs archive/'` | specify bookmarks (max 10) |
2019-01-20 18:21:45 +00:00
| `NNN_OPENER=mimeopen` | custom file opener |
2019-01-19 12:47:36 +00:00
| `NNN_CONTEXT_COLORS='1234'` | specify per context color [default: '4444' (all blue)] |
2019-03-20 22:09:47 +00:00
| `NNN_IDLE_TIMEOUT=300` | idle seconds before locking terminal [default: disabled] |
2019-01-19 12:47:36 +00:00
| `NNN_COPIER='copier.sh'` | system clipboard copier script [default: none] |
| `NNN_SCRIPT=/home/user/scripts[/script.sh]` | path to script dir or a single script |
| `NNN_NOTE=/home/user/Dropbox/Public/notes` | path to note file [default: none] |
2019-01-20 18:21:45 +00:00
| `NNN_TMPFILE=/tmp/nnn` | file to write current open dir path to for cd on quit |
| `NNN_USE_EDITOR=1` | Open text files in `$EDITOR` (`$VISUAL`, if defined; fallback vi) |
2019-03-12 14:05:24 +00:00
| `NNN_NO_AUTOSELECT=1` | do not auto-select matching dir in _nav-as-you-type_ mode |
2019-01-19 12:47:36 +00:00
| `NNN_RESTRICT_NAV_OPEN=1` | open files on <kbd></kbd>, not <kbd></kbd> or <kbd>l</kbd> |
| `NNN_RESTRICT_0B=1` | do not open 0-byte files |
2019-03-09 03:35:32 +00:00
| `NNN_TRASH=1` | trash files to the desktop Trash [default: delete] |
2019-03-09 08:16:18 +00:00
| `NNN_OPS_PROG=1` | show copy, move progress on Linux |
2019-01-19 12:47:36 +00:00
2017-04-14 18:44:25 +00:00
#### Help
2017-03-29 05:33:22 +00:00
2017-10-02 17:33:45 +00:00
$ nnn -h
$ man nnn
2017-06-04 17:45:08 +00:00
To lookup keyboard shortcuts at runtime, press <kbd>?</kbd>.
2017-03-29 05:33:22 +00:00
2018-11-11 17:50:16 +00:00
#### QUICKSTART
2017-04-21 03:30:46 +00:00
2019-01-18 02:08:56 +00:00
1. Install the [utilities required](#utility-dependencies) for your regular activities.
2019-03-17 15:05:55 +00:00
2. Configure [cd on quit](https://github.com/jarun/nnn/wiki/hacking-nnn#cd-on-quit).
3. Optionally open all text files in EDITOR (fallback vi):
2017-10-02 02:43:36 +00:00
export NNN_USE_EDITOR=1
4. Run `n`.
2019-03-12 14:05:24 +00:00
5. To use `nnn` as a GUI app launcher with fuzzy selection menu, drop [`nlaunch`](https://github.com/jarun/nnn/blob/master/user-scripts/nlaunch) somewhere in your `$PATH`.
6. Don't memorize keys. Arrows, <kbd>/</kbd> and <kbd>q</kbd> suffice. Press <kbd>?</kbd> for help on keyboard shortcuts anytime.
2018-02-24 16:13:41 +00:00
2019-03-14 15:16:57 +00:00
- For additional functionality [setup custom scripts](#user-scripts).
2019-03-17 15:05:55 +00:00
- Visit the wiki page [hacking `nnn`](https://github.com/jarun/nnn/wiki/hacking-nnn) for many more specific usecases.
2019-03-10 18:58:28 +00:00
#### USER SCRIPTS
2019-03-14 15:16:57 +00:00
`nnn` can invoke custom scripts in the current directory (`$PWD` for the script) with the currently selected file name as the argument.
Copy the scripts of your interest in the [user-scripts](https://github.com/jarun/nnn/tree/master/user-scripts) directory and let `nnn` know the location:
2019-03-10 18:58:28 +00:00
2019-03-12 14:05:24 +00:00
export NNN_SCRIPT=/absolute/path/to/scripts_dir
2019-03-14 15:16:57 +00:00
Use the run/pick script shortcut to jump to the script directory and pick a script. Repeating the same shortcut cancels the operation and puts you back in the original directory.
In case you need only one script:
export NNN_SCRIPT=/absolute/path/to/script
2019-03-12 14:05:24 +00:00
If you have an interesting script feel free to raise a PR.
2019-03-10 18:58:28 +00:00
2019-02-23 01:34:42 +00:00
#### TROUBLESHOOTING
2019-02-23 15:52:56 +00:00
##### Tmux configuration
2019-02-23 01:34:42 +00:00
`nnn` might not handle keypresses correctly when used with tmux (see issue #104 for more details). Set `TERM=xterm-256color` to address it.
##### BSD terminal issue
2019-03-03 18:54:35 +00:00
TLDR: Use the keybind <kbd>K</kbd> to toggle selection if you are having issues with <kbd>^Y</kbd>.
2019-03-03 08:22:47 +00:00
By default in OpenBSD & FreeBSD (and probably on macOS as well), `stty` maps <kbd>^Y</kbd> to `DSUSP`. This means that typing <kbd>^Y</kbd> will suspend `nnn` as if you typed <kbd>^Z</kbd> (you can bring `nnn` back to the foreground by issuing `fg`) instead of entering multi-copy mode. You can check this with `stty -a`. If it includes the text `dsusp = ^Y`, issuing `stty dsusp undef` will disable this `DSUSP` and let `nnn` receive the <kbd>^Y</kbd> instead.
2019-02-23 01:34:42 +00:00
2019-02-23 15:52:56 +00:00
##### Restrict file open
2019-02-23 01:34:42 +00:00
In order to disable opening files on accidental navigation key (<kbd></kbd> or <kbd>l</kbd>) press:
export NNN_RESTRICT_NAV_OPEN=1
Use <kbd>Enter</kbd> to open files.
2019-02-23 15:52:56 +00:00
##### Restrict 0-byte files
2019-02-23 01:34:42 +00:00
Restrict opening 0-byte files due to [unexpected behaviour](https://github.com/jarun/nnn/issues/187); use _edit_ or _open with_ to open the file.
export NNN_RESTRICT_0B=1
2018-11-11 17:50:16 +00:00
#### WHY FORK?
2017-04-21 03:30:46 +00:00
2018-10-22 01:14:49 +00:00
`nnn` was initially forked from [noice](http://git.2f30.org/noice/) but is significantly [different](https://github.com/jarun/nnn/wiki/nnn-vs.-noice) today. I chose to fork because:
2018-11-11 17:50:16 +00:00
- one can argue my approach deviates from the goal of the original project - keep the utility `suckless`. `noice` was rudimentary. In my opinion evolution is the taste of time.
2017-04-21 03:30:46 +00:00
- I would like to have a bit of control on what features are added in the name of desktop integration. A feature-bloat is the last thing in my mind. Check out [nnn design considerations](https://github.com/jarun/nnn/wiki/nnn-design-considerations) for more details.
2018-11-11 17:50:16 +00:00
#### MENTIONS
2017-04-25 16:54:47 +00:00
- [FOSSMint](https://www.fossmint.com/nnn-linux-terminal-file-browser/)
2018-11-28 15:13:44 +00:00
- [Hacker News](https://news.ycombinator.com/item?id=18520898)
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
2018-11-11 17:50:16 +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
#### CONTRIBUTIONS
2019-02-23 10:45:29 +00:00
We need contributors. Please visit the [ToDo list](https://github.com/jarun/nnn/issues/213).