| … | |
… | |
| 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 | |
| 394 | Displays a very simple digital clock in the upper right corner of the |
394 | Displays a very simple digital clock in the upper right corner of the |
| 395 | window. Illustrates overwriting the refresh callbacks to create your own |
395 | window. Illustrates overwriting the refresh callbacks to create your own |
| 396 | overlays or changes. |
396 | overlays or changes. |
|
|
397 | |
|
|
398 | =item confirm-paste |
|
|
399 | |
|
|
400 | Displays a confirmation dialog when a paste containing at least a full |
|
|
401 | line is detected. |
| 397 | |
402 | |
| 398 | =back |
403 | =back |
| 399 | |
404 | |
| 400 | =head1 API DOCUMENTATION |
405 | =head1 API DOCUMENTATION |
| 401 | |
406 | |
| … | |
… | |
| 417 | |
422 | |
| 418 | =over 4 |
423 | =over 4 |
| 419 | |
424 | |
| 420 | =item $text |
425 | =item $text |
| 421 | |
426 | |
| 422 | Rxvt-unicodes special way of encoding text, where one "unicode" character |
427 | 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. |
428 | always represents one screen cell. See L<ROW_t> for a discussion of this format. |
| 424 | |
429 | |
| 425 | =item $string |
430 | =item $string |
| 426 | |
431 | |
| 427 | A perl text string, with an emphasis on I<text>. It can store all unicode |
432 | A perl text string, with an emphasis on I<text>. It can store all unicode |
| … | |
… | |
| 610 | =item on_tt_write $term, $octets |
615 | =item on_tt_write $term, $octets |
| 611 | |
616 | |
| 612 | Called whenever some data is written to the tty/pty and can be used to |
617 | Called whenever some data is written to the tty/pty and can be used to |
| 613 | suppress or filter tty input. |
618 | suppress or filter tty input. |
| 614 | |
619 | |
|
|
620 | =item on_tt_paste $term, $octets |
|
|
621 | |
|
|
622 | Called whenever text is about to be pasted, with the text as argument. You |
|
|
623 | can filter/change and paste the text yourself by returning a true value |
|
|
624 | and calling C<< $term->tt_paste >> yourself. C<$octets> is |
|
|
625 | locale-encoded. |
|
|
626 | |
| 615 | =item on_line_update $term, $row |
627 | =item on_line_update $term, $row |
| 616 | |
628 | |
| 617 | Called whenever a line was updated or changed. Can be used to filter |
629 | 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 |
630 | 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, |
631 | that are being shown will be filtered, and, due to performance reasons, |
| … | |
… | |
| 644 | resource in the @@RXVT_NAME@@(1) manpage). |
656 | resource in the @@RXVT_NAME@@(1) manpage). |
| 645 | |
657 | |
| 646 | The event is simply the action string. This interface is assumed to change |
658 | The event is simply the action string. This interface is assumed to change |
| 647 | slightly in the future. |
659 | slightly in the future. |
| 648 | |
660 | |
| 649 | =item on_resize_all_windows $tern, $new_width, $new_height |
661 | =item on_resize_all_windows $term, $new_width, $new_height |
| 650 | |
662 | |
| 651 | Called just after the new window size has been calculated, but before |
663 | 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 |
664 | windows are actually being resized or hints are being set. If this hook |
| 653 | returns TRUE, setting of the window hints is being skipped. |
665 | returns TRUE, setting of the window hints is being skipped. |
| 654 | |
666 | |
| … | |
… | |
| 688 | |
700 | |
| 689 | =item on_map_notify $term, $event |
701 | =item on_map_notify $term, $event |
| 690 | |
702 | |
| 691 | =item on_unmap_notify $term, $event |
703 | =item on_unmap_notify $term, $event |
| 692 | |
704 | |
| 693 | Called whenever the corresponding X event is received for the terminal If |
705 | 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. |
706 | the hook returns true, then the event will be ignored by rxvt-unicode. |
| 695 | |
707 | |
| 696 | The event is a hash with most values as named by Xlib (see the XEvent |
708 | 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 |
709 | 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. |
710 | (real, not screen-based) row and column under the mouse cursor. |
| 699 | |
711 | |
| … | |
… | |
| 708 | |
720 | |
| 709 | =item on_wm_delete_window $term, $event |
721 | =item on_wm_delete_window $term, $event |
| 710 | |
722 | |
| 711 | Called when various types of ClientMessage events are received (all with |
723 | Called when various types of ClientMessage events are received (all with |
| 712 | format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
724 | format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
|
|
725 | |
|
|
726 | =item on_bell $term |
|
|
727 | |
|
|
728 | Called on receipt of a bell character. |
| 713 | |
729 | |
| 714 | =back |
730 | =back |
| 715 | |
731 | |
| 716 | =cut |
732 | =cut |
| 717 | |
733 | |
| … | |
… | |
| 782 | |
798 | |
| 783 | =over 4 |
799 | =over 4 |
| 784 | |
800 | |
| 785 | =item urxvt::fatal $errormessage |
801 | =item urxvt::fatal $errormessage |
| 786 | |
802 | |
| 787 | Fatally aborts execution with the given error message. Avoid at all |
803 | Fatally aborts execution with the given error message (which should |
| 788 | costs! The only time this is acceptable is when the terminal process |
804 | include a trailing newline). Avoid at all costs! The only time this |
| 789 | starts up. |
805 | is acceptable (and useful) is in the init hook, where it prevents the |
|
|
806 | temrinal from starting up. |
| 790 | |
807 | |
| 791 | =item urxvt::warn $string |
808 | =item urxvt::warn $string |
| 792 | |
809 | |
| 793 | Calls C<rxvt_warn> with the given string which should not include a |
810 | Calls C<rxvt_warn> with the given string which should include a trailing |
| 794 | newline. The module also overwrites the C<warn> builtin with a function |
811 | newline. The module also overwrites the C<warn> builtin with a function |
| 795 | that calls this function. |
812 | that calls this function. |
| 796 | |
813 | |
| 797 | Using this function has the advantage that its output ends up in the |
814 | Using this function has the advantage that its output ends up in the |
| 798 | correct place, e.g. on stderr of the connecting urxvtc client. |
815 | correct place, e.g. on stderr of the connecting urxvtc client. |
| … | |
… | |
| 855 | |
872 | |
| 856 | =item $rend = urxvt::OVERLAY_RSTYLE |
873 | =item $rend = urxvt::OVERLAY_RSTYLE |
| 857 | |
874 | |
| 858 | Return the rendition mask used for overlays by default. |
875 | Return the rendition mask used for overlays by default. |
| 859 | |
876 | |
| 860 | =item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline |
877 | =item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink, |
|
|
878 | urxvt::RS_RVid, urxvt::RS_Uline |
| 861 | |
879 | |
| 862 | Return the bit that enabled bold, italic, blink, reverse-video and |
880 | Return the bit that enabled bold, italic, blink, reverse-video and |
| 863 | underline, respectively. To enable such a style, just logically OR it into |
881 | underline, respectively. To enable such a style, just logically OR it into |
| 864 | the bitset. |
882 | the bitset. |
| 865 | |
883 | |
| … | |
… | |
| 1372 | |
1390 | |
| 1373 | =item ($row, $col) = $term->selection_beg ([$row, $col]) |
1391 | =item ($row, $col) = $term->selection_beg ([$row, $col]) |
| 1374 | |
1392 | |
| 1375 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
1393 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
| 1376 | |
1394 | |
| 1377 | Return the current values of the selection mark, begin or end positions, |
1395 | Return the current values of the selection mark, begin or end positions. |
| 1378 | and optionally set them to new values. |
1396 | |
|
|
1397 | When arguments are given, then the selection coordinates are set to |
|
|
1398 | C<$row> and C<$col>, and the selection screen is set to the current |
|
|
1399 | screen. |
|
|
1400 | |
|
|
1401 | =item $screen = $term->selection_screen ([$screen]) |
|
|
1402 | |
|
|
1403 | Returns the current selection screen, and then optionally sets it. |
| 1379 | |
1404 | |
| 1380 | =item $term->selection_make ($eventtime[, $rectangular]) |
1405 | =item $term->selection_make ($eventtime[, $rectangular]) |
| 1381 | |
1406 | |
| 1382 | Tries to make a selection as set by C<selection_beg> and |
1407 | Tries to make a selection as set by C<selection_beg> and |
| 1383 | C<selection_end>. If C<$rectangular> is true (default: false), a |
1408 | C<selection_end>. If C<$rectangular> is true (default: false), a |
| 1384 | rectangular selection will be made. This is the prefered function to make |
1409 | rectangular selection will be made. This is the preferred function to make |
| 1385 | a selection. |
1410 | a selection. |
| 1386 | |
1411 | |
| 1387 | =item $success = $term->selection_grab ($eventtime) |
1412 | =item $success = $term->selection_grab ($eventtime[, $clipboard]) |
| 1388 | |
1413 | |
| 1389 | Try to request the primary selection text from the server (for example, as |
1414 | Try to acquire ownership of the primary (clipboard if C<$clipboard> is |
|
|
1415 | true) selection from the server. The corresponding text can be set |
| 1390 | set by the next method). No visual feedback will be given. This function |
1416 | with the next method. No visual feedback will be given. This function |
| 1391 | is mostly useful from within C<on_sel_grab> hooks. |
1417 | is mostly useful from within C<on_sel_grab> hooks. |
| 1392 | |
1418 | |
| 1393 | =item $oldtext = $term->selection ([$newtext]) |
1419 | =item $oldtext = $term->selection ([$newtext, $clipboard]) |
| 1394 | |
1420 | |
| 1395 | Return the current selection text and optionally replace it by C<$newtext>. |
1421 | Return the current selection (clipboard if C<$clipboard> is true) text |
|
|
1422 | and optionally replace it by C<$newtext>. |
|
|
1423 | |
|
|
1424 | =item $term->selection_clear ([$clipboard]) |
|
|
1425 | |
|
|
1426 | Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection. |
| 1396 | |
1427 | |
| 1397 | =item $term->overlay_simple ($x, $y, $text) |
1428 | =item $term->overlay_simple ($x, $y, $text) |
| 1398 | |
1429 | |
| 1399 | Create a simple multi-line overlay box. See the next method for details. |
1430 | Create a simple multi-line overlay box. See the next method for details. |
| 1400 | |
1431 | |
| … | |
… | |
| 1528 | locale-specific encoding of the terminal and can contain command sequences |
1559 | locale-specific encoding of the terminal and can contain command sequences |
| 1529 | (escape codes) that will be interpreted. |
1560 | (escape codes) that will be interpreted. |
| 1530 | |
1561 | |
| 1531 | =item $term->tt_write ($octets) |
1562 | =item $term->tt_write ($octets) |
| 1532 | |
1563 | |
| 1533 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
1564 | Write the octets given in C<$octets> to the tty (i.e. as program input). To |
| 1534 | pass characters instead of octets, you should convert your strings first |
1565 | pass characters instead of octets, you should convert your strings first |
| 1535 | to the locale-specific encoding using C<< $term->locale_encode >>. |
1566 | to the locale-specific encoding using C<< $term->locale_encode >>. |
|
|
1567 | |
|
|
1568 | =item $term->tt_paste ($octets) |
|
|
1569 | |
|
|
1570 | Write the octets given in C<$octets> to the tty as a paste, converting NL to |
|
|
1571 | CR and bracketing the data with control sequences if bracketed paste mode |
|
|
1572 | is set. |
| 1536 | |
1573 | |
| 1537 | =item $old_events = $term->pty_ev_events ([$new_events]) |
1574 | =item $old_events = $term->pty_ev_events ([$new_events]) |
| 1538 | |
1575 | |
| 1539 | Replaces the event mask of the pty watcher by the given event mask. Can |
1576 | Replaces the event mask of the pty watcher by the given event mask. Can |
| 1540 | be used to suppress input and output handling to the pty/tty. See the |
1577 | be used to suppress input and output handling to the pty/tty. See the |
| … | |
… | |
| 1854 | Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most |
1891 | Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most |
| 1855 | recent grab. |
1892 | recent grab. |
| 1856 | |
1893 | |
| 1857 | =item $term->ungrab |
1894 | =item $term->ungrab |
| 1858 | |
1895 | |
| 1859 | Calls XUngrab for the most recent grab. Is called automatically on |
1896 | Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on |
| 1860 | evaluation errors, as it is better to lose the grab in the error case as |
1897 | evaluation errors, as it is better to lose the grab in the error case as |
| 1861 | the session. |
1898 | the session. |
| 1862 | |
1899 | |
| 1863 | =item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) |
1900 | =item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) |
| 1864 | |
1901 | |
| … | |
… | |
| 1886 | |
1923 | |
| 1887 | =item $term->XChangeInput ($window, $add_events[, $del_events]) |
1924 | =item $term->XChangeInput ($window, $add_events[, $del_events]) |
| 1888 | |
1925 | |
| 1889 | Various X or X-related functions. The C<$term> object only serves as |
1926 | Various X or X-related functions. The C<$term> object only serves as |
| 1890 | the source of the display, otherwise those functions map more-or-less |
1927 | the source of the display, otherwise those functions map more-or-less |
| 1891 | directory onto the X functions of the same name. |
1928 | directly onto the X functions of the same name. |
| 1892 | |
1929 | |
| 1893 | =back |
1930 | =back |
| 1894 | |
1931 | |
| 1895 | =cut |
1932 | =cut |
| 1896 | |
1933 | |
