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.170 by root, Tue Sep 23 07:03:13 2008 UTC vs.
Revision 1.183 by sf-exg, Wed Mar 31 13:14:50 2010 UTC

… …
303extension will actually grab a physical key just for this function. 303extension will actually grab a physical key just for this function.
304 304
305If you want a quake-like animation, tell your window manager to do so 305If you want a quake-like animation, tell your window manager to do so
306(fvwm can do it). 306(fvwm can do it).
307 307
308=item overlay-osc
309
310This extension implements some OSC commands to display timed popups on the
311screen - useful for status displays from within scripts. You have to read
312the sources for more info.
313
308=item block-graphics-to-ascii 314=item block-graphics-to-ascii
309 315
310A not very useful example of filtering all text output to the terminal 316A not very useful example of filtering all text output to the terminal
311by replacing all line-drawing characters (U+2500 .. U+259F) by a 317by replacing all line-drawing characters (U+2500 .. U+259F) by a
312similar-looking ascii character. 318similar-looking ascii character.
… …
335 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' 341 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
336 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' 342 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
337 343
338=item selection-pastebin 344=item selection-pastebin
339 345
340This is a little rarely useful extension that Uploads the selection as 346This is a little rarely useful extension that uploads the selection as
341textfile to a remote site (or does other things). (The implementation is 347textfile to a remote site (or does other things). (The implementation is
342not currently secure for use in a multiuser environment as it writes to 348not currently secure for use in a multiuser environment as it writes to
343F</tmp> directly.). 349F</tmp> directly.).
344 350
345It listens to the C<selection-pastebin:remote-pastebin> keyboard command, 351It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
… …
364 370
365 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% 371 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
366 372
367I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret 373I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
368the double C</> characters as comment start. Use C<\057\057> instead, 374the double C</> characters as comment start. Use C<\057\057> instead,
369which works regardless of wether xrdb is used to parse the resource file 375which works regardless of whether xrdb is used to parse the resource file
370or not. 376or not.
377
378=item macosx-clipboard and macosx-clipboard-native
379
380These two modules implement an extended clipboard for Mac OS X. They are
381used like this:
382
383 URxvt.perl-ext-common: default,macosx-clipboard
384 URxvt.keysym.M-c: perl:macosx-clipboard:copy
385 URxvt.keysym.M-v: perl:macosx-clipboard:paste
386
387The difference between them is that the native variant requires a
388perl from apple's devkit or so, and C<macosx-clipboard> requires the
389C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
390simpler etc. etc.
371 391
372=item example-refresh-hooks 392=item example-refresh-hooks
373 393
374Displays a very simple digital clock in the upper right corner of the 394Displays a very simple digital clock in the upper right corner of the
375window. Illustrates overwriting the refresh callbacks to create your own 395window. Illustrates overwriting the refresh callbacks to create your own
… …
397 417
398=over 4 418=over 4
399 419
400=item $text 420=item $text
401 421
402Rxvt-unicodes special way of encoding text, where one "unicode" character 422Rxvt-unicode's special way of encoding text, where one "unicode" character
403always represents one screen cell. See L<ROW_t> for a discussion of this format. 423always represents one screen cell. See L<ROW_t> for a discussion of this format.
404 424
405=item $string 425=item $string
406 426
407A perl text string, with an emphasis on I<text>. It can store all unicode 427A perl text string, with an emphasis on I<text>. It can store all unicode
… …
541 561
542It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 562It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
543$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total 563$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
544number of lines that will be in the scrollback buffer. 564number of lines that will be in the scrollback buffer.
545 565
546=item on_osc_seq $term, $op, $args 566=item on_osc_seq $term, $op, $args, $resp
547 567
548Called on every OSC sequence and can be used to suppress it or modify its 568Called on every OSC sequence and can be used to suppress it or modify its
549behaviour. The default should be to return an empty list. A true value 569behaviour. The default should be to return an empty list. A true value
550suppresses execution of the request completely. Make sure you don't get 570suppresses execution of the request completely. Make sure you don't get
551confused by recursive invocations when you output an osc sequence within 571confused by recursive invocations when you output an OSC sequence within
552this callback. 572this callback.
553 573
554C<on_osc_seq_perl> should be used for new behaviour. 574C<on_osc_seq_perl> should be used for new behaviour.
555 575
556=item on_osc_seq_perl $term, $string 576=item on_osc_seq_perl $term, $args, $resp
557 577
558Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 578Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
559operating system command) is processed. Cursor position and other state 579operating system command) is processed. Cursor position and other state
560information is up-to-date when this happens. For interoperability, the 580information is up-to-date when this happens. For interoperability, the
561string should start with the extension name and a colon, to distinguish 581string should start with the extension name (sans -osc) and a semicolon,
562it from commands for other extensions, and this might be enforced in the 582to distinguish it from commands for other extensions, and this might be
563future. 583enforced in the future.
584
585For example, C<overlay-osc> uses this:
586
587 sub on_osc_seq_perl {
588 my ($self, $osc, $resp) = @_;
589
590 return unless $osc =~ s/^overlay;//;
591
592 ... process remaining $osc string
593 }
564 594
565Be careful not ever to trust (in a security sense) the data you receive, 595Be careful not ever to trust (in a security sense) the data you receive,
566as its source can not easily be controlled (e-mail content, messages from 596as its source can not easily be controlled (e-mail content, messages from
567other users on the same system etc.). 597other users on the same system etc.).
598
599For responses, C<$resp> contains the end-of-args separator used by the
600sender.
568 601
569=item on_add_lines $term, $string 602=item on_add_lines $term, $string
570 603
571Called whenever text is about to be output, with the text as argument. You 604Called whenever text is about to be output, with the text as argument. You
572can filter/change and output the text yourself by returning a true value 605can filter/change and output the text yourself by returning a true value
… …
593later with the already-modified line (e.g. if unrelated parts change), so 626later with the already-modified line (e.g. if unrelated parts change), so
594you cannot just toggle rendition bits, but only set them. 627you cannot just toggle rendition bits, but only set them.
595 628
596=item on_refresh_begin $term 629=item on_refresh_begin $term
597 630
598Called just before the screen gets redrawn. Can be used for overlay 631Called just before the screen gets redrawn. Can be used for overlay or
599or similar effects by modify terminal contents in refresh_begin, and 632similar effects by modifying the terminal contents in refresh_begin, and
600restoring them in refresh_end. The built-in overlay and selection display 633restoring them in refresh_end. The built-in overlay and selection display
601code is run after this hook, and takes precedence. 634code is run after this hook, and takes precedence.
602 635
603=item on_refresh_end $term 636=item on_refresh_end $term
604 637
… …
655 688
656=item on_map_notify $term, $event 689=item on_map_notify $term, $event
657 690
658=item on_unmap_notify $term, $event 691=item on_unmap_notify $term, $event
659 692
660Called whenever the corresponding X event is received for the terminal If 693Called whenever the corresponding X event is received for the terminal. If
661the hook returns true, then the even will be ignored by rxvt-unicode. 694the hook returns true, then the event will be ignored by rxvt-unicode.
662 695
663The event is a hash with most values as named by Xlib (see the XEvent 696The event is a hash with most values as named by Xlib (see the XEvent
664manpage), with the additional members C<row> and C<col>, which are the 697manpage), with the additional members C<row> and C<col>, which are the
665(real, not screen-based) row and column under the mouse cursor. 698(real, not screen-based) row and column under the mouse cursor.
666 699
… …
675 708
676=item on_wm_delete_window $term, $event 709=item on_wm_delete_window $term, $event
677 710
678Called when various types of ClientMessage events are received (all with 711Called when various types of ClientMessage events are received (all with
679format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). 712format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
713
714=item on_bell $term
715
716Called on receipt of a bell character.
680 717
681=back 718=back
682 719
683=cut 720=cut
684 721
… …
1091is that you cannot use blocking APIs, but the non-blocking variant should 1128is that you cannot use blocking APIs, but the non-blocking variant should
1092work. 1129work.
1093 1130
1094=cut 1131=cut
1095 1132
1096our $VERSION = '3.4'; 1133our $VERSION = '5.23';
1097 1134
1098$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1135$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1099push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1136push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1100 1137
1101sub timer { 1138sub timer {
… …
1103 1140
1104 my $cb = $arg{cb}; 1141 my $cb = $arg{cb};
1105 1142
1106 urxvt::timer 1143 urxvt::timer
1107 ->new 1144 ->new
1108 ->start (urxvt::NOW + $arg{after}) 1145 ->after ($arg{after}, $arg{interval})
1109 ->cb (sub { 1146 ->cb ($arg{interval} ? $cb : sub {
1110 $_[0]->stop; # need to cancel manually 1147 $_[0]->stop; # need to cancel manually
1111 $cb->(); 1148 $cb->();
1112 }) 1149 })
1113} 1150}
1114 1151
1115sub io { 1152sub io {
1116 my ($class, %arg) = @_; 1153 my ($class, %arg) = @_;
1117 1154
1118 my $cb = $arg{cb}; 1155 my $cb = $arg{cb};
1156 my $fd = fileno $arg{fh};
1157 defined $fd or $fd = $arg{fh};
1119 1158
1120 bless [$arg{fh}, urxvt::iow 1159 bless [$arg{fh}, urxvt::iow
1121 ->new 1160 ->new
1122 ->fd (fileno $arg{fh}) 1161 ->fd ($fd)
1123 ->events (($arg{poll} =~ /r/ ? 1 : 0) 1162 ->events (($arg{poll} =~ /r/ ? 1 : 0)
1124 | ($arg{poll} =~ /w/ ? 2 : 0)) 1163 | ($arg{poll} =~ /w/ ? 2 : 0))
1125 ->start 1164 ->start
1126 ->cb (sub { 1165 ->cb ($cb)
1127 $cb->(($_[1] & 1 ? 'r' : '')
1128 . ($_[1] & 2 ? 'w' : ''));
1129 })],
1130 urxvt::anyevent:: 1166 ], urxvt::anyevent::
1167}
1168
1169sub idle {
1170 my ($class, %arg) = @_;
1171
1172 my $cb = $arg{cb};
1173
1174 urxvt::iw
1175 ->new
1176 ->start
1177 ->cb ($cb)
1178}
1179
1180sub child {
1181 my ($class, %arg) = @_;
1182
1183 my $cb = $arg{cb};
1184
1185 urxvt::pw
1186 ->new
1187 ->start ($arg{pid})
1188 ->cb (sub {
1189 $_[0]->stop; # need to cancel manually
1190 $cb->($_[0]->rpid, $_[0]->rstatus);
1191 })
1131} 1192}
1132 1193
1133sub DESTROY { 1194sub DESTROY {
1134 $_[0][1]->stop; 1195 $_[0][1]->stop;
1135} 1196}
… …
1265 1326
1266 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1327 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1267 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key 1328 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1268 display_name embed ext_bwidth fade font geometry hold iconName 1329 display_name embed ext_bwidth fade font geometry hold iconName
1269 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1330 imFont imLocale inputMethod insecure int_bwidth intensityStyles
1270 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier 1331 italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
1271 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 1332 modifier mouseWheelScrollPage name override_redirect pastableTabs path
1272 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1333 perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1273 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1334 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1274 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1335 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1275 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1336 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1276 secondaryScreen secondaryScroll shade term_name title 1337 secondaryScreen secondaryScroll shade term_name title
1277 transient_for transparent transparent_all tripleclickwords utmpInhibit 1338 transient_for transparent transparent_all tripleclickwords utmpInhibit
… …
1315 1376
1316=item ($row, $col) = $term->selection_beg ([$row, $col]) 1377=item ($row, $col) = $term->selection_beg ([$row, $col])
1317 1378
1318=item ($row, $col) = $term->selection_end ([$row, $col]) 1379=item ($row, $col) = $term->selection_end ([$row, $col])
1319 1380
1320Return the current values of the selection mark, begin or end positions, 1381Return the current values of the selection mark, begin or end positions.
1321and optionally set them to new values. 1382
1383When arguments are given, then the selection coordinates are set to
1384C<$row> and C<$col>, and the selection screen is set to the current
1385screen.
1386
1387=item $screen = $term->selection_screen ([$screen])
1388
1389Returns the current selection screen, and then optionally sets it.
1322 1390
1323=item $term->selection_make ($eventtime[, $rectangular]) 1391=item $term->selection_make ($eventtime[, $rectangular])
1324 1392
1325Tries to make a selection as set by C<selection_beg> and 1393Tries to make a selection as set by C<selection_beg> and
1326C<selection_end>. If C<$rectangular> is true (default: false), a 1394C<selection_end>. If C<$rectangular> is true (default: false), a
… …
1373 1441
1374The methods currently supported on C<urxvt::overlay> objects are: 1442The methods currently supported on C<urxvt::overlay> objects are:
1375 1443
1376=over 4 1444=over 4
1377 1445
1378=item $overlay->set ($x, $y, $text, $rend) 1446=item $overlay->set ($x, $y, $text[, $rend])
1379 1447
1380Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts 1448Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1381text in rxvt-unicode's special encoding and an array of rendition values 1449text in rxvt-unicode's special encoding and an array of rendition values
1382at a specific position inside the overlay. 1450at a specific position inside the overlay.
1451
1452If C<$rend> is missing, then the rendition will not be changed.
1383 1453
1384=item $overlay->hide 1454=item $overlay->hide
1385 1455
1386If visible, hide the overlay, but do not destroy it. 1456If visible, hide the overlay, but do not destroy it.
1387 1457
… …
1795Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 1865Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1796recent grab. 1866recent grab.
1797 1867
1798=item $term->ungrab 1868=item $term->ungrab
1799 1869
1800Calls XUngrab for the most recent grab. Is called automatically on 1870Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1801evaluation errors, as it is better to lose the grab in the error case as 1871evaluation errors, as it is better to lose the grab in the error case as
1802the session. 1872the session.
1803 1873
1804=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) 1874=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1805 1875
… …
1827 1897
1828=item $term->XChangeInput ($window, $add_events[, $del_events]) 1898=item $term->XChangeInput ($window, $add_events[, $del_events])
1829 1899
1830Various X or X-related functions. The C<$term> object only serves as 1900Various X or X-related functions. The C<$term> object only serves as
1831the source of the display, otherwise those functions map more-or-less 1901the source of the display, otherwise those functions map more-or-less
1832directory onto the X functions of the same name. 1902directly onto the X functions of the same name.
1833 1903
1834=back 1904=back
1835 1905
1836=cut 1906=cut
1837 1907
… …
1994 2064
1995=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 2065=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1996 2066
1997Set the callback to be called when the timer triggers. 2067Set the callback to be called when the timer triggers.
1998 2068
1999=item $tstamp = $timer->at
2000
2001Return the time this watcher will fire next.
2002
2003=item $timer = $timer->set ($tstamp) 2069=item $timer = $timer->set ($tstamp[, $interval])
2004 2070
2005Set the time the event is generated to $tstamp. 2071Set the time the event is generated to $tstamp (and optionally specifies a
2072new $interval).
2006 2073
2007=item $timer = $timer->interval ($interval) 2074=item $timer = $timer->interval ($interval)
2008 2075
2009Normally (and when C<$interval> is C<0>), the timer will automatically 2076By default (and when C<$interval> is C<0>), the timer will automatically
2010stop after it has fired once. If C<$interval> is non-zero, then the timer 2077stop after it has fired once. If C<$interval> is non-zero, then the timer
2011is automatically rescheduled at the given intervals. 2078is automatically rescheduled at the given intervals.
2012 2079
2013=item $timer = $timer->start 2080=item $timer = $timer->start
2014 2081
2015Start the timer. 2082Start the timer.
2016 2083
2017=item $timer = $timer->start ($tstamp) 2084=item $timer = $timer->start ($tstamp[, $interval])
2018 2085
2019Set the event trigger time to C<$tstamp> and start the timer. 2086Set the event trigger time to C<$tstamp> and start the timer. Optionally
2087also replaces the interval.
2020 2088
2021=item $timer = $timer->after ($delay) 2089=item $timer = $timer->after ($delay[, $interval])
2022 2090
2023Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. 2091Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2024 2092
2025=item $timer = $timer->stop 2093=item $timer = $timer->stop
2026 2094

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines