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.185 by sf-exg, Fri Jul 2 12:44:45 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
668 688
669=item on_map_notify $term, $event 689=item on_map_notify $term, $event
670 690
671=item on_unmap_notify $term, $event 691=item on_unmap_notify $term, $event
672 692
673Called whenever the corresponding X event is received for the terminal If 693Called whenever the corresponding X event is received for the terminal. If
674the 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.
675 695
676The 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
677manpage), 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
678(real, not screen-based) row and column under the mouse cursor. 698(real, not screen-based) row and column under the mouse cursor.
679 699
688 708
689=item on_wm_delete_window $term, $event 709=item on_wm_delete_window $term, $event
690 710
691Called when various types of ClientMessage events are received (all with 711Called when various types of ClientMessage events are received (all with
692format=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.
693 717
694=back 718=back
695 719
696=cut 720=cut
697 721
1104is 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
1105work. 1129work.
1106 1130
1107=cut 1131=cut
1108 1132
1109our $VERSION = '3.4'; 1133our $VERSION = '5.23';
1110 1134
1111$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1135$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1112push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1136push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1113 1137
1114sub timer { 1138sub timer {
1116 1140
1117 my $cb = $arg{cb}; 1141 my $cb = $arg{cb};
1118 1142
1119 urxvt::timer 1143 urxvt::timer
1120 ->new 1144 ->new
1121 ->start (urxvt::NOW + $arg{after}) 1145 ->after ($arg{after}, $arg{interval})
1122 ->cb (sub { 1146 ->cb ($arg{interval} ? $cb : sub {
1123 $_[0]->stop; # need to cancel manually 1147 $_[0]->stop; # need to cancel manually
1124 $cb->(); 1148 $cb->();
1125 }) 1149 })
1126} 1150}
1127 1151
1128sub io { 1152sub io {
1129 my ($class, %arg) = @_; 1153 my ($class, %arg) = @_;
1130 1154
1131 my $cb = $arg{cb}; 1155 my $cb = $arg{cb};
1156 my $fd = fileno $arg{fh};
1157 defined $fd or $fd = $arg{fh};
1132 1158
1133 bless [$arg{fh}, urxvt::iow 1159 bless [$arg{fh}, urxvt::iow
1134 ->new 1160 ->new
1135 ->fd (fileno $arg{fh}) 1161 ->fd ($fd)
1136 ->events (($arg{poll} =~ /r/ ? 1 : 0) 1162 ->events (($arg{poll} =~ /r/ ? 1 : 0)
1137 | ($arg{poll} =~ /w/ ? 2 : 0)) 1163 | ($arg{poll} =~ /w/ ? 2 : 0))
1138 ->start 1164 ->start
1139 ->cb (sub { 1165 ->cb ($cb)
1140 $cb->(($_[1] & 1 ? 'r' : '')
1141 . ($_[1] & 2 ? 'w' : ''));
1142 })],
1143 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 })
1144} 1192}
1145 1193
1146sub DESTROY { 1194sub DESTROY {
1147 $_[0][1]->stop; 1195 $_[0][1]->stop;
1148} 1196}
1278 1326
1279 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1327 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1280 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key 1328 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1281 display_name embed ext_bwidth fade font geometry hold iconName 1329 display_name embed ext_bwidth fade font geometry hold iconName
1282 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1330 imFont imLocale inputMethod insecure int_bwidth intensityStyles
1283 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier 1331 italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
1284 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 1332 modifier mouseWheelScrollPage name override_redirect pastableTabs path
1285 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1333 perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1286 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1334 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1287 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1335 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1288 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1336 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1289 secondaryScreen secondaryScroll shade term_name title 1337 secondaryScreen secondaryScroll shade term_name title
1290 transient_for transparent transparent_all tripleclickwords utmpInhibit 1338 transient_for transparent transparent_all tripleclickwords utmpInhibit
1328 1376
1329=item ($row, $col) = $term->selection_beg ([$row, $col]) 1377=item ($row, $col) = $term->selection_beg ([$row, $col])
1330 1378
1331=item ($row, $col) = $term->selection_end ([$row, $col]) 1379=item ($row, $col) = $term->selection_end ([$row, $col])
1332 1380
1333Return the current values of the selection mark, begin or end positions, 1381Return the current values of the selection mark, begin or end positions.
1334and 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.
1335 1390
1336=item $term->selection_make ($eventtime[, $rectangular]) 1391=item $term->selection_make ($eventtime[, $rectangular])
1337 1392
1338Tries to make a selection as set by C<selection_beg> and 1393Tries to make a selection as set by C<selection_beg> and
1339C<selection_end>. If C<$rectangular> is true (default: false), a 1394C<selection_end>. If C<$rectangular> is true (default: false), a
1340rectangular selection will be made. This is the prefered function to make 1395rectangular selection will be made. This is the preferred function to make
1341a selection. 1396a selection.
1342 1397
1343=item $success = $term->selection_grab ($eventtime) 1398=item $success = $term->selection_grab ($eventtime[, $clipboard])
1344 1399
1345Try to request the primary selection text from the server (for example, as 1400Try to acquire ownership of the primary (clipboard if C<$clipboard> is
1401true) selection from the server. The corresponding text can be set
1346set by the next method). No visual feedback will be given. This function 1402with the next method. No visual feedback will be given. This function
1347is mostly useful from within C<on_sel_grab> hooks. 1403is mostly useful from within C<on_sel_grab> hooks.
1348 1404
1349=item $oldtext = $term->selection ([$newtext]) 1405=item $oldtext = $term->selection ([$newtext, $clipboard])
1350 1406
1351Return the current selection text and optionally replace it by C<$newtext>. 1407Return the current selection (clipboard if C<$clipboard> is true) text
1408and optionally replace it by C<$newtext>.
1409
1410=item $term->selection_clear ([$clipboard])
1411
1412Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1352 1413
1353=item $term->overlay_simple ($x, $y, $text) 1414=item $term->overlay_simple ($x, $y, $text)
1354 1415
1355Create a simple multi-line overlay box. See the next method for details. 1416Create a simple multi-line overlay box. See the next method for details.
1356 1417
1810Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 1871Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1811recent grab. 1872recent grab.
1812 1873
1813=item $term->ungrab 1874=item $term->ungrab
1814 1875
1815Calls XUngrab for the most recent grab. Is called automatically on 1876Calls 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 1877evaluation errors, as it is better to lose the grab in the error case as
1817the session. 1878the session.
1818 1879
1819=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) 1880=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1820 1881
1842 1903
1843=item $term->XChangeInput ($window, $add_events[, $del_events]) 1904=item $term->XChangeInput ($window, $add_events[, $del_events])
1844 1905
1845Various X or X-related functions. The C<$term> object only serves as 1906Various X or X-related functions. The C<$term> object only serves as
1846the source of the display, otherwise those functions map more-or-less 1907the source of the display, otherwise those functions map more-or-less
1847directory onto the X functions of the same name. 1908directly onto the X functions of the same name.
1848 1909
1849=back 1910=back
1850 1911
1851=cut 1912=cut
1852 1913
2009 2070
2010=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 2071=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2011 2072
2012Set the callback to be called when the timer triggers. 2073Set the callback to be called when the timer triggers.
2013 2074
2014=item $tstamp = $timer->at
2015
2016Return the time this watcher will fire next.
2017
2018=item $timer = $timer->set ($tstamp) 2075=item $timer = $timer->set ($tstamp[, $interval])
2019 2076
2020Set the time the event is generated to $tstamp. 2077Set the time the event is generated to $tstamp (and optionally specifies a
2078new $interval).
2021 2079
2022=item $timer = $timer->interval ($interval) 2080=item $timer = $timer->interval ($interval)
2023 2081
2024Normally (and when C<$interval> is C<0>), the timer will automatically 2082By 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 2083stop after it has fired once. If C<$interval> is non-zero, then the timer
2026is automatically rescheduled at the given intervals. 2084is automatically rescheduled at the given intervals.
2027 2085
2028=item $timer = $timer->start 2086=item $timer = $timer->start
2029 2087
2030Start the timer. 2088Start the timer.
2031 2089
2032=item $timer = $timer->start ($tstamp) 2090=item $timer = $timer->start ($tstamp[, $interval])
2033 2091
2034Set the event trigger time to C<$tstamp> and start the timer. 2092Set the event trigger time to C<$tstamp> and start the timer. Optionally
2093also replaces the interval.
2035 2094
2036=item $timer = $timer->after ($delay) 2095=item $timer = $timer->after ($delay[, $interval])
2037 2096
2038Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. 2097Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2039 2098
2040=item $timer = $timer->stop 2099=item $timer = $timer->stop
2041 2100

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines