From f13974ff2cc79eebca7912d422e464c702001ac0 Mon Sep 17 00:00:00 2001 From: Arun Prakash Jana Date: Sun, 11 Mar 2018 13:42:49 +0530 Subject: [PATCH] Add table of external dependencies --- README.md | 18 +++++++++++++----- nlay | 9 ++++----- 2 files changed, 17 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index f1648c46..f0589395 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,7 @@ Cool things you can do with `nnn`: - lock the current terminal after a specified idle time - change directory on exit -If you want to edit a file in vim with some soothing music in the background while referring to a spec in your GUI PDF viewer, `nnn` got it! [Quickstart](#quickstart) and see how `nnn` simplifies those long desktop sessions... +If you want to edit a file in vi with some soothing music in the background while referring to a spec in your GUI PDF viewer, `nnn` got it! [Quickstart](#quickstart) and see how `nnn` simplifies those long desktop sessions... Have fun with it! PRs are welcome. Check out [#1](https://github.com/jarun/nnn/issues/1). @@ -294,7 +294,18 @@ The following abbreviations are used in the detail view: #### File handling -- `nnn` uses `xdg-open` on Linux and `open(1)` on OS X as the desktop opener. +| External dependency | Operation | +| --- | --- | +| xdg-open (Linux), open(1) (OS X) | desktop opener | +| mediainfo, exiftool | multimedia file details | +| gnome-search-tool, catfish | desktop search utility | +| atool | list and extract archives | +| vidir from moreutils | batch rename, move, delete dir entries | +| vlock (Linux) | terminal locker | +| $EDITOR | edit files (fallback vi) | +| $PAGER | page through files (fallback less) | +| $SHELL | spawn a shell in dir (fallback sh) | + - To edit all text files in EDITOR (preferably CLI, fallback vi): export NNN_USE_EDITOR=1 @@ -302,9 +313,6 @@ The following abbreviations are used in the detail view: export NNN_DE_FILE_MANAGER=thunar export NNN_DE_FILE_MANAGER=nautilus -- [mediainfo](https://mediaarea.net/en/MediaInfo) (or [exiftool](https://sno.phy.queensu.ca/~phil/exiftool/), if specified) is required to view media information -- [atool](http://www.nongnu.org/atool/) is required to list and extract archives -- vidir from [moreutils](https://joeyh.name/code/moreutils/) is used to batch rename entries in current directory #### Help diff --git a/nlay b/nlay index e554c01a..2a5579bc 100755 --- a/nlay +++ b/nlay @@ -12,14 +12,13 @@ # bg settings. If bg is set the app is detached and started in the background # in silent mode. # -# The bg setting depends on personal preference and type of app, e.g., -# I would start vim (CLI) in the foreground but Sublime Text (GUI) in the -# background. +# The bg setting depends on personal preferences and type of utility, e.g., I +# would start vi (CLI) in the foreground but Sublime Text (GUI) in background. # # Check (and TOGGLE as you wish) the default bg settings. # # 2. Detached apps are not killed when nnn exits. Use kill(1) or killall(1) to -# to stop console based background apps. +# stop console based background apps. # # 3. nlay is OVERWRITTEN during nnn upgrade. You can store your custom nlay in a # location other than the default and have an alias with nnn option '-p' to @@ -56,7 +55,7 @@ ENABLE_FILE_TYPE_HANDLING #------------ PLAINTEXT (UNUSED) ------------ if [ "$2" == "text" ]; then - app=("vim") + app=("vi") opts=("")