| 1 |
.\" Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved. |
| 2 |
.\" |
| 3 |
.\" Permission is hereby granted, free of charge, to any person obtaining a |
| 4 |
.\" copy of this software and associated documentation files (the "Software"), |
| 5 |
.\" to deal in the Software without restriction, including without limitation |
| 6 |
.\" the rights to use, copy, modify, merge, publish, distribute, sublicense, |
| 7 |
.\" and/or sell copies of the Software, and to permit persons to whom the |
| 8 |
.\" Software is furnished to do so, subject to the following conditions: |
| 9 |
.\" |
| 10 |
.\" The above copyright notice and this permission notice (including the next |
| 11 |
.\" paragraph) shall be included in all copies or substantial portions of the |
| 12 |
.\" Software. |
| 13 |
.\" |
| 14 |
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 15 |
.\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 16 |
.\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL |
| 17 |
.\" THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| 18 |
.\" LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING |
| 19 |
.\" FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER |
| 20 |
.\" DEALINGS IN THE SOFTWARE. |
| 21 |
.\" |
| 22 |
.ds q \N'34' |
| 23 |
.TH TRANSSET 1 "transset 1.0.3" "X Version 11" |
| 24 |
.SH NAME |
| 25 |
transset \- Set transparency on a window |
| 26 |
.SH SYNOPSIS |
| 27 |
.B transset |
| 28 |
[\fI-options ...\fP] [\fIopacity\fP] |
| 29 |
.SH DESCRIPTION |
| 30 |
.B transset |
| 31 |
is a simple program for X servers supporting the XFIXES, DAMAGE, |
| 32 |
and COMPOSITE extensions. It lets the user set the transparency on a window. |
| 33 |
.PP |
| 34 |
The \fIopacity\fP value is a number from 0 to 1, with zero being fully |
| 35 |
transparent and 1 being fully opaque. |
| 36 |
If no \fIopacity\fP argument is given, a default value of 0.75 is used for the |
| 37 |
opacity value. If neither \fB--inc\fP nor \fB--dec\fP are given, the |
| 38 |
opacity is treated as an absolute value and set to the given opacity |
| 39 |
value. If \fB--inc\fP or \fB--dec\fP is specified, then the opacity is |
| 40 |
treated as a relative value to increase or decrease the current opacity by. |
| 41 |
.SH OPTIONS |
| 42 |
.PP |
| 43 |
.TP 8 |
| 44 |
.B -display \fIdisplay\fP |
| 45 |
This option specifies the server to use; see \fIX(7)\fP. |
| 46 |
.PP |
| 47 |
.TP 8 |
| 48 |
.BR -h ", " --help |
| 49 |
This option displays a help message and exits. |
| 50 |
.PP |
| 51 |
.TP 8 |
| 52 |
.BR -t ", " --toggle |
| 53 |
This option forces a toggle of opacity. If the current opacity is not set |
| 54 |
to fully opaque (opacity 1.0), it will be reset to fully opaque. |
| 55 |
If the window is already fully opaque, the opacity will be set normally. |
| 56 |
.PP |
| 57 |
.TP 8 |
| 58 |
.BR -c ", " --click |
| 59 |
This option selects the target window by waiting for the user to click the |
| 60 |
mouse - the topmost window under the mouse cursor when the mouse click occurs |
| 61 |
will be used as the target. |
| 62 |
.PP |
| 63 |
.TP 8 |
| 64 |
.BR -p ", " --point |
| 65 |
This option selects the window currently under the cursor to be the target. |
| 66 |
.PP |
| 67 |
.TP 8 |
| 68 |
.BR -a ", " --actual |
| 69 |
This option selects the window that currently has input focus to be the target. |
| 70 |
.PP |
| 71 |
.TP 8 |
| 72 |
.BR -n ", " --name " \fIname\fP" |
| 73 |
This option selects the target window by name, where \fIname\fP is matched as |
| 74 |
a regular expression, unless \fB--no-regex\fP is also specified. |
| 75 |
.PP |
| 76 |
.TP 8 |
| 77 |
.B --no-regex |
| 78 |
This option disables treating the \fIname\fP argument to \fB--name\fP as a |
| 79 |
regular expression. |
| 80 |
.PP |
| 81 |
.TP 8 |
| 82 |
.BR -i ", " --id |
| 83 |
This option selects the target window by window id. |
| 84 |
.PP |
| 85 |
.TP 8 |
| 86 |
.B --inc |
| 87 |
This option increases the window opacity by the given \fIopacity\fP argument. |
| 88 |
.PP |
| 89 |
.TP 8 |
| 90 |
.B --dec |
| 91 |
This option decreases the window opacity by the given \fIopacity\fP argument. |
| 92 |
.PP |
| 93 |
.TP 8 |
| 94 |
.BR -m ", " --min " \fIopacity\fP" |
| 95 |
This option sets the minimum possible opacity value. It defaults to 0 if this |
| 96 |
option is not given. |
| 97 |
.PP |
| 98 |
.TP 8 |
| 99 |
.BR -x ", " --max " \fIopacity\fP" |
| 100 |
This option sets the maximum possible opacity value. It defaults to 1 if this |
| 101 |
option is not given. |
| 102 |
.PP |
| 103 |
.TP 8 |
| 104 |
.BR -v ", " --verbose |
| 105 |
This option prints some additional debug info as the program operates. |
| 106 |
.PP |
| 107 |
.TP 8 |
| 108 |
.BR -V ", " --version |
| 109 |
This option prints the program version number and exits. |
| 110 |
.SH BUGS |
| 111 |
Probably. Please report any you find to |
| 112 |
https://gitlab.freedesktop.org/xorg/app/transset/. |
| 113 |
.SH AUTHORS |
| 114 |
Matthew Hawn |