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.16 by root, Sun Jan 8 06:35:38 2006 UTC vs.
Revision 1.17 by root, Mon Jan 9 01:36:56 2006 UTC

… …
127.\} 127.\}
128.rm #[ #] #H #V #F C 128.rm #[ #] #H #V #F C
129.\" ======================================================================== 129.\" ========================================================================
130.\" 130.\"
131.IX Title "rxvt 3" 131.IX Title "rxvt 3"
132.TH rxvt 3 "2006-01-08" "6.3" "RXVT-UNICODE" 132.TH rxvt 3 "2006-01-09" "6.3" "RXVT-UNICODE"
133.SH "NAME" 133.SH "NAME"
134@@RXVT_NAME@@perl \- rxvt\-unicode's embedded perl interpreter 134@@RXVT_NAME@@perl \- rxvt\-unicode's embedded perl interpreter
135.SH "SYNOPSIS" 135.SH "SYNOPSIS"
136.IX Header "SYNOPSIS" 136.IX Header "SYNOPSIS"
137.Vb 1 137.Vb 1
… …
191.RE 191.RE
192.RS 4 192.RS 4
193.RE 193.RE
194.IP "option-popup (enabled by default)" 4 194.IP "option-popup (enabled by default)" 4
195.IX Item "option-popup (enabled by default)" 195.IX Item "option-popup (enabled by default)"
196Binds a popup menu to Ctrl\-Button3 that lets you toggle (some) options at 196Binds a popup menu to Ctrl\-Button2 that lets you toggle (some) options at
197runtime. 197runtime.
198.IP "selection-popup (enabled by default)" 4
199.IX Item "selection-popup (enabled by default)"
200Binds a popup menu to Ctrl\-Button3 that lets you convert the selection
201text into various other formats/action.
198.IP "digital-clock" 4 202.IP "digital-clock" 4
199.IX Item "digital-clock" 203.IX Item "digital-clock"
200Displays a digital clock using the built-in overlay. 204Displays a digital clock using the built-in overlay.
201.IP "mark-urls" 4 205.IP "mark-urls" 4
202.IX Item "mark-urls" 206.IX Item "mark-urls"
… …
315than the scroll back buffer or the terminal. 319than the scroll back buffer or the terminal.
316.Sp 320.Sp
317It is called before lines are scrolled out (so rows 0 .. min ($lines \- 1, 321It is called before lines are scrolled out (so rows 0 .. min ($lines \- 1,
318\&\f(CW$nrow\fR \- 1) represent the lines to be scrolled out). \f(CW$saved\fR is the total 322\&\f(CW$nrow\fR \- 1) represent the lines to be scrolled out). \f(CW$saved\fR is the total
319number of lines that will be in the scrollback buffer. 323number of lines that will be in the scrollback buffer.
320.ie n .IP "on_tty_activity $term *NYI*" 4
321.el .IP "on_tty_activity \f(CW$term\fR *NYI*" 4
322.IX Item "on_tty_activity $term *NYI*"
323Called whenever the program(s) running in the urxvt window send output.
324.ie n .IP "on_osc_seq $term\fR, \f(CW$string" 4 324.ie n .IP "on_osc_seq $term\fR, \f(CW$string" 4
325.el .IP "on_osc_seq \f(CW$term\fR, \f(CW$string\fR" 4 325.el .IP "on_osc_seq \f(CW$term\fR, \f(CW$string\fR" 4
326.IX Item "on_osc_seq $term, $string" 326.IX Item "on_osc_seq $term, $string"
327Called whenever the \fB\s-1ESC\s0 ] 777 ; string \s-1ST\s0\fR command sequence (\s-1OSC\s0 = 327Called whenever the \fB\s-1ESC\s0 ] 777 ; string \s-1ST\s0\fR command sequence (\s-1OSC\s0 =
328operating system command) is processed. Cursor position and other state 328operating system command) is processed. Cursor position and other state
… …
860.IX Item "($row, $col) = $line->coord_of ($offset)" 860.IX Item "($row, $col) = $line->coord_of ($offset)"
861Translates a string offset into terminal coordinates again. 861Translates a string offset into terminal coordinates again.
862.RE 862.RE
863.RS 4 863.RS 4
864.RE 864.RE
865.ie n .IP "($row, $col\fR) = \f(CW$line\fR\->coord_of ($offset) =item \f(CW$text\fR = \f(CW$term\fR\->special_encode \f(CW$string" 4 865.ie n .IP "$text = $term\fR\->special_encode \f(CW$string" 4
866.el .IP "($row, \f(CW$col\fR) = \f(CW$line\fR\->coord_of ($offset) =item \f(CW$text\fR = \f(CW$term\fR\->special_encode \f(CW$string\fR" 4 866.el .IP "$text = \f(CW$term\fR\->special_encode \f(CW$string\fR" 4
867.IX Item "($row, $col) = $line->coord_of ($offset) =item $text = $term->special_encode $string" 867.IX Item "$text = $term->special_encode $string"
868Converts a perl string into the special encoding used by rxvt\-unicode, 868Converts a perl string into the special encoding used by rxvt\-unicode,
869where one character corresponds to one screen cell. See 869where one character corresponds to one screen cell. See
870\&\f(CW\*(C`$term\->ROW_t\*(C'\fR for details. 870\&\f(CW\*(C`$term\->ROW_t\*(C'\fR for details.
871.ie n .IP "$string = $term\fR\->special_decode \f(CW$text" 4 871.ie n .IP "$string = $term\fR\->special_decode \f(CW$text" 4
872.el .IP "$string = \f(CW$term\fR\->special_decode \f(CW$text\fR" 4 872.el .IP "$string = \f(CW$term\fR\->special_decode \f(CW$text\fR" 4
873.IX Item "$string = $term->special_decode $text" 873.IX Item "$string = $term->special_decode $text"
874Converts rxvt-unicodes text reprsentation into a perl string. See 874Converts rxvt-unicodes text reprsentation into a perl string. See
875\&\f(CW\*(C`$term\->ROW_t\*(C'\fR for details. 875\&\f(CW\*(C`$term\->ROW_t\*(C'\fR for details.
876.ie n .IP "$success = $term\fR\->grab_button ($button, \f(CW$modifiermask)" 4
877.el .IP "$success = \f(CW$term\fR\->grab_button ($button, \f(CW$modifiermask\fR)" 4
878.IX Item "$success = $term->grab_button ($button, $modifiermask)"
879Registers a synchronous button grab. See XGrabButton.
880.ie n .IP "$success = $term\fR\->grab ($eventtime[, \f(CW$sync])" 4
881.el .IP "$success = \f(CW$term\fR\->grab ($eventtime[, \f(CW$sync\fR])" 4
882.IX Item "$success = $term->grab ($eventtime[, $sync])"
883Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
884synchronous (\f(CW$sync\fR is true). Also remembers the grab timestampe.
885.IP "$term\->allow_events_async" 4
886.IX Item "$term->allow_events_async"
887Calls XAllowEvents with AsyncBoth for the most recent grab.
888.IP "$term\->allow_events_sync" 4
889.IX Item "$term->allow_events_sync"
890Calls XAllowEvents with SyncBoth for the most recent grab.
891.IP "$term\->allow_events_replay" 4
892.IX Item "$term->allow_events_replay"
893Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
894recent grab.
895.IP "$term\->ungrab" 4
896.IX Item "$term->ungrab"
897Calls XUngrab for the most recent grab. Is called automatically on
898evaluation errors, as it is better to lose the grab in the error case as
899the session.
876.ie n .Sh "The ""urxvt::popup"" Class" 900.ie n .Sh "The ""urxvt::popup"" Class"
877.el .Sh "The \f(CWurxvt::popup\fP Class" 901.el .Sh "The \f(CWurxvt::popup\fP Class"
878.IX Subsection "The urxvt::popup Class" 902.IX Subsection "The urxvt::popup Class"
879.ie n .Sh "The ""urxvt::timer"" Class" 903.ie n .Sh "The ""urxvt::timer"" Class"
880.el .Sh "The \f(CWurxvt::timer\fP Class" 904.el .Sh "The \f(CWurxvt::timer\fP Class"
… …
979.IX Header "ENVIRONMENT" 1003.IX Header "ENVIRONMENT"
980.Sh "\s-1URXVT_PERL_VERBOSITY\s0" 1004.Sh "\s-1URXVT_PERL_VERBOSITY\s0"
981.IX Subsection "URXVT_PERL_VERBOSITY" 1005.IX Subsection "URXVT_PERL_VERBOSITY"
982This variable controls the verbosity level of the perl extension. Higher 1006This variable controls the verbosity level of the perl extension. Higher
983numbers indicate more verbose output. 1007numbers indicate more verbose output.
984.IP "=0 \- only fatal messages" 4 1008.IP "== 0 \- fatal messages" 4
985.IX Item "=0 - only fatal messages" 1009.IX Item "== 0 - fatal messages"
986.PD 0 1010.PD 0
987.IP "=3 \- script loading and management" 4 1011.IP ">= 3 \- script loading and management" 4
988.IX Item "=3 - script loading and management" 1012.IX Item ">= 3 - script loading and management"
989.IP "=10 \- all events received" 4 1013.IP ">=10 \- all events received" 4
990.IX Item "=10 - all events received" 1014.IX Item ">=10 - all events received"
991.RE 1015.RE
992.RS 4 1016.RS 4
993.PD 1017.PD
994.SH "AUTHOR" 1018.SH "AUTHOR"
995.IX Header "AUTHOR" 1019.IX Header "AUTHOR"

Diff Legend

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