p/sdn
1
1
Fork 0
Code Issues 2 Pull Requests Releases Wiki Activity

README.adoc: split into subsections

Browse Source
This commit is contained in:
Přemysl Eric Janouch 2020-10-01 04:07:56 +02:00
parent 063938ff60
commit 6e8d816ada
Signed by: p
GPG Key ID: A0420B94F92B9493
1 changed files with 20 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
README.adoc
View File

@ -45,8 +45,11 @@ Or you can try telling CMake to make a package for you. For Debian it is:
There is also a Makefile you can use to quickly build a binary to be copied There is also a Makefile you can use to quickly build a binary to be copied
into the PATH of any machine you want to have 'sdn' on. into the PATH of any machine you want to have 'sdn' on.
Integration
-----------
zsh zsh
--- ~~~
To start using this navigator, put the following in your '.zshrc': To start using this navigator, put the following in your '.zshrc':
.... ....
@ -65,25 +68,25 @@ bindkey '\eo' sdn-navigate
.... ....
fish fish
---- ~~~~
To start using this navigator, put the following in your 'config.fish': To start using this navigator, put the following in your 'config.fish':
.... ....
function sdn-navigate function sdn-navigate
set --local IFS set --local IFS
while eval (sdn | string replace -ar '^(.*?)=' 'set --$1 ') while eval (sdn | string replace -ar '^(.*?)=' 'set --$1 ')
test -z "$cd" || cd "$cd" test -z "$cd" || cd "$cd"
test -z "$insert" || commandline --insert "$insert " test -z "$insert" || commandline --insert "$insert "
test -z "$helper" && break test -z "$helper" && break
eval $helper || break eval $helper || break
end end
commandline --function repaint commandline --function repaint
end end
bind \eo sdn-navigate bind \eo sdn-navigate
.... ....
bash bash
---- ~~~~
Here we can't reset the prompt from within a `bind -x` handler but there is Here we can't reset the prompt from within a `bind -x` handler but there is
an acceptable workaround that sadly submits a blank line: an acceptable workaround that sadly submits a blank line:
@ -112,8 +115,11 @@ bind -x '"\201": sdn-restore'
bind '"\eo":"\200\C-m\201"' bind '"\eo":"\200\C-m\201"'
.... ....
Configuration
-------------
Colours Colours
------- ~~~~~~~
Here is an example of a '~/.config/sdn/look' file; the format is similar to Here is an example of a '~/.config/sdn/look' file; the format is similar to
that of git, only named colours aren't supported: that of git, only named colours aren't supported:
@ -128,7 +134,7 @@ Filename colours are taken from the `LS_COLORS` environment variable.
Run `dircolors` to get some defaults. Run `dircolors` to get some defaults.
Bindings Bindings
-------- ~~~~~~~~
To obtain more vifm-like controls, you may write the following to your To obtain more vifm-like controls, you may write the following to your
'~/.config/sdn/bindings' file: '~/.config/sdn/bindings' file:
@ -139,7 +145,7 @@ normal ? help
.... ....
Helper programs Helper programs
--------------- ~~~~~~~~~~~~~~~
The F3 and F4 keys are normally bound to actions 'view' and 'edit', similarly to 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 Norton Commander and other orthodox file managers. The helper programs used
here may be changed by setting the PAGER and VISUAL (or EDITOR) environment here may be changed by setting the PAGER and VISUAL (or EDITOR) environment