1ICEWM-WINOPTIONS(5)   Standards, Environments and Macros   ICEWM-WINOPTIONS(5)
2
3
4
5   NAME
6        icewm-winoptions - IceWM window options configuration file
7
8   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
15   DESCRIPTION
16       Contains settings to control window appearance and behaviour. These are
17       specific to applications, or to groups of applications.  Options can
18       control the window border, whether the application appears on the task
19       bar, the window list, the system tray and the work spaces.  Also its
20       layer, geometry, whether it can be moved, resized and closed.
21
22       Options are established when icewm(1) starts.  However, they can be
23       overridden later using icesh(1) or icewmhint(1). The command "icesh
24       winoptions" instructs icewm to reload the winoptions file.
25
26   FORMAT
27       Each line in the file must be in one of the following formats:
28
29           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
37       Where the fields are defined as follows:
38
39       CLASS
40           The resource class portion of the ICCCM WM_CLASS property for the
41           window.
42
43       NAME
44           The resource instance portion of the ICCCM WM_CLASS property for
45           the window.
46
47       ROLE
48           The ICCCM WM_WINDOW_ROLE property for the window.
49
50       OPTION: VALUE
51           One of the options and values described below under "OPTIONS".
52
53       Note that it is possible that the WM_WINDOW_ROLE may contain a period
54       (".").  When it does, the period should be escaped by a single
55       backslash when specifying the ROLE in the file.
56
57   OPTIONS
58       The options and values described in the format, above, consist of an
59       option name, OPTION followed by a semicolon (":") a space (" ") and an
60       allowable value for the option, VALUE.  The available options are as
61       follows:
62
63   GENERAL OPTIONS
64       The following option control general characteristics of windows:
65
66       icon: NAME (default: none)
67           Specifies the icon name for the window.  NAME is the name of the
68           icon, like utilities-terminal. It can also be a file, like
69           xterm.png, a full path, or a prefix of a path without sizes or
70           suffix.
71
72       workspace: WORKSPACE (default: current)
73           Specifies the default workspace for the window.  WORKSPACE is the
74           workspace number counting from zero (0).
75
76       layer: {Desktop|Below|Normal|OnTop|Dock|AboveDock|Menu|NUMBER}
77       (default: 4)
78           Specifies the default layer for the window.  Layer can be one of
79           the following strings or a number from zero (0) to fifteen (15):
80
81             Desktop     (0)  Desktop window.
82             Below       (2)  Below the default layer.
83             Normal      (4)  Default layer for windows.
84             OnTop       (6)  Above the default layer.
85             Dock        (8)  Docked windows at edge of screen.
86             AboveDock  (10)  Windows above the dock.
87             Menu       (12)  Windows above the dock.
88
89       geometry geometry (default: WM_SIZE_HINTS)
90           The default geometry for the window.  This geometry should be
91           specified in a format that can be parsed by XParseGeometry(3):
92
93            [=][<width>{xX}<height>][{+-}<xoffset>{+-}<yoffset>]
94
95       tray: {Ignore|Minimized|Exclusive|NUMBER} (default: 0)
96           The default tray option for the window.  This affects both the tray
97           and the task pane.  Tray can be one of the following strings or a
98           number from zero (0) to two (2):
99
100             Ignore     (0)  No icon added to tray.
101             Minimized  (1)  Add to tray, no task when minimized.
102             Exclusive  (2)  Add to tray, no task button.
103
104       order: NUMBER (default: 0)
105           The sorting order of task buttons and tray icons. The default value
106           is zero. Increasing positive values go farther right, while
107           decreasing negative values go farther left. The order option
108           applies to the task pane, the tray pane and the system tray.
109
110       opacity: NUMBER (default: 0)
111           Set the _NET_WM_WINDOW_OPACITY property if NUMBER is a value
112           between 1 and 100. NUMBER is interpreted as percentage of maximum
113           opaqueness.
114
115       keyboard: layout (default: none)
116           Specifies the keyboard layout to use for this window.  The layout
117           is the name of a keyboard layout.  It can be a space-separated list
118           of arguments to the setxkbmap program. Please note that setxkbmap
119           must be installed for this to work. Also define a default keyboard
120           layout in preferences.
121
122       frame: label (default: none)
123           All windows with the same frame label become tabs in a single
124           frame.
125
126   FUNCTION OPTIONS
127       Function options enable/disable (1/0) the ability to take an action on
128       the window.  The normal default for all options is enabled (1) unless
129       overridden by the application.  The following options are defined:
130
131         fClose:    {0|1}  can be closed.        (default: 1)
132         fHide:     {0|1}  can be hidden.        (default: 1)
133         fMaximize: {0|1}  can be maximized.     (default: 1)
134         fMinimize: {0|1}  can be minimized.     (default: 1)
135         fMove:     {0|1}  can be moved.         (default: 1)
136         fResize:   {0|1}  can be resized.       (default: 1)
137         fRollup:   {0|1}  can be shaded.        (default: 1)
138
139   DECOR OPTIONS
140       Decor options enable/disable (1/0) decorations on the window.  The
141       normal default for all options is enabled (1) unless overridden by the
142       application.  The following options are defined:
143
144         dBorder:   {0|1}  has border.           (default: 1)
145         dClose:    {0|1}  has close button.     (default: 1)
146         dDepth:    {0|1}  has depth button.     (default: 1)
147         dHide:     {0|1}  has hide button.      (default: 1)
148         dMaximize: {0|1}  has maximize button.  (default: 1)
149         dMinimize: {0|1}  has minimize button.  (default: 1)
150         dResize:   {0|1}  has resize grips.     (default: 1)
151         dRollup:   {0|1}  has shade button.     (default: 1)
152         dSysMenu:  {0|1}  has window menu.      (default: 1)
153         dTitleBar: {0|1}  has title bar.        (default: 1)
154
155   FEATURE OPTIONS
156       Feature options enable/disable (1/0) additional features of the window.
157       The normal default for all options is disabled (0) unless overridden by
158       the application.  The following options are defined:
159
160         allWorkspaces:            {1|0}  on all workspaces.
161         appTakesFocus:            {1|0}  let application take focus.
162         doNotCover:               {1|0}  limits workspace if sticky.
163         doNotFocus:               {1|0}  do not focus.
164         forcedClose:              {1|0}  no close dialog.
165         fullKeys:                 {1|0}  provided more keys.
166         ignoreNoFocusHint:        {1|0}  focus even no-input.
167         ignorePagerPreview:       {1|0}  do not show in pager preview.
168         ignorePositionHint:       {1|0}  place automatically.
169         ignoreQuickSwitch:        {1|0}  not on quick switch.
170         ignoreTaskBar:            {1|0}  not on task bar.
171         ignoreUrgentHint:         {1|0}  ignore urgent hints.
172         ignoreWinList:            {1|0}  not on window list.
173         ignoreActivationMessages: {1|0}  only user can focus window.
174         ignoreOverrideRedirect:   {1|0}  ignore override redirect.
175         noFocusOnAppRaise:        {1|0}  no focus on raise.
176         noFocusOnMap:             {1|0}  do not focus when mapped.
177         noIgnoreTaskBar:          {1|0}  on task bar.
178         startClose:               {1|0}  close the window immediately.
179         startFullscreen:          {1|0}  start full screen.
180         startMaximized:           {1|0}  start maximized.
181         startMaximizedHorz:       {1|0}  start maximized horizontal.
182         startMaximizedVert:       {1|0}  start maximized vertical.
183         startMinimized:           {1|0}  start minimized.
184
185   EXAMPLES
186       This example uses the WM_WINDOW_ROLE property value "pop-up" to deny
187       input focus to Chrome pop-ups and asks to close them immediately.
188
189         google-chrome.pop-up.doNotFocus: 1
190         google-chrome.pop-up.forcedClose: 1
191         google-chrome.pop-up.ignorePagerPreview: 1
192         google-chrome.pop-up.ignoreUrgentHint: 1
193         google-chrome.pop-up.layer: Below
194         google-chrome.pop-up.noFocusOnAppRaise: 1
195         google-chrome.pop-up.noFocusOnMap: 1
196         google-chrome.pop-up.startClose: 1
197         google-chrome.pop-up.startMinimized: 1
198
199       IceWM places dockapps in a container automatically, but for those which
200       fail to comply with the protocol it can also be emulated.  An emulated
201       dockapp should appear on all workspaces, have no decorations, and
202       always be visible in a fixed location.
203
204         wmtime.wmtime.allWorkspaces: 1
205         wmtime.wmtime.ignoreTaskBar: 1
206         wmtime.wmtime.ignoreQuickSwitch: 1
207         wmtime.wmtime.ignoreWinList: 1
208         wmtime.wmtime.layer: Below
209         wmtime.wmtime.dTitleBar: 0
210         wmtime.wmtime.dBorder: 1
211         wmtime.wmtime.geometry: 64x64-74-100
212
213       Following is the example window options file that ships with icewm(1)
214       and typically installs to /usr/share/icewm/winoptions.
215
216         # This is an example for IceWM's window options file.
217         #
218         # Place your variants in /etc/icewm or in $HOME/.icewm
219         # since modifications to this file will be discarded when you
220         # (re)install icewm.
221
222         xterm.icon: xterm
223         rxvt.icon: xterm
224         nxterm.icon: xterm
225         fte.icon: fte
226         emacs.Emacs.icon: emacs
227         AWTapp.icon: java
228         xeyes.ignoreWinList: 0
229         xeyes.ignoreTaskBar: 1
230         xeyes.allWorkspaces: 1
231         xeyes.dTitleBar: 0
232         xeyes.dBorder: 0
233         xeyes.dSysMenu: 0
234         xeyes.dResize: 0
235         xeyes.dClose: 0
236         xeyes.dMinimize: 0
237         xeyes.dMaximize: 0
238         xeyes.ignoreNoFocusHint: 1
239
240         XClock.ignoreNoFocusHint: 1
241         Vim.icon: vim
242
243         applix.ignoreNoFocusHint: 1
244         XDdts.noFocusOnAppRaise: 1
245         Wingz.noFocusOnAppRaise: 1
246         WingzPro.noFocusOnAppRaise: 1
247
248         gkrellm.Gkrellm.allWorkspaces: 1
249         gkrellm.Gkrellm.ignoreTaskBar: 1
250         gkrellm.Gkrellm.layer: Below
251         #gkrellm.Gkrellm.doNotCover: 1
252
253         MainWindow.licq.allWorkspaces: 1
254         MainWindow.licq.ignoreQuickSwitch: 1
255         MainWindow.licq.ignoreWinList: 1
256         MainWindow.licq.layer: Below
257         #MainWindow.licq.doNotCover: 1
258
259   FILES
260       Locations for the winoptions file are as follows:
261
262        $ICEWM_PRIVCFG/winoptions
263        $XDG_CONFIG_HOME/icewm/winoptions
264        $HOME/.icewm/winoptions
265        /etc/icewm/winoptions
266        /usr/share/icewm/winoptions
267
268       The locations are searched in the order listed; the first file found is
269       read and the remainder ignored.
270
271   SEE ALSO
272       icewm(1), icesh(1), icewmhint(1), setxkbmap(1), XParseGeometry(3).
273
274   AUTHOR
275       Brian Bidulock <mailto:bidulock@openss7.org>.
276
277   LICENSE
278       IceWM is licensed under the GNU Library General Public License.  See
279       the COPYING file in the distribution.
280
281
282
283icewm 3.3.1                       2023-01-24               ICEWM-WINOPTIONS(5)
Impressum