summaryrefslogtreecommitdiffstats
path: root/upstream/mageia-cauldron/man1/icewmhint.1
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 19:43:11 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 19:43:11 +0000
commitfc22b3d6507c6745911b9dfcc68f1e665ae13dbc (patch)
treece1e3bce06471410239a6f41282e328770aa404a /upstream/mageia-cauldron/man1/icewmhint.1
parentInitial commit. (diff)
downloadmanpages-l10n-fc22b3d6507c6745911b9dfcc68f1e665ae13dbc.tar.xz
manpages-l10n-fc22b3d6507c6745911b9dfcc68f1e665ae13dbc.zip
Adding upstream version 4.22.0.upstream/4.22.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'upstream/mageia-cauldron/man1/icewmhint.1')
-rw-r--r--upstream/mageia-cauldron/man1/icewmhint.1281
1 files changed, 281 insertions, 0 deletions
diff --git a/upstream/mageia-cauldron/man1/icewmhint.1 b/upstream/mageia-cauldron/man1/icewmhint.1
new file mode 100644
index 00000000..0ca36bd3
--- /dev/null
+++ b/upstream/mageia-cauldron/man1/icewmhint.1
@@ -0,0 +1,281 @@
+.\" -*- mode: troff; coding: utf-8 -*-
+.\" Automatically generated by Pod::Man 5.01 (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
+..
+.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
+.ie n \{\
+. ds C` ""
+. ds C' ""
+'br\}
+.el\{\
+. 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
+.\" ========================================================================
+.\"
+.IX Title "ICEWMHINT 1"
+.TH ICEWMHINT 1 2023-12-28 "icewm 3.4.5" "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
+.SS NAME
+.IX Subsection "NAME"
+icewmhint \- set IceWM hints by window class and instance
+.SS SYNOPSIS
+.IX Subsection "SYNOPSIS"
+\&\fBicewmhint\fR \fICLASS\fR\fB.\fR\fIINSTANCE\fR \fIOPTION\fR \fIVALUE\fR ...
+.SS DESCRIPTION
+.IX Subsection "DESCRIPTION"
+\&\fBicewmhint\fR is a utility for passing IceWM hints to \fBicewm\fR\|(1).
+\&\fBicewm\fR uses these hints for the first \fIX11 client\fR which is
+subsequently started. They take precedence over hints from
+the \fBicewm\-winoptions\fR\|(1) file.
+.PP
+A hint is a triplet consisting of a \fIclass.instance\fR, an
+\&\fIIceWM winoption\fR and its value. Multiple hints can be given per
+invocation of \fBicewmhint\fR.
+.PP
+The hints are communicated over the \f(CW\*(C`_ICEWM_WINOPTHINT\*(C'\fR property on
+the root window. \fBicewmhint\fR appends hints to this property, while
+\&\fBicewm\fR removes the property after reading it.
+.SS OPTIONS
+.IX Subsection "OPTIONS"
+\&\fBicewmhint\fR recognizes the following options:
+.SS "COMMAND OPTIONS"
+.IX Subsection "COMMAND OPTIONS"
+Only one command option can be specified per invocation. If no command
+option is specified, argument parsing and processing is performed.
+.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.
+.SS "GENERAL OPTIONS"
+.IX Subsection "GENERAL OPTIONS"
+.IP "\fB\-d\fR, \fB\-\-display\fR=\fIDISPLAY\fR" 4
+.IX Item "-d, --display=DISPLAY"
+Specifies the X11 DISPLAY. If unspecified, defaults to \fR\f(CB$DISPLAY\fR\fB\fR.
+.SS ARGUMENTS
+.IX Subsection "ARGUMENTS"
+The following three arguments are required for each hint.
+.IP \fICLASS\fR\fB.\fR\fIINSTANCE\fR 4
+.IX Item "CLASS.INSTANCE"
+Specifies the ICCCM 2.0 \fBWM_CLASS\fR property in terms of resource class
+and resource name separated by a period (\f(CW\*(C`.\*(C'\fR). For example:
+\&\f(CW\*(C`XTerm.xterm\*(C'\fR. Just the resource class or resource name without a dot
+is also acceptable, like \f(CW\*(C`XTerm\*(C'\fR or \f(CW\*(C`xterm\*(C'\fR.
+.IP \fIOPTION\fR 4
+.IX Item "OPTION"
+Specifies the \fIOPTION\fR to affect.
+.IP \fIVALUE\fR 4
+.IX Item "VALUE"
+Gives the \fIVALUE\fR for the option.
+.PP
+Multiple hints can be given.
+.SS "GENERAL OPTION ARGUMENTS"
+.IX Subsection "GENERAL OPTION ARGUMENTS"
+.IP "\fBicon\fR \fINAME\fR" 4
+.IX Item "icon NAME"
+Specifies the icon name for windows of \fICLASS\fR\fB.\fR\fIINSTANCE\fR.
+\&\fINAME\fR should be the name of the icon. \fBicewm\fR\|(1) will use its
+usual method to locate the icon. The default is the name provided
+by window manager hints.
+.IP "\fBworkspace\fR \fIWORKSPACE\fR" 4
+.IX Item "workspace WORKSPACE"
+Specifies the workspace on which a window of \fICLASS\fR\fB.\fR\fIINSTANCE\fR
+will be initially placed. The default is the current workspace.
+\&\fIWORKSPACE\fR should be a workspace number counting from 0.
+.IP "\fBgeometry\fR \fIGEOMETRY\fR" 4
+.IX Item "geometry GEOMETRY"
+Specifies the initial geometry for windows of the given
+\&\fICLASS\fR\fB.\fR\fIINSTANCE\fR. \fIGEOMETRY\fR must be a geometry that can be
+parsed by \fBXParseGeometry\fR\|(3). The default is the geometry provided by
+window manager hints.
+.IP "\fBorder\fR \fINUMBER\fR" 4
+.IX Item "order NUMBER"
+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 \fINUMBER\fR" 4
+.IX Item "opacity NUMBER"
+Set the _NET_WM_WINDOW_OPACITY property if \fINUMBER\fR is a value between
+1 and 100. \fINUMBER\fR is interpreted as percentage of maximum opaqueness.
+.IP "\fBlayer\fR {\fILAYER\fR|\fINUMBER\fR}" 4
+.IX Item "layer {LAYER|NUMBER}"
+This command option specifies the layer to be associated with a
+\&\fICLASS\fR\fB.\fR\fIINSTANCE\fR. The default is the \f(CW\*(C`Normal\*(C'\fR layer. \fIVALUE\fR
+is either a layer number or a symbolic layer name. Symbolic
+layer names are:
+.Sp
+.Vb 9
+\& 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) The layer for menu\*(Aqs.
+\& Fullscreen (14) When fullscreen and focused.
+\& AboveAll (15) Always above anything.
+.Ve
+.IP "\fBtray\fR {\fBIgnore\fR|\fBMinimized\fR|\fBExclusive\fR|\fINUMBER\fR}" 4
+.IX Item "tray {Ignore|Minimized|Exclusive|NUMBER}"
+Specifies the tray handling to be applied to windows with
+\&\fICLASS\fR\fB.\fR\fIINSTANCE\fR. This option is specific to \fBicewm\fR\|(1) and
+sets the \f(CW\*(C`_ICEWM_TRAY\*(C'\fR property associated with the window.
+The default is \f(CW\*(C`Ignore\*(C'\fR. \fIVALUE\fR can be an option number
+or a symbolic name as follows:
+.Sp
+.Vb 3
+\& Ignore (0) only in task list.
+\& Minimized (1) icon in tray, task list unminimized.
+\& Exclusive (2) only in tray, not in task list.
+.Ve
+.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 "FUNCTION OPTION ARGUMENTS"
+.IX Subsection "FUNCTION OPTION ARGUMENTS"
+Specifies which functions are disabled or enabled (0/1) for windows with
+\&\fICLASS\fR\fB.\fR\fIINSTANCE\fR. All functions have a default value of enabled
+(1) unless overridden by the application. The Motif-like functions are
+as follows:
+.PP
+.Vb 7
+\& fClose can be closed: (default: 1).
+\& fHide can be hidden: (default: 1).
+\& fMaximize can be maximized: (default: 1).
+\& fMinimize can be minimized: (default: 1).
+\& fMove can be moved: (default: 1).
+\& fResize can be resized: (default: 1).
+\& fRollup can be shaded: (default: 1).
+.Ve
+.SS "DECOR OPTION ARGUMENTS"
+.IX Subsection "DECOR OPTION ARGUMENTS"
+Specifies which decorations are disabled or enabled (0/1) for windows
+with \fICLASS\fR\fB.\fR\fIINSTANCE\fR. All decor options have a default value
+of enabled (1) unless overridden by the application. The Motif-like
+decorations are as follows:
+.PP
+.Vb 10
+\& dBorder has border: (default: 1).
+\& dClose has close button: (default: 1).
+\& dDepth has depth button: (default: 1).
+\& dHide has hide button: (default: 1).
+\& dMaximize has maximize button: (default: 1).
+\& dMinimize has minimize button: (default: 1).
+\& dResize has resize grips: (default: 1).
+\& dRollup has shade button: (default: 1).
+\& dSysMenu has window menu: (default: 1).
+\& dTitleBar has title bar: (default: 1).
+.Ve
+.SS "FEATURE OPTION ARGUMENTS"
+.IX Subsection "FEATURE OPTION ARGUMENTS"
+Specifies which advanced features to be enabled/disabled (1/0) for
+windows with \fICLASS\fR\fB.\fR\fIINSTANCE\fR. All advanced features have a
+default value of disabled (0) unless overridden by the application. The
+advanced features are as follows:
+.PP
+.Vb 10
+\& allWorkspaces on all workspaces.
+\& appTakesFocus let application take focus.
+\& doNotCover limits workspace if sticky.
+\& doNotFocus do not focus.
+\& doNotManage do not manage.
+\& forcedClose no close dialog.
+\& fullKeys provided more keys.
+\& ignoreNoFocusHint focus even no\-input.
+\& ignorePagerPreview do not show in pager preview.
+\& ignorePositionHint place automatically.
+\& ignoreQuickSwitch not on quick switch.
+\& ignoreTaskBar not on task bar.
+\& ignoreUrgentHint ignore urgent hints.
+\& ignoreWinList not on window list.
+\& ignoreActivationMessages only user can focus window.
+\& ignoreOverrideRedirect ignore the override redirect flag.
+\& noFocusOnAppRaise no focus on raise.
+\& noFocusOnMap do not focus when mapped.
+\& noIgnoreTaskBar on task bar.
+\& startClose close the window immediately.
+\& startFullscreen start full screen.
+\& startMaximized start maximized.
+\& startMaximizedHorz start maximized horizontal.
+\& startMaximizedVert start maximized vertical.
+\& startMinimized start minimized.
+.Ve
+.SS EXAMPLE
+.IX Subsection "EXAMPLE"
+.Vb 2
+\& # Here is how to preload an invisible background process of chromium
+\& # on the fourth workspace which is only visible on the Window List.
+\&
+\& icewmhint Chromium\-browser startMinimized 1 \e
+\& Chromium\-browser workspace 3 \e
+\& Chromium\-browser ignorePagerPreview 1 \e
+\& Chromium\-browser ignorePositionHint 1 \e
+\& Chromium\-browser ignoreTaskBar 1 \e
+\& Chromium\-browser ignoreQuickSwitch 1 \e
+\& Chromium\-browser ignoreUrgentHint 1 \e
+\& Chromium\-browser noFocusOnAppRaise 1
+\& chromium
+.Ve
+.SS BUGS
+.IX Subsection "BUGS"
+Please report bugs at <https://github.com/bbidulock/icewm/issues>.
+.SS AUTHOR
+.IX Subsection "AUTHOR"
+Brian Bidulock <mailto:bidulock@openss7.org>.
+.PP
+See \fB\-\-copying\fR for full copyright notice and copying permissions.
+.SS LICENSE
+.IX Subsection "LICENSE"
+\&\fBIceWM\fR is licensed under the GNU Library General Public License.
+See the \fICOPYING\fR file in the distribution or use the \fB\-\-copying\fR flag
+to display copying permissions.