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.190 by root, Fri Jan 7 21:17:08 2011 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
398=item confirm-paste 400=item confirm-paste
399 401
400Displays a confirmation dialog when a paste containing at least a full 402Displays a confirmation dialog when a paste containing at least a full
401line is detected. 403line is detected.
402 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
403=back 413=back
404 414
405=head1 API DOCUMENTATION 415=head1 API DOCUMENTATION
406 416
407=head2 General API Considerations 417=head2 General API Considerations
436=item $octets 446=item $octets
437 447
438Either binary data or - more common - a text string encoded in a 448Either binary data or - more common - a text string encoded in a
439locale-specific way. 449locale-specific way.
440 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
441=back 457=back
442 458
443=head2 Extension Objects 459=head2 Extension Objects
444 460
445Every 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
446for 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,
447which 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
448their C<$self> object without having to think about clashes with other 464their C<$self> object without having to think about clashes with other
449extensions or other terminals, with the exception of methods and members 465extensions or other terminals, with the exception of methods and members
450that begin with an underscore character C<_>: these are reserved for 466that begin with an underscore character C<_>: these are reserved for
451internal use. 467internal use.
801=item urxvt::fatal $errormessage 817=item urxvt::fatal $errormessage
802 818
803Fatally aborts execution with the given error message (which should 819Fatally aborts execution with the given error message (which should
804include a trailing newline). Avoid at all costs! The only time this 820include a trailing newline). Avoid at all costs! The only time this
805is acceptable (and useful) is in the init hook, where it prevents the 821is acceptable (and useful) is in the init hook, where it prevents the
806temrinal from starting up. 822terminal from starting up.
807 823
808=item urxvt::warn $string 824=item urxvt::warn $string
809 825
810Calls C<rxvt_warn> with the given string which should include a trailing 826Calls C<rxvt_warn> with the given string which should include a trailing
811newline. The module also overwrites the C<warn> builtin with a function 827newline. The module also overwrites the C<warn> builtin with a function
819=item @terms = urxvt::termlist 835=item @terms = urxvt::termlist
820 836
821Returns all urxvt::term objects that exist in this process, regardless of 837Returns all urxvt::term objects that exist in this process, regardless of
822whether they are started, being destroyed etc., so be careful. Only term 838whether they are started, being destroyed etc., so be careful. Only term
823objects that have perl extensions attached will be returned (because there 839objects that have perl extensions attached will be returned (because there
824is no urxvt::term objet associated with others). 840is no urxvt::term object associated with others).
825 841
826=item $time = urxvt::NOW 842=item $time = urxvt::NOW
827 843
828Returns the "current time" (as per the event loop). 844Returns the "current time" (as per the event loop).
829 845
965sub invoke { 981sub invoke {
966 local $TERM = shift; 982 local $TERM = shift;
967 my $htype = shift; 983 my $htype = shift;
968 984
969 if ($htype == 0) { # INIT 985 if ($htype == 0) { # INIT
970 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 986 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$ENV{HOME}/.urxvt/ext", "$LIBDIR/perl");
971 987
972 my %ext_arg; 988 my %ext_arg;
973 989
974 { 990 {
975 my @init = @TERM_INIT; 991 my @init = @TERM_INIT;
1207 1223
1208sub DESTROY { 1224sub DESTROY {
1209 $_[0][1]->stop; 1225 $_[0][1]->stop;
1210} 1226}
1211 1227
1228# only needed for AnyEvent < 6 compatibility
1212sub one_event { 1229sub one_event {
1213 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";
1214} 1231}
1215 1232
1216package urxvt::term; 1233package urxvt::term;
1308C<%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.
1309 1326
1310Here 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
1311source file F</src/optinc.h> to see the actual list: 1328source file F</src/optinc.h> to see the actual list:
1312 1329
1313 borderLess console cursorBlink cursorUnderline hold iconic insecure 1330 borderLess buffered console cursorBlink cursorUnderline hold iconic
1314 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1331 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1315 override-redirect pastableTabs pointerBlank reverseVideo scrollBar 1332 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1316 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput 1333 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1317 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs 1334 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1318 transparent tripleclickwords utmpInhibit visualBell 1335 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1336 urgentOnBell utmpInhibit visualBell
1319 1337
1320=item $value = $term->resource ($name[, $newval]) 1338=item $value = $term->resource ($name[, $newval])
1321 1339
1322Returns the current resource value associated with a given name and 1340Returns the current resource value associated with a given name and
1323optionally 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>
1336 1354
1337Here 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
1338are 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>
1339to see the actual list: 1357to see the actual list:
1340 1358
1341 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1359 answerbackstring backgroundPixmap backspace_key blendtype blurradius
1342 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key 1360 boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1343 display_name embed ext_bwidth fade font geometry hold iconName 1361 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1344 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1362 fade font geometry hold iconName iconfile imFont imLocale inputMethod
1345 italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8 1363 insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1364 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1346 modifier mouseWheelScrollPage name override_redirect pastableTabs path 1365 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1347 perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1366 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1348 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1367 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1349 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1368 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1350 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1369 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1351 secondaryScreen secondaryScroll shade term_name title 1370 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1352 transient_for transparent transparent_all tripleclickwords utmpInhibit 1371 term_name title transient_for transparent tripleclickwords urgentOnBell
1353 visualBell 1372 utmpInhibit visualBell
1354 1373
1355=cut 1374=cut
1356 1375
1357sub resource($$;$) { 1376sub resource($$;$) {
1358 my ($self, $name) = (shift, shift); 1377 my ($self, $name) = (shift, shift);
1369 1388
1370This 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
1371only one resource database per display, and later invocations might return 1390only one resource database per display, and later invocations might return
1372the wrong resources. 1391the wrong resources.
1373 1392
1374=item $success = $term->parse_keysym ($keysym_spec, $command_string) 1393=item $success = $term->parse_keysym ($key, $octets)
1375 1394
1376Adds a keymap translation exactly as specified via a resource. See the 1395Adds a key binding exactly as specified via a resource. See the
1377C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 1396C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
1378 1397
1379=item $rend = $term->rstyle ([$new_rstyle]) 1398=item $rend = $term->rstyle ([$new_rstyle])
1380 1399
1381Return and optionally change the current rendition. Text that is output by 1400Return and optionally change the current rendition. Text that is output by
1920=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) 1939=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1921 1940
1922=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) 1941=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1923 1942
1924=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)
1925 1948
1926Various 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
1927the source of the display, otherwise those functions map more-or-less 1950the source of the display, otherwise those functions map more-or-less
1928directly onto the X functions of the same name. 1951directly onto the X functions of the same name.
1929 1952
2251 2274
2252=back 2275=back
2253 2276
2254=head1 AUTHOR 2277=head1 AUTHOR
2255 2278
2256 Marc Lehmann <pcg@goof.com> 2279 Marc Lehmann <schmorp@schmorp.de>
2257 http://software.schmorp.de/pkg/rxvt-unicode 2280 http://software.schmorp.de/pkg/rxvt-unicode
2258 2281
2259=cut 2282=cut
2260 2283
22611 22841

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines