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              Idenfify 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
87       configuration file.
88
89       A list of keys is in /usr/include/X11/keysym.h and in
90       /usr/include/X11/keysymdef.h.
91       The XK_ is not needed.
92
93       List of modifier:
94           Release, Control, Shift, Mod1 (Alt), Mod2 (NumLock),
95           Mod3 (CapsLock), Mod4, Mod5 (Scroll).
96
97       The release modifier is not a standard X modifier, but you can
98       use it if you want to catch release events instead of press events.
99
100       By defaults, xbindkeys does not pay attention with the modifiers
101       NumLock, CapsLock and ScrollLock.
102       Add the lines above in the configuration file, if you want to pay
103       attention to them.
104
105           keystate_numlock = enable
106           keystate_capslock = enable
107           keystate_scrolllock= enable
108
109

EXAMPLES

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

SCHEME CONFIGURATION STYLE

133       If  the  guile support have not been disabled, you can use an alternate
134       configuration file writen in scheme. xbindkeys read  first  the  scheme
135       configuration  file,  and if this file doesn't exist, it read the stan‐
136       tard configuration file.
137
138       The defaults is ~/.xbindkeysrc.scm
139
140       Use xbindkeys --defaults-guile for more details.
141
142       And xbindkeys --defaults-guile > ~/.xbindkeysrc.scm to use  this  meth‐
143       ode.
144
145

NOTE

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

BUGS

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

HOMEPAGE

161       http://hocwp.free.fr/xbindkeys
162
163

AUTHOR

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

FILES

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