… | |
… | |
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 following bindable keyboard commands: |
50 | |
72 | |
51 | =over 4 |
73 | =over 4 |
52 | |
74 | |
53 | =item rot13 |
75 | =item rot13 |
54 | |
76 | |
55 | Rot-13 the selection when activated. Used via keyboard trigger: |
77 | Rot-13 the selection when activated. Used via keyboard trigger: |
56 | |
78 | |
57 | URxvt.keysym.C-M-r: perl:selection:rot13 |
79 | URxvt.keysym.C-M-r: perl:selection:rot13 |
|
|
80 | |
|
|
81 | =item remote-pastebin |
|
|
82 | |
|
|
83 | Upload the selection as textfile to a remote site. |
|
|
84 | |
|
|
85 | URxvt.keysym.C-M-e: perl:selection:remote-pastebin |
|
|
86 | |
|
|
87 | To set the command to upload the file set this resource: |
|
|
88 | |
|
|
89 | URxvt.selection-pastebin-cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/. |
|
|
90 | |
|
|
91 | The % is the placeholder for the textfile. The name of the textfile is the hex encoded |
|
|
92 | md5 sum of the selection. |
|
|
93 | After an successful upload the selection will be replaced by the following url |
|
|
94 | (the % is the placeholder for the filename): |
|
|
95 | |
|
|
96 | URxvt.selection-pastebin-url: http://www.ta-sa.org/files/txt/% |
58 | |
97 | |
59 | =back |
98 | =back |
60 | |
99 | |
61 | =item option-popup (enabled by default) |
100 | =item option-popup (enabled by default) |
62 | |
101 | |
… | |
… | |
70 | evalution, web-browser starting etc.), depending on content. |
109 | evalution, web-browser starting etc.), depending on content. |
71 | |
110 | |
72 | =item searchable-scrollback<hotkey> (enabled by default) |
111 | =item searchable-scrollback<hotkey> (enabled by default) |
73 | |
112 | |
74 | Adds regex search functionality to the scrollback buffer, triggered |
113 | Adds regex search functionality to the scrollback buffer, triggered |
75 | by a hotkey (default: C<M-s>). When in search mode, normal terminal |
114 | by a hotkey (default: C<M-s>). While in search mode, normal terminal |
76 | input/output is suspended. |
115 | input/output is suspended and a regex is displayed at the bottom of the |
|
|
116 | screen. |
77 | |
117 | |
78 | C</> starts an incremental regex search, C<n> searches further, C<p> or |
118 | 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 |
119 | 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> |
120 | search upwards/downwards in the scrollback buffer, C<End> jumps to the |
81 | returns to the original position. |
121 | bottom. C<Escape> leaves search mode and returns to the point where search |
|
|
122 | was started, while C<Enter> or C<Return> stay at the current position and |
|
|
123 | additionally stores the first match in the current line into the primary |
|
|
124 | selection. |
82 | |
125 | |
83 | =item digital-clock |
126 | =item selection-autotransform |
84 | |
127 | |
85 | Displays a digital clock using the built-in overlay. |
128 | This selection allows you to do automatic transforms on a selection |
|
|
129 | whenever a selection is made. |
|
|
130 | |
|
|
131 | It works by specifying perl snippets (most useful is a single C<s///> |
|
|
132 | operator) that modify C<$_> as resources: |
|
|
133 | |
|
|
134 | URxvt.selection-autotransform.0: transform |
|
|
135 | URxvt.selection-autotransform.1: transform |
|
|
136 | ... |
|
|
137 | |
|
|
138 | For example, the following will transform selections of the form |
|
|
139 | C<filename:number>, often seen in compiler messages, into C<vi +$filename |
|
|
140 | $word>: |
|
|
141 | |
|
|
142 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ |
|
|
143 | |
|
|
144 | And this example matches the same,but replaces it with vi-commands you can |
|
|
145 | paste directly into your (vi :) editor: |
|
|
146 | |
|
|
147 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/ |
|
|
148 | |
|
|
149 | Of course, this can be modified to suit your needs and your editor :) |
|
|
150 | |
|
|
151 | To expand the example above to typical perl error messages ("XXX at |
|
|
152 | FILENAME line YYY."), you need a slightly more elaborate solution: |
|
|
153 | |
|
|
154 | URxvt.selection.pattern-0: ( at .*? line \\d+\\.) |
|
|
155 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/ |
|
|
156 | |
|
|
157 | The first line tells the selection code to treat the unchanging part of |
|
|
158 | every error message as a selection pattern, and the second line transforms |
|
|
159 | the message into vi commands to load the file. |
86 | |
160 | |
87 | =item mark-urls |
161 | =item mark-urls |
88 | |
162 | |
89 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
163 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
90 | make them clickable. When middle-clicked, the program specified in the |
164 | make them clickable. When middle-clicked, the program specified in the |
91 | resource C<urlLauncher> (default C<x-www-browser>) will be started. |
165 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
|
|
166 | the URL as first argument. |
92 | |
167 | |
93 | =item block-graphics-to-ascii |
168 | =item block-graphics-to-ascii |
94 | |
169 | |
95 | A not very useful example of filtering all text output to the terminal, |
170 | A not very useful example of filtering all text output to the terminal, |
96 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
171 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
97 | similar-looking ascii character. |
172 | similar-looking ascii character. |
|
|
173 | |
|
|
174 | =item digital-clock |
|
|
175 | |
|
|
176 | Displays a digital clock using the built-in overlay. |
98 | |
177 | |
99 | =item example-refresh-hooks |
178 | =item example-refresh-hooks |
100 | |
179 | |
101 | Displays a very simple digital clock in the upper right corner of the |
180 | Displays a very simple digital clock in the upper right corner of the |
102 | window. Illustrates overwriting the refresh callbacks to create your own |
181 | window. Illustrates overwriting the refresh callbacks to create your own |
… | |
… | |
309 | |
388 | |
310 | Called whenever the user presses a key combination that has a |
389 | Called whenever the user presses a key combination that has a |
311 | C<perl:string> action bound to it (see description of the B<keysym> |
390 | C<perl:string> action bound to it (see description of the B<keysym> |
312 | resource in the @@RXVT_NAME@@(1) manpage). |
391 | resource in the @@RXVT_NAME@@(1) manpage). |
313 | |
392 | |
|
|
393 | =item on_x_event $term, $event |
|
|
394 | |
|
|
395 | Called on every X event received on the vt window (and possibly other |
|
|
396 | windows). Should only be used as a last resort. Most event structure |
|
|
397 | members are not passed. |
|
|
398 | |
314 | =item on_focus_in $term |
399 | =item on_focus_in $term |
315 | |
400 | |
316 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
401 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
317 | does focus in processing. |
402 | does focus in processing. |
318 | |
403 | |
… | |
… | |
428 | =item urxvt::CurrentTime |
513 | =item urxvt::CurrentTime |
429 | |
514 | |
430 | =item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
515 | =item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
431 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
516 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
432 | Button4Mask, Button5Mask, AnyModifier |
517 | Button4Mask, Button5Mask, AnyModifier |
|
|
518 | |
|
|
519 | =item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask, |
|
|
520 | ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, |
|
|
521 | PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask, |
|
|
522 | Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask, |
|
|
523 | KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask, |
|
|
524 | ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask, |
|
|
525 | FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask |
|
|
526 | |
|
|
527 | =item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify, |
|
|
528 | EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose, |
|
|
529 | GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify, |
|
|
530 | UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify, |
|
|
531 | ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify, |
|
|
532 | CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, |
|
|
533 | SelectionNotify, ColormapNotify, ClientMessage, MappingNotify |
433 | |
534 | |
434 | Various constants for use in X calls and event processing. |
535 | Various constants for use in X calls and event processing. |
435 | |
536 | |
436 | =back |
537 | =back |
437 | |
538 | |
… | |
… | |
505 | delete $ENV{CDPATH}; |
606 | delete $ENV{CDPATH}; |
506 | delete $ENV{BASH_ENV}; |
607 | delete $ENV{BASH_ENV}; |
507 | $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; |
608 | $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; |
508 | } |
609 | } |
509 | |
610 | |
510 | my @hook_count; |
|
|
511 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
611 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
512 | |
612 | |
513 | sub verbose { |
613 | sub verbose { |
514 | my ($level, $msg) = @_; |
614 | my ($level, $msg) = @_; |
515 | warn "$msg\n" if $level <= $verbosity; |
615 | warn "$msg\n" if $level <= $verbosity; |
… | |
… | |
603 | verbose 11, "$HOOKNAME[$htype] returning <$retval>" |
703 | verbose 11, "$HOOKNAME[$htype] returning <$retval>" |
604 | if $verbosity >= 11; |
704 | if $verbosity >= 11; |
605 | } |
705 | } |
606 | |
706 | |
607 | if ($htype == 1) { # DESTROY |
707 | if ($htype == 1) { # DESTROY |
608 | if (my $hook = delete $TERM->{_hook}) { |
|
|
609 | for my $htype (0..$#$hook) { |
|
|
610 | $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } |
|
|
611 | or set_should_invoke $htype, 0; |
|
|
612 | } |
|
|
613 | } |
|
|
614 | |
|
|
615 | # clear package objects |
708 | # clear package objects |
616 | %$_ = () for values %{ $TERM->{_pkg} }; |
709 | %$_ = () for values %{ $TERM->{_pkg} }; |
617 | |
710 | |
618 | # clear package |
711 | # clear package |
619 | %$TERM = (); |
712 | %$TERM = (); |
… | |
… | |
645 | while (my ($name, $cb) = each %hook) { |
738 | while (my ($name, $cb) = each %hook) { |
646 | my $htype = $HOOKTYPE{uc $name}; |
739 | my $htype = $HOOKTYPE{uc $name}; |
647 | defined $htype |
740 | defined $htype |
648 | or Carp::croak "unsupported hook type '$name'"; |
741 | or Carp::croak "unsupported hook type '$name'"; |
649 | |
742 | |
|
|
743 | $self->set_should_invoke ($htype, +1) |
650 | unless (exists $self->{term}{_hook}[$htype]{$pkg}) { |
744 | unless exists $self->{term}{_hook}[$htype]{$pkg}; |
651 | $hook_count[$htype]++ |
|
|
652 | or urxvt::set_should_invoke $htype, 1; |
|
|
653 | } |
|
|
654 | |
745 | |
655 | $self->{term}{_hook}[$htype]{$pkg} = $cb; |
746 | $self->{term}{_hook}[$htype]{$pkg} = $cb; |
656 | } |
747 | } |
657 | } |
748 | } |
658 | |
749 | |
… | |
… | |
663 | for my $name (@hook) { |
754 | for my $name (@hook) { |
664 | my $htype = $HOOKTYPE{uc $name}; |
755 | my $htype = $HOOKTYPE{uc $name}; |
665 | defined $htype |
756 | defined $htype |
666 | or Carp::croak "unsupported hook type '$name'"; |
757 | or Carp::croak "unsupported hook type '$name'"; |
667 | |
758 | |
|
|
759 | $self->set_should_invoke ($htype, -1) |
668 | if (delete $self->{term}{_hook}[$htype]{$pkg}) { |
760 | if delete $self->{term}{_hook}[$htype]{$pkg}; |
669 | --$hook_count[$htype] |
|
|
670 | or urxvt::set_should_invoke $htype, 0; |
|
|
671 | } |
|
|
672 | } |
761 | } |
673 | } |
762 | } |
674 | |
763 | |
675 | our $AUTOLOAD; |
764 | our $AUTOLOAD; |
676 | |
765 | |
… | |
… | |
915 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
1004 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
916 | |
1005 | |
917 | Return the current values of the selection mark, begin or end positions, |
1006 | Return the current values of the selection mark, begin or end positions, |
918 | and optionally set them to new values. |
1007 | and optionally set them to new values. |
919 | |
1008 | |
|
|
1009 | =item $term->selection_make ($eventtime[, $rectangular]) |
|
|
1010 | |
|
|
1011 | Tries to make a selection as set by C<selection_beg> and |
|
|
1012 | C<selection_end>. If C<$rectangular> is true (default: false), a |
|
|
1013 | rectangular selection will be made. This is the prefered function to make |
|
|
1014 | a selection. |
|
|
1015 | |
920 | =item $success = $term->selection_grab ($eventtime) |
1016 | =item $success = $term->selection_grab ($eventtime) |
921 | |
1017 | |
922 | Try to request the primary selection from the server (for example, as set |
1018 | Try to request the primary selection text from the server (for example, as |
923 | by the next method). |
1019 | set by the next method). No visual feedback will be given. This function |
|
|
1020 | is mostly useful from within C<on_sel_grab> hooks. |
924 | |
1021 | |
925 | =item $oldtext = $term->selection ([$newtext]) |
1022 | =item $oldtext = $term->selection ([$newtext]) |
926 | |
1023 | |
927 | Return the current selection text and optionally replace it by C<$newtext>. |
1024 | Return the current selection text and optionally replace it by C<$newtext>. |
928 | |
1025 | |
… | |
… | |
1021 | Convert the given locale-encoded octets into a perl string. |
1118 | Convert the given locale-encoded octets into a perl string. |
1022 | |
1119 | |
1023 | =item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) |
1120 | =item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) |
1024 | |
1121 | |
1025 | XORs the rendition values in the given span with the provided value |
1122 | XORs the rendition values in the given span with the provided value |
1026 | (default: C<RS_RVid>). Useful in refresh hooks to provide effects similar |
1123 | (default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in |
1027 | to the selection. |
1124 | refresh hooks to provide effects similar to the selection. |
1028 | |
1125 | |
1029 | =item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]]) |
1126 | =item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]]) |
1030 | |
1127 | |
1031 | Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing |
1128 | Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing |
1032 | whitespace will additionally be xored with the C<$rstyle2>, which defaults |
1129 | whitespace will additionally be xored with the C<$rstyle2>, which defaults |
1033 | to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines |
1130 | to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines |
1034 | it instead. |
1131 | it instead. Both styles I<MUST NOT> contain font styles. |
1035 | |
1132 | |
1036 | =item $term->scr_bell |
1133 | =item $term->scr_bell |
1037 | |
1134 | |
1038 | Ring the bell! |
1135 | Ring the bell! |
1039 | |
1136 | |
… | |
… | |
1073 | |
1170 | |
1074 | =item $windowid = $term->vt |
1171 | =item $windowid = $term->vt |
1075 | |
1172 | |
1076 | Return the window id of the terminal window. |
1173 | Return the window id of the terminal window. |
1077 | |
1174 | |
|
|
1175 | =item $term->vt_emask_add ($x_event_mask) |
|
|
1176 | |
|
|
1177 | Adds the specified events to the vt event mask. Useful e.g. when you want |
|
|
1178 | to receive pointer events all the times: |
|
|
1179 | |
|
|
1180 | $term->vt_emask_add (urxvt::PointerMotionMask); |
|
|
1181 | |
1078 | =item $window_width = $term->width |
1182 | =item $window_width = $term->width |
1079 | |
1183 | |
1080 | =item $window_height = $term->height |
1184 | =item $window_height = $term->height |
1081 | |
1185 | |
1082 | =item $font_width = $term->fwidth |
1186 | =item $font_width = $term->fwidth |
… | |
… | |
1095 | |
1199 | |
1096 | =item $max_scrollback = $term->saveLines |
1200 | =item $max_scrollback = $term->saveLines |
1097 | |
1201 | |
1098 | =item $nrow_plus_saveLines = $term->total_rows |
1202 | =item $nrow_plus_saveLines = $term->total_rows |
1099 | |
1203 | |
1100 | =item $lines_in_scrollback = $term->nsaved |
1204 | =item $topmost_scrollback_row = $term->top_row |
1101 | |
1205 | |
1102 | Return various integers describing terminal characteristics. |
1206 | Return various integers describing terminal characteristics. |
1103 | |
1207 | |
1104 | =item $x_display = $term->display_id |
1208 | =item $x_display = $term->display_id |
1105 | |
1209 | |
… | |
… | |
1133 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
1237 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
1134 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1238 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1135 | |
1239 | |
1136 | =item $view_start = $term->view_start ([$newvalue]) |
1240 | =item $view_start = $term->view_start ([$newvalue]) |
1137 | |
1241 | |
1138 | Returns the negative row number of the topmost line. Minimum value is |
1242 | Returns the row number of the topmost displayed line. Maximum value is |
1139 | C<0>, which displays the normal terminal contents. Larger values scroll |
1243 | C<0>, which displays the normal terminal contents. Lower values scroll |
1140 | this many lines into the scrollback buffer. |
1244 | this many lines into the scrollback buffer. |
1141 | |
1245 | |
1142 | =item $term->want_refresh |
1246 | =item $term->want_refresh |
1143 | |
1247 | |
1144 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
1248 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |