summaryrefslogtreecommitdiffstats
path: root/sxiv.1
diff options
context:
space:
mode:
authorArtem Bezsmertnyi <artem.bezsmertny@gmail.com>2014-05-19 21:53:23 +0200
committerBert Münnich <ber.t@posteo.de>2014-05-24 10:04:29 +0200
commit5ca20ad3e8cb2aa17a724357228decd46f02034f (patch)
tree883d03c8744f2f2e68f7ae1205d5b0e2bb5e014f /sxiv.1
parent1560d2b4fb5803aae9162162c84af07165f0cfb9 (diff)
downloadnsxiv-5ca20ad3e8cb2aa17a724357228decd46f02034f.tar.zst
Add a section about key-handler to the man page.
Diffstat (limited to 'sxiv.1')
-rw-r--r--sxiv.116
1 files changed, 16 insertions, 0 deletions
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/