ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvtperl.3.man.in
(Generate patch)

Comparing rxvt-unicode/doc/rxvtperl.3.man.in (file contents):
Revision 1.66 by root, Sat Nov 8 16:49:46 2008 UTC vs.
Revision 1.67 by root, Wed Dec 30 06:14:03 2009 UTC

1.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05) 1.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07)
2.\" 2.\"
3.\" Standard preamble: 3.\" Standard preamble:
4.\" ======================================================================== 4.\" ========================================================================
5.de Sh \" Subsection heading
6.br
7.if t .Sp
8.ne 5
9.PP
10\fB\\$1\fR
11.PP
12..
13.de Sp \" Vertical space (when we can't use .PP) 5.de Sp \" Vertical space (when we can't use .PP)
14.if t .sp .5v 6.if t .sp .5v
15.if n .sp 7.if n .sp
16.. 8..
17.de Vb \" Begin verbatim text 9.de Vb \" Begin verbatim text
… …
51.\" Escape single quotes in literal strings from groff's Unicode transform. 43.\" Escape single quotes in literal strings from groff's Unicode transform.
52.ie \n(.g .ds Aq \(aq 44.ie \n(.g .ds Aq \(aq
53.el .ds Aq ' 45.el .ds Aq '
54.\" 46.\"
55.\" If the F register is turned on, we'll generate index entries on stderr for 47.\" If the F register is turned on, we'll generate index entries on stderr for
56.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index 48.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
57.\" entries marked with X<> in POD. Of course, you'll have to process the 49.\" entries marked with X<> in POD. Of course, you'll have to process the
58.\" output yourself in some meaningful fashion. 50.\" output yourself in some meaningful fashion.
59.ie \nF \{\ 51.ie \nF \{\
60. de IX 52. de IX
61. tm Index:\\$1\t\\n%\t"\\$2" 53. tm Index:\\$1\t\\n%\t"\\$2"
… …
130.\} 122.\}
131.rm #[ #] #H #V #F C 123.rm #[ #] #H #V #F C
132.\" ======================================================================== 124.\" ========================================================================
133.\" 125.\"
134.IX Title "@@RXVT_NAME@@ 3" 126.IX Title "@@RXVT_NAME@@ 3"
135.TH @@RXVT_NAME@@ 3 "2008-11-08" "@@RXVT_VERSION@@" "RXVT-UNICODE" 127.TH @@RXVT_NAME@@ 3 "2009-12-30" "@@RXVT_VERSION@@" "RXVT-UNICODE"
136.\" For nroff, turn off justification. Always turn off hyphenation; it makes 128.\" For nroff, turn off justification. Always turn off hyphenation; it makes
137.\" way too many mistakes in technical documents. 129.\" way too many mistakes in technical documents.
138.if n .ad l 130.if n .ad l
139.nh 131.nh
140.SH "NAME" 132.SH "NAME"
… …
529.Sp 521.Sp
530\&\fINote to xrdb users:\fR xrdb uses the C preprocessor, which might interpret 522\&\fINote to xrdb users:\fR xrdb uses the C preprocessor, which might interpret
531the double \f(CW\*(C`/\*(C'\fR characters as comment start. Use \f(CW\*(C`\e057\e057\*(C'\fR instead, 523the double \f(CW\*(C`/\*(C'\fR characters as comment start. Use \f(CW\*(C`\e057\e057\*(C'\fR instead,
532which works regardless of wether xrdb is used to parse the resource file 524which works regardless of wether xrdb is used to parse the resource file
533or not. 525or not.
526.IP "macosx-pastebin and macosx-pastebin-native" 4
527.IX Item "macosx-pastebin and macosx-pastebin-native"
528These two modules implement an extended clipboard for Mac \s-1OS\s0 X. They are
529used like this:
530.Sp
531.Vb 3
532\& URxvt.perl\-ext\-common: default,macosx\-clipboard
533\& URxvt.keysym.M\-c: perl:macosx\-clipboard:copy
534\& URxvt.keysym.M\-v: perl:macosx\-clipboard:paste
535.Ve
536.Sp
537The difference between them is that the native variant requires a
538perl from apple's devkit or so, and \f(CW\*(C`maxosx\-pastebin\*(C'\fR requires the
539\&\f(CW\*(C`Mac::Pasteboard\*(C'\fR module, works with other perls, has fewer bugs, is
540simpler etc. etc.
534.IP "example-refresh-hooks" 4 541.IP "example-refresh-hooks" 4
535.IX Item "example-refresh-hooks" 542.IX Item "example-refresh-hooks"
536Displays a very simple digital clock in the upper right corner of the 543Displays a very simple digital clock in the upper right corner of the
537window. Illustrates overwriting the refresh callbacks to create your own 544window. Illustrates overwriting the refresh callbacks to create your own
538overlays or changes. 545overlays or changes.
539.SH "API DOCUMENTATION" 546.SH "API DOCUMENTATION"
540.IX Header "API DOCUMENTATION" 547.IX Header "API DOCUMENTATION"
541.Sh "General \s-1API\s0 Considerations" 548.SS "General \s-1API\s0 Considerations"
542.IX Subsection "General API Considerations" 549.IX Subsection "General API Considerations"
543All objects (such as terminals, time watchers etc.) are typical 550All objects (such as terminals, time watchers etc.) are typical
544reference-to-hash objects. The hash can be used to store anything you 551reference-to-hash objects. The hash can be used to store anything you
545like. All members starting with an underscore (such as \f(CW\*(C`_ptr\*(C'\fR or 552like. All members starting with an underscore (such as \f(CW\*(C`_ptr\*(C'\fR or
546\&\f(CW\*(C`_hook\*(C'\fR) are reserved for internal uses and \fB\s-1MUST\s0 \s-1NOT\s0\fR be accessed or 553\&\f(CW\*(C`_hook\*(C'\fR) are reserved for internal uses and \fB\s-1MUST\s0 \s-1NOT\s0\fR be accessed or
… …
567.ie n .IP "$octets" 4 574.ie n .IP "$octets" 4
568.el .IP "\f(CW$octets\fR" 4 575.el .IP "\f(CW$octets\fR" 4
569.IX Item "$octets" 576.IX Item "$octets"
570Either binary data or \- more common \- a text string encoded in a 577Either binary data or \- more common \- a text string encoded in a
571locale-specific way. 578locale-specific way.
572.Sh "Extension Objects" 579.SS "Extension Objects"
573.IX Subsection "Extension Objects" 580.IX Subsection "Extension Objects"
574Every perl extension is a perl class. A separate perl object is created 581Every perl extension is a perl class. A separate perl object is created
575for each terminal, and each terminal has its own set of extenion objects, 582for each terminal, and each terminal has its own set of extenion objects,
576which are passed as the first parameter to hooks. So extensions can use 583which are passed as the first parameter to hooks. So extensions can use
577their \f(CW$self\fR object without having to think about clashes with other 584their \f(CW$self\fR object without having to think about clashes with other
… …
581.PP 588.PP
582Although it isn't a \f(CW\*(C`urxvt::term\*(C'\fR object, you can call all methods of the 589Although it isn't a \f(CW\*(C`urxvt::term\*(C'\fR object, you can call all methods of the
583\&\f(CW\*(C`urxvt::term\*(C'\fR class on this object. 590\&\f(CW\*(C`urxvt::term\*(C'\fR class on this object.
584.PP 591.PP
585It has the following methods and data members: 592It has the following methods and data members:
586.ie n .IP "$urxvt_term\fR = \f(CW$self\->{term}" 4 593.ie n .IP "$urxvt_term = $self\->{term}" 4
587.el .IP "\f(CW$urxvt_term\fR = \f(CW$self\fR\->{term}" 4 594.el .IP "\f(CW$urxvt_term\fR = \f(CW$self\fR\->{term}" 4
588.IX Item "$urxvt_term = $self->{term}" 595.IX Item "$urxvt_term = $self->{term}"
589Returns the \f(CW\*(C`urxvt::term\*(C'\fR object associated with this instance of the 596Returns the \f(CW\*(C`urxvt::term\*(C'\fR object associated with this instance of the
590extension. This member \fImust not\fR be changed in any way. 597extension. This member \fImust not\fR be changed in any way.
591.ie n .IP "$self\fR\->enable ($hook_name => \f(CW$cb\fR, [$hook_name => \f(CW$cb..])" 4 598.ie n .IP "$self\->enable ($hook_name => $cb, [$hook_name => $cb..])" 4
592.el .IP "\f(CW$self\fR\->enable ($hook_name => \f(CW$cb\fR, [$hook_name => \f(CW$cb\fR..])" 4 599.el .IP "\f(CW$self\fR\->enable ($hook_name => \f(CW$cb\fR, [$hook_name => \f(CW$cb\fR..])" 4
593.IX Item "$self->enable ($hook_name => $cb, [$hook_name => $cb..])" 600.IX Item "$self->enable ($hook_name => $cb, [$hook_name => $cb..])"
594Dynamically enable the given hooks (named without the \f(CW\*(C`on_\*(C'\fR prefix) for 601Dynamically enable the given hooks (named without the \f(CW\*(C`on_\*(C'\fR prefix) for
595this extension, replacing any previous hook. This is useful when you want 602this extension, replacing any previous hook. This is useful when you want
596to overwrite time-critical hooks only temporarily. 603to overwrite time-critical hooks only temporarily.
597.ie n .IP "$self\fR\->disable ($hook_name[, \f(CW$hook_name..])" 4 604.ie n .IP "$self\->disable ($hook_name[, $hook_name..])" 4
598.el .IP "\f(CW$self\fR\->disable ($hook_name[, \f(CW$hook_name\fR..])" 4 605.el .IP "\f(CW$self\fR\->disable ($hook_name[, \f(CW$hook_name\fR..])" 4
599.IX Item "$self->disable ($hook_name[, $hook_name..])" 606.IX Item "$self->disable ($hook_name[, $hook_name..])"
600Dynamically disable the given hooks. 607Dynamically disable the given hooks.
601.Sh "Hooks" 608.SS "Hooks"
602.IX Subsection "Hooks" 609.IX Subsection "Hooks"
603The following subroutines can be declared in extension files, and will be 610The following subroutines can be declared in extension files, and will be
604called whenever the relevant event happens. 611called whenever the relevant event happens.
605.PP 612.PP
606The first argument passed to them is an extension object as described in 613The first argument passed to them is an extension object as described in
… …
634.el .IP "on_reset \f(CW$term\fR" 4 641.el .IP "on_reset \f(CW$term\fR" 4
635.IX Item "on_reset $term" 642.IX Item "on_reset $term"
636Called after the screen is \*(L"reset\*(R" for any reason, such as resizing or 643Called after the screen is \*(L"reset\*(R" for any reason, such as resizing or
637control sequences. Here is where you can react on changes to size-related 644control sequences. Here is where you can react on changes to size-related
638variables. 645variables.
639.ie n .IP "on_child_start $term\fR, \f(CW$pid" 4 646.ie n .IP "on_child_start $term, $pid" 4
640.el .IP "on_child_start \f(CW$term\fR, \f(CW$pid\fR" 4 647.el .IP "on_child_start \f(CW$term\fR, \f(CW$pid\fR" 4
641.IX Item "on_child_start $term, $pid" 648.IX Item "on_child_start $term, $pid"
642Called just after the child process has been \f(CW\*(C`fork\*(C'\fRed. 649Called just after the child process has been \f(CW\*(C`fork\*(C'\fRed.
643.ie n .IP "on_child_exit $term\fR, \f(CW$status" 4 650.ie n .IP "on_child_exit $term, $status" 4
644.el .IP "on_child_exit \f(CW$term\fR, \f(CW$status\fR" 4 651.el .IP "on_child_exit \f(CW$term\fR, \f(CW$status\fR" 4
645.IX Item "on_child_exit $term, $status" 652.IX Item "on_child_exit $term, $status"
646Called just after the child process has exited. \f(CW$status\fR is the status 653Called just after the child process has exited. \f(CW$status\fR is the status
647from \f(CW\*(C`waitpid\*(C'\fR. 654from \f(CW\*(C`waitpid\*(C'\fR.
648.ie n .IP "on_sel_make $term\fR, \f(CW$eventtime" 4 655.ie n .IP "on_sel_make $term, $eventtime" 4
649.el .IP "on_sel_make \f(CW$term\fR, \f(CW$eventtime\fR" 4 656.el .IP "on_sel_make \f(CW$term\fR, \f(CW$eventtime\fR" 4
650.IX Item "on_sel_make $term, $eventtime" 657.IX Item "on_sel_make $term, $eventtime"
651Called whenever a selection has been made by the user, but before the 658Called whenever a selection has been made by the user, but before the
652selection text is copied, so changes to the beginning, end or type of the 659selection text is copied, so changes to the beginning, end or type of the
653selection will be honored. 660selection will be honored.
654.Sp 661.Sp
655Returning a true value aborts selection making by urxvt, in which case you 662Returning a true value aborts selection making by urxvt, in which case you
656have to make a selection yourself by calling \f(CW\*(C`$term\->selection_grab\*(C'\fR. 663have to make a selection yourself by calling \f(CW\*(C`$term\->selection_grab\*(C'\fR.
657.ie n .IP "on_sel_grab $term\fR, \f(CW$eventtime" 4 664.ie n .IP "on_sel_grab $term, $eventtime" 4
658.el .IP "on_sel_grab \f(CW$term\fR, \f(CW$eventtime\fR" 4 665.el .IP "on_sel_grab \f(CW$term\fR, \f(CW$eventtime\fR" 4
659.IX Item "on_sel_grab $term, $eventtime" 666.IX Item "on_sel_grab $term, $eventtime"
660Called whenever a selection has been copied, but before the selection is 667Called whenever a selection has been copied, but before the selection is
661requested from the server. The selection text can be queried and changed 668requested from the server. The selection text can be queried and changed
662by calling \f(CW\*(C`$term\->selection\*(C'\fR. 669by calling \f(CW\*(C`$term\->selection\*(C'\fR.
… …
671processing. This can happen multiple times, as long as the callback 678processing. This can happen multiple times, as long as the callback
672returns true, it will be called on every further click by the user and is 679returns true, it will be called on every further click by the user and is
673supposed to enlarge the selection more and more, if possible. 680supposed to enlarge the selection more and more, if possible.
674.Sp 681.Sp
675See the \fIselection\fR example extension. 682See the \fIselection\fR example extension.
676.ie n .IP "on_view_change $term\fR, \f(CW$offset" 4 683.ie n .IP "on_view_change $term, $offset" 4
677.el .IP "on_view_change \f(CW$term\fR, \f(CW$offset\fR" 4 684.el .IP "on_view_change \f(CW$term\fR, \f(CW$offset\fR" 4
678.IX Item "on_view_change $term, $offset" 685.IX Item "on_view_change $term, $offset"
679Called whenever the view offset changes, i.e. the user or program 686Called whenever the view offset changes, i.e. the user or program
680scrolls. Offset \f(CW0\fR means display the normal terminal, positive values 687scrolls. Offset \f(CW0\fR means display the normal terminal, positive values
681show this many lines of scrollback. 688show this many lines of scrollback.
682.ie n .IP "on_scroll_back $term\fR, \f(CW$lines\fR, \f(CW$saved" 4 689.ie n .IP "on_scroll_back $term, $lines, $saved" 4
683.el .IP "on_scroll_back \f(CW$term\fR, \f(CW$lines\fR, \f(CW$saved\fR" 4 690.el .IP "on_scroll_back \f(CW$term\fR, \f(CW$lines\fR, \f(CW$saved\fR" 4
684.IX Item "on_scroll_back $term, $lines, $saved" 691.IX Item "on_scroll_back $term, $lines, $saved"
685Called whenever lines scroll out of the terminal area into the scrollback 692Called whenever lines scroll out of the terminal area into the scrollback
686buffer. \f(CW$lines\fR is the number of lines scrolled out and may be larger 693buffer. \f(CW$lines\fR is the number of lines scrolled out and may be larger
687than the scroll back buffer or the terminal. 694than the scroll back buffer or the terminal.
688.Sp 695.Sp
689It is called before lines are scrolled out (so rows 0 .. min ($lines \- 1, 696It is called before lines are scrolled out (so rows 0 .. min ($lines \- 1,
690\&\f(CW$nrow\fR \- 1) represent the lines to be scrolled out). \f(CW$saved\fR is the total 697\&\f(CW$nrow\fR \- 1) represent the lines to be scrolled out). \f(CW$saved\fR is the total
691number of lines that will be in the scrollback buffer. 698number of lines that will be in the scrollback buffer.
692.ie n .IP "on_osc_seq $term\fR, \f(CW$op\fR, \f(CW$args\fR, \f(CW$resp" 4 699.ie n .IP "on_osc_seq $term, $op, $args, $resp" 4
693.el .IP "on_osc_seq \f(CW$term\fR, \f(CW$op\fR, \f(CW$args\fR, \f(CW$resp\fR" 4 700.el .IP "on_osc_seq \f(CW$term\fR, \f(CW$op\fR, \f(CW$args\fR, \f(CW$resp\fR" 4
694.IX Item "on_osc_seq $term, $op, $args, $resp" 701.IX Item "on_osc_seq $term, $op, $args, $resp"
695Called on every \s-1OSC\s0 sequence and can be used to suppress it or modify its 702Called on every \s-1OSC\s0 sequence and can be used to suppress it or modify its
696behaviour. The default should be to return an empty list. A true value 703behaviour. The default should be to return an empty list. A true value
697suppresses execution of the request completely. Make sure you don't get 704suppresses execution of the request completely. Make sure you don't get
698confused by recursive invocations when you output an \s-1OSC\s0 sequence within 705confused by recursive invocations when you output an \s-1OSC\s0 sequence within
699this callback. 706this callback.
700.Sp 707.Sp
701\&\f(CW\*(C`on_osc_seq_perl\*(C'\fR should be used for new behaviour. 708\&\f(CW\*(C`on_osc_seq_perl\*(C'\fR should be used for new behaviour.
702.ie n .IP "on_osc_seq_perl $term\fR, \f(CW$args\fR, \f(CW$resp" 4 709.ie n .IP "on_osc_seq_perl $term, $args, $resp" 4
703.el .IP "on_osc_seq_perl \f(CW$term\fR, \f(CW$args\fR, \f(CW$resp\fR" 4 710.el .IP "on_osc_seq_perl \f(CW$term\fR, \f(CW$args\fR, \f(CW$resp\fR" 4
704.IX Item "on_osc_seq_perl $term, $args, $resp" 711.IX Item "on_osc_seq_perl $term, $args, $resp"
705Called whenever the \fB\s-1ESC\s0 ] 777 ; string \s-1ST\s0\fR command sequence (\s-1OSC\s0 = 712Called whenever the \fB\s-1ESC\s0 ] 777 ; string \s-1ST\s0\fR command sequence (\s-1OSC\s0 =
706operating system command) is processed. Cursor position and other state 713operating system command) is processed. Cursor position and other state
707information is up-to-date when this happens. For interoperability, the 714information is up-to-date when this happens. For interoperability, the
… …
725as its source can not easily be controlled (e\-mail content, messages from 732as its source can not easily be controlled (e\-mail content, messages from
726other users on the same system etc.). 733other users on the same system etc.).
727.Sp 734.Sp
728For responses, \f(CW$resp\fR contains the end-of-args separator used by the 735For responses, \f(CW$resp\fR contains the end-of-args separator used by the
729sender. 736sender.
730.ie n .IP "on_add_lines $term\fR, \f(CW$string" 4 737.ie n .IP "on_add_lines $term, $string" 4
731.el .IP "on_add_lines \f(CW$term\fR, \f(CW$string\fR" 4 738.el .IP "on_add_lines \f(CW$term\fR, \f(CW$string\fR" 4
732.IX Item "on_add_lines $term, $string" 739.IX Item "on_add_lines $term, $string"
733Called whenever text is about to be output, with the text as argument. You 740Called whenever text is about to be output, with the text as argument. You
734can filter/change and output the text yourself by returning a true value 741can filter/change and output the text yourself by returning a true value
735and calling \f(CW\*(C`$term\->scr_add_lines\*(C'\fR yourself. Please note that this 742and calling \f(CW\*(C`$term\->scr_add_lines\*(C'\fR yourself. Please note that this
736might be very slow, however, as your hook is called for \fBall\fR text being 743might be very slow, however, as your hook is called for \fBall\fR text being
737output. 744output.
738.ie n .IP "on_tt_write $term\fR, \f(CW$octets" 4 745.ie n .IP "on_tt_write $term, $octets" 4
739.el .IP "on_tt_write \f(CW$term\fR, \f(CW$octets\fR" 4 746.el .IP "on_tt_write \f(CW$term\fR, \f(CW$octets\fR" 4
740.IX Item "on_tt_write $term, $octets" 747.IX Item "on_tt_write $term, $octets"
741Called whenever some data is written to the tty/pty and can be used to 748Called whenever some data is written to the tty/pty and can be used to
742suppress or filter tty input. 749suppress or filter tty input.
743.ie n .IP "on_line_update $term\fR, \f(CW$row" 4 750.ie n .IP "on_line_update $term, $row" 4
744.el .IP "on_line_update \f(CW$term\fR, \f(CW$row\fR" 4 751.el .IP "on_line_update \f(CW$term\fR, \f(CW$row\fR" 4
745.IX Item "on_line_update $term, $row" 752.IX Item "on_line_update $term, $row"
746Called whenever a line was updated or changed. Can be used to filter 753Called whenever a line was updated or changed. Can be used to filter
747screen output (e.g. underline urls or other useless stuff). Only lines 754screen output (e.g. underline urls or other useless stuff). Only lines
748that are being shown will be filtered, and, due to performance reasons, 755that are being shown will be filtered, and, due to performance reasons,
… …
763code is run after this hook, and takes precedence. 770code is run after this hook, and takes precedence.
764.ie n .IP "on_refresh_end $term" 4 771.ie n .IP "on_refresh_end $term" 4
765.el .IP "on_refresh_end \f(CW$term\fR" 4 772.el .IP "on_refresh_end \f(CW$term\fR" 4
766.IX Item "on_refresh_end $term" 773.IX Item "on_refresh_end $term"
767Called just after the screen gets redrawn. See \f(CW\*(C`on_refresh_begin\*(C'\fR. 774Called just after the screen gets redrawn. See \f(CW\*(C`on_refresh_begin\*(C'\fR.
768.ie n .IP "on_user_command $term\fR, \f(CW$string" 4 775.ie n .IP "on_user_command $term, $string" 4
769.el .IP "on_user_command \f(CW$term\fR, \f(CW$string\fR" 4 776.el .IP "on_user_command \f(CW$term\fR, \f(CW$string\fR" 4
770.IX Item "on_user_command $term, $string" 777.IX Item "on_user_command $term, $string"
771Called whenever a user-configured event is being activated (e.g. via 778Called whenever a user-configured event is being activated (e.g. via
772a \f(CW\*(C`perl:string\*(C'\fR action bound to a key, see description of the \fBkeysym\fR 779a \f(CW\*(C`perl:string\*(C'\fR action bound to a key, see description of the \fBkeysym\fR
773resource in the @@RXVT_NAME@@(1) manpage). 780resource in the @@RXVT_NAME@@(1) manpage).
774.Sp 781.Sp
775The event is simply the action string. This interface is assumed to change 782The event is simply the action string. This interface is assumed to change
776slightly in the future. 783slightly in the future.
777.ie n .IP "on_resize_all_windows $tern\fR, \f(CW$new_width\fR, \f(CW$new_height" 4 784.ie n .IP "on_resize_all_windows $tern, $new_width, $new_height" 4
778.el .IP "on_resize_all_windows \f(CW$tern\fR, \f(CW$new_width\fR, \f(CW$new_height\fR" 4 785.el .IP "on_resize_all_windows \f(CW$tern\fR, \f(CW$new_width\fR, \f(CW$new_height\fR" 4
779.IX Item "on_resize_all_windows $tern, $new_width, $new_height" 786.IX Item "on_resize_all_windows $tern, $new_width, $new_height"
780Called just after the new window size has been calculated, but before 787Called just after the new window size has been calculated, but before
781windows are actually being resized or hints are being set. If this hook 788windows are actually being resized or hints are being set. If this hook
782returns \s-1TRUE\s0, setting of the window hints is being skipped. 789returns \s-1TRUE\s0, setting of the window hints is being skipped.
783.ie n .IP "on_x_event $term\fR, \f(CW$event" 4 790.ie n .IP "on_x_event $term, $event" 4
784.el .IP "on_x_event \f(CW$term\fR, \f(CW$event\fR" 4 791.el .IP "on_x_event \f(CW$term\fR, \f(CW$event\fR" 4
785.IX Item "on_x_event $term, $event" 792.IX Item "on_x_event $term, $event"
786Called on every X event received on the vt window (and possibly other 793Called on every X event received on the vt window (and possibly other
787windows). Should only be used as a last resort. Most event structure 794windows). Should only be used as a last resort. Most event structure
788members are not passed. 795members are not passed.
789.ie n .IP "on_root_event $term\fR, \f(CW$event" 4 796.ie n .IP "on_root_event $term, $event" 4
790.el .IP "on_root_event \f(CW$term\fR, \f(CW$event\fR" 4 797.el .IP "on_root_event \f(CW$term\fR, \f(CW$event\fR" 4
791.IX Item "on_root_event $term, $event" 798.IX Item "on_root_event $term, $event"
792Like \f(CW\*(C`on_x_event\*(C'\fR, but is called for events on the root window. 799Like \f(CW\*(C`on_x_event\*(C'\fR, but is called for events on the root window.
793.ie n .IP "on_focus_in $term" 4 800.ie n .IP "on_focus_in $term" 4
794.el .IP "on_focus_in \f(CW$term\fR" 4 801.el .IP "on_focus_in \f(CW$term\fR" 4
… …
798.ie n .IP "on_focus_out $term" 4 805.ie n .IP "on_focus_out $term" 4
799.el .IP "on_focus_out \f(CW$term\fR" 4 806.el .IP "on_focus_out \f(CW$term\fR" 4
800.IX Item "on_focus_out $term" 807.IX Item "on_focus_out $term"
801Called whenever the window loses keyboard focus, before rxvt-unicode does 808Called whenever the window loses keyboard focus, before rxvt-unicode does
802focus out processing. 809focus out processing.
803.ie n .IP "on_configure_notify $term\fR, \f(CW$event" 4 810.ie n .IP "on_configure_notify $term, $event" 4
804.el .IP "on_configure_notify \f(CW$term\fR, \f(CW$event\fR" 4 811.el .IP "on_configure_notify \f(CW$term\fR, \f(CW$event\fR" 4
805.IX Item "on_configure_notify $term, $event" 812.IX Item "on_configure_notify $term, $event"
806.PD 0 813.PD 0
807.ie n .IP "on_property_notify $term\fR, \f(CW$event" 4 814.ie n .IP "on_property_notify $term, $event" 4
808.el .IP "on_property_notify \f(CW$term\fR, \f(CW$event\fR" 4 815.el .IP "on_property_notify \f(CW$term\fR, \f(CW$event\fR" 4
809.IX Item "on_property_notify $term, $event" 816.IX Item "on_property_notify $term, $event"
810.ie n .IP "on_key_press $term\fR, \f(CW$event\fR, \f(CW$keysym\fR, \f(CW$octets" 4 817.ie n .IP "on_key_press $term, $event, $keysym, $octets" 4
811.el .IP "on_key_press \f(CW$term\fR, \f(CW$event\fR, \f(CW$keysym\fR, \f(CW$octets\fR" 4 818.el .IP "on_key_press \f(CW$term\fR, \f(CW$event\fR, \f(CW$keysym\fR, \f(CW$octets\fR" 4
812.IX Item "on_key_press $term, $event, $keysym, $octets" 819.IX Item "on_key_press $term, $event, $keysym, $octets"
813.ie n .IP "on_key_release $term\fR, \f(CW$event\fR, \f(CW$keysym" 4 820.ie n .IP "on_key_release $term, $event, $keysym" 4
814.el .IP "on_key_release \f(CW$term\fR, \f(CW$event\fR, \f(CW$keysym\fR" 4 821.el .IP "on_key_release \f(CW$term\fR, \f(CW$event\fR, \f(CW$keysym\fR" 4
815.IX Item "on_key_release $term, $event, $keysym" 822.IX Item "on_key_release $term, $event, $keysym"
816.ie n .IP "on_button_press $term\fR, \f(CW$event" 4 823.ie n .IP "on_button_press $term, $event" 4
817.el .IP "on_button_press \f(CW$term\fR, \f(CW$event\fR" 4 824.el .IP "on_button_press \f(CW$term\fR, \f(CW$event\fR" 4
818.IX Item "on_button_press $term, $event" 825.IX Item "on_button_press $term, $event"
819.ie n .IP "on_button_release $term\fR, \f(CW$event" 4 826.ie n .IP "on_button_release $term, $event" 4
820.el .IP "on_button_release \f(CW$term\fR, \f(CW$event\fR" 4 827.el .IP "on_button_release \f(CW$term\fR, \f(CW$event\fR" 4
821.IX Item "on_button_release $term, $event" 828.IX Item "on_button_release $term, $event"
822.ie n .IP "on_motion_notify $term\fR, \f(CW$event" 4 829.ie n .IP "on_motion_notify $term, $event" 4
823.el .IP "on_motion_notify \f(CW$term\fR, \f(CW$event\fR" 4 830.el .IP "on_motion_notify \f(CW$term\fR, \f(CW$event\fR" 4
824.IX Item "on_motion_notify $term, $event" 831.IX Item "on_motion_notify $term, $event"
825.ie n .IP "on_map_notify $term\fR, \f(CW$event" 4 832.ie n .IP "on_map_notify $term, $event" 4
826.el .IP "on_map_notify \f(CW$term\fR, \f(CW$event\fR" 4 833.el .IP "on_map_notify \f(CW$term\fR, \f(CW$event\fR" 4
827.IX Item "on_map_notify $term, $event" 834.IX Item "on_map_notify $term, $event"
828.ie n .IP "on_unmap_notify $term\fR, \f(CW$event" 4 835.ie n .IP "on_unmap_notify $term, $event" 4
829.el .IP "on_unmap_notify \f(CW$term\fR, \f(CW$event\fR" 4 836.el .IP "on_unmap_notify \f(CW$term\fR, \f(CW$event\fR" 4
830.IX Item "on_unmap_notify $term, $event" 837.IX Item "on_unmap_notify $term, $event"
831.PD 838.PD
832Called whenever the corresponding X event is received for the terminal If 839Called whenever the corresponding X event is received for the terminal If
833the hook returns true, then the even will be ignored by rxvt-unicode. 840the hook returns true, then the even will be ignored by rxvt-unicode.
… …
838.Sp 845.Sp
839\&\f(CW\*(C`on_key_press\*(C'\fR additionally receives the string rxvt-unicode would 846\&\f(CW\*(C`on_key_press\*(C'\fR additionally receives the string rxvt-unicode would
840output, if any, in locale-specific encoding. 847output, if any, in locale-specific encoding.
841.Sp 848.Sp
842subwindow. 849subwindow.
843.ie n .IP "on_client_message $term\fR, \f(CW$event" 4 850.ie n .IP "on_client_message $term, $event" 4
844.el .IP "on_client_message \f(CW$term\fR, \f(CW$event\fR" 4 851.el .IP "on_client_message \f(CW$term\fR, \f(CW$event\fR" 4
845.IX Item "on_client_message $term, $event" 852.IX Item "on_client_message $term, $event"
846.PD 0 853.PD 0
847.ie n .IP "on_wm_protocols $term\fR, \f(CW$event" 4 854.ie n .IP "on_wm_protocols $term, $event" 4
848.el .IP "on_wm_protocols \f(CW$term\fR, \f(CW$event\fR" 4 855.el .IP "on_wm_protocols \f(CW$term\fR, \f(CW$event\fR" 4
849.IX Item "on_wm_protocols $term, $event" 856.IX Item "on_wm_protocols $term, $event"
850.ie n .IP "on_wm_delete_window $term\fR, \f(CW$event" 4 857.ie n .IP "on_wm_delete_window $term, $event" 4
851.el .IP "on_wm_delete_window \f(CW$term\fR, \f(CW$event\fR" 4 858.el .IP "on_wm_delete_window \f(CW$term\fR, \f(CW$event\fR" 4
852.IX Item "on_wm_delete_window $term, $event" 859.IX Item "on_wm_delete_window $term, $event"
853.PD 860.PD
854Called when various types of ClientMessage events are received (all with 861Called when various types of ClientMessage events are received (all with
855format=32, \s-1WM_PROTOCOLS\s0 or \s-1WM_PROTOCOLS:WM_DELETE_WINDOW\s0). 862format=32, \s-1WM_PROTOCOLS\s0 or \s-1WM_PROTOCOLS:WM_DELETE_WINDOW\s0).
856.ie n .Sh "Variables in the ""urxvt"" Package" 863.ie n .SS "Variables in the ""urxvt"" Package"
857.el .Sh "Variables in the \f(CWurxvt\fP Package" 864.el .SS "Variables in the \f(CWurxvt\fP Package"
858.IX Subsection "Variables in the urxvt Package" 865.IX Subsection "Variables in the urxvt Package"
859.ie n .IP "$urxvt::LIBDIR" 4 866.ie n .IP "$urxvt::LIBDIR" 4
860.el .IP "\f(CW$urxvt::LIBDIR\fR" 4 867.el .IP "\f(CW$urxvt::LIBDIR\fR" 4
861.IX Item "$urxvt::LIBDIR" 868.IX Item "$urxvt::LIBDIR"
862The rxvt-unicode library directory, where, among other things, the perl 869The rxvt-unicode library directory, where, among other things, the perl
863modules and scripts are stored. 870modules and scripts are stored.
864.ie n .IP "$urxvt::RESCLASS\fR, \f(CW$urxvt::RESCLASS" 4 871.ie n .IP "$urxvt::RESCLASS, $urxvt::RESCLASS" 4
865.el .IP "\f(CW$urxvt::RESCLASS\fR, \f(CW$urxvt::RESCLASS\fR" 4 872.el .IP "\f(CW$urxvt::RESCLASS\fR, \f(CW$urxvt::RESCLASS\fR" 4
866.IX Item "$urxvt::RESCLASS, $urxvt::RESCLASS" 873.IX Item "$urxvt::RESCLASS, $urxvt::RESCLASS"
867The resource class and name rxvt-unicode uses to look up X resources. 874The resource class and name rxvt-unicode uses to look up X resources.
868.ie n .IP "$urxvt::RXVTNAME" 4 875.ie n .IP "$urxvt::RXVTNAME" 4
869.el .IP "\f(CW$urxvt::RXVTNAME\fR" 4 876.el .IP "\f(CW$urxvt::RXVTNAME\fR" 4
… …
888.el .IP "\f(CW@urxvt::TERM_EXT\fR" 4 895.el .IP "\f(CW@urxvt::TERM_EXT\fR" 4
889.IX Item "@urxvt::TERM_EXT" 896.IX Item "@urxvt::TERM_EXT"
890Works similar to \f(CW@TERM_INIT\fR, but contains perl package/class names, which 897Works similar to \f(CW@TERM_INIT\fR, but contains perl package/class names, which
891get registered as normal extensions after calling the hooks in \f(CW@TERM_INIT\fR 898get registered as normal extensions after calling the hooks in \f(CW@TERM_INIT\fR
892but before other extensions. Gets cleared just like \f(CW@TERM_INIT\fR. 899but before other extensions. Gets cleared just like \f(CW@TERM_INIT\fR.
893.ie n .Sh "Functions in the ""urxvt"" Package" 900.ie n .SS "Functions in the ""urxvt"" Package"
894.el .Sh "Functions in the \f(CWurxvt\fP Package" 901.el .SS "Functions in the \f(CWurxvt\fP Package"
895.IX Subsection "Functions in the urxvt Package" 902.IX Subsection "Functions in the urxvt Package"
896.ie n .IP "urxvt::fatal $errormessage" 4 903.ie n .IP "urxvt::fatal $errormessage" 4
897.el .IP "urxvt::fatal \f(CW$errormessage\fR" 4 904.el .IP "urxvt::fatal \f(CW$errormessage\fR" 4
898.IX Item "urxvt::fatal $errormessage" 905.IX Item "urxvt::fatal $errormessage"
899Fatally aborts execution with the given error message. Avoid at all 906Fatally aborts execution with the given error message. Avoid at all
… …
930.IX Item "urxvt::NoEventMask, KeyPressMask, KeyReleaseMask, ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask, Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask, KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask, ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask, FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask" 937.IX Item "urxvt::NoEventMask, KeyPressMask, KeyReleaseMask, ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask, Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask, KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask, ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask, FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask"
931.IP "urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify, EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose, GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify, UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify, ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify, CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, SelectionNotify, ColormapNotify, ClientMessage, MappingNotify" 4 938.IP "urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify, EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose, GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify, UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify, ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify, CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, SelectionNotify, ColormapNotify, ClientMessage, MappingNotify" 4
932.IX Item "urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify, EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose, GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify, UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify, ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify, CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, SelectionNotify, ColormapNotify, ClientMessage, MappingNotify" 939.IX Item "urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify, EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose, GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify, UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify, ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify, CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, SelectionNotify, ColormapNotify, ClientMessage, MappingNotify"
933.PD 940.PD
934Various constants for use in X calls and event processing. 941Various constants for use in X calls and event processing.
935.Sh "\s-1RENDITION\s0" 942.SS "\s-1RENDITION\s0"
936.IX Subsection "RENDITION" 943.IX Subsection "RENDITION"
937Rendition bitsets contain information about colour, font, font styles and 944Rendition bitsets contain information about colour, font, font styles and
938similar information for each screen cell. 945similar information for each screen cell.
939.PP 946.PP
940The following \*(L"macros\*(R" deal with changes in rendition sets. You should 947The following \*(L"macros\*(R" deal with changes in rendition sets. You should
… …
954.el .IP "\f(CW$rendbit\fR = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline" 4 961.el .IP "\f(CW$rendbit\fR = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline" 4
955.IX Item "$rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline" 962.IX Item "$rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline"
956Return the bit that enabled bold, italic, blink, reverse-video and 963Return the bit that enabled bold, italic, blink, reverse-video and
957underline, respectively. To enable such a style, just logically \s-1OR\s0 it into 964underline, respectively. To enable such a style, just logically \s-1OR\s0 it into
958the bitset. 965the bitset.
959.ie n .IP "$foreground\fR = urxvt::GET_BASEFG \f(CW$rend" 4 966.ie n .IP "$foreground = urxvt::GET_BASEFG $rend" 4
960.el .IP "\f(CW$foreground\fR = urxvt::GET_BASEFG \f(CW$rend\fR" 4 967.el .IP "\f(CW$foreground\fR = urxvt::GET_BASEFG \f(CW$rend\fR" 4
961.IX Item "$foreground = urxvt::GET_BASEFG $rend" 968.IX Item "$foreground = urxvt::GET_BASEFG $rend"
962.PD 0 969.PD 0
963.ie n .IP "$background\fR = urxvt::GET_BASEBG \f(CW$rend" 4 970.ie n .IP "$background = urxvt::GET_BASEBG $rend" 4
964.el .IP "\f(CW$background\fR = urxvt::GET_BASEBG \f(CW$rend\fR" 4 971.el .IP "\f(CW$background\fR = urxvt::GET_BASEBG \f(CW$rend\fR" 4
965.IX Item "$background = urxvt::GET_BASEBG $rend" 972.IX Item "$background = urxvt::GET_BASEBG $rend"
966.PD 973.PD
967Return the foreground/background colour index, respectively. 974Return the foreground/background colour index, respectively.
968.ie n .IP "$rend\fR = urxvt::SET_FGCOLOR \f(CW$rend\fR, \f(CW$new_colour" 4 975.ie n .IP "$rend = urxvt::SET_FGCOLOR $rend, $new_colour" 4
969.el .IP "\f(CW$rend\fR = urxvt::SET_FGCOLOR \f(CW$rend\fR, \f(CW$new_colour\fR" 4 976.el .IP "\f(CW$rend\fR = urxvt::SET_FGCOLOR \f(CW$rend\fR, \f(CW$new_colour\fR" 4
970.IX Item "$rend = urxvt::SET_FGCOLOR $rend, $new_colour" 977.IX Item "$rend = urxvt::SET_FGCOLOR $rend, $new_colour"
971.PD 0 978.PD 0
972.ie n .IP "$rend\fR = urxvt::SET_BGCOLOR \f(CW$rend\fR, \f(CW$new_colour" 4 979.ie n .IP "$rend = urxvt::SET_BGCOLOR $rend, $new_colour" 4
973.el .IP "\f(CW$rend\fR = urxvt::SET_BGCOLOR \f(CW$rend\fR, \f(CW$new_colour\fR" 4 980.el .IP "\f(CW$rend\fR = urxvt::SET_BGCOLOR \f(CW$rend\fR, \f(CW$new_colour\fR" 4
974.IX Item "$rend = urxvt::SET_BGCOLOR $rend, $new_colour" 981.IX Item "$rend = urxvt::SET_BGCOLOR $rend, $new_colour"
975.ie n .IP "$rend\fR = urxvt::SET_COLOR \f(CW$rend\fR, \f(CW$new_fg\fR, \f(CW$new_bg" 4 982.ie n .IP "$rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg" 4
976.el .IP "\f(CW$rend\fR = urxvt::SET_COLOR \f(CW$rend\fR, \f(CW$new_fg\fR, \f(CW$new_bg\fR" 4 983.el .IP "\f(CW$rend\fR = urxvt::SET_COLOR \f(CW$rend\fR, \f(CW$new_fg\fR, \f(CW$new_bg\fR" 4
977.IX Item "$rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg" 984.IX Item "$rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg"
978.PD 985.PD
979Replace the foreground/background colour in the rendition mask with the 986Replace the foreground/background colour in the rendition mask with the
980specified one. 987specified one.
981.ie n .IP "$value\fR = urxvt::GET_CUSTOM \f(CW$rend" 4 988.ie n .IP "$value = urxvt::GET_CUSTOM $rend" 4
982.el .IP "\f(CW$value\fR = urxvt::GET_CUSTOM \f(CW$rend\fR" 4 989.el .IP "\f(CW$value\fR = urxvt::GET_CUSTOM \f(CW$rend\fR" 4
983.IX Item "$value = urxvt::GET_CUSTOM $rend" 990.IX Item "$value = urxvt::GET_CUSTOM $rend"
984Return the \*(L"custom\*(R" value: Every rendition has 5 bits for use by 991Return the \*(L"custom\*(R" value: Every rendition has 5 bits for use by
985extensions. They can be set and changed as you like and are initially 992extensions. They can be set and changed as you like and are initially
986zero. 993zero.
987.ie n .IP "$rend\fR = urxvt::SET_CUSTOM \f(CW$rend\fR, \f(CW$new_value" 4 994.ie n .IP "$rend = urxvt::SET_CUSTOM $rend, $new_value" 4
988.el .IP "\f(CW$rend\fR = urxvt::SET_CUSTOM \f(CW$rend\fR, \f(CW$new_value\fR" 4 995.el .IP "\f(CW$rend\fR = urxvt::SET_CUSTOM \f(CW$rend\fR, \f(CW$new_value\fR" 4
989.IX Item "$rend = urxvt::SET_CUSTOM $rend, $new_value" 996.IX Item "$rend = urxvt::SET_CUSTOM $rend, $new_value"
990Change the custom value. 997Change the custom value.
991.ie n .Sh "The ""urxvt::anyevent"" Class" 998.ie n .SS "The ""urxvt::anyevent"" Class"
992.el .Sh "The \f(CWurxvt::anyevent\fP Class" 999.el .SS "The \f(CWurxvt::anyevent\fP Class"
993.IX Subsection "The urxvt::anyevent Class" 1000.IX Subsection "The urxvt::anyevent Class"
994The sole purpose of this class is to deliver an interface to the 1001The sole purpose of this class is to deliver an interface to the
995\&\f(CW\*(C`AnyEvent\*(C'\fR module \- any module using it will work inside urxvt without 1002\&\f(CW\*(C`AnyEvent\*(C'\fR module \- any module using it will work inside urxvt without
996further programming. The only exception is that you cannot wait on 1003further programming. The only exception is that you cannot wait on
997condition variables, but non-blocking condvar use is ok. What this means 1004condition variables, but non-blocking condvar use is ok. What this means
998is that you cannot use blocking APIs, but the non-blocking variant should 1005is that you cannot use blocking APIs, but the non-blocking variant should
999work. 1006work.
1000.ie n .Sh "The ""urxvt::term"" Class" 1007.ie n .SS "The ""urxvt::term"" Class"
1001.el .Sh "The \f(CWurxvt::term\fP Class" 1008.el .SS "The \f(CWurxvt::term\fP Class"
1002.IX Subsection "The urxvt::term Class" 1009.IX Subsection "The urxvt::term Class"
1003.ie n .IP "$term\fR = new urxvt::term \f(CW$envhashref\fR, \f(CW$rxvtname, [arg...]" 4 1010.ie n .IP "$term = new urxvt::term $envhashref, $rxvtname, [arg...]" 4
1004.el .IP "\f(CW$term\fR = new urxvt::term \f(CW$envhashref\fR, \f(CW$rxvtname\fR, [arg...]" 4 1011.el .IP "\f(CW$term\fR = new urxvt::term \f(CW$envhashref\fR, \f(CW$rxvtname\fR, [arg...]" 4
1005.IX Item "$term = new urxvt::term $envhashref, $rxvtname, [arg...]" 1012.IX Item "$term = new urxvt::term $envhashref, $rxvtname, [arg...]"
1006Creates a new terminal, very similar as if you had started it with system 1013Creates a new terminal, very similar as if you had started it with system
1007\&\f(CW\*(C`$rxvtname, arg...\*(C'\fR. \f(CW$envhashref\fR must be a reference to a \f(CW%ENV\fR\-like 1014\&\f(CW\*(C`$rxvtname, arg...\*(C'\fR. \f(CW$envhashref\fR must be a reference to a \f(CW%ENV\fR\-like
1008hash which defines the environment of the new terminal. 1015hash which defines the environment of the new terminal.
… …
1016.el .IP "\f(CW$term\fR\->destroy" 4 1023.el .IP "\f(CW$term\fR\->destroy" 4
1017.IX Item "$term->destroy" 1024.IX Item "$term->destroy"
1018Destroy the terminal object (close the window, free resources 1025Destroy the terminal object (close the window, free resources
1019etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event 1026etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
1020watchers (timers, io watchers) are still active. 1027watchers (timers, io watchers) are still active.
1021.ie n .IP "$term\fR\->exec_async ($cmd[, \f(CW@args])" 4 1028.ie n .IP "$term\->exec_async ($cmd[, @args])" 4
1022.el .IP "\f(CW$term\fR\->exec_async ($cmd[, \f(CW@args\fR])" 4 1029.el .IP "\f(CW$term\fR\->exec_async ($cmd[, \f(CW@args\fR])" 4
1023.IX Item "$term->exec_async ($cmd[, @args])" 1030.IX Item "$term->exec_async ($cmd[, @args])"
1024Works like the combination of the \f(CW\*(C`fork\*(C'\fR/\f(CW\*(C`exec\*(C'\fR builtins, which executes 1031Works like the combination of the \f(CW\*(C`fork\*(C'\fR/\f(CW\*(C`exec\*(C'\fR builtins, which executes
1025(\*(L"starts\*(R") programs in the background. This function takes care of setting 1032(\*(L"starts\*(R") programs in the background. This function takes care of setting
1026the user environment before exec'ing the command (e.g. \f(CW\*(C`PATH\*(C'\fR) and should 1033the user environment before exec'ing the command (e.g. \f(CW\*(C`PATH\*(C'\fR) and should
1027be preferred over explicit calls to \f(CW\*(C`exec\*(C'\fR or \f(CW\*(C`system\*(C'\fR. 1034be preferred over explicit calls to \f(CW\*(C`exec\*(C'\fR or \f(CW\*(C`system\*(C'\fR.
1028.Sp 1035.Sp
1029Returns the pid of the subprocess or \f(CW\*(C`undef\*(C'\fR on error. 1036Returns the pid of the subprocess or \f(CW\*(C`undef\*(C'\fR on error.
1030.ie n .IP "$isset\fR = \f(CW$term\fR\->option ($optval[, \f(CW$set])" 4 1037.ie n .IP "$isset = $term\->option ($optval[, $set])" 4
1031.el .IP "\f(CW$isset\fR = \f(CW$term\fR\->option ($optval[, \f(CW$set\fR])" 4 1038.el .IP "\f(CW$isset\fR = \f(CW$term\fR\->option ($optval[, \f(CW$set\fR])" 4
1032.IX Item "$isset = $term->option ($optval[, $set])" 1039.IX Item "$isset = $term->option ($optval[, $set])"
1033Returns true if the option specified by \f(CW$optval\fR is enabled, and 1040Returns true if the option specified by \f(CW$optval\fR is enabled, and
1034optionally change it. All option values are stored by name in the hash 1041optionally change it. All option values are stored by name in the hash
1035\&\f(CW%urxvt::OPTION\fR. Options not enabled in this binary are not in the hash. 1042\&\f(CW%urxvt::OPTION\fR. Options not enabled in this binary are not in the hash.
… …
1043\& override\-redirect pastableTabs pointerBlank reverseVideo scrollBar 1050\& override\-redirect pastableTabs pointerBlank reverseVideo scrollBar
1044\& scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput 1051\& scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
1045\& scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs 1052\& scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
1046\& transparent tripleclickwords utmpInhibit visualBell 1053\& transparent tripleclickwords utmpInhibit visualBell
1047.Ve 1054.Ve
1048.ie n .IP "$value\fR = \f(CW$term\fR\->resource ($name[, \f(CW$newval])" 4 1055.ie n .IP "$value = $term\->resource ($name[, $newval])" 4
1049.el .IP "\f(CW$value\fR = \f(CW$term\fR\->resource ($name[, \f(CW$newval\fR])" 4 1056.el .IP "\f(CW$value\fR = \f(CW$term\fR\->resource ($name[, \f(CW$newval\fR])" 4
1050.IX Item "$value = $term->resource ($name[, $newval])" 1057.IX Item "$value = $term->resource ($name[, $newval])"
1051Returns the current resource value associated with a given name and 1058Returns the current resource value associated with a given name and
1052optionally sets a new value. Setting values is most useful in the \f(CW\*(C`init\*(C'\fR 1059optionally sets a new value. Setting values is most useful in the \f(CW\*(C`init\*(C'\fR
1053hook. Unset resources are returned and accepted as \f(CW\*(C`undef\*(C'\fR. 1060hook. Unset resources are returned and accepted as \f(CW\*(C`undef\*(C'\fR.
… …
1070.Vb 10 1077.Vb 10
1071\& answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1078\& answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1072\& borderLess chdir color cursorBlink cursorUnderline cutchars delete_key 1079\& borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1073\& display_name embed ext_bwidth fade font geometry hold iconName 1080\& display_name embed ext_bwidth fade font geometry hold iconName
1074\& imFont imLocale inputMethod insecure int_bwidth intensityStyles 1081\& imFont imLocale inputMethod insecure int_bwidth intensityStyles
1075\& italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier 1082\& italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
1076\& mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 1083\& modifier mouseWheelScrollPage name override_redirect pastableTabs path
1077\& perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1084\& perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1078\& preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1085\& preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1079\& scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1086\& scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1080\& scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1087\& scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1081\& secondaryScreen secondaryScroll shade term_name title 1088\& secondaryScreen secondaryScroll shade term_name title
1082\& transient_for transparent transparent_all tripleclickwords utmpInhibit 1089\& transient_for transparent transparent_all tripleclickwords utmpInhibit
1083\& visualBell 1090\& visualBell
1084.Ve 1091.Ve
1085.ie n .IP "$value\fR = \f(CW$term\->x_resource ($pattern)" 4 1092.ie n .IP "$value = $term\->x_resource ($pattern)" 4
1086.el .IP "\f(CW$value\fR = \f(CW$term\fR\->x_resource ($pattern)" 4 1093.el .IP "\f(CW$value\fR = \f(CW$term\fR\->x_resource ($pattern)" 4
1087.IX Item "$value = $term->x_resource ($pattern)" 1094.IX Item "$value = $term->x_resource ($pattern)"
1088Returns the X\-Resource for the given pattern, excluding the program or 1095Returns the X\-Resource for the given pattern, excluding the program or
1089class name, i.e. \f(CW\*(C`$term\->x_resource ("boldFont")\*(C'\fR should return the 1096class name, i.e. \f(CW\*(C`$term\->x_resource ("boldFont")\*(C'\fR should return the
1090same value as used by this instance of rxvt-unicode. Returns \f(CW\*(C`undef\*(C'\fR if no 1097same value as used by this instance of rxvt-unicode. Returns \f(CW\*(C`undef\*(C'\fR if no
1091resource with that pattern exists. 1098resource with that pattern exists.
1092.Sp 1099.Sp
1093This method should only be called during the \f(CW\*(C`on_start\*(C'\fR hook, as there is 1100This method should only be called during the \f(CW\*(C`on_start\*(C'\fR hook, as there is
1094only one resource database per display, and later invocations might return 1101only one resource database per display, and later invocations might return
1095the wrong resources. 1102the wrong resources.
1096.ie n .IP "$success\fR = \f(CW$term\fR\->parse_keysym ($keysym_spec, \f(CW$command_string)" 4 1103.ie n .IP "$success = $term\->parse_keysym ($keysym_spec, $command_string)" 4
1097.el .IP "\f(CW$success\fR = \f(CW$term\fR\->parse_keysym ($keysym_spec, \f(CW$command_string\fR)" 4 1104.el .IP "\f(CW$success\fR = \f(CW$term\fR\->parse_keysym ($keysym_spec, \f(CW$command_string\fR)" 4
1098.IX Item "$success = $term->parse_keysym ($keysym_spec, $command_string)" 1105.IX Item "$success = $term->parse_keysym ($keysym_spec, $command_string)"
1099Adds a keymap translation exactly as specified via a resource. See the 1106Adds a keymap translation exactly as specified via a resource. See the
1100\&\f(CW\*(C`keysym\*(C'\fR resource in the @@RXVT_NAME@@(1) manpage. 1107\&\f(CW\*(C`keysym\*(C'\fR resource in the @@RXVT_NAME@@(1) manpage.
1101.ie n .IP "$rend\fR = \f(CW$term\->rstyle ([$new_rstyle])" 4 1108.ie n .IP "$rend = $term\->rstyle ([$new_rstyle])" 4
1102.el .IP "\f(CW$rend\fR = \f(CW$term\fR\->rstyle ([$new_rstyle])" 4 1109.el .IP "\f(CW$rend\fR = \f(CW$term\fR\->rstyle ([$new_rstyle])" 4
1103.IX Item "$rend = $term->rstyle ([$new_rstyle])" 1110.IX Item "$rend = $term->rstyle ([$new_rstyle])"
1104Return and optionally change the current rendition. Text that is output by 1111Return and optionally change the current rendition. Text that is output by
1105the terminal application will use this style. 1112the terminal application will use this style.
1106.ie n .IP "($row, $col\fR) = \f(CW$term\fR\->screen_cur ([$row, \f(CW$col])" 4 1113.ie n .IP "($row, $col) = $term\->screen_cur ([$row, $col])" 4
1107.el .IP "($row, \f(CW$col\fR) = \f(CW$term\fR\->screen_cur ([$row, \f(CW$col\fR])" 4 1114.el .IP "($row, \f(CW$col\fR) = \f(CW$term\fR\->screen_cur ([$row, \f(CW$col\fR])" 4
1108.IX Item "($row, $col) = $term->screen_cur ([$row, $col])" 1115.IX Item "($row, $col) = $term->screen_cur ([$row, $col])"
1109Return the current coordinates of the text cursor position and optionally 1116Return the current coordinates of the text cursor position and optionally
1110set it (which is usually bad as applications don't expect that). 1117set it (which is usually bad as applications don't expect that).
1111.ie n .IP "($row, $col\fR) = \f(CW$term\fR\->selection_mark ([$row, \f(CW$col])" 4 1118.ie n .IP "($row, $col) = $term\->selection_mark ([$row, $col])" 4
1112.el .IP "($row, \f(CW$col\fR) = \f(CW$term\fR\->selection_mark ([$row, \f(CW$col\fR])" 4 1119.el .IP "($row, \f(CW$col\fR) = \f(CW$term\fR\->selection_mark ([$row, \f(CW$col\fR])" 4
1113.IX Item "($row, $col) = $term->selection_mark ([$row, $col])" 1120.IX Item "($row, $col) = $term->selection_mark ([$row, $col])"
1114.PD 0 1121.PD 0
1115.ie n .IP "($row, $col\fR) = \f(CW$term\fR\->selection_beg ([$row, \f(CW$col])" 4 1122.ie n .IP "($row, $col) = $term\->selection_beg ([$row, $col])" 4
1116.el .IP "($row, \f(CW$col\fR) = \f(CW$term\fR\->selection_beg ([$row, \f(CW$col\fR])" 4 1123.el .IP "($row, \f(CW$col\fR) = \f(CW$term\fR\->selection_beg ([$row, \f(CW$col\fR])" 4
1117.IX Item "($row, $col) = $term->selection_beg ([$row, $col])" 1124.IX Item "($row, $col) = $term->selection_beg ([$row, $col])"
1118.ie n .IP "($row, $col\fR) = \f(CW$term\fR\->selection_end ([$row, \f(CW$col])" 4 1125.ie n .IP "($row, $col) = $term\->selection_end ([$row, $col])" 4
1119.el .IP "($row, \f(CW$col\fR) = \f(CW$term\fR\->selection_end ([$row, \f(CW$col\fR])" 4 1126.el .IP "($row, \f(CW$col\fR) = \f(CW$term\fR\->selection_end ([$row, \f(CW$col\fR])" 4
1120.IX Item "($row, $col) = $term->selection_end ([$row, $col])" 1127.IX Item "($row, $col) = $term->selection_end ([$row, $col])"
1121.PD 1128.PD
1122Return the current values of the selection mark, begin or end positions, 1129Return the current values of the selection mark, begin or end positions.
1123and optionally set them to new values. 1130.Sp
1131When arguments are given, then the selection coordinates are set to
1132\&\f(CW$row\fR and \f(CW$col\fR, and the selection screen is set to the current
1133screen.
1134.ie n .IP "$screen = $term\->selection_screen ([$screen])" 4
1135.el .IP "\f(CW$screen\fR = \f(CW$term\fR\->selection_screen ([$screen])" 4
1136.IX Item "$screen = $term->selection_screen ([$screen])"
1137Returns the current selection screen, and then optionally sets it.
1124.ie n .IP "$term\fR\->selection_make ($eventtime[, \f(CW$rectangular])" 4 1138.ie n .IP "$term\->selection_make ($eventtime[, $rectangular])" 4
1125.el .IP "\f(CW$term\fR\->selection_make ($eventtime[, \f(CW$rectangular\fR])" 4 1139.el .IP "\f(CW$term\fR\->selection_make ($eventtime[, \f(CW$rectangular\fR])" 4
1126.IX Item "$term->selection_make ($eventtime[, $rectangular])" 1140.IX Item "$term->selection_make ($eventtime[, $rectangular])"
1127Tries to make a selection as set by \f(CW\*(C`selection_beg\*(C'\fR and 1141Tries to make a selection as set by \f(CW\*(C`selection_beg\*(C'\fR and
1128\&\f(CW\*(C`selection_end\*(C'\fR. If \f(CW$rectangular\fR is true (default: false), a 1142\&\f(CW\*(C`selection_end\*(C'\fR. If \f(CW$rectangular\fR is true (default: false), a
1129rectangular selection will be made. This is the prefered function to make 1143rectangular selection will be made. This is the prefered function to make
1130a selection. 1144a selection.
1131.ie n .IP "$success\fR = \f(CW$term\->selection_grab ($eventtime)" 4 1145.ie n .IP "$success = $term\->selection_grab ($eventtime)" 4
1132.el .IP "\f(CW$success\fR = \f(CW$term\fR\->selection_grab ($eventtime)" 4 1146.el .IP "\f(CW$success\fR = \f(CW$term\fR\->selection_grab ($eventtime)" 4
1133.IX Item "$success = $term->selection_grab ($eventtime)" 1147.IX Item "$success = $term->selection_grab ($eventtime)"
1134Try to request the primary selection text from the server (for example, as 1148Try to request the primary selection text from the server (for example, as
1135set by the next method). No visual feedback will be given. This function 1149set by the next method). No visual feedback will be given. This function
1136is mostly useful from within \f(CW\*(C`on_sel_grab\*(C'\fR hooks. 1150is mostly useful from within \f(CW\*(C`on_sel_grab\*(C'\fR hooks.
1137.ie n .IP "$oldtext\fR = \f(CW$term\->selection ([$newtext])" 4 1151.ie n .IP "$oldtext = $term\->selection ([$newtext])" 4
1138.el .IP "\f(CW$oldtext\fR = \f(CW$term\fR\->selection ([$newtext])" 4 1152.el .IP "\f(CW$oldtext\fR = \f(CW$term\fR\->selection ([$newtext])" 4
1139.IX Item "$oldtext = $term->selection ([$newtext])" 1153.IX Item "$oldtext = $term->selection ([$newtext])"
1140Return the current selection text and optionally replace it by \f(CW$newtext\fR. 1154Return the current selection text and optionally replace it by \f(CW$newtext\fR.
1141.ie n .IP "$term\fR\->overlay_simple ($x, \f(CW$y\fR, \f(CW$text)" 4 1155.ie n .IP "$term\->overlay_simple ($x, $y, $text)" 4
1142.el .IP "\f(CW$term\fR\->overlay_simple ($x, \f(CW$y\fR, \f(CW$text\fR)" 4 1156.el .IP "\f(CW$term\fR\->overlay_simple ($x, \f(CW$y\fR, \f(CW$text\fR)" 4
1143.IX Item "$term->overlay_simple ($x, $y, $text)" 1157.IX Item "$term->overlay_simple ($x, $y, $text)"
1144Create a simple multi-line overlay box. See the next method for details. 1158Create a simple multi-line overlay box. See the next method for details.
1145.ie n .IP "$term\fR\->overlay ($x, \f(CW$y\fR, \f(CW$width\fR, \f(CW$height\fR[, \f(CW$rstyle\fR[, \f(CW$border]])" 4 1159.ie n .IP "$term\->overlay ($x, $y, $width, $height[, $rstyle[, $border]])" 4
1146.el .IP "\f(CW$term\fR\->overlay ($x, \f(CW$y\fR, \f(CW$width\fR, \f(CW$height\fR[, \f(CW$rstyle\fR[, \f(CW$border\fR]])" 4 1160.el .IP "\f(CW$term\fR\->overlay ($x, \f(CW$y\fR, \f(CW$width\fR, \f(CW$height\fR[, \f(CW$rstyle\fR[, \f(CW$border\fR]])" 4
1147.IX Item "$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])" 1161.IX Item "$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])"
1148Create a new (empty) overlay at the given position with the given 1162Create a new (empty) overlay at the given position with the given
1149width/height. \f(CW$rstyle\fR defines the initial rendition style 1163width/height. \f(CW$rstyle\fR defines the initial rendition style
1150(default: \f(CW\*(C`OVERLAY_RSTYLE\*(C'\fR). 1164(default: \f(CW\*(C`OVERLAY_RSTYLE\*(C'\fR).
… …
1158This method returns an urxvt::overlay object. The overlay will be visible 1172This method returns an urxvt::overlay object. The overlay will be visible
1159as long as the perl object is referenced. 1173as long as the perl object is referenced.
1160.Sp 1174.Sp
1161The methods currently supported on \f(CW\*(C`urxvt::overlay\*(C'\fR objects are: 1175The methods currently supported on \f(CW\*(C`urxvt::overlay\*(C'\fR objects are:
1162.RS 4 1176.RS 4
1163.ie n .IP "$overlay\fR\->set ($x, \f(CW$y\fR, \f(CW$text\fR[, \f(CW$rend])" 4 1177.ie n .IP "$overlay\->set ($x, $y, $text[, $rend])" 4
1164.el .IP "\f(CW$overlay\fR\->set ($x, \f(CW$y\fR, \f(CW$text\fR[, \f(CW$rend\fR])" 4 1178.el .IP "\f(CW$overlay\fR\->set ($x, \f(CW$y\fR, \f(CW$text\fR[, \f(CW$rend\fR])" 4
1165.IX Item "$overlay->set ($x, $y, $text[, $rend])" 1179.IX Item "$overlay->set ($x, $y, $text[, $rend])"
1166Similar to \f(CW\*(C`$term\->ROW_t\*(C'\fR and \f(CW\*(C`$term\->ROW_r\*(C'\fR in that it puts 1180Similar to \f(CW\*(C`$term\->ROW_t\*(C'\fR and \f(CW\*(C`$term\->ROW_r\*(C'\fR in that it puts
1167text in rxvt-unicode's special encoding and an array of rendition values 1181text in rxvt-unicode's special encoding and an array of rendition values
1168at a specific position inside the overlay. 1182at a specific position inside the overlay.
… …
1177.IX Item "$overlay->show" 1191.IX Item "$overlay->show"
1178If hidden, display the overlay again. 1192If hidden, display the overlay again.
1179.RE 1193.RE
1180.RS 4 1194.RS 4
1181.RE 1195.RE
1182.ie n .IP "$popup\fR = \f(CW$term\->popup ($event)" 4 1196.ie n .IP "$popup = $term\->popup ($event)" 4
1183.el .IP "\f(CW$popup\fR = \f(CW$term\fR\->popup ($event)" 4 1197.el .IP "\f(CW$popup\fR = \f(CW$term\fR\->popup ($event)" 4
1184.IX Item "$popup = $term->popup ($event)" 1198.IX Item "$popup = $term->popup ($event)"
1185Creates a new \f(CW\*(C`urxvt::popup\*(C'\fR object that implements a popup menu. The 1199Creates a new \f(CW\*(C`urxvt::popup\*(C'\fR object that implements a popup menu. The
1186\&\f(CW$event\fR \fImust\fR be the event causing the menu to pop up (a button event, 1200\&\f(CW$event\fR \fImust\fR be the event causing the menu to pop up (a button event,
1187currently). 1201currently).
1188.ie n .IP "$cellwidth\fR = \f(CW$term\->strwidth ($string)" 4 1202.ie n .IP "$cellwidth = $term\->strwidth ($string)" 4
1189.el .IP "\f(CW$cellwidth\fR = \f(CW$term\fR\->strwidth ($string)" 4 1203.el .IP "\f(CW$cellwidth\fR = \f(CW$term\fR\->strwidth ($string)" 4
1190.IX Item "$cellwidth = $term->strwidth ($string)" 1204.IX Item "$cellwidth = $term->strwidth ($string)"
1191Returns the number of screen-cells this string would need. Correctly 1205Returns the number of screen-cells this string would need. Correctly
1192accounts for wide and combining characters. 1206accounts for wide and combining characters.
1193.ie n .IP "$octets\fR = \f(CW$term\->locale_encode ($string)" 4 1207.ie n .IP "$octets = $term\->locale_encode ($string)" 4
1194.el .IP "\f(CW$octets\fR = \f(CW$term\fR\->locale_encode ($string)" 4 1208.el .IP "\f(CW$octets\fR = \f(CW$term\fR\->locale_encode ($string)" 4
1195.IX Item "$octets = $term->locale_encode ($string)" 1209.IX Item "$octets = $term->locale_encode ($string)"
1196Convert the given text string into the corresponding locale encoding. 1210Convert the given text string into the corresponding locale encoding.
1197.ie n .IP "$string\fR = \f(CW$term\->locale_decode ($octets)" 4 1211.ie n .IP "$string = $term\->locale_decode ($octets)" 4
1198.el .IP "\f(CW$string\fR = \f(CW$term\fR\->locale_decode ($octets)" 4 1212.el .IP "\f(CW$string\fR = \f(CW$term\fR\->locale_decode ($octets)" 4
1199.IX Item "$string = $term->locale_decode ($octets)" 1213.IX Item "$string = $term->locale_decode ($octets)"
1200Convert the given locale-encoded octets into a perl string. 1214Convert the given locale-encoded octets into a perl string.
1201.ie n .IP "$term\fR\->scr_xor_span ($beg_row, \f(CW$beg_col\fR, \f(CW$end_row\fR, \f(CW$end_col\fR[, \f(CW$rstyle])" 4 1215.ie n .IP "$term\->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])" 4
1202.el .IP "\f(CW$term\fR\->scr_xor_span ($beg_row, \f(CW$beg_col\fR, \f(CW$end_row\fR, \f(CW$end_col\fR[, \f(CW$rstyle\fR])" 4 1216.el .IP "\f(CW$term\fR\->scr_xor_span ($beg_row, \f(CW$beg_col\fR, \f(CW$end_row\fR, \f(CW$end_col\fR[, \f(CW$rstyle\fR])" 4
1203.IX Item "$term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])" 1217.IX Item "$term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])"
1204XORs the rendition values in the given span with the provided value 1218XORs the rendition values in the given span with the provided value
1205(default: \f(CW\*(C`RS_RVid\*(C'\fR), which \fI\s-1MUST\s0 \s-1NOT\s0\fR contain font styles. Useful in 1219(default: \f(CW\*(C`RS_RVid\*(C'\fR), which \fI\s-1MUST\s0 \s-1NOT\s0\fR contain font styles. Useful in
1206refresh hooks to provide effects similar to the selection. 1220refresh hooks to provide effects similar to the selection.
1207.ie n .IP "$term\fR\->scr_xor_rect ($beg_row, \f(CW$beg_col\fR, \f(CW$end_row\fR, \f(CW$end_col\fR[, \f(CW$rstyle1\fR[, \f(CW$rstyle2]])" 4 1221.ie n .IP "$term\->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])" 4
1208.el .IP "\f(CW$term\fR\->scr_xor_rect ($beg_row, \f(CW$beg_col\fR, \f(CW$end_row\fR, \f(CW$end_col\fR[, \f(CW$rstyle1\fR[, \f(CW$rstyle2\fR]])" 4 1222.el .IP "\f(CW$term\fR\->scr_xor_rect ($beg_row, \f(CW$beg_col\fR, \f(CW$end_row\fR, \f(CW$end_col\fR[, \f(CW$rstyle1\fR[, \f(CW$rstyle2\fR]])" 4
1209.IX Item "$term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])" 1223.IX Item "$term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])"
1210Similar to \f(CW\*(C`scr_xor_span\*(C'\fR, but xors a rectangle instead. Trailing 1224Similar to \f(CW\*(C`scr_xor_span\*(C'\fR, but xors a rectangle instead. Trailing
1211whitespace will additionally be xored with the \f(CW$rstyle2\fR, which defaults 1225whitespace will additionally be xored with the \f(CW$rstyle2\fR, which defaults
1212to \f(CW\*(C`RS_RVid | RS_Uline\*(C'\fR, which removes reverse video again and underlines 1226to \f(CW\*(C`RS_RVid | RS_Uline\*(C'\fR, which removes reverse video again and underlines
… …
1240.el .IP "\f(CW$term\fR\->tt_write ($octets)" 4 1254.el .IP "\f(CW$term\fR\->tt_write ($octets)" 4
1241.IX Item "$term->tt_write ($octets)" 1255.IX Item "$term->tt_write ($octets)"
1242Write the octets given in \f(CW$data\fR to the tty (i.e. as program input). To 1256Write the octets given in \f(CW$data\fR to the tty (i.e. as program input). To
1243pass characters instead of octets, you should convert your strings first 1257pass characters instead of octets, you should convert your strings first
1244to the locale-specific encoding using \f(CW\*(C`$term\->locale_encode\*(C'\fR. 1258to the locale-specific encoding using \f(CW\*(C`$term\->locale_encode\*(C'\fR.
1245.ie n .IP "$old_events\fR = \f(CW$term\->pty_ev_events ([$new_events])" 4 1259.ie n .IP "$old_events = $term\->pty_ev_events ([$new_events])" 4
1246.el .IP "\f(CW$old_events\fR = \f(CW$term\fR\->pty_ev_events ([$new_events])" 4 1260.el .IP "\f(CW$old_events\fR = \f(CW$term\fR\->pty_ev_events ([$new_events])" 4
1247.IX Item "$old_events = $term->pty_ev_events ([$new_events])" 1261.IX Item "$old_events = $term->pty_ev_events ([$new_events])"
1248Replaces the event mask of the pty watcher by the given event mask. Can 1262Replaces the event mask of the pty watcher by the given event mask. Can
1249be used to suppress input and output handling to the pty/tty. See the 1263be used to suppress input and output handling to the pty/tty. See the
1250description of \f(CW\*(C`urxvt::timer\->events\*(C'\fR. Make sure to always restore 1264description of \f(CW\*(C`urxvt::timer\->events\*(C'\fR. Make sure to always restore
1251the previous value. 1265the previous value.
1252.ie n .IP "$fd\fR = \f(CW$term\->pty_fd" 4 1266.ie n .IP "$fd = $term\->pty_fd" 4
1253.el .IP "\f(CW$fd\fR = \f(CW$term\fR\->pty_fd" 4 1267.el .IP "\f(CW$fd\fR = \f(CW$term\fR\->pty_fd" 4
1254.IX Item "$fd = $term->pty_fd" 1268.IX Item "$fd = $term->pty_fd"
1255Returns the master file descriptor for the pty in use, or \f(CW\*(C`\-1\*(C'\fR if no pty 1269Returns the master file descriptor for the pty in use, or \f(CW\*(C`\-1\*(C'\fR if no pty
1256is used. 1270is used.
1257.ie n .IP "$windowid\fR = \f(CW$term\->parent" 4 1271.ie n .IP "$windowid = $term\->parent" 4
1258.el .IP "\f(CW$windowid\fR = \f(CW$term\fR\->parent" 4 1272.el .IP "\f(CW$windowid\fR = \f(CW$term\fR\->parent" 4
1259.IX Item "$windowid = $term->parent" 1273.IX Item "$windowid = $term->parent"
1260Return the window id of the toplevel window. 1274Return the window id of the toplevel window.
1261.ie n .IP "$windowid\fR = \f(CW$term\->vt" 4 1275.ie n .IP "$windowid = $term\->vt" 4
1262.el .IP "\f(CW$windowid\fR = \f(CW$term\fR\->vt" 4 1276.el .IP "\f(CW$windowid\fR = \f(CW$term\fR\->vt" 4
1263.IX Item "$windowid = $term->vt" 1277.IX Item "$windowid = $term->vt"
1264Return the window id of the terminal window. 1278Return the window id of the terminal window.
1265.ie n .IP "$term\->vt_emask_add ($x_event_mask)" 4 1279.ie n .IP "$term\->vt_emask_add ($x_event_mask)" 4
1266.el .IP "\f(CW$term\fR\->vt_emask_add ($x_event_mask)" 4 1280.el .IP "\f(CW$term\fR\->vt_emask_add ($x_event_mask)" 4
… …
1276.IX Item "$term->focus_in" 1290.IX Item "$term->focus_in"
1277.PD 0 1291.PD 0
1278.ie n .IP "$term\->focus_out" 4 1292.ie n .IP "$term\->focus_out" 4
1279.el .IP "\f(CW$term\fR\->focus_out" 4 1293.el .IP "\f(CW$term\fR\->focus_out" 4
1280.IX Item "$term->focus_out" 1294.IX Item "$term->focus_out"
1281.ie n .IP "$term\fR\->key_press ($state, \f(CW$keycode\fR[, \f(CW$time])" 4 1295.ie n .IP "$term\->key_press ($state, $keycode[, $time])" 4
1282.el .IP "\f(CW$term\fR\->key_press ($state, \f(CW$keycode\fR[, \f(CW$time\fR])" 4 1296.el .IP "\f(CW$term\fR\->key_press ($state, \f(CW$keycode\fR[, \f(CW$time\fR])" 4
1283.IX Item "$term->key_press ($state, $keycode[, $time])" 1297.IX Item "$term->key_press ($state, $keycode[, $time])"
1284.ie n .IP "$term\fR\->key_release ($state, \f(CW$keycode\fR[, \f(CW$time])" 4 1298.ie n .IP "$term\->key_release ($state, $keycode[, $time])" 4
1285.el .IP "\f(CW$term\fR\->key_release ($state, \f(CW$keycode\fR[, \f(CW$time\fR])" 4 1299.el .IP "\f(CW$term\fR\->key_release ($state, \f(CW$keycode\fR[, \f(CW$time\fR])" 4
1286.IX Item "$term->key_release ($state, $keycode[, $time])" 1300.IX Item "$term->key_release ($state, $keycode[, $time])"
1287.PD 1301.PD
1288Deliver various fake events to to terminal. 1302Deliver various fake events to to terminal.
1289.ie n .IP "$window_width\fR = \f(CW$term\->width" 4 1303.ie n .IP "$window_width = $term\->width" 4
1290.el .IP "\f(CW$window_width\fR = \f(CW$term\fR\->width" 4 1304.el .IP "\f(CW$window_width\fR = \f(CW$term\fR\->width" 4
1291.IX Item "$window_width = $term->width" 1305.IX Item "$window_width = $term->width"
1292.PD 0 1306.PD 0
1293.ie n .IP "$window_height\fR = \f(CW$term\->height" 4 1307.ie n .IP "$window_height = $term\->height" 4
1294.el .IP "\f(CW$window_height\fR = \f(CW$term\fR\->height" 4 1308.el .IP "\f(CW$window_height\fR = \f(CW$term\fR\->height" 4
1295.IX Item "$window_height = $term->height" 1309.IX Item "$window_height = $term->height"
1296.ie n .IP "$font_width\fR = \f(CW$term\->fwidth" 4 1310.ie n .IP "$font_width = $term\->fwidth" 4
1297.el .IP "\f(CW$font_width\fR = \f(CW$term\fR\->fwidth" 4 1311.el .IP "\f(CW$font_width\fR = \f(CW$term\fR\->fwidth" 4
1298.IX Item "$font_width = $term->fwidth" 1312.IX Item "$font_width = $term->fwidth"
1299.ie n .IP "$font_height\fR = \f(CW$term\->fheight" 4 1313.ie n .IP "$font_height = $term\->fheight" 4
1300.el .IP "\f(CW$font_height\fR = \f(CW$term\fR\->fheight" 4 1314.el .IP "\f(CW$font_height\fR = \f(CW$term\fR\->fheight" 4
1301.IX Item "$font_height = $term->fheight" 1315.IX Item "$font_height = $term->fheight"
1302.ie n .IP "$font_ascent\fR = \f(CW$term\->fbase" 4 1316.ie n .IP "$font_ascent = $term\->fbase" 4
1303.el .IP "\f(CW$font_ascent\fR = \f(CW$term\fR\->fbase" 4 1317.el .IP "\f(CW$font_ascent\fR = \f(CW$term\fR\->fbase" 4
1304.IX Item "$font_ascent = $term->fbase" 1318.IX Item "$font_ascent = $term->fbase"
1305.ie n .IP "$terminal_rows\fR = \f(CW$term\->nrow" 4 1319.ie n .IP "$terminal_rows = $term\->nrow" 4
1306.el .IP "\f(CW$terminal_rows\fR = \f(CW$term\fR\->nrow" 4 1320.el .IP "\f(CW$terminal_rows\fR = \f(CW$term\fR\->nrow" 4
1307.IX Item "$terminal_rows = $term->nrow" 1321.IX Item "$terminal_rows = $term->nrow"
1308.ie n .IP "$terminal_columns\fR = \f(CW$term\->ncol" 4 1322.ie n .IP "$terminal_columns = $term\->ncol" 4
1309.el .IP "\f(CW$terminal_columns\fR = \f(CW$term\fR\->ncol" 4 1323.el .IP "\f(CW$terminal_columns\fR = \f(CW$term\fR\->ncol" 4
1310.IX Item "$terminal_columns = $term->ncol" 1324.IX Item "$terminal_columns = $term->ncol"
1311.ie n .IP "$has_focus\fR = \f(CW$term\->focus" 4 1325.ie n .IP "$has_focus = $term\->focus" 4
1312.el .IP "\f(CW$has_focus\fR = \f(CW$term\fR\->focus" 4 1326.el .IP "\f(CW$has_focus\fR = \f(CW$term\fR\->focus" 4
1313.IX Item "$has_focus = $term->focus" 1327.IX Item "$has_focus = $term->focus"
1314.ie n .IP "$is_mapped\fR = \f(CW$term\->mapped" 4 1328.ie n .IP "$is_mapped = $term\->mapped" 4
1315.el .IP "\f(CW$is_mapped\fR = \f(CW$term\fR\->mapped" 4 1329.el .IP "\f(CW$is_mapped\fR = \f(CW$term\fR\->mapped" 4
1316.IX Item "$is_mapped = $term->mapped" 1330.IX Item "$is_mapped = $term->mapped"
1317.ie n .IP "$max_scrollback\fR = \f(CW$term\->saveLines" 4 1331.ie n .IP "$max_scrollback = $term\->saveLines" 4
1318.el .IP "\f(CW$max_scrollback\fR = \f(CW$term\fR\->saveLines" 4 1332.el .IP "\f(CW$max_scrollback\fR = \f(CW$term\fR\->saveLines" 4
1319.IX Item "$max_scrollback = $term->saveLines" 1333.IX Item "$max_scrollback = $term->saveLines"
1320.ie n .IP "$nrow_plus_saveLines\fR = \f(CW$term\->total_rows" 4 1334.ie n .IP "$nrow_plus_saveLines = $term\->total_rows" 4
1321.el .IP "\f(CW$nrow_plus_saveLines\fR = \f(CW$term\fR\->total_rows" 4 1335.el .IP "\f(CW$nrow_plus_saveLines\fR = \f(CW$term\fR\->total_rows" 4
1322.IX Item "$nrow_plus_saveLines = $term->total_rows" 1336.IX Item "$nrow_plus_saveLines = $term->total_rows"
1323.ie n .IP "$topmost_scrollback_row\fR = \f(CW$term\->top_row" 4 1337.ie n .IP "$topmost_scrollback_row = $term\->top_row" 4
1324.el .IP "\f(CW$topmost_scrollback_row\fR = \f(CW$term\fR\->top_row" 4 1338.el .IP "\f(CW$topmost_scrollback_row\fR = \f(CW$term\fR\->top_row" 4
1325.IX Item "$topmost_scrollback_row = $term->top_row" 1339.IX Item "$topmost_scrollback_row = $term->top_row"
1326.PD 1340.PD
1327Return various integers describing terminal characteristics. 1341Return various integers describing terminal characteristics.
1328.ie n .IP "$x_display\fR = \f(CW$term\->display_id" 4 1342.ie n .IP "$x_display = $term\->display_id" 4
1329.el .IP "\f(CW$x_display\fR = \f(CW$term\fR\->display_id" 4 1343.el .IP "\f(CW$x_display\fR = \f(CW$term\fR\->display_id" 4
1330.IX Item "$x_display = $term->display_id" 1344.IX Item "$x_display = $term->display_id"
1331Return the \s-1DISPLAY\s0 used by rxvt-unicode. 1345Return the \s-1DISPLAY\s0 used by rxvt-unicode.
1332.ie n .IP "$lc_ctype\fR = \f(CW$term\->locale" 4 1346.ie n .IP "$lc_ctype = $term\->locale" 4
1333.el .IP "\f(CW$lc_ctype\fR = \f(CW$term\fR\->locale" 4 1347.el .IP "\f(CW$lc_ctype\fR = \f(CW$term\fR\->locale" 4
1334.IX Item "$lc_ctype = $term->locale" 1348.IX Item "$lc_ctype = $term->locale"
1335Returns the \s-1LC_CTYPE\s0 category string used by this rxvt-unicode. 1349Returns the \s-1LC_CTYPE\s0 category string used by this rxvt-unicode.
1336.ie n .IP "$env\fR = \f(CW$term\->env" 4 1350.ie n .IP "$env = $term\->env" 4
1337.el .IP "\f(CW$env\fR = \f(CW$term\fR\->env" 4 1351.el .IP "\f(CW$env\fR = \f(CW$term\fR\->env" 4
1338.IX Item "$env = $term->env" 1352.IX Item "$env = $term->env"
1339Returns a copy of the environment in effect for the terminal as a hashref 1353Returns a copy of the environment in effect for the terminal as a hashref
1340similar to \f(CW\*(C`\e%ENV\*(C'\fR. 1354similar to \f(CW\*(C`\e%ENV\*(C'\fR.
1341.ie n .IP "@envv\fR = \f(CW$term\->envv" 4 1355.ie n .IP "@envv = $term\->envv" 4
1342.el .IP "\f(CW@envv\fR = \f(CW$term\fR\->envv" 4 1356.el .IP "\f(CW@envv\fR = \f(CW$term\fR\->envv" 4
1343.IX Item "@envv = $term->envv" 1357.IX Item "@envv = $term->envv"
1344Returns the environment as array of strings of the form \f(CW\*(C`VAR=VALUE\*(C'\fR. 1358Returns the environment as array of strings of the form \f(CW\*(C`VAR=VALUE\*(C'\fR.
1345.ie n .IP "@argv\fR = \f(CW$term\->argv" 4 1359.ie n .IP "@argv = $term\->argv" 4
1346.el .IP "\f(CW@argv\fR = \f(CW$term\fR\->argv" 4 1360.el .IP "\f(CW@argv\fR = \f(CW$term\fR\->argv" 4
1347.IX Item "@argv = $term->argv" 1361.IX Item "@argv = $term->argv"
1348Return the argument vector as this terminal, similar to \f(CW@ARGV\fR, but 1362Return the argument vector as this terminal, similar to \f(CW@ARGV\fR, but
1349includes the program name as first element. 1363includes the program name as first element.
1350.ie n .IP "$modifiermask\fR = \f(CW$term\->ModLevel3Mask" 4 1364.ie n .IP "$modifiermask = $term\->ModLevel3Mask" 4
1351.el .IP "\f(CW$modifiermask\fR = \f(CW$term\fR\->ModLevel3Mask" 4 1365.el .IP "\f(CW$modifiermask\fR = \f(CW$term\fR\->ModLevel3Mask" 4
1352.IX Item "$modifiermask = $term->ModLevel3Mask" 1366.IX Item "$modifiermask = $term->ModLevel3Mask"
1353.PD 0 1367.PD 0
1354.ie n .IP "$modifiermask\fR = \f(CW$term\->ModMetaMask" 4 1368.ie n .IP "$modifiermask = $term\->ModMetaMask" 4
1355.el .IP "\f(CW$modifiermask\fR = \f(CW$term\fR\->ModMetaMask" 4 1369.el .IP "\f(CW$modifiermask\fR = \f(CW$term\fR\->ModMetaMask" 4
1356.IX Item "$modifiermask = $term->ModMetaMask" 1370.IX Item "$modifiermask = $term->ModMetaMask"
1357.ie n .IP "$modifiermask\fR = \f(CW$term\->ModNumLockMask" 4 1371.ie n .IP "$modifiermask = $term\->ModNumLockMask" 4
1358.el .IP "\f(CW$modifiermask\fR = \f(CW$term\fR\->ModNumLockMask" 4 1372.el .IP "\f(CW$modifiermask\fR = \f(CW$term\fR\->ModNumLockMask" 4
1359.IX Item "$modifiermask = $term->ModNumLockMask" 1373.IX Item "$modifiermask = $term->ModNumLockMask"
1360.PD 1374.PD
1361Return the modifier masks corresponding to the \*(L"\s-1ISO\s0 Level 3 Shift\*(R" (often 1375Return the modifier masks corresponding to the \*(L"\s-1ISO\s0 Level 3 Shift\*(R" (often
1362AltGr), the meta key (often Alt) and the num lock key, if applicable. 1376AltGr), the meta key (often Alt) and the num lock key, if applicable.
1363.ie n .IP "$screen\fR = \f(CW$term\->current_screen" 4 1377.ie n .IP "$screen = $term\->current_screen" 4
1364.el .IP "\f(CW$screen\fR = \f(CW$term\fR\->current_screen" 4 1378.el .IP "\f(CW$screen\fR = \f(CW$term\fR\->current_screen" 4
1365.IX Item "$screen = $term->current_screen" 1379.IX Item "$screen = $term->current_screen"
1366Returns the currently displayed screen (0 primary, 1 secondary). 1380Returns the currently displayed screen (0 primary, 1 secondary).
1367.ie n .IP "$cursor_is_hidden\fR = \f(CW$term\->hidden_cursor" 4 1381.ie n .IP "$cursor_is_hidden = $term\->hidden_cursor" 4
1368.el .IP "\f(CW$cursor_is_hidden\fR = \f(CW$term\fR\->hidden_cursor" 4 1382.el .IP "\f(CW$cursor_is_hidden\fR = \f(CW$term\fR\->hidden_cursor" 4
1369.IX Item "$cursor_is_hidden = $term->hidden_cursor" 1383.IX Item "$cursor_is_hidden = $term->hidden_cursor"
1370Returns whether the cursor is currently hidden or not. 1384Returns whether the cursor is currently hidden or not.
1371.ie n .IP "$view_start\fR = \f(CW$term\->view_start ([$newvalue])" 4 1385.ie n .IP "$view_start = $term\->view_start ([$newvalue])" 4
1372.el .IP "\f(CW$view_start\fR = \f(CW$term\fR\->view_start ([$newvalue])" 4 1386.el .IP "\f(CW$view_start\fR = \f(CW$term\fR\->view_start ([$newvalue])" 4
1373.IX Item "$view_start = $term->view_start ([$newvalue])" 1387.IX Item "$view_start = $term->view_start ([$newvalue])"
1374Returns the row number of the topmost displayed line. Maximum value is 1388Returns the row number of the topmost displayed line. Maximum value is
1375\&\f(CW0\fR, which displays the normal terminal contents. Lower values scroll 1389\&\f(CW0\fR, which displays the normal terminal contents. Lower values scroll
1376this many lines into the scrollback buffer. 1390this many lines into the scrollback buffer.
… …
1380Requests a screen refresh. At the next opportunity, rxvt-unicode will 1394Requests a screen refresh. At the next opportunity, rxvt-unicode will
1381compare the on-screen display with its stored representation. If they 1395compare the on-screen display with its stored representation. If they
1382differ, it redraws the differences. 1396differ, it redraws the differences.
1383.Sp 1397.Sp
1384Used after changing terminal contents to display them. 1398Used after changing terminal contents to display them.
1385.ie n .IP "$text\fR = \f(CW$term\fR\->ROW_t ($row_number[, \f(CW$new_text\fR[, \f(CW$start_col]])" 4 1399.ie n .IP "$text = $term\->ROW_t ($row_number[, $new_text[, $start_col]])" 4
1386.el .IP "\f(CW$text\fR = \f(CW$term\fR\->ROW_t ($row_number[, \f(CW$new_text\fR[, \f(CW$start_col\fR]])" 4 1400.el .IP "\f(CW$text\fR = \f(CW$term\fR\->ROW_t ($row_number[, \f(CW$new_text\fR[, \f(CW$start_col\fR]])" 4
1387.IX Item "$text = $term->ROW_t ($row_number[, $new_text[, $start_col]])" 1401.IX Item "$text = $term->ROW_t ($row_number[, $new_text[, $start_col]])"
1388Returns the text of the entire row with number \f(CW$row_number\fR. Row \f(CW\*(C`$term\->top_row\*(C'\fR 1402Returns the text of the entire row with number \f(CW$row_number\fR. Row \f(CW\*(C`$term\->top_row\*(C'\fR
1389is the topmost terminal line, row \f(CW\*(C`$term\->nrow\-1\*(C'\fR is the bottommost 1403is the topmost terminal line, row \f(CW\*(C`$term\->nrow\-1\*(C'\fR is the bottommost
1390terminal line. Nothing will be returned if a nonexistent line 1404terminal line. Nothing will be returned if a nonexistent line
… …
1405that \f(CW\*(C`substr\*(C'\fR and similar functions work on screen cells and not on 1419that \f(CW\*(C`substr\*(C'\fR and similar functions work on screen cells and not on
1406characters. 1420characters.
1407.Sp 1421.Sp
1408The methods \f(CW\*(C`$term\->special_encode\*(C'\fR and \f(CW\*(C`$term\->special_decode\*(C'\fR 1422The methods \f(CW\*(C`$term\->special_encode\*(C'\fR and \f(CW\*(C`$term\->special_decode\*(C'\fR
1409can be used to convert normal strings into this encoding and vice versa. 1423can be used to convert normal strings into this encoding and vice versa.
1410.ie n .IP "$rend\fR = \f(CW$term\fR\->ROW_r ($row_number[, \f(CW$new_rend\fR[, \f(CW$start_col]])" 4 1424.ie n .IP "$rend = $term\->ROW_r ($row_number[, $new_rend[, $start_col]])" 4
1411.el .IP "\f(CW$rend\fR = \f(CW$term\fR\->ROW_r ($row_number[, \f(CW$new_rend\fR[, \f(CW$start_col\fR]])" 4 1425.el .IP "\f(CW$rend\fR = \f(CW$term\fR\->ROW_r ($row_number[, \f(CW$new_rend\fR[, \f(CW$start_col\fR]])" 4
1412.IX Item "$rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])" 1426.IX Item "$rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])"
1413Like \f(CW\*(C`$term\->ROW_t\*(C'\fR, but returns an arrayref with rendition 1427Like \f(CW\*(C`$term\->ROW_t\*(C'\fR, but returns an arrayref with rendition
1414bitsets. Rendition bitsets contain information about colour, font, font 1428bitsets. Rendition bitsets contain information about colour, font, font
1415styles and similar information. See also \f(CW\*(C`$term\->ROW_t\*(C'\fR. 1429styles and similar information. See also \f(CW\*(C`$term\->ROW_t\*(C'\fR.
1416.Sp 1430.Sp
1417When setting rendition, the font mask will be ignored. 1431When setting rendition, the font mask will be ignored.
1418.Sp 1432.Sp
1419See the section on \s-1RENDITION\s0, above. 1433See the section on \s-1RENDITION\s0, above.
1420.ie n .IP "$length\fR = \f(CW$term\fR\->ROW_l ($row_number[, \f(CW$new_length])" 4 1434.ie n .IP "$length = $term\->ROW_l ($row_number[, $new_length])" 4
1421.el .IP "\f(CW$length\fR = \f(CW$term\fR\->ROW_l ($row_number[, \f(CW$new_length\fR])" 4 1435.el .IP "\f(CW$length\fR = \f(CW$term\fR\->ROW_l ($row_number[, \f(CW$new_length\fR])" 4
1422.IX Item "$length = $term->ROW_l ($row_number[, $new_length])" 1436.IX Item "$length = $term->ROW_l ($row_number[, $new_length])"
1423Returns the number of screen cells that are in use (\*(L"the line 1437Returns the number of screen cells that are in use (\*(L"the line
1424length\*(R"). Unlike the urxvt core, this returns \f(CW\*(C`$term\->ncol\*(C'\fR if the 1438length\*(R"). Unlike the urxvt core, this returns \f(CW\*(C`$term\->ncol\*(C'\fR if the
1425line is joined with the following one. 1439line is joined with the following one.
1426.ie n .IP "$bool\fR = \f(CW$term\->is_longer ($row_number)" 4 1440.ie n .IP "$bool = $term\->is_longer ($row_number)" 4
1427.el .IP "\f(CW$bool\fR = \f(CW$term\fR\->is_longer ($row_number)" 4 1441.el .IP "\f(CW$bool\fR = \f(CW$term\fR\->is_longer ($row_number)" 4
1428.IX Item "$bool = $term->is_longer ($row_number)" 1442.IX Item "$bool = $term->is_longer ($row_number)"
1429Returns true if the row is part of a multiple-row logical \*(L"line\*(R" (i.e. 1443Returns true if the row is part of a multiple-row logical \*(L"line\*(R" (i.e.
1430joined with the following row), which means all characters are in use 1444joined with the following row), which means all characters are in use
1431and it is continued on the next row (and possibly a continuation of the 1445and it is continued on the next row (and possibly a continuation of the
1432previous row(s)). 1446previous row(s)).
1433.ie n .IP "$line\fR = \f(CW$term\->line ($row_number)" 4 1447.ie n .IP "$line = $term\->line ($row_number)" 4
1434.el .IP "\f(CW$line\fR = \f(CW$term\fR\->line ($row_number)" 4 1448.el .IP "\f(CW$line\fR = \f(CW$term\fR\->line ($row_number)" 4
1435.IX Item "$line = $term->line ($row_number)" 1449.IX Item "$line = $term->line ($row_number)"
1436Create and return a new \f(CW\*(C`urxvt::line\*(C'\fR object that stores information 1450Create and return a new \f(CW\*(C`urxvt::line\*(C'\fR object that stores information
1437about the logical line that row \f(CW$row_number\fR is part of. It supports the 1451about the logical line that row \f(CW$row_number\fR is part of. It supports the
1438following methods: 1452following methods:
1439.RS 4 1453.RS 4
1440.ie n .IP "$text\fR = \f(CW$line\->t ([$new_text])" 4 1454.ie n .IP "$text = $line\->t ([$new_text])" 4
1441.el .IP "\f(CW$text\fR = \f(CW$line\fR\->t ([$new_text])" 4 1455.el .IP "\f(CW$text\fR = \f(CW$line\fR\->t ([$new_text])" 4
1442.IX Item "$text = $line->t ([$new_text])" 1456.IX Item "$text = $line->t ([$new_text])"
1443Returns or replaces the full text of the line, similar to \f(CW\*(C`ROW_t\*(C'\fR 1457Returns or replaces the full text of the line, similar to \f(CW\*(C`ROW_t\*(C'\fR
1444.ie n .IP "$rend\fR = \f(CW$line\->r ([$new_rend])" 4 1458.ie n .IP "$rend = $line\->r ([$new_rend])" 4
1445.el .IP "\f(CW$rend\fR = \f(CW$line\fR\->r ([$new_rend])" 4 1459.el .IP "\f(CW$rend\fR = \f(CW$line\fR\->r ([$new_rend])" 4
1446.IX Item "$rend = $line->r ([$new_rend])" 1460.IX Item "$rend = $line->r ([$new_rend])"
1447Returns or replaces the full rendition array of the line, similar to \f(CW\*(C`ROW_r\*(C'\fR 1461Returns or replaces the full rendition array of the line, similar to \f(CW\*(C`ROW_r\*(C'\fR
1448.ie n .IP "$length\fR = \f(CW$line\->l" 4 1462.ie n .IP "$length = $line\->l" 4
1449.el .IP "\f(CW$length\fR = \f(CW$line\fR\->l" 4 1463.el .IP "\f(CW$length\fR = \f(CW$line\fR\->l" 4
1450.IX Item "$length = $line->l" 1464.IX Item "$length = $line->l"
1451Returns the length of the line in cells, similar to \f(CW\*(C`ROW_l\*(C'\fR. 1465Returns the length of the line in cells, similar to \f(CW\*(C`ROW_l\*(C'\fR.
1452.ie n .IP "$rownum\fR = \f(CW$line\->beg" 4 1466.ie n .IP "$rownum = $line\->beg" 4
1453.el .IP "\f(CW$rownum\fR = \f(CW$line\fR\->beg" 4 1467.el .IP "\f(CW$rownum\fR = \f(CW$line\fR\->beg" 4
1454.IX Item "$rownum = $line->beg" 1468.IX Item "$rownum = $line->beg"
1455.PD 0 1469.PD 0
1456.ie n .IP "$rownum\fR = \f(CW$line\->end" 4 1470.ie n .IP "$rownum = $line\->end" 4
1457.el .IP "\f(CW$rownum\fR = \f(CW$line\fR\->end" 4 1471.el .IP "\f(CW$rownum\fR = \f(CW$line\fR\->end" 4
1458.IX Item "$rownum = $line->end" 1472.IX Item "$rownum = $line->end"
1459.PD 1473.PD
1460Return the row number of the first/last row of the line, respectively. 1474Return the row number of the first/last row of the line, respectively.
1461.ie n .IP "$offset\fR = \f(CW$line\fR\->offset_of ($row, \f(CW$col)" 4 1475.ie n .IP "$offset = $line\->offset_of ($row, $col)" 4
1462.el .IP "\f(CW$offset\fR = \f(CW$line\fR\->offset_of ($row, \f(CW$col\fR)" 4 1476.el .IP "\f(CW$offset\fR = \f(CW$line\fR\->offset_of ($row, \f(CW$col\fR)" 4
1463.IX Item "$offset = $line->offset_of ($row, $col)" 1477.IX Item "$offset = $line->offset_of ($row, $col)"
1464Returns the character offset of the given row|col pair within the logical 1478Returns the character offset of the given row|col pair within the logical
1465line. Works for rows outside the line, too, and returns corresponding 1479line. Works for rows outside the line, too, and returns corresponding
1466offsets outside the string. 1480offsets outside the string.
1467.ie n .IP "($row, $col\fR) = \f(CW$line\->coord_of ($offset)" 4 1481.ie n .IP "($row, $col) = $line\->coord_of ($offset)" 4
1468.el .IP "($row, \f(CW$col\fR) = \f(CW$line\fR\->coord_of ($offset)" 4 1482.el .IP "($row, \f(CW$col\fR) = \f(CW$line\fR\->coord_of ($offset)" 4
1469.IX Item "($row, $col) = $line->coord_of ($offset)" 1483.IX Item "($row, $col) = $line->coord_of ($offset)"
1470Translates a string offset into terminal coordinates again. 1484Translates a string offset into terminal coordinates again.
1471.RE 1485.RE
1472.RS 4 1486.RS 4
1473.RE 1487.RE
1474.ie n .IP "$text\fR = \f(CW$term\fR\->special_encode \f(CW$string" 4 1488.ie n .IP "$text = $term\->special_encode $string" 4
1475.el .IP "\f(CW$text\fR = \f(CW$term\fR\->special_encode \f(CW$string\fR" 4 1489.el .IP "\f(CW$text\fR = \f(CW$term\fR\->special_encode \f(CW$string\fR" 4
1476.IX Item "$text = $term->special_encode $string" 1490.IX Item "$text = $term->special_encode $string"
1477Converts a perl string into the special encoding used by rxvt-unicode, 1491Converts a perl string into the special encoding used by rxvt-unicode,
1478where one character corresponds to one screen cell. See 1492where one character corresponds to one screen cell. See
1479\&\f(CW\*(C`$term\->ROW_t\*(C'\fR for details. 1493\&\f(CW\*(C`$term\->ROW_t\*(C'\fR for details.
1480.ie n .IP "$string\fR = \f(CW$term\fR\->special_decode \f(CW$text" 4 1494.ie n .IP "$string = $term\->special_decode $text" 4
1481.el .IP "\f(CW$string\fR = \f(CW$term\fR\->special_decode \f(CW$text\fR" 4 1495.el .IP "\f(CW$string\fR = \f(CW$term\fR\->special_decode \f(CW$text\fR" 4
1482.IX Item "$string = $term->special_decode $text" 1496.IX Item "$string = $term->special_decode $text"
1483Converts rxvt-unicodes text representation into a perl string. See 1497Converts rxvt-unicodes text representation into a perl string. See
1484\&\f(CW\*(C`$term\->ROW_t\*(C'\fR for details. 1498\&\f(CW\*(C`$term\->ROW_t\*(C'\fR for details.
1485.ie n .IP "$success\fR = \f(CW$term\fR\->grab_button ($button, \f(CW$modifiermask\fR[, \f(CW$window\fR = \f(CW$term\->vt])" 4 1499.ie n .IP "$success = $term\->grab_button ($button, $modifiermask[, $window = $term\->vt])" 4
1486.el .IP "\f(CW$success\fR = \f(CW$term\fR\->grab_button ($button, \f(CW$modifiermask\fR[, \f(CW$window\fR = \f(CW$term\fR\->vt])" 4 1500.el .IP "\f(CW$success\fR = \f(CW$term\fR\->grab_button ($button, \f(CW$modifiermask\fR[, \f(CW$window\fR = \f(CW$term\fR\->vt])" 4
1487.IX Item "$success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])" 1501.IX Item "$success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])"
1488.PD 0 1502.PD 0
1489.ie n .IP "$term\fR\->ungrab_button ($button, \f(CW$modifiermask\fR[, \f(CW$window\fR = \f(CW$term\->vt])" 4 1503.ie n .IP "$term\->ungrab_button ($button, $modifiermask[, $window = $term\->vt])" 4
1490.el .IP "\f(CW$term\fR\->ungrab_button ($button, \f(CW$modifiermask\fR[, \f(CW$window\fR = \f(CW$term\fR\->vt])" 4 1504.el .IP "\f(CW$term\fR\->ungrab_button ($button, \f(CW$modifiermask\fR[, \f(CW$window\fR = \f(CW$term\fR\->vt])" 4
1491.IX Item "$term->ungrab_button ($button, $modifiermask[, $window = $term->vt])" 1505.IX Item "$term->ungrab_button ($button, $modifiermask[, $window = $term->vt])"
1492.PD 1506.PD
1493Register/unregister a synchronous button grab. See the XGrabButton 1507Register/unregister a synchronous button grab. See the XGrabButton
1494manpage. 1508manpage.
1495.ie n .IP "$success\fR = \f(CW$term\fR\->grab ($eventtime[, \f(CW$sync])" 4 1509.ie n .IP "$success = $term\->grab ($eventtime[, $sync])" 4
1496.el .IP "\f(CW$success\fR = \f(CW$term\fR\->grab ($eventtime[, \f(CW$sync\fR])" 4 1510.el .IP "\f(CW$success\fR = \f(CW$term\fR\->grab ($eventtime[, \f(CW$sync\fR])" 4
1497.IX Item "$success = $term->grab ($eventtime[, $sync])" 1511.IX Item "$success = $term->grab ($eventtime[, $sync])"
1498Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or 1512Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1499synchronous (\f(CW$sync\fR is true). Also remembers the grab timestamp. 1513synchronous (\f(CW$sync\fR is true). Also remembers the grab timestamp.
1500.ie n .IP "$term\->allow_events_async" 4 1514.ie n .IP "$term\->allow_events_async" 4
… …
1514.el .IP "\f(CW$term\fR\->ungrab" 4 1528.el .IP "\f(CW$term\fR\->ungrab" 4
1515.IX Item "$term->ungrab" 1529.IX Item "$term->ungrab"
1516Calls XUngrab for the most recent grab. Is called automatically on 1530Calls XUngrab for the most recent grab. Is called automatically on
1517evaluation errors, as it is better to lose the grab in the error case as 1531evaluation errors, as it is better to lose the grab in the error case as
1518the session. 1532the session.
1519.ie n .IP "$atom\fR = \f(CW$term\fR\->XInternAtom ($atom_name[, \f(CW$only_if_exists])" 4 1533.ie n .IP "$atom = $term\->XInternAtom ($atom_name[, $only_if_exists])" 4
1520.el .IP "\f(CW$atom\fR = \f(CW$term\fR\->XInternAtom ($atom_name[, \f(CW$only_if_exists\fR])" 4 1534.el .IP "\f(CW$atom\fR = \f(CW$term\fR\->XInternAtom ($atom_name[, \f(CW$only_if_exists\fR])" 4
1521.IX Item "$atom = $term->XInternAtom ($atom_name[, $only_if_exists])" 1535.IX Item "$atom = $term->XInternAtom ($atom_name[, $only_if_exists])"
1522.PD 0 1536.PD 0
1523.ie n .IP "$atom_name\fR = \f(CW$term\->XGetAtomName ($atom)" 4 1537.ie n .IP "$atom_name = $term\->XGetAtomName ($atom)" 4
1524.el .IP "\f(CW$atom_name\fR = \f(CW$term\fR\->XGetAtomName ($atom)" 4 1538.el .IP "\f(CW$atom_name\fR = \f(CW$term\fR\->XGetAtomName ($atom)" 4
1525.IX Item "$atom_name = $term->XGetAtomName ($atom)" 1539.IX Item "$atom_name = $term->XGetAtomName ($atom)"
1526.ie n .IP "@atoms\fR = \f(CW$term\->XListProperties ($window)" 4 1540.ie n .IP "@atoms = $term\->XListProperties ($window)" 4
1527.el .IP "\f(CW@atoms\fR = \f(CW$term\fR\->XListProperties ($window)" 4 1541.el .IP "\f(CW@atoms\fR = \f(CW$term\fR\->XListProperties ($window)" 4
1528.IX Item "@atoms = $term->XListProperties ($window)" 1542.IX Item "@atoms = $term->XListProperties ($window)"
1529.ie n .IP "($type,$format,$octets) = $term\fR\->XGetWindowProperty ($window, \f(CW$property)" 4 1543.ie n .IP "($type,$format,$octets) = $term\->XGetWindowProperty ($window, $property)" 4
1530.el .IP "($type,$format,$octets) = \f(CW$term\fR\->XGetWindowProperty ($window, \f(CW$property\fR)" 4 1544.el .IP "($type,$format,$octets) = \f(CW$term\fR\->XGetWindowProperty ($window, \f(CW$property\fR)" 4
1531.IX Item "($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)" 1545.IX Item "($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)"
1532.ie n .IP "$term\fR\->XChangeProperty ($window, \f(CW$property\fR, \f(CW$type\fR, \f(CW$format\fR, \f(CW$octets)" 4 1546.ie n .IP "$term\->XChangeProperty ($window, $property, $type, $format, $octets)" 4
1533.el .IP "\f(CW$term\fR\->XChangeProperty ($window, \f(CW$property\fR, \f(CW$type\fR, \f(CW$format\fR, \f(CW$octets\fR)" 4 1547.el .IP "\f(CW$term\fR\->XChangeProperty ($window, \f(CW$property\fR, \f(CW$type\fR, \f(CW$format\fR, \f(CW$octets\fR)" 4
1534.IX Item "$term->XChangeProperty ($window, $property, $type, $format, $octets)" 1548.IX Item "$term->XChangeProperty ($window, $property, $type, $format, $octets)"
1535.ie n .IP "$term\fR\->XDeleteProperty ($window, \f(CW$property)" 4 1549.ie n .IP "$term\->XDeleteProperty ($window, $property)" 4
1536.el .IP "\f(CW$term\fR\->XDeleteProperty ($window, \f(CW$property\fR)" 4 1550.el .IP "\f(CW$term\fR\->XDeleteProperty ($window, \f(CW$property\fR)" 4
1537.IX Item "$term->XDeleteProperty ($window, $property)" 1551.IX Item "$term->XDeleteProperty ($window, $property)"
1538.ie n .IP "$window\fR = \f(CW$term\->DefaultRootWindow" 4 1552.ie n .IP "$window = $term\->DefaultRootWindow" 4
1539.el .IP "\f(CW$window\fR = \f(CW$term\fR\->DefaultRootWindow" 4 1553.el .IP "\f(CW$window\fR = \f(CW$term\fR\->DefaultRootWindow" 4
1540.IX Item "$window = $term->DefaultRootWindow" 1554.IX Item "$window = $term->DefaultRootWindow"
1541.ie n .IP "$term\fR\->XReparentWindow ($window, \f(CW$parent\fR, [$x, \f(CW$y])" 4 1555.ie n .IP "$term\->XReparentWindow ($window, $parent, [$x, $y])" 4
1542.el .IP "\f(CW$term\fR\->XReparentWindow ($window, \f(CW$parent\fR, [$x, \f(CW$y\fR])" 4 1556.el .IP "\f(CW$term\fR\->XReparentWindow ($window, \f(CW$parent\fR, [$x, \f(CW$y\fR])" 4
1543.IX Item "$term->XReparentWindow ($window, $parent, [$x, $y])" 1557.IX Item "$term->XReparentWindow ($window, $parent, [$x, $y])"
1544.ie n .IP "$term\->XMapWindow ($window)" 4 1558.ie n .IP "$term\->XMapWindow ($window)" 4
1545.el .IP "\f(CW$term\fR\->XMapWindow ($window)" 4 1559.el .IP "\f(CW$term\fR\->XMapWindow ($window)" 4
1546.IX Item "$term->XMapWindow ($window)" 1560.IX Item "$term->XMapWindow ($window)"
1547.ie n .IP "$term\->XUnmapWindow ($window)" 4 1561.ie n .IP "$term\->XUnmapWindow ($window)" 4
1548.el .IP "\f(CW$term\fR\->XUnmapWindow ($window)" 4 1562.el .IP "\f(CW$term\fR\->XUnmapWindow ($window)" 4
1549.IX Item "$term->XUnmapWindow ($window)" 1563.IX Item "$term->XUnmapWindow ($window)"
1550.ie n .IP "$term\fR\->XMoveResizeWindow ($window, \f(CW$x\fR, \f(CW$y\fR, \f(CW$width\fR, \f(CW$height)" 4 1564.ie n .IP "$term\->XMoveResizeWindow ($window, $x, $y, $width, $height)" 4
1551.el .IP "\f(CW$term\fR\->XMoveResizeWindow ($window, \f(CW$x\fR, \f(CW$y\fR, \f(CW$width\fR, \f(CW$height\fR)" 4 1565.el .IP "\f(CW$term\fR\->XMoveResizeWindow ($window, \f(CW$x\fR, \f(CW$y\fR, \f(CW$width\fR, \f(CW$height\fR)" 4
1552.IX Item "$term->XMoveResizeWindow ($window, $x, $y, $width, $height)" 1566.IX Item "$term->XMoveResizeWindow ($window, $x, $y, $width, $height)"
1553.ie n .IP "($x, $y\fR, \f(CW$child_window\fR) = \f(CW$term\fR\->XTranslateCoordinates ($src, \f(CW$dst\fR, \f(CW$x\fR, \f(CW$y)" 4 1567.ie n .IP "($x, $y, $child_window) = $term\->XTranslateCoordinates ($src, $dst, $x, $y)" 4
1554.el .IP "($x, \f(CW$y\fR, \f(CW$child_window\fR) = \f(CW$term\fR\->XTranslateCoordinates ($src, \f(CW$dst\fR, \f(CW$x\fR, \f(CW$y\fR)" 4 1568.el .IP "($x, \f(CW$y\fR, \f(CW$child_window\fR) = \f(CW$term\fR\->XTranslateCoordinates ($src, \f(CW$dst\fR, \f(CW$x\fR, \f(CW$y\fR)" 4
1555.IX Item "($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)" 1569.IX Item "($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)"
1556.ie n .IP "$term\fR\->XChangeInput ($window, \f(CW$add_events\fR[, \f(CW$del_events])" 4 1570.ie n .IP "$term\->XChangeInput ($window, $add_events[, $del_events])" 4
1557.el .IP "\f(CW$term\fR\->XChangeInput ($window, \f(CW$add_events\fR[, \f(CW$del_events\fR])" 4 1571.el .IP "\f(CW$term\fR\->XChangeInput ($window, \f(CW$add_events\fR[, \f(CW$del_events\fR])" 4
1558.IX Item "$term->XChangeInput ($window, $add_events[, $del_events])" 1572.IX Item "$term->XChangeInput ($window, $add_events[, $del_events])"
1559.PD 1573.PD
1560Various X or X\-related functions. The \f(CW$term\fR object only serves as 1574Various X or X\-related functions. The \f(CW$term\fR object only serves as
1561the source of the display, otherwise those functions map more-or-less 1575the source of the display, otherwise those functions map more-or-less
1562directory onto the X functions of the same name. 1576directory onto the X functions of the same name.
1563.ie n .Sh "The ""urxvt::popup"" Class" 1577.ie n .SS "The ""urxvt::popup"" Class"
1564.el .Sh "The \f(CWurxvt::popup\fP Class" 1578.el .SS "The \f(CWurxvt::popup\fP Class"
1565.IX Subsection "The urxvt::popup Class" 1579.IX Subsection "The urxvt::popup Class"
1566.ie n .IP "$popup\->add_title ($title)" 4 1580.ie n .IP "$popup\->add_title ($title)" 4
1567.el .IP "\f(CW$popup\fR\->add_title ($title)" 4 1581.el .IP "\f(CW$popup\fR\->add_title ($title)" 4
1568.IX Item "$popup->add_title ($title)" 1582.IX Item "$popup->add_title ($title)"
1569Adds a non-clickable title to the popup. 1583Adds a non-clickable title to the popup.
1570.ie n .IP "$popup\->add_separator ([$sepchr])" 4 1584.ie n .IP "$popup\->add_separator ([$sepchr])" 4
1571.el .IP "\f(CW$popup\fR\->add_separator ([$sepchr])" 4 1585.el .IP "\f(CW$popup\fR\->add_separator ([$sepchr])" 4
1572.IX Item "$popup->add_separator ([$sepchr])" 1586.IX Item "$popup->add_separator ([$sepchr])"
1573Creates a separator, optionally using the character given as \f(CW$sepchr\fR. 1587Creates a separator, optionally using the character given as \f(CW$sepchr\fR.
1574.ie n .IP "$popup\fR\->add_button ($text, \f(CW$cb)" 4 1588.ie n .IP "$popup\->add_button ($text, $cb)" 4
1575.el .IP "\f(CW$popup\fR\->add_button ($text, \f(CW$cb\fR)" 4 1589.el .IP "\f(CW$popup\fR\->add_button ($text, \f(CW$cb\fR)" 4
1576.IX Item "$popup->add_button ($text, $cb)" 1590.IX Item "$popup->add_button ($text, $cb)"
1577Adds a clickable button to the popup. \f(CW$cb\fR is called whenever it is 1591Adds a clickable button to the popup. \f(CW$cb\fR is called whenever it is
1578selected. 1592selected.
1579.ie n .IP "$popup\fR\->add_toggle ($text, \f(CW$initial_value\fR, \f(CW$cb)" 4 1593.ie n .IP "$popup\->add_toggle ($text, $initial_value, $cb)" 4
1580.el .IP "\f(CW$popup\fR\->add_toggle ($text, \f(CW$initial_value\fR, \f(CW$cb\fR)" 4 1594.el .IP "\f(CW$popup\fR\->add_toggle ($text, \f(CW$initial_value\fR, \f(CW$cb\fR)" 4
1581.IX Item "$popup->add_toggle ($text, $initial_value, $cb)" 1595.IX Item "$popup->add_toggle ($text, $initial_value, $cb)"
1582Adds a toggle/checkbox item to the popup. The callback gets called 1596Adds a toggle/checkbox item to the popup. The callback gets called
1583whenever it gets toggled, with a boolean indicating its new value as its 1597whenever it gets toggled, with a boolean indicating its new value as its
1584first argument. 1598first argument.
1585.ie n .IP "$popup\->show" 4 1599.ie n .IP "$popup\->show" 4
1586.el .IP "\f(CW$popup\fR\->show" 4 1600.el .IP "\f(CW$popup\fR\->show" 4
1587.IX Item "$popup->show" 1601.IX Item "$popup->show"
1588Displays the popup (which is initially hidden). 1602Displays the popup (which is initially hidden).
1589.ie n .Sh "The ""urxvt::timer"" Class" 1603.ie n .SS "The ""urxvt::timer"" Class"
1590.el .Sh "The \f(CWurxvt::timer\fP Class" 1604.el .SS "The \f(CWurxvt::timer\fP Class"
1591.IX Subsection "The urxvt::timer Class" 1605.IX Subsection "The urxvt::timer Class"
1592This class implements timer watchers/events. Time is represented as a 1606This class implements timer watchers/events. Time is represented as a
1593fractional number of seconds since the epoch. Example: 1607fractional number of seconds since the epoch. Example:
1594.PP 1608.PP
1595.Vb 8 1609.Vb 8
… …
1605.ie n .IP "$timer = new urxvt::timer" 4 1619.ie n .IP "$timer = new urxvt::timer" 4
1606.el .IP "\f(CW$timer\fR = new urxvt::timer" 4 1620.el .IP "\f(CW$timer\fR = new urxvt::timer" 4
1607.IX Item "$timer = new urxvt::timer" 1621.IX Item "$timer = new urxvt::timer"
1608Create a new timer object in started state. It is scheduled to fire 1622Create a new timer object in started state. It is scheduled to fire
1609immediately. 1623immediately.
1610.ie n .IP "$timer\fR = \f(CW$timer\fR\->cb (sub { my ($timer) = \f(CW@_; ... })" 4 1624.ie n .IP "$timer = $timer\->cb (sub { my ($timer) = @_; ... })" 4
1611.el .IP "\f(CW$timer\fR = \f(CW$timer\fR\->cb (sub { my ($timer) = \f(CW@_\fR; ... })" 4 1625.el .IP "\f(CW$timer\fR = \f(CW$timer\fR\->cb (sub { my ($timer) = \f(CW@_\fR; ... })" 4
1612.IX Item "$timer = $timer->cb (sub { my ($timer) = @_; ... })" 1626.IX Item "$timer = $timer->cb (sub { my ($timer) = @_; ... })"
1613Set the callback to be called when the timer triggers. 1627Set the callback to be called when the timer triggers.
1614.ie n .IP "$tstamp\fR = \f(CW$timer\->at" 4
1615.el .IP "\f(CW$tstamp\fR = \f(CW$timer\fR\->at" 4
1616.IX Item "$tstamp = $timer->at"
1617Return the time this watcher will fire next.
1618.ie n .IP "$timer\fR = \f(CW$timer\->set ($tstamp)" 4 1628.ie n .IP "$timer = $timer\->set ($tstamp[, $interval])" 4
1619.el .IP "\f(CW$timer\fR = \f(CW$timer\fR\->set ($tstamp)" 4 1629.el .IP "\f(CW$timer\fR = \f(CW$timer\fR\->set ($tstamp[, \f(CW$interval\fR])" 4
1620.IX Item "$timer = $timer->set ($tstamp)" 1630.IX Item "$timer = $timer->set ($tstamp[, $interval])"
1621Set the time the event is generated to \f(CW$tstamp\fR. 1631Set the time the event is generated to \f(CW$tstamp\fR (and optionally specifies a
1632new \f(CW$interval\fR).
1622.ie n .IP "$timer\fR = \f(CW$timer\->interval ($interval)" 4 1633.ie n .IP "$timer = $timer\->interval ($interval)" 4
1623.el .IP "\f(CW$timer\fR = \f(CW$timer\fR\->interval ($interval)" 4 1634.el .IP "\f(CW$timer\fR = \f(CW$timer\fR\->interval ($interval)" 4
1624.IX Item "$timer = $timer->interval ($interval)" 1635.IX Item "$timer = $timer->interval ($interval)"
1625Normally (and when \f(CW$interval\fR is \f(CW0\fR), the timer will automatically 1636By default (and when \f(CW$interval\fR is \f(CW0\fR), the timer will automatically
1626stop after it has fired once. If \f(CW$interval\fR is non-zero, then the timer 1637stop after it has fired once. If \f(CW$interval\fR is non-zero, then the timer
1627is automatically rescheduled at the given intervals. 1638is automatically rescheduled at the given intervals.
1628.ie n .IP "$timer\fR = \f(CW$timer\->start" 4 1639.ie n .IP "$timer = $timer\->start" 4
1629.el .IP "\f(CW$timer\fR = \f(CW$timer\fR\->start" 4 1640.el .IP "\f(CW$timer\fR = \f(CW$timer\fR\->start" 4
1630.IX Item "$timer = $timer->start" 1641.IX Item "$timer = $timer->start"
1631Start the timer. 1642Start the timer.
1632.ie n .IP "$timer\fR = \f(CW$timer\->start ($tstamp)" 4 1643.ie n .IP "$timer = $timer\->start ($tstamp[, $interval])" 4
1633.el .IP "\f(CW$timer\fR = \f(CW$timer\fR\->start ($tstamp)" 4 1644.el .IP "\f(CW$timer\fR = \f(CW$timer\fR\->start ($tstamp[, \f(CW$interval\fR])" 4
1634.IX Item "$timer = $timer->start ($tstamp)" 1645.IX Item "$timer = $timer->start ($tstamp[, $interval])"
1635Set the event trigger time to \f(CW$tstamp\fR and start the timer. 1646Set the event trigger time to \f(CW$tstamp\fR and start the timer. Optionally
1647also replaces the interval.
1636.ie n .IP "$timer\fR = \f(CW$timer\->after ($delay)" 4 1648.ie n .IP "$timer = $timer\->after ($delay[, $interval])" 4
1637.el .IP "\f(CW$timer\fR = \f(CW$timer\fR\->after ($delay)" 4 1649.el .IP "\f(CW$timer\fR = \f(CW$timer\fR\->after ($delay[, \f(CW$interval\fR])" 4
1638.IX Item "$timer = $timer->after ($delay)" 1650.IX Item "$timer = $timer->after ($delay[, $interval])"
1639Like \f(CW\*(C`start\*(C'\fR, but sets the expiry timer to c<urxvt::NOW + \f(CW$delay\fR>. 1651Like \f(CW\*(C`start\*(C'\fR, but sets the expiry timer to c<urxvt::NOW + \f(CW$delay\fR>.
1640.ie n .IP "$timer\fR = \f(CW$timer\->stop" 4 1652.ie n .IP "$timer = $timer\->stop" 4
1641.el .IP "\f(CW$timer\fR = \f(CW$timer\fR\->stop" 4 1653.el .IP "\f(CW$timer\fR = \f(CW$timer\fR\->stop" 4
1642.IX Item "$timer = $timer->stop" 1654.IX Item "$timer = $timer->stop"
1643Stop the timer. 1655Stop the timer.
1644.ie n .Sh "The ""urxvt::iow"" Class" 1656.ie n .SS "The ""urxvt::iow"" Class"
1645.el .Sh "The \f(CWurxvt::iow\fP Class" 1657.el .SS "The \f(CWurxvt::iow\fP Class"
1646.IX Subsection "The urxvt::iow Class" 1658.IX Subsection "The urxvt::iow Class"
1647This class implements io watchers/events. Example: 1659This class implements io watchers/events. Example:
1648.PP 1660.PP
1649.Vb 12 1661.Vb 12
1650\& $term\->{socket} = ... 1662\& $term\->{socket} = ...
… …
1662.Ve 1674.Ve
1663.ie n .IP "$iow = new urxvt::iow" 4 1675.ie n .IP "$iow = new urxvt::iow" 4
1664.el .IP "\f(CW$iow\fR = new urxvt::iow" 4 1676.el .IP "\f(CW$iow\fR = new urxvt::iow" 4
1665.IX Item "$iow = new urxvt::iow" 1677.IX Item "$iow = new urxvt::iow"
1666Create a new io watcher object in stopped state. 1678Create a new io watcher object in stopped state.
1667.ie n .IP "$iow\fR = \f(CW$iow\fR\->cb (sub { my ($iow, \f(CW$reventmask\fR) = \f(CW@_; ... })" 4 1679.ie n .IP "$iow = $iow\->cb (sub { my ($iow, $reventmask) = @_; ... })" 4
1668.el .IP "\f(CW$iow\fR = \f(CW$iow\fR\->cb (sub { my ($iow, \f(CW$reventmask\fR) = \f(CW@_\fR; ... })" 4 1680.el .IP "\f(CW$iow\fR = \f(CW$iow\fR\->cb (sub { my ($iow, \f(CW$reventmask\fR) = \f(CW@_\fR; ... })" 4
1669.IX Item "$iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... })" 1681.IX Item "$iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... })"
1670Set the callback to be called when io events are triggered. \f(CW$reventmask\fR 1682Set the callback to be called when io events are triggered. \f(CW$reventmask\fR
1671is a bitset as described in the \f(CW\*(C`events\*(C'\fR method. 1683is a bitset as described in the \f(CW\*(C`events\*(C'\fR method.
1672.ie n .IP "$iow\fR = \f(CW$iow\->fd ($fd)" 4 1684.ie n .IP "$iow = $iow\->fd ($fd)" 4
1673.el .IP "\f(CW$iow\fR = \f(CW$iow\fR\->fd ($fd)" 4 1685.el .IP "\f(CW$iow\fR = \f(CW$iow\fR\->fd ($fd)" 4
1674.IX Item "$iow = $iow->fd ($fd)" 1686.IX Item "$iow = $iow->fd ($fd)"
1675Set the file descriptor (not handle) to watch. 1687Set the file descriptor (not handle) to watch.
1676.ie n .IP "$iow\fR = \f(CW$iow\->events ($eventmask)" 4 1688.ie n .IP "$iow = $iow\->events ($eventmask)" 4
1677.el .IP "\f(CW$iow\fR = \f(CW$iow\fR\->events ($eventmask)" 4 1689.el .IP "\f(CW$iow\fR = \f(CW$iow\fR\->events ($eventmask)" 4
1678.IX Item "$iow = $iow->events ($eventmask)" 1690.IX Item "$iow = $iow->events ($eventmask)"
1679Set the event mask to watch. The only allowed values are 1691Set the event mask to watch. The only allowed values are
1680\&\f(CW\*(C`urxvt::EV_READ\*(C'\fR and \f(CW\*(C`urxvt::EV_WRITE\*(C'\fR, which might be ORed 1692\&\f(CW\*(C`urxvt::EV_READ\*(C'\fR and \f(CW\*(C`urxvt::EV_WRITE\*(C'\fR, which might be ORed
1681together, or \f(CW\*(C`urxvt::EV_NONE\*(C'\fR. 1693together, or \f(CW\*(C`urxvt::EV_NONE\*(C'\fR.
1682.ie n .IP "$iow\fR = \f(CW$iow\->start" 4 1694.ie n .IP "$iow = $iow\->start" 4
1683.el .IP "\f(CW$iow\fR = \f(CW$iow\fR\->start" 4 1695.el .IP "\f(CW$iow\fR = \f(CW$iow\fR\->start" 4
1684.IX Item "$iow = $iow->start" 1696.IX Item "$iow = $iow->start"
1685Start watching for requested events on the given handle. 1697Start watching for requested events on the given handle.
1686.ie n .IP "$iow\fR = \f(CW$iow\->stop" 4 1698.ie n .IP "$iow = $iow\->stop" 4
1687.el .IP "\f(CW$iow\fR = \f(CW$iow\fR\->stop" 4 1699.el .IP "\f(CW$iow\fR = \f(CW$iow\fR\->stop" 4
1688.IX Item "$iow = $iow->stop" 1700.IX Item "$iow = $iow->stop"
1689Stop watching for events on the given file handle. 1701Stop watching for events on the given file handle.
1690.ie n .Sh "The ""urxvt::iw"" Class" 1702.ie n .SS "The ""urxvt::iw"" Class"
1691.el .Sh "The \f(CWurxvt::iw\fP Class" 1703.el .SS "The \f(CWurxvt::iw\fP Class"
1692.IX Subsection "The urxvt::iw Class" 1704.IX Subsection "The urxvt::iw Class"
1693This class implements idle watchers, that get called automatically when 1705This class implements idle watchers, that get called automatically when
1694the process is idle. They should return as fast as possible, after doing 1706the process is idle. They should return as fast as possible, after doing
1695some useful work. 1707some useful work.
1696.ie n .IP "$iw = new urxvt::iw" 4 1708.ie n .IP "$iw = new urxvt::iw" 4
1697.el .IP "\f(CW$iw\fR = new urxvt::iw" 4 1709.el .IP "\f(CW$iw\fR = new urxvt::iw" 4
1698.IX Item "$iw = new urxvt::iw" 1710.IX Item "$iw = new urxvt::iw"
1699Create a new idle watcher object in stopped state. 1711Create a new idle watcher object in stopped state.
1700.ie n .IP "$iw\fR = \f(CW$iw\fR\->cb (sub { my ($iw) = \f(CW@_; ... })" 4 1712.ie n .IP "$iw = $iw\->cb (sub { my ($iw) = @_; ... })" 4
1701.el .IP "\f(CW$iw\fR = \f(CW$iw\fR\->cb (sub { my ($iw) = \f(CW@_\fR; ... })" 4 1713.el .IP "\f(CW$iw\fR = \f(CW$iw\fR\->cb (sub { my ($iw) = \f(CW@_\fR; ... })" 4
1702.IX Item "$iw = $iw->cb (sub { my ($iw) = @_; ... })" 1714.IX Item "$iw = $iw->cb (sub { my ($iw) = @_; ... })"
1703Set the callback to be called when the watcher triggers. 1715Set the callback to be called when the watcher triggers.
1704.ie n .IP "$timer\fR = \f(CW$timer\->start" 4 1716.ie n .IP "$timer = $timer\->start" 4
1705.el .IP "\f(CW$timer\fR = \f(CW$timer\fR\->start" 4 1717.el .IP "\f(CW$timer\fR = \f(CW$timer\fR\->start" 4
1706.IX Item "$timer = $timer->start" 1718.IX Item "$timer = $timer->start"
1707Start the watcher. 1719Start the watcher.
1708.ie n .IP "$timer\fR = \f(CW$timer\->stop" 4 1720.ie n .IP "$timer = $timer\->stop" 4
1709.el .IP "\f(CW$timer\fR = \f(CW$timer\fR\->stop" 4 1721.el .IP "\f(CW$timer\fR = \f(CW$timer\fR\->stop" 4
1710.IX Item "$timer = $timer->stop" 1722.IX Item "$timer = $timer->stop"
1711Stop the watcher. 1723Stop the watcher.
1712.ie n .Sh "The ""urxvt::pw"" Class" 1724.ie n .SS "The ""urxvt::pw"" Class"
1713.el .Sh "The \f(CWurxvt::pw\fP Class" 1725.el .SS "The \f(CWurxvt::pw\fP Class"
1714.IX Subsection "The urxvt::pw Class" 1726.IX Subsection "The urxvt::pw Class"
1715This class implements process watchers. They create an event whenever a 1727This class implements process watchers. They create an event whenever a
1716process exits, after which they stop automatically. 1728process exits, after which they stop automatically.
1717.PP 1729.PP
1718.Vb 9 1730.Vb 9
… …
1728.Ve 1740.Ve
1729.ie n .IP "$pw = new urxvt::pw" 4 1741.ie n .IP "$pw = new urxvt::pw" 4
1730.el .IP "\f(CW$pw\fR = new urxvt::pw" 4 1742.el .IP "\f(CW$pw\fR = new urxvt::pw" 4
1731.IX Item "$pw = new urxvt::pw" 1743.IX Item "$pw = new urxvt::pw"
1732Create a new process watcher in stopped state. 1744Create a new process watcher in stopped state.
1733.ie n .IP "$pw\fR = \f(CW$pw\fR\->cb (sub { my ($pw, \f(CW$exit_status\fR) = \f(CW@_; ... })" 4 1745.ie n .IP "$pw = $pw\->cb (sub { my ($pw, $exit_status) = @_; ... })" 4
1734.el .IP "\f(CW$pw\fR = \f(CW$pw\fR\->cb (sub { my ($pw, \f(CW$exit_status\fR) = \f(CW@_\fR; ... })" 4 1746.el .IP "\f(CW$pw\fR = \f(CW$pw\fR\->cb (sub { my ($pw, \f(CW$exit_status\fR) = \f(CW@_\fR; ... })" 4
1735.IX Item "$pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })" 1747.IX Item "$pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })"
1736Set the callback to be called when the timer triggers. 1748Set the callback to be called when the timer triggers.
1737.ie n .IP "$pw\fR = \f(CW$timer\->start ($pid)" 4 1749.ie n .IP "$pw = $timer\->start ($pid)" 4
1738.el .IP "\f(CW$pw\fR = \f(CW$timer\fR\->start ($pid)" 4 1750.el .IP "\f(CW$pw\fR = \f(CW$timer\fR\->start ($pid)" 4
1739.IX Item "$pw = $timer->start ($pid)" 1751.IX Item "$pw = $timer->start ($pid)"
1740Tells the watcher to start watching for process \f(CW$pid\fR. 1752Tells the watcher to start watching for process \f(CW$pid\fR.
1741.ie n .IP "$pw\fR = \f(CW$pw\->stop" 4 1753.ie n .IP "$pw = $pw\->stop" 4
1742.el .IP "\f(CW$pw\fR = \f(CW$pw\fR\->stop" 4 1754.el .IP "\f(CW$pw\fR = \f(CW$pw\fR\->stop" 4
1743.IX Item "$pw = $pw->stop" 1755.IX Item "$pw = $pw->stop"
1744Stop the watcher. 1756Stop the watcher.
1745.SH "ENVIRONMENT" 1757.SH "ENVIRONMENT"
1746.IX Header "ENVIRONMENT" 1758.IX Header "ENVIRONMENT"
1747.Sh "\s-1URXVT_PERL_VERBOSITY\s0" 1759.SS "\s-1URXVT_PERL_VERBOSITY\s0"
1748.IX Subsection "URXVT_PERL_VERBOSITY" 1760.IX Subsection "URXVT_PERL_VERBOSITY"
1749This variable controls the verbosity level of the perl extension. Higher 1761This variable controls the verbosity level of the perl extension. Higher
1750numbers indicate more verbose output. 1762numbers indicate more verbose output.
1751.IP "== 0 \- fatal messages" 4 1763.IP "== 0 \- fatal messages" 4
1752.IX Item "== 0 - fatal messages" 1764.IX Item "== 0 - fatal messages"

Diff Legend

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