… | |
… | |
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-clipboard and macosx-clipboard-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 |
… | |
… | |
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 | |
… | |
… | |
436 | =back |
441 | =back |
437 | |
442 | |
438 | =head2 Extension Objects |
443 | =head2 Extension Objects |
439 | |
444 | |
440 | Every perl extension is a perl class. A separate perl object is created |
445 | Every perl extension is a perl class. A separate perl object is created |
441 | for each terminal, and each terminal has its own set of extenion objects, |
446 | for each terminal, and each terminal has its own set of extension objects, |
442 | which are passed as the first parameter to hooks. So extensions can use |
447 | which are passed as the first parameter to hooks. So extensions can use |
443 | their C<$self> object without having to think about clashes with other |
448 | their C<$self> object without having to think about clashes with other |
444 | extensions or other terminals, with the exception of methods and members |
449 | extensions or other terminals, with the exception of methods and members |
445 | that begin with an underscore character C<_>: these are reserved for |
450 | that begin with an underscore character C<_>: these are reserved for |
446 | internal use. |
451 | internal use. |
… | |
… | |
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 | |
… | |
… | |
786 | |
798 | |
787 | =over 4 |
799 | =over 4 |
788 | |
800 | |
789 | =item urxvt::fatal $errormessage |
801 | =item urxvt::fatal $errormessage |
790 | |
802 | |
791 | Fatally aborts execution with the given error message. Avoid at all |
803 | Fatally aborts execution with the given error message (which should |
792 | 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 |
793 | starts up. |
805 | is acceptable (and useful) is in the init hook, where it prevents the |
|
|
806 | terminal from starting up. |
794 | |
807 | |
795 | =item urxvt::warn $string |
808 | =item urxvt::warn $string |
796 | |
809 | |
797 | 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 |
798 | 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 |
799 | that calls this function. |
812 | that calls this function. |
800 | |
813 | |
801 | 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 |
802 | correct place, e.g. on stderr of the connecting urxvtc client. |
815 | correct place, e.g. on stderr of the connecting urxvtc client. |
… | |
… | |
806 | =item @terms = urxvt::termlist |
819 | =item @terms = urxvt::termlist |
807 | |
820 | |
808 | Returns all urxvt::term objects that exist in this process, regardless of |
821 | Returns all urxvt::term objects that exist in this process, regardless of |
809 | whether they are started, being destroyed etc., so be careful. Only term |
822 | whether they are started, being destroyed etc., so be careful. Only term |
810 | objects that have perl extensions attached will be returned (because there |
823 | objects that have perl extensions attached will be returned (because there |
811 | is no urxvt::term objet associated with others). |
824 | is no urxvt::term object associated with others). |
812 | |
825 | |
813 | =item $time = urxvt::NOW |
826 | =item $time = urxvt::NOW |
814 | |
827 | |
815 | Returns the "current time" (as per the event loop). |
828 | Returns the "current time" (as per the event loop). |
816 | |
829 | |
… | |
… | |
859 | |
872 | |
860 | =item $rend = urxvt::OVERLAY_RSTYLE |
873 | =item $rend = urxvt::OVERLAY_RSTYLE |
861 | |
874 | |
862 | Return the rendition mask used for overlays by default. |
875 | Return the rendition mask used for overlays by default. |
863 | |
876 | |
864 | =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 |
865 | |
879 | |
866 | Return the bit that enabled bold, italic, blink, reverse-video and |
880 | Return the bit that enabled bold, italic, blink, reverse-video and |
867 | 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 |
868 | the bitset. |
882 | the bitset. |
869 | |
883 | |
… | |
… | |
1294 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1308 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1295 | |
1309 | |
1296 | Here is a likely non-exhaustive list of option names, please see the |
1310 | Here is a likely non-exhaustive list of option names, please see the |
1297 | source file F</src/optinc.h> to see the actual list: |
1311 | source file F</src/optinc.h> to see the actual list: |
1298 | |
1312 | |
1299 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1313 | borderLess buffered console cursorBlink cursorUnderline hold iconic |
1300 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1314 | insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell |
1301 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
1315 | mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs |
1302 | scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput |
1316 | pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right |
1303 | scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs |
1317 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen |
1304 | transparent tripleclickwords utmpInhibit visualBell |
1318 | secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords |
|
|
1319 | urgentOnBell utmpInhibit visualBell |
1305 | |
1320 | |
1306 | =item $value = $term->resource ($name[, $newval]) |
1321 | =item $value = $term->resource ($name[, $newval]) |
1307 | |
1322 | |
1308 | Returns the current resource value associated with a given name and |
1323 | Returns the current resource value associated with a given name and |
1309 | optionally sets a new value. Setting values is most useful in the C<init> |
1324 | optionally sets a new value. Setting values is most useful in the C<init> |
… | |
… | |
1322 | |
1337 | |
1323 | Here is a likely non-exhaustive list of resource names, not all of which |
1338 | Here is a likely non-exhaustive list of resource names, not all of which |
1324 | are supported in every build, please see the source file F</src/rsinc.h> |
1339 | are supported in every build, please see the source file F</src/rsinc.h> |
1325 | to see the actual list: |
1340 | to see the actual list: |
1326 | |
1341 | |
1327 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1342 | answerbackstring backgroundPixmap backspace_key blendtype blurradius |
1328 | borderLess chdir color cursorBlink cursorUnderline cutchars delete_key |
1343 | boldFont boldItalicFont borderLess buffered chdir color cursorBlink |
1329 | display_name embed ext_bwidth fade font geometry hold iconName |
1344 | cursorUnderline cutchars delete_key depth display_name embed ext_bwidth |
1330 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
1345 | fade font geometry hold iconName iconfile imFont imLocale inputMethod |
1331 | italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8 |
1346 | insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont |
|
|
1347 | jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier |
1332 | modifier mouseWheelScrollPage name override_redirect pastableTabs path |
1348 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
1333 | perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
1349 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
1334 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
1350 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
1335 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
1351 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
1336 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
1352 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
1337 | secondaryScreen secondaryScroll shade term_name title |
1353 | secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll |
1338 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
1354 | term_name title transient_for transparent tripleclickwords urgentOnBell |
1339 | visualBell |
1355 | utmpInhibit visualBell |
1340 | |
1356 | |
1341 | =cut |
1357 | =cut |
1342 | |
1358 | |
1343 | sub resource($$;$) { |
1359 | sub resource($$;$) { |
1344 | my ($self, $name) = (shift, shift); |
1360 | my ($self, $name) = (shift, shift); |
… | |
… | |
1390 | |
1406 | |
1391 | =item $term->selection_make ($eventtime[, $rectangular]) |
1407 | =item $term->selection_make ($eventtime[, $rectangular]) |
1392 | |
1408 | |
1393 | Tries to make a selection as set by C<selection_beg> and |
1409 | Tries to make a selection as set by C<selection_beg> and |
1394 | C<selection_end>. If C<$rectangular> is true (default: false), a |
1410 | C<selection_end>. If C<$rectangular> is true (default: false), a |
1395 | rectangular selection will be made. This is the prefered function to make |
1411 | rectangular selection will be made. This is the preferred function to make |
1396 | a selection. |
1412 | a selection. |
1397 | |
1413 | |
1398 | =item $success = $term->selection_grab ($eventtime) |
1414 | =item $success = $term->selection_grab ($eventtime[, $clipboard]) |
1399 | |
1415 | |
1400 | Try to request the primary selection text from the server (for example, as |
1416 | Try to acquire ownership of the primary (clipboard if C<$clipboard> is |
|
|
1417 | true) selection from the server. The corresponding text can be set |
1401 | set by the next method). No visual feedback will be given. This function |
1418 | with the next method. No visual feedback will be given. This function |
1402 | is mostly useful from within C<on_sel_grab> hooks. |
1419 | is mostly useful from within C<on_sel_grab> hooks. |
1403 | |
1420 | |
1404 | =item $oldtext = $term->selection ([$newtext]) |
1421 | =item $oldtext = $term->selection ([$newtext, $clipboard]) |
1405 | |
1422 | |
1406 | Return the current selection text and optionally replace it by C<$newtext>. |
1423 | Return the current selection (clipboard if C<$clipboard> is true) text |
|
|
1424 | and optionally replace it by C<$newtext>. |
|
|
1425 | |
|
|
1426 | =item $term->selection_clear ([$clipboard]) |
|
|
1427 | |
|
|
1428 | Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection. |
1407 | |
1429 | |
1408 | =item $term->overlay_simple ($x, $y, $text) |
1430 | =item $term->overlay_simple ($x, $y, $text) |
1409 | |
1431 | |
1410 | Create a simple multi-line overlay box. See the next method for details. |
1432 | Create a simple multi-line overlay box. See the next method for details. |
1411 | |
1433 | |
… | |
… | |
1539 | locale-specific encoding of the terminal and can contain command sequences |
1561 | locale-specific encoding of the terminal and can contain command sequences |
1540 | (escape codes) that will be interpreted. |
1562 | (escape codes) that will be interpreted. |
1541 | |
1563 | |
1542 | =item $term->tt_write ($octets) |
1564 | =item $term->tt_write ($octets) |
1543 | |
1565 | |
1544 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
1566 | Write the octets given in C<$octets> to the tty (i.e. as program input). To |
1545 | pass characters instead of octets, you should convert your strings first |
1567 | pass characters instead of octets, you should convert your strings first |
1546 | to the locale-specific encoding using C<< $term->locale_encode >>. |
1568 | to the locale-specific encoding using C<< $term->locale_encode >>. |
|
|
1569 | |
|
|
1570 | =item $term->tt_paste ($octets) |
|
|
1571 | |
|
|
1572 | Write the octets given in C<$octets> to the tty as a paste, converting NL to |
|
|
1573 | CR and bracketing the data with control sequences if bracketed paste mode |
|
|
1574 | is set. |
1547 | |
1575 | |
1548 | =item $old_events = $term->pty_ev_events ([$new_events]) |
1576 | =item $old_events = $term->pty_ev_events ([$new_events]) |
1549 | |
1577 | |
1550 | Replaces the event mask of the pty watcher by the given event mask. Can |
1578 | Replaces the event mask of the pty watcher by the given event mask. Can |
1551 | be used to suppress input and output handling to the pty/tty. See the |
1579 | be used to suppress input and output handling to the pty/tty. See the |
… | |
… | |
2225 | |
2253 | |
2226 | =back |
2254 | =back |
2227 | |
2255 | |
2228 | =head1 AUTHOR |
2256 | =head1 AUTHOR |
2229 | |
2257 | |
2230 | Marc Lehmann <pcg@goof.com> |
2258 | Marc Lehmann <schmorp@schmorp.de> |
2231 | http://software.schmorp.de/pkg/rxvt-unicode |
2259 | http://software.schmorp.de/pkg/rxvt-unicode |
2232 | |
2260 | |
2233 | =cut |
2261 | =cut |
2234 | |
2262 | |
2235 | 1 |
2263 | 1 |