xhotkeys(1)

1xhotkeys(1)                           X11                          xhotkeys(1)
2
3
4

NAME

6       xhotkeys - Bind keys and mouse events to commands in the X-Window
7

SYNOPSIS

9       xhotkeys [options]
10

DESCRIPTION

12       The  purpose  of  xhotkeys is to provide a simple and easy configurable
13       hotkey launcher for the X-Window System, independent from  the  desktop
14       (Gnome, KDE, Xfce, ...) used.
15
16       Although  xhotkeys  has a graphical GTK+ configurator, it's possible to
17       manage configuration files manually.
18

CONFIGURATION

20       The xhotkeys daemon should be run after X user  logs  in.  All  desktop
21       interfaces  provide  (or should provide) a way to do this automatically
22       (for example, Gnome has the Startup Programs at Sessions). Take a  look
23       on the documentation.
24

OPTIONS

26       -h | --help
27              Displays the help message and exit
28
29
30       -v | --verbose
31              Increase the level of verbosity (0: error, 1: info, 2: debug)
32
33
34       -c | --config
35              Start GTK+ configurator
36
37
38       -f | --configuration-file  configuration_file
39              Alternative configuration file
40
41

CONFIGURATION FILE

43       By default, $HOME/.xhotkeys would be used. Any line beggining with # is
44       ignored.  Hotkeys are defined that way:
45
46       name=[<modifier1>][<modifier2>][<modifierN>]key:command
47
48       Hotkey names cannot use = character.
49
50       Available modifiers are: shift, control, alt, winkey, altgr, lock,  and
51       mod3.  Available  keys  are  all  the strings defined in miscellany and
52       latin1 Xlib source files. Both modifiers and keys are case-insensitive.
53       Moreover, you can define some special key values:
54
55       @DIGIT@ meaning keycode = DIGIT (use for keys without X-name)
56
57       ButtonX meaning a mouse button (where X=1..5)
58
59       Examples:
60
61         Calculator=<control><alt>F1:xcalc
62         Eyes=<control><winkey>Button3:xeyes
63         Window's Info=<alt><shift>@103@:xwininfo
64
65

FILES

67       ~/.xhotkeys
68            Default configuration for current user
69
70       ~/.xhotkeys.settings-$USER
71            Last window's setting used on GTK+ configurator
72
73       ~/.xhotkeys.pid-$USER
74            Pidfile for running daemon
75
76       /usr/lib/python-VERSION/site-packages/Xlib/keysymdef/latin1.py
77            String definitions for latin1 keycodes.
78
79       /usr/lib/python-VERSION/site-packages/Xlib/keysymdef/miscellany.py
80            String definitions for control keycodes.
81
82

ENVIRONMENT

84       USER and HOME are used to get username and user's home path.
85
86

SIGNALS

88       SIGHUP  makes  the  hotkey  daemon to reload the configuration file and
89       continue running.
90

AUTHOR

92       Arnau Sanchez <arnau@ehas.org>.
93
94       Some ideas were taken from keylaunch (Ken Lynch and  Stefan  Pfetzing).
95       Without their code this utility would have been painful to program.
96