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.178 by root, Sat Dec 26 09:02:42 2009 UTC vs.
Revision 1.187 by sf-exg, Sat Jul 24 10:20:26 2010 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
417 417
418=over 4 418=over 4
419 419
420=item $text 420=item $text
421 421
422Rxvt-unicodes special way of encoding text, where one "unicode" character 422Rxvt-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. 423always represents one screen cell. See L<ROW_t> for a discussion of this format.
424 424
425=item $string 425=item $string
426 426
427A 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
610=item on_tt_write $term, $octets 610=item on_tt_write $term, $octets
611 611
612Called whenever some data is written to the tty/pty and can be used to 612Called whenever some data is written to the tty/pty and can be used to
613suppress or filter tty input. 613suppress or filter tty input.
614 614
615=item on_tt_paste $term, $octets
616
617Called whenever text is about to be pasted, with the text as argument. You
618can filter/change and paste the text yourself by returning a true value
619and calling C<< $term->tt_paste >> yourself. C<$octets> is
620locale-encoded.
621
615=item on_line_update $term, $row 622=item on_line_update $term, $row
616 623
617Called whenever a line was updated or changed. Can be used to filter 624Called whenever a line was updated or changed. Can be used to filter
618screen output (e.g. underline urls or other useless stuff). Only lines 625screen output (e.g. underline urls or other useless stuff). Only lines
619that are being shown will be filtered, and, due to performance reasons, 626that are being shown will be filtered, and, due to performance reasons,
644resource in the @@RXVT_NAME@@(1) manpage). 651resource in the @@RXVT_NAME@@(1) manpage).
645 652
646The event is simply the action string. This interface is assumed to change 653The event is simply the action string. This interface is assumed to change
647slightly in the future. 654slightly in the future.
648 655
649=item on_resize_all_windows $tern, $new_width, $new_height 656=item on_resize_all_windows $term, $new_width, $new_height
650 657
651Called just after the new window size has been calculated, but before 658Called just after the new window size has been calculated, but before
652windows are actually being resized or hints are being set. If this hook 659windows are actually being resized or hints are being set. If this hook
653returns TRUE, setting of the window hints is being skipped. 660returns TRUE, setting of the window hints is being skipped.
654 661
688 695
689=item on_map_notify $term, $event 696=item on_map_notify $term, $event
690 697
691=item on_unmap_notify $term, $event 698=item on_unmap_notify $term, $event
692 699
693Called whenever the corresponding X event is received for the terminal If 700Called whenever the corresponding X event is received for the terminal. If
694the hook returns true, then the even will be ignored by rxvt-unicode. 701the hook returns true, then the event will be ignored by rxvt-unicode.
695 702
696The event is a hash with most values as named by Xlib (see the XEvent 703The 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 704manpage), with the additional members C<row> and C<col>, which are the
698(real, not screen-based) row and column under the mouse cursor. 705(real, not screen-based) row and column under the mouse cursor.
699 706
708 715
709=item on_wm_delete_window $term, $event 716=item on_wm_delete_window $term, $event
710 717
711Called when various types of ClientMessage events are received (all with 718Called when various types of ClientMessage events are received (all with
712format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). 719format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
720
721=item on_bell $term
722
723Called on receipt of a bell character.
713 724
714=back 725=back
715 726
716=cut 727=cut
717 728
1136 1147
1137 my $cb = $arg{cb}; 1148 my $cb = $arg{cb};
1138 1149
1139 urxvt::timer 1150 urxvt::timer
1140 ->new 1151 ->new
1141 ->after ($arg{after}) 1152 ->after ($arg{after}, $arg{interval})
1142 ->interval ($arg{interval})
1143 ->start
1144 ->cb ($argv{interval} ? $cb : sub { 1153 ->cb ($arg{interval} ? $cb : sub {
1145 $_[0]->stop; # need to cancel manually 1154 $_[0]->stop; # need to cancel manually
1146 $cb->(); 1155 $cb->();
1147 }) 1156 })
1148} 1157}
1149 1158
1374 1383
1375=item ($row, $col) = $term->selection_beg ([$row, $col]) 1384=item ($row, $col) = $term->selection_beg ([$row, $col])
1376 1385
1377=item ($row, $col) = $term->selection_end ([$row, $col]) 1386=item ($row, $col) = $term->selection_end ([$row, $col])
1378 1387
1379Return the current values of the selection mark, begin or end positions, 1388Return the current values of the selection mark, begin or end positions.
1380and optionally set them to new values. 1389
1390When arguments are given, then the selection coordinates are set to
1391C<$row> and C<$col>, and the selection screen is set to the current
1392screen.
1393
1394=item $screen = $term->selection_screen ([$screen])
1395
1396Returns the current selection screen, and then optionally sets it.
1381 1397
1382=item $term->selection_make ($eventtime[, $rectangular]) 1398=item $term->selection_make ($eventtime[, $rectangular])
1383 1399
1384Tries to make a selection as set by C<selection_beg> and 1400Tries to make a selection as set by C<selection_beg> and
1385C<selection_end>. If C<$rectangular> is true (default: false), a 1401C<selection_end>. If C<$rectangular> is true (default: false), a
1386rectangular selection will be made. This is the prefered function to make 1402rectangular selection will be made. This is the preferred function to make
1387a selection. 1403a selection.
1388 1404
1389=item $success = $term->selection_grab ($eventtime) 1405=item $success = $term->selection_grab ($eventtime[, $clipboard])
1390 1406
1391Try to request the primary selection text from the server (for example, as 1407Try to acquire ownership of the primary (clipboard if C<$clipboard> is
1408true) selection from the server. The corresponding text can be set
1392set by the next method). No visual feedback will be given. This function 1409with the next method. No visual feedback will be given. This function
1393is mostly useful from within C<on_sel_grab> hooks. 1410is mostly useful from within C<on_sel_grab> hooks.
1394 1411
1395=item $oldtext = $term->selection ([$newtext]) 1412=item $oldtext = $term->selection ([$newtext, $clipboard])
1396 1413
1397Return the current selection text and optionally replace it by C<$newtext>. 1414Return the current selection (clipboard if C<$clipboard> is true) text
1415and optionally replace it by C<$newtext>.
1416
1417=item $term->selection_clear ([$clipboard])
1418
1419Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1398 1420
1399=item $term->overlay_simple ($x, $y, $text) 1421=item $term->overlay_simple ($x, $y, $text)
1400 1422
1401Create a simple multi-line overlay box. See the next method for details. 1423Create a simple multi-line overlay box. See the next method for details.
1402 1424
1530locale-specific encoding of the terminal and can contain command sequences 1552locale-specific encoding of the terminal and can contain command sequences
1531(escape codes) that will be interpreted. 1553(escape codes) that will be interpreted.
1532 1554
1533=item $term->tt_write ($octets) 1555=item $term->tt_write ($octets)
1534 1556
1535Write the octets given in C<$data> to the tty (i.e. as program input). To 1557Write the octets given in C<$octets> to the tty (i.e. as program input). To
1536pass characters instead of octets, you should convert your strings first 1558pass characters instead of octets, you should convert your strings first
1537to the locale-specific encoding using C<< $term->locale_encode >>. 1559to the locale-specific encoding using C<< $term->locale_encode >>.
1560
1561=item $term->tt_paste ($octets)
1562
1563Write the octets given in C<$octets> to the tty as a paste, converting NL to
1564CR and bracketing the data with control sequences if bracketed paste mode
1565is set.
1538 1566
1539=item $old_events = $term->pty_ev_events ([$new_events]) 1567=item $old_events = $term->pty_ev_events ([$new_events])
1540 1568
1541Replaces the event mask of the pty watcher by the given event mask. Can 1569Replaces the event mask of the pty watcher by the given event mask. Can
1542be used to suppress input and output handling to the pty/tty. See the 1570be used to suppress input and output handling to the pty/tty. See the
1856Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 1884Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1857recent grab. 1885recent grab.
1858 1886
1859=item $term->ungrab 1887=item $term->ungrab
1860 1888
1861Calls XUngrab for the most recent grab. Is called automatically on 1889Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1862evaluation errors, as it is better to lose the grab in the error case as 1890evaluation errors, as it is better to lose the grab in the error case as
1863the session. 1891the session.
1864 1892
1865=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) 1893=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1866 1894
1888 1916
1889=item $term->XChangeInput ($window, $add_events[, $del_events]) 1917=item $term->XChangeInput ($window, $add_events[, $del_events])
1890 1918
1891Various X or X-related functions. The C<$term> object only serves as 1919Various X or X-related functions. The C<$term> object only serves as
1892the source of the display, otherwise those functions map more-or-less 1920the source of the display, otherwise those functions map more-or-less
1893directory onto the X functions of the same name. 1921directly onto the X functions of the same name.
1894 1922
1895=back 1923=back
1896 1924
1897=cut 1925=cut
1898 1926
2055 2083
2056=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 2084=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2057 2085
2058Set the callback to be called when the timer triggers. 2086Set the callback to be called when the timer triggers.
2059 2087
2060=item $tstamp = $timer->at
2061
2062Return the time this watcher will fire next.
2063
2064=item $timer = $timer->set ($tstamp) 2088=item $timer = $timer->set ($tstamp[, $interval])
2065 2089
2066Set the time the event is generated to $tstamp. 2090Set the time the event is generated to $tstamp (and optionally specifies a
2091new $interval).
2067 2092
2068=item $timer = $timer->interval ($interval) 2093=item $timer = $timer->interval ($interval)
2069 2094
2070Normally (and when C<$interval> is C<0>), the timer will automatically 2095By default (and when C<$interval> is C<0>), the timer will automatically
2071stop after it has fired once. If C<$interval> is non-zero, then the timer 2096stop after it has fired once. If C<$interval> is non-zero, then the timer
2072is automatically rescheduled at the given intervals. 2097is automatically rescheduled at the given intervals.
2073 2098
2074=item $timer = $timer->start 2099=item $timer = $timer->start
2075 2100
2076Start the timer. 2101Start the timer.
2077 2102
2078=item $timer = $timer->start ($tstamp) 2103=item $timer = $timer->start ($tstamp[, $interval])
2079 2104
2080Set the event trigger time to C<$tstamp> and start the timer. 2105Set the event trigger time to C<$tstamp> and start the timer. Optionally
2106also replaces the interval.
2081 2107
2082=item $timer = $timer->after ($delay) 2108=item $timer = $timer->after ($delay[, $interval])
2083 2109
2084Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. 2110Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2085 2111
2086=item $timer = $timer->stop 2112=item $timer = $timer->stop
2087 2113

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines