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

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 window options configuration file is used to configure
17       settings for individual application windows.  The window options that
18       are established by this file when icewm(1) starts can be overridden
19       while running using the icesh(1) or icewmhint(1) utilities.
20
21       Contains settings to control window appearance and behaviour which are
22       specific to applications or groups of applications.  Options can
23       control the border, whether it appears on the task bar, the window
24       list, the system tray and the work spaces.  Also its layer, geometry,
25       whether it can be moved, resized and closed.  Full details for this
26       file are explained in the IceWM Manual.
27

FORMAT

29       Each line in the file must be in one of the following formats:
30
31           NAME.CLASS.OPTION: VALUE
32           CLASS.ROLE.OPTION: VALUE
33           NAME.ROLE.OPTION: VALUE
34           CLASS.OPTION: VALUE
35           NAME.OPTION: VALUE
36           ROLE.OPTION: VALUE
37
38       Where the fields are defined as follows:
39
40       CLASS
41           The resource class portion of the ICCCM WM_CLASS property for the
42           window.
43
44       NAME
45           The resource instance portion of the ICCCM WM_CLASS property for
46           the window.
47
48       ROLE
49           The ICCCM WM_WINDOW_ROLE property for the window.
50
51       OPTION: VALUE
52           One of the options and values described below under "OPTIONS".
53
54       Note that it is possible that the WM_WINDOW_ROLE may contain a period
55       (".").  When it does, the period should be escaped by a single
56       backslash when specifying the ROLE in the file.
57

OPTIONS

59       The options and values described in the format, above, consist of an
60       option name, OPTION followed by a semicolon (":") a space (" ") and an
61       allowable value for the option, VALUE.  The available options are as
62       follows:
63
64   GENERAL OPTIONS
65       The following option control general characteristics of windows:
66
67       icon: NAME (default: none)
68           Specifies the icon name for the window.  NAME is the name of the
69           icon, like utilities-terminal. It can also be a file, like
70           xterm.png, a full path, or a prefix of a path without sizes or
71           suffix.
72
73       workspace: WORKSPACE (default: current)
74           Specifies the default workspace for the window.  WORKSPACE is the
75           workspace number counting from zero (0).
76
77       layer: {Desktop|Below|Normal|OnTop|Dock|AboveDock|Menu|NUMBER}
78       (default: 4)
79           Specifies the default layer for the window.  Layer can be one of
80           the following strings or a number from zero (0) to fifteen (15):
81
82             Desktop     (0)  Desktop window.
83             Below       (2)  Below the default layer.
84             Normal      (4)  Default layer for windows.
85             OnTop       (6)  Above the default layer.
86             Dock        (8)  Docked windows at edge of screen.
87             AboveDock  (10)  Windows above the dock.
88             Menu       (12)  Windows above the dock.
89
90       geometry geometry (default: WM_SIZE_HINTS)
91           The default geometry for the window.  This geometry should be
92           specified in a format that can be parsed by XParseGeometry(3):
93
94            [=][<width>{xX}<height>][{+-}<xoffset>{+-}<yoffset>]
95
96       tray: {Ignore|Minimized|Exclusive|NUMBER} (default: 0)
97           The default tray option for the window.  This affects both the tray
98           and the task pane.  Tray can be one of the following strings or a
99           number from zero (0) to two (2):
100
101             Ignore     (0)  No icon added to tray.
102             Minimized  (1)  Add to tray, no task when minimized.
103             Exclusive  (2)  Add to tray, no task button.
104
105       order: NUMBER (default: 0)
106           The sorting order of task buttons and tray icons. The default value
107           is zero. Increasing positive values go farther right, while
108           decreasing negative values go farther left. The order option
109           applies to the task pane, the tray pane and the system tray.
110
111       opacity: NUMBER (default: 0)
112           Set the _NET_WM_WINDOW_OPACITY property if NUMBER is a value
113           between 1 and 100. NUMBER is interpreted as percentage of maximum
114           opaqueness.
115
116   FUNCTION OPTIONS
117       Function options enable/disable (1/0) the ability to take an action on
118       the window.  The normal default for all options is enabled (1) unless
119       overridden by the application.  The following options are defined:
120
121         fClose:    {0|1}  can be closed.        (default: 1)
122         fHide:     {0|1}  can be hidden.        (default: 1)
123         fMaximize: {0|1}  can be maximized.     (default: 1)
124         fMinimize: {0|1}  can be minimized.     (default: 1)
125         fMove:     {0|1}  can be moved.         (default: 1)
126         fResize:   {0|1}  can be resized.       (default: 1)
127         fRollup:   {0|1}  can be shaded.        (default: 1)
128
129   DECOR OPTIONS
130       Decor options enable/disable (1/0) decorations on the window.  The
131       normal default for all options is enabled (1) unless overridden by the
132       application.  The following options are defined:
133
134         dBorder:   {0|1}  has border.           (default: 1)
135         dClose:    {0|1}  has close button.     (default: 1)
136         dDepth:    {0|1}  has depth button.     (default: 1)
137         dHide:     {0|1}  has hide button.      (default: 1)
138         dMaximize: {0|1}  has maximize button.  (default: 1)
139         dMinimize: {0|1}  has minimize button.  (default: 1)
140         dResize:   {0|1}  has resize grips.     (default: 1)
141         dRollup:   {0|1}  has shade button.     (default: 1)
142         dSysMenu:  {0|1}  has window menu.      (default: 1)
143         dTitleBar: {0|1}  has title bar.        (default: 1)
144
145   FEATURE OPTIONS
146       Feature options enable/disable (1/0) additional features of the window.
147       The normal default for all options is disabled (0) unless overridden by
148       the application.  The following options are defined:
149
150         allWorkspaces:            {1|0}  on all workspaces.
151         appTakesFocus:            {1|0}  let application take focus.
152         doNotCover:               {1|0}  limits workspace if sticky.
153         doNotFocus:               {1|0}  do not focus.
154         forcedClose:              {1|0}  no close dialog.
155         fullKeys:                 {1|0}  provided more keys.
156         ignoreNoFocusHint:        {1|0}  focus even no-input.
157         ignorePagerPreview:       {1|0}  do not show in pager preview.
158         ignorePositionHint:       {1|0}  place automatically.
159         ignoreQuickSwitch:        {1|0}  not on quick switch.
160         ignoreTaskBar:            {1|0}  not on task bar.
161         ignoreUrgentHint:         {1|0}  ignore urgent hints.
162         ignoreWinList:            {1|0}  not on window list.
163         noFocusOnAppRaise:        {1|0}  no focus on raise.
164         noFocusOnMap:             {1|0}  do not focus when mapped.
165         noIgnoreTaskBar:          {1|0}  on task bar.
166         nonICCCMconfigureRequest: {1|0}  more configure requests.
167         startClose:               {1|0}  close the window immediately.
168         startFullscreen:          {1|0}  start full screen.
169         startMaximized:           {1|0}  start maximized.
170         startMaximizedHorz:       {1|0}  start maximized horizontal.
171         startMaximizedVert:       {1|0}  start maximized vertical.
172         startMinimized:           {1|0}  start minimized.
173

EXAMPLES

175       This example uses the WM_WINDOW_ROLE property value "pop-up" to deny
176       input focus to Chrome pop-ups and asks to close them immediately.
177
178         google-chrome.pop-up.doNotFocus: 1
179         google-chrome.pop-up.forcedClose: 1
180         google-chrome.pop-up.ignorePagerPreview: 1
181         google-chrome.pop-up.ignoreUrgentHint: 1
182         google-chrome.pop-up.layer: Below
183         google-chrome.pop-up.noFocusOnAppRaise: 1
184         google-chrome.pop-up.noFocusOnMap: 1
185         google-chrome.pop-up.startClose: 1
186         google-chrome.pop-up.startMinimized: 1
187
188       Following is the example window options file that ships with icewm(1)
189       and typically installs to /usr/share/icewm/winoptions.
190
191         # This is an example for IceWM's window options file.
192         #
193         # Place your variants in @CFGDIR@ or in $HOME/.icewm
194         # since modifications to this file will be discarded when you
195         # (re)install icewm.
196
197         xterm.icon: xterm
198         rxvt.icon: xterm
199         nxterm.icon: xterm
200         fte.icon: fte
201         emacs.Emacs.icon: emacs
202         AWTapp.icon: java
203         # workaround for XV window repositioning problems
204         xv.nonICCCMconfigureRequest: 1
205         xeyes.ignoreWinList: 0
206         xeyes.ignoreTaskBar: 1
207         xeyes.allWorkspaces: 1
208         xeyes.dTitleBar: 0
209         xeyes.dBorder: 0
210         xeyes.dSysMenu: 0
211         xeyes.dResize: 0
212         xeyes.dClose: 0
213         xeyes.dMinimize: 0
214         xeyes.dMaximize: 0
215         xeyes.ignoreNoFocusHint: 1
216
217         XClock.ignoreNoFocusHint: 1
218         Vim.icon: vim
219
220         applix.ignoreNoFocusHint: 1
221         XDdts.noFocusOnAppRaise: 1
222         Wingz.noFocusOnAppRaise: 1
223         WingzPro.noFocusOnAppRaise: 1
224
225         gkrellm.Gkrellm.allWorkspaces: 1
226         gkrellm.Gkrellm.ignoreTaskBar: 1
227         gkrellm.Gkrellm.layer: Below
228         #gkrellm.Gkrellm.doNotCover: 1
229
230         MainWindow.licq.allWorkspaces: 1
231         MainWindow.licq.ignoreQuickSwitch: 1
232         MainWindow.licq.ignoreWinList: 1
233         MainWindow.licq.layer: Below
234         #MainWindow.licq.doNotCover: 1
235

FILES

237       Locations for the winoptions file are as follows:
238
239        $ICEWM_PRIVCFG/winoptions
240        $XDG_CONFIG_HOME/icewm/winoptions
241        $HOME/.icewm/winoptions
242        /etc/icewm/winoptions
243        /usr/share/icewm/winoptions
244
245       The locations are searched in the order listed; the first file found is
246       read and the remainder ignored.
247

SEE ALSO

249       icewm(1), icesh(1), icewmhint(1), XParseGeometry(3).
250

AUTHOR

252       Brian Bidulock <mailto:bidulock@openss7.org>.
253

LICENSE

255       IceWM is licensed under the GNU Library General Public License.  See
256       the COPYING file in the distribution.
257
258
259
260icewm 1.6.1                       2019-11-25               ICEWM-WINOPTIONS(5)
Impressum