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.189 by root, Sat Dec 18 15:37:10 2010 UTC vs.
Revision 1.193 by sf-exg, Wed Jun 29 15:30:28 2011 UTC

441=back 441=back
442 442
443=head2 Extension Objects 443=head2 Extension Objects
444 444
445Every perl extension is a perl class. A separate perl object is created 445Every 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, 446for 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 447which are passed as the first parameter to hooks. So extensions can use
448their C<$self> object without having to think about clashes with other 448their C<$self> object without having to think about clashes with other
449extensions or other terminals, with the exception of methods and members 449extensions or other terminals, with the exception of methods and members
450that begin with an underscore character C<_>: these are reserved for 450that begin with an underscore character C<_>: these are reserved for
451internal use. 451internal use.
798 798
799=over 4 799=over 4
800 800
801=item urxvt::fatal $errormessage 801=item urxvt::fatal $errormessage
802 802
803Fatally aborts execution with the given error message. Avoid at all 803Fatally aborts execution with the given error message (which should
804costs! The only time this is acceptable is when the terminal process 804include a trailing newline). Avoid at all costs! The only time this
805starts up. 805is acceptable (and useful) is in the init hook, where it prevents the
806terminal from starting up.
806 807
807=item urxvt::warn $string 808=item urxvt::warn $string
808 809
809Calls C<rxvt_warn> with the given string which should not include a 810Calls C<rxvt_warn> with the given string which should include a trailing
810newline. The module also overwrites the C<warn> builtin with a function 811newline. The module also overwrites the C<warn> builtin with a function
811that calls this function. 812that calls this function.
812 813
813Using this function has the advantage that its output ends up in the 814Using this function has the advantage that its output ends up in the
814correct place, e.g. on stderr of the connecting urxvtc client. 815correct place, e.g. on stderr of the connecting urxvtc client.
818=item @terms = urxvt::termlist 819=item @terms = urxvt::termlist
819 820
820Returns all urxvt::term objects that exist in this process, regardless of 821Returns all urxvt::term objects that exist in this process, regardless of
821whether they are started, being destroyed etc., so be careful. Only term 822whether they are started, being destroyed etc., so be careful. Only term
822objects that have perl extensions attached will be returned (because there 823objects that have perl extensions attached will be returned (because there
823is no urxvt::term objet associated with others). 824is no urxvt::term object associated with others).
824 825
825=item $time = urxvt::NOW 826=item $time = urxvt::NOW
826 827
827Returns the "current time" (as per the event loop). 828Returns the "current time" (as per the event loop).
828 829
2250 2251
2251=back 2252=back
2252 2253
2253=head1 AUTHOR 2254=head1 AUTHOR
2254 2255
2255 Marc Lehmann <pcg@goof.com> 2256 Marc Lehmann <schmorp@schmorp.de>
2256 http://software.schmorp.de/pkg/rxvt-unicode 2257 http://software.schmorp.de/pkg/rxvt-unicode
2257 2258
2258=cut 2259=cut
2259 2260
22601 22611

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines