| … | |
… | |
| 341 | URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' |
341 | URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' |
| 342 | URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' |
342 | URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' |
| 343 | |
343 | |
| 344 | =item selection-pastebin |
344 | =item selection-pastebin |
| 345 | |
345 | |
| 346 | This is a little rarely useful extension that Uploads the selection as |
346 | This is a little rarely useful extension that uploads the selection as |
| 347 | textfile to a remote site (or does other things). (The implementation is |
347 | textfile to a remote site (or does other things). (The implementation is |
| 348 | not currently secure for use in a multiuser environment as it writes to |
348 | not currently secure for use in a multiuser environment as it writes to |
| 349 | F</tmp> directly.). |
349 | F</tmp> directly.). |
| 350 | |
350 | |
| 351 | It listens to the C<selection-pastebin:remote-pastebin> keyboard command, |
351 | It listens to the C<selection-pastebin:remote-pastebin> keyboard command, |
| … | |
… | |
| 370 | |
370 | |
| 371 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
371 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
| 372 | |
372 | |
| 373 | I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret |
373 | I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret |
| 374 | the double C</> characters as comment start. Use C<\057\057> instead, |
374 | the double C</> characters as comment start. Use C<\057\057> instead, |
| 375 | which works regardless of wether xrdb is used to parse the resource file |
375 | which works regardless of whether xrdb is used to parse the resource file |
| 376 | or not. |
376 | or not. |
| 377 | |
377 | |
| 378 | =item macosx-pastebin and macosx-pastebin-native |
378 | =item macosx-clipboard and macosx-clipboard-native |
| 379 | |
379 | |
| 380 | These two modules implement an extended clipboard for Mac OS X. They are |
380 | These two modules implement an extended clipboard for Mac OS X. They are |
| 381 | used like this: |
381 | used like this: |
| 382 | |
382 | |
| 383 | URxvt.perl-ext-common: default,macosx-clipboard |
383 | URxvt.perl-ext-common: default,macosx-clipboard |
| 384 | URxvt.keysym.M-c: perl:macosx-clipboard:copy |
384 | URxvt.keysym.M-c: perl:macosx-clipboard:copy |
| 385 | URxvt.keysym.M-v: perl:macosx-clipboard:paste |
385 | URxvt.keysym.M-v: perl:macosx-clipboard:paste |
| 386 | |
386 | |
| 387 | The difference between them is that the native variant requires a |
387 | The difference between them is that the native variant requires a |
| 388 | perl from apple's devkit or so, and C<maxosx-pastebin> requires the |
388 | perl from apple's devkit or so, and C<macosx-clipboard> requires the |
| 389 | C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is |
389 | C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is |
| 390 | simpler etc. etc. |
390 | simpler etc. etc. |
| 391 | |
391 | |
| 392 | =item example-refresh-hooks |
392 | =item example-refresh-hooks |
| 393 | |
393 | |
| … | |
… | |
| 417 | |
417 | |
| 418 | =over 4 |
418 | =over 4 |
| 419 | |
419 | |
| 420 | =item $text |
420 | =item $text |
| 421 | |
421 | |
| 422 | Rxvt-unicodes special way of encoding text, where one "unicode" character |
422 | Rxvt-unicode's special way of encoding text, where one "unicode" character |
| 423 | always represents one screen cell. See L<ROW_t> for a discussion of this format. |
423 | always represents one screen cell. See L<ROW_t> for a discussion of this format. |
| 424 | |
424 | |
| 425 | =item $string |
425 | =item $string |
| 426 | |
426 | |
| 427 | A perl text string, with an emphasis on I<text>. It can store all unicode |
427 | A perl text string, with an emphasis on I<text>. It can store all unicode |
| … | |
… | |
| 610 | =item on_tt_write $term, $octets |
610 | =item on_tt_write $term, $octets |
| 611 | |
611 | |
| 612 | Called whenever some data is written to the tty/pty and can be used to |
612 | Called whenever some data is written to the tty/pty and can be used to |
| 613 | suppress or filter tty input. |
613 | suppress or filter tty input. |
| 614 | |
614 | |
|
|
615 | =item on_tt_paste $term, $octets |
|
|
616 | |
|
|
617 | Called whenever text is about to be pasted, with the text as argument. You |
|
|
618 | can filter/change and paste the text yourself by returning a true value |
|
|
619 | and calling C<< $term->tt_paste >> yourself. C<$octets> is |
|
|
620 | locale-encoded. |
|
|
621 | |
| 615 | =item on_line_update $term, $row |
622 | =item on_line_update $term, $row |
| 616 | |
623 | |
| 617 | Called whenever a line was updated or changed. Can be used to filter |
624 | Called whenever a line was updated or changed. Can be used to filter |
| 618 | screen output (e.g. underline urls or other useless stuff). Only lines |
625 | screen output (e.g. underline urls or other useless stuff). Only lines |
| 619 | that are being shown will be filtered, and, due to performance reasons, |
626 | that are being shown will be filtered, and, due to performance reasons, |
| … | |
… | |
| 644 | resource in the @@RXVT_NAME@@(1) manpage). |
651 | resource in the @@RXVT_NAME@@(1) manpage). |
| 645 | |
652 | |
| 646 | The event is simply the action string. This interface is assumed to change |
653 | The event is simply the action string. This interface is assumed to change |
| 647 | slightly in the future. |
654 | slightly in the future. |
| 648 | |
655 | |
| 649 | =item on_resize_all_windows $tern, $new_width, $new_height |
656 | =item on_resize_all_windows $term, $new_width, $new_height |
| 650 | |
657 | |
| 651 | Called just after the new window size has been calculated, but before |
658 | Called just after the new window size has been calculated, but before |
| 652 | windows are actually being resized or hints are being set. If this hook |
659 | windows are actually being resized or hints are being set. If this hook |
| 653 | returns TRUE, setting of the window hints is being skipped. |
660 | returns TRUE, setting of the window hints is being skipped. |
| 654 | |
661 | |
| … | |
… | |
| 688 | |
695 | |
| 689 | =item on_map_notify $term, $event |
696 | =item on_map_notify $term, $event |
| 690 | |
697 | |
| 691 | =item on_unmap_notify $term, $event |
698 | =item on_unmap_notify $term, $event |
| 692 | |
699 | |
| 693 | Called whenever the corresponding X event is received for the terminal If |
700 | Called whenever the corresponding X event is received for the terminal. If |
| 694 | the hook returns true, then the even will be ignored by rxvt-unicode. |
701 | the hook returns true, then the event will be ignored by rxvt-unicode. |
| 695 | |
702 | |
| 696 | The event is a hash with most values as named by Xlib (see the XEvent |
703 | The event is a hash with most values as named by Xlib (see the XEvent |
| 697 | manpage), with the additional members C<row> and C<col>, which are the |
704 | manpage), with the additional members C<row> and C<col>, which are the |
| 698 | (real, not screen-based) row and column under the mouse cursor. |
705 | (real, not screen-based) row and column under the mouse cursor. |
| 699 | |
706 | |
| … | |
… | |
| 708 | |
715 | |
| 709 | =item on_wm_delete_window $term, $event |
716 | =item on_wm_delete_window $term, $event |
| 710 | |
717 | |
| 711 | Called when various types of ClientMessage events are received (all with |
718 | Called when various types of ClientMessage events are received (all with |
| 712 | format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
719 | format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
|
|
720 | |
|
|
721 | =item on_bell $term |
|
|
722 | |
|
|
723 | Called on receipt of a bell character. |
| 713 | |
724 | |
| 714 | =back |
725 | =back |
| 715 | |
726 | |
| 716 | =cut |
727 | =cut |
| 717 | |
728 | |
| … | |
… | |
| 1124 | is that you cannot use blocking APIs, but the non-blocking variant should |
1135 | is that you cannot use blocking APIs, but the non-blocking variant should |
| 1125 | work. |
1136 | work. |
| 1126 | |
1137 | |
| 1127 | =cut |
1138 | =cut |
| 1128 | |
1139 | |
| 1129 | our $VERSION = '3.4'; |
1140 | our $VERSION = '5.23'; |
| 1130 | |
1141 | |
| 1131 | $INC{"urxvt/anyevent.pm"} = 1; # mark us as there |
1142 | $INC{"urxvt/anyevent.pm"} = 1; # mark us as there |
| 1132 | push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; |
1143 | push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; |
| 1133 | |
1144 | |
| 1134 | sub timer { |
1145 | sub timer { |
| … | |
… | |
| 1136 | |
1147 | |
| 1137 | my $cb = $arg{cb}; |
1148 | my $cb = $arg{cb}; |
| 1138 | |
1149 | |
| 1139 | urxvt::timer |
1150 | urxvt::timer |
| 1140 | ->new |
1151 | ->new |
| 1141 | ->after ($arg{after}) |
1152 | ->after ($arg{after}, $arg{interval}) |
| 1142 | ->interval ($arg{interval}) |
1153 | ->cb ($arg{interval} ? $cb : sub { |
| 1143 | ->start |
|
|
| 1144 | ->cb (sub { |
|
|
| 1145 | #TODO interval? |
|
|
| 1146 | $_[0]->stop; # need to cancel manually |
1154 | $_[0]->stop; # need to cancel manually |
| 1147 | $cb->(); |
1155 | $cb->(); |
| 1148 | }) |
1156 | }) |
| 1149 | } |
1157 | } |
| 1150 | |
1158 | |
| … | |
… | |
| 1155 | my $fd = fileno $arg{fh}; |
1163 | my $fd = fileno $arg{fh}; |
| 1156 | defined $fd or $fd = $arg{fh}; |
1164 | defined $fd or $fd = $arg{fh}; |
| 1157 | |
1165 | |
| 1158 | bless [$arg{fh}, urxvt::iow |
1166 | bless [$arg{fh}, urxvt::iow |
| 1159 | ->new |
1167 | ->new |
| 1160 | ->fd (defined fileno $arg{fh}) |
1168 | ->fd ($fd) |
| 1161 | ->events (($arg{poll} =~ /r/ ? 1 : 0) |
1169 | ->events (($arg{poll} =~ /r/ ? 1 : 0) |
| 1162 | | ($arg{poll} =~ /w/ ? 2 : 0)) |
1170 | | ($arg{poll} =~ /w/ ? 2 : 0)) |
| 1163 | ->start |
1171 | ->start |
| 1164 | ->cb ($cb) |
1172 | ->cb ($cb) |
| 1165 | ], urxvt::anyevent:: |
1173 | ], urxvt::anyevent:: |
| … | |
… | |
| 1171 | my $cb = $arg{cb}; |
1179 | my $cb = $arg{cb}; |
| 1172 | |
1180 | |
| 1173 | urxvt::iw |
1181 | urxvt::iw |
| 1174 | ->new |
1182 | ->new |
| 1175 | ->start |
1183 | ->start |
| 1176 | ->cb (sub { |
1184 | ->cb ($cb) |
| 1177 | #TODO really cancel? |
|
|
| 1178 | $_[0]->stop; # need to cancel manually |
|
|
| 1179 | $cb->(); |
|
|
| 1180 | }) |
|
|
| 1181 | } |
1185 | } |
| 1182 | |
1186 | |
| 1183 | sub child { |
1187 | sub child { |
| 1184 | my ($class, %arg) = @_; |
1188 | my ($class, %arg) = @_; |
| 1185 | |
1189 | |
| … | |
… | |
| 1187 | |
1191 | |
| 1188 | urxvt::pw |
1192 | urxvt::pw |
| 1189 | ->new |
1193 | ->new |
| 1190 | ->start ($arg{pid}) |
1194 | ->start ($arg{pid}) |
| 1191 | ->cb (sub { |
1195 | ->cb (sub { |
| 1192 | #TODO really cancel? |
|
|
| 1193 | $_[0]->stop; # need to cancel manually |
1196 | $_[0]->stop; # need to cancel manually |
| 1194 | $cb->($_[0]->rpid, $_[0]->rstatus); |
1197 | $cb->($_[0]->rpid, $_[0]->rstatus); |
| 1195 | }) |
1198 | }) |
| 1196 | } |
1199 | } |
| 1197 | |
1200 | |
| … | |
… | |
| 1380 | |
1383 | |
| 1381 | =item ($row, $col) = $term->selection_beg ([$row, $col]) |
1384 | =item ($row, $col) = $term->selection_beg ([$row, $col]) |
| 1382 | |
1385 | |
| 1383 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
1386 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
| 1384 | |
1387 | |
| 1385 | Return the current values of the selection mark, begin or end positions, |
1388 | Return the current values of the selection mark, begin or end positions. |
| 1386 | and optionally set them to new values. |
1389 | |
|
|
1390 | When arguments are given, then the selection coordinates are set to |
|
|
1391 | C<$row> and C<$col>, and the selection screen is set to the current |
|
|
1392 | screen. |
|
|
1393 | |
|
|
1394 | =item $screen = $term->selection_screen ([$screen]) |
|
|
1395 | |
|
|
1396 | Returns the current selection screen, and then optionally sets it. |
| 1387 | |
1397 | |
| 1388 | =item $term->selection_make ($eventtime[, $rectangular]) |
1398 | =item $term->selection_make ($eventtime[, $rectangular]) |
| 1389 | |
1399 | |
| 1390 | Tries to make a selection as set by C<selection_beg> and |
1400 | Tries to make a selection as set by C<selection_beg> and |
| 1391 | C<selection_end>. If C<$rectangular> is true (default: false), a |
1401 | C<selection_end>. If C<$rectangular> is true (default: false), a |
| 1392 | rectangular selection will be made. This is the prefered function to make |
1402 | rectangular selection will be made. This is the preferred function to make |
| 1393 | a selection. |
1403 | a selection. |
| 1394 | |
1404 | |
| 1395 | =item $success = $term->selection_grab ($eventtime) |
1405 | =item $success = $term->selection_grab ($eventtime[, $clipboard]) |
| 1396 | |
1406 | |
| 1397 | Try to request the primary selection text from the server (for example, as |
1407 | Try to acquire ownership of the primary (clipboard if C<$clipboard> is |
|
|
1408 | true) selection from the server. The corresponding text can be set |
| 1398 | set by the next method). No visual feedback will be given. This function |
1409 | with the next method. No visual feedback will be given. This function |
| 1399 | is mostly useful from within C<on_sel_grab> hooks. |
1410 | is mostly useful from within C<on_sel_grab> hooks. |
| 1400 | |
1411 | |
| 1401 | =item $oldtext = $term->selection ([$newtext]) |
1412 | =item $oldtext = $term->selection ([$newtext, $clipboard]) |
| 1402 | |
1413 | |
| 1403 | Return the current selection text and optionally replace it by C<$newtext>. |
1414 | Return the current selection (clipboard if C<$clipboard> is true) text |
|
|
1415 | and optionally replace it by C<$newtext>. |
|
|
1416 | |
|
|
1417 | =item $term->selection_clear ([$clipboard]) |
|
|
1418 | |
|
|
1419 | Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection. |
| 1404 | |
1420 | |
| 1405 | =item $term->overlay_simple ($x, $y, $text) |
1421 | =item $term->overlay_simple ($x, $y, $text) |
| 1406 | |
1422 | |
| 1407 | Create a simple multi-line overlay box. See the next method for details. |
1423 | Create a simple multi-line overlay box. See the next method for details. |
| 1408 | |
1424 | |
| … | |
… | |
| 1536 | locale-specific encoding of the terminal and can contain command sequences |
1552 | locale-specific encoding of the terminal and can contain command sequences |
| 1537 | (escape codes) that will be interpreted. |
1553 | (escape codes) that will be interpreted. |
| 1538 | |
1554 | |
| 1539 | =item $term->tt_write ($octets) |
1555 | =item $term->tt_write ($octets) |
| 1540 | |
1556 | |
| 1541 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
1557 | Write the octets given in C<$octets> to the tty (i.e. as program input). To |
| 1542 | pass characters instead of octets, you should convert your strings first |
1558 | pass characters instead of octets, you should convert your strings first |
| 1543 | to the locale-specific encoding using C<< $term->locale_encode >>. |
1559 | to the locale-specific encoding using C<< $term->locale_encode >>. |
|
|
1560 | |
|
|
1561 | =item $term->tt_paste ($octets) |
|
|
1562 | |
|
|
1563 | Write the octets given in C<$octets> to the tty as a paste, converting NL to |
|
|
1564 | CR and bracketing the data with control sequences if bracketed paste mode |
|
|
1565 | is set. |
| 1544 | |
1566 | |
| 1545 | =item $old_events = $term->pty_ev_events ([$new_events]) |
1567 | =item $old_events = $term->pty_ev_events ([$new_events]) |
| 1546 | |
1568 | |
| 1547 | Replaces the event mask of the pty watcher by the given event mask. Can |
1569 | Replaces the event mask of the pty watcher by the given event mask. Can |
| 1548 | be used to suppress input and output handling to the pty/tty. See the |
1570 | be used to suppress input and output handling to the pty/tty. See the |
| … | |
… | |
| 1862 | Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most |
1884 | Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most |
| 1863 | recent grab. |
1885 | recent grab. |
| 1864 | |
1886 | |
| 1865 | =item $term->ungrab |
1887 | =item $term->ungrab |
| 1866 | |
1888 | |
| 1867 | Calls XUngrab for the most recent grab. Is called automatically on |
1889 | Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on |
| 1868 | evaluation errors, as it is better to lose the grab in the error case as |
1890 | evaluation errors, as it is better to lose the grab in the error case as |
| 1869 | the session. |
1891 | the session. |
| 1870 | |
1892 | |
| 1871 | =item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) |
1893 | =item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) |
| 1872 | |
1894 | |
| … | |
… | |
| 1894 | |
1916 | |
| 1895 | =item $term->XChangeInput ($window, $add_events[, $del_events]) |
1917 | =item $term->XChangeInput ($window, $add_events[, $del_events]) |
| 1896 | |
1918 | |
| 1897 | Various X or X-related functions. The C<$term> object only serves as |
1919 | Various X or X-related functions. The C<$term> object only serves as |
| 1898 | the source of the display, otherwise those functions map more-or-less |
1920 | the source of the display, otherwise those functions map more-or-less |
| 1899 | directory onto the X functions of the same name. |
1921 | directly onto the X functions of the same name. |
| 1900 | |
1922 | |
| 1901 | =back |
1923 | =back |
| 1902 | |
1924 | |
| 1903 | =cut |
1925 | =cut |
| 1904 | |
1926 | |
| … | |
… | |
| 2061 | |
2083 | |
| 2062 | =item $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
2084 | =item $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
| 2063 | |
2085 | |
| 2064 | Set the callback to be called when the timer triggers. |
2086 | Set the callback to be called when the timer triggers. |
| 2065 | |
2087 | |
| 2066 | =item $tstamp = $timer->at |
|
|
| 2067 | |
|
|
| 2068 | Return the time this watcher will fire next. |
|
|
| 2069 | |
|
|
| 2070 | =item $timer = $timer->set ($tstamp) |
2088 | =item $timer = $timer->set ($tstamp[, $interval]) |
| 2071 | |
2089 | |
| 2072 | Set the time the event is generated to $tstamp. |
2090 | Set the time the event is generated to $tstamp (and optionally specifies a |
|
|
2091 | new $interval). |
| 2073 | |
2092 | |
| 2074 | =item $timer = $timer->interval ($interval) |
2093 | =item $timer = $timer->interval ($interval) |
| 2075 | |
2094 | |
| 2076 | Normally (and when C<$interval> is C<0>), the timer will automatically |
2095 | By default (and when C<$interval> is C<0>), the timer will automatically |
| 2077 | stop after it has fired once. If C<$interval> is non-zero, then the timer |
2096 | stop after it has fired once. If C<$interval> is non-zero, then the timer |
| 2078 | is automatically rescheduled at the given intervals. |
2097 | is automatically rescheduled at the given intervals. |
| 2079 | |
2098 | |
| 2080 | =item $timer = $timer->start |
2099 | =item $timer = $timer->start |
| 2081 | |
2100 | |
| 2082 | Start the timer. |
2101 | Start the timer. |
| 2083 | |
2102 | |
| 2084 | =item $timer = $timer->start ($tstamp) |
2103 | =item $timer = $timer->start ($tstamp[, $interval]) |
| 2085 | |
2104 | |
| 2086 | Set the event trigger time to C<$tstamp> and start the timer. |
2105 | Set the event trigger time to C<$tstamp> and start the timer. Optionally |
|
|
2106 | also replaces the interval. |
| 2087 | |
2107 | |
| 2088 | =item $timer = $timer->after ($delay) |
2108 | =item $timer = $timer->after ($delay[, $interval]) |
| 2089 | |
2109 | |
| 2090 | Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. |
2110 | Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. |
| 2091 | |
2111 | |
| 2092 | =item $timer = $timer->stop |
2112 | =item $timer = $timer->stop |
| 2093 | |
2113 | |
