Debian Codegraph @

upstream/debian-trixie/man1/icesh.1

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