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.74 by root, Tue Jan 10 04:26:54 2006 UTC vs.
Revision 1.75 by root, Tue Jan 10 05:00:13 2006 UTC

… …
26thus must be encoded as UTF-8. 26thus must be encoded as UTF-8.
27 27
28Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where 28Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29scripts will be shared (but not enabled) for all terminals. 29scripts will be shared (but not enabled) for all terminals.
30 30
31=head2 Prepackaged Extensions 31=head1 PREPACKAGED EXTENSIONS
32 32
33This section describes the extensiosn delivered with this version. You can 33This section describes the extensions delivered with this release. You can
34find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. 34find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35 35
36You can activate them like this: 36You can activate them like this:
37 37
38 @@RXVT_NAME@@ -pe <extensionname> 38 @@RXVT_NAME@@ -pe <extensionname>
39 39
40=over 4 40=over 4
41 41
42=item selection (enabled by default) 42=item selection (enabled by default)
43 43
44Intelligent selection. This extension tries to be more intelligent when 44(More) intelligent selection. This extension tries to be more intelligent
45the user extends selections (double-click). Right now, it tries to select 45when the user extends selections (double-click). Right now, it tries to
46urls and complete shell-quoted arguments, which is very convenient, too, 46select urls and complete shell-quoted arguments, which is very convenient,
47if your F<ls> supports C<--quoting-style=shell>. 47too, if your F<ls> supports C<--quoting-style=shell>.
48 48
49It also offers the following bindable event: 49It also offers the following bindable keyboard command:
50 50
51=over 4 51=over 4
52 52
53=item rot13 53=item rot13
54 54
… …
64runtime. 64runtime.
65 65
66=item selection-popup (enabled by default) 66=item selection-popup (enabled by default)
67 67
68Binds a popup menu to Ctrl-Button3 that lets you convert the selection 68Binds a popup menu to Ctrl-Button3 that lets you convert the selection
69text into various other formats/action. 69text into various other formats/action (such as uri unescaping, perl
70evalution, web-browser starting etc.), depending on content.
70 71
71=item searchable-scrollback<hotkey> (enabled by default) 72=item searchable-scrollback<hotkey> (enabled by default)
72 73
73Adds regex search functionality to the scrollback buffer, triggered 74Adds regex search functionality to the scrollback buffer, triggered
74by a hotkey (default: C<M-s>). When in search mode, normal terminal 75by a hotkey (default: C<M-s>). When in search mode, normal terminal
… …
98Displays a very simple digital clock in the upper right corner of the 99Displays a very simple digital clock in the upper right corner of the
99window. Illustrates overwriting the refresh callbacks to create your own 100window. Illustrates overwriting the refresh callbacks to create your own
100overlays or changes. 101overlays or changes.
101 102
102=back 103=back
104
105=head1 API DOCUMENTATION
103 106
104=head2 General API Considerations 107=head2 General API Considerations
105 108
106All objects (such as terminals, time watchers etc.) are typical 109All objects (such as terminals, time watchers etc.) are typical
107reference-to-hash objects. The hash can be used to store anything you 110reference-to-hash objects. The hash can be used to store anything you
… …
344 347
345=head2 Variables in the C<urxvt> Package 348=head2 Variables in the C<urxvt> Package
346 349
347=over 4 350=over 4
348 351
352=item $urxvt::LIBDIR
353
354The rxvt-unicode library directory, where, among other things, the perl
355modules and scripts are stored.
356
357=item $urxvt::RESCLASS, $urxvt::RESCLASS
358
359The resource class and name rxvt-unicode uses to look up X resources.
360
361=item $urxvt::RXVTNAME
362
363The basename of the installed binaries, usually C<urxvt>.
364
349=item $urxvt::TERM 365=item $urxvt::TERM
350 366
351The current terminal. This variable stores the current C<urxvt::term> 367The current terminal. This variable stores the current C<urxvt::term>
352object, whenever a callback/hook is executing. 368object, whenever a callback/hook is executing.
369
370=item
353 371
354=back 372=back
355 373
356=head2 Functions in the C<urxvt> Package 374=head2 Functions in the C<urxvt> Package
357 375
… …
431 449
432=item $background = urxvt::GET_BASEBG $rend 450=item $background = urxvt::GET_BASEBG $rend
433 451
434Return the foreground/background colour index, respectively. 452Return the foreground/background colour index, respectively.
435 453
436=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour) 454=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
437 455
438=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour) 456=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
439 457
440Replace the foreground/background colour in the rendition mask with the 458Replace the foreground/background colour in the rendition mask with the
441specified one. 459specified one.
442 460
443=item $value = urxvt::GET_CUSTOM ($rend) 461=item $value = urxvt::GET_CUSTOM $rend
444 462
445Return the "custom" value: Every rendition has 5 bits for use by 463Return the "custom" value: Every rendition has 5 bits for use by
446extensions. They can be set and changed as you like and are initially 464extensions. They can be set and changed as you like and are initially
447zero. 465zero.
448 466
449=item $rend = urxvt::SET_CUSTOM ($rend, $new_value) 467=item $rend = urxvt::SET_CUSTOM $rend, $new_value
450 468
451Change the custom value. 469Change the custom value.
452 470
453=back 471=back
454 472
… …
675 693
676=head2 The C<urxvt::anyevent> Class 694=head2 The C<urxvt::anyevent> Class
677 695
678The sole purpose of this class is to deliver an interface to the 696The sole purpose of this class is to deliver an interface to the
679C<AnyEvent> module - any module using it will work inside urxvt without 697C<AnyEvent> module - any module using it will work inside urxvt without
680further work. The only exception is that you cannot wait on condition 698further programming. The only exception is that you cannot wait on
681variables, but non-blocking condvar use is ok. What this means is that you 699condition variables, but non-blocking condvar use is ok. What this means
682cannot use blocking APIs, but the non-blocking variant should work. 700is that you cannot use blocking APIs, but the non-blocking variant should
701work.
683 702
684=cut 703=cut
685 704
686our $VERSION = 1; 705our $VERSION = 1;
687 706
… …
766 } 785 }
767} 786}
768 787
769=item $term->destroy 788=item $term->destroy
770 789
771Destroy the terminal object (close the window, free resources etc.). 790Destroy the terminal object (close the window, free resources
791etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
792watchers (timers, io watchers) are still active.
772 793
773=item $isset = $term->option ($optval[, $set]) 794=item $isset = $term->option ($optval[, $set])
774 795
775Returns true if the option specified by C<$optval> is enabled, and 796Returns true if the option specified by C<$optval> is enabled, and
776optionally change it. All option values are stored by name in the hash 797optionally change it. All option values are stored by name in the hash

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines