1ICEWM-WINOPTIONS(5) Standards, Environments and Macros ICEWM-WINOPTIONS(5)
2 NAME
6 icewm-winoptions - IceWM window options configuration file
7 SYNOPSIS
9 $ICEWM_PRIVCFG/winoptions
10 $XDG_CONFIG_HOME/icewm/winoptions
11 $HOME/.icewm/winoptions
12 /etc/icewm/winoptions
13 /usr/share/icewm/winoptions
14 DESCRIPTION
16 The IceWM winoptions file contains settings to control application
17 specific window appearance and behavior. For instance, they control
18 the window border, placement and size, the window layer, its workspace,
19 its visibility on the task bar and its focus behavior.
20 The winoptions are established when icewm(1) starts. However, they can
22 be overridden later using icesh(1) or icewmhint(1). The command "icesh
23 winoptions" instructs icewm to reload the winoptions file, while
24 icewmhint tunes a specific application instance when it starts.
25 FORMAT
27 Each line in the file must be in one of the following formats:
28 NAME.CLASS.OPTION: VALUE
30 CLASS.ROLE.OPTION: VALUE
31 NAME.ROLE.OPTION: VALUE
32 CLASS.OPTION: VALUE
33 NAME.OPTION: VALUE
34 ROLE.OPTION: VALUE
35 .OPTION: VALUE
36 Here NAME and CLASS are from the WM_CLASS property of the window. This
38 can be found in the output of "icesh -a getClass".
39 While ROLE refers to the WM_WINDOW_ROLE property of the window, which
41 is the application instance specific name. Only a minority of windows
42 have it. See the output of "icesh -a list prop WM_WINDOW_ROLE".
43 In rare cases, a name, class or role may contain a period. If it does,
45 the period should be escaped by a single backslash.
46 Lastly, the OPTION: VALUE pair refer to the options and values
48 described below. A line with just a dot, followed by an option/value
49 pair, applies to all windows.
50 OPTIONS
52 There are four categories: general, function, decor and feature.
53 GENERAL OPTIONS
55 These control general characteristics of windows:
56 icon: NAME (default: none)
58 Specifies the icon name for the window. NAME is the icon name,
59 like utilities-terminal. It can also be a file, like xterm.png, a
60 full path, or a prefix of a path without sizes or suffix.
61 workspace: WORKSPACE (default: current)
63 Specifies the default workspace for the window. WORKSPACE is the
64 workspace number counting from zero (0).
65 layer: {LAYER|NUMBER} (default: Normal)
67 Specifies the default layer for the window. Layer can be one of
68 the following names or a number from zero to fifteen:
69 Desktop (0) Desktop window.
71 Below (2) Below the default layer.
72 Normal (4) Default layer for windows.
73 OnTop (6) Above the default layer.
74 Dock (8) Docked windows at edge of screen.
75 AboveDock (10) Windows above the dock.
76 Menu (12) The layer for menu's.
77 Fullscreen (14) When fullscreen and focused.
78 AboveAll (15) Always above anything.
79 geometry geometry (default: WM_SIZE_HINTS property)
81 The default geometry for the window. This geometry should be
82 specified in a format that can be parsed by XParseGeometry(3):
83 [=][<width>{xX}<height>][{+-}<xoffset>{+-}<yoffset>]
85 The default geometry is taken from the WM_SIZE_HINTS property of
87 the window or else from the initial window geometry. This option
88 overrides the default.
89 tray: {Ignore|Minimized|Exclusive|NUMBER} (default: 0)
91 The default tray option for the window. This affects both the tray
92 and the task pane. Tray can be one of the following three strings
93 or a number from zero (0) to two (2):
94 Ignore (0) No icon is added to the tray.
96 Minimized (1) Add to tray, no task when minimized.
97 Exclusive (2) Add to tray, no task button.
98 order: NUMBER (default: 0)
100 The sorting order for task buttons, tray icons, quick switch and
101 window list. The default value is zero. Increasing positive values
102 go right, while decreasing negative values go left.
103 opacity: NUMBER (default: 0)
105 Set the _NET_WM_WINDOW_OPACITY property if NUMBER is a value
106 between 1 and 100. NUMBER is interpreted as percentage of maximum
107 opaqueness.
108 keyboard: layout (default: none)
110 Specifies the keyboard layout to use for this window. The layout
111 is the name of a keyboard layout. It can be a space-separated list
112 of arguments to the setxkbmap program. Please note that setxkbmap
113 must be installed for this to work. Also define a default keyboard
114 layout in preferences.
115 frame: label (default: none)
117 All windows with the same frame label become tabs in a single
118 frame.
119 FUNCTION OPTIONS
121 Function options enable/disable (1/0) the ability to take an action on
122 the window. The normal default for all options is enabled (1) unless
123 overridden by the application:
124 fClose: {0|1} can be closed. (default: 1)
126 fHide: {0|1} can be hidden. (default: 1)
127 fMaximize: {0|1} can be maximized. (default: 1)
128 fMinimize: {0|1} can be minimized. (default: 1)
129 fMove: {0|1} can be moved. (default: 1)
130 fResize: {0|1} can be resized. (default: 1)
131 fRollup: {0|1} can be shaded. (default: 1)
132 DECOR OPTIONS
134 Decor options enable/disable (1/0) decorations on the window. The
135 normal default for all options is enabled (1) unless overridden by the
136 application or the theme:
137 dBorder: {0|1} has border. (default: 1)
139 dClose: {0|1} has close button. (default: 1)
140 dDepth: {0|1} has depth button. (default: 1)
141 dHide: {0|1} has hide button. (default: 1)
142 dMaximize: {0|1} has maximize button. (default: 1)
143 dMinimize: {0|1} has minimize button. (default: 1)
144 dResize: {0|1} has resize grips. (default: 1)
145 dRollup: {0|1} has shade button. (default: 1)
146 dSysMenu: {0|1} has window menu. (default: 1)
147 dTitleBar: {0|1} has title bar. (default: 1)
148 FEATURE OPTIONS
150 Feature options enable/disable (1/0) additional features of the window.
151 The normal default for all options is disabled (0) unless overridden by
152 the application:
153 allWorkspaces: {1|0} on all workspaces.
155 appTakesFocus: {1|0} let application take focus.
156 doNotCover: {1|0} limits workspace if sticky.
157 doNotFocus: {1|0} do not focus.
158 doNotManage: {1|0} do not manage.
159 forcedClose: {1|0} no close confirmation dialog.
160 fullKeys: {1|0} don't install icewm key bindings.
161 ignoreNoFocusHint: {1|0} focus even when no-input is set.
162 ignorePagerPreview: {1|0} do not show in pager preview.
163 ignorePositionHint: {1|0} always let icewm place the window.
164 ignoreQuickSwitch: {1|0} not on quick switch.
165 ignoreTaskBar: {1|0} not on task bar.
166 ignoreUrgentHint: {1|0} ignore urgent hints.
167 ignoreWinList: {1|0} not on window list.
168 ignoreActivationMessages: {1|0} only user can focus window.
169 ignoreOverrideRedirect: {1|0} ignore the override redirect flag.
170 noFocusOnAppRaise: {1|0} no automatic focus on raise.
171 noFocusOnMap: {1|0} do not focus when mapped.
172 noIgnoreTaskBar: {1|0} always show on task bar.
173 startClose: {1|0} close the window immediately.
174 startFullscreen: {1|0} start full screen.
175 startMaximized: {1|0} start maximized.
176 startMaximizedHorz: {1|0} start maximized horizontal.
177 startMaximizedVert: {1|0} start maximized vertical.
178 startMinimized: {1|0} start minimized.
179 EXAMPLES
181 This example uses the WM_WINDOW_ROLE property value "pop-up" to deny
182 input focus to Chrome pop-ups and asks to close them immediately.
183 google-chrome.pop-up.doNotFocus: 1
185 google-chrome.pop-up.forcedClose: 1
186 google-chrome.pop-up.ignorePagerPreview: 1
187 google-chrome.pop-up.ignoreUrgentHint: 1
188 google-chrome.pop-up.layer: Below
189 google-chrome.pop-up.noFocusOnAppRaise: 1
190 google-chrome.pop-up.noFocusOnMap: 1
191 google-chrome.pop-up.startClose: 1
192 google-chrome.pop-up.startMinimized: 1
193 IceWM places dockapps in a container automatically, but for those that
195 fail to comply with the protocol it can also be emulated. An emulated
196 dockapp should appear on all workspaces, have no decorations, and
197 always be visible in a fixed location.
198 wmtime.wmtime.allWorkspaces: 1
200 wmtime.wmtime.ignoreTaskBar: 1
201 wmtime.wmtime.ignoreQuickSwitch: 1
202 wmtime.wmtime.ignoreWinList: 1
203 wmtime.wmtime.layer: Below
204 wmtime.wmtime.dTitleBar: 0
205 wmtime.wmtime.dBorder: 1
206 wmtime.wmtime.geometry: 64x64-74-100
207 Following shows how a shaped output-only application is shown without
209 titlebar and minimal functionality.
210 xeyes.tray: Exclusive
212 xeyes.ignoreWinList: 0
213 xeyes.ignoreTaskBar: 1
214 xeyes.allWorkspaces: 1
215 xeyes.dTitleBar: 0
216 xeyes.dBorder: 0
217 xeyes.dSysMenu: 0
218 xeyes.dResize: 0
219 xeyes.dClose: 0
220 xeyes.dMinimize: 0
221 xeyes.dMaximize: 0
222 FILES
224 Locations for the winoptions file are as follows:
225 $ICEWM_PRIVCFG/winoptions
227 $XDG_CONFIG_HOME/icewm/winoptions
228 $HOME/.icewm/winoptions
229 /etc/icewm/winoptions
230 /usr/share/icewm/winoptions
231 The locations are searched in the order listed; the first file found is
233 read and the remainder ignored.
234 SEE ALSO
236 icewm(1), icesh(1), icewmhint(1), setxkbmap(1), XParseGeometry(3).
237 AUTHOR
239 Brian Bidulock <mailto:bidulock@openss7.org>.
240 LICENSE
242 IceWM is licensed under the GNU Library General Public License. See
243 the COPYING file in the distribution.
244icewm 3.4.4 2023-11-03 ICEWM-WINOPTIONS(5)