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.172 by root, Fri Oct 10 00:21:15 2008 UTC vs.
Revision 1.192 by root, Mon Feb 21 07:41:04 2011 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
376overlays or changes. 396overlays or changes.
397
398=item confirm-paste
399
400Displays a confirmation dialog when a paste containing at least a full
401line is detected.
377 402
378=back 403=back
379 404
380=head1 API DOCUMENTATION 405=head1 API DOCUMENTATION
381 406
… …
397 422
398=over 4 423=over 4
399 424
400=item $text 425=item $text
401 426
402Rxvt-unicodes special way of encoding text, where one "unicode" character 427Rxvt-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. 428always represents one screen cell. See L<ROW_t> for a discussion of this format.
404 429
405=item $string 430=item $string
406 431
407A perl text string, with an emphasis on I<text>. It can store all unicode 432A perl text string, with an emphasis on I<text>. It can store all unicode
… …
590=item on_tt_write $term, $octets 615=item on_tt_write $term, $octets
591 616
592Called whenever some data is written to the tty/pty and can be used to 617Called whenever some data is written to the tty/pty and can be used to
593suppress or filter tty input. 618suppress or filter tty input.
594 619
620=item on_tt_paste $term, $octets
621
622Called whenever text is about to be pasted, with the text as argument. You
623can filter/change and paste the text yourself by returning a true value
624and calling C<< $term->tt_paste >> yourself. C<$octets> is
625locale-encoded.
626
595=item on_line_update $term, $row 627=item on_line_update $term, $row
596 628
597Called whenever a line was updated or changed. Can be used to filter 629Called whenever a line was updated or changed. Can be used to filter
598screen output (e.g. underline urls or other useless stuff). Only lines 630screen output (e.g. underline urls or other useless stuff). Only lines
599that are being shown will be filtered, and, due to performance reasons, 631that are being shown will be filtered, and, due to performance reasons,
… …
624resource in the @@RXVT_NAME@@(1) manpage). 656resource in the @@RXVT_NAME@@(1) manpage).
625 657
626The event is simply the action string. This interface is assumed to change 658The event is simply the action string. This interface is assumed to change
627slightly in the future. 659slightly in the future.
628 660
629=item on_resize_all_windows $tern, $new_width, $new_height 661=item on_resize_all_windows $term, $new_width, $new_height
630 662
631Called just after the new window size has been calculated, but before 663Called just after the new window size has been calculated, but before
632windows are actually being resized or hints are being set. If this hook 664windows are actually being resized or hints are being set. If this hook
633returns TRUE, setting of the window hints is being skipped. 665returns TRUE, setting of the window hints is being skipped.
634 666
… …
668 700
669=item on_map_notify $term, $event 701=item on_map_notify $term, $event
670 702
671=item on_unmap_notify $term, $event 703=item on_unmap_notify $term, $event
672 704
673Called whenever the corresponding X event is received for the terminal If 705Called whenever the corresponding X event is received for the terminal. If
674the hook returns true, then the even will be ignored by rxvt-unicode. 706the hook returns true, then the event will be ignored by rxvt-unicode.
675 707
676The event is a hash with most values as named by Xlib (see the XEvent 708The event is a hash with most values as named by Xlib (see the XEvent
677manpage), with the additional members C<row> and C<col>, which are the 709manpage), with the additional members C<row> and C<col>, which are the
678(real, not screen-based) row and column under the mouse cursor. 710(real, not screen-based) row and column under the mouse cursor.
679 711
… …
688 720
689=item on_wm_delete_window $term, $event 721=item on_wm_delete_window $term, $event
690 722
691Called when various types of ClientMessage events are received (all with 723Called when various types of ClientMessage events are received (all with
692format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). 724format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
725
726=item on_bell $term
727
728Called on receipt of a bell character.
693 729
694=back 730=back
695 731
696=cut 732=cut
697 733
… …
762 798
763=over 4 799=over 4
764 800
765=item urxvt::fatal $errormessage 801=item urxvt::fatal $errormessage
766 802
767Fatally aborts execution with the given error message. Avoid at all 803Fatally aborts execution with the given error message (which should
768costs! The only time this is acceptable is when the terminal process 804include a trailing newline). Avoid at all costs! The only time this
769starts up. 805is acceptable (and useful) is in the init hook, where it prevents the
806terminal from starting up.
770 807
771=item urxvt::warn $string 808=item urxvt::warn $string
772 809
773Calls C<rxvt_warn> with the given string which should not include a 810Calls C<rxvt_warn> with the given string which should include a trailing
774newline. The module also overwrites the C<warn> builtin with a function 811newline. The module also overwrites the C<warn> builtin with a function
775that calls this function. 812that calls this function.
776 813
777Using this function has the advantage that its output ends up in the 814Using this function has the advantage that its output ends up in the
778correct place, e.g. on stderr of the connecting urxvtc client. 815correct place, e.g. on stderr of the connecting urxvtc client.
… …
835 872
836=item $rend = urxvt::OVERLAY_RSTYLE 873=item $rend = urxvt::OVERLAY_RSTYLE
837 874
838Return the rendition mask used for overlays by default. 875Return the rendition mask used for overlays by default.
839 876
840=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline 877=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
878urxvt::RS_RVid, urxvt::RS_Uline
841 879
842Return the bit that enabled bold, italic, blink, reverse-video and 880Return the bit that enabled bold, italic, blink, reverse-video and
843underline, respectively. To enable such a style, just logically OR it into 881underline, respectively. To enable such a style, just logically OR it into
844the bitset. 882the bitset.
845 883
… …
1104is that you cannot use blocking APIs, but the non-blocking variant should 1142is that you cannot use blocking APIs, but the non-blocking variant should
1105work. 1143work.
1106 1144
1107=cut 1145=cut
1108 1146
1109our $VERSION = '3.4'; 1147our $VERSION = '5.23';
1110 1148
1111$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1149$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1112push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1150push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1113 1151
1114sub timer { 1152sub timer {
… …
1116 1154
1117 my $cb = $arg{cb}; 1155 my $cb = $arg{cb};
1118 1156
1119 urxvt::timer 1157 urxvt::timer
1120 ->new 1158 ->new
1121 ->start (urxvt::NOW + $arg{after}) 1159 ->after ($arg{after}, $arg{interval})
1122 ->cb (sub { 1160 ->cb ($arg{interval} ? $cb : sub {
1123 $_[0]->stop; # need to cancel manually 1161 $_[0]->stop; # need to cancel manually
1124 $cb->(); 1162 $cb->();
1125 }) 1163 })
1126} 1164}
1127 1165
1128sub io { 1166sub io {
1129 my ($class, %arg) = @_; 1167 my ($class, %arg) = @_;
1130 1168
1131 my $cb = $arg{cb}; 1169 my $cb = $arg{cb};
1170 my $fd = fileno $arg{fh};
1171 defined $fd or $fd = $arg{fh};
1132 1172
1133 bless [$arg{fh}, urxvt::iow 1173 bless [$arg{fh}, urxvt::iow
1134 ->new 1174 ->new
1135 ->fd (fileno $arg{fh}) 1175 ->fd ($fd)
1136 ->events (($arg{poll} =~ /r/ ? 1 : 0) 1176 ->events (($arg{poll} =~ /r/ ? 1 : 0)
1137 | ($arg{poll} =~ /w/ ? 2 : 0)) 1177 | ($arg{poll} =~ /w/ ? 2 : 0))
1138 ->start 1178 ->start
1139 ->cb (sub { 1179 ->cb ($cb)
1140 $cb->(($_[1] & 1 ? 'r' : '')
1141 . ($_[1] & 2 ? 'w' : ''));
1142 })],
1143 urxvt::anyevent:: 1180 ], urxvt::anyevent::
1181}
1182
1183sub idle {
1184 my ($class, %arg) = @_;
1185
1186 my $cb = $arg{cb};
1187
1188 urxvt::iw
1189 ->new
1190 ->start
1191 ->cb ($cb)
1192}
1193
1194sub child {
1195 my ($class, %arg) = @_;
1196
1197 my $cb = $arg{cb};
1198
1199 urxvt::pw
1200 ->new
1201 ->start ($arg{pid})
1202 ->cb (sub {
1203 $_[0]->stop; # need to cancel manually
1204 $cb->($_[0]->rpid, $_[0]->rstatus);
1205 })
1144} 1206}
1145 1207
1146sub DESTROY { 1208sub DESTROY {
1147 $_[0][1]->stop; 1209 $_[0][1]->stop;
1148} 1210}
… …
1278 1340
1279 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1341 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1280 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key 1342 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1281 display_name embed ext_bwidth fade font geometry hold iconName 1343 display_name embed ext_bwidth fade font geometry hold iconName
1282 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1344 imFont imLocale inputMethod insecure int_bwidth intensityStyles
1283 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier 1345 italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
1284 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 1346 modifier mouseWheelScrollPage name override_redirect pastableTabs path
1285 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1347 perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1286 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1348 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1287 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1349 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1288 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1350 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1289 secondaryScreen secondaryScroll shade term_name title 1351 secondaryScreen secondaryScroll shade term_name title
1290 transient_for transparent transparent_all tripleclickwords utmpInhibit 1352 transient_for transparent transparent_all tripleclickwords utmpInhibit
… …
1328 1390
1329=item ($row, $col) = $term->selection_beg ([$row, $col]) 1391=item ($row, $col) = $term->selection_beg ([$row, $col])
1330 1392
1331=item ($row, $col) = $term->selection_end ([$row, $col]) 1393=item ($row, $col) = $term->selection_end ([$row, $col])
1332 1394
1333Return the current values of the selection mark, begin or end positions, 1395Return the current values of the selection mark, begin or end positions.
1334and optionally set them to new values. 1396
1397When arguments are given, then the selection coordinates are set to
1398C<$row> and C<$col>, and the selection screen is set to the current
1399screen.
1400
1401=item $screen = $term->selection_screen ([$screen])
1402
1403Returns the current selection screen, and then optionally sets it.
1335 1404
1336=item $term->selection_make ($eventtime[, $rectangular]) 1405=item $term->selection_make ($eventtime[, $rectangular])
1337 1406
1338Tries to make a selection as set by C<selection_beg> and 1407Tries to make a selection as set by C<selection_beg> and
1339C<selection_end>. If C<$rectangular> is true (default: false), a 1408C<selection_end>. If C<$rectangular> is true (default: false), a
1340rectangular selection will be made. This is the prefered function to make 1409rectangular selection will be made. This is the preferred function to make
1341a selection. 1410a selection.
1342 1411
1343=item $success = $term->selection_grab ($eventtime) 1412=item $success = $term->selection_grab ($eventtime[, $clipboard])
1344 1413
1345Try to request the primary selection text from the server (for example, as 1414Try to acquire ownership of the primary (clipboard if C<$clipboard> is
1415true) selection from the server. The corresponding text can be set
1346set by the next method). No visual feedback will be given. This function 1416with the next method. No visual feedback will be given. This function
1347is mostly useful from within C<on_sel_grab> hooks. 1417is mostly useful from within C<on_sel_grab> hooks.
1348 1418
1349=item $oldtext = $term->selection ([$newtext]) 1419=item $oldtext = $term->selection ([$newtext, $clipboard])
1350 1420
1351Return the current selection text and optionally replace it by C<$newtext>. 1421Return the current selection (clipboard if C<$clipboard> is true) text
1422and optionally replace it by C<$newtext>.
1423
1424=item $term->selection_clear ([$clipboard])
1425
1426Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1352 1427
1353=item $term->overlay_simple ($x, $y, $text) 1428=item $term->overlay_simple ($x, $y, $text)
1354 1429
1355Create a simple multi-line overlay box. See the next method for details. 1430Create a simple multi-line overlay box. See the next method for details.
1356 1431
… …
1484locale-specific encoding of the terminal and can contain command sequences 1559locale-specific encoding of the terminal and can contain command sequences
1485(escape codes) that will be interpreted. 1560(escape codes) that will be interpreted.
1486 1561
1487=item $term->tt_write ($octets) 1562=item $term->tt_write ($octets)
1488 1563
1489Write the octets given in C<$data> to the tty (i.e. as program input). To 1564Write the octets given in C<$octets> to the tty (i.e. as program input). To
1490pass characters instead of octets, you should convert your strings first 1565pass characters instead of octets, you should convert your strings first
1491to the locale-specific encoding using C<< $term->locale_encode >>. 1566to the locale-specific encoding using C<< $term->locale_encode >>.
1567
1568=item $term->tt_paste ($octets)
1569
1570Write the octets given in C<$octets> to the tty as a paste, converting NL to
1571CR and bracketing the data with control sequences if bracketed paste mode
1572is set.
1492 1573
1493=item $old_events = $term->pty_ev_events ([$new_events]) 1574=item $old_events = $term->pty_ev_events ([$new_events])
1494 1575
1495Replaces the event mask of the pty watcher by the given event mask. Can 1576Replaces the event mask of the pty watcher by the given event mask. Can
1496be used to suppress input and output handling to the pty/tty. See the 1577be used to suppress input and output handling to the pty/tty. See the
… …
1810Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 1891Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1811recent grab. 1892recent grab.
1812 1893
1813=item $term->ungrab 1894=item $term->ungrab
1814 1895
1815Calls XUngrab for the most recent grab. Is called automatically on 1896Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1816evaluation errors, as it is better to lose the grab in the error case as 1897evaluation errors, as it is better to lose the grab in the error case as
1817the session. 1898the session.
1818 1899
1819=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) 1900=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1820 1901
… …
1842 1923
1843=item $term->XChangeInput ($window, $add_events[, $del_events]) 1924=item $term->XChangeInput ($window, $add_events[, $del_events])
1844 1925
1845Various X or X-related functions. The C<$term> object only serves as 1926Various X or X-related functions. The C<$term> object only serves as
1846the source of the display, otherwise those functions map more-or-less 1927the source of the display, otherwise those functions map more-or-less
1847directory onto the X functions of the same name. 1928directly onto the X functions of the same name.
1848 1929
1849=back 1930=back
1850 1931
1851=cut 1932=cut
1852 1933
… …
2009 2090
2010=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 2091=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2011 2092
2012Set the callback to be called when the timer triggers. 2093Set the callback to be called when the timer triggers.
2013 2094
2014=item $tstamp = $timer->at
2015
2016Return the time this watcher will fire next.
2017
2018=item $timer = $timer->set ($tstamp) 2095=item $timer = $timer->set ($tstamp[, $interval])
2019 2096
2020Set the time the event is generated to $tstamp. 2097Set the time the event is generated to $tstamp (and optionally specifies a
2098new $interval).
2021 2099
2022=item $timer = $timer->interval ($interval) 2100=item $timer = $timer->interval ($interval)
2023 2101
2024Normally (and when C<$interval> is C<0>), the timer will automatically 2102By default (and when C<$interval> is C<0>), the timer will automatically
2025stop after it has fired once. If C<$interval> is non-zero, then the timer 2103stop after it has fired once. If C<$interval> is non-zero, then the timer
2026is automatically rescheduled at the given intervals. 2104is automatically rescheduled at the given intervals.
2027 2105
2028=item $timer = $timer->start 2106=item $timer = $timer->start
2029 2107
2030Start the timer. 2108Start the timer.
2031 2109
2032=item $timer = $timer->start ($tstamp) 2110=item $timer = $timer->start ($tstamp[, $interval])
2033 2111
2034Set the event trigger time to C<$tstamp> and start the timer. 2112Set the event trigger time to C<$tstamp> and start the timer. Optionally
2113also replaces the interval.
2035 2114
2036=item $timer = $timer->after ($delay) 2115=item $timer = $timer->after ($delay[, $interval])
2037 2116
2038Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. 2117Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2039 2118
2040=item $timer = $timer->stop 2119=item $timer = $timer->stop
2041 2120
… …
2172 2251
2173=back 2252=back
2174 2253
2175=head1 AUTHOR 2254=head1 AUTHOR
2176 2255
2177 Marc Lehmann <pcg@goof.com> 2256 Marc Lehmann <schmorp@schmorp.de>
2178 http://software.schmorp.de/pkg/rxvt-unicode 2257 http://software.schmorp.de/pkg/rxvt-unicode
2179 2258
2180=cut 2259=cut
2181 2260
21821 22611

Diff Legend

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