xbindkeys(1)

1XBindKeys(1)                General Commands Manual               XBindKeys(1)
2
3
4

NAME

6       xbindkeys - a grabbing keys program for X
7

SYNOPSIS

9       xbindkeys [ options ]
10

DESCRIPTION

12       XbindKeys  is a program that grabs key and mouse button events in X and
13       starts associated shell commands.
14
15

COMMAND LINE OPTIONS

17       Available command line options are as follows:
18
19       -d, --defaults
20              Print a default rc file
21
22       -f, --file
23              Use an alternative rc file
24
25       -h, --help
26              Short help on options plus version/author info.
27
28       -X, --display
29              Set X display to use
30
31       -v, --verbose
32              More information on xbindkeys when it runs
33
34
35       -k, --key
36              Identify one key pressed (useful for configuration)
37
38
39       -mk, --multikey
40              Identify multi key pressed (useful for configuration)
41
42
43       -g, --geometry
44              size and position of window with -k|-mk option
45
46
47       -n, --nodaemon
48              don't start as daemon
49
50
51       If guile support has not been disabled:
52
53       -dg, --defaults-guile
54              Print a default guile configuration file
55
56
57       -fg, --file-guile
58              Use an alternative guile configuration file
59
60

XBINDKEYSRC

62       XBindKeys default configuration file  is  at  $HOME/.xbindkeysrc,  used
63       only for one user.
64
65       The configuration file consists of commands in double quotes, and asso‐
66       ciated keys in the next line.
67
68       Comments are started with a pound (#) and extend  to  the  end  of  the
69       line.
70
71       You can see a default configuration with --defaults
72

KEYSYMS

74       The  program  expects  combinations of keysyms to be used by using plus
75       (+) characters to combine them together.
76
77       The format of a command line is:
78           "command to start &"
79              associated key
80
81       To specify an associated key, you can use `xbindkeys --key` or
82        `xbindkeys --multikey` and put one of the two lines in the  configura‐
83       tion file.
84
85       A    list    of   keys   is   in   /usr/include/X11/keysym.h   and   in
86       /usr/include/X11/keysymdef.h.  The XK_ is not needed.
87
88       List of modifiers:
89           Release, Control, Shift, Mod1 (Alt), Mod2 (NumLock),
90           Mod3 (CapsLock), Mod4, Mod5 (Scroll).
91
92       The release modifier is not a standard X modifier, but you can  use  it
93       if you want to catch release events instead of press events.  Modifiers
94       are not case sensitive.
95
96       By defaults, xbindkeys does not pay attention to the modifiers NumLock,
97       CapsLock and ScrollLock.  Add the lines below in the configuration file
98       if you want to pay attention to them.
99
100           keystate_numlock = enable
101           keystate_capslock = enable
102           keystate_scrolllock= enable
103
104

EXAMPLES

106       # control+shift+q starts xterm
107       "xterm"
108         control+shift + q
109
110       # Menu key starts xbindkeys_show
111       "xbindkeys_show"
112         Menu
113
114       # Control + mouse button 1 starts xterm
115       "xterm"
116         Control + b:1
117
118       # Control+Shift+a  release event starts rxvt
119       "rxvt"
120         release+control+shift + a
121
122       # Control + mouse button 2 release event starts rxvt
123       "rxvt"
124         Control + b:2 + Release
125
126

SCHEME CONFIGURATION STYLE

128       A scheme configuration can be used if guile support has not  been  dis‐
129       abled.  The standard configuration is loaded only if the scheme config‐
130       uration is not available.
131
132       For more details, please see here
133         http://www.gnu.org/software/guile/guile.html
134
135       Note: The guile configuration file is prefered for non trivial
136       configurations, for example double click, timed click or key combinations.
137
138       The default location is ~/.xbindkeysrc.scm
139
140       Use xbindkeys --defaults-guile for more details.
141
142       And xbindkeys --defaults-guile > ~/.xbindkeysrc.scm to use this method.
143
144

NOTE

146       xbindkeys reloads the configuration file if modified.  Send a HUP  sig‐
147       nal to force reloading:
148
149       killall -HUP xbindkeys
150
151       When  a HUP signal is sent to xbindkeys, changes take effect only after
152       moving the mouse.
153
154

BUGS

156       If you find a bug, please send mail to <xbindkeys-devel@nongnu.org>
157

HOMEPAGE

159       http://www.nongnu.org/xbindkeys/
160
161

AUTHOR

163       Philippe Brochard <hocwp@free.fr>
164       Marcello Mathias Herreshoff for guile support <marcello@hummer.stanford.edu>
165
166

FILES

168       $HOME/.xbindkeysrc
169               The users configuration file.
170
171       $HOME/.xbindkeysrc.scm
172               The users configuration file in scheme
173               (if guile support has not been disabled).
174
175