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.  Each non-empty line starts with the word "key".
18       After one or more spaces follows a double-quoted string of the bound
19       X11 key combination like "Alt+Ctrl+Shift+X".  Then after at least one
20       space follows a shell command line which will be executed by icewm
21       whenever this key combination is pressed.  For example, the following
22       line creates a hotkey to reload the icewm configuration:
23
24           key "Ctrl+Shift+r"      icesh restart
25

FORMAT

27       The syntax of the keys file is as follows:
28
29           key "key_combination" program options
30
31       Where,
32
33       key The literal string keyword.
34
35       switchkey
36           The literal string keyword, used as alternative to "key" to build
37           menu-like quickswitch popups.
38
39       key_combination
40           A combination of modifiers and a key, separated by plus-sign ("+").
41
42       program options
43           program is the name of the executable or full path to the
44           executable file that will be run in response to selecting the menu
45           item.  When used with the switchkey keyword, the program must print
46           on standard output the contents of the popup like it would be used
47           for dynamic menus.
48
49           options is the options and arguments passed to the program
50           verbatim.
51

EXAMPLES

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

FILES

90       Locations for the keys file are as follows:
91
92        $ICEWM_PRIVCFG/keys
93        $XDG_CONFIG_HOME/icewm/keys
94        $HOME/.icewm/keys
95        /etc/icewm/keys
96        /usr/share/icewm/keys
97
98       The locations are searched in the order listed; the first file found is
99       read and the remainder ignored.
100

AUTHOR

105       Brian Bidulock <mailto:bidulock@openss7.org>.
106

LICENSE

108       IceWM is licensed under the GNU Library General Public License.  See
109       the COPYING file in the distribution.
110
111
112
113icewm 1.6.1                       2019-11-25                     ICEWM-KEYS(5)