summaryrefslogtreecommitdiff
path: root/README.adoc
diff options
context:
space:
mode:
authorPřemysl Eric Janouch <p@janouch.name>2020-09-28 21:18:08 +0200
committerPřemysl Eric Janouch <p@janouch.name>2020-09-28 21:26:33 +0200
commit9a2f6ab5cfcea44eeae0689b8c3c4c1d452156c0 (patch)
treecd7a845ce0e5fa3e4b7b4888e070a553c58569c0 /README.adoc
parent0a66ae4d266ea32e68497863c3ec424244d6cf09 (diff)
downloadsdn-9a2f6ab5cfcea44eeae0689b8c3c4c1d452156c0.tar.gz
sdn-9a2f6ab5cfcea44eeae0689b8c3c4c1d452156c0.tar.xz
sdn-9a2f6ab5cfcea44eeae0689b8c3c4c1d452156c0.zip
README.adoc: talk about view and edit helpers
Diffstat (limited to 'README.adoc')
-rw-r--r--README.adoc22
1 files changed, 18 insertions, 4 deletions
diff --git a/README.adoc b/README.adoc
index 3e713af..e49cbce 100644
--- a/README.adoc
+++ b/README.adoc
@@ -89,10 +89,10 @@ bind -x '"\201": sdn-restore'
bind '"\eo":"\200\C-m\201"'
....
-Colors
-------
+Colours
+-------
Here is an example of a '~/.config/sdn/look' file; the format is similar to
-that of git, only named colors aren't supported:
+that of git, only named colours aren't supported:
....
cursor 231 202
@@ -101,7 +101,7 @@ cwd bold
input
....
-Filename colors are taken from the `LS_COLORS` environment variable.
+Filename colours are taken from the `LS_COLORS` environment variable.
Run `dircolors` to get some defaults.
Bindings
@@ -115,6 +115,20 @@ normal l choose
normal ? help
....
+Helper programs
+---------------
+The F3 and F4 keys are normally bound to actions 'view' and 'edit', similarly to
+Norton Commander and other orthodox file managers. The helper programs used
+here may be changed by setting the PAGER and VISUAL (or EDITOR) environment
+variables.
+
+While it is mostly possible to get 'mcview' working using an invocation like
+`PAGER='mcview -u' sdn`, beware that this helper cannot read files from its
+standard input, nor does it enable overstrike processing by default (F9, could
+be hacked around in 'mc.ext' by turning on the `nroff` switch for a custom file
+extension, just without actually invoking 'nroff'), and thus it can't show the
+program help. 'sdn' is currently optimised for 'less' as the pager.
+
Similar software
----------------
* https://elvish.io/ is an entire shell with an integrated ranger-like file