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.35 by root, Fri Jan 6 01:27:27 2006 UTC vs.
Revision 1.36 by root, Fri Jan 6 02:58:02 2006 UTC

… …
137=over 4 137=over 4
138 138
139=item on_init $term 139=item on_init $term
140 140
141Called after a new terminal object has been initialized, but before 141Called after a new terminal object has been initialized, but before
142windows are created or the command gets run. 142windows are created or the command gets run. Most methods are unsafe to
143call or deliver senseless data, as terminal size and other characteristics
144have not yet been determined. You can safely query and change resources,
145though.
143 146
144=item on_reset $term 147=item on_reset $term
145 148
146Called after the screen is "reset" for any reason, such as resizing or 149Called after the screen is "reset" for any reason, such as resizing or
147control sequences. Here is where you can react on changes to size-related 150control sequences. Here is where you can react on changes to size-related
… …
274=back 277=back
275 278
276=head2 Functions in the C<urxvt> Package 279=head2 Functions in the C<urxvt> Package
277 280
278=over 4 281=over 4
282
283=item $term = new urxvt [arg...]
284
285Creates a new terminal, very similar as if you had started it with
286C<system $binfile, arg...>. Croaks (and probably outputs an error message)
287if the new instance couldn't be created. Returns C<undef> if the new
288instance didn't initialise perl, and the terminal object otherwise. The
289C<init> and C<start> hooks will be called during the call.
279 290
280=item urxvt::fatal $errormessage 291=item urxvt::fatal $errormessage
281 292
282Fatally aborts execution with the given error message. Avoid at all 293Fatally aborts execution with the given error message. Avoid at all
283costs! The only time this is acceptable is when the terminal process 294costs! The only time this is acceptable is when the terminal process
… …
500} 511}
501 512
502=head2 The C<urxvt::term> Class 513=head2 The C<urxvt::term> Class
503 514
504=over 4 515=over 4
516
517=item $term->destroy
518
519Destroy the terminal object (close the window, free resources etc.).
505 520
506=item $value = $term->resource ($name[, $newval]) 521=item $value = $term->resource ($name[, $newval])
507 522
508Returns the current resource value associated with a given name and 523Returns the current resource value associated with a given name and
509optionally sets a new value. Setting values is most useful in the C<init> 524optionally sets a new value. Setting values is most useful in the C<init>
… …
650 665
651Normally its not a good idea to use this function, as programs might be 666Normally its not a good idea to use this function, as programs might be
652confused by changes in cursor position or scrolling. Its useful inside a 667confused by changes in cursor position or scrolling. Its useful inside a
653C<on_add_lines> hook, though. 668C<on_add_lines> hook, though.
654 669
670=item $term->cmd_parse ($octets)
671
672Similar to C<scr_add_lines>, but the argument must be in the
673locale-specific encoding of the terminal and can contain command sequences
674(escape codes) that will be interpreted.
675
655=item $term->tt_write ($octets) 676=item $term->tt_write ($octets)
656 677
657Write the octets given in C<$data> to the tty (i.e. as program input). To 678Write the octets given in C<$data> to the tty (i.e. as program input). To
658pass characters instead of octets, you should convert your strings first 679pass characters instead of octets, you should convert your strings first
659to the locale-specific encoding using C<< $term->locale_encode >>. 680to the locale-specific encoding using C<< $term->locale_encode >>.

Diff Legend

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