--- rxvt-unicode/src/perl/searchable-scrollback	2007/08/01 17:55:37	1.23
+++ rxvt-unicode/src/perl/searchable-scrollback	2014/05/31 08:33:47	1.36
@@ -2,23 +2,54 @@
 
 # this extension implements scrollback buffer search
 
+#: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 ("searchable-scrollback")
-                || "M-s";
+                || $self->x_resource ("%")
+                || 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;
 
    ()
@@ -37,7 +68,7 @@
    return if $self->{overlay};
 
    $self->{view_start} = $self->view_start;
-   $self->{pty_ev_events} = $self->pty_ev_events (urxvt::EVENT_NONE);
+   $self->{pty_ev_events} = $self->pty_ev_events (urxvt::EV_NONE);
    $self->{row} = $self->nrow - 1;
    $self->{search} = "(?i)";
 
@@ -62,7 +93,6 @@
 
    delete $self->{manpage_overlay};
    delete $self->{overlay};
-   delete $self->{history};
    delete $self->{search};
 }
 
@@ -82,7 +112,7 @@
 
    no re 'eval'; # just to be sure
    if (my $re = eval { qr/$search/ }) {
-      while ($self->nrow > $row && $row > $self->top_row) {
+      while ($self->nrow > $row && $row >= $self->top_row) {
          my $line = $self->line ($row)
             or last;
 
@@ -162,7 +192,7 @@
 
    $self->{search} =~ s/^\(\?i\)//
       if $self->{search} =~ /^\(.*[[:upper:]]/;
-   
+
    $self->search (-1);
    $self->idle;