… | |
… | |
91 | |
91 | |
92 | =item selection-popup (enabled by default) |
92 | =item selection-popup (enabled by default) |
93 | |
93 | |
94 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
94 | 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 |
95 | text into various other formats/action (such as uri unescaping, perl |
96 | evalution, web-browser starting etc.), depending on content. |
96 | evaluation, web-browser starting etc.), depending on content. |
97 | |
97 | |
98 | Other extensions can extend this popup menu by pushing a code reference |
98 | Other extensions can extend this popup menu by pushing a code reference |
99 | onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the |
99 | onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the |
100 | popup is displayed. |
100 | popup is displayed. |
101 | |
101 | |
… | |
… | |
127 | bottom. C<Escape> leaves search mode and returns to the point where search |
127 | 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 |
128 | 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 |
129 | additionally stores the first match in the current line into the primary |
130 | selection. |
130 | selection. |
131 | |
131 | |
|
|
132 | =item readline (enabled by default) |
|
|
133 | |
|
|
134 | A support package that tries to make editing with readline easier. At the |
|
|
135 | moment, it reacts to clicking with the left mouse button by trying to |
|
|
136 | move the text cursor to this position. It does so by generating as many |
|
|
137 | cursor-left or cursor-right keypresses as required (the this only works |
|
|
138 | for programs that correctly support wide characters). |
|
|
139 | |
|
|
140 | To avoid too many false positives, this is only done when: |
|
|
141 | |
|
|
142 | =over 4 |
|
|
143 | |
|
|
144 | =item - the mouse is on the same (multi-row-) line as the text cursor. |
|
|
145 | |
|
|
146 | =item - the primary screen is currently being displayed. |
|
|
147 | |
|
|
148 | =item - the text cursor is visible. |
|
|
149 | |
|
|
150 | =back |
|
|
151 | |
|
|
152 | The normal selection mechanism isn't disabled, so quick successive clicks |
|
|
153 | might interfere with selection creation in harmless ways. |
|
|
154 | |
132 | =item selection-autotransform |
155 | =item selection-autotransform |
133 | |
156 | |
134 | This selection allows you to do automatic transforms on a selection |
157 | This selection allows you to do automatic transforms on a selection |
135 | whenever a selection is made. |
158 | whenever a selection is made. |
136 | |
159 | |
… | |
… | |
161 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/ |
184 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/ |
162 | |
185 | |
163 | The first line tells the selection code to treat the unchanging part of |
186 | The first line tells the selection code to treat the unchanging part of |
164 | every error message as a selection pattern, and the second line transforms |
187 | every error message as a selection pattern, and the second line transforms |
165 | the message into vi commands to load the file. |
188 | the message into vi commands to load the file. |
|
|
189 | |
|
|
190 | =item tabbed |
|
|
191 | |
|
|
192 | This transforms the terminal into a tabbar with additional terminals, that |
|
|
193 | is, it implements what is commonly refered to as "tabbed terminal". The topmost line |
|
|
194 | displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one |
|
|
195 | button per tab. |
|
|
196 | |
|
|
197 | Clicking a button will activate that tab. Pressing B<Shift-Left> and |
|
|
198 | B<Shift-Right> will switch to the tab left or right of the current one, |
|
|
199 | while B<Shift-Down> creates a new tab. |
166 | |
200 | |
167 | =item mark-urls |
201 | =item mark-urls |
168 | |
202 | |
169 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
203 | Uses per-line display filtering (C<on_line_update>) to underline urls and |
170 | make them clickable. When middle-clicked, the program specified in the |
204 | make them clickable. When middle-clicked, the program specified in the |
… | |
… | |
465 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
499 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
466 | focus out processing. |
500 | focus out processing. |
467 | |
501 | |
468 | =item on_configure_notify $term, $event |
502 | =item on_configure_notify $term, $event |
469 | |
503 | |
|
|
504 | =item on_property_notify $term, $event |
|
|
505 | |
470 | =item on_key_press $term, $event, $keysym, $octets |
506 | =item on_key_press $term, $event, $keysym, $octets |
471 | |
507 | |
472 | =item on_key_release $term, $event, $keysym |
508 | =item on_key_release $term, $event, $keysym |
473 | |
509 | |
474 | =item on_button_press $term, $event |
510 | =item on_button_press $term, $event |
… | |
… | |
483 | |
519 | |
484 | Called whenever the corresponding X event is received for the terminal If |
520 | Called whenever the corresponding X event is received for the terminal If |
485 | the hook returns true, then the even will be ignored by rxvt-unicode. |
521 | the hook returns true, then the even will be ignored by rxvt-unicode. |
486 | |
522 | |
487 | The event is a hash with most values as named by Xlib (see the XEvent |
523 | The event is a hash with most values as named by Xlib (see the XEvent |
488 | manpage), with the additional members C<row> and C<col>, which are the row |
524 | manpage), with the additional members C<row> and C<col>, which are the |
489 | and column under the mouse cursor. |
525 | (real, not screen-based) row and column under the mouse cursor. |
490 | |
526 | |
491 | C<on_key_press> additionally receives the string rxvt-unicode would |
527 | C<on_key_press> additionally receives the string rxvt-unicode would |
492 | output, if any, in locale-specific encoding. |
528 | output, if any, in locale-specific encoding. |
493 | |
529 | |
494 | subwindow. |
530 | subwindow. |
|
|
531 | |
|
|
532 | =item on_client_message $term, $event |
|
|
533 | |
|
|
534 | =item on_wm_protocols $term, $event |
|
|
535 | |
|
|
536 | =item on_wm_delete_window $term, $event |
|
|
537 | |
|
|
538 | Called when various types of ClientMessage events are received (all with |
|
|
539 | format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
495 | |
540 | |
496 | =back |
541 | =back |
497 | |
542 | |
498 | =cut |
543 | =cut |
499 | |
544 | |
… | |
… | |
515 | |
560 | |
516 | our $LIBDIR; |
561 | our $LIBDIR; |
517 | our $RESNAME; |
562 | our $RESNAME; |
518 | our $RESCLASS; |
563 | our $RESCLASS; |
519 | our $RXVTNAME; |
564 | our $RXVTNAME; |
|
|
565 | |
|
|
566 | our $NOCHAR = chr 0xffff; |
520 | |
567 | |
521 | =head2 Variables in the C<urxvt> Package |
568 | =head2 Variables in the C<urxvt> Package |
522 | |
569 | |
523 | =over 4 |
570 | =over 4 |
524 | |
571 | |
… | |
… | |
671 | unless $msg =~ /\n$/; |
718 | unless $msg =~ /\n$/; |
672 | urxvt::warn ($msg); |
719 | urxvt::warn ($msg); |
673 | }; |
720 | }; |
674 | } |
721 | } |
675 | |
722 | |
|
|
723 | no warnings 'utf8'; |
|
|
724 | |
676 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
725 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
677 | |
726 | |
678 | sub verbose { |
727 | sub verbose { |
679 | my ($level, $msg) = @_; |
728 | my ($level, $msg) = @_; |
680 | warn "$msg\n" if $level <= $verbosity; |
729 | warn "$msg\n" if $level <= $verbosity; |
… | |
… | |
696 | |
745 | |
697 | open my $fh, "<:raw", $path |
746 | open my $fh, "<:raw", $path |
698 | or die "$path: $!"; |
747 | or die "$path: $!"; |
699 | |
748 | |
700 | my $source = |
749 | my $source = |
701 | "package $pkg; use strict; use utf8;\n" |
750 | "package $pkg; use strict; use utf8; no warnings 'utf8';\n" |
702 | . "#line 1 \"$path\"\n{\n" |
751 | . "#line 1 \"$path\"\n{\n" |
703 | . (do { local $/; <$fh> }) |
752 | . (do { local $/; <$fh> }) |
704 | . "\n};\n1"; |
753 | . "\n};\n1"; |
705 | |
754 | |
706 | eval $source |
755 | eval $source |
… | |
… | |
731 | $TERM->register_package ($_) for @pkg; |
780 | $TERM->register_package ($_) for @pkg; |
732 | } |
781 | } |
733 | |
782 | |
734 | for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
783 | for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
735 | if ($_ eq "default") { |
784 | if ($_ eq "default") { |
736 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); |
785 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline); |
737 | } elsif (/^-(.*)$/) { |
786 | } elsif (/^-(.*)$/) { |
738 | delete $ext_arg{$1}; |
787 | delete $ext_arg{$1}; |
739 | } elsif (/^([^<]+)<(.*)>$/) { |
788 | } elsif (/^([^<]+)<(.*)>$/) { |
740 | push @{ $ext_arg{$1} }, $2; |
789 | push @{ $ext_arg{$1} }, $2; |
741 | } else { |
790 | } else { |
… | |
… | |
1238 | |
1287 | |
1239 | Normally its not a good idea to use this function, as programs might be |
1288 | Normally its not a good idea to use this function, as programs might be |
1240 | confused by changes in cursor position or scrolling. Its useful inside a |
1289 | confused by changes in cursor position or scrolling. Its useful inside a |
1241 | C<on_add_lines> hook, though. |
1290 | C<on_add_lines> hook, though. |
1242 | |
1291 | |
|
|
1292 | =item $term->scr_change_screen ($screen) |
|
|
1293 | |
|
|
1294 | Switch to given screen - 0 primary, 1 secondary. |
|
|
1295 | |
1243 | =item $term->cmd_parse ($octets) |
1296 | =item $term->cmd_parse ($octets) |
1244 | |
1297 | |
1245 | Similar to C<scr_add_lines>, but the argument must be in the |
1298 | Similar to C<scr_add_lines>, but the argument must be in the |
1246 | locale-specific encoding of the terminal and can contain command sequences |
1299 | locale-specific encoding of the terminal and can contain command sequences |
1247 | (escape codes) that will be interpreted. |
1300 | (escape codes) that will be interpreted. |
… | |
… | |
1330 | =item $modifiermask = $term->ModNumLockMask |
1383 | =item $modifiermask = $term->ModNumLockMask |
1331 | |
1384 | |
1332 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
1385 | Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
1333 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1386 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1334 | |
1387 | |
|
|
1388 | =item $screen = $term->current_screen |
|
|
1389 | |
|
|
1390 | Returns the currently displayed screen (0 primary, 1 secondary). |
|
|
1391 | |
|
|
1392 | =item $cursor_is_hidden = $term->hidden_cursor |
|
|
1393 | |
|
|
1394 | Returns wether the cursor is currently hidden or not. |
|
|
1395 | |
1335 | =item $view_start = $term->view_start ([$newvalue]) |
1396 | =item $view_start = $term->view_start ([$newvalue]) |
1336 | |
1397 | |
1337 | Returns the row number of the topmost displayed line. Maximum value is |
1398 | Returns the row number of the topmost displayed line. Maximum value is |
1338 | C<0>, which displays the normal terminal contents. Lower values scroll |
1399 | C<0>, which displays the normal terminal contents. Lower values scroll |
1339 | this many lines into the scrollback buffer. |
1400 | this many lines into the scrollback buffer. |
… | |
… | |
1358 | line, starting at column C<$start_col> (default C<0>), which is useful |
1419 | line, starting at column C<$start_col> (default C<0>), which is useful |
1359 | to replace only parts of a line. The font index in the rendition will |
1420 | to replace only parts of a line. The font index in the rendition will |
1360 | automatically be updated. |
1421 | automatically be updated. |
1361 | |
1422 | |
1362 | C<$text> is in a special encoding: tabs and wide characters that use more |
1423 | C<$text> is in a special encoding: tabs and wide characters that use more |
1363 | than one cell when displayed are padded with urxvt::NOCHAR characters |
1424 | than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) |
1364 | (C<chr 65535>). Characters with combining characters and other characters |
1425 | characters. Characters with combining characters and other characters that |
1365 | that do not fit into the normal tetx encoding will be replaced with |
1426 | do not fit into the normal tetx encoding will be replaced with characters |
1366 | characters in the private use area. |
1427 | in the private use area. |
1367 | |
1428 | |
1368 | You have to obey this encoding when changing text. The advantage is |
1429 | You have to obey this encoding when changing text. The advantage is |
1369 | that C<substr> and similar functions work on screen cells and not on |
1430 | that C<substr> and similar functions work on screen cells and not on |
1370 | characters. |
1431 | characters. |
1371 | |
1432 | |
… | |
… | |
1545 | =item $term->ungrab |
1606 | =item $term->ungrab |
1546 | |
1607 | |
1547 | Calls XUngrab for the most recent grab. Is called automatically on |
1608 | Calls XUngrab for the most recent grab. Is called automatically on |
1548 | evaluation errors, as it is better to lose the grab in the error case as |
1609 | evaluation errors, as it is better to lose the grab in the error case as |
1549 | the session. |
1610 | the session. |
|
|
1611 | |
|
|
1612 | =item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) |
|
|
1613 | |
|
|
1614 | =item $atom_name = $term->XGetAtomName ($atom) |
|
|
1615 | |
|
|
1616 | =item @atoms = $term->XListProperties ($window) |
|
|
1617 | |
|
|
1618 | =item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) |
|
|
1619 | |
|
|
1620 | =item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) |
|
|
1621 | |
|
|
1622 | =item $term->XDeleteProperty ($window, $property) |
|
|
1623 | |
|
|
1624 | =item $window = $term->DefaultRootWindow |
|
|
1625 | |
|
|
1626 | =item $term->XReparentWindow ($window, $parent, [$x, $y]) |
|
|
1627 | |
|
|
1628 | =item $term->XMapWindow ($window) |
|
|
1629 | |
|
|
1630 | =item $term->XUnmapWindow ($window) |
|
|
1631 | |
|
|
1632 | =item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) |
|
|
1633 | |
|
|
1634 | =item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) |
|
|
1635 | |
|
|
1636 | =item $term->XChangeInput ($window, $add_events[, $del_events]) |
|
|
1637 | |
|
|
1638 | Various X or X-related functions. The C<$term> object only serves as |
|
|
1639 | the source of the display, otherwise those functions map more-or-less |
|
|
1640 | directory onto the X functions of the same name. |
1550 | |
1641 | |
1551 | =back |
1642 | =back |
1552 | |
1643 | |
1553 | =cut |
1644 | =cut |
1554 | |
1645 | |
… | |
… | |
1790 | |
1881 | |
1791 | Stop watching for events on the given filehandle. |
1882 | Stop watching for events on the given filehandle. |
1792 | |
1883 | |
1793 | =back |
1884 | =back |
1794 | |
1885 | |
|
|
1886 | =head2 The C<urxvt::iw> Class |
|
|
1887 | |
|
|
1888 | This class implements idle watchers, that get called automatically when |
|
|
1889 | the process is idle. They should return as fast as possible, after doing |
|
|
1890 | some useful work. |
|
|
1891 | |
|
|
1892 | =over 4 |
|
|
1893 | |
|
|
1894 | =item $iw = new urxvt::iw |
|
|
1895 | |
|
|
1896 | Create a new idle watcher object in stopped state. |
|
|
1897 | |
|
|
1898 | =item $iw = $iw->cb (sub { my ($iw) = @_; ... }) |
|
|
1899 | |
|
|
1900 | Set the callback to be called when the watcher triggers. |
|
|
1901 | |
|
|
1902 | =item $timer = $timer->start |
|
|
1903 | |
|
|
1904 | Start the watcher. |
|
|
1905 | |
|
|
1906 | =item $timer = $timer->stop |
|
|
1907 | |
|
|
1908 | Stop the watcher. |
|
|
1909 | |
|
|
1910 | =back |
|
|
1911 | |
|
|
1912 | =head2 The C<urxvt::pw> Class |
|
|
1913 | |
|
|
1914 | This class implements process watchers. They create an event whenever a |
|
|
1915 | process exits, after which they stop automatically. |
|
|
1916 | |
|
|
1917 | my $pid = fork; |
|
|
1918 | ... |
|
|
1919 | $term->{pw} = urxvt::pw |
|
|
1920 | ->new |
|
|
1921 | ->start ($pid) |
|
|
1922 | ->cb (sub { |
|
|
1923 | my ($pw, $exit_status) = @_; |
|
|
1924 | ... |
|
|
1925 | }); |
|
|
1926 | |
|
|
1927 | =over 4 |
|
|
1928 | |
|
|
1929 | =item $pw = new urxvt::pw |
|
|
1930 | |
|
|
1931 | Create a new process watcher in stopped state. |
|
|
1932 | |
|
|
1933 | =item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... }) |
|
|
1934 | |
|
|
1935 | Set the callback to be called when the timer triggers. |
|
|
1936 | |
|
|
1937 | =item $pw = $timer->start ($pid) |
|
|
1938 | |
|
|
1939 | Tells the wqtcher to start watching for process C<$pid>. |
|
|
1940 | |
|
|
1941 | =item $pw = $pw->stop |
|
|
1942 | |
|
|
1943 | Stop the watcher. |
|
|
1944 | |
|
|
1945 | =back |
|
|
1946 | |
1795 | =head1 ENVIRONMENT |
1947 | =head1 ENVIRONMENT |
1796 | |
1948 | |
1797 | =head2 URXVT_PERL_VERBOSITY |
1949 | =head2 URXVT_PERL_VERBOSITY |
1798 | |
1950 | |
1799 | This variable controls the verbosity level of the perl extension. Higher |
1951 | This variable controls the verbosity level of the perl extension. Higher |