path: root/upstream/debian-bookworm/man5/icewm-winoptions.5

.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" 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
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" 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 "ICEWM-WINOPTIONS 5"
.TH ICEWM-WINOPTIONS 5 "2023-02-05" "icewm\ 3.3.1" "Standards, Environments and Macros"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SS "\s-1NAME\s0"
.IX Subsection "NAME"
.Vb 1
\& icewm\-winoptions \- IceWM window options configuration file
.Ve
.SS "\s-1SYNOPSIS\s0"
.IX Subsection "SYNOPSIS"
.Vb 5
\& $ICEWM_PRIVCFG/winoptions
\& $XDG_CONFIG_HOME/icewm/winoptions
\& $HOME/.icewm/winoptions
\& /etc/X11/icewm/winoptions
\& /usr/share/icewm/winoptions
.Ve
.SS "\s-1DESCRIPTION\s0"
.IX Subsection "DESCRIPTION"
Contains settings to control window appearance and behaviour. These are
specific to applications, or to groups of applications.  Options can
control the window border, whether the application appears on the task
bar, the window list, the system tray and the work spaces.
Also its layer, geometry, whether it can be moved, resized and closed.
.PP
Options are established when \fBicewm\fR\|(1) starts.  However, they can be
overridden later using \fBicesh\fR\|(1) or \fBicewmhint\fR\|(1). The command
\&\f(CW\*(C`icesh winoptions\*(C'\fR instructs icewm to reload the winoptions file.
.SS "\s-1FORMAT\s0"
.IX Subsection "FORMAT"
Each line in the file must be in one of the following formats:
.RS 4
.IP "\fI\s-1NAME\s0\fR\fB.\fR\fI\s-1CLASS\s0\fR\fB.\fR\fI\s-1OPTION\s0\fR\fB:\fR \fI\s-1VALUE\s0\fR" 4
.IX Item "NAME.CLASS.OPTION: VALUE"
.PD 0
.IP "\fI\s-1CLASS\s0\fR\fB.\fR\fI\s-1ROLE\s0\fR\fB.\fR\fI\s-1OPTION\s0\fR\fB:\fR \fI\s-1VALUE\s0\fR" 4
.IX Item "CLASS.ROLE.OPTION: VALUE"
.IP "\fI\s-1NAME\s0\fR\fB.\fR\fI\s-1ROLE\s0\fR\fB.\fR\fI\s-1OPTION\s0\fR\fB:\fR \fI\s-1VALUE\s0\fR" 4
.IX Item "NAME.ROLE.OPTION: VALUE"
.IP "\fI\s-1CLASS\s0\fR\fB.\fR\fI\s-1OPTION\s0\fR\fB:\fR \fI\s-1VALUE\s0\fR" 4
.IX Item "CLASS.OPTION: VALUE"
.IP "\fI\s-1NAME\s0\fR\fB.\fR\fI\s-1OPTION\s0\fR\fB:\fR \fI\s-1VALUE\s0\fR" 4
.IX Item "NAME.OPTION: VALUE"
.IP "\fI\s-1ROLE\s0\fR\fB.\fR\fI\s-1OPTION\s0\fR\fB:\fR \fI\s-1VALUE\s0\fR" 4
.IX Item "ROLE.OPTION: VALUE"
.IP "\fB.\fR\fI\s-1OPTION\s0\fR\fB:\fR \fI\s-1VALUE\s0\fR" 4
.IX Item ".OPTION: VALUE"
.RE
.RS 4
.RE
.PD
.PP
Where the fields are defined as follows:
.IP "\fI\s-1CLASS\s0\fR" 4
.IX Item "CLASS"
The resource class portion of the \s-1ICCCM\s0 \fB\s-1WM_CLASS\s0\fR property for the
window.
.IP "\fI\s-1NAME\s0\fR" 4
.IX Item "NAME"
The resource instance portion of the \s-1ICCCM\s0 \fB\s-1WM_CLASS\s0\fR property for the
window.
.IP "\fI\s-1ROLE\s0\fR" 4
.IX Item "ROLE"
The \s-1ICCCM\s0 \fB\s-1WM_WINDOW_ROLE\s0\fR property for the window.
.IP "\fI\s-1OPTION\s0\fR: \fI\s-1VALUE\s0\fR" 4
.IX Item "OPTION: VALUE"
One of the options and values described below under \*(L"\s-1OPTIONS\*(R"\s0.
.PP
Note that it is possible that the \fB\s-1WM_WINDOW_ROLE\s0\fR may contain a period
(\f(CW\*(C`.\*(C'\fR).  When it does, the period should be escaped by a single
backslash when specifying the \fI\s-1ROLE\s0\fR in the file.
.SS "\s-1OPTIONS\s0"
.IX Subsection "OPTIONS"
The options and values described in the format, above, consist of an
option name, \fI\s-1OPTION\s0\fR followed by a semicolon (\f(CW\*(C`:\*(C'\fR) a space (\f(CW\*(C` \*(C'\fR) and
an allowable value for the option, \fI\s-1VALUE\s0\fR.  The available options are
as follows:
.SS "\s-1GENERAL OPTIONS\s0"
.IX Subsection "GENERAL OPTIONS"
The following option control general characteristics of windows:
.IP "\fBicon\fR: \fI\s-1NAME\s0\fR (default: none)" 4
.IX Item "icon: NAME (default: none)"
Specifies the icon name for the window.  \fI\s-1NAME\s0\fR is the name of the
icon, like \fIutilities-terminal\fR. It can also be a file, like
\&\fIxterm.png\fR, a full path, or a prefix of a path without sizes or suffix.
.IP "\fBworkspace\fR: \fI\s-1WORKSPACE\s0\fR (default: current)" 4
.IX Item "workspace: WORKSPACE (default: current)"
Specifies the default workspace for the window.  \fI\s-1WORKSPACE\s0\fR is the
workspace number counting from zero (0).
.IP "\fBlayer\fR: {\fBDesktop\fR|\fBBelow\fR|\fBNormal\fR|\fBOnTop\fR|\fBDock\fR|\fBAboveDock\fR|\fBMenu\fR|\fI\s-1NUMBER\s0\fR} (default: 4)" 4
.IX Item "layer: {Desktop|Below|Normal|OnTop|Dock|AboveDock|Menu|NUMBER} (default: 4)"
Specifies the default layer for the window.  Layer can be one of the
following strings or a number from zero (0) to fifteen (15):
.Sp
.Vb 7
\&  Desktop     (0)  Desktop window.
\&  Below       (2)  Below the default layer.
\&  Normal      (4)  Default layer for windows.
\&  OnTop       (6)  Above the default layer.
\&  Dock        (8)  Docked windows at edge of screen.
\&  AboveDock  (10)  Windows above the dock.
\&  Menu       (12)  Windows above the dock.
.Ve
.IP "\fBgeometry\fR \fIgeometry\fR (default: \s-1WM_SIZE_HINTS\s0)" 4
.IX Item "geometry geometry (default: WM_SIZE_HINTS)"
The default geometry for the window.  This geometry should be specified
in a format that can be parsed by \fBXParseGeometry\fR\|(3):
.Sp
.Vb 1
\& [=][<width>{xX}<height>][{+\-}<xoffset>{+\-}<yoffset>]
.Ve
.IP "\fBtray\fR: {\fBIgnore\fR|\fBMinimized\fR|\fBExclusive\fR|\fI\s-1NUMBER\s0\fR} (default: 0)" 4
.IX Item "tray: {Ignore|Minimized|Exclusive|NUMBER} (default: 0)"
The default tray option for the window.  This affects both the tray and
the task pane.  Tray can be one of the following strings or a number
from zero (0) to two (2):
.Sp
.Vb 3
\&  Ignore     (0)  No icon added to tray.
\&  Minimized  (1)  Add to tray, no task when minimized.
\&  Exclusive  (2)  Add to tray, no task button.
.Ve
.IP "\fBorder\fR: \fI\s-1NUMBER\s0\fR (default: 0)" 4
.IX Item "order: NUMBER (default: 0)"
The sorting order of task buttons and tray icons. The default value is
zero. Increasing positive values go farther right, while decreasing
negative values go farther left. The order option applies to the task
pane, the tray pane and the system tray.
.IP "\fBopacity\fR: \fI\s-1NUMBER\s0\fR (default: 0)" 4
.IX Item "opacity: NUMBER (default: 0)"
Set the _NET_WM_WINDOW_OPACITY property if \fI\s-1NUMBER\s0\fR is a value between
1 and 100. \fI\s-1NUMBER\s0\fR is interpreted as percentage of maximum opaqueness.
.IP "\fBkeyboard\fR: \fIlayout\fR (default: none)" 4
.IX Item "keyboard: layout (default: none)"
Specifies the keyboard layout to use for this window. 
The \fIlayout\fR is the name of a keyboard layout.
It can be a space-separated list of arguments to the
\&\fBsetxkbmap\fR program. Please note that \fBsetxkbmap\fR
must be installed for this to work. Also define
a default keyboard layout in \fIpreferences\fR.
.IP "\fBframe\fR: \fIlabel\fR (default: none)" 4
.IX Item "frame: label (default: none)"
All windows with the same frame label become tabs in a single frame.
.SS "\s-1FUNCTION OPTIONS\s0"
.IX Subsection "FUNCTION OPTIONS"
Function options enable/disable (1/0) the ability to take an action on
the window.  The normal default for all options is enabled (1) unless
overridden by the application.  The following options are defined:
.PP
.Vb 7
\&  fClose:    {0|1}  can be closed.        (default: 1)
\&  fHide:     {0|1}  can be hidden.        (default: 1)
\&  fMaximize: {0|1}  can be maximized.     (default: 1)
\&  fMinimize: {0|1}  can be minimized.     (default: 1)
\&  fMove:     {0|1}  can be moved.         (default: 1)
\&  fResize:   {0|1}  can be resized.       (default: 1)
\&  fRollup:   {0|1}  can be shaded.        (default: 1)
.Ve
.SS "\s-1DECOR OPTIONS\s0"
.IX Subsection "DECOR OPTIONS"
Decor options enable/disable (1/0) decorations on the window.  The
normal default for all options is enabled (1) unless overridden by the
application.  The following options are defined:
.PP
.Vb 10
\&  dBorder:   {0|1}  has border.           (default: 1)
\&  dClose:    {0|1}  has close button.     (default: 1)
\&  dDepth:    {0|1}  has depth button.     (default: 1)
\&  dHide:     {0|1}  has hide button.      (default: 1)
\&  dMaximize: {0|1}  has maximize button.  (default: 1)
\&  dMinimize: {0|1}  has minimize button.  (default: 1)
\&  dResize:   {0|1}  has resize grips.     (default: 1)
\&  dRollup:   {0|1}  has shade button.     (default: 1)
\&  dSysMenu:  {0|1}  has window menu.      (default: 1)
\&  dTitleBar: {0|1}  has title bar.        (default: 1)
.Ve
.SS "\s-1FEATURE OPTIONS\s0"
.IX Subsection "FEATURE OPTIONS"
Feature options enable/disable (1/0) additional features of the window.
The normal default for all options is disabled (0) unless overridden by
the application.  The following options are defined:
.PP
.Vb 10
\&  allWorkspaces:            {1|0}  on all workspaces.
\&  appTakesFocus:            {1|0}  let application take focus.
\&  doNotCover:               {1|0}  limits workspace if sticky.
\&  doNotFocus:               {1|0}  do not focus.
\&  forcedClose:              {1|0}  no close dialog.
\&  fullKeys:                 {1|0}  provided more keys.
\&  ignoreNoFocusHint:        {1|0}  focus even no\-input.
\&  ignorePagerPreview:       {1|0}  do not show in pager preview.
\&  ignorePositionHint:       {1|0}  place automatically.
\&  ignoreQuickSwitch:        {1|0}  not on quick switch.
\&  ignoreTaskBar:            {1|0}  not on task bar.
\&  ignoreUrgentHint:         {1|0}  ignore urgent hints.
\&  ignoreWinList:            {1|0}  not on window list.
\&  ignoreActivationMessages: {1|0}  only user can focus window.
\&  ignoreOverrideRedirect:   {1|0}  ignore override redirect.
\&  noFocusOnAppRaise:        {1|0}  no focus on raise.
\&  noFocusOnMap:             {1|0}  do not focus when mapped.
\&  noIgnoreTaskBar:          {1|0}  on task bar.
\&  startClose:               {1|0}  close the window immediately.
\&  startFullscreen:          {1|0}  start full screen.
\&  startMaximized:           {1|0}  start maximized.
\&  startMaximizedHorz:       {1|0}  start maximized horizontal.
\&  startMaximizedVert:       {1|0}  start maximized vertical.
\&  startMinimized:           {1|0}  start minimized.
.Ve
.SS "\s-1EXAMPLES\s0"
.IX Subsection "EXAMPLES"
This example uses the \s-1WM_WINDOW_ROLE\s0 property value \f(CW\*(C`pop\-up\*(C'\fR to deny
input focus to \fIChrome\fR pop-ups and asks to close them immediately.
.PP
.Vb 9
\&  google\-chrome.pop\-up.doNotFocus: 1
\&  google\-chrome.pop\-up.forcedClose: 1
\&  google\-chrome.pop\-up.ignorePagerPreview: 1
\&  google\-chrome.pop\-up.ignoreUrgentHint: 1
\&  google\-chrome.pop\-up.layer: Below
\&  google\-chrome.pop\-up.noFocusOnAppRaise: 1
\&  google\-chrome.pop\-up.noFocusOnMap: 1
\&  google\-chrome.pop\-up.startClose: 1
\&  google\-chrome.pop\-up.startMinimized: 1
.Ve
.PP
IceWM places dockapps in a container automatically, but for those
which fail to comply with the protocol it can also be emulated.
An emulated dockapp should appear on all workspaces, have
no decorations, and always be visible in a fixed location.
.PP
.Vb 8
\&  wmtime.wmtime.allWorkspaces: 1
\&  wmtime.wmtime.ignoreTaskBar: 1
\&  wmtime.wmtime.ignoreQuickSwitch: 1
\&  wmtime.wmtime.ignoreWinList: 1
\&  wmtime.wmtime.layer: Below
\&  wmtime.wmtime.dTitleBar: 0
\&  wmtime.wmtime.dBorder: 1
\&  wmtime.wmtime.geometry: 64x64\-74\-100
.Ve
.PP
Following is the example window options file that ships with \fBicewm\fR\|(1)
and typically installs to \fI/usr/share/icewm/winoptions\fR.
.PP
.Vb 5
\&  # This is an example for IceWM\*(Aqs window options file.
\&  #
\&  # Place your variants in /etc/X11/icewm or in $HOME/.icewm
\&  # since modifications to this file will be discarded when you
\&  # (re)install icewm.
\&
\&  xterm.icon: xterm
\&  rxvt.icon: xterm
\&  nxterm.icon: xterm
\&  fte.icon: fte
\&  emacs.Emacs.icon: emacs
\&  AWTapp.icon: java
\&  xeyes.ignoreWinList: 0
\&  xeyes.ignoreTaskBar: 1
\&  xeyes.allWorkspaces: 1
\&  xeyes.dTitleBar: 0
\&  xeyes.dBorder: 0
\&  xeyes.dSysMenu: 0
\&  xeyes.dResize: 0
\&  xeyes.dClose: 0
\&  xeyes.dMinimize: 0
\&  xeyes.dMaximize: 0
\&  xeyes.ignoreNoFocusHint: 1
\&
\&  XClock.ignoreNoFocusHint: 1
\&  Vim.icon: vim
\&
\&  applix.ignoreNoFocusHint: 1
\&  XDdts.noFocusOnAppRaise: 1
\&  Wingz.noFocusOnAppRaise: 1
\&  WingzPro.noFocusOnAppRaise: 1
\&
\&  gkrellm.Gkrellm.allWorkspaces: 1
\&  gkrellm.Gkrellm.ignoreTaskBar: 1
\&  gkrellm.Gkrellm.layer: Below
\&  #gkrellm.Gkrellm.doNotCover: 1
\&
\&  MainWindow.licq.allWorkspaces: 1
\&  MainWindow.licq.ignoreQuickSwitch: 1
\&  MainWindow.licq.ignoreWinList: 1
\&  MainWindow.licq.layer: Below
\&  #MainWindow.licq.doNotCover: 1
.Ve
.SS "\s-1FILES\s0"
.IX Subsection "FILES"
Locations for the \fIwinoptions\fR file are as follows:
.PP
.Vb 5
\& $ICEWM_PRIVCFG/winoptions
\& $XDG_CONFIG_HOME/icewm/winoptions
\& $HOME/.icewm/winoptions
\& /etc/X11/icewm/winoptions
\& /usr/share/icewm/winoptions
.Ve
.PP
The locations are searched in the order listed; the first file found is
read and the remainder ignored.
.SS "\s-1SEE ALSO\s0"
.IX Subsection "SEE ALSO"
\&\fBicewm\fR\|(1),
\&\fBicesh\fR\|(1),
\&\fBicewmhint\fR\|(1),
\&\fBsetxkbmap\fR\|(1),
\&\fBXParseGeometry\fR\|(3).
.SS "\s-1AUTHOR\s0"
.IX Subsection "AUTHOR"
Brian Bidulock <mailto:bidulock@openss7.org>.
.SS "\s-1LICENSE\s0"
.IX Subsection "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.