--- rxvt-unicode/src/perl/searchable-scrollback	2012/06/10 13:58:06	1.28
+++ rxvt-unicode/src/perl/searchable-scrollback	2014/06/06 19:40:15	1.37
@@ -2,25 +2,54 @@
 
 # this extension implements scrollback buffer search
 
-#:META:X_RESOURCE:%:string:activation hotkey keysym
+#:META:RESOURCE:%:string:activation hotkey keysym
+#:META:BINDING:M-s:start
+
+=head1 NAME
+
+searchable-scrollback - incremental scrollback search (enabled by default)
+
+=head1 DESCRIPTION
+
+Adds regex search functionality to the scrollback buffer, triggered by
+the C<searchable-scrollback:start> action (bound to C<M-s> by
+default). While in search mode, normal terminal input/output is
+suspended and a regex is displayed at the bottom of the screen.
+
+Inputting characters appends them to the regex and continues incremental
+search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
+search upwards/downwards in the scrollback buffer, C<End> jumps to the
+bottom. C<Escape> leaves search mode and returns to the point where search
+was started, while C<Enter> or C<Return> stay at the current position and
+additionally stores the first match in the current line into the primary
+selection if the C<Shift> modifier is active.
+
+The regex defaults to "(?i)", resulting in a case-insensitive search. To
+get a case-sensitive search you can delete this prefix using C<BackSpace>
+or simply use an uppercase character which removes the "(?i)" prefix.
+
+See L<perlre> for more info about perl regular expression syntax.
+
+=cut
 
 sub on_init {
    my ($self) = @_;
 
+   # only for backwards compatibility
    my $hotkey = $self->{argv}[0]
                 || $self->x_resource ("%")
-                || "M-s";
+                || return;
 
-   $self->parse_keysym ($hotkey, "perl:searchable-scrollback:start")
+   $self->bind_action ($hotkey, "searchable-scrollback:start") # ugh
       or warn "unable to register '$hotkey' as scrollback search start hotkey\n";
 
    ()
 }
 
-sub on_user_command {
-   my ($self, $cmd) = @_;
+sub on_action {
+   my ($self, $action) = @_;
 
-   $cmd eq "searchable-scrollback:start"
+   $action eq "start"
       and $self->enter;
 
    ()
@@ -64,7 +93,6 @@
 
    delete $self->{manpage_overlay};
    delete $self->{overlay};
-   delete $self->{history};
    delete $self->{search};
 }
 
@@ -75,10 +103,9 @@
 }
 
 sub search {
-   my ($self, $dir) = @_;
+   my ($self, $dir, $row) = @_;
 
    delete $self->{found};
-   my $row = $self->{row};
 
    my $search = $self->special_encode ($self->{search});
 
@@ -141,14 +168,16 @@
       $self->{row} = $self->nrow - 1;
       $self->view_start (0);
    } elsif ($keysym == 0xff52) { # up
-      $self->{row}-- if $self->{row} > $self->top_row;
-      $self->search (-1);
+      my $line = $self->line ($self->{row});
+      $self->search (-1, $line->beg - 1)
+         if $line->beg > $self->top_row;
    } elsif ($keysym == 0xff54) { # down
-      $self->{row}++ if $self->{row} < $self->nrow;
-      $self->search (+1);
+      my $line = $self->line ($self->{row});
+      $self->search (+1, $line->end + 1)
+         if $line->end < $self->nrow;
    } elsif ($keysym == 0xff08) { # backspace
       substr $self->{search}, -1, 1, "";
-      $self->search;
+      $self->search (+1, $self->{row});
       $self->idle;
    } elsif ($string !~ /[\x00-\x1f\x80-\xaf]/) {
       return; # pass to tt_write
@@ -165,7 +194,7 @@
    $self->{search} =~ s/^\(\?i\)//
       if $self->{search} =~ /^\(.*[[:upper:]]/;
 
-   $self->search (-1);
+   $self->search (-1, $self->{row});
    $self->idle;
 
    1