penwing/zeniba-nsxiv
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Add a section about key-handler to the man page.

Browse source
This commit is contained in:
Artem Bezsmertnyi 2014-05-19 22:53:23 +03:00 committed by Bert Münnich
parent 1560d2b4fb
commit 5ca20ad3e8
2 changed files with 17 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
Makefile
View file

@ -1,4 +1,4 @@
VERSION = 1.2
VERSION = git-20140525
PREFIX = /usr/local
MANPREFIX = $(PREFIX)/share/man

16
sxiv.1
View file

@ -354,6 +354,22 @@ and the first argument to this script is the path of the loaded image.
.P
There is also an example script installed together with sxiv as
.IR PREFIX/share/sxiv/exec/image-info .
.SH EXTERNAL KEY HANDLER
Additional external keyboard commands can be defined using a handler program
located in
.IR $XDG_CONFIG_HOME/sxiv/exec/key-handler .
The handler is invoked by pressing
.BR Ctrl-x .
The next key combo is then passed as its first argument and the path of the
current image as its second argument. sxiv(1) will block until the handler
terminates. It then checks if the image has been modified and reloads it.
The key combo argument has the following form: "[C-][M-][S-]KEY",
where C/M/S indicate Ctrl/Meta(Alt)/Shift modifier states and KEY is the X
keysym as listed in /usr/include/X11/keysymdef.h without the "XK_" prefix.
There is also an example script installed together with sxiv as
.IR PREFIX/share/sxiv/exec/key-handler .
.SH THUMBNAIL CACHING
To enable thumbnail caching, please make sure to create the directory
.I $XDG_CACHE_HOME/sxiv/