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.199 by sf-exg, Sun Nov 20 10:49:56 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
405=item bell-command
406
407Runs the command specified by the C<URxvt.bell-command> resource when
408a bell event occurs. For example, the following pops up a notification
409bubble with the text "Beep, Beep" using notify-send:
410
411 URxvt.bell-command: notify-send "Beep, Beep"
412
398=back 413=back
399 414
400=head1 API DOCUMENTATION 415=head1 API DOCUMENTATION
401 416
402=head2 General API Considerations 417=head2 General API Considerations
436=back 451=back
437 452
438=head2 Extension Objects 453=head2 Extension Objects
439 454
440Every perl extension is a perl class. A separate perl object is created 455Every 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, 456for 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 457which are passed as the first parameter to hooks. So extensions can use
443their C<$self> object without having to think about clashes with other 458their C<$self> object without having to think about clashes with other
444extensions or other terminals, with the exception of methods and members 459extensions or other terminals, with the exception of methods and members
445that begin with an underscore character C<_>: these are reserved for 460that begin with an underscore character C<_>: these are reserved for
446internal use. 461internal use.
610=item on_tt_write $term, $octets 625=item on_tt_write $term, $octets
611 626
612Called whenever some data is written to the tty/pty and can be used to 627Called whenever some data is written to the tty/pty and can be used to
613suppress or filter tty input. 628suppress or filter tty input.
614 629
630=item on_tt_paste $term, $octets
631
632Called whenever text is about to be pasted, with the text as argument. You
633can filter/change and paste the text yourself by returning a true value
634and calling C<< $term->tt_paste >> yourself. C<$octets> is
635locale-encoded.
636
615=item on_line_update $term, $row 637=item on_line_update $term, $row
616 638
617Called whenever a line was updated or changed. Can be used to filter 639Called whenever a line was updated or changed. Can be used to filter
618screen output (e.g. underline urls or other useless stuff). Only lines 640screen output (e.g. underline urls or other useless stuff). Only lines
619that are being shown will be filtered, and, due to performance reasons, 641that are being shown will be filtered, and, due to performance reasons,
644resource in the @@RXVT_NAME@@(1) manpage). 666resource in the @@RXVT_NAME@@(1) manpage).
645 667
646The event is simply the action string. This interface is assumed to change 668The event is simply the action string. This interface is assumed to change
647slightly in the future. 669slightly in the future.
648 670
649=item on_resize_all_windows $tern, $new_width, $new_height 671=item on_resize_all_windows $term, $new_width, $new_height
650 672
651Called just after the new window size has been calculated, but before 673Called just after the new window size has been calculated, but before
652windows are actually being resized or hints are being set. If this hook 674windows are actually being resized or hints are being set. If this hook
653returns TRUE, setting of the window hints is being skipped. 675returns TRUE, setting of the window hints is being skipped.
654 676
786 808
787=over 4 809=over 4
788 810
789=item urxvt::fatal $errormessage 811=item urxvt::fatal $errormessage
790 812
791Fatally aborts execution with the given error message. Avoid at all 813Fatally aborts execution with the given error message (which should
792costs! The only time this is acceptable is when the terminal process 814include a trailing newline). Avoid at all costs! The only time this
793starts up. 815is acceptable (and useful) is in the init hook, where it prevents the
816terminal from starting up.
794 817
795=item urxvt::warn $string 818=item urxvt::warn $string
796 819
797Calls C<rxvt_warn> with the given string which should not include a 820Calls C<rxvt_warn> with the given string which should include a trailing
798newline. The module also overwrites the C<warn> builtin with a function 821newline. The module also overwrites the C<warn> builtin with a function
799that calls this function. 822that calls this function.
800 823
801Using this function has the advantage that its output ends up in the 824Using this function has the advantage that its output ends up in the
802correct place, e.g. on stderr of the connecting urxvtc client. 825correct place, e.g. on stderr of the connecting urxvtc client.
806=item @terms = urxvt::termlist 829=item @terms = urxvt::termlist
807 830
808Returns all urxvt::term objects that exist in this process, regardless of 831Returns all urxvt::term objects that exist in this process, regardless of
809whether they are started, being destroyed etc., so be careful. Only term 832whether they are started, being destroyed etc., so be careful. Only term
810objects that have perl extensions attached will be returned (because there 833objects that have perl extensions attached will be returned (because there
811is no urxvt::term objet associated with others). 834is no urxvt::term object associated with others).
812 835
813=item $time = urxvt::NOW 836=item $time = urxvt::NOW
814 837
815Returns the "current time" (as per the event loop). 838Returns the "current time" (as per the event loop).
816 839
859 882
860=item $rend = urxvt::OVERLAY_RSTYLE 883=item $rend = urxvt::OVERLAY_RSTYLE
861 884
862Return the rendition mask used for overlays by default. 885Return the rendition mask used for overlays by default.
863 886
864=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline 887=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
888urxvt::RS_RVid, urxvt::RS_Uline
865 889
866Return the bit that enabled bold, italic, blink, reverse-video and 890Return the bit that enabled bold, italic, blink, reverse-video and
867underline, respectively. To enable such a style, just logically OR it into 891underline, respectively. To enable such a style, just logically OR it into
868the bitset. 892the bitset.
869 893
1193 1217
1194sub DESTROY { 1218sub DESTROY {
1195 $_[0][1]->stop; 1219 $_[0][1]->stop;
1196} 1220}
1197 1221
1222# only needed for AnyEvent < 6 compatibility
1198sub one_event { 1223sub one_event {
1199 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; 1224 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1200} 1225}
1201 1226
1202package urxvt::term; 1227package urxvt::term;
1294C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1319C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1295 1320
1296Here is a likely non-exhaustive list of option names, please see the 1321Here is a likely non-exhaustive list of option names, please see the
1297source file F</src/optinc.h> to see the actual list: 1322source file F</src/optinc.h> to see the actual list:
1298 1323
1299 borderLess console cursorBlink cursorUnderline hold iconic insecure 1324 borderLess buffered console cursorBlink cursorUnderline hold iconic
1300 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1325 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1301 override-redirect pastableTabs pointerBlank reverseVideo scrollBar 1326 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1302 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput 1327 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1303 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs 1328 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1304 transparent tripleclickwords utmpInhibit visualBell 1329 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1330 urgentOnBell utmpInhibit visualBell
1305 1331
1306=item $value = $term->resource ($name[, $newval]) 1332=item $value = $term->resource ($name[, $newval])
1307 1333
1308Returns the current resource value associated with a given name and 1334Returns the current resource value associated with a given name and
1309optionally sets a new value. Setting values is most useful in the C<init> 1335optionally sets a new value. Setting values is most useful in the C<init>
1322 1348
1323Here is a likely non-exhaustive list of resource names, not all of which 1349Here 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> 1350are supported in every build, please see the source file F</src/rsinc.h>
1325to see the actual list: 1351to see the actual list:
1326 1352
1327 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1353 answerbackstring backgroundPixmap backspace_key blendtype blurradius
1328 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key 1354 boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1329 display_name embed ext_bwidth fade font geometry hold iconName 1355 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1330 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1356 fade font geometry hold iconName iconfile imFont imLocale inputMethod
1331 italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8 1357 insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1358 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1332 modifier mouseWheelScrollPage name override_redirect pastableTabs path 1359 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1333 perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1360 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1334 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1361 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1335 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1362 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1336 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1363 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1337 secondaryScreen secondaryScroll shade term_name title 1364 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1338 transient_for transparent transparent_all tripleclickwords utmpInhibit 1365 term_name title transient_for transparent tripleclickwords urgentOnBell
1339 visualBell 1366 utmpInhibit visualBell
1340 1367
1341=cut 1368=cut
1342 1369
1343sub resource($$;$) { 1370sub resource($$;$) {
1344 my ($self, $name) = (shift, shift); 1371 my ($self, $name) = (shift, shift);
1545locale-specific encoding of the terminal and can contain command sequences 1572locale-specific encoding of the terminal and can contain command sequences
1546(escape codes) that will be interpreted. 1573(escape codes) that will be interpreted.
1547 1574
1548=item $term->tt_write ($octets) 1575=item $term->tt_write ($octets)
1549 1576
1550Write the octets given in C<$data> to the tty (i.e. as program input). To 1577Write 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 1578pass characters instead of octets, you should convert your strings first
1552to the locale-specific encoding using C<< $term->locale_encode >>. 1579to the locale-specific encoding using C<< $term->locale_encode >>.
1580
1581=item $term->tt_paste ($octets)
1582
1583Write the octets given in C<$octets> to the tty as a paste, converting NL to
1584CR and bracketing the data with control sequences if bracketed paste mode
1585is set.
1553 1586
1554=item $old_events = $term->pty_ev_events ([$new_events]) 1587=item $old_events = $term->pty_ev_events ([$new_events])
1555 1588
1556Replaces the event mask of the pty watcher by the given event mask. Can 1589Replaces 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 1590be used to suppress input and output handling to the pty/tty. See the
2231 2264
2232=back 2265=back
2233 2266
2234=head1 AUTHOR 2267=head1 AUTHOR
2235 2268
2236 Marc Lehmann <pcg@goof.com> 2269 Marc Lehmann <schmorp@schmorp.de>
2237 http://software.schmorp.de/pkg/rxvt-unicode 2270 http://software.schmorp.de/pkg/rxvt-unicode
2238 2271
2239=cut 2272=cut
2240 2273
22411 22741

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines