1urxvt-clickthrough(1)            RXVT-UNICODE            urxvt-clickthrough(1)
2
3
4

NAME

6       clickthrough - make window "transparent" with respect to input events
7

SYNOPSIS

9          # create a transparent non-interactable overlay
10          urxvt -override-redirect -depth 32 -bg "[0]black" -clickthrough on -e top
11

DESCRIPTION

13       This extension can toggle the terminal window between "normal" and
14       "clickthrough" states. In the latter state, input events such as clicks
15       will go "through" the window, as if it weren't there. This can be used
16       to put a (preferably partially transparent) window in front of other
17       windows and let clicks and other events go through the underlying
18       window.
19
20       See <https://shallowsky.com/blog/2017/Apr/06/> for an example.
21
22       This extension is loaded automatically when the "-clickthrough mode"
23       command line argument is given, and operates in one of three modes:
24
25       "disable" (the default)
26           In this mode, everything works normally and the OSC sequence is not
27           active.
28
29       "on"
30           In this mode, events go through the window, and this can be toggled
31           via an OSC sequence.
32
33       "off"
34           In this mode, events act normally, but this can be toggled via an
35           OSC sequence.
36
37   OSC SEQUENCE
38       When enabled, the OSC sequence "777;clickthroughmode" can be used to
39       change the clickthrough mode. Example, switch it on, and then switch it
40       off again:
41
42          printf '\033]777;clickthrough:on\007'
43          printf '\033]777;clickthrough:off\007'
44
45   BUGS
46       For this to work as expected, your window manager needs to support
47       shaped windows fully, but most only have partial support. The only
48       window manager known to handle this correctly is openbox 3.7.
49
50       A workaround is to also use "-override-redirect".
51
52       In addition, input shapes don't seem to be well supported in Xorg,
53       which sometimes does not generate the necessary events for window
54       managers. This is currently being worked around in this extension by
55       re-setting the input shape after every map event.
56
57
58
599.31                              2023-01-21             urxvt-clickthrough(1)
Impressum