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.64 by root, Sun Jun 15 18:11:41 2008 UTC vs.
Revision 1.65 by root, Tue Nov 4 22:44:09 2008 UTC

… …
130.\} 130.\}
131.rm #[ #] #H #V #F C 131.rm #[ #] #H #V #F C
132.\" ======================================================================== 132.\" ========================================================================
133.\" 133.\"
134.IX Title "@@RXVT_NAME@@ 3" 134.IX Title "@@RXVT_NAME@@ 3"
135.TH @@RXVT_NAME@@ 3 "2008-06-15" "@@RXVT_VERSION@@" "RXVT-UNICODE" 135.TH @@RXVT_NAME@@ 3 "2008-11-04" "@@RXVT_VERSION@@" "RXVT-UNICODE"
136.\" For nroff, turn off justification. Always turn off hyphenation; it makes 136.\" For nroff, turn off justification. Always turn off hyphenation; it makes
137.\" way too many mistakes in technical documents. 137.\" way too many mistakes in technical documents.
138.if n .ad l 138.if n .ad l
139.nh 139.nh
140.SH "NAME" 140.SH "NAME"
… …
250reference. The string will be used as button text and the code reference 250reference. The string will be used as button text and the code reference
251will be called when the toggle changes, with the new boolean value as 251will be called when the toggle changes, with the new boolean value as
252first argument. 252first argument.
253.Sp 253.Sp
254The following will add an entry \f(CW\*(C`myoption\*(C'\fR that changes 254The following will add an entry \f(CW\*(C`myoption\*(C'\fR that changes
255\&\f(CW\*(C`$self\-\*(C'\fR{myoption}>: 255\&\f(CW\*(C`$self\->{myoption}\*(C'\fR:
256.Sp 256.Sp
257.Vb 3 257.Vb 3
258\& push @{ $self\->{term}{option_popup_hook} }, sub { 258\& push @{ $self\->{term}{option_popup_hook} }, sub {
259\& ("my option" => $myoption, sub { $self\->{myoption} = $_[0] }) 259\& ("my option" => $myoption, sub { $self\->{myoption} = $_[0] })
260\& }; 260\& };
… …
682than the scroll back buffer or the terminal. 682than the scroll back buffer or the terminal.
683.Sp 683.Sp
684It is called before lines are scrolled out (so rows 0 .. min ($lines \- 1, 684It is called before lines are scrolled out (so rows 0 .. min ($lines \- 1,
685\&\f(CW$nrow\fR \- 1) represent the lines to be scrolled out). \f(CW$saved\fR is the total 685\&\f(CW$nrow\fR \- 1) represent the lines to be scrolled out). \f(CW$saved\fR is the total
686number of lines that will be in the scrollback buffer. 686number of lines that will be in the scrollback buffer.
687.ie n .IP "on_osc_seq $term\fR, \f(CW$op\fR, \f(CW$args" 4 687.ie n .IP "on_osc_seq $term\fR, \f(CW$op\fR, \f(CW$args\fR, \f(CW$resp" 4
688.el .IP "on_osc_seq \f(CW$term\fR, \f(CW$op\fR, \f(CW$args\fR" 4 688.el .IP "on_osc_seq \f(CW$term\fR, \f(CW$op\fR, \f(CW$args\fR, \f(CW$resp\fR" 4
689.IX Item "on_osc_seq $term, $op, $args" 689.IX Item "on_osc_seq $term, $op, $args, $resp"
690Called on every \s-1OSC\s0 sequence and can be used to suppress it or modify its 690Called on every \s-1OSC\s0 sequence and can be used to suppress it or modify its
691behaviour. The default should be to return an empty list. A true value 691behaviour. The default should be to return an empty list. A true value
692suppresses execution of the request completely. Make sure you don't get 692suppresses execution of the request completely. Make sure you don't get
693confused by recursive invocations when you output an osc sequence within 693confused by recursive invocations when you output an \s-1OSC\s0 sequence within
694this callback. 694this callback.
695.Sp 695.Sp
696\&\f(CW\*(C`on_osc_seq_perl\*(C'\fR should be used for new behaviour. 696\&\f(CW\*(C`on_osc_seq_perl\*(C'\fR should be used for new behaviour.
697.ie n .IP "on_osc_seq_perl $term\fR, \f(CW$string" 4 697.ie n .IP "on_osc_seq_perl $term\fR, \f(CW$args\fR, \f(CW$resp" 4
698.el .IP "on_osc_seq_perl \f(CW$term\fR, \f(CW$string\fR" 4 698.el .IP "on_osc_seq_perl \f(CW$term\fR, \f(CW$args\fR, \f(CW$resp\fR" 4
699.IX Item "on_osc_seq_perl $term, $string" 699.IX Item "on_osc_seq_perl $term, $args, $resp"
700Called whenever the \fB\s-1ESC\s0 ] 777 ; string \s-1ST\s0\fR command sequence (\s-1OSC\s0 = 700Called whenever the \fB\s-1ESC\s0 ] 777 ; string \s-1ST\s0\fR command sequence (\s-1OSC\s0 =
701operating system command) is processed. Cursor position and other state 701operating system command) is processed. Cursor position and other state
702information is up-to-date when this happens. For interoperability, the 702information is up-to-date when this happens. For interoperability, the
703string should start with the extension name and a colon, to distinguish 703string should start with the extension name (sans \-osc) and a semicolon,
704it from commands for other extensions, and this might be enforced in the 704to distinguish it from commands for other extensions, and this might be
705future. 705enforced in the future.
706.Sp
707For example, \f(CW\*(C`overlay\-osc\*(C'\fR uses this:
708.Sp
709.Vb 2
710\& sub on_osc_seq_perl {
711\& my ($self, $osc, $resp) = @_;
712\&
713\& return unless $osc =~ s/^overlay;//;
714\&
715\& ... process remaining $osc string
716\& }
717.Ve
706.Sp 718.Sp
707Be careful not ever to trust (in a security sense) the data you receive, 719Be careful not ever to trust (in a security sense) the data you receive,
708as its source can not easily be controlled (e\-mail content, messages from 720as its source can not easily be controlled (e\-mail content, messages from
709other users on the same system etc.). 721other users on the same system etc.).
722.Sp
723For responses, \f(CW$resp\fR contains the end-of-args separator used by the
724sender.
710.ie n .IP "on_add_lines $term\fR, \f(CW$string" 4 725.ie n .IP "on_add_lines $term\fR, \f(CW$string" 4
711.el .IP "on_add_lines \f(CW$term\fR, \f(CW$string\fR" 4 726.el .IP "on_add_lines \f(CW$term\fR, \f(CW$string\fR" 4
712.IX Item "on_add_lines $term, $string" 727.IX Item "on_add_lines $term, $string"
713Called whenever text is about to be output, with the text as argument. You 728Called whenever text is about to be output, with the text as argument. You
714can filter/change and output the text yourself by returning a true value 729can filter/change and output the text yourself by returning a true value
… …
735later with the already-modified line (e.g. if unrelated parts change), so 750later with the already-modified line (e.g. if unrelated parts change), so
736you cannot just toggle rendition bits, but only set them. 751you cannot just toggle rendition bits, but only set them.
737.ie n .IP "on_refresh_begin $term" 4 752.ie n .IP "on_refresh_begin $term" 4
738.el .IP "on_refresh_begin \f(CW$term\fR" 4 753.el .IP "on_refresh_begin \f(CW$term\fR" 4
739.IX Item "on_refresh_begin $term" 754.IX Item "on_refresh_begin $term"
740Called just before the screen gets redrawn. Can be used for overlay 755Called just before the screen gets redrawn. Can be used for overlay or
741or similar effects by modify terminal contents in refresh_begin, and 756similar effects by modifying the terminal contents in refresh_begin, and
742restoring them in refresh_end. The built-in overlay and selection display 757restoring them in refresh_end. The built-in overlay and selection display
743code is run after this hook, and takes precedence. 758code is run after this hook, and takes precedence.
744.ie n .IP "on_refresh_end $term" 4 759.ie n .IP "on_refresh_end $term" 4
745.el .IP "on_refresh_end \f(CW$term\fR" 4 760.el .IP "on_refresh_end \f(CW$term\fR" 4
746.IX Item "on_refresh_end $term" 761.IX Item "on_refresh_end $term"
… …
1138This method returns an urxvt::overlay object. The overlay will be visible 1153This method returns an urxvt::overlay object. The overlay will be visible
1139as long as the perl object is referenced. 1154as long as the perl object is referenced.
1140.Sp 1155.Sp
1141The methods currently supported on \f(CW\*(C`urxvt::overlay\*(C'\fR objects are: 1156The methods currently supported on \f(CW\*(C`urxvt::overlay\*(C'\fR objects are:
1142.RS 4 1157.RS 4
1143.ie n .IP "$overlay\fR\->set ($x, \f(CW$y\fR, \f(CW$text\fR, \f(CW$rend)" 4 1158.ie n .IP "$overlay\fR\->set ($x, \f(CW$y\fR, \f(CW$text\fR[, \f(CW$rend])" 4
1144.el .IP "\f(CW$overlay\fR\->set ($x, \f(CW$y\fR, \f(CW$text\fR, \f(CW$rend\fR)" 4 1159.el .IP "\f(CW$overlay\fR\->set ($x, \f(CW$y\fR, \f(CW$text\fR[, \f(CW$rend\fR])" 4
1145.IX Item "$overlay->set ($x, $y, $text, $rend)" 1160.IX Item "$overlay->set ($x, $y, $text[, $rend])"
1146Similar to \f(CW\*(C`$term\->ROW_t\*(C'\fR and \f(CW\*(C`$term\->ROW_r\*(C'\fR in that it puts 1161Similar to \f(CW\*(C`$term\->ROW_t\*(C'\fR and \f(CW\*(C`$term\->ROW_r\*(C'\fR in that it puts
1147text in rxvt-unicode's special encoding and an array of rendition values 1162text in rxvt-unicode's special encoding and an array of rendition values
1148at a specific position inside the overlay. 1163at a specific position inside the overlay.
1164.Sp
1165If \f(CW$rend\fR is missing, then the rendition will not be changed.
1149.ie n .IP "$overlay\->hide" 4 1166.ie n .IP "$overlay\->hide" 4
1150.el .IP "\f(CW$overlay\fR\->hide" 4 1167.el .IP "\f(CW$overlay\fR\->hide" 4
1151.IX Item "$overlay->hide" 1168.IX Item "$overlay->hide"
1152If visible, hide the overlay, but do not destroy it. 1169If visible, hide the overlay, but do not destroy it.
1153.ie n .IP "$overlay\->show" 4 1170.ie n .IP "$overlay\->show" 4

Diff Legend

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