My build of nnn with minor changes
Nevar pievienot vairāk kā 25 tēmas Tēmai ir jāsākas ar burtu vai ciparu, tā var saturēt domu zīmes ('-') un var būt līdz 35 simboliem gara.

pirms 8 gadiem
pirms 8 gadiem
pirms 7 gadiem
pirms 7 gadiem
pirms 5 gadiem
pirms 5 gadiem
pirms 5 gadiem
pirms 6 gadiem
pirms 6 gadiem
pirms 5 gadiem
pirms 6 gadiem
pirms 5 gadiem
pirms 6 gadiem
pirms 5 gadiem
pirms 6 gadiem
pirms 6 gadiem
pirms 6 gadiem
pirms 5 gadiem
pirms 8 gadiem
pirms 7 gadiem
pirms 5 gadiem
pirms 7 gadiem
pirms 5 gadiem
pirms 7 gadiem
pirms 7 gadiem
pirms 7 gadiem
pirms 7 gadiem
pirms 7 gadiem
pirms 7 gadiem
pirms 5 gadiem
pirms 6 gadiem
pirms 5 gadiem
pirms 5 gadiem
pirms 5 gadiem
pirms 5 gadiem
pirms 7 gadiem
pirms 7 gadiem
pirms 8 gadiem
pirms 5 gadiem
pirms 7 gadiem
pirms 5 gadiem
pirms 7 gadiem
pirms 6 gadiem
pirms 5 gadiem
pirms 6 gadiem
pirms 5 gadiem
pirms 7 gadiem
pirms 5 gadiem
pirms 7 gadiem
pirms 5 gadiem
pirms 7 gadiem
pirms 6 gadiem
pirms 5 gadiem
pirms 7 gadiem
pirms 5 gadiem
pirms 7 gadiem
pirms 5 gadiem
pirms 5 gadiem
pirms 5 gadiem
pirms 7 gadiem
pirms 5 gadiem
pirms 7 gadiem
pirms 5 gadiem
pirms 7 gadiem
pirms 6 gadiem
pirms 5 gadiem
pirms 6 gadiem
pirms 7 gadiem
pirms 5 gadiem
pirms 7 gadiem
pirms 8 gadiem
pirms 8 gadiem
pirms 5 gadiem
pirms 5 gadiem
pirms 6 gadiem
pirms 8 gadiem
pirms 6 gadiem
pirms 5 gadiem
pirms 5 gadiem
pirms 8 gadiem
pirms 7 gadiem
pirms 6 gadiem
pirms 6 gadiem
pirms 6 gadiem
pirms 6 gadiem
pirms 6 gadiem
pirms 6 gadiem
pirms 6 gadiem
pirms 7 gadiem
pirms 7 gadiem
pirms 7 gadiem
pirms 5 gadiem
pirms 5 gadiem
pirms 5 gadiem
pirms 5 gadiem
pirms 5 gadiem
pirms 5 gadiem
pirms 7 gadiem
pirms 7 gadiem
pirms 6 gadiem
pirms 7 gadiem
pirms 5 gadiem
pirms 5 gadiem
pirms 6 gadiem
pirms 5 gadiem
pirms 5 gadiem
pirms 6 gadiem
pirms 5 gadiem
pirms 7 gadiem
pirms 7 gadiem
pirms 7 gadiem
pirms 7 gadiem
pirms 7 gadiem
pirms 7 gadiem
pirms 5 gadiem
pirms 7 gadiem
pirms 5 gadiem
pirms 7 gadiem
pirms 7 gadiem
pirms 7 gadiem
pirms 5 gadiem
pirms 5 gadiem
pirms 5 gadiem
pirms 5 gadiem
pirms 5 gadiem
pirms 6 gadiem
pirms 5 gadiem
pirms 5 gadiem
pirms 5 gadiem
pirms 5 gadiem
pirms 5 gadiem
pirms 6 gadiem
pirms 5 gadiem
pirms 5 gadiem
pirms 5 gadiem
pirms 5 gadiem
pirms 7 gadiem
pirms 6 gadiem
pirms 5 gadiem
pirms 7 gadiem
pirms 5 gadiem
pirms 7 gadiem
pirms 5 gadiem
pirms 6 gadiem
pirms 5 gadiem
pirms 6 gadiem
pirms 7 gadiem
pirms 5 gadiem
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559
  1. ## nnn
  2. Noice is Not Noice, a noicer fork...
  3. <p align="center">
  4. <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>
  5. <a href="http://formulae.brew.sh/formula/nnn"><img src="https://img.shields.io/homebrew/v/nnn.svg?maxAge=600" alt="Homebrew" /></a>
  6. <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>
  7. <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>
  8. <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>
  9. <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>
  10. <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>
  11. </p>
  12. <p align="center">
  13. <a href="https://travis-ci.org/jarun/nnn"><img src="https://img.shields.io/travis/jarun/nnn/master.svg" alt="Build Status" /></a>
  14. <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>
  15. </p>
  16. [![nnn video](https://i.imgur.com/pDyq5oa.jpg)](https://www.youtube.com/watch?v=U2n5aGqou9E "Click to see nnn in action!")
  17. <p align="center"><i>nnn in action! (Thanks Luke Smith for the video!)</i></a></p>
  18. `nnn` is probably the [fastest and most resource-sensitive](#comparison) 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.
  19. [Integrate utilities](https://github.com/jarun/nnn#sample-scripts) like sxiv or fzy easily, transfer selected files using lftp or use it as a [(neo)vim plugin](https://github.com/jarun/nnn#neovim-plugin); `nnn` supports as many scripts as you need!
  20. It runs on Linux, macOS, Raspberry Pi, BSD, Cygwin, Linux subsystem for Windows and Termux.
  21. [Quickstart](#quickstart) and see how `nnn` simplifies those long desktop sessions.
  22. We need contributors. Please visit the [ToDo list](https://github.com/jarun/nnn/issues/137).
  23. *Love smart and efficient utilities? Explore [my repositories](https://github.com/jarun?tab=repositories). Buy me a cup of coffee if they help you.*
  24. <p align="center">
  25. <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>
  26. </p>
  27. #### TABLE OF CONTENTS
  28. - [Features](#features)
  29. - [Comparison](#comparison)
  30. - [Installation](#installation)
  31. - [Dependencies](#dependencies)
  32. - [From a package manager](#from-a-package-manager)
  33. - [Release packages](#release-packages)
  34. - [From source](#from-source)
  35. - [Shell completion](#shell-completion)
  36. - [Usage](#usage)
  37. - [Cmdline options](#cmdline-options)
  38. - [Keyboard shortcuts](#keyboard-shortcuts)
  39. - [Leader key](#leader-key)
  40. - [Contexts](#contexts)
  41. - [Directory color](#directory-color)
  42. - [Selection](#selection)
  43. - [Filters](#filters)
  44. - [Navigate-as-you-type mode](#navigate-as-you-type-mode)
  45. - [File indicators](#file-indicators)
  46. - [Utility dependencies](#utility-dependencies)
  47. - [Help](#help)
  48. - [Quickstart](#quickstart)
  49. - [How to](#how-to)
  50. - [add bookmarks](#add-bookmarks)
  51. - [copy file paths](#copy-file-paths)
  52. - [to clipboard](#to-clipboard)
  53. - [get selection manually](#get-selection-manually)
  54. - [cd on quit](#cd-on-quit)
  55. - [(neo)vim plugin](#neovim-plugin)
  56. - [file picker](#file-picker)
  57. - [run custom scripts](#run-custom-scripts)
  58. - [sample scripts](#sample-scripts)
  59. - [launch applications](#launch-applications)
  60. - [change dir color](#change-dir-color)
  61. - [integrate patool](#integrate-patool)
  62. - [lftp transfers](#lftp-transfers)
  63. - [prompt shortcuts](#prompt-shortcuts)
  64. - [set idle timeout](#set-idle-timeout)
  65. - [hot-plugged drives](#hot-plugged-drives)
  66. - [tmux configuration](#tmux-configuration)
  67. - [BSD terminal issue](#bsd-terminal-issue)
  68. - [restrict file open](#restrict-file-open)
  69. - [Why fork?](#why-fork)
  70. - [Mentions](#mentions)
  71. - [Developers](#developers)
  72. #### FEATURES
  73. - Modes
  74. - Basic, detail (default), disk usage analyzer (du)
  75. - Vim (or neovim) file picker (as a plugin)
  76. - Navigation
  77. - Familiar, easy shortcuts (arrows, `~`, `-`, `&`)
  78. - *Navigate-as-you-type* with auto-select directory
  79. - Contexts (_aka_ tabs _aka_ workspaces)
  80. - Bookmarks
  81. - Pin and visit a directory
  82. - Sorting
  83. - Directories always listed on top
  84. - Sort by file name, modification time, size
  85. - Numeric order for numeric names (visit _/proc_)
  86. - Search
  87. - Instant filtering with *search-as-you-type*
  88. - Mimes
  89. - Open with desktop opener or specify a custom app
  90. - Create, list, extract archives (needs (p)atool)
  91. - Open all text files in EDITOR (optional)
  92. - Information
  93. - Detailed stat-like file information
  94. - Media information (needs mediainfo/exiftool)
  95. - Convenience
  96. - Create, rename files and directories
  97. - Select files across directories
  98. - Copy, move, delete selection
  99. - Transfer files using lftp
  100. - Batch rename/move/delete (needs vidir)
  101. - Show directories in custom color (default: blue)
  102. - Spawn a subshell in the current directory
  103. - Run a command, launch applications
  104. - Run custom scripts in the current directory
  105. - Run current file as executable
  106. - Change directory at exit (*easy* shell integration)
  107. - Edit file in EDITOR or open in PAGER
  108. - Terminal locker integration
  109. - Unicode support
  110. - Highly optimized, static analysis integrated code
  111. - Available on many distros
  112. #### COMPARISON
  113. Stripped binary (or script) size and memory usage of `nnn` and some other similar utilities while viewing a directory with 13.5K files (0 directories), sorted by size/du:
  114. <pre>
  115. <b>BINSZ</b> VIRT <b> RES</b> SHR S %MEM COMMAND
  116. <b> 650K</b> 139720 <b>91220</b> 8460 S 1.1 ranger
  117. <b> 1M</b> 50496 <b>15328</b> 4076 S 0.2 vifm
  118. <b> 1M</b> 72152 <b>12468</b> 7336 S 0.2 mc
  119. <b> 70K</b> 16068 <b> 4620</b> 2408 S 0.1 ncdu
  120. <b> 55K</b> 15712 <b> 4368</b> 2512 S 0.1 nnn -S
  121. </pre>
  122. Intrigued? Find out [HOW](https://github.com/jarun/nnn/wiki/performance-factors).
  123. #### INSTALLATION
  124. #### Dependencies
  125. `nnn` needs a curses library with wide character support (like ncursesw) and standard libc.
  126. #### From a package manager
  127. - [Arch Linux](https://www.archlinux.org/packages/community/x86_64/nnn/) (`pacman -S nnn`)
  128. - [Debian](https://packages.debian.org/search?keywords=nnn&searchon=names&exact=1) (`apt-get install nnn`)
  129. - [Fedora](https://apps.fedoraproject.org/packages/nnn) (`dnf install nnn`)
  130. - [FreeBSD](https://www.freshports.org/misc/nnn) (`pkg install nnn`)
  131. - [Gentoo](https://packages.gentoo.org/packages/app-misc/nnn) (`emerge nnn`)
  132. - [macOS/Homebrew](http://formulae.brew.sh/formula/nnn) (`brew install nnn`)
  133. - [NixOS](https://github.com/NixOS/nixpkgs/tree/master/pkgs/applications/misc/nnn) (`nix-env -i nnn`)
  134. - [OpenBSD](https://cvsweb.openbsd.org/cgi-bin/cvsweb/ports/sysutils/nnn/) (`pkg_add nnn`)
  135. - [openSUSE](https://software.opensuse.org/package/nnn) (and packages for several other distros) (`zypper in nnn`)
  136. - [pkgrsc](http://pkgsrc.se/sysutils/nnn) (`pkg_add nnn`)
  137. - [Raspbian Testing](https://archive.raspbian.org/raspbian/pool/main/n/nnn/) (`apt-get install nnn`)
  138. - [Slackware](http://slackbuilds.org/repository/14.2/system/nnn/) (`slackpkg install nnn`)
  139. - [Solus](https://packages.getsol.us/shannon/n/nnn/) (`eopkg install nnn`)
  140. - [Source Mage](http://codex.sourcemage.org/test/shell-term-fm/nnn/) (`cast nnn`)
  141. - [Termux](https://github.com/termux/termux-packages/tree/master/packages/nnn) (`pkg in nnn`)
  142. - [Ubuntu](https://packages.ubuntu.com/search?keywords=nnn&searchon=names&exact=1) (`apt-get install nnn`)
  143. - [Ubuntu PPA](https://launchpad.net/~twodopeshaggy/+archive/ubuntu/jarun/) (`apt-get install nnn`)
  144. - [Void Linux](https://github.com/void-linux/void-packages/tree/master/srcpkgs/nnn) (`xbps-install -S nnn`)
  145. #### Release packages
  146. Packages for Arch Linux, CentOS, Debian, Fedora, Solus, and Ubuntu are available with the [latest stable release](https://github.com/jarun/nnn/releases/latest).
  147. #### From source
  148. 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):
  149. $ sudo apt-get install pkg-config libncursesw5-dev
  150. $ make
  151. $ sudo make install
  152. `PREFIX` is supported, in case you want to install to a different location.
  153. - Compilation information for [Raspberry Pi](https://github.com/jarun/nnn/issues/182)
  154. - Instructions for [Cygwin](https://github.com/jarun/nnn/wiki/Cygwin-instructions)
  155. #### Shell completion
  156. 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.
  157. #### USAGE
  158. #### Cmdline options
  159. ```
  160. usage: nnn [-b key] [-C] [-e] [-i] [-l]
  161. [-p file] [-S] [-v] [-h] [PATH]
  162. The missing terminal file manager for X.
  163. positional args:
  164. PATH start dir [default: current dir]
  165. optional args:
  166. -b key bookmark key to open
  167. -C disable directory color
  168. -e use exiftool instead of mediainfo
  169. -i start in navigate-as-you-type mode
  170. -l start in light mode
  171. -p file copy selection to file (stdout if '-')
  172. -S start in disk usage analyser mode
  173. -v show program version
  174. -h show this help
  175. ```
  176. `>` indicates the currently selected entry in `nnn`.
  177. #### Keyboard shortcuts
  178. Press <kbd>?</kbd> in `nnn` to see the list anytime.
  179. ```
  180. NAVIGATION
  181. ↑, k, ^P Up PgUp, ^U Scroll up
  182. ↓, j, ^N Down PgDn, ^D Scroll down
  183. Home, g, ^, ^A First entry ~ Go HOME
  184. End, G, $, ^E Last entry & Start dir
  185. ←, Bksp, h, ^H Parent dir - Last visited dir
  186. →, ↵, l, ^M Open file/dir . Toggle show hidden
  187. / Filter Ins, ^T Toggle nav-as-you-type
  188. b Pin current dir ^W Go to pinned dir
  189. Tab, ^I Next context d Toggle detail view
  190. `, ^/ Leader key LeaderN Go to/create context N
  191. Esc Exit prompt ^L Redraw/clear prompt
  192. ^G Quit and cd q Quit context
  193. Q, ^Q Quit ? Help, config
  194. FILES
  195. ^O Open with... n Create new
  196. D File details ^R Rename entry
  197. ⎵, ^K Copy entry path r Open dir in vidir
  198. Y, ^Y Toggle selection y List selection
  199. P Copy selection X Delete selection
  200. V Move selection ^X Delete entry
  201. f Archive entry F List archive
  202. ^F Extract archive m, M Brief/full media info
  203. e Edit in EDITOR p Open in PAGER
  204. ORDER TOGGLES
  205. ^J Disk usage S Apparent du
  206. t Modification time s Size
  207. MISC
  208. !, ^] Spawn SHELL in dir C Execute entry
  209. R, ^V Run custom script L Lock terminal
  210. ^S Run a command
  211. ```
  212. Help & settings, file details, media info and archive listing are shown in the PAGER. Please use the PAGER-specific keys in these screens.
  213. #### Leader key
  214. 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.
  215. | Key | Function |
  216. |:---:| --- |
  217. | <kbd>1-4</kbd> | Go to/create selected context |
  218. | <kbd>></kbd>, <kbd>.</kbd> | Go to next active context |
  219. | <kbd><</kbd>, <kbd>,</kbd> | Go to previous active context |
  220. | key | Go to bookmarked location |
  221. | <kbd>~</kbd> | Go to HOME directory |
  222. | <kbd>-</kbd> | Go to last visited directory |
  223. | <kbd>&</kbd> | Go to start directory |
  224. | <kbd>q</kbd> | Quit context |
  225. #### Contexts
  226. 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:
  227. - the current context is in reverse
  228. - other used contexts are underlined
  229. - rest are unused
  230. To switch to a context press the Leader key followed by the context number (1-4).
  231. 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.
  232. When a context is quit, the next active context is selected. If the last active context is quit, the program quits.
  233. #### Directory color
  234. Each context can have its own color for directories specified:
  235. export NNN_CONTEXT_COLORS="1234"
  236. colors: 0-black, 1-red, 2-green, 3-yellow, 4-blue (default), 5-magenta, 6-cyan, 7-white
  237. #### Selection
  238. Use <kbd>^K</kbd> to copy the absolute path of the file under the cursor.
  239. To copy multiple absolute file paths:
  240. - press <kbd>^Y</kbd> (or <kbd>Y</kbd>) to enter selection mode. In this mode it's possible to
  241. - cherry-pick individual files one by one by pressing <kbd>^K</kbd> on each entry (works across directories and contexts); or,
  242. - navigate to another file in the same directory to select a range of files
  243. - press <kbd>^Y</kbd> (or <kbd>Y</kbd>) _again_ to copy the paths and exit the selection mode
  244. The files in the list can now be copied (<kbd>P</kbd>), moved (<kbd>V</kbd>) or removed (<kbd>X</kbd>).
  245. To list the file paths copied to memory press <kbd>y</kbd>.
  246. File paths are copied to the temporary file `DIR/.nnncp`, where `DIR` (by priority) is:
  247. $HOME or,
  248. $TMPDIR or,
  249. /tmp
  250. The path is shown in the help and configuration screen.
  251. #### Filters
  252. Filters support regexes to instantly (search-as-you-type) list the matching entries in the current directory.
  253. Common use cases:
  254. - to list all matches starting with the filter expression, start the expression with a `^` (caret) symbol
  255. - type `\.mkv` to list all MKV files
  256. - use `.*` to match any character (_sort of_ fuzzy search)
  257. If `nnn` is invoked as root or the environment variable `NNN_SHOW_HIDDEN` is set the default filter will also match hidden files.
  258. #### Navigate-as-you-type mode
  259. In this mode directories are opened in filter mode, allowing continuous navigation. Works best with the **arrow keys**.
  260. 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,
  261. export NNN_NO_AUTOSELECT=1
  262. #### File indicators
  263. The following indicators are used in the detail view:
  264. | Indicator | File Type |
  265. |:---:| --- |
  266. | `/` | Directory |
  267. | `*` | Executable |
  268. | <code>&#124;</code> | Fifo |
  269. | `=` | Socket |
  270. | `@` | Symbolic Link |
  271. | `@/` | Symbolic Link to directory |
  272. | `b` | Block Device |
  273. | `c` | Character Device |
  274. #### Utility dependencies
  275. | External dependency | Operation |
  276. | --- | --- |
  277. | xdg-open (Linux), open(1) (macOS), cygstart (Cygwin) | desktop opener |
  278. | file | determine file type |
  279. | cp, mv, rm, xargs (from findutils on Linux) | copy, move and remove files |
  280. | mediainfo, exiftool | multimedia file details |
  281. | atool, patool ([integration](#integrate-patool)) | create, list and extract archives |
  282. | vidir (from moreutils) | batch rename, move, delete dir entries |
  283. | vlock (Linux), bashlock (macOS), lock(1) (BSD) | terminal locker |
  284. | $EDITOR (overridden by $VISUAL, if defined) | edit files (fallback vi) |
  285. | $PAGER | page through files (fallback less) |
  286. | $SHELL | spawn a shell, run script (fallback sh) |
  287. To edit all text files in EDITOR (preferably CLI, fallback vi):
  288. export NNN_USE_EDITOR=1
  289. Arguments to the `$PAGER` and `$SHELL` should be combined together.
  290. The option `open with` takes 1 combined argument.
  291. #### Help
  292. $ nnn -h
  293. $ man nnn
  294. To lookup keyboard shortcuts at runtime, press <kbd>?</kbd>.
  295. #### QUICKSTART
  296. 1. Install the [utilities required](#file-handling) for your regular activities.
  297. 2. Configure [cd on quit](#cd-on-quit).
  298. 3. Optionally open all text files in EDITOR (fallback vi):
  299. export NNN_USE_EDITOR=1
  300. 4. Run `n`.
  301. 5. Press <kbd>?</kbd> for help on keyboard shortcuts anytime.
  302. 6. For additional functionality [setup custom scripts](#run-custom-scripts).
  303. #### HOW TO
  304. #### add bookmarks
  305. Set environment variable `NNN_BMS` as a string of `key_char:location` pairs (max 10) separated by semicolons (`;`):
  306. export NNN_BMS='d:~/Documents;u:/home/user/Cam Uploads;D:~/Downloads/'
  307. NOTE: Bookmark keys should be single-character to use them in combination with the Leader key.
  308. #### copy file paths
  309. ##### to clipboard
  310. 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 macOS. Here's a sample [copier script](https://github.com/jarun/nnn/blob/master/scripts/user-scripts/copier.sh).
  311. To inform `nnn` of the executable copier script location:
  312. export NNN_COPIER="/path/to/copier.sh"
  313. ##### get selection manually
  314. NOTE: In the following examples we assume the copy file is at `/home/user/.nnncp`.
  315. The file paths are `NUL`-terminated, so additional processing is required to make them usable.
  316. To get a space-separated list of the file paths in selection:
  317. cat /home/user/.nnncp | xargs -0 echo
  318. To get a newline-separated list of the file paths in selection:
  319. # bash/zsh
  320. ls -ltr `cat /home/user/.nnncp | tr '\0' '\n'`
  321. ls -ltr $(cat /home/user/.nnncp | tr '\0' '\n')
  322. # fish
  323. ls -ltr (cat /home/user/.nnncp | tr '\0' '\n')
  324. An alias may be handy, e.g. when you want to copy selection at the _run a command_ prompt:
  325. alias ncp="cat /home/user/.nnncp | tr '\0' '\n'"
  326. so you can easily handle files together:
  327. # bash/zsh
  328. ls -ltr `ncp`
  329. ls -ltr $(ncp)
  330. # fish
  331. ls -ltr (ncp)
  332. To get the list in a file:
  333. ncp > out.txt
  334. #### cd on quit
  335. To quit `nnn` and switch to the directory last opened follow the instructions below.
  336. 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.
  337. As you might notice, `nnn` uses the environment variable `NNN_TMPFILE` to write the last visited directory path. You can change it.
  338. #### (neo)vim plugin
  339. `nnn` can be used as a file picker/chooser within vim or neovim. Find the plugin [here](https://github.com/mcchrish/nnn.vim).
  340. #### file picker
  341. To use `nnn` as a file picker and redirect the output to other programs, use [picker.sh](https://github.com/jarun/nnn/blob/master/scripts/user-scripts/picker.sh).
  342. Ways to pick files:
  343. - use selection and press <kbd>q</kbd> to quit
  344. - press <kbd>Enter</kbd> to pick any earlier selection and the current entry (to avoid selecting the last file in the selection twice, press <kbd>q</kbd> instead).
  345. Notes:
  346. - pressing <kbd>Enter</kbd> on a directory enters it; when trying to pick a directory, e.g. to pipe to `cd`, use single file selection and press <kbd>q</kbd>
  347. - to discard selection and quit, press <kbd>^G</kbd>
  348. #### run custom scripts
  349. `nnn` can invoke custom scripts with the currently selected file name as argument 1.
  350. Export the absolute path to the directory with your scripts or a single script:
  351. export NNN_SCRIPT=/home/user/scripts
  352. OR
  353. export NNN_SCRIPT=/usr/local/bin/nscript.sh
  354. Press <kbd>R</kbd> to run the script in the current directory. You can also use this key to cancel choosing a script from the script directory.
  355. ##### sample scripts
  356. Sample scripts for use cases like sxiv or fzy integration are under [user-scripts](https://github.com/jarun/nnn/tree/master/scripts/user-scripts). Feel free to contribute yours!
  357. #### launch applications
  358. Applications can be launched from the _run a command_ prompt. Use `&` to launch GUI applications in the background.
  359. #### change dir color
  360. The default color for directories is blue. Option `-c` accepts color codes from 0 to 7 to use a different color:
  361. 0-black, 1-red, 2-green, 3-yellow, 4-blue, 5-magenta, 6-cyan, 7-white
  362. Any other value disables colored directories.
  363. #### integrate patool
  364. On systems where `atool` is not available but `patool` is, drop two copies of the Python3 script [natool](https://github.com/jarun/nnn/tree/master/scripts/natool) as `atool` and `apack` somewhere in `$PATH`.
  365. #### lftp transfers
  366. lftp can be used from `nnn` for automated remote transfers or copying a selection to a server. Visit the [wiki page](https://github.com/jarun/nnn/wiki/simplify-remote-transfers-with-lftp) for more details on the integration.
  367. #### prompt shortcuts
  368. The prompts (expect filter prompt) support some bash-like command-line shortcuts - <kbd>^A</kbd>, <kbd>^E</kbd>, <kbd>^U</kbd>.
  369. Key <kbd>^L</kbd> clears and <kbd>Esc</kbd> exits _any_ prompt.
  370. #### set idle timeout
  371. The terminal locker is disabled by default. To set the wait time in seconds, use environment variable `NNN_IDLE_TIMEOUT`.
  372. #### hot-plugged drives
  373. 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`.
  374. #### tmux configuration
  375. `nnn` might not handle keypresses correctly when used with tmux (see issue #104 for more details). Set `TERM=xterm-256color` to address it.
  376. #### BSD terminal issue
  377. 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.
  378. #### Restrict file open
  379. In order to disable opening files on accidental navigation key (<kbd>→</kbd> or <kbd>l</kbd>) press:
  380. export DISABLE_FILE_OPEN_ON_NAV=1
  381. Use <kbd>Enter</kbd> to open files.
  382. #### WHY FORK?
  383. `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:
  384. - 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.
  385. - 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.
  386. #### MENTIONS
  387. - [FOSSMint](https://www.fossmint.com/nnn-linux-terminal-file-browser/)
  388. - [Hacker News](https://news.ycombinator.com/item?id=18520898)
  389. - [It's FOSS](https://itsfoss.com/nnn-file-browser-linux/)
  390. - [LinuxLinks](https://www.linuxlinks.com/nnn-fast-and-flexible-file-manager/)
  391. - [Suckless Rocks](https://suckless.org/rocks/)
  392. - [Ubuntu Full Circle Magazine - Issue 135](https://fullcirclemagazine.org/issue-135/)
  393. #### DEVELOPERS
  394. 1. Copyright © 2014-2016 Lazaros Koromilas
  395. 2. Copyright © 2014-2016 Dimitris Papastamos
  396. 3. Copyright © 2016-2019 [Arun Prakash Jana](https://github.com/jarun)