From 5ca20ad3e8cb2aa17a724357228decd46f02034f Mon Sep 17 00:00:00 2001 From: Artem Bezsmertnyi Date: Mon, 19 May 2014 22:53:23 +0300 Subject: [PATCH] Add a section about key-handler to the man page. --- Makefile | 2 +- sxiv.1 | 16 ++++++++++++++++ 2 files changed, 17 insertions(+), 1 deletion(-) diff --git a/Makefile b/Makefile index 2e6d53b..855284e 100644 --- a/Makefile +++ b/Makefile @@ -1,4 +1,4 @@ -VERSION = 1.2 +VERSION = git-20140525 PREFIX = /usr/local MANPREFIX = $(PREFIX)/share/man diff --git a/sxiv.1 b/sxiv.1 index 6b74c13..e287e55 100644 --- a/sxiv.1 +++ b/sxiv.1 @@ -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/