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.1 by root, Mon Jan 2 15:35:43 2006 UTC vs.
Revision 1.5 by root, Mon Jan 2 17:20:00 2006 UTC

1=head1 NAME 1=head1 NAME
2 2
3urxvt - rxvt-unicode's embedded perl interpreter 3rxvtperl - rxvt-unicode's embedded perl interpreter
4 4
5=head1 SYNOPSIS 5=head1 SYNOPSIS
6 6
7Put your scripts into $LIBDIR/perl-init/, they will be loaded automatically. 7* Put your scripts into F<@@RXVT_LIBDIR@@/urxvt/perl-ext/>, they will be loaded automatically.
8 8
9Each script will only be loaded once, even in urxvtd, and will be valid 9* Each script will only be loaded once, even in urxvtd, and will be valid
10globally. 10globally.
11 11
12Scripts are evaluated in a 'use strict' and 'use utf8' environment, and 12* Scripts are evaluated in a 'use strict' and 'use utf8' environment, and
13thus must be written in utf-8. 13thus must be encoded as UTF-8.
14 14
15 sub on_sel_grab { 15 sub on_sel_grab {
16 warn "you selected ", $_[0]->selection; 16 warn "you selected ", $_[0]->selection;
17 ()
17 } 18 }
18 19
19 1 20 1
20 21
21=head1 DESCRIPTION 22=head1 DESCRIPTION
224 225
225 $pkg 226 $pkg
226 }; 227 };
227} 228}
228 229
229load_script $_ for grep -f $_, <$LIBDIR/perl-init/*>; 230load_script $_ for grep -f $_, <$LIBDIR/perl-ext/*>;
230
231 231
232=back 232=back
233 233
234=head2 The C<urxvt::term> Class 234=head2 The C<urxvt::term> Class
235 235
236=over 4 236=over 4
237
238=item $value = $term->resource ($name[, $newval])
239
240Returns the current resource value associated with a given name and
241optionally sets a new value. Setting values is most useful in the C<init>
242hook. Unset resources are returned and accepted as C<undef>.
243
244The new value must be properly encoded to a suitable character encoding
245before passing it to this method. Similarly, the returned value may need
246to be converted from the used encoding to text.
247
248Resource names are as defined in F<src/rsinc.h>. Colours can be specified
249as resource names of the form C<< color+<index> >>, e.g. C<color+5>. (will
250likely change).
251
252Please note that resource strings will currently only be freed when the
253terminal is destroyed, so changing options frequently will eat memory.
254
255Here is a a likely non-exhaustive list of resource names, not all of which
256are supported in every build, please see the source to see the actual
257list:
258
259 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
260 borderLess color cursorBlink cursorUnderline cutchars delete_key
261 display_name embed ext_bwidth fade font geometry hold iconName
262 imFont imLocale inputMethod insecure int_bwidth intensityStyles
263 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8
264 modifier mouseWheelScrollPage name pastableTabs path pointerBlank
265 pointerBlankDelay preeditType print_pipe pty_fd reverseVideo saveLines
266 scrollBar scrollBar_align scrollBar_floating scrollBar_right
267 scrollBar_thickness scrollTtyKeypress scrollTtyOutput scrollWithBuffer
268 scrollstyle secondaryScreen secondaryScroll selectstyle shade term_name
269 title transparent transparent_all tripleclickwords utmpInhibit
270 visualBell
271
272=cut
273
274sub urxvt::term::resource($$;$) {
275 my ($self, $name) = (shift, shift);
276 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
277 goto &urxvt::term::_resource;
278}
237 279
238=item ($row, $col) = $term->selection_mark ([$row, $col]) 280=item ($row, $col) = $term->selection_mark ([$row, $col])
239 281
240=item ($row, $col) = $term->selection_beg ([$row, $col]) 282=item ($row, $col) = $term->selection_beg ([$row, $col])
241 283
390 432
391Stop watching for events on the given filehandle. 433Stop watching for events on the given filehandle.
392 434
393=back 435=back
394 436
437=head1 ENVIRONMENT
438
439=head2 URXVT_PERL_VERBOSITY
440
441This variable controls the verbosity level of the perl extension. Higher
442numbers indicate more verbose output.
443
444=over 4
445
446=item 0 - only fatal messages
447
448=item 3 - script loading and management
449
450=item 10 - all events received
451
452=back
453
395=head1 AUTHOR 454=head1 AUTHOR
396 455
397 Marc Lehmann <pcg@goof.com> 456 Marc Lehmann <pcg@goof.com>
398 http://software.schmorp.de/pkg/rxvt-unicode 457 http://software.schmorp.de/pkg/rxvt-unicode
399 458

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines