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.185 by sf-exg, Fri Jul 2 12:44:45 2010 UTC vs.
Revision 1.198 by root, Tue Oct 4 22:25:14 2011 UTC

259The default pattern to match URLs can be overridden with the 259The default pattern to match URLs can be overridden with the
260C<matcher.pattern.0> resource, and additional patterns can be specified 260C<matcher.pattern.0> resource, and additional patterns can be specified
261with numbered patterns, in a manner similar to the "selection" extension. 261with numbered patterns, in a manner similar to the "selection" extension.
262The launcher can also be overridden on a per-pattern basis. 262The launcher can also be overridden on a per-pattern basis.
263 263
264It is possible to activate the most recently seen match from the keyboard. 264It is possible to activate the most recently seen match or a list of matches
265from the keyboard. Simply bind a keysym to "perl:matcher:last" or
265Simply bind a keysym to "perl:matcher" as seen in the example below. 266"perl:matcher:list" as seen in the example below.
266 267
267Example configuration: 268Example configuration:
268 269
269 URxvt.perl-ext: default,matcher 270 URxvt.perl-ext: default,matcher
270 URxvt.urlLauncher: sensible-browser 271 URxvt.urlLauncher: sensible-browser
271 URxvt.keysym.C-Delete: perl:matcher 272 URxvt.keysym.C-Delete: perl:matcher:last
273 URxvt.keysym.M-Delete: perl:matcher:list
272 URxvt.matcher.button: 1 274 URxvt.matcher.button: 1
273 URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-] 275 URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
274 URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$) 276 URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
275 URxvt.matcher.launcher.2: gvim +$2 $1 277 URxvt.matcher.launcher.2: gvim +$2 $1
276 278
393 395
394Displays a very simple digital clock in the upper right corner of the 396Displays a very simple digital clock in the upper right corner of the
395window. Illustrates overwriting the refresh callbacks to create your own 397window. Illustrates overwriting the refresh callbacks to create your own
396overlays or changes. 398overlays or changes.
397 399
400=item confirm-paste
401
402Displays a confirmation dialog when a paste containing at least a full
403line is detected.
404
398=back 405=back
399 406
400=head1 API DOCUMENTATION 407=head1 API DOCUMENTATION
401 408
402=head2 General API Considerations 409=head2 General API Considerations
436=back 443=back
437 444
438=head2 Extension Objects 445=head2 Extension Objects
439 446
440Every perl extension is a perl class. A separate perl object is created 447Every perl extension is a perl class. A separate perl object is created
441for each terminal, and each terminal has its own set of extenion objects, 448for each terminal, and each terminal has its own set of extension objects,
442which are passed as the first parameter to hooks. So extensions can use 449which are passed as the first parameter to hooks. So extensions can use
443their C<$self> object without having to think about clashes with other 450their C<$self> object without having to think about clashes with other
444extensions or other terminals, with the exception of methods and members 451extensions or other terminals, with the exception of methods and members
445that begin with an underscore character C<_>: these are reserved for 452that begin with an underscore character C<_>: these are reserved for
446internal use. 453internal use.
610=item on_tt_write $term, $octets 617=item on_tt_write $term, $octets
611 618
612Called whenever some data is written to the tty/pty and can be used to 619Called whenever some data is written to the tty/pty and can be used to
613suppress or filter tty input. 620suppress or filter tty input.
614 621
622=item on_tt_paste $term, $octets
623
624Called whenever text is about to be pasted, with the text as argument. You
625can filter/change and paste the text yourself by returning a true value
626and calling C<< $term->tt_paste >> yourself. C<$octets> is
627locale-encoded.
628
615=item on_line_update $term, $row 629=item on_line_update $term, $row
616 630
617Called whenever a line was updated or changed. Can be used to filter 631Called whenever a line was updated or changed. Can be used to filter
618screen output (e.g. underline urls or other useless stuff). Only lines 632screen output (e.g. underline urls or other useless stuff). Only lines
619that are being shown will be filtered, and, due to performance reasons, 633that are being shown will be filtered, and, due to performance reasons,
644resource in the @@RXVT_NAME@@(1) manpage). 658resource in the @@RXVT_NAME@@(1) manpage).
645 659
646The event is simply the action string. This interface is assumed to change 660The event is simply the action string. This interface is assumed to change
647slightly in the future. 661slightly in the future.
648 662
649=item on_resize_all_windows $tern, $new_width, $new_height 663=item on_resize_all_windows $term, $new_width, $new_height
650 664
651Called just after the new window size has been calculated, but before 665Called just after the new window size has been calculated, but before
652windows are actually being resized or hints are being set. If this hook 666windows are actually being resized or hints are being set. If this hook
653returns TRUE, setting of the window hints is being skipped. 667returns TRUE, setting of the window hints is being skipped.
654 668
786 800
787=over 4 801=over 4
788 802
789=item urxvt::fatal $errormessage 803=item urxvt::fatal $errormessage
790 804
791Fatally aborts execution with the given error message. Avoid at all 805Fatally aborts execution with the given error message (which should
792costs! The only time this is acceptable is when the terminal process 806include a trailing newline). Avoid at all costs! The only time this
793starts up. 807is acceptable (and useful) is in the init hook, where it prevents the
808terminal from starting up.
794 809
795=item urxvt::warn $string 810=item urxvt::warn $string
796 811
797Calls C<rxvt_warn> with the given string which should not include a 812Calls C<rxvt_warn> with the given string which should include a trailing
798newline. The module also overwrites the C<warn> builtin with a function 813newline. The module also overwrites the C<warn> builtin with a function
799that calls this function. 814that calls this function.
800 815
801Using this function has the advantage that its output ends up in the 816Using this function has the advantage that its output ends up in the
802correct place, e.g. on stderr of the connecting urxvtc client. 817correct place, e.g. on stderr of the connecting urxvtc client.
806=item @terms = urxvt::termlist 821=item @terms = urxvt::termlist
807 822
808Returns all urxvt::term objects that exist in this process, regardless of 823Returns all urxvt::term objects that exist in this process, regardless of
809whether they are started, being destroyed etc., so be careful. Only term 824whether they are started, being destroyed etc., so be careful. Only term
810objects that have perl extensions attached will be returned (because there 825objects that have perl extensions attached will be returned (because there
811is no urxvt::term objet associated with others). 826is no urxvt::term object associated with others).
812 827
813=item $time = urxvt::NOW 828=item $time = urxvt::NOW
814 829
815Returns the "current time" (as per the event loop). 830Returns the "current time" (as per the event loop).
816 831
859 874
860=item $rend = urxvt::OVERLAY_RSTYLE 875=item $rend = urxvt::OVERLAY_RSTYLE
861 876
862Return the rendition mask used for overlays by default. 877Return the rendition mask used for overlays by default.
863 878
864=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline 879=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
880urxvt::RS_RVid, urxvt::RS_Uline
865 881
866Return the bit that enabled bold, italic, blink, reverse-video and 882Return the bit that enabled bold, italic, blink, reverse-video and
867underline, respectively. To enable such a style, just logically OR it into 883underline, respectively. To enable such a style, just logically OR it into
868the bitset. 884the bitset.
869 885
1193 1209
1194sub DESTROY { 1210sub DESTROY {
1195 $_[0][1]->stop; 1211 $_[0][1]->stop;
1196} 1212}
1197 1213
1214# only needed for AnyEvent < 6 compatibility
1198sub one_event { 1215sub one_event {
1199 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; 1216 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1200} 1217}
1201 1218
1202package urxvt::term; 1219package urxvt::term;
1294C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1311C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1295 1312
1296Here is a likely non-exhaustive list of option names, please see the 1313Here is a likely non-exhaustive list of option names, please see the
1297source file F</src/optinc.h> to see the actual list: 1314source file F</src/optinc.h> to see the actual list:
1298 1315
1299 borderLess console cursorBlink cursorUnderline hold iconic insecure 1316 borderLess buffered console cursorBlink cursorUnderline hold iconic
1300 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1317 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1301 override-redirect pastableTabs pointerBlank reverseVideo scrollBar 1318 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1302 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput 1319 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1303 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs 1320 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1304 transparent tripleclickwords utmpInhibit visualBell 1321 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1322 urgentOnBell utmpInhibit visualBell
1305 1323
1306=item $value = $term->resource ($name[, $newval]) 1324=item $value = $term->resource ($name[, $newval])
1307 1325
1308Returns the current resource value associated with a given name and 1326Returns the current resource value associated with a given name and
1309optionally sets a new value. Setting values is most useful in the C<init> 1327optionally sets a new value. Setting values is most useful in the C<init>
1322 1340
1323Here is a likely non-exhaustive list of resource names, not all of which 1341Here is a likely non-exhaustive list of resource names, not all of which
1324are supported in every build, please see the source file F</src/rsinc.h> 1342are supported in every build, please see the source file F</src/rsinc.h>
1325to see the actual list: 1343to see the actual list:
1326 1344
1327 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1345 answerbackstring backgroundPixmap backspace_key blendtype blurradius
1328 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key 1346 boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1329 display_name embed ext_bwidth fade font geometry hold iconName 1347 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1330 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1348 fade font geometry hold iconName iconfile imFont imLocale inputMethod
1331 italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8 1349 insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1350 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1332 modifier mouseWheelScrollPage name override_redirect pastableTabs path 1351 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1333 perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1352 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1334 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1353 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1335 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1354 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1336 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1355 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1337 secondaryScreen secondaryScroll shade term_name title 1356 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1338 transient_for transparent transparent_all tripleclickwords utmpInhibit 1357 term_name title transient_for transparent tripleclickwords urgentOnBell
1339 visualBell 1358 utmpInhibit visualBell
1340 1359
1341=cut 1360=cut
1342 1361
1343sub resource($$;$) { 1362sub resource($$;$) {
1344 my ($self, $name) = (shift, shift); 1363 my ($self, $name) = (shift, shift);
1545locale-specific encoding of the terminal and can contain command sequences 1564locale-specific encoding of the terminal and can contain command sequences
1546(escape codes) that will be interpreted. 1565(escape codes) that will be interpreted.
1547 1566
1548=item $term->tt_write ($octets) 1567=item $term->tt_write ($octets)
1549 1568
1550Write the octets given in C<$data> to the tty (i.e. as program input). To 1569Write the octets given in C<$octets> to the tty (i.e. as program input). To
1551pass characters instead of octets, you should convert your strings first 1570pass characters instead of octets, you should convert your strings first
1552to the locale-specific encoding using C<< $term->locale_encode >>. 1571to the locale-specific encoding using C<< $term->locale_encode >>.
1572
1573=item $term->tt_paste ($octets)
1574
1575Write the octets given in C<$octets> to the tty as a paste, converting NL to
1576CR and bracketing the data with control sequences if bracketed paste mode
1577is set.
1553 1578
1554=item $old_events = $term->pty_ev_events ([$new_events]) 1579=item $old_events = $term->pty_ev_events ([$new_events])
1555 1580
1556Replaces the event mask of the pty watcher by the given event mask. Can 1581Replaces the event mask of the pty watcher by the given event mask. Can
1557be used to suppress input and output handling to the pty/tty. See the 1582be used to suppress input and output handling to the pty/tty. See the
2231 2256
2232=back 2257=back
2233 2258
2234=head1 AUTHOR 2259=head1 AUTHOR
2235 2260
2236 Marc Lehmann <pcg@goof.com> 2261 Marc Lehmann <schmorp@schmorp.de>
2237 http://software.schmorp.de/pkg/rxvt-unicode 2262 http://software.schmorp.de/pkg/rxvt-unicode
2238 2263
2239=cut 2264=cut
2240 2265
22411 22661

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines