… | |
… | |
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 | |
… | |
… | |
303 | extension will actually grab a physical key just for this function. |
305 | extension will actually grab a physical key just for this function. |
304 | |
306 | |
305 | If you want a quake-like animation, tell your window manager to do so |
307 | If you want a quake-like animation, tell your window manager to do so |
306 | (fvwm can do it). |
308 | (fvwm can do it). |
307 | |
309 | |
|
|
310 | =item overlay-osc |
|
|
311 | |
|
|
312 | This extension implements some OSC commands to display timed popups on the |
|
|
313 | screen - useful for status displays from within scripts. You have to read |
|
|
314 | the sources for more info. |
|
|
315 | |
308 | =item block-graphics-to-ascii |
316 | =item block-graphics-to-ascii |
309 | |
317 | |
310 | A not very useful example of filtering all text output to the terminal |
318 | A not very useful example of filtering all text output to the terminal |
311 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
319 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
312 | similar-looking ascii character. |
320 | similar-looking ascii character. |
… | |
… | |
335 | URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' |
343 | URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' |
336 | URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' |
344 | URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' |
337 | |
345 | |
338 | =item selection-pastebin |
346 | =item selection-pastebin |
339 | |
347 | |
340 | 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 |
341 | 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 |
342 | 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 |
343 | F</tmp> directly.). |
351 | F</tmp> directly.). |
344 | |
352 | |
345 | It listens to the C<selection-pastebin:remote-pastebin> keyboard command, |
353 | It listens to the C<selection-pastebin:remote-pastebin> keyboard command, |
… | |
… | |
364 | |
372 | |
365 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
373 | URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
366 | |
374 | |
367 | 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 |
368 | 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, |
369 | 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 |
370 | 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. |
371 | |
393 | |
372 | =item example-refresh-hooks |
394 | =item example-refresh-hooks |
373 | |
395 | |
374 | 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 |
375 | window. Illustrates overwriting the refresh callbacks to create your own |
397 | window. Illustrates overwriting the refresh callbacks to create your own |
376 | 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. |
377 | |
404 | |
378 | =back |
405 | =back |
379 | |
406 | |
380 | =head1 API DOCUMENTATION |
407 | =head1 API DOCUMENTATION |
381 | |
408 | |
… | |
… | |
397 | |
424 | |
398 | =over 4 |
425 | =over 4 |
399 | |
426 | |
400 | =item $text |
427 | =item $text |
401 | |
428 | |
402 | Rxvt-unicodes special way of encoding text, where one "unicode" character |
429 | Rxvt-unicode's special way of encoding text, where one "unicode" character |
403 | always represents one screen cell. See L<ROW_t> for a discussion of this format. |
430 | always represents one screen cell. See L<ROW_t> for a discussion of this format. |
404 | |
431 | |
405 | =item $string |
432 | =item $string |
406 | |
433 | |
407 | A perl text string, with an emphasis on I<text>. It can store all unicode |
434 | A perl text string, with an emphasis on I<text>. It can store all unicode |
… | |
… | |
416 | =back |
443 | =back |
417 | |
444 | |
418 | =head2 Extension Objects |
445 | =head2 Extension Objects |
419 | |
446 | |
420 | Every perl extension is a perl class. A separate perl object is created |
447 | Every perl extension is a perl class. A separate perl object is created |
421 | for each terminal, and each terminal has its own set of extenion objects, |
448 | for each terminal, and each terminal has its own set of extension objects, |
422 | which are passed as the first parameter to hooks. So extensions can use |
449 | which are passed as the first parameter to hooks. So extensions can use |
423 | their C<$self> object without having to think about clashes with other |
450 | their C<$self> object without having to think about clashes with other |
424 | extensions or other terminals, with the exception of methods and members |
451 | extensions or other terminals, with the exception of methods and members |
425 | that begin with an underscore character C<_>: these are reserved for |
452 | that begin with an underscore character C<_>: these are reserved for |
426 | internal use. |
453 | internal use. |
… | |
… | |
590 | =item on_tt_write $term, $octets |
617 | =item on_tt_write $term, $octets |
591 | |
618 | |
592 | Called whenever some data is written to the tty/pty and can be used to |
619 | Called whenever some data is written to the tty/pty and can be used to |
593 | suppress or filter tty input. |
620 | suppress or filter tty input. |
594 | |
621 | |
|
|
622 | =item on_tt_paste $term, $octets |
|
|
623 | |
|
|
624 | Called whenever text is about to be pasted, with the text as argument. You |
|
|
625 | can filter/change and paste the text yourself by returning a true value |
|
|
626 | and calling C<< $term->tt_paste >> yourself. C<$octets> is |
|
|
627 | locale-encoded. |
|
|
628 | |
595 | =item on_line_update $term, $row |
629 | =item on_line_update $term, $row |
596 | |
630 | |
597 | Called whenever a line was updated or changed. Can be used to filter |
631 | Called whenever a line was updated or changed. Can be used to filter |
598 | screen output (e.g. underline urls or other useless stuff). Only lines |
632 | screen output (e.g. underline urls or other useless stuff). Only lines |
599 | that are being shown will be filtered, and, due to performance reasons, |
633 | that are being shown will be filtered, and, due to performance reasons, |
… | |
… | |
624 | resource in the @@RXVT_NAME@@(1) manpage). |
658 | resource in the @@RXVT_NAME@@(1) manpage). |
625 | |
659 | |
626 | The event is simply the action string. This interface is assumed to change |
660 | The event is simply the action string. This interface is assumed to change |
627 | slightly in the future. |
661 | slightly in the future. |
628 | |
662 | |
629 | =item on_resize_all_windows $tern, $new_width, $new_height |
663 | =item on_resize_all_windows $term, $new_width, $new_height |
630 | |
664 | |
631 | Called just after the new window size has been calculated, but before |
665 | Called just after the new window size has been calculated, but before |
632 | windows are actually being resized or hints are being set. If this hook |
666 | windows are actually being resized or hints are being set. If this hook |
633 | returns TRUE, setting of the window hints is being skipped. |
667 | returns TRUE, setting of the window hints is being skipped. |
634 | |
668 | |
… | |
… | |
668 | |
702 | |
669 | =item on_map_notify $term, $event |
703 | =item on_map_notify $term, $event |
670 | |
704 | |
671 | =item on_unmap_notify $term, $event |
705 | =item on_unmap_notify $term, $event |
672 | |
706 | |
673 | Called whenever the corresponding X event is received for the terminal If |
707 | Called whenever the corresponding X event is received for the terminal. If |
674 | the hook returns true, then the even will be ignored by rxvt-unicode. |
708 | the hook returns true, then the event will be ignored by rxvt-unicode. |
675 | |
709 | |
676 | The event is a hash with most values as named by Xlib (see the XEvent |
710 | The event is a hash with most values as named by Xlib (see the XEvent |
677 | manpage), with the additional members C<row> and C<col>, which are the |
711 | manpage), with the additional members C<row> and C<col>, which are the |
678 | (real, not screen-based) row and column under the mouse cursor. |
712 | (real, not screen-based) row and column under the mouse cursor. |
679 | |
713 | |
… | |
… | |
688 | |
722 | |
689 | =item on_wm_delete_window $term, $event |
723 | =item on_wm_delete_window $term, $event |
690 | |
724 | |
691 | Called when various types of ClientMessage events are received (all with |
725 | Called when various types of ClientMessage events are received (all with |
692 | format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
726 | format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
|
|
727 | |
|
|
728 | =item on_bell $term |
|
|
729 | |
|
|
730 | Called on receipt of a bell character. |
693 | |
731 | |
694 | =back |
732 | =back |
695 | |
733 | |
696 | =cut |
734 | =cut |
697 | |
735 | |
… | |
… | |
762 | |
800 | |
763 | =over 4 |
801 | =over 4 |
764 | |
802 | |
765 | =item urxvt::fatal $errormessage |
803 | =item urxvt::fatal $errormessage |
766 | |
804 | |
767 | Fatally aborts execution with the given error message. Avoid at all |
805 | Fatally aborts execution with the given error message (which should |
768 | costs! The only time this is acceptable is when the terminal process |
806 | include a trailing newline). Avoid at all costs! The only time this |
769 | starts up. |
807 | is acceptable (and useful) is in the init hook, where it prevents the |
|
|
808 | terminal from starting up. |
770 | |
809 | |
771 | =item urxvt::warn $string |
810 | =item urxvt::warn $string |
772 | |
811 | |
773 | Calls C<rxvt_warn> with the given string which should not include a |
812 | Calls C<rxvt_warn> with the given string which should include a trailing |
774 | newline. The module also overwrites the C<warn> builtin with a function |
813 | newline. The module also overwrites the C<warn> builtin with a function |
775 | that calls this function. |
814 | that calls this function. |
776 | |
815 | |
777 | Using this function has the advantage that its output ends up in the |
816 | Using this function has the advantage that its output ends up in the |
778 | correct place, e.g. on stderr of the connecting urxvtc client. |
817 | correct place, e.g. on stderr of the connecting urxvtc client. |
… | |
… | |
782 | =item @terms = urxvt::termlist |
821 | =item @terms = urxvt::termlist |
783 | |
822 | |
784 | Returns all urxvt::term objects that exist in this process, regardless of |
823 | Returns all urxvt::term objects that exist in this process, regardless of |
785 | whether they are started, being destroyed etc., so be careful. Only term |
824 | whether they are started, being destroyed etc., so be careful. Only term |
786 | objects that have perl extensions attached will be returned (because there |
825 | objects that have perl extensions attached will be returned (because there |
787 | is no urxvt::term objet associated with others). |
826 | is no urxvt::term object associated with others). |
788 | |
827 | |
789 | =item $time = urxvt::NOW |
828 | =item $time = urxvt::NOW |
790 | |
829 | |
791 | Returns the "current time" (as per the event loop). |
830 | Returns the "current time" (as per the event loop). |
792 | |
831 | |
… | |
… | |
835 | |
874 | |
836 | =item $rend = urxvt::OVERLAY_RSTYLE |
875 | =item $rend = urxvt::OVERLAY_RSTYLE |
837 | |
876 | |
838 | Return the rendition mask used for overlays by default. |
877 | Return the rendition mask used for overlays by default. |
839 | |
878 | |
840 | =item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline |
879 | =item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink, |
|
|
880 | urxvt::RS_RVid, urxvt::RS_Uline |
841 | |
881 | |
842 | Return the bit that enabled bold, italic, blink, reverse-video and |
882 | Return the bit that enabled bold, italic, blink, reverse-video and |
843 | underline, respectively. To enable such a style, just logically OR it into |
883 | underline, respectively. To enable such a style, just logically OR it into |
844 | the bitset. |
884 | the bitset. |
845 | |
885 | |
… | |
… | |
1104 | is that you cannot use blocking APIs, but the non-blocking variant should |
1144 | is that you cannot use blocking APIs, but the non-blocking variant should |
1105 | work. |
1145 | work. |
1106 | |
1146 | |
1107 | =cut |
1147 | =cut |
1108 | |
1148 | |
1109 | our $VERSION = '3.4'; |
1149 | our $VERSION = '5.23'; |
1110 | |
1150 | |
1111 | $INC{"urxvt/anyevent.pm"} = 1; # mark us as there |
1151 | $INC{"urxvt/anyevent.pm"} = 1; # mark us as there |
1112 | push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; |
1152 | push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; |
1113 | |
1153 | |
1114 | sub timer { |
1154 | sub timer { |
… | |
… | |
1116 | |
1156 | |
1117 | my $cb = $arg{cb}; |
1157 | my $cb = $arg{cb}; |
1118 | |
1158 | |
1119 | urxvt::timer |
1159 | urxvt::timer |
1120 | ->new |
1160 | ->new |
1121 | ->start (urxvt::NOW + $arg{after}) |
1161 | ->after ($arg{after}, $arg{interval}) |
1122 | ->cb (sub { |
1162 | ->cb ($arg{interval} ? $cb : sub { |
1123 | $_[0]->stop; # need to cancel manually |
1163 | $_[0]->stop; # need to cancel manually |
1124 | $cb->(); |
1164 | $cb->(); |
1125 | }) |
1165 | }) |
1126 | } |
1166 | } |
1127 | |
1167 | |
1128 | sub io { |
1168 | sub io { |
1129 | my ($class, %arg) = @_; |
1169 | my ($class, %arg) = @_; |
1130 | |
1170 | |
1131 | my $cb = $arg{cb}; |
1171 | my $cb = $arg{cb}; |
|
|
1172 | my $fd = fileno $arg{fh}; |
|
|
1173 | defined $fd or $fd = $arg{fh}; |
1132 | |
1174 | |
1133 | bless [$arg{fh}, urxvt::iow |
1175 | bless [$arg{fh}, urxvt::iow |
1134 | ->new |
1176 | ->new |
1135 | ->fd (fileno $arg{fh}) |
1177 | ->fd ($fd) |
1136 | ->events (($arg{poll} =~ /r/ ? 1 : 0) |
1178 | ->events (($arg{poll} =~ /r/ ? 1 : 0) |
1137 | | ($arg{poll} =~ /w/ ? 2 : 0)) |
1179 | | ($arg{poll} =~ /w/ ? 2 : 0)) |
1138 | ->start |
1180 | ->start |
1139 | ->cb (sub { |
1181 | ->cb ($cb) |
1140 | $cb->(($_[1] & 1 ? 'r' : '') |
|
|
1141 | . ($_[1] & 2 ? 'w' : '')); |
|
|
1142 | })], |
|
|
1143 | urxvt::anyevent:: |
1182 | ], urxvt::anyevent:: |
|
|
1183 | } |
|
|
1184 | |
|
|
1185 | sub idle { |
|
|
1186 | my ($class, %arg) = @_; |
|
|
1187 | |
|
|
1188 | my $cb = $arg{cb}; |
|
|
1189 | |
|
|
1190 | urxvt::iw |
|
|
1191 | ->new |
|
|
1192 | ->start |
|
|
1193 | ->cb ($cb) |
|
|
1194 | } |
|
|
1195 | |
|
|
1196 | sub child { |
|
|
1197 | my ($class, %arg) = @_; |
|
|
1198 | |
|
|
1199 | my $cb = $arg{cb}; |
|
|
1200 | |
|
|
1201 | urxvt::pw |
|
|
1202 | ->new |
|
|
1203 | ->start ($arg{pid}) |
|
|
1204 | ->cb (sub { |
|
|
1205 | $_[0]->stop; # need to cancel manually |
|
|
1206 | $cb->($_[0]->rpid, $_[0]->rstatus); |
|
|
1207 | }) |
1144 | } |
1208 | } |
1145 | |
1209 | |
1146 | sub DESTROY { |
1210 | sub DESTROY { |
1147 | $_[0][1]->stop; |
1211 | $_[0][1]->stop; |
1148 | } |
1212 | } |
1149 | |
1213 | |
|
|
1214 | # only needed for AnyEvent < 6 compatibility |
1150 | sub one_event { |
1215 | sub one_event { |
1151 | Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; |
1216 | Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; |
1152 | } |
1217 | } |
1153 | |
1218 | |
1154 | package urxvt::term; |
1219 | package urxvt::term; |
… | |
… | |
1246 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1311 | C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. |
1247 | |
1312 | |
1248 | Here is a likely non-exhaustive list of option names, please see the |
1313 | Here is a likely non-exhaustive list of option names, please see the |
1249 | source file F</src/optinc.h> to see the actual list: |
1314 | source file F</src/optinc.h> to see the actual list: |
1250 | |
1315 | |
1251 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1316 | borderLess buffered console cursorBlink cursorUnderline hold iconic |
1252 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1317 | insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell |
1253 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
1318 | mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs |
1254 | scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput |
1319 | pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right |
1255 | scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs |
1320 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen |
1256 | transparent tripleclickwords utmpInhibit visualBell |
1321 | secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords |
|
|
1322 | urgentOnBell utmpInhibit visualBell |
1257 | |
1323 | |
1258 | =item $value = $term->resource ($name[, $newval]) |
1324 | =item $value = $term->resource ($name[, $newval]) |
1259 | |
1325 | |
1260 | Returns the current resource value associated with a given name and |
1326 | Returns the current resource value associated with a given name and |
1261 | optionally sets a new value. Setting values is most useful in the C<init> |
1327 | optionally sets a new value. Setting values is most useful in the C<init> |
… | |
… | |
1274 | |
1340 | |
1275 | Here is a likely non-exhaustive list of resource names, not all of which |
1341 | Here is a likely non-exhaustive list of resource names, not all of which |
1276 | are supported in every build, please see the source file F</src/rsinc.h> |
1342 | are supported in every build, please see the source file F</src/rsinc.h> |
1277 | to see the actual list: |
1343 | to see the actual list: |
1278 | |
1344 | |
1279 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1345 | answerbackstring backgroundPixmap backspace_key blendtype blurradius |
1280 | borderLess chdir color cursorBlink cursorUnderline cutchars delete_key |
1346 | boldFont boldItalicFont borderLess buffered chdir color cursorBlink |
1281 | display_name embed ext_bwidth fade font geometry hold iconName |
1347 | cursorUnderline cutchars delete_key depth display_name embed ext_bwidth |
1282 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
1348 | fade font geometry hold iconName iconfile imFont imLocale inputMethod |
|
|
1349 | insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont |
1283 | italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier |
1350 | jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier |
1284 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
1351 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
1285 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
1352 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
1286 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
1353 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
1287 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
1354 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
1288 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
1355 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
1289 | secondaryScreen secondaryScroll shade term_name title |
1356 | secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll |
1290 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
1357 | term_name title transient_for transparent tripleclickwords urgentOnBell |
1291 | visualBell |
1358 | utmpInhibit visualBell |
1292 | |
1359 | |
1293 | =cut |
1360 | =cut |
1294 | |
1361 | |
1295 | sub resource($$;$) { |
1362 | sub resource($$;$) { |
1296 | my ($self, $name) = (shift, shift); |
1363 | my ($self, $name) = (shift, shift); |
… | |
… | |
1328 | |
1395 | |
1329 | =item ($row, $col) = $term->selection_beg ([$row, $col]) |
1396 | =item ($row, $col) = $term->selection_beg ([$row, $col]) |
1330 | |
1397 | |
1331 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
1398 | =item ($row, $col) = $term->selection_end ([$row, $col]) |
1332 | |
1399 | |
1333 | Return the current values of the selection mark, begin or end positions, |
1400 | Return the current values of the selection mark, begin or end positions. |
1334 | and optionally set them to new values. |
1401 | |
|
|
1402 | When arguments are given, then the selection coordinates are set to |
|
|
1403 | C<$row> and C<$col>, and the selection screen is set to the current |
|
|
1404 | screen. |
|
|
1405 | |
|
|
1406 | =item $screen = $term->selection_screen ([$screen]) |
|
|
1407 | |
|
|
1408 | Returns the current selection screen, and then optionally sets it. |
1335 | |
1409 | |
1336 | =item $term->selection_make ($eventtime[, $rectangular]) |
1410 | =item $term->selection_make ($eventtime[, $rectangular]) |
1337 | |
1411 | |
1338 | Tries to make a selection as set by C<selection_beg> and |
1412 | Tries to make a selection as set by C<selection_beg> and |
1339 | C<selection_end>. If C<$rectangular> is true (default: false), a |
1413 | C<selection_end>. If C<$rectangular> is true (default: false), a |
1340 | rectangular selection will be made. This is the prefered function to make |
1414 | rectangular selection will be made. This is the preferred function to make |
1341 | a selection. |
1415 | a selection. |
1342 | |
1416 | |
1343 | =item $success = $term->selection_grab ($eventtime) |
1417 | =item $success = $term->selection_grab ($eventtime[, $clipboard]) |
1344 | |
1418 | |
1345 | Try to request the primary selection text from the server (for example, as |
1419 | Try to acquire ownership of the primary (clipboard if C<$clipboard> is |
|
|
1420 | true) selection from the server. The corresponding text can be set |
1346 | set by the next method). No visual feedback will be given. This function |
1421 | with the next method. No visual feedback will be given. This function |
1347 | is mostly useful from within C<on_sel_grab> hooks. |
1422 | is mostly useful from within C<on_sel_grab> hooks. |
1348 | |
1423 | |
1349 | =item $oldtext = $term->selection ([$newtext]) |
1424 | =item $oldtext = $term->selection ([$newtext, $clipboard]) |
1350 | |
1425 | |
1351 | Return the current selection text and optionally replace it by C<$newtext>. |
1426 | Return the current selection (clipboard if C<$clipboard> is true) text |
|
|
1427 | and optionally replace it by C<$newtext>. |
|
|
1428 | |
|
|
1429 | =item $term->selection_clear ([$clipboard]) |
|
|
1430 | |
|
|
1431 | Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection. |
1352 | |
1432 | |
1353 | =item $term->overlay_simple ($x, $y, $text) |
1433 | =item $term->overlay_simple ($x, $y, $text) |
1354 | |
1434 | |
1355 | Create a simple multi-line overlay box. See the next method for details. |
1435 | Create a simple multi-line overlay box. See the next method for details. |
1356 | |
1436 | |
… | |
… | |
1386 | |
1466 | |
1387 | The methods currently supported on C<urxvt::overlay> objects are: |
1467 | The methods currently supported on C<urxvt::overlay> objects are: |
1388 | |
1468 | |
1389 | =over 4 |
1469 | =over 4 |
1390 | |
1470 | |
1391 | =item $overlay->set ($x, $y, $text, $rend) |
1471 | =item $overlay->set ($x, $y, $text[, $rend]) |
1392 | |
1472 | |
1393 | Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts |
1473 | Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts |
1394 | text in rxvt-unicode's special encoding and an array of rendition values |
1474 | text in rxvt-unicode's special encoding and an array of rendition values |
1395 | at a specific position inside the overlay. |
1475 | at a specific position inside the overlay. |
|
|
1476 | |
|
|
1477 | If C<$rend> is missing, then the rendition will not be changed. |
1396 | |
1478 | |
1397 | =item $overlay->hide |
1479 | =item $overlay->hide |
1398 | |
1480 | |
1399 | If visible, hide the overlay, but do not destroy it. |
1481 | If visible, hide the overlay, but do not destroy it. |
1400 | |
1482 | |
… | |
… | |
1482 | locale-specific encoding of the terminal and can contain command sequences |
1564 | locale-specific encoding of the terminal and can contain command sequences |
1483 | (escape codes) that will be interpreted. |
1565 | (escape codes) that will be interpreted. |
1484 | |
1566 | |
1485 | =item $term->tt_write ($octets) |
1567 | =item $term->tt_write ($octets) |
1486 | |
1568 | |
1487 | Write the octets given in C<$data> to the tty (i.e. as program input). To |
1569 | Write the octets given in C<$octets> to the tty (i.e. as program input). To |
1488 | pass characters instead of octets, you should convert your strings first |
1570 | pass characters instead of octets, you should convert your strings first |
1489 | to the locale-specific encoding using C<< $term->locale_encode >>. |
1571 | to the locale-specific encoding using C<< $term->locale_encode >>. |
|
|
1572 | |
|
|
1573 | =item $term->tt_paste ($octets) |
|
|
1574 | |
|
|
1575 | Write the octets given in C<$octets> to the tty as a paste, converting NL to |
|
|
1576 | CR and bracketing the data with control sequences if bracketed paste mode |
|
|
1577 | is set. |
1490 | |
1578 | |
1491 | =item $old_events = $term->pty_ev_events ([$new_events]) |
1579 | =item $old_events = $term->pty_ev_events ([$new_events]) |
1492 | |
1580 | |
1493 | Replaces the event mask of the pty watcher by the given event mask. Can |
1581 | Replaces the event mask of the pty watcher by the given event mask. Can |
1494 | be used to suppress input and output handling to the pty/tty. See the |
1582 | be used to suppress input and output handling to the pty/tty. See the |
… | |
… | |
1808 | Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most |
1896 | Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most |
1809 | recent grab. |
1897 | recent grab. |
1810 | |
1898 | |
1811 | =item $term->ungrab |
1899 | =item $term->ungrab |
1812 | |
1900 | |
1813 | Calls XUngrab for the most recent grab. Is called automatically on |
1901 | Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on |
1814 | evaluation errors, as it is better to lose the grab in the error case as |
1902 | evaluation errors, as it is better to lose the grab in the error case as |
1815 | the session. |
1903 | the session. |
1816 | |
1904 | |
1817 | =item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) |
1905 | =item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) |
1818 | |
1906 | |
… | |
… | |
1840 | |
1928 | |
1841 | =item $term->XChangeInput ($window, $add_events[, $del_events]) |
1929 | =item $term->XChangeInput ($window, $add_events[, $del_events]) |
1842 | |
1930 | |
1843 | Various X or X-related functions. The C<$term> object only serves as |
1931 | Various X or X-related functions. The C<$term> object only serves as |
1844 | the source of the display, otherwise those functions map more-or-less |
1932 | the source of the display, otherwise those functions map more-or-less |
1845 | directory onto the X functions of the same name. |
1933 | directly onto the X functions of the same name. |
1846 | |
1934 | |
1847 | =back |
1935 | =back |
1848 | |
1936 | |
1849 | =cut |
1937 | =cut |
1850 | |
1938 | |
… | |
… | |
2007 | |
2095 | |
2008 | =item $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
2096 | =item $timer = $timer->cb (sub { my ($timer) = @_; ... }) |
2009 | |
2097 | |
2010 | Set the callback to be called when the timer triggers. |
2098 | Set the callback to be called when the timer triggers. |
2011 | |
2099 | |
2012 | =item $tstamp = $timer->at |
|
|
2013 | |
|
|
2014 | Return the time this watcher will fire next. |
|
|
2015 | |
|
|
2016 | =item $timer = $timer->set ($tstamp) |
2100 | =item $timer = $timer->set ($tstamp[, $interval]) |
2017 | |
2101 | |
2018 | Set the time the event is generated to $tstamp. |
2102 | Set the time the event is generated to $tstamp (and optionally specifies a |
|
|
2103 | new $interval). |
2019 | |
2104 | |
2020 | =item $timer = $timer->interval ($interval) |
2105 | =item $timer = $timer->interval ($interval) |
2021 | |
2106 | |
2022 | Normally (and when C<$interval> is C<0>), the timer will automatically |
2107 | By default (and when C<$interval> is C<0>), the timer will automatically |
2023 | stop after it has fired once. If C<$interval> is non-zero, then the timer |
2108 | stop after it has fired once. If C<$interval> is non-zero, then the timer |
2024 | is automatically rescheduled at the given intervals. |
2109 | is automatically rescheduled at the given intervals. |
2025 | |
2110 | |
2026 | =item $timer = $timer->start |
2111 | =item $timer = $timer->start |
2027 | |
2112 | |
2028 | Start the timer. |
2113 | Start the timer. |
2029 | |
2114 | |
2030 | =item $timer = $timer->start ($tstamp) |
2115 | =item $timer = $timer->start ($tstamp[, $interval]) |
2031 | |
2116 | |
2032 | Set the event trigger time to C<$tstamp> and start the timer. |
2117 | Set the event trigger time to C<$tstamp> and start the timer. Optionally |
|
|
2118 | also replaces the interval. |
2033 | |
2119 | |
2034 | =item $timer = $timer->after ($delay) |
2120 | =item $timer = $timer->after ($delay[, $interval]) |
2035 | |
2121 | |
2036 | Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. |
2122 | Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. |
2037 | |
2123 | |
2038 | =item $timer = $timer->stop |
2124 | =item $timer = $timer->stop |
2039 | |
2125 | |
… | |
… | |
2170 | |
2256 | |
2171 | =back |
2257 | =back |
2172 | |
2258 | |
2173 | =head1 AUTHOR |
2259 | =head1 AUTHOR |
2174 | |
2260 | |
2175 | Marc Lehmann <pcg@goof.com> |
2261 | Marc Lehmann <schmorp@schmorp.de> |
2176 | http://software.schmorp.de/pkg/rxvt-unicode |
2262 | http://software.schmorp.de/pkg/rxvt-unicode |
2177 | |
2263 | |
2178 | =cut |
2264 | =cut |
2179 | |
2265 | |
2180 | 1 |
2266 | 1 |