1ICEWMHINT(1) User Commands ICEWMHINT(1)
2 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 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 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 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 -h, --help
31 Print a brief usage statement to stdout and exit.
32 -V, --version
34 Print the program version to stdout and exit.
35 -C, --copying
37 Print copying permissions to stdout for the program and exit.
38 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 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 OPTION
53 Specifies the OPTION to affect.
54 VALUE
56 Gives the VALUE for the option.
57 Multiple hints can be given.
59 GENERAL OPTION ARGUMENTS
61 icon NAME
62 Specifies the icon name for windows of CLASS.INSTANCE. NAME should
63 be the name of the icon. icewm(1) will use its usual method to
64 locate the icon. The default is the name provided by window
65 manager hints.
66 workspace WORKSPACE
68 Specifies the workspace on which a window of CLASS.INSTANCE will be
69 initially placed. The default is the current workspace. WORKSPACE
70 should be a workspace number counting from 0.
71 geometry GEOMETRY
73 Specifies the initial geometry for windows of the given
74 CLASS.INSTANCE. GEOMETRY must be a geometry that can be parsed by
75 XParseGeometry(3). The default is the geometry provided by window
76 manager hints.
77 order NUMBER
79 The sorting order of task buttons and tray icons. The default value
80 is zero. Increasing positive values go farther right, while
81 decreasing negative values go farther left. The order option
82 applies to the task pane, the tray pane and the system tray.
83 opacity NUMBER
85 Set the _NET_WM_WINDOW_OPACITY property if NUMBER is a value
86 between 1 and 100. NUMBER is interpreted as percentage of maximum
87 opaqueness.
88 layer {LAYER|NUMBER}
90 This command option specifies the layer to be associated with a
91 CLASS.INSTANCE. The default is the "Normal" layer. VALUE is
92 either a layer number or a symbolic layer name. Symbolic layer
93 names are:
94 Desktop (0) Desktop window.
96 Below (2) Below the default layer.
97 Normal (4) Default layer for windows.
98 OnTop (6) Above the default layer.
99 Dock (8) Docked windows at edge of screen.
100 AboveDock (10) Windows above the dock.
101 Menu (12) The layer for menu's.
102 Fullscreen (14) When fullscreen and focused.
103 AboveAll (15) Always above anything.
104 tray {Ignore|Minimized|Exclusive|NUMBER}
106 Specifies the tray handling to be applied to windows with
107 CLASS.INSTANCE. This option is specific to icewm(1) and sets the
108 "_ICEWM_TRAY" property associated with the window. The default is
109 "Ignore". VALUE can be an option number or a symbolic name as
110 follows:
111 Ignore (0) only in task list.
113 Minimized (1) icon in tray, task list unminimized.
114 Exclusive (2) only in tray, not in task list.
115 frame label (default: none)
117 All windows with the same frame label become tabs in a single
118 frame.
119 FUNCTION OPTION ARGUMENTS
121 Specifies which functions are disabled or enabled (0/1) for windows
122 with CLASS.INSTANCE. All functions have a default value of enabled (1)
123 unless overridden by the application. The Motif-like functions are as
124 follows:
125 fClose can be closed: (default: 1).
127 fHide can be hidden: (default: 1).
128 fMaximize can be maximized: (default: 1).
129 fMinimize can be minimized: (default: 1).
130 fMove can be moved: (default: 1).
131 fResize can be resized: (default: 1).
132 fRollup can be shaded: (default: 1).
133 DECOR OPTION ARGUMENTS
135 Specifies which decorations are disabled or enabled (0/1) for windows
136 with CLASS.INSTANCE. All decor options have a default value of enabled
137 (1) unless overridden by the application. The Motif-like decorations
138 are as follows:
139 dBorder has border: (default: 1).
141 dClose has close button: (default: 1).
142 dDepth has depth button: (default: 1).
143 dHide has hide button: (default: 1).
144 dMaximize has maximize button: (default: 1).
145 dMinimize has minimize button: (default: 1).
146 dResize has resize grips: (default: 1).
147 dRollup has shade button: (default: 1).
148 dSysMenu has window menu: (default: 1).
149 dTitleBar has title bar: (default: 1).
150 FEATURE OPTION ARGUMENTS
152 Specifies which advanced features to be enabled/disabled (1/0) for
153 windows with CLASS.INSTANCE. All advanced features have a default
154 value of disabled (0) unless overridden by the application. The
155 advanced features are as follows:
156 allWorkspaces on all workspaces.
158 appTakesFocus let application take focus.
159 doNotCover limits workspace if sticky.
160 doNotFocus do not focus.
161 doNotManage do not manage.
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 ignoreActivationMessages only user can focus window.
172 ignoreOverrideRedirect ignore the override redirect flag.
173 noFocusOnAppRaise no focus on raise.
174 noFocusOnMap do not focus when mapped.
175 noIgnoreTaskBar on task bar.
176 startClose close the window immediately.
177 startFullscreen start full screen.
178 startMaximized start maximized.
179 startMaximizedHorz start maximized horizontal.
180 startMaximizedVert start maximized vertical.
181 startMinimized start minimized.
182 EXAMPLE
184 # Here is how to preload an invisible background process of chromium
185 # on the fourth workspace which is only visible on the Window List.
186 icewmhint Chromium-browser startMinimized 1 \
188 Chromium-browser workspace 3 \
189 Chromium-browser ignorePagerPreview 1 \
190 Chromium-browser ignorePositionHint 1 \
191 Chromium-browser ignoreTaskBar 1 \
192 Chromium-browser ignoreQuickSwitch 1 \
193 Chromium-browser ignoreUrgentHint 1 \
194 Chromium-browser noFocusOnAppRaise 1
195 chromium
196 BUGS
198 Please report bugs at <https://github.com/bbidulock/icewm/issues>.
199 AUTHOR
201 Brian Bidulock <mailto:bidulock@openss7.org>.
202 See --copying for full copyright notice and copying permissions.
204 LICENSE
206 IceWM is licensed under the GNU Library General Public License. See
207 the COPYING file in the distribution or use the --copying flag to
208 display copying permissions.
209icewm 3.4.4 2023-11-03 ICEWMHINT(1)