ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/src/urxvt.pm
(Generate patch)

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.178 by root, Sat Dec 26 09:02:42 2009 UTC vs.
Revision 1.207 by root, Tue Jun 5 21:29:52 2012 UTC

259The default pattern to match URLs can be overridden with the 259The default pattern to match URLs can be overridden with the
260C<matcher.pattern.0> resource, and additional patterns can be specified 260C<matcher.pattern.0> resource, and additional patterns can be specified
261with numbered patterns, in a manner similar to the "selection" extension. 261with numbered patterns, in a manner similar to the "selection" extension.
262The launcher can also be overridden on a per-pattern basis. 262The launcher can also be overridden on a per-pattern basis.
263 263
264It is possible to activate the most recently seen match from the keyboard. 264It is possible to activate the most recently seen match or a list of matches
265from the keyboard. Simply bind a keysym to "perl:matcher:last" or
265Simply bind a keysym to "perl:matcher" as seen in the example below. 266"perl:matcher:list" as seen in the example below.
266 267
267Example configuration: 268Example 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
346This is a little rarely useful extension that Uploads the selection as 348This is a little rarely useful extension that uploads the selection as
347textfile to a remote site (or does other things). (The implementation is 349textfile to a remote site (or does other things). (The implementation is
348not currently secure for use in a multiuser environment as it writes to 350not currently secure for use in a multiuser environment as it writes to
349F</tmp> directly.). 351F</tmp> directly.).
350 352
351It listens to the C<selection-pastebin:remote-pastebin> keyboard command, 353It 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
373I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret 375I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
374the double C</> characters as comment start. Use C<\057\057> instead, 376the double C</> characters as comment start. Use C<\057\057> instead,
375which works regardless of wether xrdb is used to parse the resource file 377which works regardless of whether xrdb is used to parse the resource file
376or not. 378or not.
377 379
378=item macosx-pastebin and macosx-pastebin-native 380=item macosx-clipboard and macosx-clipboard-native
379 381
380These two modules implement an extended clipboard for Mac OS X. They are 382These two modules implement an extended clipboard for Mac OS X. They are
381used like this: 383used like this:
382 384
383 URxvt.perl-ext-common: default,macosx-clipboard 385 URxvt.perl-ext-common: default,macosx-clipboard
384 URxvt.keysym.M-c: perl:macosx-clipboard:copy 386 URxvt.keysym.M-c: perl:macosx-clipboard:copy
385 URxvt.keysym.M-v: perl:macosx-clipboard:paste 387 URxvt.keysym.M-v: perl:macosx-clipboard:paste
386 388
387The difference between them is that the native variant requires a 389The difference between them is that the native variant requires a
388perl from apple's devkit or so, and C<maxosx-pastebin> requires the 390perl from apple's devkit or so, and C<macosx-clipboard> requires the
389C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is 391C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
390simpler etc. etc. 392simpler etc. etc.
391 393
392=item example-refresh-hooks 394=item example-refresh-hooks
393 395
394Displays a very simple digital clock in the upper right corner of the 396Displays a very simple digital clock in the upper right corner of the
395window. Illustrates overwriting the refresh callbacks to create your own 397window. Illustrates overwriting the refresh callbacks to create your own
396overlays or changes. 398overlays or changes.
399
400=item confirm-paste
401
402Displays a confirmation dialog when a paste containing at least a full
403line is detected.
404
405=item bell-command
406
407Runs the command specified by the C<URxvt.bell-command> resource when
408a bell event occurs. For example, the following pops up a notification
409bubble with the text "Beep, Beep" using notify-send:
410
411 URxvt.bell-command: notify-send "Beep, Beep"
397 412
398=back 413=back
399 414
400=head1 API DOCUMENTATION 415=head1 API DOCUMENTATION
401 416
417 432
418=over 4 433=over 4
419 434
420=item $text 435=item $text
421 436
422Rxvt-unicodes special way of encoding text, where one "unicode" character 437Rxvt-unicode's special way of encoding text, where one "unicode" character
423always represents one screen cell. See L<ROW_t> for a discussion of this format. 438always represents one screen cell. See L<ROW_t> for a discussion of this format.
424 439
425=item $string 440=item $string
426 441
427A perl text string, with an emphasis on I<text>. It can store all unicode 442A perl text string, with an emphasis on I<text>. It can store all unicode
431=item $octets 446=item $octets
432 447
433Either binary data or - more common - a text string encoded in a 448Either binary data or - more common - a text string encoded in a
434locale-specific way. 449locale-specific way.
435 450
451=item $keysym
452
453an integer that is a valid X11 keysym code. You can convert a string
454into a keysym and viceversa by using C<XStringToKeysym> and
455C<XKeysymToString>.
456
436=back 457=back
437 458
438=head2 Extension Objects 459=head2 Extension Objects
439 460
440Every perl extension is a perl class. A separate perl object is created 461Every perl extension is a perl class. A separate perl object is created
441for each terminal, and each terminal has its own set of extenion objects, 462for each terminal, and each terminal has its own set of extension objects,
442which are passed as the first parameter to hooks. So extensions can use 463which are passed as the first parameter to hooks. So extensions can use
443their C<$self> object without having to think about clashes with other 464their C<$self> object without having to think about clashes with other
444extensions or other terminals, with the exception of methods and members 465extensions or other terminals, with the exception of methods and members
445that begin with an underscore character C<_>: these are reserved for 466that begin with an underscore character C<_>: these are reserved for
446internal use. 467internal use.
610=item on_tt_write $term, $octets 631=item on_tt_write $term, $octets
611 632
612Called whenever some data is written to the tty/pty and can be used to 633Called whenever some data is written to the tty/pty and can be used to
613suppress or filter tty input. 634suppress or filter tty input.
614 635
636=item on_tt_paste $term, $octets
637
638Called whenever text is about to be pasted, with the text as argument. You
639can filter/change and paste the text yourself by returning a true value
640and calling C<< $term->tt_paste >> yourself. C<$octets> is
641locale-encoded.
642
615=item on_line_update $term, $row 643=item on_line_update $term, $row
616 644
617Called whenever a line was updated or changed. Can be used to filter 645Called whenever a line was updated or changed. Can be used to filter
618screen output (e.g. underline urls or other useless stuff). Only lines 646screen output (e.g. underline urls or other useless stuff). Only lines
619that are being shown will be filtered, and, due to performance reasons, 647that are being shown will be filtered, and, due to performance reasons,
644resource in the @@RXVT_NAME@@(1) manpage). 672resource in the @@RXVT_NAME@@(1) manpage).
645 673
646The event is simply the action string. This interface is assumed to change 674The event is simply the action string. This interface is assumed to change
647slightly in the future. 675slightly in the future.
648 676
677=item on_register_command $term, $keysym, $modifiermask, $string
678
679Called after parsing a keysym resource but before registering the
680associated binding. If this hook returns TRUE the binding is not
681registered. It can be used to modify a binding by calling
682C<register_command>.
683
649=item on_resize_all_windows $tern, $new_width, $new_height 684=item on_resize_all_windows $term, $new_width, $new_height
650 685
651Called just after the new window size has been calculated, but before 686Called just after the new window size has been calculated, but before
652windows are actually being resized or hints are being set. If this hook 687windows are actually being resized or hints are being set. If this hook
653returns TRUE, setting of the window hints is being skipped. 688returns TRUE, setting of the window hints is being skipped.
654 689
688 723
689=item on_map_notify $term, $event 724=item on_map_notify $term, $event
690 725
691=item on_unmap_notify $term, $event 726=item on_unmap_notify $term, $event
692 727
693Called whenever the corresponding X event is received for the terminal If 728Called whenever the corresponding X event is received for the terminal. If
694the hook returns true, then the even will be ignored by rxvt-unicode. 729the hook returns true, then the event will be ignored by rxvt-unicode.
695 730
696The event is a hash with most values as named by Xlib (see the XEvent 731The event is a hash with most values as named by Xlib (see the XEvent
697manpage), with the additional members C<row> and C<col>, which are the 732manpage), with the additional members C<row> and C<col>, which are the
698(real, not screen-based) row and column under the mouse cursor. 733(real, not screen-based) row and column under the mouse cursor.
699 734
708 743
709=item on_wm_delete_window $term, $event 744=item on_wm_delete_window $term, $event
710 745
711Called when various types of ClientMessage events are received (all with 746Called when various types of ClientMessage events are received (all with
712format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). 747format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
748
749=item on_bell $term
750
751Called on receipt of a bell character.
713 752
714=back 753=back
715 754
716=cut 755=cut
717 756
782 821
783=over 4 822=over 4
784 823
785=item urxvt::fatal $errormessage 824=item urxvt::fatal $errormessage
786 825
787Fatally aborts execution with the given error message. Avoid at all 826Fatally aborts execution with the given error message (which should
788costs! The only time this is acceptable is when the terminal process 827include a trailing newline). Avoid at all costs! The only time this
789starts up. 828is acceptable (and useful) is in the init hook, where it prevents the
829terminal from starting up.
790 830
791=item urxvt::warn $string 831=item urxvt::warn $string
792 832
793Calls C<rxvt_warn> with the given string which should not include a 833Calls C<rxvt_warn> with the given string which should include a trailing
794newline. The module also overwrites the C<warn> builtin with a function 834newline. The module also overwrites the C<warn> builtin with a function
795that calls this function. 835that calls this function.
796 836
797Using this function has the advantage that its output ends up in the 837Using this function has the advantage that its output ends up in the
798correct place, e.g. on stderr of the connecting urxvtc client. 838correct place, e.g. on stderr of the connecting urxvtc client.
802=item @terms = urxvt::termlist 842=item @terms = urxvt::termlist
803 843
804Returns all urxvt::term objects that exist in this process, regardless of 844Returns all urxvt::term objects that exist in this process, regardless of
805whether they are started, being destroyed etc., so be careful. Only term 845whether they are started, being destroyed etc., so be careful. Only term
806objects that have perl extensions attached will be returned (because there 846objects that have perl extensions attached will be returned (because there
807is no urxvt::term objet associated with others). 847is no urxvt::term object associated with others).
808 848
809=item $time = urxvt::NOW 849=item $time = urxvt::NOW
810 850
811Returns the "current time" (as per the event loop). 851Returns the "current time" (as per the event loop).
812 852
855 895
856=item $rend = urxvt::OVERLAY_RSTYLE 896=item $rend = urxvt::OVERLAY_RSTYLE
857 897
858Return the rendition mask used for overlays by default. 898Return the rendition mask used for overlays by default.
859 899
860=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline 900=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
901urxvt::RS_RVid, urxvt::RS_Uline
861 902
862Return the bit that enabled bold, italic, blink, reverse-video and 903Return the bit that enabled bold, italic, blink, reverse-video and
863underline, respectively. To enable such a style, just logically OR it into 904underline, respectively. To enable such a style, just logically OR it into
864the bitset. 905the bitset.
865 906
902 }; 943 };
903} 944}
904 945
905no warnings 'utf8'; 946no warnings 'utf8';
906 947
948sub perl_libdirs {
949 map { split /:/ }
950 $_[0]->resource ("perl_lib"),
951 $ENV{URXVT_PERL_LIB},
952 "$ENV{HOME}/.urxvt/ext",
953 "$LIBDIR/perl"
954}
955
956our %META; # meta header information from scripts
957our %SCAN; # which dirs already scanned
958
959sub resource {
960 my ($term, $name, $isarg, $flag, $value) = @_;
961
962 for my $dir (perl_libdirs $term) {
963 }
964
965 warn "resourece<@_>\n";#d#
966
967 0
968}
969
907my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 970my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
908 971
909sub verbose { 972sub verbose {
910 my ($level, $msg) = @_; 973 my ($level, $msg) = @_;
911 warn "$msg\n" if $level <= $verbosity; 974 warn "$msg\n" if $level <= $verbosity;
947sub invoke { 1010sub invoke {
948 local $TERM = shift; 1011 local $TERM = shift;
949 my $htype = shift; 1012 my $htype = shift;
950 1013
951 if ($htype == 0) { # INIT 1014 if ($htype == 0) { # INIT
952 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 1015 my @dirs = perl_libdirs $TERM;
953 1016
954 my %ext_arg; 1017 my %ext_arg;
955 1018
956 { 1019 {
957 my @init = @TERM_INIT; 1020 my @init = @TERM_INIT;
1136 1199
1137 my $cb = $arg{cb}; 1200 my $cb = $arg{cb};
1138 1201
1139 urxvt::timer 1202 urxvt::timer
1140 ->new 1203 ->new
1141 ->after ($arg{after}) 1204 ->after ($arg{after}, $arg{interval})
1142 ->interval ($arg{interval})
1143 ->start
1144 ->cb ($argv{interval} ? $cb : sub { 1205 ->cb ($arg{interval} ? $cb : sub {
1145 $_[0]->stop; # need to cancel manually 1206 $_[0]->stop; # need to cancel manually
1146 $cb->(); 1207 $cb->();
1147 }) 1208 })
1148} 1209}
1149 1210
1191 1252
1192sub DESTROY { 1253sub DESTROY {
1193 $_[0][1]->stop; 1254 $_[0][1]->stop;
1194} 1255}
1195 1256
1257# only needed for AnyEvent < 6 compatibility
1196sub one_event { 1258sub one_event {
1197 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; 1259 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1198} 1260}
1199 1261
1200package urxvt::term; 1262package urxvt::term;
1292C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1354C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1293 1355
1294Here is a likely non-exhaustive list of option names, please see the 1356Here is a likely non-exhaustive list of option names, please see the
1295source file F</src/optinc.h> to see the actual list: 1357source file F</src/optinc.h> to see the actual list:
1296 1358
1297 borderLess console cursorBlink cursorUnderline hold iconic insecure 1359 borderLess buffered console cursorBlink cursorUnderline hold iconic
1298 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1360 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1299 override-redirect pastableTabs pointerBlank reverseVideo scrollBar 1361 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1300 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput 1362 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1301 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs 1363 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1302 transparent tripleclickwords utmpInhibit visualBell 1364 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1365 urgentOnBell utmpInhibit visualBell
1303 1366
1304=item $value = $term->resource ($name[, $newval]) 1367=item $value = $term->resource ($name[, $newval])
1305 1368
1306Returns the current resource value associated with a given name and 1369Returns the current resource value associated with a given name and
1307optionally sets a new value. Setting values is most useful in the C<init> 1370optionally sets a new value. Setting values is most useful in the C<init>
1320 1383
1321Here is a likely non-exhaustive list of resource names, not all of which 1384Here is a likely non-exhaustive list of resource names, not all of which
1322are supported in every build, please see the source file F</src/rsinc.h> 1385are supported in every build, please see the source file F</src/rsinc.h>
1323to see the actual list: 1386to see the actual list:
1324 1387
1325 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1388 answerbackstring backgroundPixmap backspace_key blendtype blurradius
1326 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key 1389 boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1327 display_name embed ext_bwidth fade font geometry hold iconName 1390 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1328 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1391 fade font geometry hold iconName iconfile imFont imLocale inputMethod
1329 italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8 1392 insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1393 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1330 modifier mouseWheelScrollPage name override_redirect pastableTabs path 1394 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1331 perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1395 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1332 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1396 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1333 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1397 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1334 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1398 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1335 secondaryScreen secondaryScroll shade term_name title 1399 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1336 transient_for transparent transparent_all tripleclickwords utmpInhibit 1400 term_name title transient_for transparent tripleclickwords urgentOnBell
1337 visualBell 1401 utmpInhibit visualBell
1338 1402
1339=cut 1403=cut
1340 1404
1341sub resource($$;$) { 1405sub resource($$;$) {
1342 my ($self, $name) = (shift, shift); 1406 my ($self, $name) = (shift, shift);
1353 1417
1354This method should only be called during the C<on_start> hook, as there is 1418This method should only be called during the C<on_start> hook, as there is
1355only one resource database per display, and later invocations might return 1419only one resource database per display, and later invocations might return
1356the wrong resources. 1420the wrong resources.
1357 1421
1358=item $success = $term->parse_keysym ($keysym_spec, $command_string) 1422=item $success = $term->parse_keysym ($key, $octets)
1359 1423
1360Adds a keymap translation exactly as specified via a resource. See the 1424Adds a key binding exactly as specified via a resource. See the
1361C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 1425C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
1426
1427=item $term->register_command ($keysym, $modifiermask, $string)
1428
1429Adds a key binding. This is a lower level api compared to
1430C<parse_keysym>, as it expects a parsed key description, and can be
1431used only inside either the C<on_init> hook, to add a binding, or the
1432C<on_register_command> hook, to modify a parsed binding.
1362 1433
1363=item $rend = $term->rstyle ([$new_rstyle]) 1434=item $rend = $term->rstyle ([$new_rstyle])
1364 1435
1365Return and optionally change the current rendition. Text that is output by 1436Return and optionally change the current rendition. Text that is output by
1366the terminal application will use this style. 1437the terminal application will use this style.
1374 1445
1375=item ($row, $col) = $term->selection_beg ([$row, $col]) 1446=item ($row, $col) = $term->selection_beg ([$row, $col])
1376 1447
1377=item ($row, $col) = $term->selection_end ([$row, $col]) 1448=item ($row, $col) = $term->selection_end ([$row, $col])
1378 1449
1379Return the current values of the selection mark, begin or end positions, 1450Return the current values of the selection mark, begin or end positions.
1380and optionally set them to new values. 1451
1452When arguments are given, then the selection coordinates are set to
1453C<$row> and C<$col>, and the selection screen is set to the current
1454screen.
1455
1456=item $screen = $term->selection_screen ([$screen])
1457
1458Returns the current selection screen, and then optionally sets it.
1381 1459
1382=item $term->selection_make ($eventtime[, $rectangular]) 1460=item $term->selection_make ($eventtime[, $rectangular])
1383 1461
1384Tries to make a selection as set by C<selection_beg> and 1462Tries to make a selection as set by C<selection_beg> and
1385C<selection_end>. If C<$rectangular> is true (default: false), a 1463C<selection_end>. If C<$rectangular> is true (default: false), a
1386rectangular selection will be made. This is the prefered function to make 1464rectangular selection will be made. This is the preferred function to make
1387a selection. 1465a selection.
1388 1466
1389=item $success = $term->selection_grab ($eventtime) 1467=item $success = $term->selection_grab ($eventtime[, $clipboard])
1390 1468
1391Try to request the primary selection text from the server (for example, as 1469Try to acquire ownership of the primary (clipboard if C<$clipboard> is
1470true) selection from the server. The corresponding text can be set
1392set by the next method). No visual feedback will be given. This function 1471with the next method. No visual feedback will be given. This function
1393is mostly useful from within C<on_sel_grab> hooks. 1472is mostly useful from within C<on_sel_grab> hooks.
1394 1473
1395=item $oldtext = $term->selection ([$newtext]) 1474=item $oldtext = $term->selection ([$newtext, $clipboard])
1396 1475
1397Return the current selection text and optionally replace it by C<$newtext>. 1476Return the current selection (clipboard if C<$clipboard> is true) text
1477and optionally replace it by C<$newtext>.
1478
1479=item $term->selection_clear ([$clipboard])
1480
1481Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1398 1482
1399=item $term->overlay_simple ($x, $y, $text) 1483=item $term->overlay_simple ($x, $y, $text)
1400 1484
1401Create a simple multi-line overlay box. See the next method for details. 1485Create a simple multi-line overlay box. See the next method for details.
1402 1486
1530locale-specific encoding of the terminal and can contain command sequences 1614locale-specific encoding of the terminal and can contain command sequences
1531(escape codes) that will be interpreted. 1615(escape codes) that will be interpreted.
1532 1616
1533=item $term->tt_write ($octets) 1617=item $term->tt_write ($octets)
1534 1618
1535Write the octets given in C<$data> to the tty (i.e. as program input). To 1619Write the octets given in C<$octets> to the tty (i.e. as program input). To
1536pass characters instead of octets, you should convert your strings first 1620pass characters instead of octets, you should convert your strings first
1537to the locale-specific encoding using C<< $term->locale_encode >>. 1621to the locale-specific encoding using C<< $term->locale_encode >>.
1622
1623=item $term->tt_paste ($octets)
1624
1625Write the octets given in C<$octets> to the tty as a paste, converting NL to
1626CR and bracketing the data with control sequences if bracketed paste mode
1627is set.
1538 1628
1539=item $old_events = $term->pty_ev_events ([$new_events]) 1629=item $old_events = $term->pty_ev_events ([$new_events])
1540 1630
1541Replaces the event mask of the pty watcher by the given event mask. Can 1631Replaces the event mask of the pty watcher by the given event mask. Can
1542be used to suppress input and output handling to the pty/tty. See the 1632be used to suppress input and output handling to the pty/tty. See the
1560 1650
1561Adds the specified events to the vt event mask. Useful e.g. when you want 1651Adds the specified events to the vt event mask. Useful e.g. when you want
1562to receive pointer events all the times: 1652to receive pointer events all the times:
1563 1653
1564 $term->vt_emask_add (urxvt::PointerMotionMask); 1654 $term->vt_emask_add (urxvt::PointerMotionMask);
1655
1656=item $term->set_urgency ($set)
1657
1658Enable/disable the urgency hint on the toplevel window.
1565 1659
1566=item $term->focus_in 1660=item $term->focus_in
1567 1661
1568=item $term->focus_out 1662=item $term->focus_out
1569 1663
1856Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 1950Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1857recent grab. 1951recent grab.
1858 1952
1859=item $term->ungrab 1953=item $term->ungrab
1860 1954
1861Calls XUngrab for the most recent grab. Is called automatically on 1955Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1862evaluation errors, as it is better to lose the grab in the error case as 1956evaluation errors, as it is better to lose the grab in the error case as
1863the session. 1957the session.
1864 1958
1865=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) 1959=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1866 1960
1886 1980
1887=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) 1981=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1888 1982
1889=item $term->XChangeInput ($window, $add_events[, $del_events]) 1983=item $term->XChangeInput ($window, $add_events[, $del_events])
1890 1984
1985=item $keysym = $term->XStringToKeysym ($string)
1986
1987=item $string = $term->XKeysymToString ($keysym)
1988
1891Various X or X-related functions. The C<$term> object only serves as 1989Various X or X-related functions. The C<$term> object only serves as
1892the source of the display, otherwise those functions map more-or-less 1990the source of the display, otherwise those functions map more-or-less
1893directory onto the X functions of the same name. 1991directly onto the X functions of the same name.
1894 1992
1895=back 1993=back
1896 1994
1897=cut 1995=cut
1898 1996
2055 2153
2056=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 2154=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2057 2155
2058Set the callback to be called when the timer triggers. 2156Set the callback to be called when the timer triggers.
2059 2157
2060=item $tstamp = $timer->at
2061
2062Return the time this watcher will fire next.
2063
2064=item $timer = $timer->set ($tstamp) 2158=item $timer = $timer->set ($tstamp[, $interval])
2065 2159
2066Set the time the event is generated to $tstamp. 2160Set the time the event is generated to $tstamp (and optionally specifies a
2161new $interval).
2067 2162
2068=item $timer = $timer->interval ($interval) 2163=item $timer = $timer->interval ($interval)
2069 2164
2070Normally (and when C<$interval> is C<0>), the timer will automatically 2165By default (and when C<$interval> is C<0>), the timer will automatically
2071stop after it has fired once. If C<$interval> is non-zero, then the timer 2166stop after it has fired once. If C<$interval> is non-zero, then the timer
2072is automatically rescheduled at the given intervals. 2167is automatically rescheduled at the given intervals.
2073 2168
2074=item $timer = $timer->start 2169=item $timer = $timer->start
2075 2170
2076Start the timer. 2171Start the timer.
2077 2172
2078=item $timer = $timer->start ($tstamp) 2173=item $timer = $timer->start ($tstamp[, $interval])
2079 2174
2080Set the event trigger time to C<$tstamp> and start the timer. 2175Set the event trigger time to C<$tstamp> and start the timer. Optionally
2176also replaces the interval.
2081 2177
2082=item $timer = $timer->after ($delay) 2178=item $timer = $timer->after ($delay[, $interval])
2083 2179
2084Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. 2180Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2085 2181
2086=item $timer = $timer->stop 2182=item $timer = $timer->stop
2087 2183
2218 2314
2219=back 2315=back
2220 2316
2221=head1 AUTHOR 2317=head1 AUTHOR
2222 2318
2223 Marc Lehmann <pcg@goof.com> 2319 Marc Lehmann <schmorp@schmorp.de>
2224 http://software.schmorp.de/pkg/rxvt-unicode 2320 http://software.schmorp.de/pkg/rxvt-unicode
2225 2321
2226=cut 2322=cut
2227 2323
22281 23241

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines