Update documentation
All checks were successful
Alpine 3.20 Success
Arch Linux AUR Success
OpenBSD 7.5 Success

This commit is contained in:
Přemysl Eric Janouch 2024-12-30 19:36:51 +01:00
parent 9b274417c5
commit 977d1a7120
Signed by: p
GPG Key ID: A0420B94F92B9493
3 changed files with 19 additions and 11 deletions

View File

@ -5,7 +5,8 @@ sdn
'sdn' is a simple directory navigator that you can invoke while editing shell 'sdn' is a simple directory navigator that you can invoke while editing shell
commands. It enables you to: 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: * 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 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 can be simply forwarded if it is to be edited. What's more, it will always
@ -75,6 +76,7 @@ that of git, only named colours aren't supported:
.... ....
cursor 231 202 cursor 231 202
select 202 bold
bar 16 255 ul bar 16 255 ul
cwd bold cwd bold
input input
@ -91,15 +93,19 @@ To obtain more vifm-like controls, you may write the following to your
.... ....
normal h parent normal h parent
normal l choose normal l enter
.... ....
Helper programs Helper programs
~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~
The F3 and F4 keys are normally bound to actions 'view' and 'edit', similarly to The F3, F13 and F4 keys are normally bound to actions 'view', 'view-raw',
Norton Commander and other orthodox file managers. The helper programs used and 'edit', similarly to Norton Commander and other orthodox file managers.
here may be changed by setting the PAGER and VISUAL (or EDITOR) environment The helper programs used here may be changed by setting the PAGER and VISUAL
variables. (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 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 `PAGER='mcview -u' sdn`, beware that this helper cannot read files from its

View File

@ -1,4 +1,4 @@
.Dd December 28, 2024 .Dd December 30, 2024
.Dt SDN-VIEW 1 .Dt SDN-VIEW 1
.Os .Os
.Sh NAME .Sh NAME
@ -16,7 +16,8 @@ or a fallback pager on the passed filename.
If it succeeds in finding a If it succeeds in finding a
.Xr mc 1 .Xr mc 1
.Pa mc.ext.ini .Pa mc.ext.ini
file, it will first process it, and apply any matching filter. file, it will first process it, and apply any matching filter,
or run the respective command.
.Sh REPORTING BUGS .Sh REPORTING BUGS
Use Use
.Lk https://git.janouch.name/p/sdn .Lk https://git.janouch.name/p/sdn

7
sdn.1
View File

@ -1,5 +1,5 @@
\" https://mandoc.bsd.lv/man/roff.7.html#Sentence_Spacing \" https://mandoc.bsd.lv/man/roff.7.html#Sentence_Spacing
.Dd October 27, 2020 .Dd December 30, 2024
.Dt SDN 1 .Dt SDN 1
.Os .Os
.Sh NAME .Sh NAME
@ -95,7 +95,7 @@ names are used for special keys.
To obtain more vifm-like controls and Windows-like quit abilities: To obtain more vifm-like controls and Windows-like quit abilities:
.Bd -literal -offset indent .Bd -literal -offset indent
normal h parent normal h parent
normal l choose normal l enter
normal M-f4 quit normal M-f4 quit
.Ed .Ed
.Pp .Pp
@ -107,7 +107,7 @@ For rxvt, that would be:
define C-ppage ^[[5^ define C-ppage ^[[5^
define C-npage ^[[6^ define C-npage ^[[6^
normal C-ppage parent normal C-ppage parent
normal C-npage choose normal C-npage enter
.Ed .Ed
.Pp .Pp
Escape characters must be inserted verbatim, e.g., by pressing C-v ESC in vi, Escape characters must be inserted verbatim, e.g., by pressing C-v ESC in vi,
@ -120,6 +120,7 @@ For a black-on-white terminal supporting 256 colours, a theme such as the
following may work: following may work:
.Bd -literal -offset indent .Bd -literal -offset indent
cursor 231 202 cursor 231 202
select 202 bold
bar 16 255 ul bar 16 255 ul
cwd bold cwd bold
input input