| 1 |
.\" -*- mode: troff; coding: utf-8 -*- |
| 2 |
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) |
| 3 |
.\" |
| 4 |
.\" Standard preamble: |
| 5 |
.\" ======================================================================== |
| 6 |
.de Sp \" Vertical space (when we can't use .PP) |
| 7 |
.if t .sp .5v |
| 8 |
.if n .sp |
| 9 |
.. |
| 10 |
.de Vb \" Begin verbatim text |
| 11 |
.ft CW |
| 12 |
.nf |
| 13 |
.ne \\$1 |
| 14 |
.. |
| 15 |
.de Ve \" End verbatim text |
| 16 |
.ft R |
| 17 |
.fi |
| 18 |
.. |
| 19 |
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. |
| 20 |
.ie n \{\ |
| 21 |
. ds C` "" |
| 22 |
. ds C' "" |
| 23 |
'br\} |
| 24 |
.el\{\ |
| 25 |
. ds C` |
| 26 |
. ds C' |
| 27 |
'br\} |
| 28 |
.\" |
| 29 |
.\" Escape single quotes in literal strings from groff's Unicode transform. |
| 30 |
.ie \n(.g .ds Aq \(aq |
| 31 |
.el .ds Aq ' |
| 32 |
.\" |
| 33 |
.\" If the F register is >0, we'll generate index entries on stderr for |
| 34 |
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index |
| 35 |
.\" entries marked with X<> in POD. Of course, you'll have to process the |
| 36 |
.\" output yourself in some meaningful fashion. |
| 37 |
.\" |
| 38 |
.\" Avoid warning from groff about undefined register 'F'. |
| 39 |
.de IX |
| 40 |
.. |
| 41 |
.nr rF 0 |
| 42 |
.if \n(.g .if rF .nr rF 1 |
| 43 |
.if (\n(rF:(\n(.g==0)) \{\ |
| 44 |
. if \nF \{\ |
| 45 |
. de IX |
| 46 |
. tm Index:\\$1\t\\n%\t"\\$2" |
| 47 |
.. |
| 48 |
. if !\nF==2 \{\ |
| 49 |
. nr % 0 |
| 50 |
. nr F 2 |
| 51 |
. \} |
| 52 |
. \} |
| 53 |
.\} |
| 54 |
.rr rF |
| 55 |
.\" ======================================================================== |
| 56 |
.\" |
| 57 |
.IX Title "ICEWMHINT 1" |
| 58 |
.TH ICEWMHINT 1 2026-01-18 "icewm\ 4.0.0" "User Commands" |
| 59 |
.\" For nroff, turn off justification. Always turn off hyphenation; it makes |
| 60 |
.\" way too many mistakes in technical documents. |
| 61 |
.if n .ad l |
| 62 |
.nh |
| 63 |
.SS NAME |
| 64 |
.IX Subsection "NAME" |
| 65 |
icewmhint \- set IceWM hints by window class and instance |
| 66 |
.SS SYNOPSIS |
| 67 |
.IX Subsection "SYNOPSIS" |
| 68 |
\&\fBicewmhint\fR \fICLASS\fR\fB.\fR\fIINSTANCE\fR \fIOPTION\fR \fIVALUE\fR ... |
| 69 |
.SS DESCRIPTION |
| 70 |
.IX Subsection "DESCRIPTION" |
| 71 |
\&\fBicewmhint\fR is a utility for passing IceWM hints to \fBicewm\fR\|(1). |
| 72 |
\&\fBicewm\fR uses these hints for the first \fIX11 client\fR which is |
| 73 |
subsequently started. They take precedence over hints from |
| 74 |
the \fBicewm\-winoptions\fR\|(1) file. |
| 75 |
.PP |
| 76 |
A hint is a triplet consisting of a \fIclass.instance\fR, an |
| 77 |
\&\fIIceWM winoption\fR and its value. Multiple hints can be given per |
| 78 |
invocation of \fBicewmhint\fR. |
| 79 |
.PP |
| 80 |
The hints are communicated over the \f(CW\*(C`_ICEWM_WINOPTHINT\*(C'\fR property on |
| 81 |
the root window. \fBicewmhint\fR appends hints to this property, while |
| 82 |
\&\fBicewm\fR removes the property after reading it. |
| 83 |
.SS OPTIONS |
| 84 |
.IX Subsection "OPTIONS" |
| 85 |
\&\fBicewmhint\fR recognizes the following options: |
| 86 |
.SS "COMMAND OPTIONS" |
| 87 |
.IX Subsection "COMMAND OPTIONS" |
| 88 |
Only one command option can be specified per invocation. If no command |
| 89 |
option is specified, argument parsing and processing is performed. |
| 90 |
.IP "\fB\-h\fR, \fB\-\-help\fR" 4 |
| 91 |
.IX Item "-h, --help" |
| 92 |
Print a brief usage statement to \fIstdout\fR and exit. |
| 93 |
.IP "\fB\-V\fR, \fB\-\-version\fR" 4 |
| 94 |
.IX Item "-V, --version" |
| 95 |
Print the program version to \fIstdout\fR and exit. |
| 96 |
.IP "\fB\-C\fR, \fB\-\-copying\fR" 4 |
| 97 |
.IX Item "-C, --copying" |
| 98 |
Print copying permissions to \fIstdout\fR for the program and exit. |
| 99 |
.SS "GENERAL OPTIONS" |
| 100 |
.IX Subsection "GENERAL OPTIONS" |
| 101 |
.IP "\fB\-d\fR, \fB\-\-display\fR=\fIDISPLAY\fR" 4 |
| 102 |
.IX Item "-d, --display=DISPLAY" |
| 103 |
Specifies the X11 DISPLAY. If unspecified, defaults to \fR\f(CB$DISPLAY\fR\fB\fR. |
| 104 |
.SS ARGUMENTS |
| 105 |
.IX Subsection "ARGUMENTS" |
| 106 |
The following three arguments are required for each hint. |
| 107 |
.IP \fICLASS\fR\fB.\fR\fIINSTANCE\fR 4 |
| 108 |
.IX Item "CLASS.INSTANCE" |
| 109 |
Specifies the ICCCM 2.0 \fBWM_CLASS\fR property in terms of resource class |
| 110 |
and resource name separated by a period (\f(CW\*(C`.\*(C'\fR). For example: |
| 111 |
\&\f(CW\*(C`XTerm.xterm\*(C'\fR. Just the resource class or resource name without a dot |
| 112 |
is also acceptable, like \f(CW\*(C`XTerm\*(C'\fR or \f(CW\*(C`xterm\*(C'\fR. |
| 113 |
.IP \fIOPTION\fR 4 |
| 114 |
.IX Item "OPTION" |
| 115 |
Specifies the \fIOPTION\fR to affect. |
| 116 |
.IP \fIVALUE\fR 4 |
| 117 |
.IX Item "VALUE" |
| 118 |
Gives the \fIVALUE\fR for the option. |
| 119 |
.PP |
| 120 |
Multiple hints can be given. |
| 121 |
.SS "GENERAL OPTION ARGUMENTS" |
| 122 |
.IX Subsection "GENERAL OPTION ARGUMENTS" |
| 123 |
.IP "\fBicon\fR \fINAME\fR" 4 |
| 124 |
.IX Item "icon NAME" |
| 125 |
Specifies the icon name for windows of \fICLASS\fR\fB.\fR\fIINSTANCE\fR. |
| 126 |
\&\fINAME\fR should be the name of the icon. \fBicewm\fR\|(1) will use its |
| 127 |
usual method to locate the icon. The default is the name provided |
| 128 |
by window manager hints. |
| 129 |
.IP "\fBworkspace\fR \fIWORKSPACE\fR" 4 |
| 130 |
.IX Item "workspace WORKSPACE" |
| 131 |
Specifies the workspace on which a window of \fICLASS\fR\fB.\fR\fIINSTANCE\fR |
| 132 |
will be initially placed. The default is the current workspace. |
| 133 |
\&\fIWORKSPACE\fR should be a workspace number counting from 0. |
| 134 |
.IP "\fBgeometry\fR \fIGEOMETRY\fR" 4 |
| 135 |
.IX Item "geometry GEOMETRY" |
| 136 |
Specifies the initial geometry for windows of the given |
| 137 |
\&\fICLASS\fR\fB.\fR\fIINSTANCE\fR. \fIGEOMETRY\fR must be a geometry that can be |
| 138 |
parsed by \fBXParseGeometry\fR\|(3). The default is the geometry provided by |
| 139 |
window manager hints. |
| 140 |
.IP "\fBorder\fR \fINUMBER\fR" 4 |
| 141 |
.IX Item "order NUMBER" |
| 142 |
The sorting order of task buttons and tray icons. The default value is |
| 143 |
zero. Increasing positive values go farther right, while decreasing |
| 144 |
negative values go farther left. The order option applies to the task |
| 145 |
pane, the tray pane and the system tray. |
| 146 |
.IP "\fBopacity\fR \fINUMBER\fR" 4 |
| 147 |
.IX Item "opacity NUMBER" |
| 148 |
Set the _NET_WM_WINDOW_OPACITY property if \fINUMBER\fR is a value between |
| 149 |
1 and 100. \fINUMBER\fR is interpreted as percentage of maximum opaqueness. |
| 150 |
.IP "\fBlayer\fR {\fILAYER\fR|\fINUMBER\fR}" 4 |
| 151 |
.IX Item "layer {LAYER|NUMBER}" |
| 152 |
This command option specifies the layer to be associated with a |
| 153 |
\&\fICLASS\fR\fB.\fR\fIINSTANCE\fR. The default is the \f(CW\*(C`Normal\*(C'\fR layer. \fIVALUE\fR |
| 154 |
is either a layer number or a symbolic layer name. Symbolic |
| 155 |
layer names are: |
| 156 |
.Sp |
| 157 |
.Vb 9 |
| 158 |
\& Desktop (0) Desktop window. |
| 159 |
\& Below (2) Below the default layer. |
| 160 |
\& Normal (4) Default layer for windows. |
| 161 |
\& OnTop (6) Above the default layer. |
| 162 |
\& Dock (8) Docked windows at edge of screen. |
| 163 |
\& AboveDock (10) Windows above the dock. |
| 164 |
\& Menu (12) The layer for menu\*(Aqs. |
| 165 |
\& Fullscreen (14) When fullscreen and focused. |
| 166 |
\& AboveAll (15) Always above anything. |
| 167 |
.Ve |
| 168 |
.IP "\fBtray\fR {\fBIgnore\fR|\fBMinimized\fR|\fBExclusive\fR|\fINUMBER\fR}" 4 |
| 169 |
.IX Item "tray {Ignore|Minimized|Exclusive|NUMBER}" |
| 170 |
Specifies the tray handling to be applied to windows with |
| 171 |
\&\fICLASS\fR\fB.\fR\fIINSTANCE\fR. This option is specific to \fBicewm\fR\|(1) and |
| 172 |
sets the \f(CW\*(C`_ICEWM_TRAY\*(C'\fR property associated with the window. |
| 173 |
The default is \f(CW\*(C`Ignore\*(C'\fR. \fIVALUE\fR can be an option number |
| 174 |
or a symbolic name as follows: |
| 175 |
.Sp |
| 176 |
.Vb 3 |
| 177 |
\& Ignore (0) only in task list. |
| 178 |
\& Minimized (1) icon in tray, task list unminimized. |
| 179 |
\& Exclusive (2) only in tray, not in task list. |
| 180 |
.Ve |
| 181 |
.IP "\fBframe\fR \fIlabel\fR (default: none)" 4 |
| 182 |
.IX Item "frame label (default: none)" |
| 183 |
All windows with the same frame label become tabs in a single frame. |
| 184 |
.SS "FUNCTION OPTION ARGUMENTS" |
| 185 |
.IX Subsection "FUNCTION OPTION ARGUMENTS" |
| 186 |
Specifies which functions are disabled or enabled (0/1) for windows with |
| 187 |
\&\fICLASS\fR\fB.\fR\fIINSTANCE\fR. All functions have a default value of enabled |
| 188 |
(1) unless overridden by the application. The Motif-like functions are |
| 189 |
as follows: |
| 190 |
.PP |
| 191 |
.Vb 7 |
| 192 |
\& fClose can be closed: (default: 1). |
| 193 |
\& fHide can be hidden: (default: 1). |
| 194 |
\& fMaximize can be maximized: (default: 1). |
| 195 |
\& fMinimize can be minimized: (default: 1). |
| 196 |
\& fMove can be moved: (default: 1). |
| 197 |
\& fResize can be resized: (default: 1). |
| 198 |
\& fRollup can be shaded: (default: 1). |
| 199 |
.Ve |
| 200 |
.SS "DECOR OPTION ARGUMENTS" |
| 201 |
.IX Subsection "DECOR OPTION ARGUMENTS" |
| 202 |
Specifies which decorations are disabled or enabled (0/1) for windows |
| 203 |
with \fICLASS\fR\fB.\fR\fIINSTANCE\fR. All decor options have a default value |
| 204 |
of enabled (1) unless overridden by the application. The Motif-like |
| 205 |
decorations are as follows: |
| 206 |
.PP |
| 207 |
.Vb 10 |
| 208 |
\& dBorder has border: (default: 1). |
| 209 |
\& dClose has close button: (default: 1). |
| 210 |
\& dDepth has depth button: (default: 1). |
| 211 |
\& dHide has hide button: (default: 1). |
| 212 |
\& dMaximize has maximize button: (default: 1). |
| 213 |
\& dMinimize has minimize button: (default: 1). |
| 214 |
\& dResize has resize grips: (default: 1). |
| 215 |
\& dRollup has shade button: (default: 1). |
| 216 |
\& dSysMenu has window menu: (default: 1). |
| 217 |
\& dTitleBar has title bar: (default: 1). |
| 218 |
.Ve |
| 219 |
.SS "FEATURE OPTION ARGUMENTS" |
| 220 |
.IX Subsection "FEATURE OPTION ARGUMENTS" |
| 221 |
Specifies which advanced features to be enabled/disabled (1/0) for |
| 222 |
windows with \fICLASS\fR\fB.\fR\fIINSTANCE\fR. All advanced features have a |
| 223 |
default value of disabled (0) unless overridden by the application. The |
| 224 |
advanced features are as follows: |
| 225 |
.PP |
| 226 |
.Vb 10 |
| 227 |
\& allWorkspaces on all workspaces. |
| 228 |
\& appTakesFocus let application take focus. |
| 229 |
\& doNotCover limits workspace if sticky. |
| 230 |
\& doNotFocus do not focus. |
| 231 |
\& doNotManage do not manage. |
| 232 |
\& forcedClose no close dialog. |
| 233 |
\& fullKeys provided more keys. |
| 234 |
\& ignoreNoFocusHint focus even no\-input. |
| 235 |
\& ignorePagerPreview do not show in pager preview. |
| 236 |
\& ignorePositionHint place automatically. |
| 237 |
\& ignoreQuickSwitch not on quick switch. |
| 238 |
\& ignoreTaskBar not on task bar. |
| 239 |
\& ignoreUrgentHint ignore urgent hints. |
| 240 |
\& ignoreWinList not on window list. |
| 241 |
\& ignoreActivationMessages only user can focus window. |
| 242 |
\& ignoreOverrideRedirect ignore the override redirect flag. |
| 243 |
\& noFocusOnAppRaise no focus on raise. |
| 244 |
\& noFocusOnMap do not focus when mapped. |
| 245 |
\& noIgnoreTaskBar on task bar. |
| 246 |
\& startClose close the window immediately. |
| 247 |
\& startFullscreen start full screen. |
| 248 |
\& startMaximized start maximized. |
| 249 |
\& startMaximizedHorz start maximized horizontal. |
| 250 |
\& startMaximizedVert start maximized vertical. |
| 251 |
\& startMinimized start minimized. |
| 252 |
.Ve |
| 253 |
.SS EXAMPLE |
| 254 |
.IX Subsection "EXAMPLE" |
| 255 |
.Vb 2 |
| 256 |
\& # Here is how to preload an invisible background process of chromium |
| 257 |
\& # on the fourth workspace which is only visible on the Window List. |
| 258 |
\& |
| 259 |
\& icewmhint Chromium\-browser startMinimized 1 \e |
| 260 |
\& Chromium\-browser workspace 3 \e |
| 261 |
\& Chromium\-browser ignorePagerPreview 1 \e |
| 262 |
\& Chromium\-browser ignorePositionHint 1 \e |
| 263 |
\& Chromium\-browser ignoreTaskBar 1 \e |
| 264 |
\& Chromium\-browser ignoreQuickSwitch 1 \e |
| 265 |
\& Chromium\-browser ignoreUrgentHint 1 \e |
| 266 |
\& Chromium\-browser noFocusOnAppRaise 1 |
| 267 |
\& chromium |
| 268 |
.Ve |
| 269 |
.SS BUGS |
| 270 |
.IX Subsection "BUGS" |
| 271 |
Please report bugs at <https://github.com/ice\-wm/icewm/issues>. |
| 272 |
.SS AUTHOR |
| 273 |
.IX Subsection "AUTHOR" |
| 274 |
Brian Bidulock <mailto:[email protected]>. |
| 275 |
.PP |
| 276 |
See \fB\-\-copying\fR for full copyright notice and copying permissions. |
| 277 |
.SS LICENSE |
| 278 |
.IX Subsection "LICENSE" |
| 279 |
\&\fBIceWM\fR is licensed under the GNU Library General Public License. |
| 280 |
See the \fICOPYING\fR file in the distribution or use the \fB\-\-copying\fR flag |
| 281 |
to display copying permissions. |