--- rxvt-unicode/src/perl/readline	2006/02/20 20:48:11	1.10
+++ rxvt-unicode/src/perl/readline	2021/07/24 09:48:43	1.15
@@ -1,5 +1,36 @@
 #! perl
 
+=head1 NAME
+
+readline - improve readline editing
+
+=head1 DESCRIPTION
+
+A support package that tries to make editing with readline easier. At
+the moment, it reacts to clicking shift-left mouse button by trying to
+move the text cursor to this position. It does so by generating as many
+cursor-left or cursor-right keypresses as required (this only works
+for programs that correctly support wide characters).
+
+To avoid too many false positives, this is only done when:
+
+=over
+
+=item - the tty is in ICANON state.
+
+=item - the text cursor is visible.
+
+=item - the primary screen is currently being displayed.
+
+=item - the mouse is on the same (multi-row-) line as the text cursor.
+
+=back
+
+The normal selection mechanism isn't disabled, so quick successive clicks
+might interfere with selection creation in harmless ways.
+
+=cut
+
 use POSIX ();
 
 my $termios = new POSIX::Termios;
@@ -24,7 +55,7 @@
 
    my $mask = $self->ModLevel3Mask | $self->ModMetaMask
             | urxvt::ShiftMask | urxvt::ControlMask;
-   
+
    ($event->{state} & $mask) == urxvt::ShiftMask
       or return;