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.181 by sf-exg, Wed Jan 6 17:52:43 2010 UTC vs.
Revision 1.188 by sf-exg, Sat Jul 24 13:04:27 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
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
1390 1402
1391=item $term->selection_make ($eventtime[, $rectangular]) 1403=item $term->selection_make ($eventtime[, $rectangular])
1392 1404
1393Tries to make a selection as set by C<selection_beg> and 1405Tries to make a selection as set by C<selection_beg> and
1394C<selection_end>. If C<$rectangular> is true (default: false), a 1406C<selection_end>. If C<$rectangular> is true (default: false), a
1395rectangular selection will be made. This is the prefered function to make 1407rectangular selection will be made. This is the preferred function to make
1396a selection. 1408a selection.
1397 1409
1398=item $success = $term->selection_grab ($eventtime) 1410=item $success = $term->selection_grab ($eventtime[, $clipboard])
1399 1411
1400Try to request the primary selection text from the server (for example, as 1412Try to acquire ownership of the primary (clipboard if C<$clipboard> is
1413true) selection from the server. The corresponding text can be set
1401set by the next method). No visual feedback will be given. This function 1414with the next method. No visual feedback will be given. This function
1402is mostly useful from within C<on_sel_grab> hooks. 1415is mostly useful from within C<on_sel_grab> hooks.
1403 1416
1404=item $oldtext = $term->selection ([$newtext]) 1417=item $oldtext = $term->selection ([$newtext, $clipboard])
1405 1418
1406Return the current selection text and optionally replace it by C<$newtext>. 1419Return the current selection (clipboard if C<$clipboard> is true) text
1420and optionally replace it by C<$newtext>.
1421
1422=item $term->selection_clear ([$clipboard])
1423
1424Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1407 1425
1408=item $term->overlay_simple ($x, $y, $text) 1426=item $term->overlay_simple ($x, $y, $text)
1409 1427
1410Create a simple multi-line overlay box. See the next method for details. 1428Create a simple multi-line overlay box. See the next method for details.
1411 1429
1539locale-specific encoding of the terminal and can contain command sequences 1557locale-specific encoding of the terminal and can contain command sequences
1540(escape codes) that will be interpreted. 1558(escape codes) that will be interpreted.
1541 1559
1542=item $term->tt_write ($octets) 1560=item $term->tt_write ($octets)
1543 1561
1544Write the octets given in C<$data> to the tty (i.e. as program input). To 1562Write the octets given in C<$octets> to the tty (i.e. as program input). To
1545pass characters instead of octets, you should convert your strings first 1563pass characters instead of octets, you should convert your strings first
1546to the locale-specific encoding using C<< $term->locale_encode >>. 1564to the locale-specific encoding using C<< $term->locale_encode >>.
1565
1566=item $term->tt_paste ($octets)
1567
1568Write the octets given in C<$octets> to the tty as a paste, converting NL to
1569CR and bracketing the data with control sequences if bracketed paste mode
1570is set.
1547 1571
1548=item $old_events = $term->pty_ev_events ([$new_events]) 1572=item $old_events = $term->pty_ev_events ([$new_events])
1549 1573
1550Replaces the event mask of the pty watcher by the given event mask. Can 1574Replaces the event mask of the pty watcher by the given event mask. Can
1551be used to suppress input and output handling to the pty/tty. See the 1575be used to suppress input and output handling to the pty/tty. See the
1865Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 1889Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1866recent grab. 1890recent grab.
1867 1891
1868=item $term->ungrab 1892=item $term->ungrab
1869 1893
1870Calls XUngrab for the most recent grab. Is called automatically on 1894Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1871evaluation errors, as it is better to lose the grab in the error case as 1895evaluation errors, as it is better to lose the grab in the error case as
1872the session. 1896the session.
1873 1897
1874=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) 1898=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1875 1899
1897 1921
1898=item $term->XChangeInput ($window, $add_events[, $del_events]) 1922=item $term->XChangeInput ($window, $add_events[, $del_events])
1899 1923
1900Various X or X-related functions. The C<$term> object only serves as 1924Various X or X-related functions. The C<$term> object only serves as
1901the source of the display, otherwise those functions map more-or-less 1925the source of the display, otherwise those functions map more-or-less
1902directory onto the X functions of the same name. 1926directly onto the X functions of the same name.
1903 1927
1904=back 1928=back
1905 1929
1906=cut 1930=cut
1907 1931

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines