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       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

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
36       Where the fields are defined as follows:
37
38       CLASS
39           The resource class portion of the ICCCM WM_CLASS property for the
40           window.
41
42       NAME
43           The resource instance portion of the ICCCM WM_CLASS property for
44           the window.
45
46       ROLE
47           The ICCCM WM_WINDOW_ROLE property for the window.
48
49       OPTION: VALUE
50           One of the options and values described below under "OPTIONS".
51
52       Note that it is possible that the WM_WINDOW_ROLE may contain a period
53       (".").  When it does, the period should be escaped by a single
54       backslash when specifying the ROLE in the file.
55

OPTIONS

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

EXAMPLES

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

FILES

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

SEE ALSO

247       icewm(1), icesh(1), icewmhint(1), XParseGeometry(3).
248

AUTHOR

250       Brian Bidulock <mailto:bidulock@openss7.org>.
251

LICENSE

253       IceWM is licensed under the GNU Library General Public License.  See
254       the COPYING file in the distribution.
255
256
257
258icewm 1.6.5                       2020-03-17               ICEWM-WINOPTIONS(5)
Impressum