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.175 by root, Sat May 30 08:51:23 2009 UTC vs.
Revision 1.192 by root, Mon Feb 21 07:41:04 2011 UTC

… …
341 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' 341 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
342 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' 342 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
343 343
344=item selection-pastebin 344=item selection-pastebin
345 345
346This is a little rarely useful extension that Uploads the selection as 346This is a little rarely useful extension that uploads the selection as
347textfile to a remote site (or does other things). (The implementation is 347textfile to a remote site (or does other things). (The implementation is
348not 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
349F</tmp> directly.). 349F</tmp> directly.).
350 350
351It listens to the C<selection-pastebin:remote-pastebin> keyboard command, 351It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
… …
370 370
371 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% 371 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
372 372
373I<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
374the double C</> characters as comment start. Use C<\057\057> instead, 374the double C</> characters as comment start. Use C<\057\057> instead,
375which 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
376or not. 376or not.
377 377
378=item macosx-pastebin and macosx-pastebin-native 378=item macosx-clipboard and macosx-clipboard-native
379 379
380These two modules implement an extended clipboard for Mac OS X. They are 380These two modules implement an extended clipboard for Mac OS X. They are
381used like this: 381used like this:
382 382
383 URxvt.perl-ext-common: default,macosx-clipboard 383 URxvt.perl-ext-common: default,macosx-clipboard
384 URxvt.keysym.M-c: perl:macosx-clipboard:copy 384 URxvt.keysym.M-c: perl:macosx-clipboard:copy
385 URxvt.keysym.M-v: perl:macosx-clipboard:paste 385 URxvt.keysym.M-v: perl:macosx-clipboard:paste
386 386
387The difference between them is that the native variant requires a 387The difference between them is that the native variant requires a
388perl from apple's devkit or so, and C<maxosx-pastebin> requires the 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 389C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
390simpler etc. etc. 390simpler etc. etc.
391 391
392=item example-refresh-hooks 392=item example-refresh-hooks
393 393
394Displays 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
395window. Illustrates overwriting the refresh callbacks to create your own 395window. Illustrates overwriting the refresh callbacks to create your own
396overlays 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.
397 402
398=back 403=back
399 404
400=head1 API DOCUMENTATION 405=head1 API DOCUMENTATION
401 406
… …
417 422
418=over 4 423=over 4
419 424
420=item $text 425=item $text
421 426
422Rxvt-unicodes special way of encoding text, where one "unicode" character 427Rxvt-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. 428always represents one screen cell. See L<ROW_t> for a discussion of this format.
424 429
425=item $string 430=item $string
426 431
427A 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
… …
610=item on_tt_write $term, $octets 615=item on_tt_write $term, $octets
611 616
612Called 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
613suppress or filter tty input. 618suppress or filter tty input.
614 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
615=item on_line_update $term, $row 627=item on_line_update $term, $row
616 628
617Called 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
618screen output (e.g. underline urls or other useless stuff). Only lines 630screen output (e.g. underline urls or other useless stuff). Only lines
619that are being shown will be filtered, and, due to performance reasons, 631that are being shown will be filtered, and, due to performance reasons,
… …
644resource in the @@RXVT_NAME@@(1) manpage). 656resource in the @@RXVT_NAME@@(1) manpage).
645 657
646The 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
647slightly in the future. 659slightly in the future.
648 660
649=item on_resize_all_windows $tern, $new_width, $new_height 661=item on_resize_all_windows $term, $new_width, $new_height
650 662
651Called just after the new window size has been calculated, but before 663Called just after the new window size has been calculated, but before
652windows 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
653returns TRUE, setting of the window hints is being skipped. 665returns TRUE, setting of the window hints is being skipped.
654 666
… …
688 700
689=item on_map_notify $term, $event 701=item on_map_notify $term, $event
690 702
691=item on_unmap_notify $term, $event 703=item on_unmap_notify $term, $event
692 704
693Called whenever the corresponding X event is received for the terminal If 705Called whenever the corresponding X event is received for the terminal. If
694the 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.
695 707
696The 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
697manpage), 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
698(real, not screen-based) row and column under the mouse cursor. 710(real, not screen-based) row and column under the mouse cursor.
699 711
… …
708 720
709=item on_wm_delete_window $term, $event 721=item on_wm_delete_window $term, $event
710 722
711Called when various types of ClientMessage events are received (all with 723Called when various types of ClientMessage events are received (all with
712format=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.
713 729
714=back 730=back
715 731
716=cut 732=cut
717 733
… …
782 798
783=over 4 799=over 4
784 800
785=item urxvt::fatal $errormessage 801=item urxvt::fatal $errormessage
786 802
787Fatally aborts execution with the given error message. Avoid at all 803Fatally aborts execution with the given error message (which should
788costs! The only time this is acceptable is when the terminal process 804include a trailing newline). Avoid at all costs! The only time this
789starts up. 805is acceptable (and useful) is in the init hook, where it prevents the
806terminal from starting up.
790 807
791=item urxvt::warn $string 808=item urxvt::warn $string
792 809
793Calls 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
794newline. The module also overwrites the C<warn> builtin with a function 811newline. The module also overwrites the C<warn> builtin with a function
795that calls this function. 812that calls this function.
796 813
797Using 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
798correct place, e.g. on stderr of the connecting urxvtc client. 815correct place, e.g. on stderr of the connecting urxvtc client.
… …
855 872
856=item $rend = urxvt::OVERLAY_RSTYLE 873=item $rend = urxvt::OVERLAY_RSTYLE
857 874
858Return the rendition mask used for overlays by default. 875Return the rendition mask used for overlays by default.
859 876
860=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
861 879
862Return the bit that enabled bold, italic, blink, reverse-video and 880Return the bit that enabled bold, italic, blink, reverse-video and
863underline, respectively. To enable such a style, just logically OR it into 881underline, respectively. To enable such a style, just logically OR it into
864the bitset. 882the bitset.
865 883
… …
1124is 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
1125work. 1143work.
1126 1144
1127=cut 1145=cut
1128 1146
1129our $VERSION = '3.4'; 1147our $VERSION = '5.23';
1130 1148
1131$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1149$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1132push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1150push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1133 1151
1134sub timer { 1152sub timer {
… …
1136 1154
1137 my $cb = $arg{cb}; 1155 my $cb = $arg{cb};
1138 1156
1139 urxvt::timer 1157 urxvt::timer
1140 ->new 1158 ->new
1141 ->start (urxvt::NOW + $arg{after}) 1159 ->after ($arg{after}, $arg{interval})
1142 ->cb (sub { 1160 ->cb ($arg{interval} ? $cb : sub {
1143 $_[0]->stop; # need to cancel manually 1161 $_[0]->stop; # need to cancel manually
1144 $cb->(); 1162 $cb->();
1145 }) 1163 })
1146} 1164}
1147 1165
1148sub io { 1166sub io {
1149 my ($class, %arg) = @_; 1167 my ($class, %arg) = @_;
1150 1168
1151 my $cb = $arg{cb}; 1169 my $cb = $arg{cb};
1170 my $fd = fileno $arg{fh};
1171 defined $fd or $fd = $arg{fh};
1152 1172
1153 bless [$arg{fh}, urxvt::iow 1173 bless [$arg{fh}, urxvt::iow
1154 ->new 1174 ->new
1155 ->fd (fileno $arg{fh}) 1175 ->fd ($fd)
1156 ->events (($arg{poll} =~ /r/ ? 1 : 0) 1176 ->events (($arg{poll} =~ /r/ ? 1 : 0)
1157 | ($arg{poll} =~ /w/ ? 2 : 0)) 1177 | ($arg{poll} =~ /w/ ? 2 : 0))
1158 ->start 1178 ->start
1159 ->cb (sub { 1179 ->cb ($cb)
1160 $cb->(($_[1] & 1 ? 'r' : '')
1161 . ($_[1] & 2 ? 'w' : ''));
1162 })],
1163 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 })
1164} 1206}
1165 1207
1166sub DESTROY { 1208sub DESTROY {
1167 $_[0][1]->stop; 1209 $_[0][1]->stop;
1168} 1210}
… …
1348 1390
1349=item ($row, $col) = $term->selection_beg ([$row, $col]) 1391=item ($row, $col) = $term->selection_beg ([$row, $col])
1350 1392
1351=item ($row, $col) = $term->selection_end ([$row, $col]) 1393=item ($row, $col) = $term->selection_end ([$row, $col])
1352 1394
1353Return the current values of the selection mark, begin or end positions, 1395Return the current values of the selection mark, begin or end positions.
1354and 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.
1355 1404
1356=item $term->selection_make ($eventtime[, $rectangular]) 1405=item $term->selection_make ($eventtime[, $rectangular])
1357 1406
1358Tries to make a selection as set by C<selection_beg> and 1407Tries to make a selection as set by C<selection_beg> and
1359C<selection_end>. If C<$rectangular> is true (default: false), a 1408C<selection_end>. If C<$rectangular> is true (default: false), a
1360rectangular selection will be made. This is the prefered function to make 1409rectangular selection will be made. This is the preferred function to make
1361a selection. 1410a selection.
1362 1411
1363=item $success = $term->selection_grab ($eventtime) 1412=item $success = $term->selection_grab ($eventtime[, $clipboard])
1364 1413
1365Try 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
1366set by the next method). No visual feedback will be given. This function 1416with the next method. No visual feedback will be given. This function
1367is mostly useful from within C<on_sel_grab> hooks. 1417is mostly useful from within C<on_sel_grab> hooks.
1368 1418
1369=item $oldtext = $term->selection ([$newtext]) 1419=item $oldtext = $term->selection ([$newtext, $clipboard])
1370 1420
1371Return 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.
1372 1427
1373=item $term->overlay_simple ($x, $y, $text) 1428=item $term->overlay_simple ($x, $y, $text)
1374 1429
1375Create 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.
1376 1431
… …
1504locale-specific encoding of the terminal and can contain command sequences 1559locale-specific encoding of the terminal and can contain command sequences
1505(escape codes) that will be interpreted. 1560(escape codes) that will be interpreted.
1506 1561
1507=item $term->tt_write ($octets) 1562=item $term->tt_write ($octets)
1508 1563
1509Write 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
1510pass characters instead of octets, you should convert your strings first 1565pass characters instead of octets, you should convert your strings first
1511to 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.
1512 1573
1513=item $old_events = $term->pty_ev_events ([$new_events]) 1574=item $old_events = $term->pty_ev_events ([$new_events])
1514 1575
1515Replaces 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
1516be 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
… …
1830Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 1891Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1831recent grab. 1892recent grab.
1832 1893
1833=item $term->ungrab 1894=item $term->ungrab
1834 1895
1835Calls XUngrab for the most recent grab. Is called automatically on 1896Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1836evaluation 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
1837the session. 1898the session.
1838 1899
1839=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) 1900=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1840 1901
… …
1862 1923
1863=item $term->XChangeInput ($window, $add_events[, $del_events]) 1924=item $term->XChangeInput ($window, $add_events[, $del_events])
1864 1925
1865Various 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
1866the source of the display, otherwise those functions map more-or-less 1927the source of the display, otherwise those functions map more-or-less
1867directory onto the X functions of the same name. 1928directly onto the X functions of the same name.
1868 1929
1869=back 1930=back
1870 1931
1871=cut 1932=cut
1872 1933
… …
2029 2090
2030=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 2091=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2031 2092
2032Set the callback to be called when the timer triggers. 2093Set the callback to be called when the timer triggers.
2033 2094
2034=item $tstamp = $timer->at
2035
2036Return the time this watcher will fire next.
2037
2038=item $timer = $timer->set ($tstamp) 2095=item $timer = $timer->set ($tstamp[, $interval])
2039 2096
2040Set the time the event is generated to $tstamp. 2097Set the time the event is generated to $tstamp (and optionally specifies a
2098new $interval).
2041 2099
2042=item $timer = $timer->interval ($interval) 2100=item $timer = $timer->interval ($interval)
2043 2101
2044Normally (and when C<$interval> is C<0>), the timer will automatically 2102By default (and when C<$interval> is C<0>), the timer will automatically
2045stop 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
2046is automatically rescheduled at the given intervals. 2104is automatically rescheduled at the given intervals.
2047 2105
2048=item $timer = $timer->start 2106=item $timer = $timer->start
2049 2107
2050Start the timer. 2108Start the timer.
2051 2109
2052=item $timer = $timer->start ($tstamp) 2110=item $timer = $timer->start ($tstamp[, $interval])
2053 2111
2054Set 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.
2055 2114
2056=item $timer = $timer->after ($delay) 2115=item $timer = $timer->after ($delay[, $interval])
2057 2116
2058Like 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>.
2059 2118
2060=item $timer = $timer->stop 2119=item $timer = $timer->stop
2061 2120
… …
2192 2251
2193=back 2252=back
2194 2253
2195=head1 AUTHOR 2254=head1 AUTHOR
2196 2255
2197 Marc Lehmann <pcg@goof.com> 2256 Marc Lehmann <schmorp@schmorp.de>
2198 http://software.schmorp.de/pkg/rxvt-unicode 2257 http://software.schmorp.de/pkg/rxvt-unicode
2199 2258
2200=cut 2259=cut
2201 2260
22021 22611

Diff Legend

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