… | |
… | |
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 |
45 | when the user extends selections (double-click). Right now, it tries to |
45 | when the user extends selections (double-click and further clicks). Right |
46 | select urls and complete shell-quoted arguments, which is very convenient, |
46 | now, it tries to select words, urls and complete shell-quoted |
47 | too, if your F<ls> supports C<--quoting-style=shell>. |
47 | arguments, which is very convenient, too, if your F<ls> supports |
|
|
48 | C<--quoting-style=shell>. |
|
|
49 | |
|
|
50 | A double-click usually selects the word under the cursor, further clicks |
|
|
51 | will enlarge the selection. |
48 | |
52 | |
49 | It also offers the following bindable keyboard command: |
53 | It also offers the following bindable keyboard command: |
50 | |
54 | |
51 | =over 4 |
55 | =over 4 |
52 | |
56 | |
… | |
… | |
70 | evalution, web-browser starting etc.), depending on content. |
74 | evalution, 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 | |
74 | Adds regex search functionality to the scrollback buffer, triggered |
78 | Adds regex search functionality to the scrollback buffer, triggered |
75 | by a hotkey (default: C<M-s>). When in search mode, normal terminal |
79 | by a hotkey (default: C<M-s>). While in search mode, normal terminal |
76 | input/output is suspended. |
80 | input/output is suspended and a regex is displayed at the bottom of the |
|
|
81 | screen. |
77 | |
82 | |
78 | C</> starts an incremental regex search, C<n> searches further, C<p> or |
83 | Inputting characters appends them to the regex and continues incremental |
79 | C<N> jump to the previous match, C<G> jumps to the bottom and clears the |
84 | search. C<BackSpace> removes a character from the regex, C<Up> and C<Down> |
80 | history, C<enter> leaves search mode at the current position and C<escape> |
85 | search upwards/downwards in the scrollback buffer, C<End> jumps to the |
81 | returns to the original position. |
86 | bottom. C<Escape> leaves search mode and returns to the point where search |
|
|
87 | was started, while C<Enter> or C<Return> stay at the current position and |
|
|
88 | additionally stores the first match in the current line into the primary |
|
|
89 | selection. |
82 | |
90 | |
83 | =item digital-clock |
91 | =item digital-clock |
84 | |
92 | |
85 | Displays a digital clock using the built-in overlay. |
93 | Displays a digital clock using the built-in overlay. |
86 | |
94 | |
87 | =item mark-urls |
95 | =item mark-urls |
88 | |
96 | |
89 | Uses per-line display filtering (C<on_line_update>) to underline urls. |
97 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
|
|
98 | make them clickable. When middle-clicked, the program specified in the |
|
|
99 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
|
|
100 | the URL as first argument. |
90 | |
101 | |
91 | =item block-graphics-to-ascii |
102 | =item block-graphics-to-ascii |
92 | |
103 | |
93 | A not very useful example of filtering all text output to the terminal, |
104 | A not very useful example of filtering all text output to the terminal, |
94 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
105 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
… | |
… | |
123 | =over 4 |
134 | =over 4 |
124 | |
135 | |
125 | =item $text |
136 | =item $text |
126 | |
137 | |
127 | Rxvt-unicodes special way of encoding text, where one "unicode" character |
138 | Rxvt-unicodes special way of encoding text, where one "unicode" character |
128 | always represents one screen cell. See L<row_t> for a discussion of this format. |
139 | always represents one screen cell. See L<ROW_t> for a discussion of this format. |
129 | |
140 | |
130 | =item $string |
141 | =item $string |
131 | |
142 | |
132 | A perl text string, with an emphasis on I<text>. It can store all unicode |
143 | A perl text string, with an emphasis on I<text>. It can store all unicode |
133 | characters and is to be distinguished with text encoded in a specific |
144 | characters and is to be distinguished with text encoded in a specific |
… | |
… | |
228 | =item on_sel_extend $term |
239 | =item on_sel_extend $term |
229 | |
240 | |
230 | Called whenever the user tries to extend the selection (e.g. with a double |
241 | Called whenever the user tries to extend the selection (e.g. with a double |
231 | click) and is either supposed to return false (normal operation), or |
242 | click) and is either supposed to return false (normal operation), or |
232 | should extend the selection itelf and return true to suppress the built-in |
243 | should extend the selection itelf and return true to suppress the built-in |
233 | processing. |
244 | processing. This can happen multiple times, as long as the callback |
|
|
245 | returns true, it will be called on every further click by the user and is |
|
|
246 | supposed to enlarge the selection more and more, if possible. |
234 | |
247 | |
235 | See the F<selection> example extension. |
248 | See the F<selection> example extension. |
236 | |
249 | |
237 | =item on_view_change $term, $offset |
250 | =item on_view_change $term, $offset |
238 | |
251 | |
… | |
… | |
385 | |
398 | |
386 | =item $urxvt::TERM |
399 | =item $urxvt::TERM |
387 | |
400 | |
388 | The current terminal. This variable stores the current C<urxvt::term> |
401 | The current terminal. This variable stores the current C<urxvt::term> |
389 | object, whenever a callback/hook is executing. |
402 | object, whenever a callback/hook is executing. |
390 | |
|
|
391 | =item |
|
|
392 | |
403 | |
393 | =back |
404 | =back |
394 | |
405 | |
395 | =head2 Functions in the C<urxvt> Package |
406 | =head2 Functions in the C<urxvt> Package |
396 | |
407 | |
… | |
… | |
496 | $msg .= "\n" |
507 | $msg .= "\n" |
497 | unless $msg =~ /\n$/; |
508 | unless $msg =~ /\n$/; |
498 | urxvt::warn ($msg); |
509 | urxvt::warn ($msg); |
499 | }; |
510 | }; |
500 | |
511 | |
|
|
512 | # %ENV is the original startup environment |
501 | delete $ENV{IFS}; |
513 | delete $ENV{IFS}; |
502 | delete $ENV{CDPATH}; |
514 | delete $ENV{CDPATH}; |
503 | delete $ENV{BASH_ENV}; |
515 | delete $ENV{BASH_ENV}; |
504 | $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"; |
505 | } |
517 | } |
… | |
… | |
594 | if ($@) { |
606 | if ($@) { |
595 | $TERM->ungrab; # better to lose the grab than the session |
607 | $TERM->ungrab; # better to lose the grab than the session |
596 | warn $@; |
608 | warn $@; |
597 | } |
609 | } |
598 | } |
610 | } |
|
|
611 | |
|
|
612 | verbose 11, "$HOOKNAME[$htype] returning <$retval>" |
|
|
613 | if $verbosity >= 11; |
599 | } |
614 | } |
600 | |
615 | |
601 | if ($htype == 1) { # DESTROY |
616 | if ($htype == 1) { # DESTROY |
602 | if (my $hook = delete $TERM->{_hook}) { |
617 | if (my $hook = delete $TERM->{_hook}) { |
603 | for my $htype (0..$#$hook) { |
618 | for my $htype (0..$#$hook) { |
… | |
… | |
612 | # clear package |
627 | # clear package |
613 | %$TERM = (); |
628 | %$TERM = (); |
614 | } |
629 | } |
615 | |
630 | |
616 | $retval |
631 | $retval |
|
|
632 | } |
|
|
633 | |
|
|
634 | sub 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; |
617 | } |
644 | } |
618 | |
645 | |
619 | # urxvt::term::extension |
646 | # urxvt::term::extension |
620 | |
647 | |
621 | package urxvt::term::extension; |
648 | package urxvt::term::extension; |
… | |
… | |
782 | } |
809 | } |
783 | |
810 | |
784 | =item $term = new urxvt::term $envhashref, $rxvtname, [arg...] |
811 | =item $term = new urxvt::term $envhashref, $rxvtname, [arg...] |
785 | |
812 | |
786 | Creates a new terminal, very similar as if you had started it with system |
813 | Creates a new terminal, very similar as if you had started it with system |
787 | C<$rxvtname, arg...>. C<$envhashref> must be a reference to a %ENV>-like |
814 | C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like |
788 | C<hash which defines the environment of the new terminal. |
815 | hash which defines the environment of the new terminal. |
789 | |
816 | |
790 | Croaks (and probably outputs an error message) if the new instance |
817 | Croaks (and probably outputs an error message) if the new instance |
791 | couldn't be created. Returns C<undef> if the new instance didn't |
818 | couldn't be created. Returns C<undef> if the new instance didn't |
792 | initialise perl, and the terminal object otherwise. The C<init> and |
819 | initialise perl, and the terminal object otherwise. The C<init> and |
793 | C<start> hooks will be called during this call. |
820 | C<start> hooks will be called during this call. |
… | |
… | |
862 | my ($self, $name) = (shift, shift); |
889 | my ($self, $name) = (shift, shift); |
863 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
890 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
864 | &urxvt::term::_resource |
891 | &urxvt::term::_resource |
865 | } |
892 | } |
866 | |
893 | |
|
|
894 | =item $value = $term->x_resource ($pattern) |
|
|
895 | |
|
|
896 | Returns the X-Resource for the given pattern, excluding the program or |
|
|
897 | class name, i.e. C<< $term->x_resource ("boldFont") >> should return the |
|
|
898 | same value as used by this instance of rxvt-unicode. Returns C<undef> if no |
|
|
899 | resource with that pattern exists. |
|
|
900 | |
|
|
901 | This method should only be called during the C<on_start> hook, as there is |
|
|
902 | only one resource database per display, and later invocations might return |
|
|
903 | the wrong resources. |
|
|
904 | |
867 | =item $success = $term->parse_keysym ($keysym_spec, $command_string) |
905 | =item $success = $term->parse_keysym ($keysym_spec, $command_string) |
868 | |
906 | |
869 | Adds a keymap translation exactly as specified via a resource. See the |
907 | Adds a keymap translation exactly as specified via a resource. See the |
870 | C<keysym> resource in the @@RXVT_NAME@@(1) manpage. |
908 | C<keysym> resource in the @@RXVT_NAME@@(1) manpage. |
871 | |
909 | |
… | |
… | |
886 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
924 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
887 | |
925 | |
888 | Return the current values of the selection mark, begin or end positions, |
926 | Return the current values of the selection mark, begin or end positions, |
889 | and optionally set them to new values. |
927 | and optionally set them to new values. |
890 | |
928 | |
|
|
929 | =item $term->selection_make ($eventtime[, $rectangular]) |
|
|
930 | |
|
|
931 | Tries to make a selection as set by C<selection_beg> and |
|
|
932 | C<selection_end>. If C<$rectangular> is true (default: false), a |
|
|
933 | rectangular selection will be made. This is the prefered function to make |
|
|
934 | a selection. |
|
|
935 | |
891 | =item $success = $term->selection_grab ($eventtime) |
936 | =item $success = $term->selection_grab ($eventtime) |
892 | |
937 | |
893 | Try to request the primary selection from the server (for example, as set |
938 | Try to request the primary selection text from the server (for example, as |
894 | by the next method). |
939 | set by the next method). No visual feedback will be given. This function |
|
|
940 | is mostly useful from within C<on_sel_grab> hooks. |
895 | |
941 | |
896 | =item $oldtext = $term->selection ([$newtext]) |
942 | =item $oldtext = $term->selection ([$newtext]) |
897 | |
943 | |
898 | Return the current selection text and optionally replace it by C<$newtext>. |
944 | Return the current selection text and optionally replace it by C<$newtext>. |
899 | |
945 | |
… | |
… | |
992 | Convert the given locale-encoded octets into a perl string. |
1038 | Convert the given locale-encoded octets into a perl string. |
993 | |
1039 | |
994 | =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]) |
995 | |
1041 | |
996 | XORs the rendition values in the given span with the provided value |
1042 | XORs the rendition values in the given span with the provided value |
997 | (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 |
998 | to the selection. |
1044 | refresh hooks to provide effects similar to the selection. |
999 | |
1045 | |
1000 | =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]]) |
1001 | |
1047 | |
1002 | Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing |
1048 | Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing |
1003 | whitespace will additionally be xored with the C<$rstyle2>, which defaults |
1049 | whitespace will additionally be xored with the C<$rstyle2>, which defaults |
1004 | to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines |
1050 | to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines |
1005 | it instead. |
1051 | it instead. Both styles I<MUST NOT> contain font styles. |
1006 | |
1052 | |
1007 | =item $term->scr_bell |
1053 | =item $term->scr_bell |
1008 | |
1054 | |
1009 | Ring the bell! |
1055 | Ring the bell! |
1010 | |
1056 | |
… | |
… | |
1194 | Return the row number of the first/last row of the line, respectively. |
1240 | Return the row number of the first/last row of the line, respectively. |
1195 | |
1241 | |
1196 | =item $offset = $line->offset_of ($row, $col) |
1242 | =item $offset = $line->offset_of ($row, $col) |
1197 | |
1243 | |
1198 | Returns the character offset of the given row|col pair within the logical |
1244 | Returns the character offset of the given row|col pair within the logical |
1199 | line. |
1245 | line. Works for rows outside the line, too, and returns corresponding |
|
|
1246 | offsets outside the string. |
1200 | |
1247 | |
1201 | =item ($row, $col) = $line->coord_of ($offset) |
1248 | =item ($row, $col) = $line->coord_of ($offset) |
1202 | |
1249 | |
1203 | Translates a string offset into terminal coordinates again. |
1250 | Translates a string offset into terminal coordinates again. |
1204 | |
1251 | |
… | |
… | |
1441 | my ($self) = @_; |
1488 | my ($self) = @_; |
1442 | |
1489 | |
1443 | delete $self->{term}{_destroy}{$self}; |
1490 | delete $self->{term}{_destroy}{$self}; |
1444 | $self->{term}->ungrab; |
1491 | $self->{term}->ungrab; |
1445 | } |
1492 | } |
|
|
1493 | |
|
|
1494 | =back |
1446 | |
1495 | |
1447 | =head2 The C<urxvt::timer> Class |
1496 | =head2 The C<urxvt::timer> Class |
1448 | |
1497 | |
1449 | This class implements timer watchers/events. Time is represented as a |
1498 | This class implements timer watchers/events. Time is represented as a |
1450 | fractional number of seconds since the epoch. Example: |
1499 | fractional number of seconds since the epoch. Example: |
… | |
… | |
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 | |