diff options
| author | 2019-09-28 20:38:41 +0530 | |
|---|---|---|
| committer | 2019-09-28 21:28:43 +0530 | |
| commit | 6f856dbe74bf8b119b925269e3eadee23df0c53a (patch) | |
| tree | d8a0ef262edc82bddb02131d3eccf322bd038c90 | |
| parent | a7b61f79c4bf8e2f56bfe6f8612438f30381816a (diff) | |
| download | nnn-6f856dbe74bf8b119b925269e3eadee23df0c53a.tar.gz | |
Update docs
| -rw-r--r-- | README.md | 25 | ||||
| -rw-r--r-- | nnn.1 | 16 |
2 files changed, 23 insertions, 18 deletions
@@ -6,18 +6,12 @@ <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> <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> - -<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 analyzer mode (click on the image for a demo video)</i></a></p> - -<p align="center"> <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> +<p align="center"><img src="https://i.imgur.com/MPWpmos.png" /></p> +<p align="center"><i>navigate-as-you-type & du analyzer mode</i></p> + ## Index - [Introduction](#introduction) @@ -56,7 +50,8 @@ It runs smoothly on the Raspberry Pi, Termux on Android, Linux, macOS, BSD, Cygw 2. [Performance numbers](https://github.com/jarun/nnn/wiki/Performance) 3. [Plugin repository and docs](https://github.com/jarun/nnn/tree/master/plugins) 4. [(neo)vim plugin](https://github.com/mcchrish/nnn.vim) -5. [nnn on Android](https://www.youtube.com/watch?v=AbaauM7gUJw) +5. [Demo video](https://www.youtube.com/watch?v=U2n5aGqou9E) (v2.1) +6. [nnn on Android](https://www.youtube.com/watch?v=AbaauM7gUJw) ## Features @@ -119,7 +114,7 @@ Notes: #### Library dependencies -A curses library with wide character support (like ncursesw), libreadline and standard libc. It's possible to drop libreadline using the Makefile target `norl`. +A curses library with wide char support (e.g. ncursesw), libreadline and standard libc. Makefile target `norl` drops libreadline. #### Utility dependencies @@ -177,7 +172,9 @@ Completion scripts for Bash, Fish and Zsh are [available](misc/auto-completion). #### Configuration -`nnn` supports the following environment variables for configuration. All of them are optional (set if you need). There is no config file. Associated files are stored under `${XDG_CONFIG_HOME:-$HOME/.config}/nnn/`. +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. | Example `export` | Description | | --- | --- | @@ -257,7 +254,7 @@ Press <kbd>?</kbd> in `nnn` to see the list anytime. ^P Prompt/run expr L Lock ``` -Note: Help & settings, file details and archive listing are shown in the PAGER. +Note: Help & settings, file details and archive listing are shown in the `$PAGER`. | Mouse click | Function | |---| --- | @@ -303,8 +300,8 @@ To lookup keyboard shortcuts at runtime, press <kbd>?</kbd>. ## Developers +- Copyright © 2016-2019 [Arun Prakash Jana](https://github.com/jarun) - Copyright © 2014-2016 Lazaros Koromilas - Copyright © 2014-2016 Dimitris Papastamos -- Copyright © 2016-2019 [Arun Prakash Jana](https://github.com/jarun) Contributions are welcome. Head to the [ToDo list](https://github.com/jarun/nnn/issues/332). @@ -125,7 +125,9 @@ There is a program option to execute the current filter as a command when the pr In the \fInavigate-as-you-type\fR mode directories are opened in filter mode, allowing continuous navigation. Works best with the \fBarrow keys\fR. .br -When there's a unique match and it's a directory, `nnn` auto selects the directory and enters it in this mode. +When there's a unique match and it's a directory, +.Nm +auto selects the directory and enters it in this mode. .Sh SELECTION Use \fI^K\fR to select the file under the cursor. .Pp @@ -196,10 +198,16 @@ when dealing with the !, e and p commands respectively. A single combination to export NNN_TRASH=1 .Ed .Sh KNOWN ISSUES -If you are using urxvt you might have to set backspace key to DEC. +.Nm +may not handle keypresses correctly when used with tmux (see issue #104 for more details). Set \fBTERM=xterm-256color\fR to address it. +.Pp +Use the keybind \fBK\fR to toggle selection if you are having issues with \fB^Y\fR on *BSD or macOS. To use \fB^Y\fR, run: +.Bd -literal + stty dsusp undef +.Ed .Sh AUTHORS +.An Arun Prakash Jana Aq Mt engineerarun@gmail.com , .An Lazaros Koromilas Aq Mt lostd@2f30.org , -.An Dimitris Papastamos Aq Mt sin@2f30.org , -.An Arun Prakash Jana Aq Mt engineerarun@gmail.com . +.An Dimitris Papastamos Aq Mt sin@2f30.org . .Sh HOME .Em https://github.com/jarun/nnn |