ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/src/urxvt.pm
(Generate patch)

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.78 by root, Wed Jan 11 01:01:52 2006 UTC vs.
Revision 1.87 by root, Thu Jan 12 05:37:34 2006 UTC

40=over 4 40=over 4
41 41
42=item selection (enabled by default) 42=item selection (enabled by default)
43 43
44(More) intelligent selection. This extension tries to be more intelligent 44(More) intelligent selection. This extension tries to be more intelligent
45when the user extends selections (double-click). Right now, it tries to 45when the user extends selections (double-click and further clicks). Right
46select urls and complete shell-quoted arguments, which is very convenient, 46now, it tries to select words, urls and complete shell-quoted
47too, if your F<ls> supports C<--quoting-style=shell>. 47arguments, which is very convenient, too, if your F<ls> supports
48C<--quoting-style=shell>.
49
50A double-click usually selects the word under the cursor, further clicks
51will enlarge the selection.
48 52
49It also offers the following bindable keyboard command: 53It also offers the following bindable keyboard command:
50 54
51=over 4 55=over 4
52 56
70evalution, web-browser starting etc.), depending on content. 74evalution, web-browser starting etc.), depending on content.
71 75
72=item searchable-scrollback<hotkey> (enabled by default) 76=item searchable-scrollback<hotkey> (enabled by default)
73 77
74Adds regex search functionality to the scrollback buffer, triggered 78Adds regex search functionality to the scrollback buffer, triggered
75by a hotkey (default: C<M-s>). When in search mode, normal terminal 79by a hotkey (default: C<M-s>). While in search mode, normal terminal
76input/output is suspended. 80input/output is suspended and a regex is displayed at the bottom of the
81screen.
77 82
78C</> starts an incremental regex search, C<n> searches further, C<p> or 83Inputting characters appends them to the regex and continues incremental
79C<N> jump to the previous match, C<G> jumps to the bottom and clears the 84search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
80history, C<enter> leaves search mode at the current position and C<escape> 85search upwards/downwards in the scrollback buffer, C<End> jumps to the
81returns to the original position. 86bottom. C<Escape> leaves search mode and returns to the point where search
87was started, while C<Enter> or C<Return> stay at the current position and
88additionally stores the first match in the current line into the primary
89selection.
82 90
83=item digital-clock 91=item digital-clock
84 92
85Displays a digital clock using the built-in overlay. 93Displays a digital clock using the built-in overlay.
86 94
87=item mark-urls 95=item mark-urls
88 96
89Uses per-line display filtering (C<on_line_update>) to underline urls. 97Uses per-line display filtering (C<on_line_update>) to underline urls and
98make them clickable. When middle-clicked, the program specified in the
99resource C<urlLauncher> (default C<x-www-browser>) will be started with
100the URL as first argument.
90 101
91=item block-graphics-to-ascii 102=item block-graphics-to-ascii
92 103
93A not very useful example of filtering all text output to the terminal, 104A not very useful example of filtering all text output to the terminal,
94by replacing all line-drawing characters (U+2500 .. U+259F) by a 105by replacing all line-drawing characters (U+2500 .. U+259F) by a
228=item on_sel_extend $term 239=item on_sel_extend $term
229 240
230Called whenever the user tries to extend the selection (e.g. with a double 241Called whenever the user tries to extend the selection (e.g. with a double
231click) and is either supposed to return false (normal operation), or 242click) and is either supposed to return false (normal operation), or
232should extend the selection itelf and return true to suppress the built-in 243should extend the selection itelf and return true to suppress the built-in
233processing. 244processing. This can happen multiple times, as long as the callback
245returns true, it will be called on every further click by the user and is
246supposed to enlarge the selection more and more, if possible.
234 247
235See the F<selection> example extension. 248See the F<selection> example extension.
236 249
237=item on_view_change $term, $offset 250=item on_view_change $term, $offset
238 251
494 $msg .= "\n" 507 $msg .= "\n"
495 unless $msg =~ /\n$/; 508 unless $msg =~ /\n$/;
496 urxvt::warn ($msg); 509 urxvt::warn ($msg);
497 }; 510 };
498 511
512 # %ENV is the original startup environment
499 delete $ENV{IFS}; 513 delete $ENV{IFS};
500 delete $ENV{CDPATH}; 514 delete $ENV{CDPATH};
501 delete $ENV{BASH_ENV}; 515 delete $ENV{BASH_ENV};
502 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; 516 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
503} 517}
592 if ($@) { 606 if ($@) {
593 $TERM->ungrab; # better to lose the grab than the session 607 $TERM->ungrab; # better to lose the grab than the session
594 warn $@; 608 warn $@;
595 } 609 }
596 } 610 }
611
612 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
613 if $verbosity >= 11;
597 } 614 }
598 615
599 if ($htype == 1) { # DESTROY 616 if ($htype == 1) { # DESTROY
600 if (my $hook = delete $TERM->{_hook}) { 617 if (my $hook = delete $TERM->{_hook}) {
601 for my $htype (0..$#$hook) { 618 for my $htype (0..$#$hook) {
610 # clear package 627 # clear package
611 %$TERM = (); 628 %$TERM = ();
612 } 629 }
613 630
614 $retval 631 $retval
632}
633
634sub exec_async(@) {
635 my $pid = fork;
636
637 return
638 if !defined $pid or $pid;
639
640 %ENV = %{ $TERM->env };
641
642 exec @_;
643 _exit 255;
615} 644}
616 645
617# urxvt::term::extension 646# urxvt::term::extension
618 647
619package urxvt::term::extension; 648package urxvt::term::extension;
860 my ($self, $name) = (shift, shift); 889 my ($self, $name) = (shift, shift);
861 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 890 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
862 &urxvt::term::_resource 891 &urxvt::term::_resource
863} 892}
864 893
894=item $value = $term->x_resource ($pattern)
895
896Returns the X-Resource for the given pattern, excluding the program or
897class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
898same value as used by this instance of rxvt-unicode. Returns C<undef> if no
899resource with that pattern exists.
900
901This method should only be called during the C<on_start> hook, as there is
902only one resource database per display, and later invocations might return
903the wrong resources.
904
865=item $success = $term->parse_keysym ($keysym_spec, $command_string) 905=item $success = $term->parse_keysym ($keysym_spec, $command_string)
866 906
867Adds a keymap translation exactly as specified via a resource. See the 907Adds a keymap translation exactly as specified via a resource. See the
868C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 908C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
869 909
884=item ($row, $col) = $term->selection_end ([$row, $col]) 924=item ($row, $col) = $term->selection_end ([$row, $col])
885 925
886Return the current values of the selection mark, begin or end positions, 926Return the current values of the selection mark, begin or end positions,
887and optionally set them to new values. 927and optionally set them to new values.
888 928
929=item $term->selection_make ($eventtime[, $rectangular])
930
931Tries to make a selection as set by C<selection_beg> and
932C<selection_end>. If C<$rectangular> is true (default: false), a
933rectangular selection will be made. This is the prefered function to make
934a selection.
935
889=item $success = $term->selection_grab ($eventtime) 936=item $success = $term->selection_grab ($eventtime)
890 937
891Try to request the primary selection from the server (for example, as set 938Try to request the primary selection text from the server (for example, as
892by the next method). 939set by the next method). No visual feedback will be given. This function
940is mostly useful from within C<on_sel_grab> hooks.
893 941
894=item $oldtext = $term->selection ([$newtext]) 942=item $oldtext = $term->selection ([$newtext])
895 943
896Return the current selection text and optionally replace it by C<$newtext>. 944Return the current selection text and optionally replace it by C<$newtext>.
897 945
990Convert the given locale-encoded octets into a perl string. 1038Convert the given locale-encoded octets into a perl string.
991 1039
992=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) 1040=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
993 1041
994XORs the rendition values in the given span with the provided value 1042XORs the rendition values in the given span with the provided value
995(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar 1043(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
996to the selection. 1044refresh hooks to provide effects similar to the selection.
997 1045
998=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]]) 1046=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
999 1047
1000Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing 1048Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
1001whitespace will additionally be xored with the C<$rstyle2>, which defaults 1049whitespace will additionally be xored with the C<$rstyle2>, which defaults
1002to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines 1050to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
1003it instead. 1051it instead. Both styles I<MUST NOT> contain font styles.
1004 1052
1005=item $term->scr_bell 1053=item $term->scr_bell
1006 1054
1007Ring the bell! 1055Ring the bell!
1008 1056
1192Return the row number of the first/last row of the line, respectively. 1240Return the row number of the first/last row of the line, respectively.
1193 1241
1194=item $offset = $line->offset_of ($row, $col) 1242=item $offset = $line->offset_of ($row, $col)
1195 1243
1196Returns the character offset of the given row|col pair within the logical 1244Returns the character offset of the given row|col pair within the logical
1197line. 1245line. Works for rows outside the line, too, and returns corresponding
1246offsets outside the string.
1198 1247
1199=item ($row, $col) = $line->coord_of ($offset) 1248=item ($row, $col) = $line->coord_of ($offset)
1200 1249
1201Translates a string offset into terminal coordinates again. 1250Translates a string offset into terminal coordinates again.
1202 1251
1557 1606
1558=item == 0 - fatal messages 1607=item == 0 - fatal messages
1559 1608
1560=item >= 3 - script loading and management 1609=item >= 3 - script loading and management
1561 1610
1562=item >=10 - all events received 1611=item >=10 - all called hooks
1612
1613=item >=11 - hook reutrn values
1563 1614
1564=back 1615=back
1565 1616
1566=head1 AUTHOR 1617=head1 AUTHOR
1567 1618

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines