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.177 by root, Sat Jul 18 06:11:57 2009 UTC vs.
Revision 1.208 by root, Tue Jun 5 22:23:07 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 resource {
949 my ($term, $name, $isarg, $flag, $value) = @_;
950
951 $term->scan_meta;
952
953 warn "resourece<@_>\n";#d#
954
955 0
956}
957
958sub usage {
959 my ($term, $usage_type) = @_;
960
961 $term->scan_meta;
962
963 my $r = $term->{meta}{resource};
964
965 for my $regex (sort keys %$r) {
966 my ($ext, $type, $desc) = @{ $r->{$regex} };
967
968 $desc .= " (-pe $ext)";
969
970 if ($usage_type == 1) {
971 if ($type eq "boolean") {
972 urxvt::log sprintf " -%-20.20s %s\n", "/+$regex", $desc;
973 } else {
974 urxvt::log sprintf " -%-20.20s %s\n", "$regex $type", $desc;
975 }
976 } else {
977 urxvt::log sprintf " %-19.19s %s\n", "$regex:", $type;
978 }
979 }
980}
981
907my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 982my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
908 983
909sub verbose { 984sub verbose {
910 my ($level, $msg) = @_; 985 my ($level, $msg) = @_;
911 warn "$msg\n" if $level <= $verbosity; 986 warn "$msg\n" if $level <= $verbosity;
947sub invoke { 1022sub invoke {
948 local $TERM = shift; 1023 local $TERM = shift;
949 my $htype = shift; 1024 my $htype = shift;
950 1025
951 if ($htype == 0) { # INIT 1026 if ($htype == 0) { # INIT
952 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 1027 my @dirs = $TERM->perl_libdirs;
953 1028
954 my %ext_arg; 1029 my %ext_arg;
955 1030
956 { 1031 {
957 my @init = @TERM_INIT; 1032 my @init = @TERM_INIT;
1124is that you cannot use blocking APIs, but the non-blocking variant should 1199is that you cannot use blocking APIs, but the non-blocking variant should
1125work. 1200work.
1126 1201
1127=cut 1202=cut
1128 1203
1129our $VERSION = '3.4'; 1204our $VERSION = '5.23';
1130 1205
1131$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1206$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1132push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1207push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1133 1208
1134sub timer { 1209sub timer {
1136 1211
1137 my $cb = $arg{cb}; 1212 my $cb = $arg{cb};
1138 1213
1139 urxvt::timer 1214 urxvt::timer
1140 ->new 1215 ->new
1141 ->after ($arg{after}) 1216 ->after ($arg{after}, $arg{interval})
1142 ->interval ($arg{interval}) 1217 ->cb ($arg{interval} ? $cb : sub {
1143 ->start
1144 ->cb (sub {
1145 #TODO interval?
1146 $_[0]->stop; # need to cancel manually 1218 $_[0]->stop; # need to cancel manually
1147 $cb->(); 1219 $cb->();
1148 }) 1220 })
1149} 1221}
1150 1222
1171 my $cb = $arg{cb}; 1243 my $cb = $arg{cb};
1172 1244
1173 urxvt::iw 1245 urxvt::iw
1174 ->new 1246 ->new
1175 ->start 1247 ->start
1176 ->cb (sub { 1248 ->cb ($cb)
1177 #TODO really cancel?
1178 $_[0]->stop; # need to cancel manually
1179 $cb->();
1180 })
1181} 1249}
1182 1250
1183sub child { 1251sub child {
1184 my ($class, %arg) = @_; 1252 my ($class, %arg) = @_;
1185 1253
1187 1255
1188 urxvt::pw 1256 urxvt::pw
1189 ->new 1257 ->new
1190 ->start ($arg{pid}) 1258 ->start ($arg{pid})
1191 ->cb (sub { 1259 ->cb (sub {
1192 #TODO really cancel?
1193 $_[0]->stop; # need to cancel manually 1260 $_[0]->stop; # need to cancel manually
1194 $cb->($_[0]->rpid, $_[0]->rstatus); 1261 $cb->($_[0]->rpid, $_[0]->rstatus);
1195 }) 1262 })
1196} 1263}
1197 1264
1198sub DESTROY { 1265sub DESTROY {
1199 $_[0][1]->stop; 1266 $_[0][1]->stop;
1200} 1267}
1201 1268
1269# only needed for AnyEvent < 6 compatibility
1202sub one_event { 1270sub one_event {
1203 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; 1271 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1204} 1272}
1205 1273
1206package urxvt::term; 1274package urxvt::term;
1235 $proxy->enable ($name => $ref); 1303 $proxy->enable ($name => $ref);
1236 } 1304 }
1237 } 1305 }
1238} 1306}
1239 1307
1308sub perl_libdirs {
1309 map { split /:/ }
1310 $_[0]->resource ("perl_lib"),
1311 $ENV{URXVT_PERL_LIB},
1312 "$ENV{HOME}/.urxvt/ext",
1313 "$LIBDIR/perl"
1314}
1315
1316sub scan_meta {
1317 my ($self) = @_;
1318 my @libdirs = perl_libdirs $self;
1319
1320 return if $self->{meta_libdirs} eq join "\x00", @libdirs;
1321
1322 my %meta;
1323
1324 $self->{meta_libdirs} = join "\x00", @libdirs;
1325 $self->{meta} = \%meta;
1326
1327 for my $dir (reverse @libdirs) {
1328 opendir my $fh, $dir
1329 or next;
1330 for my $ext (readdir $fh) {
1331 $ext ne "."
1332 and $ext ne ".."
1333 and open my $fh, "<", "$dir/$ext"
1334 or next;
1335
1336 while (<$fh>) {
1337 if (/^#:META:RESOURCE:(.*)/) {
1338 my ($regex, $type, $desc) = split /:/, $1;
1339 $regex =~ s/\$\$/$ext/g; # $$ in regex == extension name
1340 $meta{resource}{$regex} = [$ext, $type, $desc];
1341 } elsif (/^\s*(?:#|$)/) {
1342 # skip other comments and empty lines
1343 } else {
1344 last; # stop parsing on first non-empty non-comment line
1345 }
1346 }
1347 }
1348 }
1349}
1350
1240=item $term = new urxvt::term $envhashref, $rxvtname, [arg...] 1351=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1241 1352
1242Creates a new terminal, very similar as if you had started it with system 1353Creates a new terminal, very similar as if you had started it with system
1243C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like 1354C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1244hash which defines the environment of the new terminal. 1355hash which defines the environment of the new terminal.
1298C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1409C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1299 1410
1300Here is a likely non-exhaustive list of option names, please see the 1411Here is a likely non-exhaustive list of option names, please see the
1301source file F</src/optinc.h> to see the actual list: 1412source file F</src/optinc.h> to see the actual list:
1302 1413
1303 borderLess console cursorBlink cursorUnderline hold iconic insecure 1414 borderLess buffered console cursorBlink cursorUnderline hold iconic
1304 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1415 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1305 override-redirect pastableTabs pointerBlank reverseVideo scrollBar 1416 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1306 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput 1417 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1307 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs 1418 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1308 transparent tripleclickwords utmpInhibit visualBell 1419 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1420 urgentOnBell utmpInhibit visualBell
1309 1421
1310=item $value = $term->resource ($name[, $newval]) 1422=item $value = $term->resource ($name[, $newval])
1311 1423
1312Returns the current resource value associated with a given name and 1424Returns the current resource value associated with a given name and
1313optionally sets a new value. Setting values is most useful in the C<init> 1425optionally sets a new value. Setting values is most useful in the C<init>
1326 1438
1327Here is a likely non-exhaustive list of resource names, not all of which 1439Here is a likely non-exhaustive list of resource names, not all of which
1328are supported in every build, please see the source file F</src/rsinc.h> 1440are supported in every build, please see the source file F</src/rsinc.h>
1329to see the actual list: 1441to see the actual list:
1330 1442
1331 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1443 answerbackstring backgroundPixmap backspace_key blendtype blurradius
1332 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key 1444 boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1333 display_name embed ext_bwidth fade font geometry hold iconName 1445 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1334 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1446 fade font geometry hold iconName iconfile imFont imLocale inputMethod
1335 italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8 1447 insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1448 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1336 modifier mouseWheelScrollPage name override_redirect pastableTabs path 1449 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1337 perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1450 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1338 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1451 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1339 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1452 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1340 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1453 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1341 secondaryScreen secondaryScroll shade term_name title 1454 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1342 transient_for transparent transparent_all tripleclickwords utmpInhibit 1455 term_name title transient_for transparent tripleclickwords urgentOnBell
1343 visualBell 1456 utmpInhibit visualBell
1344 1457
1345=cut 1458=cut
1346 1459
1347sub resource($$;$) { 1460sub resource($$;$) {
1348 my ($self, $name) = (shift, shift); 1461 my ($self, $name) = (shift, shift);
1359 1472
1360This method should only be called during the C<on_start> hook, as there is 1473This method should only be called during the C<on_start> hook, as there is
1361only one resource database per display, and later invocations might return 1474only one resource database per display, and later invocations might return
1362the wrong resources. 1475the wrong resources.
1363 1476
1364=item $success = $term->parse_keysym ($keysym_spec, $command_string) 1477=item $success = $term->parse_keysym ($key, $octets)
1365 1478
1366Adds a keymap translation exactly as specified via a resource. See the 1479Adds a key binding exactly as specified via a resource. See the
1367C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 1480C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
1481
1482=item $term->register_command ($keysym, $modifiermask, $string)
1483
1484Adds a key binding. This is a lower level api compared to
1485C<parse_keysym>, as it expects a parsed key description, and can be
1486used only inside either the C<on_init> hook, to add a binding, or the
1487C<on_register_command> hook, to modify a parsed binding.
1368 1488
1369=item $rend = $term->rstyle ([$new_rstyle]) 1489=item $rend = $term->rstyle ([$new_rstyle])
1370 1490
1371Return and optionally change the current rendition. Text that is output by 1491Return and optionally change the current rendition. Text that is output by
1372the terminal application will use this style. 1492the terminal application will use this style.
1380 1500
1381=item ($row, $col) = $term->selection_beg ([$row, $col]) 1501=item ($row, $col) = $term->selection_beg ([$row, $col])
1382 1502
1383=item ($row, $col) = $term->selection_end ([$row, $col]) 1503=item ($row, $col) = $term->selection_end ([$row, $col])
1384 1504
1385Return the current values of the selection mark, begin or end positions, 1505Return the current values of the selection mark, begin or end positions.
1386and optionally set them to new values. 1506
1507When arguments are given, then the selection coordinates are set to
1508C<$row> and C<$col>, and the selection screen is set to the current
1509screen.
1510
1511=item $screen = $term->selection_screen ([$screen])
1512
1513Returns the current selection screen, and then optionally sets it.
1387 1514
1388=item $term->selection_make ($eventtime[, $rectangular]) 1515=item $term->selection_make ($eventtime[, $rectangular])
1389 1516
1390Tries to make a selection as set by C<selection_beg> and 1517Tries to make a selection as set by C<selection_beg> and
1391C<selection_end>. If C<$rectangular> is true (default: false), a 1518C<selection_end>. If C<$rectangular> is true (default: false), a
1392rectangular selection will be made. This is the prefered function to make 1519rectangular selection will be made. This is the preferred function to make
1393a selection. 1520a selection.
1394 1521
1395=item $success = $term->selection_grab ($eventtime) 1522=item $success = $term->selection_grab ($eventtime[, $clipboard])
1396 1523
1397Try to request the primary selection text from the server (for example, as 1524Try to acquire ownership of the primary (clipboard if C<$clipboard> is
1525true) selection from the server. The corresponding text can be set
1398set by the next method). No visual feedback will be given. This function 1526with the next method. No visual feedback will be given. This function
1399is mostly useful from within C<on_sel_grab> hooks. 1527is mostly useful from within C<on_sel_grab> hooks.
1400 1528
1401=item $oldtext = $term->selection ([$newtext]) 1529=item $oldtext = $term->selection ([$newtext, $clipboard])
1402 1530
1403Return the current selection text and optionally replace it by C<$newtext>. 1531Return the current selection (clipboard if C<$clipboard> is true) text
1532and optionally replace it by C<$newtext>.
1533
1534=item $term->selection_clear ([$clipboard])
1535
1536Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1404 1537
1405=item $term->overlay_simple ($x, $y, $text) 1538=item $term->overlay_simple ($x, $y, $text)
1406 1539
1407Create a simple multi-line overlay box. See the next method for details. 1540Create a simple multi-line overlay box. See the next method for details.
1408 1541
1536locale-specific encoding of the terminal and can contain command sequences 1669locale-specific encoding of the terminal and can contain command sequences
1537(escape codes) that will be interpreted. 1670(escape codes) that will be interpreted.
1538 1671
1539=item $term->tt_write ($octets) 1672=item $term->tt_write ($octets)
1540 1673
1541Write the octets given in C<$data> to the tty (i.e. as program input). To 1674Write the octets given in C<$octets> to the tty (i.e. as program input). To
1542pass characters instead of octets, you should convert your strings first 1675pass characters instead of octets, you should convert your strings first
1543to the locale-specific encoding using C<< $term->locale_encode >>. 1676to the locale-specific encoding using C<< $term->locale_encode >>.
1677
1678=item $term->tt_paste ($octets)
1679
1680Write the octets given in C<$octets> to the tty as a paste, converting NL to
1681CR and bracketing the data with control sequences if bracketed paste mode
1682is set.
1544 1683
1545=item $old_events = $term->pty_ev_events ([$new_events]) 1684=item $old_events = $term->pty_ev_events ([$new_events])
1546 1685
1547Replaces the event mask of the pty watcher by the given event mask. Can 1686Replaces the event mask of the pty watcher by the given event mask. Can
1548be used to suppress input and output handling to the pty/tty. See the 1687be used to suppress input and output handling to the pty/tty. See the
1566 1705
1567Adds the specified events to the vt event mask. Useful e.g. when you want 1706Adds the specified events to the vt event mask. Useful e.g. when you want
1568to receive pointer events all the times: 1707to receive pointer events all the times:
1569 1708
1570 $term->vt_emask_add (urxvt::PointerMotionMask); 1709 $term->vt_emask_add (urxvt::PointerMotionMask);
1710
1711=item $term->set_urgency ($set)
1712
1713Enable/disable the urgency hint on the toplevel window.
1571 1714
1572=item $term->focus_in 1715=item $term->focus_in
1573 1716
1574=item $term->focus_out 1717=item $term->focus_out
1575 1718
1862Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 2005Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1863recent grab. 2006recent grab.
1864 2007
1865=item $term->ungrab 2008=item $term->ungrab
1866 2009
1867Calls XUngrab for the most recent grab. Is called automatically on 2010Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1868evaluation errors, as it is better to lose the grab in the error case as 2011evaluation errors, as it is better to lose the grab in the error case as
1869the session. 2012the session.
1870 2013
1871=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) 2014=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1872 2015
1892 2035
1893=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) 2036=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1894 2037
1895=item $term->XChangeInput ($window, $add_events[, $del_events]) 2038=item $term->XChangeInput ($window, $add_events[, $del_events])
1896 2039
2040=item $keysym = $term->XStringToKeysym ($string)
2041
2042=item $string = $term->XKeysymToString ($keysym)
2043
1897Various X or X-related functions. The C<$term> object only serves as 2044Various X or X-related functions. The C<$term> object only serves as
1898the source of the display, otherwise those functions map more-or-less 2045the source of the display, otherwise those functions map more-or-less
1899directory onto the X functions of the same name. 2046directly onto the X functions of the same name.
1900 2047
1901=back 2048=back
1902 2049
1903=cut 2050=cut
1904 2051
2061 2208
2062=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 2209=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2063 2210
2064Set the callback to be called when the timer triggers. 2211Set the callback to be called when the timer triggers.
2065 2212
2066=item $tstamp = $timer->at
2067
2068Return the time this watcher will fire next.
2069
2070=item $timer = $timer->set ($tstamp) 2213=item $timer = $timer->set ($tstamp[, $interval])
2071 2214
2072Set the time the event is generated to $tstamp. 2215Set the time the event is generated to $tstamp (and optionally specifies a
2216new $interval).
2073 2217
2074=item $timer = $timer->interval ($interval) 2218=item $timer = $timer->interval ($interval)
2075 2219
2076Normally (and when C<$interval> is C<0>), the timer will automatically 2220By default (and when C<$interval> is C<0>), the timer will automatically
2077stop after it has fired once. If C<$interval> is non-zero, then the timer 2221stop after it has fired once. If C<$interval> is non-zero, then the timer
2078is automatically rescheduled at the given intervals. 2222is automatically rescheduled at the given intervals.
2079 2223
2080=item $timer = $timer->start 2224=item $timer = $timer->start
2081 2225
2082Start the timer. 2226Start the timer.
2083 2227
2084=item $timer = $timer->start ($tstamp) 2228=item $timer = $timer->start ($tstamp[, $interval])
2085 2229
2086Set the event trigger time to C<$tstamp> and start the timer. 2230Set the event trigger time to C<$tstamp> and start the timer. Optionally
2231also replaces the interval.
2087 2232
2088=item $timer = $timer->after ($delay) 2233=item $timer = $timer->after ($delay[, $interval])
2089 2234
2090Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. 2235Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2091 2236
2092=item $timer = $timer->stop 2237=item $timer = $timer->stop
2093 2238
2224 2369
2225=back 2370=back
2226 2371
2227=head1 AUTHOR 2372=head1 AUTHOR
2228 2373
2229 Marc Lehmann <pcg@goof.com> 2374 Marc Lehmann <schmorp@schmorp.de>
2230 http://software.schmorp.de/pkg/rxvt-unicode 2375 http://software.schmorp.de/pkg/rxvt-unicode
2231 2376
2232=cut 2377=cut
2233 2378
22341 23791

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines