… | |
… | |
67 | the match. For example, the followign adds a regex that matches everything |
67 | the match. For example, the followign adds a regex that matches everything |
68 | between two vertical bars: |
68 | between two vertical bars: |
69 | |
69 | |
70 | URxvt.selection.pattern-0: \\|([^|]+)\\| |
70 | URxvt.selection.pattern-0: \\|([^|]+)\\| |
71 | |
71 | |
|
|
72 | Another example: Programs I use often output "absolute path: " at the |
|
|
73 | beginning of a line when they process multiple files. The following |
|
|
74 | pattern matches the filename (note, there is a single space at the very |
|
|
75 | end): |
|
|
76 | |
|
|
77 | URxvt.selection.pattern-0: ^(/[^:]+):\ |
|
|
78 | |
72 | You can look at the source of the selection extension to see more |
79 | You can look at the source of the selection extension to see more |
73 | interesting uses, such as parsing a line from beginning to end. |
80 | interesting uses, such as parsing a line from beginning to end. |
74 | |
81 | |
75 | This extension also offers following bindable keyboard commands: |
82 | This extension also offers following bindable keyboard commands: |
76 | |
83 | |
… | |
… | |
91 | |
98 | |
92 | =item selection-popup (enabled by default) |
99 | =item selection-popup (enabled by default) |
93 | |
100 | |
94 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
101 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
95 | text into various other formats/action (such as uri unescaping, perl |
102 | text into various other formats/action (such as uri unescaping, perl |
96 | evalution, web-browser starting etc.), depending on content. |
103 | evaluation, web-browser starting etc.), depending on content. |
97 | |
104 | |
98 | Other extensions can extend this popup menu by pushing a code reference |
105 | Other extensions can extend this popup menu by pushing a code reference |
99 | onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the |
106 | onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the |
100 | popup is displayed. |
107 | popup is displayed. |
101 | |
108 | |
… | |
… | |
127 | bottom. C<Escape> leaves search mode and returns to the point where search |
134 | bottom. C<Escape> leaves search mode and returns to the point where search |
128 | was started, while C<Enter> or C<Return> stay at the current position and |
135 | was started, while C<Enter> or C<Return> stay at the current position and |
129 | additionally stores the first match in the current line into the primary |
136 | additionally stores the first match in the current line into the primary |
130 | selection. |
137 | selection. |
131 | |
138 | |
|
|
139 | =item readline (enabled by default) |
|
|
140 | |
|
|
141 | A support package that tries to make editing with readline easier. At the |
|
|
142 | moment, it reacts to clicking with the left mouse button by trying to |
|
|
143 | move the text cursor to this position. It does so by generating as many |
|
|
144 | cursor-left or cursor-right keypresses as required (the this only works |
|
|
145 | for programs that correctly support wide characters). |
|
|
146 | |
|
|
147 | To avoid too many false positives, this is only done when: |
|
|
148 | |
|
|
149 | =over 4 |
|
|
150 | |
|
|
151 | =item - the tty is in ICANON state. |
|
|
152 | |
|
|
153 | =item - the text cursor is visible. |
|
|
154 | |
|
|
155 | =item - the primary screen is currently being displayed. |
|
|
156 | |
|
|
157 | =item - the mouse is on the same (multi-row-) line as the text cursor. |
|
|
158 | |
|
|
159 | =back |
|
|
160 | |
|
|
161 | The normal selection mechanism isn't disabled, so quick successive clicks |
|
|
162 | might interfere with selection creation in harmless ways. |
|
|
163 | |
132 | =item selection-autotransform |
164 | =item selection-autotransform |
133 | |
165 | |
134 | This selection allows you to do automatic transforms on a selection |
166 | This selection allows you to do automatic transforms on a selection |
135 | whenever a selection is made. |
167 | whenever a selection is made. |
136 | |
168 | |
… | |
… | |
169 | This transforms the terminal into a tabbar with additional terminals, that |
201 | This transforms the terminal into a tabbar with additional terminals, that |
170 | is, it implements what is commonly refered to as "tabbed terminal". The topmost line |
202 | is, it implements what is commonly refered to as "tabbed terminal". The topmost line |
171 | displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one |
203 | displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one |
172 | button per tab. |
204 | button per tab. |
173 | |
205 | |
174 | Clicking a button will activate that tab. Pressing Shift-Left and |
206 | Clicking a button will activate that tab. Pressing B<Shift-Left> and |
175 | Shift-Right will switch to the tab left or right of the current one. |
207 | B<Shift-Right> will switch to the tab left or right of the current one, |
|
|
208 | while B<Shift-Down> creates a new tab. |
176 | |
209 | |
177 | =item mark-urls |
210 | =item mark-urls |
178 | |
211 | |
179 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
212 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
180 | make them clickable. When middle-clicked, the program specified in the |
213 | make them clickable. When middle-clicked, the program specified in the |
181 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
214 | resource C<urlLauncher> (default C<x-www-browser>) will be started with |
182 | the URL as first argument. |
215 | the URL as first argument. |
|
|
216 | |
|
|
217 | =item xim-onthespot |
|
|
218 | |
|
|
219 | This (experimental) perl extension implements OnTheSpot editing. It does |
|
|
220 | not work perfectly, and some input methods don't seem to work well with |
|
|
221 | OnTheSpot editing in general, but it seems to work at leats for SCIM and |
|
|
222 | kinput2. |
|
|
223 | |
|
|
224 | You enable it by specifying this extension and a preedit style of |
|
|
225 | C<OnTheSpot>, i.e.: |
|
|
226 | |
|
|
227 | @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot |
183 | |
228 | |
184 | =item automove-background |
229 | =item automove-background |
185 | |
230 | |
186 | This is basically a one-line extension that dynamically changes the background pixmap offset |
231 | This is basically a one-line extension that dynamically changes the background pixmap offset |
187 | to the window position, in effect creating the same effect as pseudo transparency with |
232 | to the window position, in effect creating the same effect as pseudo transparency with |
… | |
… | |
337 | Called at the very end of initialisation of a new terminal, just before |
382 | Called at the very end of initialisation of a new terminal, just before |
338 | trying to map (display) the toplevel and returning to the mainloop. |
383 | trying to map (display) the toplevel and returning to the mainloop. |
339 | |
384 | |
340 | =item on_destroy $term |
385 | =item on_destroy $term |
341 | |
386 | |
342 | Called whenever something tries to destroy terminal, before doing anything |
387 | Called whenever something tries to destroy terminal, when the terminal is |
343 | yet. If this hook returns true, then destruction is skipped, but this is |
388 | still fully functional (not for long, though). |
344 | rarely a good idea. |
|
|
345 | |
389 | |
346 | =item on_reset $term |
390 | =item on_reset $term |
347 | |
391 | |
348 | Called after the screen is "reset" for any reason, such as resizing or |
392 | Called after the screen is "reset" for any reason, such as resizing or |
349 | control sequences. Here is where you can react on changes to size-related |
393 | control sequences. Here is where you can react on changes to size-related |
… | |
… | |
475 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
519 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
476 | focus out processing. |
520 | focus out processing. |
477 | |
521 | |
478 | =item on_configure_notify $term, $event |
522 | =item on_configure_notify $term, $event |
479 | |
523 | |
|
|
524 | =item on_property_notify $term, $event |
|
|
525 | |
480 | =item on_key_press $term, $event, $keysym, $octets |
526 | =item on_key_press $term, $event, $keysym, $octets |
481 | |
527 | |
482 | =item on_key_release $term, $event, $keysym |
528 | =item on_key_release $term, $event, $keysym |
483 | |
529 | |
484 | =item on_button_press $term, $event |
530 | =item on_button_press $term, $event |
… | |
… | |
493 | |
539 | |
494 | Called whenever the corresponding X event is received for the terminal If |
540 | Called whenever the corresponding X event is received for the terminal If |
495 | the hook returns true, then the even will be ignored by rxvt-unicode. |
541 | the hook returns true, then the even will be ignored by rxvt-unicode. |
496 | |
542 | |
497 | The event is a hash with most values as named by Xlib (see the XEvent |
543 | The event is a hash with most values as named by Xlib (see the XEvent |
498 | manpage), with the additional members C<row> and C<col>, which are the row |
544 | manpage), with the additional members C<row> and C<col>, which are the |
499 | and column under the mouse cursor. |
545 | (real, not screen-based) row and column under the mouse cursor. |
500 | |
546 | |
501 | C<on_key_press> additionally receives the string rxvt-unicode would |
547 | C<on_key_press> additionally receives the string rxvt-unicode would |
502 | output, if any, in locale-specific encoding. |
548 | output, if any, in locale-specific encoding. |
503 | |
549 | |
504 | subwindow. |
550 | subwindow. |
… | |
… | |
534 | |
580 | |
535 | our $LIBDIR; |
581 | our $LIBDIR; |
536 | our $RESNAME; |
582 | our $RESNAME; |
537 | our $RESCLASS; |
583 | our $RESCLASS; |
538 | our $RXVTNAME; |
584 | our $RXVTNAME; |
|
|
585 | |
|
|
586 | our $NOCHAR = chr 0xffff; |
539 | |
587 | |
540 | =head2 Variables in the C<urxvt> Package |
588 | =head2 Variables in the C<urxvt> Package |
541 | |
589 | |
542 | =over 4 |
590 | =over 4 |
543 | |
591 | |
… | |
… | |
690 | unless $msg =~ /\n$/; |
738 | unless $msg =~ /\n$/; |
691 | urxvt::warn ($msg); |
739 | urxvt::warn ($msg); |
692 | }; |
740 | }; |
693 | } |
741 | } |
694 | |
742 | |
|
|
743 | no warnings 'utf8'; |
|
|
744 | |
695 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
745 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
696 | |
746 | |
697 | sub verbose { |
747 | sub verbose { |
698 | my ($level, $msg) = @_; |
748 | my ($level, $msg) = @_; |
699 | warn "$msg\n" if $level <= $verbosity; |
749 | warn "$msg\n" if $level <= $verbosity; |
… | |
… | |
715 | |
765 | |
716 | open my $fh, "<:raw", $path |
766 | open my $fh, "<:raw", $path |
717 | or die "$path: $!"; |
767 | or die "$path: $!"; |
718 | |
768 | |
719 | my $source = |
769 | my $source = |
720 | "package $pkg; use strict; use utf8;\n" |
770 | "package $pkg; use strict; use utf8; no warnings 'utf8';\n" |
721 | . "#line 1 \"$path\"\n{\n" |
771 | . "#line 1 \"$path\"\n{\n" |
722 | . (do { local $/; <$fh> }) |
772 | . (do { local $/; <$fh> }) |
723 | . "\n};\n1"; |
773 | . "\n};\n1"; |
724 | |
774 | |
725 | eval $source |
775 | eval $source |
… | |
… | |
750 | $TERM->register_package ($_) for @pkg; |
800 | $TERM->register_package ($_) for @pkg; |
751 | } |
801 | } |
752 | |
802 | |
753 | for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
803 | for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
754 | if ($_ eq "default") { |
804 | if ($_ eq "default") { |
755 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); |
805 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline); |
756 | } elsif (/^-(.*)$/) { |
806 | } elsif (/^-(.*)$/) { |
757 | delete $ext_arg{$1}; |
807 | delete $ext_arg{$1}; |
758 | } elsif (/^([^<]+)<(.*)>$/) { |
808 | } elsif (/^([^<]+)<(.*)>$/) { |
759 | push @{ $ext_arg{$1} }, $2; |
809 | push @{ $ext_arg{$1} }, $2; |
760 | } else { |
810 | } else { |
… | |
… | |
1257 | |
1307 | |
1258 | Normally its not a good idea to use this function, as programs might be |
1308 | Normally its not a good idea to use this function, as programs might be |
1259 | confused by changes in cursor position or scrolling. Its useful inside a |
1309 | confused by changes in cursor position or scrolling. Its useful inside a |
1260 | C<on_add_lines> hook, though. |
1310 | C<on_add_lines> hook, though. |
1261 | |
1311 | |
|
|
1312 | =item $term->scr_change_screen ($screen) |
|
|
1313 | |
|
|
1314 | Switch to given screen - 0 primary, 1 secondary. |
|
|
1315 | |
1262 | =item $term->cmd_parse ($octets) |
1316 | =item $term->cmd_parse ($octets) |
1263 | |
1317 | |
1264 | Similar to C<scr_add_lines>, but the argument must be in the |
1318 | Similar to C<scr_add_lines>, but the argument must be in the |
1265 | locale-specific encoding of the terminal and can contain command sequences |
1319 | locale-specific encoding of the terminal and can contain command sequences |
1266 | (escape codes) that will be interpreted. |
1320 | (escape codes) that will be interpreted. |
… | |
… | |
1275 | |
1329 | |
1276 | Replaces the event mask of the pty watcher by the given event mask. Can |
1330 | Replaces the event mask of the pty watcher by the given event mask. Can |
1277 | be used to suppress input and output handling to the pty/tty. See the |
1331 | be used to suppress input and output handling to the pty/tty. See the |
1278 | description of C<< urxvt::timer->events >>. Make sure to always restore |
1332 | description of C<< urxvt::timer->events >>. Make sure to always restore |
1279 | the previous value. |
1333 | the previous value. |
|
|
1334 | |
|
|
1335 | =item $fd = $term->pty_fd |
|
|
1336 | |
|
|
1337 | Returns the master file descriptor for the pty in use, or C<-1> if no pty |
|
|
1338 | is used. |
1280 | |
1339 | |
1281 | =item $windowid = $term->parent |
1340 | =item $windowid = $term->parent |
1282 | |
1341 | |
1283 | Return the window id of the toplevel window. |
1342 | Return the window id of the toplevel window. |
1284 | |
1343 | |
… | |
… | |
1349 | =item $modifiermask = $term->ModNumLockMask |
1408 | =item $modifiermask = $term->ModNumLockMask |
1350 | |
1409 | |
1351 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
1410 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
1352 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1411 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1353 | |
1412 | |
|
|
1413 | =item $screen = $term->current_screen |
|
|
1414 | |
|
|
1415 | Returns the currently displayed screen (0 primary, 1 secondary). |
|
|
1416 | |
|
|
1417 | =item $cursor_is_hidden = $term->hidden_cursor |
|
|
1418 | |
|
|
1419 | Returns wether the cursor is currently hidden or not. |
|
|
1420 | |
1354 | =item $view_start = $term->view_start ([$newvalue]) |
1421 | =item $view_start = $term->view_start ([$newvalue]) |
1355 | |
1422 | |
1356 | Returns the row number of the topmost displayed line. Maximum value is |
1423 | Returns the row number of the topmost displayed line. Maximum value is |
1357 | C<0>, which displays the normal terminal contents. Lower values scroll |
1424 | C<0>, which displays the normal terminal contents. Lower values scroll |
1358 | this many lines into the scrollback buffer. |
1425 | this many lines into the scrollback buffer. |
… | |
… | |
1377 | line, starting at column C<$start_col> (default C<0>), which is useful |
1444 | line, starting at column C<$start_col> (default C<0>), which is useful |
1378 | to replace only parts of a line. The font index in the rendition will |
1445 | to replace only parts of a line. The font index in the rendition will |
1379 | automatically be updated. |
1446 | automatically be updated. |
1380 | |
1447 | |
1381 | C<$text> is in a special encoding: tabs and wide characters that use more |
1448 | C<$text> is in a special encoding: tabs and wide characters that use more |
1382 | than one cell when displayed are padded with urxvt::NOCHAR characters |
1449 | than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) |
1383 | (C<chr 65535>). Characters with combining characters and other characters |
1450 | characters. Characters with combining characters and other characters that |
1384 | that do not fit into the normal tetx encoding will be replaced with |
1451 | do not fit into the normal tetx encoding will be replaced with characters |
1385 | characters in the private use area. |
1452 | in the private use area. |
1386 | |
1453 | |
1387 | You have to obey this encoding when changing text. The advantage is |
1454 | You have to obey this encoding when changing text. The advantage is |
1388 | that C<substr> and similar functions work on screen cells and not on |
1455 | that C<substr> and similar functions work on screen cells and not on |
1389 | characters. |
1456 | characters. |
1390 | |
1457 | |
… | |
… | |
1564 | =item $term->ungrab |
1631 | =item $term->ungrab |
1565 | |
1632 | |
1566 | Calls XUngrab for the most recent grab. Is called automatically on |
1633 | Calls XUngrab for the most recent grab. Is called automatically on |
1567 | evaluation errors, as it is better to lose the grab in the error case as |
1634 | evaluation errors, as it is better to lose the grab in the error case as |
1568 | the session. |
1635 | the session. |
|
|
1636 | |
|
|
1637 | =item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) |
|
|
1638 | |
|
|
1639 | =item $atom_name = $term->XGetAtomName ($atom) |
|
|
1640 | |
|
|
1641 | =item @atoms = $term->XListProperties ($window) |
|
|
1642 | |
|
|
1643 | =item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) |
|
|
1644 | |
|
|
1645 | =item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) |
|
|
1646 | |
|
|
1647 | =item $term->XDeleteProperty ($window, $property) |
|
|
1648 | |
|
|
1649 | =item $window = $term->DefaultRootWindow |
|
|
1650 | |
|
|
1651 | =item $term->XReparentWindow ($window, $parent, [$x, $y]) |
|
|
1652 | |
|
|
1653 | =item $term->XMapWindow ($window) |
|
|
1654 | |
|
|
1655 | =item $term->XUnmapWindow ($window) |
|
|
1656 | |
|
|
1657 | =item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) |
|
|
1658 | |
|
|
1659 | =item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) |
|
|
1660 | |
|
|
1661 | =item $term->XChangeInput ($window, $add_events[, $del_events]) |
|
|
1662 | |
|
|
1663 | Various X or X-related functions. The C<$term> object only serves as |
|
|
1664 | the source of the display, otherwise those functions map more-or-less |
|
|
1665 | directory onto the X functions of the same name. |
1569 | |
1666 | |
1570 | =back |
1667 | =back |
1571 | |
1668 | |
1572 | =cut |
1669 | =cut |
1573 | |
1670 | |