diff options
Diffstat (limited to 'README.adoc')
| -rw-r--r-- | README.adoc | 26 |
1 files changed, 16 insertions, 10 deletions
diff --git a/README.adoc b/README.adoc index 28ff6c1..b7aeecf 100644 --- a/README.adoc +++ b/README.adoc @@ -5,14 +5,15 @@ sdn 'sdn' is a simple directory navigator that you can invoke while editing shell commands. It enables you to: - * take a quick peek at directory contents without running `ls` + * take a quick peek at directory contents without running `ls`; + * select files to insert into the command line; * browse the filesystem without all the mess that Midnight Commander does: there's no need to create a subshell in a new pty. The current command line can be simply forwarded if it is to be edited. What's more, it will always be obvious whether the navigator is running. -The only supported platform is Linux. I wanted to try a different, simpler -approach here, and the end result is very friendly to tinkering. +'sdn' runs on Linux and all BSD derivatives. I wanted to try a different, +simpler approach here, and the end result is very friendly to tinkering. image::sdn.png[align="center"] @@ -25,8 +26,8 @@ or as a https://git.janouch.name/p/nixexprs[Nix derivation]. Building -------- -Build dependencies: CMake and/or make, a C++14 compiler, pkg-config + -Runtime dependencies: ncursesw, libacl +Build dependencies: CMake and/or make, a C++17 compiler, pkg-config + +Runtime dependencies: ncursesw, libacl (on Linux) // Working around libasciidoc's missing support for escaping it like \++ Unfortunately most LLVM libc{plus}{plus} versions have a bug that crashes 'sdn' @@ -75,6 +76,7 @@ that of git, only named colours aren't supported: .... cursor 231 202 +select 202 bold bar 16 255 ul cwd bold input @@ -91,15 +93,19 @@ To obtain more vifm-like controls, you may write the following to your .... normal h parent -normal l choose +normal l enter .... 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. +The F3, F13 and F4 keys are normally bound to actions 'view', 'view-raw', +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. + +If 'view' finds Midnight Commander, it will make use of its configuration +to apply any matching filter, such as to produce archive listings, +or it will run the respective command. 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 |