1ICEWMHINT(1)                     User Commands                    ICEWMHINT(1)
2
3
4

NAME

6       icewmhint - set IceWM hints by window class and instance
7

SYNOPSIS

9       icewmhint CLASS.INSTANCE OPTION VALUE ...
10

DESCRIPTION

12       icewmhint is a utility for passing IceWM hints to icewm(1).  icewm uses
13       these hints for the first X11 client which is subsequently started.
14       They take precedence over hints from the icewm-winoptions(1) file.
15
16       A hint is a triplet consisting of a class.instance, an IceWM winoption
17       and its value. Multiple hints can be given per invocation of icewmhint.
18
19       The hints are communicated over the "_ICEWM_WINOPTHINT" property on the
20       root window.  icewmhint appends hints to this property, while icewm
21       removes the property after reading it.
22

OPTIONS

24       icewmhint recognizes the following options:
25
26   COMMAND OPTIONS
27       Only one command option can be specified per invocation.  If no command
28       option is specified, argument parsing and processing is performed.
29
30       -h, --help
31           Print a brief usage statement to stdout and exit.
32
33       -V, --version
34           Print the program version to stdout and exit.
35
36       -C, --copying
37           Print copying permissions to stdout for the program and exit.
38
39   GENERAL OPTIONS
40       -d, --display=DISPLAY
41           Specifies the X11 DISPLAY. If unspecified, defaults to $DISPLAY.
42

ARGUMENTS

44       The following three arguments are required for each hint.
45
46       CLASS.INSTANCE
47           Specifies the ICCCM 2.0 WM_CLASS property in terms of resource
48           class and resource name separated by a period (".").  For example:
49           "XTerm.xterm". Just the resource class or resource name without a
50           dot is also acceptable, like "XTerm" or "xterm".
51
52       OPTION
53           Specifies the OPTION to affect.
54
55       VALUE
56           Gives the VALUE for the option.
57
58       Multiple hints can be given.
59
60   GENERAL OPTION ARGUMENTS
61       General option arguments are normally associated with GNOME WinWM/WMH
62       hints (except for the tray option argument).
63
64       icon NAME
65           Specifies the icon name for windows of CLASS.INSTANCE.  NAME should
66           be the name of the icon.  icewm(1) will use its usual method to
67           locate the icon.  The default is the name provided by window
68           manager hints.
69
70       workspace WORKSPACE
71           Specifies the workspace on which a window of CLASS.INSTANCE will be
72           initially placed.  The default is the current workspace.  WORKSPACE
73           should be a workspace number counting from 0.
74
75       geometry GEOMETRY
76           Specifies the initial geometry for windows of the given
77           CLASS.INSTANCE.  GEOMETRY must be a geometry that can be parsed by
78           XParseGeometry(3).  The default is the geometry provided by window
79           manager hints.
80
81       order NUMBER
82           The sorting order of task buttons and tray icons. The default value
83           is zero. Increasing positive values go farther right, while
84           decreasing negative values go farther left. The order option
85           applies to the task pane, the tray pane and the system tray.
86
87       opacity NUMBER
88           Set the _NET_WM_WINDOW_OPACITY property if NUMBER is a value
89           between 1 and 100. NUMBER is interpreted as percentage of maximum
90           opaqueness.
91
92       layer {Desktop|Below|Normal|OnTop|Dock|AboveDock|Menu|NUMBER}
93           The layer is a similar concept to the layer specified by GNOME/WMH
94           and implied by NetWM/EWMH.  It is in this case however specific to
95           icewm(1).
96
97           This command option specifies the layer to be associated with a
98           CLASS.INSTANCE.  The default is the "Normal" layer.  VALUE is
99           either a layer number or a symbolic layer name.  Symbolic layer
100           names are:
101
102               Desktop    (0)  desktop window layer.
103               Below      (2)  below normal windows.
104               Normal     (4)  default window layer.
105               OnTop      (6)  above normal windows.
106               Dock       (8)  docks (panels and edge displays).
107               AboveDock (10)  above docks.
108               Menu      (12)  above everything else.
109
110       tray {Ignore|Minimized|Exclusive|NUMBER}
111           Specifies the tray handling to be applied to windows with
112           CLASS.INSTANCE.  This option is specific to icewm(1) and sets the
113           "_ICEWM_TRAY" property associated with the window.  The default is
114           "Ignore".  VALUE can be an option number or a symbolic name as
115           follows:
116
117               Ignore     (0)  only in task list.
118               Minimized  (1)  icon in tray, task list unminimized.
119               Exclusive  (2)  only in tray, not in task list.
120
121   FUNCTION OPTION ARGUMENTS
122       Specifies which functions are disabled or enabled (0/1) for windows
123       with CLASS.INSTANCE.  All functions have a default value of enabled (1)
124       unless overridden by the application.  The Motif-like functions are as
125       follows:
126
127           fClose     can be closed:        (default: 1).
128           fHide      can be hidden:        (default: 1).
129           fMaximize  can be maximized:     (default: 1).
130           fMinimize  can be minimized:     (default: 1).
131           fMove      can be moved:         (default: 1).
132           fResize    can be resized:       (default: 1).
133           fRollup    can be shaded:        (default: 1).
134
135   DECOR OPTION ARGUMENTS
136       Specifies which decorations are disabled or enabled (0/1) for windows
137       with CLASS.INSTANCE.  All decor options have a default value of enabled
138       (1) unless overridden by the application. The Motif-like decorations
139       are as follows:
140
141           dBorder    has border:           (default: 1).
142           dClose     has close button:     (default: 1).
143           dDepth     has depth button:     (default: 1).
144           dHide      has hide button:      (default: 1).
145           dMaximize  has maximize button:  (default: 1).
146           dMinimize  has minimize button:  (default: 1).
147           dResize    has resize grips:     (default: 1).
148           dRollup    has shade button:     (default: 1).
149           dSysMenu   has window menu:      (default: 1).
150           dTitleBar  has title bar:        (default: 1).
151
152   FEATURE OPTION ARGUMENTS
153       Specifies which advanced features to be enabled/disabled (1/0) for
154       windows with CLASS.INSTANCE.  All advanced features have a default
155       value of disabled (0) unless overridden by the application.  The
156       advanced features are as follows:
157
158           allWorkspaces             on all workspaces.
159           appTakesFocus             let application take focus.
160           doNotCover                limits workspace if sticky.
161           doNotFocus                do not focus.
162           forcedClose               no close dialog.
163           fullKeys                  provided more keys.
164           ignoreNoFocusHint         focus even no-input.
165           ignorePagerPreview        do not show in pager preview.
166           ignorePositionHint        place automatically.
167           ignoreQuickSwitch         not on quick switch.
168           ignoreTaskBar             not on task bar.
169           ignoreUrgentHint          ignore urgent hints.
170           ignoreWinList             not on window list.
171           noFocusOnAppRaise         no focus on raise.
172           noFocusOnMap              do not focus when mapped.
173           noIgnoreTaskBar           on task bar.
174           startFullscreen           start full screen.
175           startMaximized            start maximized.
176           startMaximizedHorz        start maximized horizontal.
177           startMaximizedVert        start maximized vertical.
178           startMinimized            start minimized.
179

EXAMPLE

181           # Here is how to preload an invisible background process of chromium
182           # on the fourth workspace which is only visible on the Window List.
183
184           icewmhint Chromium-browser startMinimized 1 \
185                     Chromium-browser workspace 3 \
186                     Chromium-browser ignorePagerPreview 1 \
187                     Chromium-browser ignorePositionHint 1 \
188                     Chromium-browser ignoreTaskBar 1 \
189                     Chromium-browser ignoreQuickSwitch 1 \
190                     Chromium-browser ignoreUrgentHint 1 \
191                     Chromium-browser noFocusOnAppRaise 1
192           chromium
193

BUGS

195       Please report bugs at <https://github.com/bbidulock/icewm/issues>.
196

AUTHOR

198       Brian Bidulock <mailto:bidulock@openss7.org>.
199
200       See --copying for full copyright notice and copying permissions.
201

LICENSE

203       IceWM is licensed under the GNU Library General Public License.  See
204       the COPYING file in the distribution or use the --copying flag to
205       display copying permissions.
206
207
208
209icewm 2.9.0                       2021-11-24                      ICEWMHINT(1)
Impressum