aboutsummaryrefslogtreecommitdiff
path: root/man/picom-trans.1.asciidoc
diff options
context:
space:
mode:
Diffstat (limited to 'man/picom-trans.1.asciidoc')
-rw-r--r--man/picom-trans.1.asciidoc114
1 files changed, 114 insertions, 0 deletions
diff --git a/man/picom-trans.1.asciidoc b/man/picom-trans.1.asciidoc
new file mode 100644
index 0000000..22b1dd2
--- /dev/null
+++ b/man/picom-trans.1.asciidoc
@@ -0,0 +1,114 @@
+picom-trans(1)
+================
+:doctype: manpage
+:man source: picom
+:man version: {picom-version}
+:man manual: User Commands
+
+NAME
+----
+picom-trans - an opacity setter tool
+
+SYNOPSIS
+--------
+
+*picom-trans* [-w 'WINDOW_ID'] [-n 'WINDOW_NAME'] [-c] [-s] 'OPACITY'
+
+DESCRIPTION
+-----------
+
+*picom-trans* is a bash script that sets '_NET_WM_WINDOW_OPACITY' attribute of a window using standard X11 command-line utilities, including *xprop*(1) and *xwininfo*(1). It is similar to *transset*(1) or *transset-df*(1).
+
+OPTIONS
+-------
+*-w*, *--window*='WINDOW_ID'::
+Specify the window id of the target window.
+
+*-n*, *--name*='WINDOW_NAME'::
+Specify and try to match a window name.
+
+*-c*, *--current*::
+Specify the currently active window as target. Only works if EWMH '_NET_ACTIVE_WINDOW' property exists on root window.
+
+*-s*, *--select*::
+Select target window with mouse cursor. This is the default if no window has been specified.
+
+*-o*, *--opacity*='OPACITY'::
+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's current opacity instead.
+
+*-g*, *--get*::
+Print the target window's opacity instead of setting it.
+
+*-d*, *--delete*::
+Delete opacity of the target window instead of setting it.
+
+*-t*, *--toggle*::
+Toggle the target window's opacity: Set opacity if not already set, and delete if already set.
+
+*-r*, *--reset*::
+Reset opacity for all windows instead of setting it.
+
+EXAMPLES
+--------
+
+* Set the opacity of the window with specific window ID to 75%:
++
+------------
+picom-trans -w "$WINDOWID" 75
+------------
+
+* Set the opacity of the window with the name "urxvt" to 75%:
++
+------------
+picom-trans -n "urxvt" 75
+------------
+
+* Set current window to opacity of 75%:
++
+------------
+picom-trans -c 75
+------------
+
+* Select target window and set opacity to 75%:
++
+------------
+picom-trans -s 75
+------------
+
+* Increment opacity of current active window by 5%:
++
+------------
+picom-trans -c +5
+------------
+
+* Decrement opacity of current active window by 5%:
++
+------------
+picom-trans -c -- -5
+------------
+
+* Delete current window's opacity:
++
+------------
+picom-trans -c --delete
+------------
+
+* Toggle current window's opacity between 90 and unset
++
+------------
+picom-trans -c --toggle 90
+------------
+
+* Reset all windows:
++
+------------
+picom-trans --reset
+------------
+
+BUGS
+----
+Please submit bug reports to <https://github.com/yshui/picom>.
+
+SEE ALSO
+--------
+link:picom.1.html[*picom*(1)], *xprop*(1), *xwininfo*(1)