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 grab keys and mouse button events in X and
13       starts associated shell command.
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 run
33
34
35       -k, --key
36              Identify one key pressed (useful to fill the configuration file)
37
38
39       -mk, --multikey
40              Identify multi key pressed (useful  to  fill  the  configuration
41              file)
42
43
44       -g, --geometry
45              size and position of window with -k|-mk option
46
47
48       -n, --nodaemon
49              don't start as daemon
50
51
52       If guile support have not been disabled:
53
54       -dg, --defaults-guile
55              Print a default guile configuration file
56
57
58       -fg, --file-guile
59              Use an alternative guile configuration file
60
61

XBINDKEYSRC

63       XBindKeys uses a configuration files.  This file is $HOME/.xbindkeysrc,
64       used only for one user.  All whitespace is ignored in the files  except
65       for within the commands names double quotes.
66
67       The configuration file consists of commands names in double quotes, and
68       associated keys in the next line.
69
70       Comments are started with a pound (#) and extend  to  the  end  of  the
71       line.
72
73       You  can  see  a  default  file  with the --defaults option or create a
74       default $HOME/.xbindkeysrc with
75        'xbindkeys --defaults > $HOME/.xbindkeysrc'.
76

KEYSYMS

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

EXAMPLES

109       # control+shift+d starts an xterm (it's a comment)
110       "xterm"
111         control+shift + q
112
113       # Menu key starts xbindkeys_show
114       "xbindkeys_show"
115         Menu
116
117       # Control + mouse button 1 starts an xterm
118       "xterm"
119         Control + b:1
120
121       # Control+Shift+a  release event starts rxvt
122       "rxvt"
123         release+control+shift + a
124
125       # Control + mouse button 2 release event starts rxvt
126       "rxvt"
127         Control + b:2 + Release
128
129

SCHEME CONFIGURATION STYLE

131       If the guile support have not been disabled, you can use  an  alternate
132       configuration  file  written in scheme. xbindkeys read first the scheme
133       configuration file, and if this file doesn't exist, it read  the  stan‐
134       dard configuration file.
135
136       For more details, please see here
137         http://www.gnu.org/software/guile/guile.html
138
139       Note: The guile configuration file is the prefered way if you have a non trivial
140       configuration like for example double click, timed click or keys combinations.
141
142       The defaults is ~/.xbindkeysrc.scm
143
144       Use xbindkeys --defaults-guile for more details.
145
146       And xbindkeys --defaults-guile > ~/.xbindkeysrc.scm to use this method.
147
148

NOTE

150       xbindkeys  reload its configuration file each time it has changed.  But
151       if you want to force it reloading its configuration file, you can  send
152       a HUP signal:
153
154       killall -HUP xbindkeys
155
156       When  HUP  signal  is  send to xbindkeys, changes in $HOME/.xbindkeysrc
157       takes effect only after moving mouse.
158
159

BUGS

161       If you find a bug, please send a mail to <hocwp@free.fr>
162

HOMEPAGE

164       http://hocwp.free.fr/xbindkeys
165
166

AUTHOR

168       Philippe Brochard <hocwp@free.fr>
169       Marcello Mathias Herreshoff for the guile support <marcello@hummer.stanford.edu>
170
171

FILES

173       $HOME/.xbindkeysrc
174               The users configuration file.
175
176       $HOME/.xbindkeysrc.scm
177               The users configuration file in scheme style (if guile support have not been disabled).
178
179