.\" -*- 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 "urxvt-clickthrough 1"
.TH urxvt-clickthrough 1 2024-03-07 9.31 RXVT-UNICODE
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
clickthrough \- make window "transparent" with respect to input events
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\&   # create a transparent non\-interactable overlay
\&   urxvt \-override\-redirect \-depth 32 \-bg "[0]black" \-clickthrough on \-e top
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This extension can toggle the terminal window between "normal" and
"clickthrough" states. In the latter state, input events such as clicks
will go "through" the window, as if it weren't there. This can be used to
put a (preferably partially transparent) window in front of other windows
and let clicks and other events go through the underlying window.
.PP
See <https://shallowsky.com/blog/2017/Apr/06/> for an example.
.PP
This extension is loaded automatically when the \f(CW\*(C`\-clickthrough mode\*(C'\fR
command line argument is given, and operates in one of three modes:
.ie n .IP """disable"" (the default)" 4
.el .IP "\f(CWdisable\fR (the default)" 4
.IX Item "disable (the default)"
In this mode, everything works normally and the OSC sequence is not
active.
.ie n .IP """on""" 4
.el .IP \f(CWon\fR 4
.IX Item "on"
In this mode, events go through the window, and this can be toggled via an
OSC sequence.
.ie n .IP """off""" 4
.el .IP \f(CWoff\fR 4
.IX Item "off"
In this mode, events act normally, but this can be toggled via an OSC
sequence.
.SS "OSC SEQUENCE"
.IX Subsection "OSC SEQUENCE"
When enabled, the OSC sequence \f(CW\*(C`777;clickthrough\fR\f(CImode\fR\f(CW\*(C'\fR can be used
to change the clickthrough mode. Example, switch it on, and then switch it
off again:
.PP
.Vb 2
\&   printf \*(Aq\e033]777;clickthrough:on\e007\*(Aq
\&   printf \*(Aq\e033]777;clickthrough:off\e007\*(Aq
.Ve
.SS BUGS
.IX Subsection "BUGS"
For this to work as expected, your window manager needs to support shaped
windows fully, but most only have partial support. The only window manager
known to handle this correctly is openbox 3.7.
.PP
A workaround is to also use \f(CW\*(C`\-override\-redirect\*(C'\fR.
.PP
In addition, input shapes don't seem to be well supported in Xorg,
which sometimes does not generate the necessary events for window
managers. This is currently being worked around in this extension by
re-setting the input shape after every map event.