nsxiv5ca20ad
Add a section about key-handler to the man page.
+17 −1
2 files changed
| @@ -1,4 +1,4 @@ | |||
| 1 | − | VERSION = 1.2 | |
| 1 | + | VERSION = git-20140525 | |
| 2 | 2 | ||
| 3 | 3 | PREFIX = /usr/local | |
| 4 | 4 | MANPREFIX = $(PREFIX)/share/man | |
| @@ -354,6 +354,22 @@ and the first argument to this script is the path of the loaded image. | |||
| 354 | 354 | .P | |
| 355 | 355 | There is also an example script installed together with sxiv as | |
| 356 | 356 | .IR PREFIX/share/sxiv/exec/image-info . | |
| 357 | + | .SH EXTERNAL KEY HANDLER | |
| 358 | + | Additional external keyboard commands can be defined using a handler program | |
| 359 | + | located in | |
| 360 | + | .IR $XDG_CONFIG_HOME/sxiv/exec/key-handler . | |
| 361 | + | The handler is invoked by pressing | |
| 362 | + | .BR Ctrl-x . | |
| 363 | + | The next key combo is then passed as its first argument and the path of the | |
| 364 | + | current image as its second argument. sxiv(1) will block until the handler | |
| 365 | + | terminates. It then checks if the image has been modified and reloads it. | |
| 366 | + | ||
| 367 | + | The key combo argument has the following form: "[C-][M-][S-]KEY", | |
| 368 | + | where C/M/S indicate Ctrl/Meta(Alt)/Shift modifier states and KEY is the X | |
| 369 | + | keysym as listed in /usr/include/X11/keysymdef.h without the "XK_" prefix. | |
| 370 | + | ||
| 371 | + | There is also an example script installed together with sxiv as | |
| 372 | + | .IR PREFIX/share/sxiv/exec/key-handler . | |
| 357 | 373 | .SH THUMBNAIL CACHING | |
| 358 | 374 | To enable thumbnail caching, please make sure to create the directory | |
| 359 | 375 | .I $XDG_CACHE_HOME/sxiv/ | |