1ICEWM-KEYS(5) Standards, Environments and Macros ICEWM-KEYS(5)
2 NAME
6 icewm-keys - icewm keys configuration file
7 SYNOPSIS
9 $ICEWM_PRIVCFG/keys
10 $XDG_CONFIG_HOME/icewm/keys
11 $HOME/.icewm/keys
12 /etc/icewm/keys
13 /usr/share/icewm/keys
14 DESCRIPTION
16 Global keybindings to launch applications, which need not be window
17 manager related. If you are looking for ways to disable icewm's
18 grabbing of default key combinations, please read icewm-preferences(5)
19 instead.
20 Each non-empty line starts with the word "key". After one or more
22 spaces follows a double-quoted string of the bound X11 key combination
23 like "Alt+Ctrl+Shift+X". Then after at least one space follows a shell
24 command line which will be executed by icewm whenever this key
25 combination is pressed. For example, the following line creates a
26 hotkey to reload the icewm configuration:
27 key "Ctrl+Shift+r" icesh restart
29 See the output of "xmodmap -pk" for a list of keystroke names. To bind
31 the mouse use "Pointer_Button1" for button 1, and so on. The command
32 "icesh keys" instructs icewm to reload this file.
33 FORMAT
35 The syntax of the keys file is as follows:
36 key "key_combination" program options
38 Where,
40 key The literal string keyword.
42 switchkey
44 The literal string keyword, instead of "key", to build popup menus.
45 The output of program should conform to icewm-menu(1).
46 key_combination
48 A combination of modifiers and a key separated by a plus-sign
49 ("+"), like "Ctrl+Alt+Delete". Mouse pointer buttons can be
50 specified by "Pointer_Button1" and up.
51 program options
53 program is the name of the executable or full path to the
54 executable file that will be run in response to selecting the menu
55 item. When used with the switchkey keyword, the program must print
56 on standard output the contents of the popup like it would be used
57 for dynamic menus.
58 options are the options and arguments passed to the program.
60 EXAMPLES
62 Following is the example keys file that ships with icewm(1):
63 # This is an example for IceWM's hotkey definition file.
65 #
66 # A list of all valid keyboard symbols can be found in
67 # /usr/include/X11/keysym.h, keysymdefs.h, XF86keysym.h,
68 # ... You'll have to omit XK_ prefixs and to replace
69 # XF86XK_ prefixes by XF86. Valid modifiers are Alt,
70 # Ctrl, Shift, Meta, Super and Hyper.
71 #
72 key "Alt+Ctrl+t" xterm
73 key "Alt+Ctrl+b" xdg-open about:blank
74 key "Alt+Ctrl+s" xdg-open https://www.google.com
75 key "Super+KP_Subtract" amixer sset PCM 5%-
77 key "Super+KP_Add" amixer sset PCM 5%+
78 # "Multimedia key" bindings for XFree86. Gather the
80 # keycodes of your advanced function keys by watching the
81 # output of the xev command whilst pressing those keys
82 # and map those symbols by using xmodmap.
83 key "XF86AudioLowerVolume" amixer sset PCM 5%-
85 key "XF86AudioRaiseVolume" amixer sset PCM 5%+
86 key "XF86AudioMute" amixer sset PCM 0%
87 key "XF86HomePage" xdg-open about:blank
88 key "XF86Search" xdg-open https://www.google.com
89 key "XF86Eject" eject
90 # display and select monitor setup configurations
92 switchkey "Super+p" icewm-menu-xrandr
93 Following shows how to add mouse button bindings on the root window to
95 change the current workspace rolling the mouse wheel on the desktop:
96 key "Pointer_Button4" icesh goto prev
98 key "Pointer_Button5" icesh goto next
99 These are key bindings for single window tile operations to replace the
101 KeyWinArrange key bindings from the preferences file:
102 key "Ctrl+Alt+KP_7" icesh -f sizeto 49% 49% top left
104 key "Ctrl+Alt+KP_8" icesh -f sizeto 100% 49% top left
105 key "Ctrl+Alt+KP_9" icesh -f sizeto 49% 49% top right
106 key "Ctrl+Alt+KP_6" icesh -f sizeto 49% 100% top right
107 key "Ctrl+Alt+KP_3" icesh -f sizeto 49% 49% bottom right
108 key "Ctrl+Alt+KP_2" icesh -f sizeto 100% 49% bottom left
109 key "Ctrl+Alt+KP_1" icesh -f sizeto 49% 49% bottom right
110 key "Ctrl+Alt+KP_4" icesh -f sizeto 49% 100% top left
111 key "Ctrl+Alt+KP_5" icesh -f sizeto 49% 49% center
112 Some systems need this instead:
114 key "Ctrl+Alt+KP_Home" icesh -f sizeto 49% 49% top left
116 key "Ctrl+Alt+KP_Up" icesh -f sizeto 100% 49% top left
117 key "Ctrl+Alt+KP_Prior" icesh -f sizeto 49% 49% top right
118 key "Ctrl+Alt+KP_Right" icesh -f sizeto 49% 100% top right
119 key "Ctrl+Alt+KP_Next" icesh -f sizeto 49% 49% bottom right
120 key "Ctrl+Alt+KP_Down" icesh -f sizeto 100% 49% bottom left
121 key "Ctrl+Alt+KP_End" icesh -f sizeto 49% 49% bottom left
122 key "Ctrl+Alt+KP_Left" icesh -f sizeto 49% 100% top left
123 key "Ctrl+Alt+KP_Begin" icesh -f sizeto 49% 49% center
124 FILES
126 Locations for the keys file are as follows:
127 $ICEWM_PRIVCFG/keys
129 $XDG_CONFIG_HOME/icewm/keys
130 $HOME/.icewm/keys
131 /etc/icewm/keys
132 /usr/share/icewm/keys
133 The locations are searched in the order listed; the first file found is
135 read and the remainder ignored.
136 SEE ALSO
138 icewm(1).
139 AUTHOR
141 Brian Bidulock <mailto:bidulock@openss7.org>.
142 LICENSE
144 IceWM is licensed under the GNU Library General Public License. See
145 the COPYING file in the distribution.
146icewm 2.9.7 2022-05-16 ICEWM-KEYS(5)