.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .if !\nF .nr F 0 .if \nF>0 \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} .\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "ICESH 1" .TH ICESH 1 "2018-10-31" "icewm\ 1.4.3.0~pre-20181030" "User\ Commands" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" .Vb 1 \& icesh \- control properties of windows .Ve .SH "SYNOPSIS" .IX Header "SYNOPSIS" .IP "\fBicesh\fR [\fI\s-1OPTIONS\s0\fR] \fI\s-1ACTIONS\s0\fR" 4 .IX Item "icesh [OPTIONS] ACTIONS" .PD 0 .IP "\fBicesh\fR {\fB\-h\fR|\fB\-\-help\fR}" 4 .IX Item "icesh {-h|--help}" .IP "\fBicesh\fR {\fB\-V\fR|\fB\-\-version\fR}" 4 .IX Item "icesh {-V|--version}" .IP "\fBicesh\fR {\fB\-C\fR|\fB\-\-copying\fR}" 4 .IX Item "icesh {-C|--copying}" .PD .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\fBicesh\fR provides commands for use by shell scripts that affect a window's state similar to \fIwmctrl\fR\|(1) or \fIxdotool\fR\|(1), except more limited, specifically for \fB\f(BIicewm\fB\|(1)\fR, and limited to affecting \s-1GNOME\s0 WinWM/WMH properties. .SH "OPTIONS" .IX Header "OPTIONS" \&\fBicesh\fR recognizes the following options: .SS "\s-1COMMAND OPTIONS\s0" .IX Subsection "COMMAND OPTIONS" Command options are mutually exclusive. Only one command option can be specified per invocation. If no command option is specified, action argument parsing and processing is performed. .IP "\fB\-display\fR \fI\s-1DISPLAY\s0\fR" 4 .IX Item "-display DISPLAY" Specifies the X11 \fI\s-1DISPLAY\s0\fR to use. When unspecified, defaults to the \&\f(CW$DISPLAY\fR environment variable. .IP "\fB\-window\fR \fI\s-1WINDOW_ID\s0\fR" 4 .IX Item "-window WINDOW_ID" Specifies the identifier of the window, \fI\s-1WINDOW_ID\s0\fR, for which the action applies. Special identifiers are \fBroot\fR for the root window and \fBfocus\fR for the currently focused window. When no \fI\s-1WINDOW_ID\s0\fR or \fI\s-1WM_CLASS\s0\fR is specified, a selection crossbar is invoked to select the desired window. .IP "\fB\-class\fR \fI\s-1WM_CLASS\s0\fR" 4 .IX Item "-class WM_CLASS" Specifies the window manager class, \fI\s-1WM_CLASS\s0\fR, for which the action applies. If \fI\s-1WM_CLASS\s0\fR contains a period, only windows with exactly the same \fI\s-1WM_CLASS\s0\fR property are matched. If there is no period, windows of the same class and windows of the same instance (aka. \fI\-name\fR) are selected. When no \fI\s-1WINDOW_ID\s0\fR or \fI\s-1WM_CLASS\s0\fR is specified, a selection crossbar is invoked to select the desired window. .SS "\s-1GENERAL OPTIONS\s0" .IX Subsection "GENERAL OPTIONS" .IP "\fB\-h\fR, \fB\-\-help\fR" 4 .IX Item "-h, --help" Print a brief usage statement to \fIstdout\fR and exit. .IP "\fB\-V\fR, \fB\-\-version\fR" 4 .IX Item "-V, --version" Print the program version to \fIstdout\fR and exit. .IP "\fB\-C\fR, \fB\-\-copying\fR" 4 .IX Item "-C, --copying" Print copying permissions to \fIstdout\fR for the program and exit. .SH "ARGUMENTS" .IX Header "ARGUMENTS" \&\fBicesh\fR accepts the following arguments: .IP "\fB\s-1ACTIONS\s0\fR ::= \fI\s-1ACTION\s0\fR[ \fI\s-1ACTION\s0\fR]*" 4 .IX Item "ACTIONS ::= ACTION[ ACTION]*" Actions can be one of: .RS 4 .IP "\fBsetIconTitle\fR \fI\s-1TITLE\s0\fR" 4 .IX Item "setIconTitle TITLE" Set the icon title for the specified window to \fI\s-1TITLE\s0\fR. .IP "\fBsetWindowTitle\fR \fI\s-1TITLE\s0\fR" 4 .IX Item "setWindowTitle TITLE" Set the window title for the specified window to \fI\s-1TITLE\s0\fR .IP "\fBsetGeometry\fR \fI\s-1GEOMETRY\s0\fR" 4 .IX Item "setGeometry GEOMETRY" Set the window geometry for the specified window to \fI\s-1GEOMETRY\s0\fR. .IP "\fBsetState\fR \fI\s-1MASK\s0\fR \fI\s-1STATE\s0\fR" 4 .IX Item "setState MASK STATE" Set the \s-1GNOME\s0 window state for the specified window to \fI\s-1STATE\s0\fR. Only the bits selected by \fI\s-1MASK\s0\fR are affected. \fI\s-1STATE\s0\fR and \fI\s-1MASK\s0\fR are expressions of the domain \fI\s-1GNOME\s0 window state\fR. See \*(L"\s-1GNOME\s0 window state\*(R", below, for \fI\s-1STATE\s0\fR and \fI\s-1MASK\s0\fR symbols. .IP "\fBtoggleState\fR \fI\s-1STATE\s0\fR" 4 .IX Item "toggleState STATE" Toggle the \s-1GNOME\s0 window state bits specified by the \fI\s-1STATE\s0\fR expression for the specified window. See \*(L"\s-1GNOME\s0 window state\*(R", below, for \fI\s-1STATE\s0\fR symbols. .IP "\fBsetHints\fR \fI\s-1HINTS\s0\fR" 4 .IX Item "setHints HINTS" Set the \fI\s-1GNOME\s0 window hints\fR for the specified window to \fI\s-1HINTS\s0\fR. See \&\*(L"\s-1GNOME\s0 window hints\*(R", below, for \fI\s-1HINTS\s0\fR symbols. .IP "\fBsetLayer\fR \fI\s-1LAYER\s0\fR" 4 .IX Item "setLayer LAYER" Moves the specified window to another \fI\s-1GNOME\s0 window layer\fR. See \&\*(L"\s-1GNOME\s0 window layer\*(R", below, for \fI\s-1LAYER\s0\fR symbols. .IP "\fBsetWorkspace\fR \fI\s-1WORKSPACE\s0\fR" 4 .IX Item "setWorkspace WORKSPACE" Moves the specified window to another workspace. Select the root window to change the current workspace. .IP "\fBlistWorkspaces\fR" 4 .IX Item "listWorkspaces" Lists the names of all workspaces. .IP "\fBsetTrayOption\fR \fI\s-1TRAYOPTION\s0\fR" 4 .IX Item "setTrayOption TRAYOPTION" Set the \fIIceWM tray option\fR hint for the specified window to \&\fI\s-1TRAYOPTION\s0\fR. See \*(L"IceWM tray options\*(R", below, for \fI\s-1TRAYOPTION\s0\fR symbols. .RE .RS 4 .RE .ie n .IP "\fB\s-1EXPRESSION\s0\fR ::= \fI\s-1SYMBOL\s0\fR | \fI\s-1EXPRESSION\s0\fR { ""+"" | ""|"" } \fI\s-1SYMBOL\s0\fR" 4 .el .IP "\fB\s-1EXPRESSION\s0\fR ::= \fI\s-1SYMBOL\s0\fR | \fI\s-1EXPRESSION\s0\fR { \f(CW+\fR | \f(CW|\fR } \fI\s-1SYMBOL\s0\fR" 4 .IX Item "EXPRESSION ::= SYMBOL | EXPRESSION { + | | } SYMBOL" Each \fI\s-1SYMBOL\s0\fR may be from one of the following applicable domains: .RS 4 .IP "\fI\s-1GNOME\s0 window state\fR" 4 .IX Item "GNOME window state" Named symbols of the domain \fI\s-1GNOME\s0 window state\fR (numeric range: 0\-1023): .Sp .Vb 10 \& AllWorkspaces (1) \& Sticky (1) \& Minimized (2) \& Maximized (12) \& MaximizedVert (4) \& MaximizedVertical (4) \& MaximizedHoriz (8) \& MaximizedHorizontal (8) \& Hidden (16) \& All (1023) .Ve .Sp These symbols are used with the \fI\s-1MASK\s0\fR and \fI\s-1STATE\s0\fR arguments to the \&\f(CW\*(C`setState\*(C'\fR and \f(CW\*(C`toggleState\*(C'\fR actions. .IP "\fI\s-1GNOME\s0 window hint\fR" 4 .IX Item "GNOME window hint" Named symbols of the domain \fI\s-1GNOME\s0 window hint\fR (numeric range: 0\-63): .Sp .Vb 6 \& SkipFocus (1) \& SkipWindowMenu (2) \& SkipTaskBar (4) \& FocusOnClick (16) \& DoNotCover (32) \& All (63) .Ve .Sp These symbols are used with the \fI\s-1HINTS\s0\fR argument to the \f(CW\*(C`setHints\*(C'\fR action. .IP "\fI\s-1GNOME\s0 window layer\fR" 4 .IX Item "GNOME window layer" Named symbols of the domain \fI\s-1GNOME\s0 window layer\fR (numeric range: 0\-15): .Sp .Vb 7 \& Desktop (0) \& Below (2) \& Normal (4) \& OnTop (6) \& Dock (8) \& AboveDock (10) \& Menu (12) .Ve .Sp These symbols are used with the \fI\s-1LAYER\s0\fR argument to the \f(CW\*(C`setLayer\*(C'\fR action. .IP "\fIIceWM tray option\fR" 4 .IX Item "IceWM tray option" Named symbols of the domain \fIIceWM tray option\fR (numeric range: 0\-2): .Sp .Vb 3 \& Ignore (0) \& Minimized (1) \& Exclusive (2) .Ve .Sp These symbols are used with the \fI\s-1TRAYOPTION\s0\fR argument to the \&\f(CW\*(C`setTrayOption\*(C'\fR action. .RE .RS 4 .RE .SH "USAGE" .IX Header "USAGE" The purpose of \fBicesh\fR is to provide commands that can be used from a shell script (see \fIsh\fR\|(1)) to affect the state, geometry and hints associated with a window, or to list and parse information about existing windows. .PP It should be noted that \fBicesh\fR works on any window manager that is compliant with the \s-1GNOME\s0 WinWM/WMH specification. The \f(CW\*(C`setTrayOption\*(C'\fR action; however, is IceWM specific. .SH "EXAMPLES" .IX Header "EXAMPLES" The following command will list all the workspaces associated with the root window after a window (any window) is selected: .PP .Vb 1 \& icesh listWorkspaces .Ve .PP Example output: .PP .Vb 8 \& workspace #0: \`main\*(Aq \& workspace #1: \`web\*(Aq \& workspace #2: \`doc\*(Aq \& workspace #3: \`dev\*(Aq \& workspace #4: \`scr\*(Aq \& workspace #5: \`gfx\*(Aq \& workspace #6: \`misc\*(Aq \& workspace #7: \`\*(Aq .Ve .SH "ENVIRONMENT" .IX Header "ENVIRONMENT" The following environment variables are set or examined by \fBicesh\fR: .IP "\fB\s-1DISPLAY\s0\fR" 4 .IX Item "DISPLAY" When the \fB\-display\fR option is not specified, the \f(CW\*(C`DISPLAY\*(C'\fR environment variable is consulted to determine the display. .SH "COMPLIANCE" .IX Header "COMPLIANCE" While \fBicesh\fR is largely compliant with the \s-1GNOME\s0 WinWM/WMH specification, it does not support NetWM/EWMH. .SH "BUGS" .IX Header "BUGS" \&\fBicesh\fR had no known bugs at the time of release. Please report bugs for current versions to the source code repository at . .SH "HISTORY" .IX Header "HISTORY" \&\fBicesh\fR is historical and deprecated. The command originally (and still) only supported the \s-1GNOME\s0 WinWM/WMH specification. Unlike \&\fIwmctrl\fR\|(1) and \fIxdotool\fR\|(1), NetWM/EWMH support was never included. Except for the \f(CW\*(C`setTrayOption\*(C'\fR command, \fIwmctrl\fR\|(1) and \fIxdotool\fR\|(1) are quite capable of performing the necessary functions and more. .SH "AUTHOR" .IX Header "AUTHOR" Brian Bidulock . .PP See \fB\-\-copying\fR for full copyright notice and copying permissions. .SH "LICENSE" .IX Header "LICENSE" \&\fBIceWM\fR is licensed under the \s-1GNU\s0 Library General Public License. See the \fI\s-1COPYING\s0\fR file in the distribution or use the \fB\-\-copying\fR flag to display copying permissions.