icewm-keys(5)

1ICEWM-KEYS(5)         Standards, Environments and Macros         ICEWM-KEYS(5)
2
3
4

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
21       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
28           key "Ctrl+Shift+r"      icesh restart
29
30       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
37           key "key_combination" program options
38
39       Where,
40
41       key The literal string keyword.
42
43       switchkey
44           The literal string keyword, used as alternative to "key" to build
45           menu-like quickswitch popups.
46
47       key_combination
48           A combination of modifiers and a key, separated by plus-sign ("+").
49
50       program options
51           program is the name of the executable or full path to the
52           executable file that will be run in response to selecting the menu
53           item.  When used with the switchkey keyword, the program must print
54           on standard output the contents of the popup like it would be used
55           for dynamic menus.
56
57           options is the options and arguments passed to the program
58           verbatim.
59

EXAMPLES

61       Following is the example keys file that ships with icewm(1):
62
63           # This is an example for IceWM's hotkey definition file.
64           #
65           # Place your variants in @CFGDIR@ or in $HOME/.icewm
66           # since modifications to this file will be discarded when
67           # you (re)install icewm.
68           #
69           # A list of all valid keyboard symbols can be found in
70           # /usr/include/X11/keysym.h, keysymdefs.h, XF86keysym.h,
71           # ...  You'll have to omit XK_ prefixs and to replace
72           # XF86XK_ prefixes by XF86. Valid modifiers are Alt,
73           # Ctrl, Shift, Meta, Super and Hyper.
74           #
75           key "Alt+Ctrl+t" xterm
76           key "Alt+Ctrl+b" xdg-open about:blank
77           key "Alt+Ctrl+s" xdg-open https://www.google.com
78
79           key "Super+KP_Subtract" amixer sset PCM 5%-
80           key "Super+KP_Add" amixer sset PCM 5%+
81
82           # "Multimedia key" bindings for XFree86. Gather the
83           # keycodes of your advanced function keys by watching the
84           # output of the xev command whilest pressing those keys
85           # and map those symbols by using xmodmap.
86
87           key "XF86AudioLowerVolume" amixer sset PCM 5%-
88           key "XF86AudioRaiseVolume" amixer sset PCM 5%+
89           key "XF86AudioMute" amixer sset PCM 0%
90           key "XF86HomePage" xdg-open about:blank
91           key "XF86Search" xdg-open https://www.google.com
92           key "XF86Eject" eject
93
94           # display and select monitor setup configurations
95           switchkey "Super+p" icewm-menu-xrandr
96

FILES

98       Locations for the keys file are as follows:
99
100        $ICEWM_PRIVCFG/keys
101        $XDG_CONFIG_HOME/icewm/keys
102        $HOME/.icewm/keys
103        /etc/icewm/keys
104        /usr/share/icewm/keys
105
106       The locations are searched in the order listed; the first file found is
107       read and the remainder ignored.
108

AUTHOR

113       Brian Bidulock <mailto:bidulock@openss7.org>.
114

LICENSE

116       IceWM is licensed under the GNU Library General Public License.  See
117       the COPYING file in the distribution.
118
119
120
121icewm 2.3.0                       2021-04-02                     ICEWM-KEYS(5)