| 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 "ICESH 1" |
| 58 |
.TH ICESH 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 |
.Vb 1 |
| 66 |
\& icesh \- control window properties and the IceWM window manager |
| 67 |
.Ve |
| 68 |
.SS SYNOPSIS |
| 69 |
.IX Subsection "SYNOPSIS" |
| 70 |
.IP "\fBicesh\fR \fIOPTIONS|ACTIONS\fR+" 4 |
| 71 |
.IX Item "icesh OPTIONS|ACTIONS+" |
| 72 |
.SS DESCRIPTION |
| 73 |
.IX Subsection "DESCRIPTION" |
| 74 |
\&\fBicesh\fR provides two types of commands: |
| 75 |
.IP "1. Commands to directly interact with icewm:" 4 |
| 76 |
.IX Item "1. Commands to directly interact with icewm:" |
| 77 |
These are listed in the section "MANAGER ACTIONS" below. |
| 78 |
They are easy to use, because they don't require to select one |
| 79 |
or more windows. For example, \f(CW\*(C`icesh restart\*(C'\fR will restart |
| 80 |
icewm and \f(CW\*(C`icesh clients\*(C'\fR lists the applications that |
| 81 |
are managed by icewm. |
| 82 |
.IP "2. Commands that operate on a selection of windows:" 4 |
| 83 |
.IX Item "2. Commands that operate on a selection of windows:" |
| 84 |
See the section \f(CW\*(C`WINDOW ACTIONS\*(C'\fR below. For example, \f(CW\*(C`icesh close\*(C'\fR |
| 85 |
is a request to close a window, but which window? Now icesh |
| 86 |
will turn the mouse pointer into a crosshair. Click on a window |
| 87 |
and a close request will be sent to that application. |
| 88 |
.Sp |
| 89 |
The power of icesh lies in its ability to programmatically |
| 90 |
select one or more windows and operate on that selection. |
| 91 |
This can be used in scripts and in \fBicewm\-keys\fR\|(5) |
| 92 |
to define your own window management hotkeys. For example, to |
| 93 |
immediately close all xterm windows do \f(CW\*(C`icesh \-c xterm close\*(C'\fR. |
| 94 |
.Sp |
| 95 |
There are a dozen \f(CW\*(C`SELECT OPTIONS\*(C'\fR to select windows. They start |
| 96 |
with a '\-' or a '+'. The '\-' starts a new selection, while the '+' |
| 97 |
adds more windows to an existing selection. |
| 98 |
.Sp |
| 99 |
This selection of windows can be reduced by \f(CW\*(C`FILTER OPTIONS\*(C'\fR. |
| 100 |
These remove unwanted windows from the current selection. |
| 101 |
Multiple filter options can be given. For example, |
| 102 |
\&\f(CW\*(C`icesh \-c xterm \-W this close\*(C'\fR will close only those xterms |
| 103 |
that are shown on the current workspace. The xterms on other |
| 104 |
workspaces are filtered out by the \f(CW\*(C`\-W this\*(C'\fR filter option. |
| 105 |
.PP |
| 106 |
There is no limit to the number of commands, selections, filters |
| 107 |
and actions that you can give to a single icesh command. |
| 108 |
They are processed and evaluated one by one from left to right. |
| 109 |
This makes icesh a small declarative programming language. |
| 110 |
Have a look at some examples near the end of this document. |
| 111 |
.SS OPTIONS |
| 112 |
.IX Subsection "OPTIONS" |
| 113 |
\&\fBicesh\fR recognizes the following options: |
| 114 |
.SS "SELECT OPTIONS" |
| 115 |
.IX Subsection "SELECT OPTIONS" |
| 116 |
Select options specify the window or windows to which subsequent |
| 117 |
actions apply. If none is given, but an action does require a window, |
| 118 |
then a selection crosshair is shown to select the desired window |
| 119 |
interactively. The manager actions do not require window options. |
| 120 |
.PP |
| 121 |
The following options \fIselect\fR one or more client windows. |
| 122 |
If needed, they can be repeated for successive actions. |
| 123 |
.IP "\fB\-a\fR, \fB\-all\fR" 4 |
| 124 |
.IX Item "-a, -all" |
| 125 |
Selects all client windows of the window manager. |
| 126 |
.IP "\fB\-f\fR, \fB\-focus\fR, \fB+f\fR, \fB+focus\fR" 4 |
| 127 |
.IX Item "-f, -focus, +f, +focus" |
| 128 |
Selects the application window that is currently focused. |
| 129 |
The option with minus sign replaces the existing selection with |
| 130 |
the focused window. With a plus sign the focused window is added to |
| 131 |
an existing selection. |
| 132 |
.IP "\fB+g\fR, \fB+group\fR" 4 |
| 133 |
.IX Item "+g, +group" |
| 134 |
Extend the current selection with client windows that |
| 135 |
belong to the same application window group. |
| 136 |
.IP "\fB\-r\fR, \fB\-root\fR, \fB+r\fR, \fB+root\fR" 4 |
| 137 |
.IX Item "-r, -root, +r, +root" |
| 138 |
Selects the root window. |
| 139 |
The option with minus sign replaces the existing selection with |
| 140 |
the root window. With a plus sign the root window is added to |
| 141 |
an existing selection. |
| 142 |
.IP "\fB\-s\fR, \fB\-shown\fR" 4 |
| 143 |
.IX Item "-s, -shown" |
| 144 |
Selects all client windows that are on the current workspace. |
| 145 |
.IP "\fB\-t\fR, \fB\-top\fR" 4 |
| 146 |
.IX Item "-t, -top" |
| 147 |
Selects all toplevel windows from the display unconditionally. |
| 148 |
This includes windows that have never been mapped and windows |
| 149 |
with the override redirect bit set to evade management. |
| 150 |
.IP "\fB\-w\fR, \fB\-window\fR, \fB+w\fR, \fB+window\fR \fIWINDOW_ID\fR" 4 |
| 151 |
.IX Item "-w, -window, +w, +window WINDOW_ID" |
| 152 |
Specifies the identifier of the window, \fIWINDOW_ID\fR, for which the |
| 153 |
action applies. Special identifiers are \fBroot\fR for the root window |
| 154 |
and \fBfocus\fR for the currently focused window. |
| 155 |
The option with minus sign replaces the existing selection. |
| 156 |
With a plus sign the window is added to an existing selection. |
| 157 |
.IP "\fB\-x\fR, \fB\-xembed\fR" 4 |
| 158 |
.IX Item "-x, -xembed" |
| 159 |
Selects all windows that are embedded using the \fIXEMBED\fR protocol. |
| 160 |
.IP "\fB+c\fR, \fB+class\fR \fICLASS\fR" 4 |
| 161 |
.IX Item "+c, +class CLASS" |
| 162 |
Extend the current selection with client windows that have a |
| 163 |
\&\fIWM_CLASS\fR property equal to \fICLASS\fR. This is the resource |
| 164 |
instance and class name. If \fICLASS\fR contains a period, only |
| 165 |
windows with exactly the same \fIWM_CLASS\fR property are matched. |
| 166 |
If there is no period, windows of the same class and windows |
| 167 |
of the same instance are selected. |
| 168 |
.IP "\fB+C\fR, \fB+Class\fR" 4 |
| 169 |
.IX Item "+C, +Class" |
| 170 |
Extend the current selection with client windows that |
| 171 |
have a \fIWM_CLASS\fR property \fIsimilar\fR to the already |
| 172 |
selected set of windows. |
| 173 |
.IP "\fB\-D\fR, \fB\-Dockapps\fR" 4 |
| 174 |
.IX Item "-D, -Dockapps" |
| 175 |
Selects all Dockapp applications that are managed by icewm. |
| 176 |
.IP "\fB+P\fR, \fB+Pid\fR" 4 |
| 177 |
.IX Item "+P, +Pid" |
| 178 |
Extend the current selection with client windows that have |
| 179 |
the same process identifier as one of the selected windows. |
| 180 |
.IP \fB\-T\fR 4 |
| 181 |
.IX Item "-T" |
| 182 |
Selects the IceWM taskbar. |
| 183 |
.IP "\fB\-A\fR, \fB\-Await\fR" 4 |
| 184 |
.IX Item "-A, -Await" |
| 185 |
Wait for one or more new client windows to appear and make that the new |
| 186 |
selection. |
| 187 |
.SS "FILTER OPTIONS" |
| 188 |
.IX Subsection "FILTER OPTIONS" |
| 189 |
The following options \fIfilter\fR the currently selected set of windows. |
| 190 |
If no previous \fIselect\fR option was given then a \fB\-all\fR option is |
| 191 |
implicitly assumed to filter all client windows. |
| 192 |
.IP "\fB\-c\fR, \fB\-class\fR \fICLASS\fR" 4 |
| 193 |
.IX Item "-c, -class CLASS" |
| 194 |
Filters the set of windows on their \fIWM_CLASS\fR property. This is |
| 195 |
the resource instance and class name. If \fICLASS\fR contains a period, |
| 196 |
only windows with exactly the same \fIWM_CLASS\fR property are matched. |
| 197 |
If there is no period, windows of the same class and windows of the |
| 198 |
same instance (aka. \fI\-name\fR) are selected. |
| 199 |
.IP "\fB\-l\fR, \fB\-last\fR" 4 |
| 200 |
.IX Item "-l, -last" |
| 201 |
Filter clients and keep only the most recent client. |
| 202 |
.IP "\fB\-m\fR, \fB\-machine\fR \fIHOST\fR" 4 |
| 203 |
.IX Item "-m, -machine HOST" |
| 204 |
Filters clients by host name. Clients with a WM_CLIENT_MACHINE property |
| 205 |
equal to \fIHOST\fR are selected. |
| 206 |
.IP "\fB\-n\fR, \fB\-name\fR \fINAME\fR" 4 |
| 207 |
.IX Item "-n, -name NAME" |
| 208 |
Filters clients by _NET_WM_NAME or WM_NAME. |
| 209 |
\&\fINAME\fR matches any part of the property value. |
| 210 |
To match at the beginning use a \f(CW\*(C`^\*(C'\fR prefix. |
| 211 |
To match at the end use a \f(CW\*(C`$\*(C'\fR suffix. |
| 212 |
.IP "\fB\-p\fR, \fB\-pid\fR \fIPID\fR" 4 |
| 213 |
.IX Item "-p, -pid PID" |
| 214 |
Filters clients by process ID. Clients are selected that have |
| 215 |
a process ID of \fIPID\fR, when libXRes is at version 1.2, or |
| 216 |
that have a _NET_WM_PID property equal to \fIPID\fR. |
| 217 |
.IP "\fB\-u\fR, \fB\-unmapped\fR" 4 |
| 218 |
.IX Item "-u, -unmapped" |
| 219 |
Filter clients and keep those that are currently not viewable. |
| 220 |
These are hidden, minimized, rolled-up, or on another workspace. |
| 221 |
.IP "\fB\-v\fR, \fB\-viewable\fR" 4 |
| 222 |
.IX Item "-v, -viewable" |
| 223 |
Filter clients and keep only those that are currently viewable. |
| 224 |
These clients are mapped on the current workspace. |
| 225 |
.IP "\fB\-k\fR, \fB\-kovered\fR" 4 |
| 226 |
.IX Item "-k, -kovered" |
| 227 |
Filter clients and keep only those that are currently viewable and |
| 228 |
that are at least partially covered by another viewable window. |
| 229 |
.IP "\fB\-G\fR, \fB\-Gravity\fR \fIGRAVITY\fR" 4 |
| 230 |
.IX Item "-G, -Gravity GRAVITY" |
| 231 |
Filters clients by the window gravity field of the WM_NORMAL_HINTS |
| 232 |
property. Clients with a gravity equal to \fIGRAVITY\fR are selected. |
| 233 |
If \fIGRAVITY\fR starts with an exclamation mark then the filtering is |
| 234 |
inverted. |
| 235 |
.IP "\fB\-L\fR, \fB\-Layer\fR \fILAYER\fR" 4 |
| 236 |
.IX Item "-L, -Layer LAYER" |
| 237 |
Filters clients by \fIGNOME window layer\fR, which can either be a layer |
| 238 |
name or a layer number. See EXPRESSIONS below. If \fILAYER\fR starts with |
| 239 |
an exclamation mark then the filtering is inverted. |
| 240 |
.IP "\fB\-N\fR, \fB\-Netstate\fR \fISTATE\fR" 4 |
| 241 |
.IX Item "-N, -Netstate STATE" |
| 242 |
Filters clients by \fIEWMH window state\fR. Clients that have at |
| 243 |
least an EWMH window state of \fISTATE\fR are selected. This state |
| 244 |
refers to details like \fBMINIZED\fR or \fBMAXIMIZED\fR. See EXPRESSIONS |
| 245 |
below. If \fISTATE\fR starts with an exclamation mark then the filtering |
| 246 |
is inverted. A question mark \f(CW\*(C`?\*(C'\fR filters clients with any bit set |
| 247 |
in \fISTATE\fR. |
| 248 |
.IP "\fB\-P\fR, \fB\-Property\fR \fIPROP[=value]\fR" 4 |
| 249 |
.IX Item "-P, -Property PROP[=value]" |
| 250 |
Filters clients by property. Clients that have a property \fIPROP\fR |
| 251 |
are selected. If the optional \fIvalue\fR is given, the match succeeds |
| 252 |
only if \fIPROP\fR is a string, window, cardinal, or atom, with a value |
| 253 |
equal to \fIvalue\fR. The filtering is inverted if \fIPROP\fR starts with |
| 254 |
an exclamation mark. |
| 255 |
.IP "\fB\-R\fR, \fB\-Role\fR \fIROLE\fR" 4 |
| 256 |
.IX Item "-R, -Role ROLE" |
| 257 |
Filters clients by WM_WINDOW_ROLE. Clients that have a WM_WINDOW_ROLE |
| 258 |
property value equal to \fIROLE\fR are selected. The filtering is inverted |
| 259 |
if \fIROLE\fR starts with an exclamation mark. |
| 260 |
.IP "\fB\-W\fR, \fB\-Workspace\fR \fIWORKSPACE\fR" 4 |
| 261 |
.IX Item "-W, -Workspace WORKSPACE" |
| 262 |
Filter clients by workspace. Workspace \fIWORKSPACE\fR is either a |
| 263 |
workspace name, or a workspace number counting from zero, or the word |
| 264 |
\&\f(CW\*(C`this\*(C'\fR for the current workspace, or the word \f(CW\*(C`All\*(C'\fR for all workspaces. |
| 265 |
If \fIWORKSPACE\fR starts with an exclamation mark then the filtering is |
| 266 |
inverted. |
| 267 |
.IP "\fB\-X\fR, \fB\-Xinerama\fR \fIMONITOR\fR" 4 |
| 268 |
.IX Item "-X, -Xinerama MONITOR" |
| 269 |
Limit clients by \fIRandR\fR/\fIXinerama\fR monitor. Only operate on |
| 270 |
clients that are displayed on \fIMONITOR\fR, where \fIMONITOR\fR can |
| 271 |
be \f(CW\*(C`All\*(C'\fR for all monitors, \f(CW\*(C`this\*(C'\fR for the monitor where the |
| 272 |
active window is displayed, or a monitor number starting from zero. |
| 273 |
See the output of \f(CW\*(C`randr\*(C'\fR or \f(CW\*(C`xinerama\*(C'\fR below. |
| 274 |
.IP "\fB\-Z\fR, \fB\-Zerminal\fR" 4 |
| 275 |
.IX Item "-Z, -Zerminal" |
| 276 |
Keep only terminals: clients that have forked a shell. |
| 277 |
.SS "GENERAL OPTIONS" |
| 278 |
.IX Subsection "GENERAL OPTIONS" |
| 279 |
The following options are identical for every IceWM command. |
| 280 |
.IP "\fB\-d\fR, \fB\-display\fR \fIDISPLAY\fR" 4 |
| 281 |
.IX Item "-d, -display DISPLAY" |
| 282 |
Specifies the X11 DISPLAY. If unspecified, defaults to \fR\f(CB$DISPLAY\fR\fB\fR. |
| 283 |
.IP "\fB\-h\fR, \fB\-\-help\fR" 4 |
| 284 |
.IX Item "-h, --help" |
| 285 |
Print a brief usage statement to \fIstdout\fR and exit. |
| 286 |
.IP "\fB\-V\fR, \fB\-\-version\fR" 4 |
| 287 |
.IX Item "-V, --version" |
| 288 |
Print the program version to \fIstdout\fR and exit. |
| 289 |
.IP "\fB\-C\fR, \fB\-\-copying\fR" 4 |
| 290 |
.IX Item "-C, --copying" |
| 291 |
Print copying permissions to \fIstdout\fR for the program and exit. |
| 292 |
.IP "\fB\-q\fR, \fB\-\-quiet\fR" 4 |
| 293 |
.IX Item "-q, --quiet" |
| 294 |
Don't complain if no matching windows could be found. |
| 295 |
.SS ACTIONS |
| 296 |
.IX Subsection "ACTIONS" |
| 297 |
\&\fBicesh\fR expects one or more action arguments. There are two kinds of |
| 298 |
actions: \fIwindow actions\fR and \fImanager actions\fR. The first operates on |
| 299 |
the selected windows. The second directly interacts with the \fBicewm\fR |
| 300 |
window manager. |
| 301 |
.SS "WINDOW ACTIONS" |
| 302 |
.IX Subsection "WINDOW ACTIONS" |
| 303 |
The following actions affect the selected window or windows. |
| 304 |
.IP \fBactivate\fR 4 |
| 305 |
.IX Item "activate" |
| 306 |
Activate the window, aka. \fIto focus\fR. |
| 307 |
.IP \fBclose\fR 4 |
| 308 |
.IX Item "close" |
| 309 |
Send a close request to the client that created the window. |
| 310 |
.IP \fBkill\fR 4 |
| 311 |
.IX Item "kill" |
| 312 |
Force an immediate close down of the client that created the window. |
| 313 |
.IP \fBid\fR 4 |
| 314 |
.IX Item "id" |
| 315 |
Print window identifiers for the selected windows. |
| 316 |
.IP \fBpid\fR 4 |
| 317 |
.IX Item "pid" |
| 318 |
Print process identifiers for the selected windows. |
| 319 |
.IP \fBlist\fR 4 |
| 320 |
.IX Item "list" |
| 321 |
Show window details, like geometry and names. |
| 322 |
.IP \fBlower\fR 4 |
| 323 |
.IX Item "lower" |
| 324 |
Lower the window. |
| 325 |
.IP \fBraise\fR 4 |
| 326 |
.IX Item "raise" |
| 327 |
Raise the window. |
| 328 |
.IP \fBabove\fR 4 |
| 329 |
.IX Item "above" |
| 330 |
Stack the window above others. |
| 331 |
.IP \fBbelow\fR 4 |
| 332 |
.IX Item "below" |
| 333 |
Stack the window below others. |
| 334 |
.IP \fBrollup\fR 4 |
| 335 |
.IX Item "rollup" |
| 336 |
Rollup the specified window. |
| 337 |
.IP \fBfullscreen\fR 4 |
| 338 |
.IX Item "fullscreen" |
| 339 |
Set the window to fullscreen. |
| 340 |
.IP \fBmaximize\fR 4 |
| 341 |
.IX Item "maximize" |
| 342 |
Maximize the window. |
| 343 |
.IP \fBhorizontal\fR 4 |
| 344 |
.IX Item "horizontal" |
| 345 |
Maximize the window only horizontally. |
| 346 |
.IP \fBvertical\fR 4 |
| 347 |
.IX Item "vertical" |
| 348 |
Maximize the window only vertically. |
| 349 |
.IP \fBminimize\fR 4 |
| 350 |
.IX Item "minimize" |
| 351 |
Minimize the window. |
| 352 |
.IP \fBrestore\fR 4 |
| 353 |
.IX Item "restore" |
| 354 |
Restore the window to normal and clear urgency. |
| 355 |
.IP \fBhide\fR 4 |
| 356 |
.IX Item "hide" |
| 357 |
Hide the window. |
| 358 |
.IP \fBunhide\fR 4 |
| 359 |
.IX Item "unhide" |
| 360 |
Reveal the window. |
| 361 |
.IP \fBskip\fR 4 |
| 362 |
.IX Item "skip" |
| 363 |
Don't show the window on the taskbar. |
| 364 |
.IP \fBunskip\fR 4 |
| 365 |
.IX Item "unskip" |
| 366 |
Do show the window on the taskbar. |
| 367 |
.IP \fBsticky\fR 4 |
| 368 |
.IX Item "sticky" |
| 369 |
Show the window on all workspaces. |
| 370 |
.IP \fBunsticky\fR 4 |
| 371 |
.IX Item "unsticky" |
| 372 |
Show the window on just one workspace. |
| 373 |
.IP \fBurgent\fR 4 |
| 374 |
.IX Item "urgent" |
| 375 |
Set the urgency flag to flash the task button. |
| 376 |
.IP "\fBresize\fR \fIWIDTH\fR \fIHEIGHT\fR" 4 |
| 377 |
.IX Item "resize WIDTH HEIGHT" |
| 378 |
Resize window to \fIWIDTH\fR by \fIHEIGHT\fR window units. For text based |
| 379 |
applications like terminals, a window unit is the size of a single |
| 380 |
character cell. |
| 381 |
.IP "\fBsizeto\fR \fIWIDTH\fR \fIHEIGHT\fR" 4 |
| 382 |
.IX Item "sizeto WIDTH HEIGHT" |
| 383 |
Resize window to \fIWIDTH\fR by \fIHEIGHT\fR pixels. If \fIWIDTH\fR or \fIHEIGHT\fR |
| 384 |
ends with a percent sign \f(CW\*(C`%\*(C'\fR, then they refer to a percentage of the |
| 385 |
desktop work area. For instance, \f(CW\*(C`sizeto 50% 100%\*(C'\fR resizes to half |
| 386 |
the desktop width and whatever height is available above or below the |
| 387 |
taskbar. |
| 388 |
.IP "\fBsizeby\fR \fIWIDTH\fR \fIHEIGHT\fR" 4 |
| 389 |
.IX Item "sizeby WIDTH HEIGHT" |
| 390 |
Resize window by \fIWIDTH\fR by \fIHEIGHT\fR pixels. If \fIWIDTH\fR or \fIHEIGHT\fR |
| 391 |
ends with a percent sign \f(CW\*(C`%\*(C'\fR, then they refer to a percentage of the |
| 392 |
current window size. For instance, \f(CW\*(C`sizeby 50% 200\*(C'\fR increases the width |
| 393 |
by 50% and increases the height by 200 pixels. |
| 394 |
.IP "\fBmove\fR \fIX\fR \fIY\fR" 4 |
| 395 |
.IX Item "move X Y" |
| 396 |
Move the selected window or windows to the screen position \fIX\fR \fIY\fR. |
| 397 |
To specify \fIX\fR or \fIY\fR values relative to the right side or bottom side |
| 398 |
precede the value with an extra minus sign, like in \f(CW\*(C`move \-+10 \-\-20\*(C'\fR. |
| 399 |
When \fIX\fR or \fIY\fR end with a percent sign \f(CW\*(C`%\*(C'\fR, they refer to a percentage |
| 400 |
of the desktop work area. |
| 401 |
.IP "\fBmoveby\fR \fIX\fR \fIY\fR" 4 |
| 402 |
.IX Item "moveby X Y" |
| 403 |
Displace window by \fIX\fR \fIY\fR pixels. |
| 404 |
.IP \fBcenter\fR 4 |
| 405 |
.IX Item "center" |
| 406 |
Position the window in the center of the desktop work area. |
| 407 |
.IP \fBleft\fR 4 |
| 408 |
.IX Item "left" |
| 409 |
Position the window against the left side of the desktop work area. |
| 410 |
.IP \fBright\fR 4 |
| 411 |
.IX Item "right" |
| 412 |
Position the window against the right side of the desktop work area. |
| 413 |
.IP \fBtop\fR 4 |
| 414 |
.IX Item "top" |
| 415 |
Position the window against the top side of the desktop work area. |
| 416 |
.IP \fBbottom\fR 4 |
| 417 |
.IX Item "bottom" |
| 418 |
Position the window against the bottom side of the desktop work area. |
| 419 |
.IP "\fBsetIconTitle\fR \fITITLE\fR" 4 |
| 420 |
.IX Item "setIconTitle TITLE" |
| 421 |
Set the icon title to \fITITLE\fR. |
| 422 |
.IP \fBgetIconTitle\fR 4 |
| 423 |
.IX Item "getIconTitle" |
| 424 |
Print the icon title. |
| 425 |
.IP "\fBsetWindowTitle\fR \fITITLE\fR" 4 |
| 426 |
.IX Item "setWindowTitle TITLE" |
| 427 |
Set the window title to \fITITLE\fR. |
| 428 |
.IP \fBgetWindowTitle\fR 4 |
| 429 |
.IX Item "getWindowTitle" |
| 430 |
Print the window title. |
| 431 |
.IP "\fBsetGeometry\fR \fIGEOMETRY\fR" 4 |
| 432 |
.IX Item "setGeometry GEOMETRY" |
| 433 |
Set the window geometry to \fIGEOMETRY\fR. This geometry should be |
| 434 |
specified in a format that can be parsed by \fBXParseGeometry\fR\|(3). |
| 435 |
Negative offsets are with respect to the bottom or right side of |
| 436 |
the screen. Use \f(CW\*(C`+\-\*(C'\fR for a truly negative position. |
| 437 |
.IP \fBgetGeometry\fR 4 |
| 438 |
.IX Item "getGeometry" |
| 439 |
Print the window geometry. |
| 440 |
.IP "\fBsetClass\fR \fICLASS\fR" 4 |
| 441 |
.IX Item "setClass CLASS" |
| 442 |
Set the resource name and class to \fICLASS\fR, which should be a resource |
| 443 |
name and a resource class connected by a dot. To preserve either the |
| 444 |
existing name or class, use a percentage sign for that part. |
| 445 |
.IP \fBgetClass\fR 4 |
| 446 |
.IX Item "getClass" |
| 447 |
Print the resource name and class. |
| 448 |
.IP "\fBnetState\fR \fI[STATE]\fR" 4 |
| 449 |
.IX Item "netState [STATE]" |
| 450 |
If \fISTATE\fR is omitted then it shows the \fIEWMH window state\fR. |
| 451 |
If \fISTATE\fR starts with a \f(CW\*(C`+\*(C'\fR then flags in \fISTATE\fR are appended to |
| 452 |
the existing \fIEWMH window state\fR. If \fISTATE\fR starts with a \f(CW\*(C`\-\*(C'\fR |
| 453 |
then flags in \fISTATE\fR are removed from the existing \fIEWMH window |
| 454 |
state\fR. If \fISTATE\fR starts with a \f(CW\*(C`^\*(C'\fR then flags in \fISTATE\fR are |
| 455 |
toggled with respect to the existing \fIEWMH window state\fR. |
| 456 |
If \fISTATE\fR starts with a \f(CW\*(C`=\*(C'\fR then the \fIEWMH window state\fR |
| 457 |
is set to \fISTATE\fR. See EXPRESSIONS below. A list of \fIEWMH flags\fR |
| 458 |
can be found in the output of \f(CW\*(C`icesh symbols\*(C'\fR. |
| 459 |
.IP "\fBsetLayer\fR \fILAYER\fR" 4 |
| 460 |
.IX Item "setLayer LAYER" |
| 461 |
Move the specified window to another \fIwindow layer\fR. |
| 462 |
See EXPRESSIONS below for a list of \fILAYER\fR symbols. |
| 463 |
.IP \fBgetLayer\fR 4 |
| 464 |
.IX Item "getLayer" |
| 465 |
Print the \fIwindow layer\fR for the specified window. |
| 466 |
.IP "\fBsetWorkspace\fR \fIWORKSPACE\fR" 4 |
| 467 |
.IX Item "setWorkspace WORKSPACE" |
| 468 |
Move the specified window to another workspace. Select the root |
| 469 |
window to change the current workspace. If \fIWORKSPACE\fR is \f(CW\*(C`All\*(C'\fR |
| 470 |
then the specified window becomes visible on all workspaces. |
| 471 |
Specify \f(CW\*(C`this\*(C'\fR for the current workspace, \f(CW\*(C`next\*(C'\fR for the subsequent |
| 472 |
workspace or \f(CW\*(C`prev\*(C'\fR for the preceding workspace. |
| 473 |
.IP \fBgetWorkspace\fR 4 |
| 474 |
.IX Item "getWorkspace" |
| 475 |
Print the workspace for the specified window. |
| 476 |
.IP "\fBopacity\fR [\fIOPACITY\fR]" 4 |
| 477 |
.IX Item "opacity [OPACITY]" |
| 478 |
Print the window opacity if \fIOPACITY\fR is not given, |
| 479 |
otherwise set the window opacity to \fIOPACITY\fR. |
| 480 |
.IP "\fBsetTrayOption\fR \fITRAYOPTION\fR" 4 |
| 481 |
.IX Item "setTrayOption TRAYOPTION" |
| 482 |
Set the \fIIceWM tray option\fR for the specified window to \fITRAYOPTION\fR. |
| 483 |
See \fIIceWM tray options\fR, below, for \fITRAYOPTION\fR symbols. |
| 484 |
.IP \fBgetTrayOption\fR 4 |
| 485 |
.IX Item "getTrayOption" |
| 486 |
Print the \fIIceWM tray option\fR for the specified window. |
| 487 |
.IP "\fBsetNormalGravity\fR \fIGRAVITY\fR" 4 |
| 488 |
.IX Item "setNormalGravity GRAVITY" |
| 489 |
Set the window gravity field in the WM_NORMAL_HINTS property for the |
| 490 |
specified window to \fIGRAVITY\fR. See below for \fIGRAVITY\fR symbols. |
| 491 |
.IP \fBgetNormalGravity\fR 4 |
| 492 |
.IX Item "getNormalGravity" |
| 493 |
Print the window gravity from the WM_NORMAL_HINTS property for the |
| 494 |
specified window. |
| 495 |
.IP "\fBsetWindowGravity\fR \fIGRAVITY\fR" 4 |
| 496 |
.IX Item "setWindowGravity GRAVITY" |
| 497 |
Set the window gravity for the specified window to \fIGRAVITY\fR. |
| 498 |
See below for \fIGRAVITY\fR symbols. |
| 499 |
.IP \fBgetWindowGravity\fR 4 |
| 500 |
.IX Item "getWindowGravity" |
| 501 |
Print the window gravity for the specified window. |
| 502 |
.IP "\fBsetBitGravity\fR \fIGRAVITY\fR" 4 |
| 503 |
.IX Item "setBitGravity GRAVITY" |
| 504 |
Set the bit gravity> for the specified window to \fIGRAVITY\fR. |
| 505 |
See below for \fIGRAVITY\fR symbols. |
| 506 |
.IP \fBgetBitGravity\fR 4 |
| 507 |
.IX Item "getBitGravity" |
| 508 |
Print the bit gravity for the specified window. |
| 509 |
.IP "\fBmotif\fR [\fBfuncs\fR \fIFUNCTIONS\fR | \fBdecor\fR \fIDECORATIONS\fR | \fBremove\fR]" 4 |
| 510 |
.IX Item "motif [funcs FUNCTIONS | decor DECORATIONS | remove]" |
| 511 |
Query, set or modify the \f(CW\*(C`_MOTIF_WM_HINTS\*(C'\fR property for the specified |
| 512 |
window. Without arguments \fBmotif\fR will show the current value, but |
| 513 |
only if the window has such a property. The property can be removed or |
| 514 |
reset with the \fBremove\fR argument. With \fBfuncs\fR and \fBdecor\fR individual |
| 515 |
fields of this property can be enabled or disabled. If \fIFUNCTIONS\fR or |
| 516 |
\&\fIDECORATIONS\fR starts with a minus or plus sign then the existing value |
| 517 |
is modified, otherwise it is set to the new value. Note that if \f(CW\*(C`All\*(C'\fR |
| 518 |
is set, other set fields are disabled and cleared fields are enabled. |
| 519 |
.IP \fBborderless\fR 4 |
| 520 |
.IX Item "borderless" |
| 521 |
Hide the frame borders and title. |
| 522 |
.IP \fBbordered\fR 4 |
| 523 |
.IX Item "bordered" |
| 524 |
Show the frame borders and title. |
| 525 |
.IP \fBdenormal\fR 4 |
| 526 |
.IX Item "denormal" |
| 527 |
Remove the WM_NORMAL_HINTS property, if it exists. This lifts |
| 528 |
font-size restrictions on resizing, especially for terminals. |
| 529 |
.IP "\fBprop\fR \fIPROPERTY\fR" 4 |
| 530 |
.IX Item "prop PROPERTY" |
| 531 |
Print the value of property \fIPROPERTY\fR, if it is present. |
| 532 |
.IP \fBproperties\fR 4 |
| 533 |
.IX Item "properties" |
| 534 |
Print all properties and their values. |
| 535 |
.IP \fBframe\fR 4 |
| 536 |
.IX Item "frame" |
| 537 |
Print the identifier of the window frame. |
| 538 |
.IP \fBextents\fR 4 |
| 539 |
.IX Item "extents" |
| 540 |
Print the window identifier and the frame border sizes: left, right, |
| 541 |
top and bottom. |
| 542 |
.IP \fBfocusmodel\fR 4 |
| 543 |
.IX Item "focusmodel" |
| 544 |
Print the ICCCM focus model as advertised by the client window. |
| 545 |
This is either Locally, Passive, Globally or NoInput. |
| 546 |
.IP "\fBoverride\fR [\fI0|1\fR]" 4 |
| 547 |
.IX Item "override [0|1]" |
| 548 |
Print the override redirect status for the window, or if either 0 or 1 |
| 549 |
is given, then disable or enable the override redirect status. |
| 550 |
.IP "\fBtabto\fR \fIlabel\fR" 4 |
| 551 |
.IX Item "tabto label" |
| 552 |
Move the windows as tabs to a frame that has \f(CW\*(C`frame\*(C'\fR label \fIlabel\fR. |
| 553 |
Such a frame is created if needed. |
| 554 |
.IP \fBuntab\fR 4 |
| 555 |
.IX Item "untab" |
| 556 |
Move each window to its own frame, if it is currently tabbed. |
| 557 |
.IP "\fBloadicon\fR \fIimage.pam\fR" 4 |
| 558 |
.IX Item "loadicon image.pam" |
| 559 |
Load an icon from file, which must be in the PAM image format, |
| 560 |
with dimensions at most 256, a depth of 4, and type \fIRGB_ALPHA\fR. |
| 561 |
.IP "\fBsaveicon\fR \fIfile000.pam\fR" 4 |
| 562 |
.IX Item "saveicon file000.pam" |
| 563 |
Save an icon to a new file in the PAM image format. Digits are |
| 564 |
increased to generate a unique new filename for each window. |
| 565 |
The window must have a \fI_NET_WM_ICON\fR property. |
| 566 |
.IP \fBusertime\fR 4 |
| 567 |
.IX Item "usertime" |
| 568 |
Show the time of last user interaction in milliseconds. |
| 569 |
.IP "\fBclick\fR \fIwindow-x\fR \fIwindow-y\fR \fIbutton\fR" 4 |
| 570 |
.IX Item "click window-x window-y button" |
| 571 |
Send a button press and release event at position (\fIwindow-x\fR, |
| 572 |
\&\fIwindow-y\fR). A negative position is relative to the bottom right |
| 573 |
corner. The mouse pointer is warped to the position before sending |
| 574 |
the events. The button number should be between 1 and 5 inclusive. |
| 575 |
.IP "\fBmonitors\fR \fItop\fR \fIbottom\fR \fIleft\fR \fIright\fR" 4 |
| 576 |
.IX Item "monitors top bottom left right" |
| 577 |
This sets the monitors to use for fullscreen. |
| 578 |
Top, bottom, left, and right are indices of the \fIicesh xinerama\fR command. |
| 579 |
.IP \fBspy\fR 4 |
| 580 |
.IX Item "spy" |
| 581 |
Observe the selected windows and report any changes. This includes |
| 582 |
focus, visibility, position, size and all window properties. |
| 583 |
To monitor all of the protocol request messages that client applications |
| 584 |
may send to icewm, also spy on the root window. |
| 585 |
.IP \fBstacking\fR 4 |
| 586 |
.IX Item "stacking" |
| 587 |
Sort the list of windows from topmost to bottom-most. |
| 588 |
.IP \fBreverse\fR 4 |
| 589 |
.IX Item "reverse" |
| 590 |
Reverse the order of the list of windows. |
| 591 |
.IP \fBswitchmenu\fR 4 |
| 592 |
.IX Item "switchmenu" |
| 593 |
Output the list as a menu for icewm's QuickSwitch. This action is to be |
| 594 |
used in a \fBswitchkey\fR directive in the \f(CW\*(C`keys\*(C'\fR file. |
| 595 |
.IP "\fBprint\fR \fIformat\fR" 4 |
| 596 |
.IX Item "print format" |
| 597 |
For each window in the selection, print a line according to \fIformat\fR. |
| 598 |
Here common backslash-escapes are recognized as well as the following |
| 599 |
percent formatting options: |
| 600 |
.RS 4 |
| 601 |
.IP \fB%\fR 4 |
| 602 |
.IX Item "%" |
| 603 |
A literal percent sign. |
| 604 |
.IP \fBh\fR 4 |
| 605 |
.IX Item "h" |
| 606 |
The window height. |
| 607 |
.IP \fBw\fR 4 |
| 608 |
.IX Item "w" |
| 609 |
The window width. |
| 610 |
.IP \fBx\fR 4 |
| 611 |
.IX Item "x" |
| 612 |
The window x\-position. |
| 613 |
.IP \fBy\fR 4 |
| 614 |
.IX Item "y" |
| 615 |
The window y\-position. |
| 616 |
.IP \fBg\fR 4 |
| 617 |
.IX Item "g" |
| 618 |
The window geometry. |
| 619 |
.IP \fBi\fR 4 |
| 620 |
.IX Item "i" |
| 621 |
The window identifying handle. |
| 622 |
.IP \fBo\fR 4 |
| 623 |
.IX Item "o" |
| 624 |
An icon name. |
| 625 |
.IP \fBp\fR 4 |
| 626 |
.IX Item "p" |
| 627 |
The process-ID of the window application. |
| 628 |
.IP \fBc\fR 4 |
| 629 |
.IX Item "c" |
| 630 |
The WM_CLASS property of the window. |
| 631 |
.IP \fBm\fR 4 |
| 632 |
.IX Item "m" |
| 633 |
The WM_CLIENT_MACHINE property of the window. |
| 634 |
.IP \fBt\fR 4 |
| 635 |
.IX Item "t" |
| 636 |
The window title. |
| 637 |
.IP \fBW\fR 4 |
| 638 |
.IX Item "W" |
| 639 |
The current workspace of the window. |
| 640 |
.RE |
| 641 |
.RS 4 |
| 642 |
.Sp |
| 643 |
Each percent format option may start with a minus sign for |
| 644 |
left-alignment and have a numeric field width. |
| 645 |
.RE |
| 646 |
.SS "MANAGER ACTIONS" |
| 647 |
.IX Subsection "MANAGER ACTIONS" |
| 648 |
The following actions control the IceWM window manager and therefore |
| 649 |
do not require a window \fIselect\fR or \fIfilter\fR option: |
| 650 |
.IP \fBlistWorkspaces\fR 4 |
| 651 |
.IX Item "listWorkspaces" |
| 652 |
List the names of all workspaces. |
| 653 |
.IP \fBcurrent\fR 4 |
| 654 |
.IX Item "current" |
| 655 |
Show the number and name of the current workspace. |
| 656 |
.IP "\fBgoto\fR \fIWORKSPACE\fR" 4 |
| 657 |
.IX Item "goto WORKSPACE" |
| 658 |
Change the current workspace to \fIWORKSPACE\fR. Specify \f(CW\*(C`next\*(C'\fR for the |
| 659 |
subsequent workspace or \f(CW\*(C`prev\*(C'\fR for the preceding workspace. |
| 660 |
.IP "\fBworkspaces\fR [\fICOUNT\fR]" 4 |
| 661 |
.IX Item "workspaces [COUNT]" |
| 662 |
Print the number of workspaces if \fICOUNT\fR is not given, |
| 663 |
otherwise set the number of workspaces to \fICOUNT\fR. |
| 664 |
.IP "\fBgetWorkspaceName\fR \fIINDEX\fR" 4 |
| 665 |
.IX Item "getWorkspaceName INDEX" |
| 666 |
Print the name of workspace \fIINDEX\fR, where \fIINDEX\fR is |
| 667 |
a workspace number starting from zero. |
| 668 |
.IP \fBgetWorkspaceNames\fR 4 |
| 669 |
.IX Item "getWorkspaceNames" |
| 670 |
Print the name of all workspaces, one per line of output. |
| 671 |
.IP "\fBsetWorkspaceName\fR \fIINDEX\fR \fINAME\fR" 4 |
| 672 |
.IX Item "setWorkspaceName INDEX NAME" |
| 673 |
Change the name of the workspace \fIINDEX\fR to \fINAME\fR, where \fIINDEX\fR is |
| 674 |
a workspace number starting from zero. |
| 675 |
.IP "\fBsetWorkspaceNames\fR \fINAME\fR [\fINAME\fR]*" 4 |
| 676 |
.IX Item "setWorkspaceNames NAME [NAME]*" |
| 677 |
Change the workspace names to the list of \fINAME\fRs. |
| 678 |
.IP "\fBaddWorkspace\fR \fINAME\fR" 4 |
| 679 |
.IX Item "addWorkspace NAME" |
| 680 |
Create a new workspace with name \fINAME\fR. |
| 681 |
.IP "\fBdesktop\fR [\fISHOWING\fR]" 4 |
| 682 |
.IX Item "desktop [SHOWING]" |
| 683 |
If \fISHOWING\fR is \f(CW1\fR then set \f(CW\*(C`showing the desktop\*(C'\fR mode. |
| 684 |
If \fISHOWING\fR is \f(CW0\fR then turn off \f(CW\*(C`showing the desktop\*(C'\fR. |
| 685 |
Print the current mode if \fISHOWING\fR is not given. |
| 686 |
.IP \fBworkarea\fR 4 |
| 687 |
.IX Item "workarea" |
| 688 |
Print the dimensions of the work area for the current workspace. |
| 689 |
This is the desktop, but minus space occupied by dock and panel windows. |
| 690 |
.IP \fBrandr\fR 4 |
| 691 |
.IX Item "randr" |
| 692 |
Summarize the \fIRandR\fR configuration. |
| 693 |
.IP \fBxinerama\fR 4 |
| 694 |
.IX Item "xinerama" |
| 695 |
Summarize the \fIXinerama\fR configuration. |
| 696 |
.IP \fBcheck\fR 4 |
| 697 |
.IX Item "check" |
| 698 |
Print information about the current window manager, like name, |
| 699 |
version, class, locale, command, host name and pid. |
| 700 |
.IP \fBclients\fR 4 |
| 701 |
.IX Item "clients" |
| 702 |
List all managed client windows, their titles and geometries. |
| 703 |
.IP \fBshown\fR 4 |
| 704 |
.IX Item "shown" |
| 705 |
List all mapped client windows for the current desktop, |
| 706 |
their titles and geometries. |
| 707 |
.IP \fBwindows\fR 4 |
| 708 |
.IX Item "windows" |
| 709 |
List all toplevel windows, their titles and geometries. |
| 710 |
.IP \fBsystray\fR 4 |
| 711 |
.IX Item "systray" |
| 712 |
List applications that are managed by the IceWM system tray. |
| 713 |
.IP \fBxembed\fR 4 |
| 714 |
.IX Item "xembed" |
| 715 |
List application windows that are embedded using the \fIXEMBED\fR protocol. |
| 716 |
This is another way to discover system tray applications. |
| 717 |
.IP \fBlogout\fR 4 |
| 718 |
.IX Item "logout" |
| 719 |
Let icewm execute the \f(CW\*(C`LogoutCommand\*(C'\fR. |
| 720 |
.IP \fBreboot\fR 4 |
| 721 |
.IX Item "reboot" |
| 722 |
Let icewm execute the \f(CW\*(C`RebootCommand\*(C'\fR. |
| 723 |
.IP \fBshutdown\fR 4 |
| 724 |
.IX Item "shutdown" |
| 725 |
Let icewm execute the \f(CW\*(C`ShutdownCommand\*(C'\fR. |
| 726 |
.IP \fBcancel\fR 4 |
| 727 |
.IX Item "cancel" |
| 728 |
Let icewm cancel the logout/reboot/shutdown. |
| 729 |
.IP \fBabout\fR 4 |
| 730 |
.IX Item "about" |
| 731 |
Let icewm show the about window. |
| 732 |
.IP \fBwindowlist\fR 4 |
| 733 |
.IX Item "windowlist" |
| 734 |
Let icewm show the window list window. |
| 735 |
.IP \fBrestart\fR 4 |
| 736 |
.IX Item "restart" |
| 737 |
Let icewm restart itself. |
| 738 |
.IP \fBsuspend\fR 4 |
| 739 |
.IX Item "suspend" |
| 740 |
Let icewm execute the \f(CW\*(C`SuspendCommand\*(C'\fR. |
| 741 |
.IP \fBhibernate\fR 4 |
| 742 |
.IX Item "hibernate" |
| 743 |
Let icewm execute the \f(CW\*(C`HibernateCommand\*(C'\fR. |
| 744 |
.IP \fBwinoptions\fR 4 |
| 745 |
.IX Item "winoptions" |
| 746 |
Let icewm reload the \f(CW\*(C`winoptions\*(C'\fR. |
| 747 |
This only affects new windows. |
| 748 |
.IP \fBkeys\fR 4 |
| 749 |
.IX Item "keys" |
| 750 |
Let icewm reload the \f(CW\*(C`keys\*(C'\fR file. |
| 751 |
.IP \fBtoolbar\fR 4 |
| 752 |
.IX Item "toolbar" |
| 753 |
Let icewm reload the \f(CW\*(C`toolbar\*(C'\fR file. |
| 754 |
.IP \fBrefresh\fR 4 |
| 755 |
.IX Item "refresh" |
| 756 |
Let icewm refresh the desktop background. |
| 757 |
.IP \fBguievents\fR 4 |
| 758 |
.IX Item "guievents" |
| 759 |
Monitor the \fBICEWM_GUI_EVENT\fR property and report all changes. |
| 760 |
Hit \f(CW\*(C`Ctrl+C\*(C'\fR to abort this and continue with the next command. |
| 761 |
.IP "\fBdelay\fR [\fItime\fR]" 4 |
| 762 |
.IX Item "delay [time]" |
| 763 |
Stop execution for \fItime\fR or 0.1 seconds. |
| 764 |
.IP "\fBrunonce\fR \fIprogram\fR [\fIarguments...\fR]" 4 |
| 765 |
.IX Item "runonce program [arguments...]" |
| 766 |
This action is meant to be used together with the \fB\-class\fR option. |
| 767 |
Only if no window is matched by \fIWM_CLASS\fR then |
| 768 |
\&\fIprogram\fR [\fIarguments...\fR] is executed. |
| 769 |
.IP "\fBloop\fR [\fIcount\fR]" 4 |
| 770 |
.IX Item "loop [count]" |
| 771 |
Loop back to the beginning of the command and repeat. The optional |
| 772 |
\&\fIcount\fR limits the number of repetitions. |
| 773 |
.IP \fBpick\fR 4 |
| 774 |
.IX Item "pick" |
| 775 |
Choose a window by a mouse button click. |
| 776 |
.IP \fBx11time\fR 4 |
| 777 |
.IX Item "x11time" |
| 778 |
Show the current X11 server time in milliseconds. |
| 779 |
.IP \fBsync\fR 4 |
| 780 |
.IX Item "sync" |
| 781 |
Synchronize with the IceWM window manager. That is, wait for icewm to |
| 782 |
process all previous actions. |
| 783 |
.IP \fBsymbols\fR 4 |
| 784 |
.IX Item "symbols" |
| 785 |
List all named symbols. |
| 786 |
.SS CONDITIONALS |
| 787 |
.IX Subsection "CONDITIONALS" |
| 788 |
Icesh supports \f(CW\*(C`if\-then\-else\*(C'\fR expressions. The full syntax is: |
| 789 |
.PP |
| 790 |
.Vb 9 |
| 791 |
\& if selection |
| 792 |
\& then |
| 793 |
\& actions |
| 794 |
\& elif selection |
| 795 |
\& then |
| 796 |
\& actions |
| 797 |
\& else |
| 798 |
\& actions |
| 799 |
\& end |
| 800 |
.Ve |
| 801 |
.PP |
| 802 |
Where \f(CW\*(C`selection\*(C'\fR is a sequence of selection and filtering options, |
| 803 |
which evaluates to \fBtrue\fR when it is non-empty. That is, if one or more |
| 804 |
windows fulfilled the condition. If it is empty, then its \f(CW\*(C`actions\*(C'\fR |
| 805 |
clause is ignored and the subsequent \f(CW\*(C`elif\*(C'\fR or \f(CW\*(C`else\*(C'\fR clause is tried |
| 806 |
or taken. Each clause is optional. |
| 807 |
.PP |
| 808 |
Whenever a selection condition evaluates to \fBfalse\fR, the window selection |
| 809 |
that existed before the \f(CW\*(C`if\*(C'\fR clause is immediately restored. This also |
| 810 |
happens after an \f(CW\*(C`end\*(C'\fR clause. |
| 811 |
.SS EXPRESSIONS |
| 812 |
.IX Subsection "EXPRESSIONS" |
| 813 |
Some of the window actions require one or two \fIEXPRESSION\fR arguments. |
| 814 |
.ie n .IP "\fBEXPRESSION\fR ::= \fISYMBOL\fR | \fIEXPRESSION\fR { ""+"" | ""|"" | ""\-"" } \fISYMBOL\fR" 4 |
| 815 |
.el .IP "\fBEXPRESSION\fR ::= \fISYMBOL\fR | \fIEXPRESSION\fR { \f(CW+\fR | \f(CW|\fR | \f(CW\-\fR } \fISYMBOL\fR" 4 |
| 816 |
.IX Item "EXPRESSION ::= SYMBOL | EXPRESSION { + | | | - } SYMBOL" |
| 817 |
.PP |
| 818 |
This says that an expression is either a \fISYMBOL\fR or an expression |
| 819 |
which is combined with an operator to a \fISYMBOL\fR. In other words, |
| 820 |
an expression is a sequence of symbols, which are combined using |
| 821 |
operators, where an operator may be a plus, a vertical bar or a minus. |
| 822 |
.PP |
| 823 |
Each \fISYMBOL\fR may be either a number or a named symbol from one of the |
| 824 |
following applicable domains, depending upon the context in which it is |
| 825 |
used: |
| 826 |
.IP "\fIWindow layer\fR" 4 |
| 827 |
.IX Item "Window layer" |
| 828 |
Named symbols of the domain \fIWindow layer\fR (numeric range: 0\-15): |
| 829 |
.Sp |
| 830 |
.Vb 9 |
| 831 |
\& Desktop (0) |
| 832 |
\& Below (2) |
| 833 |
\& Normal (4) |
| 834 |
\& OnTop (6) |
| 835 |
\& Dock (8) |
| 836 |
\& AboveDock (10) |
| 837 |
\& Menu (12) |
| 838 |
\& Fullscreen (14) |
| 839 |
\& AboveAll (15) |
| 840 |
.Ve |
| 841 |
.Sp |
| 842 |
These symbols are used with the \fILAYER\fR argument to the \f(CW\*(C`setLayer\*(C'\fR |
| 843 |
action. |
| 844 |
.IP "\fIIceWM tray option\fR" 4 |
| 845 |
.IX Item "IceWM tray option" |
| 846 |
Named symbols of the domain \fIIceWM tray option\fR (numeric range: 0\-2): |
| 847 |
.Sp |
| 848 |
.Vb 3 |
| 849 |
\& Ignore (0) |
| 850 |
\& Minimized (1) |
| 851 |
\& Exclusive (2) |
| 852 |
.Ve |
| 853 |
.Sp |
| 854 |
These symbols are used with the \fITRAYOPTION\fR argument to the |
| 855 |
\&\f(CW\*(C`setTrayOption\*(C'\fR action. |
| 856 |
.IP "\fIGravity symbols\fR" 4 |
| 857 |
.IX Item "Gravity symbols" |
| 858 |
Named symbols for window and bit gravity (numeric range: 0\-10): |
| 859 |
.Sp |
| 860 |
.Vb 11 |
| 861 |
\& ForgetGravity (0) |
| 862 |
\& NorthWestGravity (1) |
| 863 |
\& NorthGravity (2) |
| 864 |
\& NorthEastGravity (3) |
| 865 |
\& WestGravity (4) |
| 866 |
\& CenterGravity (5) |
| 867 |
\& EastGravity (6) |
| 868 |
\& SouthWestGravity (7) |
| 869 |
\& SouthGravity (8) |
| 870 |
\& SouthEastGravity (9) |
| 871 |
\& StaticGravity (10) |
| 872 |
.Ve |
| 873 |
.IP "\fIMotif functions\fR" 4 |
| 874 |
.IX Item "Motif functions" |
| 875 |
.Vb 6 |
| 876 |
\& All (1) |
| 877 |
\& Resize (2) |
| 878 |
\& Move (4) |
| 879 |
\& Minimize (8) |
| 880 |
\& Maximize (16) |
| 881 |
\& Close (32) |
| 882 |
.Ve |
| 883 |
.IP "\fIMotif decorations\fR" 4 |
| 884 |
.IX Item "Motif decorations" |
| 885 |
.Vb 7 |
| 886 |
\& All (1) |
| 887 |
\& Border (2) |
| 888 |
\& Resize (4) |
| 889 |
\& Title (8) |
| 890 |
\& Menu (16) |
| 891 |
\& Minimize (32) |
| 892 |
\& Maximize (64) |
| 893 |
.Ve |
| 894 |
.IP "\fIEWMH window state symbols\fR" 4 |
| 895 |
.IX Item "EWMH window state symbols" |
| 896 |
Named symbols of the domain \fIEWMH state\fR (numeric range: |
| 897 |
0\-8191): |
| 898 |
.Sp |
| 899 |
.Vb 10 |
| 900 |
\& ABOVE (1) |
| 901 |
\& BELOW (2) |
| 902 |
\& DEMANDS_ATTENTION (4) |
| 903 |
\& FOCUSED (8) |
| 904 |
\& FULLSCREEN (16) |
| 905 |
\& HIDDEN (32) |
| 906 |
\& MAXIMIZED_HORZ (64) |
| 907 |
\& MAXIMIZED_VERT (128) |
| 908 |
\& MODAL (256) |
| 909 |
\& SHADED (512) |
| 910 |
\& SKIP_PAGER (1024) |
| 911 |
\& SKIP_TASKBAR (2048) |
| 912 |
\& STICKY (4096) |
| 913 |
.Ve |
| 914 |
.SS EXAMPLES |
| 915 |
.IX Subsection "EXAMPLES" |
| 916 |
List all workspace names: |
| 917 |
.PP |
| 918 |
.Vb 1 |
| 919 |
\& icesh listWorkspaces |
| 920 |
.Ve |
| 921 |
.PP |
| 922 |
Example output: |
| 923 |
.PP |
| 924 |
.Vb 4 |
| 925 |
\& workspace #0: \`main\*(Aq |
| 926 |
\& workspace #1: \`web\*(Aq |
| 927 |
\& workspace #2: \`doc\*(Aq |
| 928 |
\& workspace #3: \`dev\*(Aq |
| 929 |
.Ve |
| 930 |
.PP |
| 931 |
Close terminal work and activate terminal fun. |
| 932 |
.PP |
| 933 |
.Vb 1 |
| 934 |
\& icesh \-c work.XTerm close \-a \-c fun.XTerm activate |
| 935 |
.Ve |
| 936 |
.PP |
| 937 |
Print opacity for all xterms. |
| 938 |
.PP |
| 939 |
.Vb 1 |
| 940 |
\& icesh \-c XTerm opacity |
| 941 |
.Ve |
| 942 |
.PP |
| 943 |
Change opacity for all xterms. |
| 944 |
.PP |
| 945 |
.Vb 1 |
| 946 |
\& icesh \-c XTerm opacity 84 |
| 947 |
.Ve |
| 948 |
.PP |
| 949 |
Move all windows on workspace "Top" to the current workspace. |
| 950 |
.PP |
| 951 |
.Vb 1 |
| 952 |
\& icesh \-W "Top" setWorkspace "this" |
| 953 |
.Ve |
| 954 |
.PP |
| 955 |
Restore all hidden clients, minimize all clients on the current |
| 956 |
workspace and activate Firefox. |
| 957 |
.PP |
| 958 |
.Vb 1 |
| 959 |
\& icesh \-N HIDDEN restore \-a \-W "this" minimize \-a \-c Firefox activate |
| 960 |
.Ve |
| 961 |
.PP |
| 962 |
Resize the focused window to occupy the right half of the desktop area. |
| 963 |
.PP |
| 964 |
.Vb 1 |
| 965 |
\& icesh \-f sizeto 49% 100% top right raise |
| 966 |
.Ve |
| 967 |
.PP |
| 968 |
Toggle the frame border of the focused window. |
| 969 |
.PP |
| 970 |
.Vb 2 |
| 971 |
\& if icesh \-f motif | grep \-q \*(Aqdecor:$\*(Aq; then \e |
| 972 |
\& icesh \-f motif decor All; else icesh \-f motif decor ""; fi |
| 973 |
.Ve |
| 974 |
.PP |
| 975 |
Here is a different solution using conditionals. |
| 976 |
.PP |
| 977 |
.Vb 1 |
| 978 |
\& icesh \-f if \-P _NET_FRAME_EXTENTS=0 then bordered else borderless |
| 979 |
.Ve |
| 980 |
.PP |
| 981 |
Here is a conditional to either toggle the visibility of a roxterm that |
| 982 |
has a WM_WINDOW_ROLE value of \f(CW\*(C`special\*(C'\fR or start it with \fBrunonce\fR. |
| 983 |
.PP |
| 984 |
.Vb 4 |
| 985 |
\& icesh if \-c roxterm.Roxterm \-R special then \e |
| 986 |
\& if \-v then hide \e |
| 987 |
\& elif \-u then setWorkspace this activate end \e |
| 988 |
\& else runonce roxterm \-\-role=special |
| 989 |
.Ve |
| 990 |
.PP |
| 991 |
Collect all urxvt terminals from the fourth workspace in a single frame |
| 992 |
on the current workspace. |
| 993 |
.PP |
| 994 |
.Vb 1 |
| 995 |
\& icesh \-W 3 \-c urxvt tabto myfunnyname |
| 996 |
.Ve |
| 997 |
.PP |
| 998 |
Use the loop construct conditionally to wait for a certain window to |
| 999 |
appear. |
| 1000 |
.PP |
| 1001 |
.Vb 1 |
| 1002 |
\& icesh \-t if \-n Tooltip then list else delay 0.05 loop end |
| 1003 |
.Ve |
| 1004 |
.SS ENVIRONMENT |
| 1005 |
.IX Subsection "ENVIRONMENT" |
| 1006 |
.IP \fBDISPLAY\fR 4 |
| 1007 |
.IX Item "DISPLAY" |
| 1008 |
The default display. |
| 1009 |
.SS "EXIT STATUS" |
| 1010 |
.IX Subsection "EXIT STATUS" |
| 1011 |
.IP \fB0\fR 4 |
| 1012 |
.IX Item "0" |
| 1013 |
The last action completed successfully. |
| 1014 |
.IP \fB1\fR 4 |
| 1015 |
.IX Item "1" |
| 1016 |
The last action completed unsuccessfully, or no window met the condition. |
| 1017 |
.IP \fB2\fR 4 |
| 1018 |
.IX Item "2" |
| 1019 |
A conditional has invalid syntax. |
| 1020 |
.IP \fB3\fR 4 |
| 1021 |
.IX Item "3" |
| 1022 |
The display could not be opened. |
| 1023 |
.IP \fB4\fR 4 |
| 1024 |
.IX Item "4" |
| 1025 |
The X server reports an error while processing a request. |
| 1026 |
.SS COMPLIANCE |
| 1027 |
.IX Subsection "COMPLIANCE" |
| 1028 |
\&\fBicesh\fR is largely compliant with the EWMH and ICCCM specifications. |
| 1029 |
Some commands, like manager actions, are specific to IceWM. |
| 1030 |
.SS "SEE ALSO" |
| 1031 |
.IX Subsection "SEE ALSO" |
| 1032 |
\&\fBicewm\fR\|(1), \fBwmctrl\fR\|(1), \fBxdotool\fR\|(1), \fBxprop\fR\|(1), |
| 1033 |
\&\fBxwininfo\fR\|(1), \fBXParseGeometry\fR\|(3). |
| 1034 |
.SS BUGS |
| 1035 |
.IX Subsection "BUGS" |
| 1036 |
Please report bugs at <https://github.com/ice\-wm/icewm/issues>. |
| 1037 |
.SS AUTHOR |
| 1038 |
.IX Subsection "AUTHOR" |
| 1039 |
Brian Bidulock <mailto:[email protected]>. |
| 1040 |
.PP |
| 1041 |
See \fB\-\-copying\fR for full copyright notice and copying permissions. |
| 1042 |
.SS LICENSE |
| 1043 |
.IX Subsection "LICENSE" |
| 1044 |
\&\fBIceWM\fR is licensed under the GNU Library General Public License. |
| 1045 |
See the \fICOPYING\fR file in the distribution or use the \fB\-\-copying\fR flag |
| 1046 |
to display copying permissions. |