… | |
… | |
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>. |
48 | |
49 | |
|
|
50 | A double-click usually selects the word under the cursor, further clicks |
|
|
51 | will enlarge the selection. |
|
|
52 | |
|
|
53 | The selection works by trying to match a number of regexes and displaying |
|
|
54 | them in increasing order of length. You can add your own regexes by |
|
|
55 | specifying resources of the form: |
|
|
56 | |
|
|
57 | URxvt.selection.pattern-0: perl-regex |
|
|
58 | URxvt.selection.pattern-1: perl-regex |
|
|
59 | ... |
|
|
60 | |
|
|
61 | The index number (0, 1...) must not have any holes, and each regex must |
|
|
62 | contain at least one pair of capturing parentheses, which will be used for |
|
|
63 | the match. For example, the followign adds a regex that matches everything |
|
|
64 | between two vertical bars: |
|
|
65 | |
|
|
66 | URxvt.selection.pattern-0: \\|([^|]+)\\| |
|
|
67 | |
|
|
68 | You can look at the source of the selection extension to see more |
|
|
69 | interesting uses, such as parsing a line from beginning to end. |
|
|
70 | |
49 | It also offers the following bindable keyboard command: |
71 | This extension also offers the following bindable keyboard command: |
50 | |
72 | |
51 | =over 4 |
73 | =over 4 |
52 | |
74 | |
53 | =item rot13 |
75 | =item rot13 |
54 | |
76 | |
… | |
… | |
70 | evalution, web-browser starting etc.), depending on content. |
92 | evalution, web-browser starting etc.), depending on content. |
71 | |
93 | |
72 | =item searchable-scrollback<hotkey> (enabled by default) |
94 | =item searchable-scrollback<hotkey> (enabled by default) |
73 | |
95 | |
74 | Adds regex search functionality to the scrollback buffer, triggered |
96 | Adds regex search functionality to the scrollback buffer, triggered |
75 | by a hotkey (default: C<M-s>). When in search mode, normal terminal |
97 | by a hotkey (default: C<M-s>). While in search mode, normal terminal |
76 | input/output is suspended. |
98 | input/output is suspended and a regex is displayed at the bottom of the |
|
|
99 | screen. |
77 | |
100 | |
78 | C</> starts an incremental regex search, C<n> searches further, C<p> or |
101 | 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 |
102 | 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> |
103 | search upwards/downwards in the scrollback buffer, C<End> jumps to the |
81 | returns to the original position. |
104 | bottom. C<Escape> leaves search mode and returns to the point where search |
|
|
105 | was started, while C<Enter> or C<Return> stay at the current position and |
|
|
106 | additionally stores the first match in the current line into the primary |
|
|
107 | selection. |
82 | |
108 | |
83 | =item digital-clock |
109 | =item selection-autotransform |
84 | |
110 | |
85 | Displays a digital clock using the built-in overlay. |
111 | This selection allows you to do automatic transforms on a selection |
|
|
112 | whenever a selection is made. |
|
|
113 | |
|
|
114 | It works by specifying perl snippets (most useful is a single C<s///> |
|
|
115 | operator) that modify C<$_> as resources: |
|
|
116 | |
|
|
117 | URxvt.selection-autotransform.0: transform |
|
|
118 | URxvt.selection-autotransform.1: transform |
|
|
119 | ... |
|
|
120 | |
|
|
121 | For example, the following will transform selections of the form |
|
|
122 | C<filename:number>, often seen in compiler messages, into C<vi +$filename |
|
|
123 | $word>: |
|
|
124 | |
|
|
125 | URxvt.selection-autotransform.0: s/^(\\S+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ |
|
|
126 | |
|
|
127 | And this example matches the same,but replaces it with vi-commands you can |
|
|
128 | paste directly into your (vi :) editor: |
|
|
129 | |
|
|
130 | URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/ |
86 | |
131 | |
87 | =item mark-urls |
132 | =item mark-urls |
88 | |
133 | |
89 | Uses per-line display filtering (C<on_line_update>) to underline urls. |
134 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
|
|
135 | make them clickable. When middle-clicked, the program specified in the |
|
|
136 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
|
|
137 | the URL as first argument. |
90 | |
138 | |
91 | =item block-graphics-to-ascii |
139 | =item block-graphics-to-ascii |
92 | |
140 | |
93 | A not very useful example of filtering all text output to the terminal, |
141 | 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 |
142 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
95 | similar-looking ascii character. |
143 | similar-looking ascii character. |
|
|
144 | |
|
|
145 | =item digital-clock |
|
|
146 | |
|
|
147 | Displays a digital clock using the built-in overlay. |
96 | |
148 | |
97 | =item example-refresh-hooks |
149 | =item example-refresh-hooks |
98 | |
150 | |
99 | Displays a very simple digital clock in the upper right corner of the |
151 | Displays a very simple digital clock in the upper right corner of the |
100 | window. Illustrates overwriting the refresh callbacks to create your own |
152 | window. Illustrates overwriting the refresh callbacks to create your own |
… | |
… | |
123 | =over 4 |
175 | =over 4 |
124 | |
176 | |
125 | =item $text |
177 | =item $text |
126 | |
178 | |
127 | Rxvt-unicodes special way of encoding text, where one "unicode" character |
179 | 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. |
180 | always represents one screen cell. See L<ROW_t> for a discussion of this format. |
129 | |
181 | |
130 | =item $string |
182 | =item $string |
131 | |
183 | |
132 | A perl text string, with an emphasis on I<text>. It can store all unicode |
184 | 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 |
185 | characters and is to be distinguished with text encoded in a specific |
… | |
… | |
228 | =item on_sel_extend $term |
280 | =item on_sel_extend $term |
229 | |
281 | |
230 | Called whenever the user tries to extend the selection (e.g. with a double |
282 | 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 |
283 | 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 |
284 | should extend the selection itelf and return true to suppress the built-in |
233 | processing. |
285 | processing. This can happen multiple times, as long as the callback |
|
|
286 | returns true, it will be called on every further click by the user and is |
|
|
287 | supposed to enlarge the selection more and more, if possible. |
234 | |
288 | |
235 | See the F<selection> example extension. |
289 | See the F<selection> example extension. |
236 | |
290 | |
237 | =item on_view_change $term, $offset |
291 | =item on_view_change $term, $offset |
238 | |
292 | |
… | |
… | |
385 | |
439 | |
386 | =item $urxvt::TERM |
440 | =item $urxvt::TERM |
387 | |
441 | |
388 | The current terminal. This variable stores the current C<urxvt::term> |
442 | The current terminal. This variable stores the current C<urxvt::term> |
389 | object, whenever a callback/hook is executing. |
443 | object, whenever a callback/hook is executing. |
390 | |
|
|
391 | =item |
|
|
392 | |
444 | |
393 | =back |
445 | =back |
394 | |
446 | |
395 | =head2 Functions in the C<urxvt> Package |
447 | =head2 Functions in the C<urxvt> Package |
396 | |
448 | |
… | |
… | |
496 | $msg .= "\n" |
548 | $msg .= "\n" |
497 | unless $msg =~ /\n$/; |
549 | unless $msg =~ /\n$/; |
498 | urxvt::warn ($msg); |
550 | urxvt::warn ($msg); |
499 | }; |
551 | }; |
500 | |
552 | |
|
|
553 | # %ENV is the original startup environment |
501 | delete $ENV{IFS}; |
554 | delete $ENV{IFS}; |
502 | delete $ENV{CDPATH}; |
555 | delete $ENV{CDPATH}; |
503 | delete $ENV{BASH_ENV}; |
556 | delete $ENV{BASH_ENV}; |
504 | $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; |
557 | $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; |
505 | } |
558 | } |
… | |
… | |
594 | if ($@) { |
647 | if ($@) { |
595 | $TERM->ungrab; # better to lose the grab than the session |
648 | $TERM->ungrab; # better to lose the grab than the session |
596 | warn $@; |
649 | warn $@; |
597 | } |
650 | } |
598 | } |
651 | } |
|
|
652 | |
|
|
653 | verbose 11, "$HOOKNAME[$htype] returning <$retval>" |
|
|
654 | if $verbosity >= 11; |
599 | } |
655 | } |
600 | |
656 | |
601 | if ($htype == 1) { # DESTROY |
657 | if ($htype == 1) { # DESTROY |
602 | if (my $hook = delete $TERM->{_hook}) { |
658 | if (my $hook = delete $TERM->{_hook}) { |
603 | for my $htype (0..$#$hook) { |
659 | for my $htype (0..$#$hook) { |
… | |
… | |
612 | # clear package |
668 | # clear package |
613 | %$TERM = (); |
669 | %$TERM = (); |
614 | } |
670 | } |
615 | |
671 | |
616 | $retval |
672 | $retval |
|
|
673 | } |
|
|
674 | |
|
|
675 | sub exec_async(@) { |
|
|
676 | my $pid = fork; |
|
|
677 | |
|
|
678 | return |
|
|
679 | if !defined $pid or $pid; |
|
|
680 | |
|
|
681 | %ENV = %{ $TERM->env }; |
|
|
682 | |
|
|
683 | exec @_; |
|
|
684 | _exit 255; |
617 | } |
685 | } |
618 | |
686 | |
619 | # urxvt::term::extension |
687 | # urxvt::term::extension |
620 | |
688 | |
621 | package urxvt::term::extension; |
689 | package urxvt::term::extension; |
… | |
… | |
782 | } |
850 | } |
783 | |
851 | |
784 | =item $term = new urxvt::term $envhashref, $rxvtname, [arg...] |
852 | =item $term = new urxvt::term $envhashref, $rxvtname, [arg...] |
785 | |
853 | |
786 | Creates a new terminal, very similar as if you had started it with system |
854 | 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 |
855 | 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. |
856 | hash which defines the environment of the new terminal. |
789 | |
857 | |
790 | Croaks (and probably outputs an error message) if the new instance |
858 | 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 |
859 | 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 |
860 | initialise perl, and the terminal object otherwise. The C<init> and |
793 | C<start> hooks will be called during this call. |
861 | C<start> hooks will be called during this call. |
… | |
… | |
862 | my ($self, $name) = (shift, shift); |
930 | my ($self, $name) = (shift, shift); |
863 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
931 | unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); |
864 | &urxvt::term::_resource |
932 | &urxvt::term::_resource |
865 | } |
933 | } |
866 | |
934 | |
|
|
935 | =item $value = $term->x_resource ($pattern) |
|
|
936 | |
|
|
937 | Returns the X-Resource for the given pattern, excluding the program or |
|
|
938 | class name, i.e. C<< $term->x_resource ("boldFont") >> should return the |
|
|
939 | same value as used by this instance of rxvt-unicode. Returns C<undef> if no |
|
|
940 | resource with that pattern exists. |
|
|
941 | |
|
|
942 | This method should only be called during the C<on_start> hook, as there is |
|
|
943 | only one resource database per display, and later invocations might return |
|
|
944 | the wrong resources. |
|
|
945 | |
867 | =item $success = $term->parse_keysym ($keysym_spec, $command_string) |
946 | =item $success = $term->parse_keysym ($keysym_spec, $command_string) |
868 | |
947 | |
869 | Adds a keymap translation exactly as specified via a resource. See the |
948 | Adds a keymap translation exactly as specified via a resource. See the |
870 | C<keysym> resource in the @@RXVT_NAME@@(1) manpage. |
949 | C<keysym> resource in the @@RXVT_NAME@@(1) manpage. |
871 | |
950 | |
… | |
… | |
886 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
965 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
887 | |
966 | |
888 | Return the current values of the selection mark, begin or end positions, |
967 | Return the current values of the selection mark, begin or end positions, |
889 | and optionally set them to new values. |
968 | and optionally set them to new values. |
890 | |
969 | |
|
|
970 | =item $term->selection_make ($eventtime[, $rectangular]) |
|
|
971 | |
|
|
972 | Tries to make a selection as set by C<selection_beg> and |
|
|
973 | C<selection_end>. If C<$rectangular> is true (default: false), a |
|
|
974 | rectangular selection will be made. This is the prefered function to make |
|
|
975 | a selection. |
|
|
976 | |
891 | =item $success = $term->selection_grab ($eventtime) |
977 | =item $success = $term->selection_grab ($eventtime) |
892 | |
978 | |
893 | Try to request the primary selection from the server (for example, as set |
979 | Try to request the primary selection text from the server (for example, as |
894 | by the next method). |
980 | set by the next method). No visual feedback will be given. This function |
|
|
981 | is mostly useful from within C<on_sel_grab> hooks. |
895 | |
982 | |
896 | =item $oldtext = $term->selection ([$newtext]) |
983 | =item $oldtext = $term->selection ([$newtext]) |
897 | |
984 | |
898 | Return the current selection text and optionally replace it by C<$newtext>. |
985 | Return the current selection text and optionally replace it by C<$newtext>. |
899 | |
986 | |
… | |
… | |
992 | Convert the given locale-encoded octets into a perl string. |
1079 | Convert the given locale-encoded octets into a perl string. |
993 | |
1080 | |
994 | =item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) |
1081 | =item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) |
995 | |
1082 | |
996 | XORs the rendition values in the given span with the provided value |
1083 | 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 |
1084 | (default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in |
998 | to the selection. |
1085 | refresh hooks to provide effects similar to the selection. |
999 | |
1086 | |
1000 | =item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]]) |
1087 | =item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]]) |
1001 | |
1088 | |
1002 | Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing |
1089 | Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing |
1003 | whitespace will additionally be xored with the C<$rstyle2>, which defaults |
1090 | 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 |
1091 | to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines |
1005 | it instead. |
1092 | it instead. Both styles I<MUST NOT> contain font styles. |
1006 | |
1093 | |
1007 | =item $term->scr_bell |
1094 | =item $term->scr_bell |
1008 | |
1095 | |
1009 | Ring the bell! |
1096 | Ring the bell! |
1010 | |
1097 | |
… | |
… | |
1194 | Return the row number of the first/last row of the line, respectively. |
1281 | Return the row number of the first/last row of the line, respectively. |
1195 | |
1282 | |
1196 | =item $offset = $line->offset_of ($row, $col) |
1283 | =item $offset = $line->offset_of ($row, $col) |
1197 | |
1284 | |
1198 | Returns the character offset of the given row|col pair within the logical |
1285 | Returns the character offset of the given row|col pair within the logical |
1199 | line. |
1286 | line. Works for rows outside the line, too, and returns corresponding |
|
|
1287 | offsets outside the string. |
1200 | |
1288 | |
1201 | =item ($row, $col) = $line->coord_of ($offset) |
1289 | =item ($row, $col) = $line->coord_of ($offset) |
1202 | |
1290 | |
1203 | Translates a string offset into terminal coordinates again. |
1291 | Translates a string offset into terminal coordinates again. |
1204 | |
1292 | |
… | |
… | |
1441 | my ($self) = @_; |
1529 | my ($self) = @_; |
1442 | |
1530 | |
1443 | delete $self->{term}{_destroy}{$self}; |
1531 | delete $self->{term}{_destroy}{$self}; |
1444 | $self->{term}->ungrab; |
1532 | $self->{term}->ungrab; |
1445 | } |
1533 | } |
|
|
1534 | |
|
|
1535 | =back |
1446 | |
1536 | |
1447 | =head2 The C<urxvt::timer> Class |
1537 | =head2 The C<urxvt::timer> Class |
1448 | |
1538 | |
1449 | This class implements timer watchers/events. Time is represented as a |
1539 | This class implements timer watchers/events. Time is represented as a |
1450 | fractional number of seconds since the epoch. Example: |
1540 | fractional number of seconds since the epoch. Example: |
… | |
… | |
1557 | |
1647 | |
1558 | =item == 0 - fatal messages |
1648 | =item == 0 - fatal messages |
1559 | |
1649 | |
1560 | =item >= 3 - script loading and management |
1650 | =item >= 3 - script loading and management |
1561 | |
1651 | |
1562 | =item >=10 - all events received |
1652 | =item >=10 - all called hooks |
|
|
1653 | |
|
|
1654 | =item >=11 - hook reutrn values |
1563 | |
1655 | |
1564 | =back |
1656 | =back |
1565 | |
1657 | |
1566 | =head1 AUTHOR |
1658 | =head1 AUTHOR |
1567 | |
1659 | |