nnn/README.md

530 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">
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
2018-04-25 20:00:43 +00:00
[![nnn screencast](https://i.imgur.com/wNtI24c.jpg)](https://vimeo.com/233223942 "Click to see nnn in action!")
2017-04-06 00:57:16 +00:00
2018-05-02 14:59:46 +00:00
<p align="center"><i>nnn in action! (click to play video)</i></a></p>
2017-04-04 14:27:44 +00:00
2018-11-08 20:30:28 +00:00
`nnn` is probably the [fastest and most resource-sensitive](#performance) file manager you have ever used. It integrates seamlessly with your DE and favourite GUI utilities, has a unique [navigate-as-you-type](#navigate-as-you-type-mode) mode with auto-select, disk usage analyzer mode, bookmarks, contexts, application launcher, familiar navigation shortcuts, subshell spawning and much more.
2017-12-09 06:34:32 +00:00
2018-10-22 21:14:03 +00:00
[Integrate utilities](https://github.com/jarun/nnn#sample-scripts) like sxiv or fzy easily; `nnn` supports as many scripts as you need!
2017-12-09 06:34:32 +00:00
2018-11-10 00:33:30 +00:00
It runs on Linux, OS X, Raspberry Pi, Cygwin, Linux subsystem for Windows and Termux.
2018-06-18 12:52:04 +00:00
2018-11-10 00:33:30 +00:00
[Quickstart](#quickstart) and see how `nnn` simplifies those long desktop sessions... Missing a feature? Want to contribute? Head to the rolling [ToDo list](https://github.com/jarun/nnn/issues/110).
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">
2018-02-28 11:09:23 +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-green.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-04-13 14:40:23 +00:00
- [Performance](#performance)
2017-03-29 05:33:22 +00:00
- [Installation](#installation)
2017-08-14 00:13:01 +00:00
- [Dependencies](#dependencies)
- [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)
2017-04-14 18:44:25 +00:00
- [Filters](#filters)
- [Navigate-as-you-type mode](#navigate-as-you-type-mode)
2018-07-12 14:28:53 +00:00
- [File indicators](#file-indicators)
2017-04-21 12:22:03 +00:00
- [File handling](#file-handling)
2017-04-14 18:44:25 +00:00
- [Help](#help)
2017-04-21 03:30:46 +00:00
- [Quickstart](#quickstart)
2017-04-15 01:21:10 +00:00
- [How to](#how-to)
2017-06-11 04:15:50 +00:00
- [add bookmarks](#add-bookmarks)
- [copy file paths](#copy-file-paths)
2018-11-11 05:17:24 +00:00
- [selection](#selection)
- [quote paths](#quote-paths)
- [to clipboard](#to-clipboard)
2018-10-22 16:23:37 +00:00
- [cd on quit](#cd-on-quit)
2018-06-17 16:17:19 +00:00
- [run custom scripts](#run-custom-scripts)
2018-06-18 12:52:04 +00:00
- [sample scripts](#sample-scripts)
2017-07-02 20:56:47 +00:00
- [change dir color](#change-dir-color)
- [integrate patool](#integrate-patool)
- [work faster at rename prompt](#work-faster-at-rename-prompt)
- [set idle timeout](#set-idle-timeout)
2017-10-18 01:04:32 +00:00
- [show hot plugged drives](#show-hot-plugged-drives)
2018-11-11 17:50:16 +00:00
- [tmux configuration](#tmux-configuration)
2018-11-23 02:14:32 +00:00
- [BSD terminal issue](#bsd-terminal-issue)
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)
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
- Basic, detail (default), disk usage analyzer (du)
2017-05-15 16:59:40 +00:00
- Navigation
2018-03-18 10:48:30 +00:00
- Familiar, easy shortcuts (arrows, `~`, `-`, `&`)
2018-11-11 17:50:16 +00:00
- *Navigate-as-you-type* with auto-select directory
- Contexts (_aka_ tabs _aka_ workspaces)
2018-11-11 21:34:17 +00:00
- Bookmarks
- Pin and visit a directory
2018-03-18 10:48:30 +00:00
- Sorting
- Directories always listed on top
- Sort by file name, modification time, size
2018-11-11 17:50:16 +00:00
- Numeric order for numeric names (visit _/proc_)
2017-05-15 16:59:40 +00:00
- Search
2018-11-11 17:50:16 +00:00
- Instant filtering with *search-as-you-type*
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
- Create, list, extract archives (needs (p)atool)
- Open all text files in EDITOR (optional)
2017-05-15 16:59:40 +00:00
- Information
2018-02-24 09:16:33 +00:00
- Detailed stat-like file information
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
2018-11-11 17:50:16 +00:00
- Select multiple files; copy, move, delete selection
- Batch rename/move/delete (needs vidir)
- Show directories in custom color (default: blue)
2018-11-11 21:34:17 +00:00
- Spawn a subshell in the current directory
2018-06-17 16:17:19 +00:00
- Run custom scripts in the current directory
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
- GUI app launcher (up to 2 space-separated args)
- Terminal locker integration
2017-05-11 16:55:22 +00:00
- Unicode support
2018-11-13 03:51:21 +00:00
- Highly optimized, static analysis integrated code
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
#### PERFORMANCE
2017-04-13 14:40:23 +00:00
2018-10-19 05:18:14 +00:00
`nnn` vs. ncdu memory usage in disk usage analyzer mode (400K files on disk):
2017-04-09 21:50:13 +00:00
2018-10-26 13:48:14 +00:00
<pre>
PID USER PR NI VIRT <b>RES</b> SHR S %CPU %MEM TIME+ COMMAND
5034 vaio 20 0 71628 <b>59932</b> 2412 S 0.0 0.7 0:01.22 ncdu /
4949 vaio 20 0 14812 <b>3616</b> 2560 S 0.0 0.0 0:00.83 nnn -S /
</pre>
2017-04-09 21:50:13 +00:00
2018-10-19 05:18:14 +00:00
`nnn` vs. midnight commander vs. ranger memory usage while viewing a directory with 13.5K files, sorted by size:
2017-04-13 14:40:23 +00:00
2018-10-26 13:48:14 +00:00
<pre>
PID USER PR NI VIRT <b>RES</b> SHR S %CPU %MEM TIME+ COMMAND
31885 vaio 20 0 139720 <b>91220</b> 8460 S 0.0 1.1 0:02.96 /usr/bin/python -O /usr/bin/ranger
30108 vaio 20 0 72152 <b>12468</b> 7336 S 0.0 0.2 0:00.06 mc
30168 vaio 20 0 16476 <b>5072</b> 2640 S 0.0 0.1 0:00.22 nnn -c 1 -i
</pre>
2017-04-13 14:40:23 +00:00
2017-12-19 15:19:54 +00:00
Intrigued? Find out [HOW](https://github.com/jarun/nnn/wiki/performance-factors).
2018-11-11 17:50:16 +00:00
#### INSTALLATION
2017-03-29 05:33:22 +00:00
2017-08-14 00:13:01 +00:00
#### Dependencies
`nnn` needs libncursesw (on Linux or ncurses on OS X) and standard libc.
2016-08-20 16:27:14 +00:00
2017-08-14 00:13:01 +00:00
#### From a package manager
2016-08-20 16:27:14 +00:00
2018-11-03 06:00:21 +00:00
- [Arch Linux](https://www.archlinux.org/packages/community/x86_64/nnn/) (`pacman -S 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`)
- [Homebrew](http://formulae.brew.sh/formula/nnn) (`brew install 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-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`)
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`)
- [Ubuntu PPA](https://launchpad.net/~twodopeshaggy/+archive/ubuntu/jarun/) (`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`)
2016-08-20 16:27:14 +00:00
2017-08-13 14:50:37 +00:00
#### Release packages
2017-11-24 23:18:32 +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):
2018-10-05 02:15:44 +00:00
$ sudo apt-get install pkg-config libncursesw5-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.
2018-11-13 03:51:21 +00:00
#### Shell completion
2017-09-02 06:53:19 +00:00
Search keyword and 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.
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
```
2017-12-24 13:16:56 +00:00
usage: nnn [-b key] [-c N] [-e] [-i] [-l]
2018-11-23 17:11:47 +00:00
[-p file] [-S] [-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:
2018-10-18 17:37:18 +00:00
-b key bookmark key to open
-c N dir color, disables if N>7
2017-10-02 02:43:36 +00:00
-e use exiftool instead of mediainfo
-i start in navigate-as-you-type mode
2018-08-16 15:05:57 +00:00
-l start in light mode
2018-11-23 17:11:47 +00:00
-p file copy selection to file (stdout if '-')
2018-08-16 15:05:57 +00:00
-S start in disk usage analyser mode
2018-10-18 17:37:18 +00:00
-v show program version
-h show this help
2017-10-02 02:43:36 +00:00
```
2017-04-01 05:18:18 +00:00
2017-06-04 17:45:08 +00:00
`>` indicates the currently selected entry in `nnn`.
2016-08-21 10:32:03 +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
↑, k, ^P Up PgUp, ^U Scroll up
↓, j, ^N Down PgDn, ^D Scroll down
Home, g, ^, ^A First entry ~ Go HOME
End, G, $, ^E Last entry & Start dir
←, Bksp, h, ^H Parent dir - Last visited dir
→, ↵, l, ^M Open file/enter dir . Toggle show hidden
/ Filter Ins, ^I Toggle nav-as-you-type
b Pin current dir ^W Go to pinned dir
2018-11-11 22:06:37 +00:00
`, ^/ Leader key LeaderN Switch to context N
2018-11-11 21:34:17 +00:00
Esc Exit prompt ^L Redraw, clear prompt
2018-11-11 10:52:58 +00:00
^G Quit and cd q Quit context
2018-11-23 05:14:39 +00:00
Q, ^Q Quit ? Help, config
2018-11-11 10:52:58 +00:00
FILES
^O Open with... n Create new
D File details d Toggle detail view
^R Rename entry r Open dir in vidir
2018-11-23 02:14:32 +00:00
Y, ^Y Toggle selection y List selection
2018-11-11 10:52:58 +00:00
⎵, ^K Copy entry path ^T Toggle path quote
2018-11-17 03:01:47 +00:00
P Copy selection X Delete selection
V Move selection ^X Delete entry
2018-11-11 10:52:58 +00:00
f Archive entry F List archive
^F Extract archive m, M Brief/full media info
e Edit in EDITOR p Open in PAGER
ORDER
^J Toggle du mode S Toggle apparent size
s Toggle sort by size t Toggle sort by mtime
MISC
o Launch GUI app !, ^] Spawn SHELL in dir
R Run custom script L Lock terminal
2017-04-23 21:45:06 +00:00
```
2017-03-29 05:33:22 +00:00
Help & settings, file details, media info and archive listing are shown in the PAGER. Please 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 |
|:---:| --- |
| <kbd>1-4</kbd> | Go to selected context |
| <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 |
| <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).
2018-11-08 12:59:38 +00:00
The first time a context is entered, it copies the state of the last visited context. Each context remembers its start directory and last visited directory.
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.
2017-04-14 18:44:25 +00:00
#### Filters
2017-03-31 02:52:51 +00:00
Filters support regexes to instantly (search-as-you-type) list the matching entries in the current directory.
2017-03-31 02:52:51 +00:00
2018-10-27 20:22:07 +00:00
Ways to exit filter prompt:
- press <kbd>^L</kbd> to clear filter followed by <kbd>Bksp</kbd> (to clear the filter symbol, like vi)
- at other prompts <kbd>^L</kbd> followed by <kbd>Enter</kbd> discards all changes and exits prompt
- run a search with no matches and press <kbd>Enter</kbd>
2017-04-28 23:02:47 +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
If `nnn` is invoked as root or the environment variable `NNN_SHOW_HIDDEN` is set the default filter will also match hidden files.
2017-03-31 02:52:51 +00:00
#### Navigate-as-you-type mode
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**.
2018-10-21 18:00:46 +00:00
In case of only one match and it's a directory, `nnn` auto selects the directory and enters it in this mode. To disable this behaviour,
export NNN_NO_AUTOSELECT=1
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 |
2017-04-21 12:22:03 +00:00
#### File handling
2018-03-11 08:12:49 +00:00
| External dependency | Operation |
| --- | --- |
2018-08-28 15:17:37 +00:00
| xdg-open (Linux), open(1) (OS X), cygstart (Cygwin) | desktop opener |
2018-11-21 21:43:55 +00:00
| file | determine file type |
2018-11-11 17:50:16 +00:00
| cp, mv, rm | copy, move and remove files |
2018-03-11 08:12:49 +00:00
| mediainfo, exiftool | multimedia file details |
2018-09-05 22:51:35 +00:00
| atool, patool ([integration](#integrate-patool)) | create, list and extract archives |
2018-11-11 17:50:16 +00:00
| vidir (from moreutils) | batch rename, move, delete dir entries |
2018-09-06 15:48:32 +00:00
| vlock (Linux), bashlock (OS X), lock(1) (BSD) | terminal locker |
| $EDITOR (overridden by $VISUAL, if defined) | edit files (fallback vi) |
2018-03-11 08:12:49 +00:00
| $PAGER | page through files (fallback less) |
2018-03-19 00:02:16 +00:00
| $SHELL | spawn a shell, run script (fallback sh) |
2018-03-11 08:12:49 +00:00
- To edit all text files in EDITOR (preferably CLI, fallback vi):
2017-10-02 02:43:36 +00:00
export NNN_USE_EDITOR=1
2017-04-21 03:30:46 +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
2018-10-17 16:27:04 +00:00
1. Install the [utilities required](#file-handling) for your regular activities.
2. Configure [cd on quit](#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`.
5. Press <kbd>?</kbd> for help on keyboard shortcuts anytime.
6. For additional functionality [setup custom scripts](#run-custom-scripts).
2018-02-24 16:13:41 +00:00
2018-11-11 17:50:16 +00:00
#### HOW TO
2017-04-15 01:21:10 +00:00
2017-06-11 04:15:50 +00:00
#### add bookmarks
2018-11-11 21:34:17 +00:00
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/'
2017-06-11 04:15:50 +00:00
2018-11-11 21:34:17 +00:00
NOTE: Bookmark keys should be single-character to use them in combination with the Leader key.
2017-06-11 04:15:50 +00:00
#### copy file paths
2018-11-11 05:17:24 +00:00
##### selection
2018-11-20 02:00:37 +00:00
Use <kbd>^K</kbd> to copy the absolute path of the file under the cursor.
2018-11-20 02:00:37 +00:00
To copy multiple absolute file paths:
2018-11-23 02:14:32 +00:00
- press <kbd>^Y</kbd> (or <kbd>Y</kbd>) to enter selection mode. In this mode it's possible to
2018-11-20 02:00:37 +00:00
- cherry-pick individual files one by one by pressing <kbd>^K</kbd> on each entry; or,
- navigate to another file in the same directory to select a range of files
2018-11-23 02:14:32 +00:00
- press <kbd>^Y</kbd> (or <kbd>Y</kbd>) _again_ to copy the paths and exit the selection mode
2018-11-20 02:00:37 +00:00
The files in the list can now be copied (<kbd>P</kbd>), moved (<kbd>V</kbd>) or removed (<kbd>X</kbd>).
2018-11-10 14:12:09 +00:00
To list the file paths copied to memory press <kbd>y</kbd>.
2018-11-11 00:21:05 +00:00
File paths are copied to the temporary file `DIR/.nnncp`, where `DIR` (by priority) is:
$HOME or,
$TMPDIR or,
/tmp
2018-11-23 05:00:49 +00:00
To see the path to the temporary copy file, run `nnn`, press <kbd>?</kbd> and look up `copy file`.
2018-10-22 16:23:37 +00:00
2018-11-11 05:17:24 +00:00
To use the copied paths from the cmdline, use command substitution. For example, if `DIR` above is `/home/user`:
# bash/zsh
ls -ltr `cat /home/user/.nnncp`
ls -ltr $(cat /home/user/.nnncp)
# fish
ls -ltr (cat /home/user/.nnncp)
An alias may be handy:
alias ncp='cat /home/user/.nnncp'
2018-11-11 05:17:24 +00:00
so you can easily handle files together:
# bash/zsh
ls -ltr `ncp`
ls -ltr $(ncp)
# fish
ls -ltr (ncp)
2018-11-11 05:17:24 +00:00
##### quote paths
To wrap each file path within single quotes while selecting:
export NNN_QUOTE_ON=1
This is particularly useful if you are planning to copy the whole string to the shell to run a command. Quotes can be toggled at runtime using <kbd>^T</kbd>.
Note that the filename is not escaped. So copying may still fail for filenames having quote(s) in them.
##### to clipboard
2018-11-11 00:21:05 +00:00
Along with default copy, `nnn` can pipe the absolute path of the current file or multiple files to a copier script. For example, you can use `xsel` on Linux or `pbcopy` on OS X.
Sample Linux copier script:
#!/bin/sh
# comment the next line to convert newlines to spaces
IFS=
echo -n $1 | xsel --clipboard --input
export `NNN_COPIER`:
export NNN_COPIER="/path/to/copier.sh"
2018-10-22 16:23:37 +00:00
#### cd on quit
To quit `nnn` and switch to the directory last opened follow the instructions below.
2018-11-13 13:10:48 +00:00
Pick the appropriate file for your shell from [`scripts/quitcd`](scripts/quitcd) and add the contents to your shell's rc file. You'll need to spawn a new shell for the change to take effect. You should start `nnn` as `n` (or modify the function name to something else). To change directory on quit press `^G` while exiting.
2018-10-22 16:23:37 +00:00
As you might notice, `nnn` uses the environment variable `NNN_TMPFILE` to write the last visited directory path. You can change it.
2018-06-17 16:17:19 +00:00
#### run custom scripts
2018-03-19 00:02:16 +00:00
`nnn` can invoke custom scripts with the currently selected file name as argument 1.
Export the path to the custom executable script:
2018-03-19 00:02:16 +00:00
export NNN_SCRIPT=/usr/local/bin/nscript
2018-03-19 00:02:16 +00:00
Press <kbd>R</kbd> to run the script in the current directory.
2018-06-17 16:17:19 +00:00
It's possible to run multiple scripts with `nnn` as long as the scripts are in the same location and share the same prefix. To enable multiple scripts,
export NNN_MULTISCRIPT=1
With the example of `NNN_SCRIPT` above, some more scripts could be:
/usr/local/bin/nscript1
/usr/local/bin/nscript2
/usr/local/bin/nscriptcustom1
/usr/local/bin/nscriptcustom2
and so on...
Type the correct suffix when prompted on pressing the keybind <kbd>R</kbd>. To use the base script (`NNN_SCRIPT`), just press <kbd>Enter</kbd>.
2018-06-18 12:52:04 +00:00
##### sample scripts
- Open image files in current dir in **sxiv**:
2018-06-17 16:26:06 +00:00
2018-06-18 12:52:04 +00:00
#!/usr/bin/env sh
2018-06-17 16:26:06 +00:00
2018-06-18 12:52:04 +00:00
sxiv -q * >/dev/null 2>&1
2018-06-17 16:26:06 +00:00
2018-06-18 12:52:04 +00:00
- Fuzzy find files in **fzy** and open with xdg-open:
2018-06-17 16:26:06 +00:00
2018-06-18 12:52:04 +00:00
#!/usr/bin/env sh
2018-06-17 16:26:06 +00:00
2018-06-18 12:52:04 +00:00
xdg-open $(find -type f | fzy) >/dev/null 2>&1
2018-06-17 16:26:06 +00:00
2017-07-02 20:56:47 +00:00
#### change dir color
The default color for directories is blue. Option `-c` accepts color codes from 0 to 7 to use a different color:
2017-09-19 14:25:02 +00:00
0-black, 1-red, 2-green, 3-yellow, 4-blue, 5-magenta, 6-cyan, 7-white
2017-07-02 20:56:47 +00:00
Any other value disables colored directories.
#### integrate patool
On systems where `atool` is not available but `patool` is, drop two copies of the Python3 script [natool](https://github.com/jarun/nnn/blob/master/scripts/natool) as `atool` and `apack` somewhere in `$PATH`.
#### work faster at rename prompt
The rename prompt supports some bash-like command-line shortcuts - <kbd>^A</kbd>, <kbd>^E</kbd>, <kbd>^U</kbd>. <kbd>^L</kbd> clears the name.
#### set idle timeout
2018-11-11 17:50:16 +00:00
The terminal locker is disabled by default. To set the wait time in seconds, use environment variable `NNN_IDLE_TIMEOUT`.
2017-10-18 01:04:32 +00:00
#### show hot plugged drives
Enable volume management in your DE file manager and set removable drives or media to be auto-mounted when inserted. Then visit the usual mount point location (`/mnt` or `/media/user`) in `nnn`.
2018-11-11 17:50:16 +00:00
#### tmux configuration
2018-04-19 01:22:41 +00:00
2018-04-19 01:25:59 +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.
2018-04-19 01:22:41 +00:00
#### BSD terminal issue
2018-11-23 02:14:32 +00:00
By default in OpenBSD & FreeBSD, `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.
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-08-18 07:04:25 +00:00
- [It's FOSS](https://itsfoss.com/nnn-file-browser-linux/)
2018-06-08 16:30:15 +00:00
- [LinuxLinks](https://www.linuxlinks.com/nnn-fast-and-flexible-file-manager/)
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
2018-02-24 05:25:35 +00:00
3. Copyright © 2016-2018 [Arun Prakash Jana](https://github.com/jarun)