From 078c982f4e6bb01c46d5cd17ce0bcdb7eef9a02a Mon Sep 17 00:00:00 2001 From: Arun Prakash Jana Date: Sat, 23 Feb 2019 07:04:42 +0530 Subject: [PATCH] Add troubleshooting section --- README.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/README.md b/README.md index bb056a8a..c5861df2 100644 --- a/README.md +++ b/README.md @@ -63,6 +63,11 @@ It runs on Linux, macOS, Raspberry Pi, BSD, Cygwin, Linux subsystem for Windows - [Help](#help) - [Quickstart](#quickstart) - [How to](#how-to) +- [Troubleshooting](#troubleshooting) + - [tmux configuration](#tmux-configuration) + - [BSD terminal issue](#bsd-terminal-issue) + - [restrict file open](#restrict-file-open) + - [restrict 0-byte files](#restrict-0-byte-files) - [Why fork?](#why-fork) - [Mentions](#mentions) - [Developers](#developers) @@ -406,6 +411,30 @@ To lookup keyboard shortcuts at runtime, press ?. Please visit the [How to](https://github.com/jarun/nnn/wiki/How-to) wiki page. +#### TROUBLESHOOTING + +##### tmux configuration + +`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 + +By default in OpenBSD & FreeBSD, `stty` maps ^Y to `DSUSP`. This means that typing ^Y will suspend `nnn` as if you typed ^Z (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 ^Y instead. + +##### restrict file open + +In order to disable opening files on accidental navigation key (→ or l) press: + + export NNN_RESTRICT_NAV_OPEN=1 + +Use Enter to open files. + +##### restrict 0-byte files + +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 + #### WHY FORK? `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: