… | |
… | |
259 | The default pattern to match URLs can be overridden with the |
259 | The default pattern to match URLs can be overridden with the |
260 | C<matcher.pattern.0> resource, and additional patterns can be specified |
260 | C<matcher.pattern.0> resource, and additional patterns can be specified |
261 | with numbered patterns, in a manner similar to the "selection" extension. |
261 | with numbered patterns, in a manner similar to the "selection" extension. |
262 | The launcher can also be overridden on a per-pattern basis. |
262 | The launcher can also be overridden on a per-pattern basis. |
263 | |
263 | |
264 | It is possible to activate the most recently seen match from the keyboard. |
264 | It is possible to activate the most recently seen match or a list of matches |
|
|
265 | from the keyboard. Simply bind a keysym to "perl:matcher:last" or |
265 | Simply bind a keysym to "perl:matcher" as seen in the example below. |
266 | "perl:matcher:list" as seen in the example below. |
266 | |
267 | |
267 | Example configuration: |
268 | Example configuration: |
268 | |
269 | |
269 | URxvt.perl-ext: default,matcher |
270 | URxvt.perl-ext: default,matcher |
270 | URxvt.urlLauncher: sensible-browser |
271 | URxvt.urlLauncher: sensible-browser |
271 | URxvt.keysym.C-Delete: perl:matcher |
272 | URxvt.keysym.C-Delete: perl:matcher:last |
|
|
273 | URxvt.keysym.M-Delete: perl:matcher:list |
272 | URxvt.matcher.button: 1 |
274 | URxvt.matcher.button: 1 |
273 | URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-] |
275 | URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-] |
274 | URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$) |
276 | URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$) |
275 | URxvt.matcher.launcher.2: gvim +$2 $1 |
277 | URxvt.matcher.launcher.2: gvim +$2 $1 |
276 | |
278 | |
… | |
… | |
393 | |
395 | |
394 | Displays a very simple digital clock in the upper right corner of the |
396 | Displays a very simple digital clock in the upper right corner of the |
395 | window. Illustrates overwriting the refresh callbacks to create your own |
397 | window. Illustrates overwriting the refresh callbacks to create your own |
396 | overlays or changes. |
398 | overlays or changes. |
397 | |
399 | |
|
|
400 | =item confirm-paste |
|
|
401 | |
|
|
402 | Displays a confirmation dialog when a paste containing at least a full |
|
|
403 | line is detected. |
|
|
404 | |
|
|
405 | =item bell-command |
|
|
406 | |
|
|
407 | Runs the command specified by the C<URxvt.bell-command> resource when |
|
|
408 | a bell event occurs. For example, the following pops up a notification |
|
|
409 | bubble with the text "Beep, Beep" using notify-send: |
|
|
410 | |
|
|
411 | URxvt.bell-command: notify-send "Beep, Beep" |
|
|
412 | |
398 | =back |
413 | =back |
399 | |
414 | |
400 | =head1 API DOCUMENTATION |
415 | =head1 API DOCUMENTATION |
401 | |
416 | |
402 | =head2 General API Considerations |
417 | =head2 General API Considerations |
… | |
… | |
431 | =item $octets |
446 | =item $octets |
432 | |
447 | |
433 | Either binary data or - more common - a text string encoded in a |
448 | Either binary data or - more common - a text string encoded in a |
434 | locale-specific way. |
449 | locale-specific way. |
435 | |
450 | |
|
|
451 | =item $keysym |
|
|
452 | |
|
|
453 | an integer that is a valid X11 keysym code. You can convert a string |
|
|
454 | into a keysym and viceversa by using C<XStringToKeysym> and |
|
|
455 | C<XKeysymToString>. |
|
|
456 | |
436 | =back |
457 | =back |
437 | |
458 | |
438 | =head2 Extension Objects |
459 | =head2 Extension Objects |
439 | |
460 | |
440 | Every perl extension is a perl class. A separate perl object is created |
461 | 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, |
462 | 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 |
463 | 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 |
464 | their C<$self> object without having to think about clashes with other |
444 | extensions or other terminals, with the exception of methods and members |
465 | extensions or other terminals, with the exception of methods and members |
445 | that begin with an underscore character C<_>: these are reserved for |
466 | that begin with an underscore character C<_>: these are reserved for |
446 | internal use. |
467 | internal use. |
… | |
… | |
610 | =item on_tt_write $term, $octets |
631 | =item on_tt_write $term, $octets |
611 | |
632 | |
612 | Called whenever some data is written to the tty/pty and can be used to |
633 | Called whenever some data is written to the tty/pty and can be used to |
613 | suppress or filter tty input. |
634 | suppress or filter tty input. |
614 | |
635 | |
|
|
636 | =item on_tt_paste $term, $octets |
|
|
637 | |
|
|
638 | Called whenever text is about to be pasted, with the text as argument. You |
|
|
639 | can filter/change and paste the text yourself by returning a true value |
|
|
640 | and calling C<< $term->tt_paste >> yourself. C<$octets> is |
|
|
641 | locale-encoded. |
|
|
642 | |
615 | =item on_line_update $term, $row |
643 | =item on_line_update $term, $row |
616 | |
644 | |
617 | Called whenever a line was updated or changed. Can be used to filter |
645 | 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 |
646 | 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, |
647 | that are being shown will be filtered, and, due to performance reasons, |
… | |
… | |
644 | resource in the @@RXVT_NAME@@(1) manpage). |
672 | resource in the @@RXVT_NAME@@(1) manpage). |
645 | |
673 | |
646 | The event is simply the action string. This interface is assumed to change |
674 | The event is simply the action string. This interface is assumed to change |
647 | slightly in the future. |
675 | slightly in the future. |
648 | |
676 | |
649 | =item on_resize_all_windows $tern, $new_width, $new_height |
677 | =item on_resize_all_windows $term, $new_width, $new_height |
650 | |
678 | |
651 | Called just after the new window size has been calculated, but before |
679 | 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 |
680 | windows are actually being resized or hints are being set. If this hook |
653 | returns TRUE, setting of the window hints is being skipped. |
681 | returns TRUE, setting of the window hints is being skipped. |
654 | |
682 | |
… | |
… | |
786 | |
814 | |
787 | =over 4 |
815 | =over 4 |
788 | |
816 | |
789 | =item urxvt::fatal $errormessage |
817 | =item urxvt::fatal $errormessage |
790 | |
818 | |
791 | Fatally aborts execution with the given error message. Avoid at all |
819 | Fatally aborts execution with the given error message (which should |
792 | costs! The only time this is acceptable is when the terminal process |
820 | include a trailing newline). Avoid at all costs! The only time this |
793 | starts up. |
821 | is acceptable (and useful) is in the init hook, where it prevents the |
|
|
822 | terminal from starting up. |
794 | |
823 | |
795 | =item urxvt::warn $string |
824 | =item urxvt::warn $string |
796 | |
825 | |
797 | Calls C<rxvt_warn> with the given string which should not include a |
826 | 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 |
827 | newline. The module also overwrites the C<warn> builtin with a function |
799 | that calls this function. |
828 | that calls this function. |
800 | |
829 | |
801 | Using this function has the advantage that its output ends up in the |
830 | 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. |
831 | correct place, e.g. on stderr of the connecting urxvtc client. |
… | |
… | |
806 | =item @terms = urxvt::termlist |
835 | =item @terms = urxvt::termlist |
807 | |
836 | |
808 | Returns all urxvt::term objects that exist in this process, regardless of |
837 | 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 |
838 | whether they are started, being destroyed etc., so be careful. Only term |
810 | objects that have perl extensions attached will be returned (because there |
839 | objects that have perl extensions attached will be returned (because there |
811 | is no urxvt::term objet associated with others). |
840 | is no urxvt::term object associated with others). |
812 | |
841 | |
813 | =item $time = urxvt::NOW |
842 | =item $time = urxvt::NOW |
814 | |
843 | |
815 | Returns the "current time" (as per the event loop). |
844 | Returns the "current time" (as per the event loop). |
816 | |
845 | |
… | |
… | |
859 | |
888 | |
860 | =item $rend = urxvt::OVERLAY_RSTYLE |
889 | =item $rend = urxvt::OVERLAY_RSTYLE |
861 | |
890 | |
862 | Return the rendition mask used for overlays by default. |
891 | Return the rendition mask used for overlays by default. |
863 | |
892 | |
864 | =item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline |
893 | =item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink, |
|
|
894 | urxvt::RS_RVid, urxvt::RS_Uline |
865 | |
895 | |
866 | Return the bit that enabled bold, italic, blink, reverse-video and |
896 | Return the bit that enabled bold, italic, blink, reverse-video and |
867 | underline, respectively. To enable such a style, just logically OR it into |
897 | underline, respectively. To enable such a style, just logically OR it into |
868 | the bitset. |
898 | the bitset. |
869 | |
899 | |
… | |
… | |
951 | sub invoke { |
981 | sub invoke { |
952 | local $TERM = shift; |
982 | local $TERM = shift; |
953 | my $htype = shift; |
983 | my $htype = shift; |
954 | |
984 | |
955 | if ($htype == 0) { # INIT |
985 | if ($htype == 0) { # INIT |
956 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
986 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$ENV{HOME}/.urxvt/ext", "$LIBDIR/perl"); |
957 | |
987 | |
958 | my %ext_arg; |
988 | my %ext_arg; |
959 | |
989 | |
960 | { |
990 | { |
961 | my @init = @TERM_INIT; |
991 | my @init = @TERM_INIT; |
… | |
… | |
1193 | |
1223 | |
1194 | sub DESTROY { |
1224 | sub DESTROY { |
1195 | $_[0][1]->stop; |
1225 | $_[0][1]->stop; |
1196 | } |
1226 | } |
1197 | |
1227 | |
|
|
1228 | # only needed for AnyEvent < 6 compatibility |
1198 | sub one_event { |
1229 | sub one_event { |
1199 | Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; |
1230 | Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; |
1200 | } |
1231 | } |
1201 | |
1232 | |
1202 | package urxvt::term; |
1233 | package urxvt::term; |
… | |
… | |
1294 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1325 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1295 | |
1326 | |
1296 | Here is a likely non-exhaustive list of option names, please see the |
1327 | 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: |
1328 | source file F</src/optinc.h> to see the actual list: |
1298 | |
1329 | |
1299 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1330 | borderLess buffered console cursorBlink cursorUnderline hold iconic |
1300 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1331 | insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell |
1301 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
1332 | mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs |
1302 | scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput |
1333 | pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right |
1303 | scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs |
1334 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen |
1304 | transparent tripleclickwords utmpInhibit visualBell |
1335 | secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords |
|
|
1336 | urgentOnBell utmpInhibit visualBell |
1305 | |
1337 | |
1306 | =item $value = $term->resource ($name[, $newval]) |
1338 | =item $value = $term->resource ($name[, $newval]) |
1307 | |
1339 | |
1308 | Returns the current resource value associated with a given name and |
1340 | 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> |
1341 | optionally sets a new value. Setting values is most useful in the C<init> |
… | |
… | |
1322 | |
1354 | |
1323 | Here is a likely non-exhaustive list of resource names, not all of which |
1355 | 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> |
1356 | are supported in every build, please see the source file F</src/rsinc.h> |
1325 | to see the actual list: |
1357 | to see the actual list: |
1326 | |
1358 | |
1327 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1359 | answerbackstring backgroundPixmap backspace_key blendtype blurradius |
1328 | borderLess chdir color cursorBlink cursorUnderline cutchars delete_key |
1360 | boldFont boldItalicFont borderLess buffered chdir color cursorBlink |
1329 | display_name embed ext_bwidth fade font geometry hold iconName |
1361 | cursorUnderline cutchars delete_key depth display_name embed ext_bwidth |
1330 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
1362 | fade font geometry hold iconName iconfile imFont imLocale inputMethod |
1331 | italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8 |
1363 | insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont |
|
|
1364 | jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier |
1332 | modifier mouseWheelScrollPage name override_redirect pastableTabs path |
1365 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
1333 | perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
1366 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
1334 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
1367 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
1335 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
1368 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
1336 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
1369 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
1337 | secondaryScreen secondaryScroll shade term_name title |
1370 | secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll |
1338 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
1371 | term_name title transient_for transparent tripleclickwords urgentOnBell |
1339 | visualBell |
1372 | utmpInhibit visualBell |
1340 | |
1373 | |
1341 | =cut |
1374 | =cut |
1342 | |
1375 | |
1343 | sub resource($$;$) { |
1376 | sub resource($$;$) { |
1344 | my ($self, $name) = (shift, shift); |
1377 | my ($self, $name) = (shift, shift); |
… | |
… | |
1355 | |
1388 | |
1356 | This method should only be called during the C<on_start> hook, as there is |
1389 | This method should only be called during the C<on_start> hook, as there is |
1357 | only one resource database per display, and later invocations might return |
1390 | only one resource database per display, and later invocations might return |
1358 | the wrong resources. |
1391 | the wrong resources. |
1359 | |
1392 | |
1360 | =item $success = $term->parse_keysym ($keysym_spec, $command_string) |
1393 | =item $success = $term->parse_keysym ($key, $octets) |
1361 | |
1394 | |
1362 | Adds a keymap translation exactly as specified via a resource. See the |
1395 | Adds a key binding exactly as specified via a resource. See the |
1363 | C<keysym> resource in the @@RXVT_NAME@@(1) manpage. |
1396 | C<keysym> resource in the @@RXVT_NAME@@(1) manpage. |
1364 | |
1397 | |
1365 | =item $rend = $term->rstyle ([$new_rstyle]) |
1398 | =item $rend = $term->rstyle ([$new_rstyle]) |
1366 | |
1399 | |
1367 | Return and optionally change the current rendition. Text that is output by |
1400 | Return and optionally change the current rendition. Text that is output by |
… | |
… | |
1545 | locale-specific encoding of the terminal and can contain command sequences |
1578 | locale-specific encoding of the terminal and can contain command sequences |
1546 | (escape codes) that will be interpreted. |
1579 | (escape codes) that will be interpreted. |
1547 | |
1580 | |
1548 | =item $term->tt_write ($octets) |
1581 | =item $term->tt_write ($octets) |
1549 | |
1582 | |
1550 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
1583 | Write the octets given in C<$octets> to the tty (i.e. as program input). To |
1551 | pass characters instead of octets, you should convert your strings first |
1584 | pass characters instead of octets, you should convert your strings first |
1552 | to the locale-specific encoding using C<< $term->locale_encode >>. |
1585 | to the locale-specific encoding using C<< $term->locale_encode >>. |
|
|
1586 | |
|
|
1587 | =item $term->tt_paste ($octets) |
|
|
1588 | |
|
|
1589 | Write the octets given in C<$octets> to the tty as a paste, converting NL to |
|
|
1590 | CR and bracketing the data with control sequences if bracketed paste mode |
|
|
1591 | is set. |
1553 | |
1592 | |
1554 | =item $old_events = $term->pty_ev_events ([$new_events]) |
1593 | =item $old_events = $term->pty_ev_events ([$new_events]) |
1555 | |
1594 | |
1556 | Replaces the event mask of the pty watcher by the given event mask. Can |
1595 | Replaces the event mask of the pty watcher by the given event mask. Can |
1557 | be used to suppress input and output handling to the pty/tty. See the |
1596 | be used to suppress input and output handling to the pty/tty. See the |
… | |
… | |
1900 | =item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) |
1939 | =item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) |
1901 | |
1940 | |
1902 | =item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) |
1941 | =item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) |
1903 | |
1942 | |
1904 | =item $term->XChangeInput ($window, $add_events[, $del_events]) |
1943 | =item $term->XChangeInput ($window, $add_events[, $del_events]) |
|
|
1944 | |
|
|
1945 | =item $keysym = $term->XStringToKeysym ($string) |
|
|
1946 | |
|
|
1947 | =item $string = $term->XKeysymToString ($keysym) |
1905 | |
1948 | |
1906 | Various X or X-related functions. The C<$term> object only serves as |
1949 | Various X or X-related functions. The C<$term> object only serves as |
1907 | the source of the display, otherwise those functions map more-or-less |
1950 | the source of the display, otherwise those functions map more-or-less |
1908 | directly onto the X functions of the same name. |
1951 | directly onto the X functions of the same name. |
1909 | |
1952 | |
… | |
… | |
2231 | |
2274 | |
2232 | =back |
2275 | =back |
2233 | |
2276 | |
2234 | =head1 AUTHOR |
2277 | =head1 AUTHOR |
2235 | |
2278 | |
2236 | Marc Lehmann <pcg@goof.com> |
2279 | Marc Lehmann <schmorp@schmorp.de> |
2237 | http://software.schmorp.de/pkg/rxvt-unicode |
2280 | http://software.schmorp.de/pkg/rxvt-unicode |
2238 | |
2281 | |
2239 | =cut |
2282 | =cut |
2240 | |
2283 | |
2241 | 1 |
2284 | 1 |