Debian Codegraph @

upstream/debian-unstable/man5/icewm-winoptions.5

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "ICEWM-WINOPTIONS 5"
58 .TH ICEWM-WINOPTIONS 5 2026-01-18 "icewm\ 4.0.0" "Standards, Environments and Macros"
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SS NAME
64 .IX Subsection "NAME"
65 .Vb 1
66 \& icewm\-winoptions \- IceWM window options configuration file
67 .Ve
68 .SS SYNOPSIS
69 .IX Subsection "SYNOPSIS"
70 .Vb 5
71 \& $ICEWM_PRIVCFG/winoptions
72 \& $XDG_CONFIG_HOME/icewm/winoptions
73 \& $HOME/.icewm/winoptions
74 \& /etc/X11/icewm/winoptions
75 \& /usr/share/icewm/winoptions
76 .Ve
77 .SS DESCRIPTION
78 .IX Subsection "DESCRIPTION"
79 The IceWM \fIwinoptions\fR file contains settings to control
80 \&\fIapplication specific\fR window appearance and behavior.
81 For instance, they control the window border, placement and size,
82 the window layer, its workspace, its visibility on the task bar
83 and its focus behavior.
84 .PP
85 The winoptions are established when \fBicewm\fR\|(1) starts. However,
86 they can be overridden later using \fBicesh\fR\|(1) or \fBicewmhint\fR\|(1).
87 The command \f(CW\*(C`icesh winoptions\*(C'\fR instructs icewm to reload the
88 \&\fIwinoptions\fR file, while \fIicewmhint\fR tunes a specific application
89 instance when it starts.
90 .SS FORMAT
91 .IX Subsection "FORMAT"
92 Each line in the file must be in one of the following formats:
93 .RS 4
94 .IP "\fINAME\fR\fB.\fR\fICLASS\fR\fB.\fR\fIOPTION\fR\fB:\fR \fIVALUE\fR" 4
95 .IX Item "NAME.CLASS.OPTION: VALUE"
96 .PD 0
97 .IP "\fICLASS\fR\fB.\fR\fIROLE\fR\fB.\fR\fIOPTION\fR\fB:\fR \fIVALUE\fR" 4
98 .IX Item "CLASS.ROLE.OPTION: VALUE"
99 .IP "\fINAME\fR\fB.\fR\fIROLE\fR\fB.\fR\fIOPTION\fR\fB:\fR \fIVALUE\fR" 4
100 .IX Item "NAME.ROLE.OPTION: VALUE"
101 .IP "\fICLASS\fR\fB.\fR\fIOPTION\fR\fB:\fR \fIVALUE\fR" 4
102 .IX Item "CLASS.OPTION: VALUE"
103 .IP "\fINAME\fR\fB.\fR\fIOPTION\fR\fB:\fR \fIVALUE\fR" 4
104 .IX Item "NAME.OPTION: VALUE"
105 .IP "\fIROLE\fR\fB.\fR\fIOPTION\fR\fB:\fR \fIVALUE\fR" 4
106 .IX Item "ROLE.OPTION: VALUE"
107 .IP "\fB.\fR\fIOPTION\fR\fB:\fR \fIVALUE\fR" 4
108 .IX Item ".OPTION: VALUE"
109 .RE
110 .RS 4
111 .RE
112 .PD
113 .PP
114 Here \fINAME\fR and \fICLASS\fR are from the \fBWM_CLASS\fR property of the
115 window. This can be found in the output of \f(CW\*(C`icesh \-a getClass\*(C'\fR.
116 .PP
117 While \fIROLE\fR refers to the \fBWM_WINDOW_ROLE\fR property of the window,
118 which is the application instance specific name. Only a minority of
119 windows have it. See the output of \f(CW\*(C`icesh \-a list prop WM_WINDOW_ROLE\*(C'\fR.
120 .PP
121 In rare cases, a name, class or role may contain a period. If it does,
122 the period should be escaped by a single backslash.
123 .PP
124 Lastly, the \fIOPTION: VALUE\fR pair refer to the options and values
125 described below. A line with just a dot, followed by an option/value
126 pair, applies to all windows.
127 .SS OPTIONS
128 .IX Subsection "OPTIONS"
129 There are four categories: \fIgeneral\fR, \fIfunction\fR, \fIdecor\fR and
130 \&\fIfeature\fR.
131 .SS "GENERAL OPTIONS"
132 .IX Subsection "GENERAL OPTIONS"
133 These control general characteristics of windows:
134 .IP "\fBicon\fR: \fINAME\fR (default: none)" 4
135 .IX Item "icon: NAME (default: none)"
136 Specifies the icon name for the window. \fINAME\fR is the icon name, like
137 \&\fIutilities-terminal\fR. It can also be a file, like \fIxterm.png\fR, a full
138 path, or a prefix of a path without sizes or suffix.
139 .IP "\fBworkspace\fR: \fIWORKSPACE\fR (default: current)" 4
140 .IX Item "workspace: WORKSPACE (default: current)"
141 Specifies the default workspace for the window. \fIWORKSPACE\fR is the
142 workspace number counting from zero (0).
143 .IP "\fBlayer\fR: {\fILAYER\fR|\fINUMBER\fR} (default: Normal)" 4
144 .IX Item "layer: {LAYER|NUMBER} (default: Normal)"
145 Specifies the default layer for the window. Layer can be one of the
146 following names or a number from zero to fifteen:
147 .Sp
148 .Vb 9
149 \& Desktop (0) Desktop window.
150 \& Below (2) Below the default layer.
151 \& Normal (4) Default layer for windows.
152 \& OnTop (6) Above the default layer.
153 \& Dock (8) Docked windows at edge of screen.
154 \& AboveDock (10) Windows above the dock.
155 \& Menu (12) The layer for menu\*(Aqs.
156 \& Fullscreen (14) When fullscreen and focused.
157 \& AboveAll (15) Always above anything.
158 .Ve
159 .IP "\fBgeometry\fR \fIgeometry\fR (default: WM_SIZE_HINTS property)" 4
160 .IX Item "geometry geometry (default: WM_SIZE_HINTS property)"
161 The default geometry for the window. This geometry should be specified
162 in a format that can be parsed by \fBXParseGeometry\fR\|(3):
163 .Sp
164 .Vb 1
165 \& [=][<width>{xX}<height>][{+\-}<xoffset>{+\-}<yoffset>]
166 .Ve
167 .Sp
168 The default geometry is taken from the WM_SIZE_HINTS property of the
169 window or else from the initial window geometry. This option overrides
170 the default.
171 .IP "\fBtray\fR: {\fBIgnore\fR|\fBMinimized\fR|\fBExclusive\fR|\fINUMBER\fR} (default: 0)" 4
172 .IX Item "tray: {Ignore|Minimized|Exclusive|NUMBER} (default: 0)"
173 The default tray option for the window. This affects both the tray and
174 the task pane. Tray can be one of the following three strings or a number
175 from zero (0) to two (2):
176 .Sp
177 .Vb 3
178 \& Ignore (0) No icon is added to the tray.
179 \& Minimized (1) Add to tray, no task when minimized.
180 \& Exclusive (2) Add to tray, no task button.
181 .Ve
182 .IP "\fBorder\fR: \fINUMBER\fR (default: 0)" 4
183 .IX Item "order: NUMBER (default: 0)"
184 The sorting order for task buttons, tray icons, quick switch and window
185 list. The default value is zero. Increasing positive values go right,
186 while decreasing negative values go left.
187 .IP "\fBopacity\fR: \fINUMBER\fR (default: 0)" 4
188 .IX Item "opacity: NUMBER (default: 0)"
189 Set the _NET_WM_WINDOW_OPACITY property if \fINUMBER\fR is a value between
190 1 and 100. \fINUMBER\fR is interpreted as percentage of maximum opaqueness.
191 .IP "\fBkeyboard\fR: \fIlayout\fR (default: none)" 4
192 .IX Item "keyboard: layout (default: none)"
193 Specifies the keyboard layout to use for this window.
194 The \fIlayout\fR is the name of a keyboard layout.
195 It can be a space-separated list of arguments to the
196 \&\fBsetxkbmap\fR program. Please note that \fBsetxkbmap\fR
197 must be installed for this to work. Also define
198 a default keyboard layout in \fIpreferences\fR.
199 .IP "\fBframe\fR: \fIlabel\fR (default: none)" 4
200 .IX Item "frame: label (default: none)"
201 All windows with the same frame label become tabs in a single frame.
202 .SS "FUNCTION OPTIONS"
203 .IX Subsection "FUNCTION OPTIONS"
204 Function options enable/disable (1/0) the ability to take an action on
205 the window. The normal default for all options is enabled (1) unless
206 overridden by the application:
207 .PP
208 .Vb 7
209 \& fClose: {0|1} can be closed. (default: 1)
210 \& fHide: {0|1} can be hidden. (default: 1)
211 \& fMaximize: {0|1} can be maximized. (default: 1)
212 \& fMinimize: {0|1} can be minimized. (default: 1)
213 \& fMove: {0|1} can be moved. (default: 1)
214 \& fResize: {0|1} can be resized. (default: 1)
215 \& fRollup: {0|1} can be shaded. (default: 1)
216 .Ve
217 .SS "DECOR OPTIONS"
218 .IX Subsection "DECOR OPTIONS"
219 Decor options enable/disable (1/0) decorations on the window. The
220 normal default for all options is enabled (1) unless overridden by the
221 application or the theme:
222 .PP
223 .Vb 10
224 \& dBorder: {0|1} has border. (default: 1)
225 \& dClose: {0|1} has close button. (default: 1)
226 \& dDepth: {0|1} has depth button. (default: 1)
227 \& dHide: {0|1} has hide button. (default: 1)
228 \& dMaximize: {0|1} has maximize button. (default: 1)
229 \& dMinimize: {0|1} has minimize button. (default: 1)
230 \& dResize: {0|1} has resize grips. (default: 1)
231 \& dRollup: {0|1} has shade button. (default: 1)
232 \& dSysMenu: {0|1} has window menu. (default: 1)
233 \& dTitleBar: {0|1} has title bar. (default: 1)
234 .Ve
235 .SS "FEATURE OPTIONS"
236 .IX Subsection "FEATURE OPTIONS"
237 Feature options enable/disable (1/0) additional features of the window.
238 The normal default for all options is disabled (0) unless overridden by
239 the application:
240 .PP
241 .Vb 10
242 \& allWorkspaces: {1|0} show it on all workspaces.
243 \& appTakesFocus: {1|0} let the application take focus.
244 \& doNotCover: {1|0} don\*(Aqt place other windows over it.
245 \& doNotFocus: {1|0} do not give it focus.
246 \& doNotManage: {1|0} do not manage at all.
247 \& forcedClose: {1|0} no close confirmation dialog.
248 \& fullKeys: {1|0} don\*(Aqt install icewm key bindings.
249 \& ignoreNoFocusHint: {1|0} focus even when no\-input is set.
250 \& ignorePagerPreview: {1|0} do not show in pager preview.
251 \& ignorePositionHint: {1|0} always let icewm place the window.
252 \& ignoreQuickSwitch: {1|0} not on the quick switch.
253 \& ignoreTaskBar: {1|0} not on the task bar.
254 \& ignoreUrgentHint: {1|0} ignore urgent hints.
255 \& ignoreWinList: {1|0} not on the window list.
256 \& ignoreActivationMessages: {1|0} only user can focus window.
257 \& ignoreOverrideRedirect: {1|0} ignore the override redirect flag.
258 \& noFocusOnAppRaise: {1|0} no automatic focus on raise.
259 \& noFocusOnMap: {1|0} do not focus when mapped.
260 \& noIgnoreTaskBar: {1|0} always show on task bar.
261 \& startClose: {1|0} close the window immediately.
262 \& startFullscreen: {1|0} start full screen.
263 \& startMaximized: {1|0} start maximized.
264 \& startMaximizedHorz: {1|0} start maximized horizontal.
265 \& startMaximizedVert: {1|0} start maximized vertical.
266 \& startMinimized: {1|0} start minimized.
267 .Ve
268 .SS EXAMPLES
269 .IX Subsection "EXAMPLES"
270 This example uses the WM_WINDOW_ROLE property value \f(CW\*(C`pop\-up\*(C'\fR to deny
271 input focus to \fIChrome\fR pop-ups and asks to close them immediately.
272 .PP
273 .Vb 9
274 \& google\-chrome.pop\-up.doNotFocus: 1
275 \& google\-chrome.pop\-up.forcedClose: 1
276 \& google\-chrome.pop\-up.ignorePagerPreview: 1
277 \& google\-chrome.pop\-up.ignoreUrgentHint: 1
278 \& google\-chrome.pop\-up.layer: Below
279 \& google\-chrome.pop\-up.noFocusOnAppRaise: 1
280 \& google\-chrome.pop\-up.noFocusOnMap: 1
281 \& google\-chrome.pop\-up.startClose: 1
282 \& google\-chrome.pop\-up.startMinimized: 1
283 .Ve
284 .PP
285 IceWM places dockapps in a container automatically, but for those
286 that fail to comply with the protocol it can also be emulated.
287 An emulated dockapp should appear on all workspaces, have
288 no decorations, and always be visible in a fixed location.
289 .PP
290 .Vb 8
291 \& wmtime.wmtime.allWorkspaces: 1
292 \& wmtime.wmtime.ignoreTaskBar: 1
293 \& wmtime.wmtime.ignoreQuickSwitch: 1
294 \& wmtime.wmtime.ignoreWinList: 1
295 \& wmtime.wmtime.layer: Below
296 \& wmtime.wmtime.dTitleBar: 0
297 \& wmtime.wmtime.dBorder: 1
298 \& wmtime.wmtime.geometry: 64x64\-74\-100
299 .Ve
300 .PP
301 Following shows how a shaped output-only application is shown
302 without titlebar and minimal functionality.
303 .PP
304 .Vb 11
305 \& xeyes.tray: Exclusive
306 \& xeyes.ignoreWinList: 0
307 \& xeyes.ignoreTaskBar: 1
308 \& xeyes.allWorkspaces: 1
309 \& xeyes.dTitleBar: 0
310 \& xeyes.dBorder: 0
311 \& xeyes.dSysMenu: 0
312 \& xeyes.dResize: 0
313 \& xeyes.dClose: 0
314 \& xeyes.dMinimize: 0
315 \& xeyes.dMaximize: 0
316 .Ve
317 .SS FILES
318 .IX Subsection "FILES"
319 Locations for the \fIwinoptions\fR file are as follows:
320 .PP
321 .Vb 5
322 \& $ICEWM_PRIVCFG/winoptions
323 \& $XDG_CONFIG_HOME/icewm/winoptions
324 \& $HOME/.icewm/winoptions
325 \& /etc/X11/icewm/winoptions
326 \& /usr/share/icewm/winoptions
327 .Ve
328 .PP
329 The locations are searched in the order listed; the first file found is
330 read and the remainder ignored.
331 .SS "SEE ALSO"
332 .IX Subsection "SEE ALSO"
333 \&\fBicewm\fR\|(1),
334 \&\fBicesh\fR\|(1),
335 \&\fBicewmhint\fR\|(1),
336 \&\fBsetxkbmap\fR\|(1),
337 \&\fBXParseGeometry\fR\|(3).
338 .SS AUTHOR
339 .IX Subsection "AUTHOR"
340 Brian Bidulock <mailto:[email protected]>.
341 .SS LICENSE
342 .IX Subsection "LICENSE"
343 \&\fBIceWM\fR is licensed under the GNU Library General Public License.
344 See the \fICOPYING\fR file in the distribution.