… | |
… | |
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 | |
… | |
… | |
341 | URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' |
343 | URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' |
342 | URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' |
344 | URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' |
343 | |
345 | |
344 | =item selection-pastebin |
346 | =item selection-pastebin |
345 | |
347 | |
346 | This is a little rarely useful extension that Uploads the selection as |
348 | 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 |
349 | 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 |
350 | not currently secure for use in a multiuser environment as it writes to |
349 | F</tmp> directly.). |
351 | F</tmp> directly.). |
350 | |
352 | |
351 | It listens to the C<selection-pastebin:remote-pastebin> keyboard command, |
353 | It listens to the C<selection-pastebin:remote-pastebin> keyboard command, |
… | |
… | |
370 | |
372 | |
371 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
373 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
372 | |
374 | |
373 | I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret |
375 | 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, |
376 | 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 |
377 | which works regardless of whether xrdb is used to parse the resource file |
376 | or not. |
378 | or not. |
|
|
379 | |
|
|
380 | =item macosx-clipboard and macosx-clipboard-native |
|
|
381 | |
|
|
382 | These two modules implement an extended clipboard for Mac OS X. They are |
|
|
383 | used like this: |
|
|
384 | |
|
|
385 | URxvt.perl-ext-common: default,macosx-clipboard |
|
|
386 | URxvt.keysym.M-c: perl:macosx-clipboard:copy |
|
|
387 | URxvt.keysym.M-v: perl:macosx-clipboard:paste |
|
|
388 | |
|
|
389 | The difference between them is that the native variant requires a |
|
|
390 | perl from apple's devkit or so, and C<macosx-clipboard> requires the |
|
|
391 | C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is |
|
|
392 | simpler etc. etc. |
377 | |
393 | |
378 | =item example-refresh-hooks |
394 | =item example-refresh-hooks |
379 | |
395 | |
380 | 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 |
381 | window. Illustrates overwriting the refresh callbacks to create your own |
397 | window. Illustrates overwriting the refresh callbacks to create your own |
382 | overlays or changes. |
398 | overlays or changes. |
|
|
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" |
383 | |
412 | |
384 | =back |
413 | =back |
385 | |
414 | |
386 | =head1 API DOCUMENTATION |
415 | =head1 API DOCUMENTATION |
387 | |
416 | |
… | |
… | |
403 | |
432 | |
404 | =over 4 |
433 | =over 4 |
405 | |
434 | |
406 | =item $text |
435 | =item $text |
407 | |
436 | |
408 | Rxvt-unicodes special way of encoding text, where one "unicode" character |
437 | Rxvt-unicode's special way of encoding text, where one "unicode" character |
409 | always represents one screen cell. See L<ROW_t> for a discussion of this format. |
438 | always represents one screen cell. See L<ROW_t> for a discussion of this format. |
410 | |
439 | |
411 | =item $string |
440 | =item $string |
412 | |
441 | |
413 | A perl text string, with an emphasis on I<text>. It can store all unicode |
442 | A perl text string, with an emphasis on I<text>. It can store all unicode |
… | |
… | |
417 | =item $octets |
446 | =item $octets |
418 | |
447 | |
419 | 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 |
420 | locale-specific way. |
449 | locale-specific way. |
421 | |
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 | |
422 | =back |
457 | =back |
423 | |
458 | |
424 | =head2 Extension Objects |
459 | =head2 Extension Objects |
425 | |
460 | |
426 | 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 |
427 | 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, |
428 | 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 |
429 | 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 |
430 | extensions or other terminals, with the exception of methods and members |
465 | extensions or other terminals, with the exception of methods and members |
431 | that begin with an underscore character C<_>: these are reserved for |
466 | that begin with an underscore character C<_>: these are reserved for |
432 | internal use. |
467 | internal use. |
… | |
… | |
596 | =item on_tt_write $term, $octets |
631 | =item on_tt_write $term, $octets |
597 | |
632 | |
598 | 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 |
599 | suppress or filter tty input. |
634 | suppress or filter tty input. |
600 | |
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 | |
601 | =item on_line_update $term, $row |
643 | =item on_line_update $term, $row |
602 | |
644 | |
603 | 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 |
604 | 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 |
605 | 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, |
… | |
… | |
630 | resource in the @@RXVT_NAME@@(1) manpage). |
672 | resource in the @@RXVT_NAME@@(1) manpage). |
631 | |
673 | |
632 | 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 |
633 | slightly in the future. |
675 | slightly in the future. |
634 | |
676 | |
635 | =item on_resize_all_windows $tern, $new_width, $new_height |
677 | =item on_resize_all_windows $term, $new_width, $new_height |
636 | |
678 | |
637 | 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 |
638 | 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 |
639 | returns TRUE, setting of the window hints is being skipped. |
681 | returns TRUE, setting of the window hints is being skipped. |
640 | |
682 | |
… | |
… | |
674 | |
716 | |
675 | =item on_map_notify $term, $event |
717 | =item on_map_notify $term, $event |
676 | |
718 | |
677 | =item on_unmap_notify $term, $event |
719 | =item on_unmap_notify $term, $event |
678 | |
720 | |
679 | Called whenever the corresponding X event is received for the terminal If |
721 | Called whenever the corresponding X event is received for the terminal. If |
680 | the hook returns true, then the even will be ignored by rxvt-unicode. |
722 | the hook returns true, then the event will be ignored by rxvt-unicode. |
681 | |
723 | |
682 | The event is a hash with most values as named by Xlib (see the XEvent |
724 | The event is a hash with most values as named by Xlib (see the XEvent |
683 | manpage), with the additional members C<row> and C<col>, which are the |
725 | manpage), with the additional members C<row> and C<col>, which are the |
684 | (real, not screen-based) row and column under the mouse cursor. |
726 | (real, not screen-based) row and column under the mouse cursor. |
685 | |
727 | |
… | |
… | |
694 | |
736 | |
695 | =item on_wm_delete_window $term, $event |
737 | =item on_wm_delete_window $term, $event |
696 | |
738 | |
697 | Called when various types of ClientMessage events are received (all with |
739 | Called when various types of ClientMessage events are received (all with |
698 | format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
740 | format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
|
|
741 | |
|
|
742 | =item on_bell $term |
|
|
743 | |
|
|
744 | Called on receipt of a bell character. |
699 | |
745 | |
700 | =back |
746 | =back |
701 | |
747 | |
702 | =cut |
748 | =cut |
703 | |
749 | |
… | |
… | |
768 | |
814 | |
769 | =over 4 |
815 | =over 4 |
770 | |
816 | |
771 | =item urxvt::fatal $errormessage |
817 | =item urxvt::fatal $errormessage |
772 | |
818 | |
773 | Fatally aborts execution with the given error message. Avoid at all |
819 | Fatally aborts execution with the given error message (which should |
774 | 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 |
775 | starts up. |
821 | is acceptable (and useful) is in the init hook, where it prevents the |
|
|
822 | terminal from starting up. |
776 | |
823 | |
777 | =item urxvt::warn $string |
824 | =item urxvt::warn $string |
778 | |
825 | |
779 | 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 |
780 | 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 |
781 | that calls this function. |
828 | that calls this function. |
782 | |
829 | |
783 | 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 |
784 | correct place, e.g. on stderr of the connecting urxvtc client. |
831 | correct place, e.g. on stderr of the connecting urxvtc client. |
… | |
… | |
788 | =item @terms = urxvt::termlist |
835 | =item @terms = urxvt::termlist |
789 | |
836 | |
790 | 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 |
791 | 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 |
792 | objects that have perl extensions attached will be returned (because there |
839 | objects that have perl extensions attached will be returned (because there |
793 | is no urxvt::term objet associated with others). |
840 | is no urxvt::term object associated with others). |
794 | |
841 | |
795 | =item $time = urxvt::NOW |
842 | =item $time = urxvt::NOW |
796 | |
843 | |
797 | Returns the "current time" (as per the event loop). |
844 | Returns the "current time" (as per the event loop). |
798 | |
845 | |
… | |
… | |
841 | |
888 | |
842 | =item $rend = urxvt::OVERLAY_RSTYLE |
889 | =item $rend = urxvt::OVERLAY_RSTYLE |
843 | |
890 | |
844 | Return the rendition mask used for overlays by default. |
891 | Return the rendition mask used for overlays by default. |
845 | |
892 | |
846 | =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 |
847 | |
895 | |
848 | Return the bit that enabled bold, italic, blink, reverse-video and |
896 | Return the bit that enabled bold, italic, blink, reverse-video and |
849 | 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 |
850 | the bitset. |
898 | the bitset. |
851 | |
899 | |
… | |
… | |
933 | sub invoke { |
981 | sub invoke { |
934 | local $TERM = shift; |
982 | local $TERM = shift; |
935 | my $htype = shift; |
983 | my $htype = shift; |
936 | |
984 | |
937 | if ($htype == 0) { # INIT |
985 | if ($htype == 0) { # INIT |
938 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
986 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$ENV{HOME}/.urxvt/ext", "$LIBDIR/perl"); |
939 | |
987 | |
940 | my %ext_arg; |
988 | my %ext_arg; |
941 | |
989 | |
942 | { |
990 | { |
943 | my @init = @TERM_INIT; |
991 | my @init = @TERM_INIT; |
… | |
… | |
1110 | is that you cannot use blocking APIs, but the non-blocking variant should |
1158 | is that you cannot use blocking APIs, but the non-blocking variant should |
1111 | work. |
1159 | work. |
1112 | |
1160 | |
1113 | =cut |
1161 | =cut |
1114 | |
1162 | |
1115 | our $VERSION = '3.4'; |
1163 | our $VERSION = '5.23'; |
1116 | |
1164 | |
1117 | $INC{"urxvt/anyevent.pm"} = 1; # mark us as there |
1165 | $INC{"urxvt/anyevent.pm"} = 1; # mark us as there |
1118 | push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; |
1166 | push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; |
1119 | |
1167 | |
1120 | sub timer { |
1168 | sub timer { |
… | |
… | |
1122 | |
1170 | |
1123 | my $cb = $arg{cb}; |
1171 | my $cb = $arg{cb}; |
1124 | |
1172 | |
1125 | urxvt::timer |
1173 | urxvt::timer |
1126 | ->new |
1174 | ->new |
1127 | ->start (urxvt::NOW + $arg{after}) |
1175 | ->after ($arg{after}, $arg{interval}) |
1128 | ->cb (sub { |
1176 | ->cb ($arg{interval} ? $cb : sub { |
1129 | $_[0]->stop; # need to cancel manually |
1177 | $_[0]->stop; # need to cancel manually |
1130 | $cb->(); |
1178 | $cb->(); |
1131 | }) |
1179 | }) |
1132 | } |
1180 | } |
1133 | |
1181 | |
1134 | sub io { |
1182 | sub io { |
1135 | my ($class, %arg) = @_; |
1183 | my ($class, %arg) = @_; |
1136 | |
1184 | |
1137 | my $cb = $arg{cb}; |
1185 | my $cb = $arg{cb}; |
|
|
1186 | my $fd = fileno $arg{fh}; |
|
|
1187 | defined $fd or $fd = $arg{fh}; |
1138 | |
1188 | |
1139 | bless [$arg{fh}, urxvt::iow |
1189 | bless [$arg{fh}, urxvt::iow |
1140 | ->new |
1190 | ->new |
1141 | ->fd (fileno $arg{fh}) |
1191 | ->fd ($fd) |
1142 | ->events (($arg{poll} =~ /r/ ? 1 : 0) |
1192 | ->events (($arg{poll} =~ /r/ ? 1 : 0) |
1143 | | ($arg{poll} =~ /w/ ? 2 : 0)) |
1193 | | ($arg{poll} =~ /w/ ? 2 : 0)) |
1144 | ->start |
1194 | ->start |
1145 | ->cb (sub { |
1195 | ->cb ($cb) |
1146 | $cb->(($_[1] & 1 ? 'r' : '') |
|
|
1147 | . ($_[1] & 2 ? 'w' : '')); |
|
|
1148 | })], |
|
|
1149 | urxvt::anyevent:: |
1196 | ], urxvt::anyevent:: |
|
|
1197 | } |
|
|
1198 | |
|
|
1199 | sub idle { |
|
|
1200 | my ($class, %arg) = @_; |
|
|
1201 | |
|
|
1202 | my $cb = $arg{cb}; |
|
|
1203 | |
|
|
1204 | urxvt::iw |
|
|
1205 | ->new |
|
|
1206 | ->start |
|
|
1207 | ->cb ($cb) |
|
|
1208 | } |
|
|
1209 | |
|
|
1210 | sub child { |
|
|
1211 | my ($class, %arg) = @_; |
|
|
1212 | |
|
|
1213 | my $cb = $arg{cb}; |
|
|
1214 | |
|
|
1215 | urxvt::pw |
|
|
1216 | ->new |
|
|
1217 | ->start ($arg{pid}) |
|
|
1218 | ->cb (sub { |
|
|
1219 | $_[0]->stop; # need to cancel manually |
|
|
1220 | $cb->($_[0]->rpid, $_[0]->rstatus); |
|
|
1221 | }) |
1150 | } |
1222 | } |
1151 | |
1223 | |
1152 | sub DESTROY { |
1224 | sub DESTROY { |
1153 | $_[0][1]->stop; |
1225 | $_[0][1]->stop; |
1154 | } |
1226 | } |
1155 | |
1227 | |
|
|
1228 | # only needed for AnyEvent < 6 compatibility |
1156 | sub one_event { |
1229 | sub one_event { |
1157 | 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"; |
1158 | } |
1231 | } |
1159 | |
1232 | |
1160 | package urxvt::term; |
1233 | package urxvt::term; |
… | |
… | |
1252 | 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. |
1253 | |
1326 | |
1254 | 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 |
1255 | source file F</src/optinc.h> to see the actual list: |
1328 | source file F</src/optinc.h> to see the actual list: |
1256 | |
1329 | |
1257 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1330 | borderLess buffered console cursorBlink cursorUnderline hold iconic |
1258 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1331 | insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell |
1259 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
1332 | mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs |
1260 | scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput |
1333 | pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right |
1261 | scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs |
1334 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen |
1262 | transparent tripleclickwords utmpInhibit visualBell |
1335 | secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords |
|
|
1336 | urgentOnBell utmpInhibit visualBell |
1263 | |
1337 | |
1264 | =item $value = $term->resource ($name[, $newval]) |
1338 | =item $value = $term->resource ($name[, $newval]) |
1265 | |
1339 | |
1266 | Returns the current resource value associated with a given name and |
1340 | Returns the current resource value associated with a given name and |
1267 | 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> |
… | |
… | |
1280 | |
1354 | |
1281 | 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 |
1282 | 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> |
1283 | to see the actual list: |
1357 | to see the actual list: |
1284 | |
1358 | |
1285 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1359 | answerbackstring backgroundPixmap backspace_key blendtype blurradius |
1286 | borderLess chdir color cursorBlink cursorUnderline cutchars delete_key |
1360 | boldFont boldItalicFont borderLess buffered chdir color cursorBlink |
1287 | display_name embed ext_bwidth fade font geometry hold iconName |
1361 | cursorUnderline cutchars delete_key depth display_name embed ext_bwidth |
1288 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
1362 | fade font geometry hold iconName iconfile imFont imLocale inputMethod |
|
|
1363 | insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont |
1289 | italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier |
1364 | jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier |
1290 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
1365 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
1291 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
1366 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
1292 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
1367 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
1293 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
1368 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
1294 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
1369 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
1295 | secondaryScreen secondaryScroll shade term_name title |
1370 | secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll |
1296 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
1371 | term_name title transient_for transparent tripleclickwords urgentOnBell |
1297 | visualBell |
1372 | utmpInhibit visualBell |
1298 | |
1373 | |
1299 | =cut |
1374 | =cut |
1300 | |
1375 | |
1301 | sub resource($$;$) { |
1376 | sub resource($$;$) { |
1302 | my ($self, $name) = (shift, shift); |
1377 | my ($self, $name) = (shift, shift); |
… | |
… | |
1313 | |
1388 | |
1314 | 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 |
1315 | only one resource database per display, and later invocations might return |
1390 | only one resource database per display, and later invocations might return |
1316 | the wrong resources. |
1391 | the wrong resources. |
1317 | |
1392 | |
1318 | =item $success = $term->parse_keysym ($keysym_spec, $command_string) |
1393 | =item $success = $term->parse_keysym ($key, $octets) |
1319 | |
1394 | |
1320 | 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 |
1321 | C<keysym> resource in the @@RXVT_NAME@@(1) manpage. |
1396 | C<keysym> resource in the @@RXVT_NAME@@(1) manpage. |
1322 | |
1397 | |
1323 | =item $rend = $term->rstyle ([$new_rstyle]) |
1398 | =item $rend = $term->rstyle ([$new_rstyle]) |
1324 | |
1399 | |
1325 | 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 |
… | |
… | |
1334 | |
1409 | |
1335 | =item ($row, $col) = $term->selection_beg ([$row, $col]) |
1410 | =item ($row, $col) = $term->selection_beg ([$row, $col]) |
1336 | |
1411 | |
1337 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
1412 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
1338 | |
1413 | |
1339 | Return the current values of the selection mark, begin or end positions, |
1414 | Return the current values of the selection mark, begin or end positions. |
1340 | and optionally set them to new values. |
1415 | |
|
|
1416 | When arguments are given, then the selection coordinates are set to |
|
|
1417 | C<$row> and C<$col>, and the selection screen is set to the current |
|
|
1418 | screen. |
|
|
1419 | |
|
|
1420 | =item $screen = $term->selection_screen ([$screen]) |
|
|
1421 | |
|
|
1422 | Returns the current selection screen, and then optionally sets it. |
1341 | |
1423 | |
1342 | =item $term->selection_make ($eventtime[, $rectangular]) |
1424 | =item $term->selection_make ($eventtime[, $rectangular]) |
1343 | |
1425 | |
1344 | Tries to make a selection as set by C<selection_beg> and |
1426 | Tries to make a selection as set by C<selection_beg> and |
1345 | C<selection_end>. If C<$rectangular> is true (default: false), a |
1427 | C<selection_end>. If C<$rectangular> is true (default: false), a |
1346 | rectangular selection will be made. This is the prefered function to make |
1428 | rectangular selection will be made. This is the preferred function to make |
1347 | a selection. |
1429 | a selection. |
1348 | |
1430 | |
1349 | =item $success = $term->selection_grab ($eventtime) |
1431 | =item $success = $term->selection_grab ($eventtime[, $clipboard]) |
1350 | |
1432 | |
1351 | Try to request the primary selection text from the server (for example, as |
1433 | Try to acquire ownership of the primary (clipboard if C<$clipboard> is |
|
|
1434 | true) selection from the server. The corresponding text can be set |
1352 | set by the next method). No visual feedback will be given. This function |
1435 | with the next method. No visual feedback will be given. This function |
1353 | is mostly useful from within C<on_sel_grab> hooks. |
1436 | is mostly useful from within C<on_sel_grab> hooks. |
1354 | |
1437 | |
1355 | =item $oldtext = $term->selection ([$newtext]) |
1438 | =item $oldtext = $term->selection ([$newtext, $clipboard]) |
1356 | |
1439 | |
1357 | Return the current selection text and optionally replace it by C<$newtext>. |
1440 | Return the current selection (clipboard if C<$clipboard> is true) text |
|
|
1441 | and optionally replace it by C<$newtext>. |
|
|
1442 | |
|
|
1443 | =item $term->selection_clear ([$clipboard]) |
|
|
1444 | |
|
|
1445 | Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection. |
1358 | |
1446 | |
1359 | =item $term->overlay_simple ($x, $y, $text) |
1447 | =item $term->overlay_simple ($x, $y, $text) |
1360 | |
1448 | |
1361 | Create a simple multi-line overlay box. See the next method for details. |
1449 | Create a simple multi-line overlay box. See the next method for details. |
1362 | |
1450 | |
… | |
… | |
1490 | locale-specific encoding of the terminal and can contain command sequences |
1578 | locale-specific encoding of the terminal and can contain command sequences |
1491 | (escape codes) that will be interpreted. |
1579 | (escape codes) that will be interpreted. |
1492 | |
1580 | |
1493 | =item $term->tt_write ($octets) |
1581 | =item $term->tt_write ($octets) |
1494 | |
1582 | |
1495 | 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 |
1496 | pass characters instead of octets, you should convert your strings first |
1584 | pass characters instead of octets, you should convert your strings first |
1497 | 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. |
1498 | |
1592 | |
1499 | =item $old_events = $term->pty_ev_events ([$new_events]) |
1593 | =item $old_events = $term->pty_ev_events ([$new_events]) |
1500 | |
1594 | |
1501 | 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 |
1502 | 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 |
… | |
… | |
1816 | Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most |
1910 | Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most |
1817 | recent grab. |
1911 | recent grab. |
1818 | |
1912 | |
1819 | =item $term->ungrab |
1913 | =item $term->ungrab |
1820 | |
1914 | |
1821 | Calls XUngrab for the most recent grab. Is called automatically on |
1915 | Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on |
1822 | evaluation errors, as it is better to lose the grab in the error case as |
1916 | evaluation errors, as it is better to lose the grab in the error case as |
1823 | the session. |
1917 | the session. |
1824 | |
1918 | |
1825 | =item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) |
1919 | =item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) |
1826 | |
1920 | |
… | |
… | |
1846 | |
1940 | |
1847 | =item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) |
1941 | =item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) |
1848 | |
1942 | |
1849 | =item $term->XChangeInput ($window, $add_events[, $del_events]) |
1943 | =item $term->XChangeInput ($window, $add_events[, $del_events]) |
1850 | |
1944 | |
|
|
1945 | =item $keysym = $term->XStringToKeysym ($string) |
|
|
1946 | |
|
|
1947 | =item $string = $term->XKeysymToString ($keysym) |
|
|
1948 | |
1851 | 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 |
1852 | 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 |
1853 | directory onto the X functions of the same name. |
1951 | directly onto the X functions of the same name. |
1854 | |
1952 | |
1855 | =back |
1953 | =back |
1856 | |
1954 | |
1857 | =cut |
1955 | =cut |
1858 | |
1956 | |
… | |
… | |
2015 | |
2113 | |
2016 | =item $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
2114 | =item $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
2017 | |
2115 | |
2018 | Set the callback to be called when the timer triggers. |
2116 | Set the callback to be called when the timer triggers. |
2019 | |
2117 | |
2020 | =item $tstamp = $timer->at |
|
|
2021 | |
|
|
2022 | Return the time this watcher will fire next. |
|
|
2023 | |
|
|
2024 | =item $timer = $timer->set ($tstamp) |
2118 | =item $timer = $timer->set ($tstamp[, $interval]) |
2025 | |
2119 | |
2026 | Set the time the event is generated to $tstamp. |
2120 | Set the time the event is generated to $tstamp (and optionally specifies a |
|
|
2121 | new $interval). |
2027 | |
2122 | |
2028 | =item $timer = $timer->interval ($interval) |
2123 | =item $timer = $timer->interval ($interval) |
2029 | |
2124 | |
2030 | Normally (and when C<$interval> is C<0>), the timer will automatically |
2125 | By default (and when C<$interval> is C<0>), the timer will automatically |
2031 | stop after it has fired once. If C<$interval> is non-zero, then the timer |
2126 | stop after it has fired once. If C<$interval> is non-zero, then the timer |
2032 | is automatically rescheduled at the given intervals. |
2127 | is automatically rescheduled at the given intervals. |
2033 | |
2128 | |
2034 | =item $timer = $timer->start |
2129 | =item $timer = $timer->start |
2035 | |
2130 | |
2036 | Start the timer. |
2131 | Start the timer. |
2037 | |
2132 | |
2038 | =item $timer = $timer->start ($tstamp) |
2133 | =item $timer = $timer->start ($tstamp[, $interval]) |
2039 | |
2134 | |
2040 | Set the event trigger time to C<$tstamp> and start the timer. |
2135 | Set the event trigger time to C<$tstamp> and start the timer. Optionally |
|
|
2136 | also replaces the interval. |
2041 | |
2137 | |
2042 | =item $timer = $timer->after ($delay) |
2138 | =item $timer = $timer->after ($delay[, $interval]) |
2043 | |
2139 | |
2044 | Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. |
2140 | Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. |
2045 | |
2141 | |
2046 | =item $timer = $timer->stop |
2142 | =item $timer = $timer->stop |
2047 | |
2143 | |
… | |
… | |
2178 | |
2274 | |
2179 | =back |
2275 | =back |
2180 | |
2276 | |
2181 | =head1 AUTHOR |
2277 | =head1 AUTHOR |
2182 | |
2278 | |
2183 | Marc Lehmann <pcg@goof.com> |
2279 | Marc Lehmann <schmorp@schmorp.de> |
2184 | http://software.schmorp.de/pkg/rxvt-unicode |
2280 | http://software.schmorp.de/pkg/rxvt-unicode |
2185 | |
2281 | |
2186 | =cut |
2282 | =cut |
2187 | |
2283 | |
2188 | 1 |
2284 | 1 |