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.187 by sf-exg, Sat Jul 24 10:20:26 2010 UTC vs.
Revision 1.202 by sf-exg, Wed Nov 30 10:29:51 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
431=item $octets 446=item $octets
432 447
433Either binary data or - more common - a text string encoded in a 448Either binary data or - more common - a text string encoded in a
434locale-specific way. 449locale-specific way.
435 450
451=item $keysym
452
453an integer that is a valid X11 keysym code. You can convert a string
454into a keysym and viceversa by using C<XStringToKeysym> and
455C<XKeysymToString>.
456
436=back 457=back
437 458
438=head2 Extension Objects 459=head2 Extension Objects
439 460
440Every perl extension is a perl class. A separate perl object is created 461Every 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, 462for 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 463which are passed as the first parameter to hooks. So extensions can use
443their C<$self> object without having to think about clashes with other 464their C<$self> object without having to think about clashes with other
444extensions or other terminals, with the exception of methods and members 465extensions or other terminals, with the exception of methods and members
445that begin with an underscore character C<_>: these are reserved for 466that begin with an underscore character C<_>: these are reserved for
446internal use. 467internal use.
793 814
794=over 4 815=over 4
795 816
796=item urxvt::fatal $errormessage 817=item urxvt::fatal $errormessage
797 818
798Fatally aborts execution with the given error message. Avoid at all 819Fatally aborts execution with the given error message (which should
799costs! The only time this is acceptable is when the terminal process 820include a trailing newline). Avoid at all costs! The only time this
800starts up. 821is acceptable (and useful) is in the init hook, where it prevents the
822terminal from starting up.
801 823
802=item urxvt::warn $string 824=item urxvt::warn $string
803 825
804Calls C<rxvt_warn> with the given string which should not include a 826Calls C<rxvt_warn> with the given string which should include a trailing
805newline. The module also overwrites the C<warn> builtin with a function 827newline. The module also overwrites the C<warn> builtin with a function
806that calls this function. 828that calls this function.
807 829
808Using this function has the advantage that its output ends up in the 830Using this function has the advantage that its output ends up in the
809correct place, e.g. on stderr of the connecting urxvtc client. 831correct place, e.g. on stderr of the connecting urxvtc client.
813=item @terms = urxvt::termlist 835=item @terms = urxvt::termlist
814 836
815Returns all urxvt::term objects that exist in this process, regardless of 837Returns all urxvt::term objects that exist in this process, regardless of
816whether they are started, being destroyed etc., so be careful. Only term 838whether they are started, being destroyed etc., so be careful. Only term
817objects that have perl extensions attached will be returned (because there 839objects that have perl extensions attached will be returned (because there
818is no urxvt::term objet associated with others). 840is no urxvt::term object associated with others).
819 841
820=item $time = urxvt::NOW 842=item $time = urxvt::NOW
821 843
822Returns the "current time" (as per the event loop). 844Returns the "current time" (as per the event loop).
823 845
866 888
867=item $rend = urxvt::OVERLAY_RSTYLE 889=item $rend = urxvt::OVERLAY_RSTYLE
868 890
869Return the rendition mask used for overlays by default. 891Return the rendition mask used for overlays by default.
870 892
871=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline 893=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
894urxvt::RS_RVid, urxvt::RS_Uline
872 895
873Return the bit that enabled bold, italic, blink, reverse-video and 896Return the bit that enabled bold, italic, blink, reverse-video and
874underline, respectively. To enable such a style, just logically OR it into 897underline, respectively. To enable such a style, just logically OR it into
875the bitset. 898the bitset.
876 899
958sub invoke { 981sub invoke {
959 local $TERM = shift; 982 local $TERM = shift;
960 my $htype = shift; 983 my $htype = shift;
961 984
962 if ($htype == 0) { # INIT 985 if ($htype == 0) { # INIT
963 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 986 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$ENV{HOME}/.urxvt/ext", "$LIBDIR/perl");
964 987
965 my %ext_arg; 988 my %ext_arg;
966 989
967 { 990 {
968 my @init = @TERM_INIT; 991 my @init = @TERM_INIT;
1200 1223
1201sub DESTROY { 1224sub DESTROY {
1202 $_[0][1]->stop; 1225 $_[0][1]->stop;
1203} 1226}
1204 1227
1228# only needed for AnyEvent < 6 compatibility
1205sub one_event { 1229sub one_event {
1206 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; 1230 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1207} 1231}
1208 1232
1209package urxvt::term; 1233package urxvt::term;
1301C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1325C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1302 1326
1303Here is a likely non-exhaustive list of option names, please see the 1327Here is a likely non-exhaustive list of option names, please see the
1304source file F</src/optinc.h> to see the actual list: 1328source file F</src/optinc.h> to see the actual list:
1305 1329
1306 borderLess console cursorBlink cursorUnderline hold iconic insecure 1330 borderLess buffered console cursorBlink cursorUnderline hold iconic
1307 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1331 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1308 override-redirect pastableTabs pointerBlank reverseVideo scrollBar 1332 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1309 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput 1333 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1310 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs 1334 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1311 transparent tripleclickwords utmpInhibit visualBell 1335 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1336 urgentOnBell utmpInhibit visualBell
1312 1337
1313=item $value = $term->resource ($name[, $newval]) 1338=item $value = $term->resource ($name[, $newval])
1314 1339
1315Returns the current resource value associated with a given name and 1340Returns the current resource value associated with a given name and
1316optionally sets a new value. Setting values is most useful in the C<init> 1341optionally sets a new value. Setting values is most useful in the C<init>
1329 1354
1330Here is a likely non-exhaustive list of resource names, not all of which 1355Here is a likely non-exhaustive list of resource names, not all of which
1331are supported in every build, please see the source file F</src/rsinc.h> 1356are supported in every build, please see the source file F</src/rsinc.h>
1332to see the actual list: 1357to see the actual list:
1333 1358
1334 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1359 answerbackstring backgroundPixmap backspace_key blendtype blurradius
1335 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key 1360 boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1336 display_name embed ext_bwidth fade font geometry hold iconName 1361 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1337 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1362 fade font geometry hold iconName iconfile imFont imLocale inputMethod
1338 italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8 1363 insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1364 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1339 modifier mouseWheelScrollPage name override_redirect pastableTabs path 1365 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1340 perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1366 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1341 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1367 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1342 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1368 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1343 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1369 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1344 secondaryScreen secondaryScroll shade term_name title 1370 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1345 transient_for transparent transparent_all tripleclickwords utmpInhibit 1371 term_name title transient_for transparent tripleclickwords urgentOnBell
1346 visualBell 1372 utmpInhibit visualBell
1347 1373
1348=cut 1374=cut
1349 1375
1350sub resource($$;$) { 1376sub resource($$;$) {
1351 my ($self, $name) = (shift, shift); 1377 my ($self, $name) = (shift, shift);
1362 1388
1363This method should only be called during the C<on_start> hook, as there is 1389This method should only be called during the C<on_start> hook, as there is
1364only one resource database per display, and later invocations might return 1390only one resource database per display, and later invocations might return
1365the wrong resources. 1391the wrong resources.
1366 1392
1367=item $success = $term->parse_keysym ($keysym_spec, $command_string) 1393=item $success = $term->parse_keysym ($key, $octets)
1368 1394
1369Adds a keymap translation exactly as specified via a resource. See the 1395Adds a key binding exactly as specified via a resource. See the
1370C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 1396C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
1371 1397
1372=item $rend = $term->rstyle ([$new_rstyle]) 1398=item $rend = $term->rstyle ([$new_rstyle])
1373 1399
1374Return and optionally change the current rendition. Text that is output by 1400Return and optionally change the current rendition. Text that is output by
1913=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) 1939=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1914 1940
1915=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) 1941=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1916 1942
1917=item $term->XChangeInput ($window, $add_events[, $del_events]) 1943=item $term->XChangeInput ($window, $add_events[, $del_events])
1944
1945=item $keysym = $term->XStringToKeysym ($string)
1946
1947=item $string = $term->XKeysymToString ($keysym)
1918 1948
1919Various X or X-related functions. The C<$term> object only serves as 1949Various X or X-related functions. The C<$term> object only serves as
1920the source of the display, otherwise those functions map more-or-less 1950the source of the display, otherwise those functions map more-or-less
1921directly onto the X functions of the same name. 1951directly onto the X functions of the same name.
1922 1952
2244 2274
2245=back 2275=back
2246 2276
2247=head1 AUTHOR 2277=head1 AUTHOR
2248 2278
2249 Marc Lehmann <pcg@goof.com> 2279 Marc Lehmann <schmorp@schmorp.de>
2250 http://software.schmorp.de/pkg/rxvt-unicode 2280 http://software.schmorp.de/pkg/rxvt-unicode
2251 2281
2252=cut 2282=cut
2253 2283
22541 22841

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines