blob: f3369458b6b27d4590d2cb181b338c7288bb2c31 (
plain)
1 '\" t
2 .\" Title: picom-trans
3 .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
5 .\" Date: 11/11/2020
6 .\" Manual: User Commands
7 .\" Source: picom v8.2
8 .\" Language: English
9 .\"
10 .TH "PICOM\-TRANS" "1" "11/11/2020" "picom v8\&.2" "User Commands"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30
31
32 .SH "NAME"
33 picom-trans \- an opacity setter tool
34 .SH "SYNOPSIS"
35 .sp
36 \fBpicom\-trans\fR [\-w \fIWINDOW_ID\fR] [\-n \fIWINDOW_NAME\fR] [\-c] [\-s] \fIOPACITY\fR
37
38 .SH "DESCRIPTION"
39
40 .sp
41 \fBpicom\-trans\fR is a bash script that sets \fI_NET_WM_WINDOW_OPACITY\fR attribute of a window using standard X11 command\-line utilities, including \fBxprop\fR(1) and \fBxwininfo\fR(1)\&. It is similar to \fBtransset\fR(1) or \fBtransset\-df\fR(1)\&.
42
43 .SH "OPTIONS"
44
45
46
47 .PP
48 \fB\-w\fR \fIWINDOW_ID\fR
49 .RS 4
50
51
52
53 Specify the window id of the target window\&.
54
55 .RE
56 .PP
57 \fB\-n\fR \fIWINDOW_NAME\fR
58 .RS 4
59
60
61
62 Specify and try to match a window name\&.
63
64 .RE
65 .PP
66 \fB\-c\fR
67 .RS 4
68
69
70
71 Specify the currently active window as target\&. Only works if EWMH
72 \fI_NET_ACTIVE_WINDOW\fR
73 property exists on root window\&.
74
75 .RE
76 .PP
77 \fB\-s\fR
78 .RS 4
79
80
81
82 Select target window with mouse cursor\&. This is the default if no window has been specified\&.
83
84 .RE
85 .PP
86 \fB\-o\fR \fIOPACITY\fR
87 .RS 4
88
89
90
91 Specify the new opacity value for the window\&. This value can be anywhere from 1\-100\&. If it is prefixed with a plus or minus (+/\-), this will increment or decrement from the target window\(cqs current opacity instead\&.
92
93 .RE
94
95 .SH "EXAMPLES"
96
97
98 .sp
99 .RS 4
100 .ie n \{\
101 \h'-04'\(bu\h'+03'\c
102 .\}
103 .el \{\
104 .sp -1
105 .IP \(bu 2.3
106 .\}
107
108 Set the opacity of the window with specific window ID to 75%:
109
110 .sp
111 .if n \{\
112 .RS 4
113 .\}
114 .nf
115 picom\-trans \-w "$WINDOWID" 75
116 .fi
117 .if n \{\
118 .RE
119 .\}
120 .sp
121 .RE
122 .sp
123 .RS 4
124 .ie n \{\
125 \h'-04'\(bu\h'+03'\c
126 .\}
127 .el \{\
128 .sp -1
129 .IP \(bu 2.3
130 .\}
131
132 Set the opacity of the window with the name "urxvt" to 75%:
133
134 .sp
135 .if n \{\
136 .RS 4
137 .\}
138 .nf
139 picom\-trans \-n "urxvt" 75
140 .fi
141 .if n \{\
142 .RE
143 .\}
144 .sp
145 .RE
146 .sp
147 .RS 4
148 .ie n \{\
149 \h'-04'\(bu\h'+03'\c
150 .\}
151 .el \{\
152 .sp -1
153 .IP \(bu 2.3
154 .\}
155
156 Set current window to opacity of 75%:
157
158 .sp
159 .if n \{\
160 .RS 4
161 .\}
162 .nf
163 picom\-trans \-c 75
164 .fi
165 .if n \{\
166 .RE
167 .\}
168 .sp
169 .RE
170 .sp
171 .RS 4
172 .ie n \{\
173 \h'-04'\(bu\h'+03'\c
174 .\}
175 .el \{\
176 .sp -1
177 .IP \(bu 2.3
178 .\}
179
180 Select target window and set opacity to 75%:
181
182 .sp
183 .if n \{\
184 .RS 4
185 .\}
186 .nf
187 picom\-trans \-s 75
188 .fi
189 .if n \{\
190 .RE
191 .\}
192 .sp
193 .RE
194 .sp
195 .RS 4
196 .ie n \{\
197 \h'-04'\(bu\h'+03'\c
198 .\}
199 .el \{\
200 .sp -1
201 .IP \(bu 2.3
202 .\}
203
204 Increment opacity of current active window by 5%:
205
206 .sp
207 .if n \{\
208 .RS 4
209 .\}
210 .nf
211 picom\-trans \-c +5
212 .fi
213 .if n \{\
214 .RE
215 .\}
216 .sp
217 .RE
218 .sp
219 .RS 4
220 .ie n \{\
221 \h'-04'\(bu\h'+03'\c
222 .\}
223 .el \{\
224 .sp -1
225 .IP \(bu 2.3
226 .\}
227
228 Decrement opacity of current active window by 5%:
229
230 .sp
231 .if n \{\
232 .RS 4
233 .\}
234 .nf
235 picom\-trans \-c \-\- \-5
236 .fi
237 .if n \{\
238 .RE
239 .\}
240 .sp
241 .RE
242 .SH "BUGS"
243
244 .sp
245 Please submit bug reports to \m[blue]\fBhttps://github\&.com/yshui/picom\fR\m[]\&.
246
247 .SH "SEE ALSO"
248
249 .sp
250 \m[blue]\fB\fBpicom\fR(1)\fR\m[]\&\s-2\u[1]\d\s+2, \fBxprop\fR(1), \fBxwininfo\fR(1)
|
