| 1 |
.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14 |
| 2 |
.\" |
| 3 |
.\" Standard preamble: |
| 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) |
| 14 |
.if t .sp .5v |
| 15 |
.if n .sp |
| 16 |
.. |
| 17 |
.de Vb \" Begin verbatim text |
| 18 |
.ft CW |
| 19 |
.nf |
| 20 |
.ne \\$1 |
| 21 |
.. |
| 22 |
.de Ve \" End verbatim text |
| 23 |
.ft R |
| 24 |
.fi |
| 25 |
.. |
| 26 |
.\" Set up some character translations and predefined strings. \*(-- will |
| 27 |
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left |
| 28 |
.\" double quote, and \*(R" will give a right double quote. | will give a |
| 29 |
.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to |
| 30 |
.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' |
| 31 |
.\" expand to `' in nroff, nothing in troff, for use with C<>. |
| 32 |
.tr \(*W-|\(bv\*(Tr |
| 33 |
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' |
| 34 |
.ie n \{\ |
| 35 |
. ds -- \(*W- |
| 36 |
. ds PI pi |
| 37 |
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch |
| 38 |
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch |
| 39 |
. ds L" "" |
| 40 |
. ds R" "" |
| 41 |
. ds C` "" |
| 42 |
. ds C' "" |
| 43 |
'br\} |
| 44 |
.el\{\ |
| 45 |
. ds -- \|\(em\| |
| 46 |
. ds PI \(*p |
| 47 |
. ds L" `` |
| 48 |
. ds R" '' |
| 49 |
'br\} |
| 50 |
.\" |
| 51 |
.\" If the F register is turned on, we'll generate index entries on stderr for |
| 52 |
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index |
| 53 |
.\" entries marked with X<> in POD. Of course, you'll have to process the |
| 54 |
.\" output yourself in some meaningful fashion. |
| 55 |
.if \nF \{\ |
| 56 |
. de IX |
| 57 |
. tm Index:\\$1\t\\n%\t"\\$2" |
| 58 |
.. |
| 59 |
. nr % 0 |
| 60 |
. rr F |
| 61 |
.\} |
| 62 |
.\" |
| 63 |
.\" For nroff, turn off justification. Always turn off hyphenation; it makes |
| 64 |
.\" way too many mistakes in technical documents. |
| 65 |
.hy 0 |
| 66 |
.if n .na |
| 67 |
.\" |
| 68 |
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). |
| 69 |
.\" Fear. Run. Save yourself. No user-serviceable parts. |
| 70 |
. \" fudge factors for nroff and troff |
| 71 |
.if n \{\ |
| 72 |
. ds #H 0 |
| 73 |
. ds #V .8m |
| 74 |
. ds #F .3m |
| 75 |
. ds #[ \f1 |
| 76 |
. ds #] \fP |
| 77 |
.\} |
| 78 |
.if t \{\ |
| 79 |
. ds #H ((1u-(\\\\n(.fu%2u))*.13m) |
| 80 |
. ds #V .6m |
| 81 |
. ds #F 0 |
| 82 |
. ds #[ \& |
| 83 |
. ds #] \& |
| 84 |
.\} |
| 85 |
. \" simple accents for nroff and troff |
| 86 |
.if n \{\ |
| 87 |
. ds ' \& |
| 88 |
. ds ` \& |
| 89 |
. ds ^ \& |
| 90 |
. ds , \& |
| 91 |
. ds ~ ~ |
| 92 |
. ds / |
| 93 |
.\} |
| 94 |
.if t \{\ |
| 95 |
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" |
| 96 |
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' |
| 97 |
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' |
| 98 |
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' |
| 99 |
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' |
| 100 |
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' |
| 101 |
.\} |
| 102 |
. \" troff and (daisy-wheel) nroff accents |
| 103 |
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' |
| 104 |
.ds 8 \h'\*(#H'\(*b\h'-\*(#H' |
| 105 |
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] |
| 106 |
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' |
| 107 |
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' |
| 108 |
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] |
| 109 |
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] |
| 110 |
.ds ae a\h'-(\w'a'u*4/10)'e |
| 111 |
.ds Ae A\h'-(\w'A'u*4/10)'E |
| 112 |
. \" corrections for vroff |
| 113 |
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' |
| 114 |
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' |
| 115 |
. \" for low resolution devices (crt and lpr) |
| 116 |
.if \n(.H>23 .if \n(.V>19 \ |
| 117 |
\{\ |
| 118 |
. ds : e |
| 119 |
. ds 8 ss |
| 120 |
. ds o a |
| 121 |
. ds d- d\h'-1'\(ga |
| 122 |
. ds D- D\h'-1'\(hy |
| 123 |
. ds th \o'bp' |
| 124 |
. ds Th \o'LP' |
| 125 |
. ds ae ae |
| 126 |
. ds Ae AE |
| 127 |
.\} |
| 128 |
.rm #[ #] #H #V #F C |
| 129 |
.\" ======================================================================== |
| 130 |
.\" |
| 131 |
.IX Title "rxvt 3" |
| 132 |
.TH rxvt 3 "2006-01-03" "6.2" "RXVT-UNICODE" |
| 133 |
.SH "NAME" |
| 134 |
@@RXVT_NAME@@perl \- rxvt\-unicode's embedded perl interpreter |
| 135 |
.SH "SYNOPSIS" |
| 136 |
.IX Header "SYNOPSIS" |
| 137 |
.Vb 1 |
| 138 |
\& # create a file grab_test in $HOME: |
| 139 |
.Ve |
| 140 |
.PP |
| 141 |
.Vb 4 |
| 142 |
\& sub on_sel_grab { |
| 143 |
\& warn "you selected ", $_[0]->selection; |
| 144 |
\& () |
| 145 |
\& } |
| 146 |
.Ve |
| 147 |
.PP |
| 148 |
.Vb 1 |
| 149 |
\& # start a @@RXVT_NAME@@ using it: |
| 150 |
.Ve |
| 151 |
.PP |
| 152 |
.Vb 1 |
| 153 |
\& @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test |
| 154 |
.Ve |
| 155 |
.SH "DESCRIPTION" |
| 156 |
.IX Header "DESCRIPTION" |
| 157 |
Everytime a terminal object gets created, scripts specified via the |
| 158 |
\&\f(CW\*(C`perl\*(C'\fR resource are loaded and associated with it. |
| 159 |
.PP |
| 160 |
Scripts are compiled in a 'use strict' and 'use utf8' environment, and |
| 161 |
thus must be encoded as \s-1UTF\-8\s0. |
| 162 |
.PP |
| 163 |
Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where |
| 164 |
scripts will be shared (but not enabled) for all terminals. |
| 165 |
.Sh "Prepackaged Extensions" |
| 166 |
.IX Subsection "Prepackaged Extensions" |
| 167 |
This section describes the extensiosn delivered with this version. You can |
| 168 |
find them in \fI@@RXVT_LIBDIR@@/urxvt/perl/\fR. |
| 169 |
.PP |
| 170 |
You can activate them like this: |
| 171 |
.PP |
| 172 |
.Vb 1 |
| 173 |
\& @@RXVT_NAME@@ -pe <extensionname> |
| 174 |
.Ve |
| 175 |
.IP "selection" 4 |
| 176 |
.IX Item "selection" |
| 177 |
Miscellaneous selection modifications. |
| 178 |
.RS 4 |
| 179 |
.IP "rot13" 4 |
| 180 |
.IX Item "rot13" |
| 181 |
Rot\-13 the selection when activated. Used via keyboard trigger: |
| 182 |
.Sp |
| 183 |
.Vb 1 |
| 184 |
\& URxvt.keysym.C-M-r: perl:selection:rot13 |
| 185 |
.Ve |
| 186 |
.RE |
| 187 |
.RS 4 |
| 188 |
.RE |
| 189 |
.IP "digital-clock" 4 |
| 190 |
.IX Item "digital-clock" |
| 191 |
Displays a digital clock using the built-in overlay. |
| 192 |
.IP "example-refresh-hooks" 4 |
| 193 |
.IX Item "example-refresh-hooks" |
| 194 |
Displays a very simple digital clock in the upper right corner of the |
| 195 |
window. Illustrates overwriting the refresh callbacks to create your own |
| 196 |
overlays or changes. |
| 197 |
.Sh "General \s-1API\s0 Considerations" |
| 198 |
.IX Subsection "General API Considerations" |
| 199 |
All objects (such as terminals, time watchers etc.) are typical |
| 200 |
reference-to-hash objects. The hash can be used to store anything you |
| 201 |
like. All members starting with an underscore (such as \f(CW\*(C`_ptr\*(C'\fR or |
| 202 |
\&\f(CW\*(C`_hook\*(C'\fR) are reserved for internal uses and must not be accessed or |
| 203 |
modified). |
| 204 |
.PP |
| 205 |
When objects are destroyed on the \*(C+ side, the perl object hashes are |
| 206 |
emptied, so its best to store related objects such as time watchers and |
| 207 |
the like inside the terminal object so they get destroyed as soon as the |
| 208 |
terminal is destroyed. |
| 209 |
.Sh "Hooks" |
| 210 |
.IX Subsection "Hooks" |
| 211 |
The following subroutines can be declared in loaded scripts, and will be called |
| 212 |
whenever the relevant event happens. |
| 213 |
.PP |
| 214 |
All of them must return a boolean value. If it is true, then the event |
| 215 |
counts as being \fIconsumed\fR, and the invocation of other hooks is skipped, |
| 216 |
and the relevant action might not be carried out by the \*(C+ code. |
| 217 |
.PP |
| 218 |
When in doubt, return a false value (preferably \f(CW\*(C`()\*(C'\fR). |
| 219 |
.ie n .IP "on_init $term" 4 |
| 220 |
.el .IP "on_init \f(CW$term\fR" 4 |
| 221 |
.IX Item "on_init $term" |
| 222 |
Called after a new terminal object has been initialized, but before |
| 223 |
windows are created or the command gets run. |
| 224 |
.ie n .IP "on_reset $term" 4 |
| 225 |
.el .IP "on_reset \f(CW$term\fR" 4 |
| 226 |
.IX Item "on_reset $term" |
| 227 |
Called after the screen is \*(L"reset\*(R" for any reason, such as resizing or |
| 228 |
control sequences. Here is where you can react on changes to size-related |
| 229 |
variables. |
| 230 |
.ie n .IP "on_start $term" 4 |
| 231 |
.el .IP "on_start \f(CW$term\fR" 4 |
| 232 |
.IX Item "on_start $term" |
| 233 |
Called at the very end of initialisation of a new terminal, just before |
| 234 |
returning to the mainloop. |
| 235 |
.ie n .IP "on_sel_make $term\fR, \f(CW$eventtime" 4 |
| 236 |
.el .IP "on_sel_make \f(CW$term\fR, \f(CW$eventtime\fR" 4 |
| 237 |
.IX Item "on_sel_make $term, $eventtime" |
| 238 |
Called whenever a selection has been made by the user, but before the |
| 239 |
selection text is copied, so changes to the beginning, end or type of the |
| 240 |
selection will be honored. |
| 241 |
.Sp |
| 242 |
Returning a true value aborts selection making by urxvt, in which case you |
| 243 |
have to make a selection yourself by calling \f(CW\*(C`$term\->selection_grab\*(C'\fR. |
| 244 |
.ie n .IP "on_sel_grab $term\fR, \f(CW$eventtime" 4 |
| 245 |
.el .IP "on_sel_grab \f(CW$term\fR, \f(CW$eventtime\fR" 4 |
| 246 |
.IX Item "on_sel_grab $term, $eventtime" |
| 247 |
Called whenever a selection has been copied, but before the selection is |
| 248 |
requested from the server. The selection text can be queried and changed |
| 249 |
by calling \f(CW\*(C`$term\->selection\*(C'\fR. |
| 250 |
.Sp |
| 251 |
Returning a true value aborts selection grabbing. It will still be hilighted. |
| 252 |
.ie n .IP "on_focus_in $term" 4 |
| 253 |
.el .IP "on_focus_in \f(CW$term\fR" 4 |
| 254 |
.IX Item "on_focus_in $term" |
| 255 |
Called whenever the window gets the keyboard focus, before urxvt does |
| 256 |
focus in processing. |
| 257 |
.ie n .IP "on_focus_out $term" 4 |
| 258 |
.el .IP "on_focus_out \f(CW$term\fR" 4 |
| 259 |
.IX Item "on_focus_out $term" |
| 260 |
Called wheneever the window loses keyboard focus, before urxvt does focus |
| 261 |
out processing. |
| 262 |
.ie n .IP "on_view_change $term\fR, \f(CW$offset" 4 |
| 263 |
.el .IP "on_view_change \f(CW$term\fR, \f(CW$offset\fR" 4 |
| 264 |
.IX Item "on_view_change $term, $offset" |
| 265 |
Called whenever the view offset changes, i..e the user or program |
| 266 |
scrolls. Offset \f(CW0\fR means display the normal terminal, positive values |
| 267 |
show this many lines of scrollback. |
| 268 |
.ie n .IP "on_scroll_back $term\fR, \f(CW$lines\fR, \f(CW$saved" 4 |
| 269 |
.el .IP "on_scroll_back \f(CW$term\fR, \f(CW$lines\fR, \f(CW$saved\fR" 4 |
| 270 |
.IX Item "on_scroll_back $term, $lines, $saved" |
| 271 |
Called whenever lines scroll out of the terminal area into the scrollback |
| 272 |
buffer. \f(CW$lines\fR is the number of lines scrolled out and may be larger |
| 273 |
than the scroll back buffer or the terminal. |
| 274 |
.Sp |
| 275 |
It is called before lines are scrolled out (so rows 0 .. min ($lines \- 1, |
| 276 |
\&\f(CW$nrow\fR \- 1) represent the lines to be scrolled out). \f(CW$saved\fR is the total |
| 277 |
number of lines that will be in the scrollback buffer. |
| 278 |
.ie n .IP "on_tty_activity $term *NYI*" 4 |
| 279 |
.el .IP "on_tty_activity \f(CW$term\fR *NYI*" 4 |
| 280 |
.IX Item "on_tty_activity $term *NYI*" |
| 281 |
Called whenever the program(s) running in the urxvt window send output. |
| 282 |
.ie n .IP "on_refresh_begin $term" 4 |
| 283 |
.el .IP "on_refresh_begin \f(CW$term\fR" 4 |
| 284 |
.IX Item "on_refresh_begin $term" |
| 285 |
Called just before the screen gets redrawn. Can be used for overlay |
| 286 |
or similar effects by modify terminal contents in refresh_begin, and |
| 287 |
restoring them in refresh_end. The built-in overlay and selection display |
| 288 |
code is run after this hook, and takes precedence. |
| 289 |
.ie n .IP "on_refresh_end $term" 4 |
| 290 |
.el .IP "on_refresh_end \f(CW$term\fR" 4 |
| 291 |
.IX Item "on_refresh_end $term" |
| 292 |
Called just after the screen gets redrawn. See \f(CW\*(C`on_refresh_begin\*(C'\fR. |
| 293 |
.ie n .IP "on_keyboard_command $term\fR, \f(CW$string" 4 |
| 294 |
.el .IP "on_keyboard_command \f(CW$term\fR, \f(CW$string\fR" 4 |
| 295 |
.IX Item "on_keyboard_command $term, $string" |
| 296 |
Called whenever the user presses a key combination that has a |
| 297 |
\&\f(CW\*(C`perl:string\*(C'\fR action bound to it (see description of the \fBkeysym\fR |
| 298 |
resource in the @@RXVT_NAME@@(1) manpage). |
| 299 |
.ie n .Sh "Functions in the ""urxvt"" Package" |
| 300 |
.el .Sh "Functions in the \f(CWurxvt\fP Package" |
| 301 |
.IX Subsection "Functions in the urxvt Package" |
| 302 |
.ie n .IP "urxvt::fatal $errormessage" 4 |
| 303 |
.el .IP "urxvt::fatal \f(CW$errormessage\fR" 4 |
| 304 |
.IX Item "urxvt::fatal $errormessage" |
| 305 |
Fatally aborts execution with the given error message. Avoid at all |
| 306 |
costs! The only time this is acceptable is when the terminal process |
| 307 |
starts up. |
| 308 |
.ie n .IP "urxvt::warn $string" 4 |
| 309 |
.el .IP "urxvt::warn \f(CW$string\fR" 4 |
| 310 |
.IX Item "urxvt::warn $string" |
| 311 |
Calls \f(CW\*(C`rxvt_warn\*(C'\fR with the given string which should not include a |
| 312 |
newline. The module also overwrites the \f(CW\*(C`warn\*(C'\fR builtin with a function |
| 313 |
that calls this function. |
| 314 |
.Sp |
| 315 |
Using this function has the advantage that its output ends up in the |
| 316 |
correct place, e.g. on stderr of the connecting urxvtc client. |
| 317 |
.IP "$time = urxvt::NOW" 4 |
| 318 |
.IX Item "$time = urxvt::NOW" |
| 319 |
Returns the \*(L"current time\*(R" (as per the event loop). |
| 320 |
.Sh "\s-1RENDITION\s0" |
| 321 |
.IX Subsection "RENDITION" |
| 322 |
Rendition bitsets contain information about colour, font, font styles and |
| 323 |
similar information for each screen cell. |
| 324 |
.PP |
| 325 |
The following \*(L"macros\*(R" deal with changes in rendition sets. You should |
| 326 |
never just create a bitset, you should always modify an existing one, |
| 327 |
as they contain important information required for correct operation of |
| 328 |
rxvt\-unicode. |
| 329 |
.IP "$rend = urxvt::DEFAULT_RSTYLE" 4 |
| 330 |
.IX Item "$rend = urxvt::DEFAULT_RSTYLE" |
| 331 |
Returns the default rendition, as used when the terminal is starting up or |
| 332 |
being reset. Useful as a base to start when creating renditions. |
| 333 |
.IP "$rend = urxvt::OVERLAY_RSTYLE" 4 |
| 334 |
.IX Item "$rend = urxvt::OVERLAY_RSTYLE" |
| 335 |
Return the rendition mask used for overlays by default. |
| 336 |
.IP "$rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline" 4 |
| 337 |
.IX Item "$rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline" |
| 338 |
Return the bit that enabled bold, italic, blink, reverse-video and |
| 339 |
underline, respectively. To enable such a style, just logically \s-1OR\s0 it into |
| 340 |
the bitset. |
| 341 |
.ie n .IP "$foreground = urxvt::GET_BASEFG $rend" 4 |
| 342 |
.el .IP "$foreground = urxvt::GET_BASEFG \f(CW$rend\fR" 4 |
| 343 |
.IX Item "$foreground = urxvt::GET_BASEFG $rend" |
| 344 |
.PD 0 |
| 345 |
.ie n .IP "$background = urxvt::GET_BASEBG $rend" 4 |
| 346 |
.el .IP "$background = urxvt::GET_BASEBG \f(CW$rend\fR" 4 |
| 347 |
.IX Item "$background = urxvt::GET_BASEBG $rend" |
| 348 |
.PD |
| 349 |
Return the foreground/background colour index, respectively. |
| 350 |
.ie n .IP "$rend = urxvt::SET_FGCOLOR ($rend, $new_colour)" 4 |
| 351 |
.el .IP "$rend = urxvt::SET_FGCOLOR ($rend, \f(CW$new_colour\fR)" 4 |
| 352 |
.IX Item "$rend = urxvt::SET_FGCOLOR ($rend, $new_colour)" |
| 353 |
.PD 0 |
| 354 |
.ie n .IP "$rend = urxvt::SET_BGCOLOR ($rend, $new_colour)" 4 |
| 355 |
.el .IP "$rend = urxvt::SET_BGCOLOR ($rend, \f(CW$new_colour\fR)" 4 |
| 356 |
.IX Item "$rend = urxvt::SET_BGCOLOR ($rend, $new_colour)" |
| 357 |
.PD |
| 358 |
Replace the foreground/background colour in the rendition mask with the |
| 359 |
specified one. |
| 360 |
.IP "$value = urxvt::GET_CUSTOM ($rend)" 4 |
| 361 |
.IX Item "$value = urxvt::GET_CUSTOM ($rend)" |
| 362 |
Return the \*(L"custom\*(R" value: Every rendition has 5 bits for use by |
| 363 |
extensions. They can be set and changed as you like and are initially |
| 364 |
zero. |
| 365 |
.ie n .IP "$rend = urxvt::SET_CUSTOM ($rend, $new_value)" 4 |
| 366 |
.el .IP "$rend = urxvt::SET_CUSTOM ($rend, \f(CW$new_value\fR)" 4 |
| 367 |
.IX Item "$rend = urxvt::SET_CUSTOM ($rend, $new_value)" |
| 368 |
Change the custom value. |
| 369 |
.ie n .Sh "The ""urxvt::term"" Class" |
| 370 |
.el .Sh "The \f(CWurxvt::term\fP Class" |
| 371 |
.IX Subsection "The urxvt::term Class" |
| 372 |
.ie n .IP "$value = $term\fR\->resource ($name[, \f(CW$newval])" 4 |
| 373 |
.el .IP "$value = \f(CW$term\fR\->resource ($name[, \f(CW$newval\fR])" 4 |
| 374 |
.IX Item "$value = $term->resource ($name[, $newval])" |
| 375 |
Returns the current resource value associated with a given name and |
| 376 |
optionally sets a new value. Setting values is most useful in the \f(CW\*(C`init\*(C'\fR |
| 377 |
hook. Unset resources are returned and accepted as \f(CW\*(C`undef\*(C'\fR. |
| 378 |
.Sp |
| 379 |
The new value must be properly encoded to a suitable character encoding |
| 380 |
before passing it to this method. Similarly, the returned value may need |
| 381 |
to be converted from the used encoding to text. |
| 382 |
.Sp |
| 383 |
Resource names are as defined in \fIsrc/rsinc.h\fR. Colours can be specified |
| 384 |
as resource names of the form \f(CW\*(C`color+<index>\*(C'\fR, e.g. \f(CW\*(C`color+5\*(C'\fR. (will |
| 385 |
likely change). |
| 386 |
.Sp |
| 387 |
Please note that resource strings will currently only be freed when the |
| 388 |
terminal is destroyed, so changing options frequently will eat memory. |
| 389 |
.Sp |
| 390 |
Here is a a likely non-exhaustive list of resource names, not all of which |
| 391 |
are supported in every build, please see the source to see the actual |
| 392 |
list: |
| 393 |
.Sp |
| 394 |
.Vb 12 |
| 395 |
\& answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
| 396 |
\& borderLess color cursorBlink cursorUnderline cutchars delete_key |
| 397 |
\& display_name embed ext_bwidth fade font geometry hold iconName |
| 398 |
\& imFont imLocale inputMethod insecure int_bwidth intensityStyles |
| 399 |
\& italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
| 400 |
\& mouseWheelScrollPage name pastableTabs path perl_eval perl_ext |
| 401 |
\& perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
| 402 |
\& reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
| 403 |
\& scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
| 404 |
\& scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
| 405 |
\& shade term_name title transparent transparent_all tripleclickwords |
| 406 |
\& utmpInhibit visualBell |
| 407 |
.Ve |
| 408 |
.ie n .IP "($row, $col\fR) = \f(CW$term\fR\->selection_mark ([$row, \f(CW$col])" 4 |
| 409 |
.el .IP "($row, \f(CW$col\fR) = \f(CW$term\fR\->selection_mark ([$row, \f(CW$col\fR])" 4 |
| 410 |
.IX Item "($row, $col) = $term->selection_mark ([$row, $col])" |
| 411 |
.PD 0 |
| 412 |
.ie n .IP "($row, $col\fR) = \f(CW$term\fR\->selection_beg ([$row, \f(CW$col])" 4 |
| 413 |
.el .IP "($row, \f(CW$col\fR) = \f(CW$term\fR\->selection_beg ([$row, \f(CW$col\fR])" 4 |
| 414 |
.IX Item "($row, $col) = $term->selection_beg ([$row, $col])" |
| 415 |
.ie n .IP "($row, $col\fR) = \f(CW$term\fR\->selection_end ([$row, \f(CW$col])" 4 |
| 416 |
.el .IP "($row, \f(CW$col\fR) = \f(CW$term\fR\->selection_end ([$row, \f(CW$col\fR])" 4 |
| 417 |
.IX Item "($row, $col) = $term->selection_end ([$row, $col])" |
| 418 |
.PD |
| 419 |
Return the current values of the selection mark, begin or end positions, |
| 420 |
and optionally set them to new values. |
| 421 |
.ie n .IP "$success = $term\->selection_grab ($eventtime)" 4 |
| 422 |
.el .IP "$success = \f(CW$term\fR\->selection_grab ($eventtime)" 4 |
| 423 |
.IX Item "$success = $term->selection_grab ($eventtime)" |
| 424 |
Try to request the primary selection from the server (for example, as set |
| 425 |
by the next method). |
| 426 |
.ie n .IP "$oldtext = $term\->selection ([$newtext])" 4 |
| 427 |
.el .IP "$oldtext = \f(CW$term\fR\->selection ([$newtext])" 4 |
| 428 |
.IX Item "$oldtext = $term->selection ([$newtext])" |
| 429 |
Return the current selection text and optionally replace it by \f(CW$newtext\fR. |
| 430 |
.Sp |
| 431 |
#=item \f(CW$term\fR\->overlay ($x, \f(CW$y\fR, \f(CW$text\fR) |
| 432 |
# |
| 433 |
#Create a simple multi-line overlay box. See the next method for details. |
| 434 |
# |
| 435 |
#=cut |
| 436 |
.Sp |
| 437 |
sub urxvt::term::scr_overlay { |
| 438 |
die; |
| 439 |
my ($self, \f(CW$x\fR, \f(CW$y\fR, \f(CW$text\fR) = \f(CW@_\fR; |
| 440 |
.Sp |
| 441 |
.Vb 1 |
| 442 |
\& my @lines = split /\en/, $text; |
| 443 |
.Ve |
| 444 |
.Sp |
| 445 |
.Vb 4 |
| 446 |
\& my $w = 0; |
| 447 |
\& for (map $self->strwidth ($_), @lines) { |
| 448 |
\& $w = $_ if $w < $_; |
| 449 |
\& } |
| 450 |
.Ve |
| 451 |
.Sp |
| 452 |
.Vb 3 |
| 453 |
\& $self->scr_overlay_new ($x, $y, $w, scalar @lines); |
| 454 |
\& $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; |
| 455 |
\&} |
| 456 |
.Ve |
| 457 |
.ie n .IP "$term\->overlay ($x, $y\fR, \f(CW$width\fR, \f(CW$height\fR[, \f(CW$rstyle\fR[, \f(CW$border]])" 4 |
| 458 |
.el .IP "$term\->overlay ($x, \f(CW$y\fR, \f(CW$width\fR, \f(CW$height\fR[, \f(CW$rstyle\fR[, \f(CW$border\fR]])" 4 |
| 459 |
.IX Item "$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])" |
| 460 |
Create a new (empty) overlay at the given position with the given |
| 461 |
width/height. \f(CW$rstyle\fR defines the initial rendition style |
| 462 |
(default: \f(CW\*(C`OVERLAY_RSTYLE\*(C'\fR). |
| 463 |
.Sp |
| 464 |
If \f(CW$border\fR is \f(CW2\fR (default), then a decorative border will be put |
| 465 |
around the box. |
| 466 |
.Sp |
| 467 |
If either \f(CW$x\fR or \f(CW$y\fR is negative, then this is counted from the |
| 468 |
right/bottom side, respectively. |
| 469 |
.Sp |
| 470 |
This method returns an urxvt::overlay object. The overlay will be visible |
| 471 |
as long as the perl object is referenced. |
| 472 |
.Sp |
| 473 |
Currently, the only method on the \f(CW\*(C`urxvt::overlay\*(C'\fR object is \f(CW\*(C`set\*(C'\fR: |
| 474 |
.ie n .IP "$overlay\->set ($x, $y\fR, \f(CW$text\fR, \f(CW$rend)" 4 |
| 475 |
.el .IP "$overlay\->set ($x, \f(CW$y\fR, \f(CW$text\fR, \f(CW$rend\fR)" 4 |
| 476 |
.IX Item "$overlay->set ($x, $y, $text, $rend)" |
| 477 |
Similar to \f(CW\*(C`$term\->ROW_t\*(C'\fR and \f(CW\*(C`$term\->ROW_r\*(C'\fR in that it puts |
| 478 |
text in rxvt\-unicode's special encoding and an array of rendition values |
| 479 |
at a specific position inside the overlay. |
| 480 |
.ie n .IP "$cellwidth = $term\fR\->strwidth \f(CW$string" 4 |
| 481 |
.el .IP "$cellwidth = \f(CW$term\fR\->strwidth \f(CW$string\fR" 4 |
| 482 |
.IX Item "$cellwidth = $term->strwidth $string" |
| 483 |
Returns the number of screen-cells this string would need. Correctly |
| 484 |
accounts for wide and combining characters. |
| 485 |
.ie n .IP "$octets = $term\fR\->locale_encode \f(CW$string" 4 |
| 486 |
.el .IP "$octets = \f(CW$term\fR\->locale_encode \f(CW$string\fR" 4 |
| 487 |
.IX Item "$octets = $term->locale_encode $string" |
| 488 |
Convert the given text string into the corresponding locale encoding. |
| 489 |
.ie n .IP "$string = $term\fR\->locale_decode \f(CW$octets" 4 |
| 490 |
.el .IP "$string = \f(CW$term\fR\->locale_decode \f(CW$octets\fR" 4 |
| 491 |
.IX Item "$string = $term->locale_decode $octets" |
| 492 |
Convert the given locale-encoded octets into a perl string. |
| 493 |
.IP "$term\->tt_write ($octets)" 4 |
| 494 |
.IX Item "$term->tt_write ($octets)" |
| 495 |
Write the octets given in \f(CW$data\fR to the tty (i.e. as program input). To |
| 496 |
pass characters instead of octets, you should convert your strings first |
| 497 |
to the locale-specific encoding using \f(CW\*(C`$term\->locale_encode\*(C'\fR. |
| 498 |
.ie n .IP "$nrow = $term\->nrow" 4 |
| 499 |
.el .IP "$nrow = \f(CW$term\fR\->nrow" 4 |
| 500 |
.IX Item "$nrow = $term->nrow" |
| 501 |
.PD 0 |
| 502 |
.ie n .IP "$ncol = $term\->ncol" 4 |
| 503 |
.el .IP "$ncol = \f(CW$term\fR\->ncol" 4 |
| 504 |
.IX Item "$ncol = $term->ncol" |
| 505 |
.PD |
| 506 |
Return the number of rows/columns of the terminal window (i.e. as |
| 507 |
specified by \f(CW\*(C`\-geometry\*(C'\fR, excluding any scrollback). |
| 508 |
.ie n .IP "$nsaved = $term\->nsaved" 4 |
| 509 |
.el .IP "$nsaved = \f(CW$term\fR\->nsaved" 4 |
| 510 |
.IX Item "$nsaved = $term->nsaved" |
| 511 |
Returns the number of lines in the scrollback buffer. |
| 512 |
.ie n .IP "$view_start = $term\->view_start ([$newvalue])" 4 |
| 513 |
.el .IP "$view_start = \f(CW$term\fR\->view_start ([$newvalue])" 4 |
| 514 |
.IX Item "$view_start = $term->view_start ([$newvalue])" |
| 515 |
Returns the negative row number of the topmost line. Minimum value is |
| 516 |
\&\f(CW0\fR, which displays the normal terminal contents. Larger values scroll |
| 517 |
this many lines into the scrollback buffer. |
| 518 |
.IP "$term\->want_refresh" 4 |
| 519 |
.IX Item "$term->want_refresh" |
| 520 |
Requests a screen refresh. At the next opportunity, rxvt-unicode will |
| 521 |
compare the on-screen display with its stored representation. If they |
| 522 |
differ, it redraws the differences. |
| 523 |
.Sp |
| 524 |
Used after changing terminal contents to display them. |
| 525 |
.ie n .IP "$text = $term\fR\->ROW_t ($row_number[, \f(CW$new_text\fR[, \f(CW$start_col]])" 4 |
| 526 |
.el .IP "$text = \f(CW$term\fR\->ROW_t ($row_number[, \f(CW$new_text\fR[, \f(CW$start_col\fR]])" 4 |
| 527 |
.IX Item "$text = $term->ROW_t ($row_number[, $new_text[, $start_col]])" |
| 528 |
Returns the text of the entire row with number \f(CW$row_number\fR. Row \f(CW0\fR |
| 529 |
is the topmost terminal line, row \f(CW\*(C`$term\->$ncol\-1\*(C'\fR is the bottommost |
| 530 |
terminal line. The scrollback buffer starts at line \f(CW\*(C`\-1\*(C'\fR and extends to |
| 531 |
line \f(CW\*(C`\-$term\->nsaved\*(C'\fR. |
| 532 |
.Sp |
| 533 |
If \f(CW$new_text\fR is specified, it will replace characters in the current |
| 534 |
line, starting at column \f(CW$start_col\fR (default \f(CW0\fR), which is useful |
| 535 |
to replace only parts of a line. The font index in the rendition will |
| 536 |
automatically be updated. |
| 537 |
.Sp |
| 538 |
\&\f(CW$text\fR is in a special encoding: tabs and wide characters that use more |
| 539 |
than one cell when displayed are padded with urxvt::NOCHAR characters |
| 540 |
(\f(CW\*(C`chr 65535\*(C'\fR). Characters with combining characters and other characters |
| 541 |
that do not fit into the normal tetx encoding will be replaced with |
| 542 |
characters in the private use area. |
| 543 |
.Sp |
| 544 |
You have to obey this encoding when changing text. The advantage is |
| 545 |
that \f(CW\*(C`substr\*(C'\fR and similar functions work on screen cells and not on |
| 546 |
characters. |
| 547 |
.Sp |
| 548 |
The methods \f(CW\*(C`$term\->special_encode\*(C'\fR and \f(CW\*(C`$term\->special_decode\*(C'\fR |
| 549 |
can be used to convert normal strings into this encoding and vice versa. |
| 550 |
.ie n .IP "$rend = $term\fR\->ROW_r ($row_number[, \f(CW$new_rend\fR[, \f(CW$start_col]])" 4 |
| 551 |
.el .IP "$rend = \f(CW$term\fR\->ROW_r ($row_number[, \f(CW$new_rend\fR[, \f(CW$start_col\fR]])" 4 |
| 552 |
.IX Item "$rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])" |
| 553 |
Like \f(CW\*(C`$term\->ROW_t\*(C'\fR, but returns an arrayref with rendition |
| 554 |
bitsets. Rendition bitsets contain information about colour, font, font |
| 555 |
styles and similar information. See also \f(CW\*(C`$term\->ROW_t\*(C'\fR. |
| 556 |
.Sp |
| 557 |
When setting rendition, the font mask will be ignored. |
| 558 |
.Sp |
| 559 |
See the section on \s-1RENDITION\s0, above. |
| 560 |
.ie n .IP "$length = $term\fR\->ROW_l ($row_number[, \f(CW$new_length])" 4 |
| 561 |
.el .IP "$length = \f(CW$term\fR\->ROW_l ($row_number[, \f(CW$new_length\fR])" 4 |
| 562 |
.IX Item "$length = $term->ROW_l ($row_number[, $new_length])" |
| 563 |
Returns the number of screen cells that are in use (\*(L"the line length\*(R"). If |
| 564 |
it is \f(CW\*(C`\-1\*(C'\fR, then the line is part of a multiple-row logical \*(L"line\*(R", which |
| 565 |
means all characters are in use and it is continued on the next row. |
| 566 |
.ie n .IP "$text = $term\fR\->special_encode \f(CW$string" 4 |
| 567 |
.el .IP "$text = \f(CW$term\fR\->special_encode \f(CW$string\fR" 4 |
| 568 |
.IX Item "$text = $term->special_encode $string" |
| 569 |
Converts a perl string into the special encoding used by rxvt\-unicode, |
| 570 |
where one character corresponds to one screen cell. See |
| 571 |
\&\f(CW\*(C`$term\->ROW_t\*(C'\fR for details. |
| 572 |
.ie n .IP "$string = $term\fR\->special_decode \f(CW$text" 4 |
| 573 |
.el .IP "$string = \f(CW$term\fR\->special_decode \f(CW$text\fR" 4 |
| 574 |
.IX Item "$string = $term->special_decode $text" |
| 575 |
Converts rxvt-unicodes text reprsentation into a perl string. See |
| 576 |
\&\f(CW\*(C`$term\->ROW_t\*(C'\fR for details. |
| 577 |
.ie n .Sh "The ""urxvt::timer"" Class" |
| 578 |
.el .Sh "The \f(CWurxvt::timer\fP Class" |
| 579 |
.IX Subsection "The urxvt::timer Class" |
| 580 |
This class implements timer watchers/events. Time is represented as a |
| 581 |
fractional number of seconds since the epoch. Example: |
| 582 |
.PP |
| 583 |
.Vb 8 |
| 584 |
\& $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0); |
| 585 |
\& $term->{timer} = urxvt::timer |
| 586 |
\& ->new |
| 587 |
\& ->interval (1) |
| 588 |
\& ->cb (sub { |
| 589 |
\& $term->{overlay}->set (0, 0, |
| 590 |
\& sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
| 591 |
\& }); |
| 592 |
.Ve |
| 593 |
.IP "$timer = new urxvt::timer" 4 |
| 594 |
.IX Item "$timer = new urxvt::timer" |
| 595 |
Create a new timer object in started state. It is scheduled to fire |
| 596 |
immediately. |
| 597 |
.ie n .IP "$timer = $timer\fR\->cb (sub { my ($timer) = \f(CW@_; ... })" 4 |
| 598 |
.el .IP "$timer = \f(CW$timer\fR\->cb (sub { my ($timer) = \f(CW@_\fR; ... })" 4 |
| 599 |
.IX Item "$timer = $timer->cb (sub { my ($timer) = @_; ... })" |
| 600 |
Set the callback to be called when the timer triggers. |
| 601 |
.ie n .IP "$tstamp = $timer\->at" 4 |
| 602 |
.el .IP "$tstamp = \f(CW$timer\fR\->at" 4 |
| 603 |
.IX Item "$tstamp = $timer->at" |
| 604 |
Return the time this watcher will fire next. |
| 605 |
.ie n .IP "$timer = $timer\->set ($tstamp)" 4 |
| 606 |
.el .IP "$timer = \f(CW$timer\fR\->set ($tstamp)" 4 |
| 607 |
.IX Item "$timer = $timer->set ($tstamp)" |
| 608 |
Set the time the event is generated to \f(CW$tstamp\fR. |
| 609 |
.ie n .IP "$timer = $timer\->interval ($interval)" 4 |
| 610 |
.el .IP "$timer = \f(CW$timer\fR\->interval ($interval)" 4 |
| 611 |
.IX Item "$timer = $timer->interval ($interval)" |
| 612 |
Normally (and when \f(CW$interval\fR is \f(CW0\fR), the timer will automatically |
| 613 |
stop after it has fired once. If \f(CW$interval\fR is non\-zero, then the timer |
| 614 |
is automatically rescheduled at the given intervals. |
| 615 |
.ie n .IP "$timer = $timer\->start" 4 |
| 616 |
.el .IP "$timer = \f(CW$timer\fR\->start" 4 |
| 617 |
.IX Item "$timer = $timer->start" |
| 618 |
Start the timer. |
| 619 |
.ie n .IP "$timer = $timer\->start ($tstamp)" 4 |
| 620 |
.el .IP "$timer = \f(CW$timer\fR\->start ($tstamp)" 4 |
| 621 |
.IX Item "$timer = $timer->start ($tstamp)" |
| 622 |
Set the event trigger time to \f(CW$tstamp\fR and start the timer. |
| 623 |
.ie n .IP "$timer = $timer\->stop" 4 |
| 624 |
.el .IP "$timer = \f(CW$timer\fR\->stop" 4 |
| 625 |
.IX Item "$timer = $timer->stop" |
| 626 |
Stop the timer. |
| 627 |
.ie n .Sh "The ""urxvt::iow"" Class" |
| 628 |
.el .Sh "The \f(CWurxvt::iow\fP Class" |
| 629 |
.IX Subsection "The urxvt::iow Class" |
| 630 |
This class implements io watchers/events. Example: |
| 631 |
.PP |
| 632 |
.Vb 12 |
| 633 |
\& $term->{socket} = ... |
| 634 |
\& $term->{iow} = urxvt::iow |
| 635 |
\& ->new |
| 636 |
\& ->fd (fileno $term->{socket}) |
| 637 |
\& ->events (1) # wait for read data |
| 638 |
\& ->start |
| 639 |
\& ->cb (sub { |
| 640 |
\& my ($iow, $revents) = @_; |
| 641 |
\& # $revents must be 1 here, no need to check |
| 642 |
\& sysread $term->{socket}, my $buf, 8192 |
| 643 |
\& or end-of-file; |
| 644 |
\& }); |
| 645 |
.Ve |
| 646 |
.IP "$iow = new urxvt::iow" 4 |
| 647 |
.IX Item "$iow = new urxvt::iow" |
| 648 |
Create a new io watcher object in stopped state. |
| 649 |
.ie n .IP "$iow = $iow\fR\->cb (sub { my ($iow, \f(CW$reventmask\fR) = \f(CW@_; ... })" 4 |
| 650 |
.el .IP "$iow = \f(CW$iow\fR\->cb (sub { my ($iow, \f(CW$reventmask\fR) = \f(CW@_\fR; ... })" 4 |
| 651 |
.IX Item "$iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... })" |
| 652 |
Set the callback to be called when io events are triggered. \f(CW$reventmask\fR |
| 653 |
is a bitset as described in the \f(CW\*(C`events\*(C'\fR method. |
| 654 |
.ie n .IP "$iow = $iow\->fd ($fd)" 4 |
| 655 |
.el .IP "$iow = \f(CW$iow\fR\->fd ($fd)" 4 |
| 656 |
.IX Item "$iow = $iow->fd ($fd)" |
| 657 |
Set the filedescriptor (not handle) to watch. |
| 658 |
.ie n .IP "$iow = $iow\->events ($eventmask)" 4 |
| 659 |
.el .IP "$iow = \f(CW$iow\fR\->events ($eventmask)" 4 |
| 660 |
.IX Item "$iow = $iow->events ($eventmask)" |
| 661 |
Set the event mask to watch. Bit #0 (value \f(CW1\fR) enables watching for read |
| 662 |
data, Bit #1 (value \f(CW2\fR) enables watching for write data. |
| 663 |
.ie n .IP "$iow = $iow\->start" 4 |
| 664 |
.el .IP "$iow = \f(CW$iow\fR\->start" 4 |
| 665 |
.IX Item "$iow = $iow->start" |
| 666 |
Start watching for requested events on the given handle. |
| 667 |
.ie n .IP "$iow = $iow\->stop" 4 |
| 668 |
.el .IP "$iow = \f(CW$iow\fR\->stop" 4 |
| 669 |
.IX Item "$iow = $iow->stop" |
| 670 |
Stop watching for events on the given filehandle. |
| 671 |
.SH "ENVIRONMENT" |
| 672 |
.IX Header "ENVIRONMENT" |
| 673 |
.Sh "\s-1URXVT_PERL_VERBOSITY\s0" |
| 674 |
.IX Subsection "URXVT_PERL_VERBOSITY" |
| 675 |
This variable controls the verbosity level of the perl extension. Higher |
| 676 |
numbers indicate more verbose output. |
| 677 |
.IP "0 \- only fatal messages" 4 |
| 678 |
.IX Item "0 - only fatal messages" |
| 679 |
.PD 0 |
| 680 |
.IP "3 \- script loading and management" 4 |
| 681 |
.IX Item "3 - script loading and management" |
| 682 |
.IP "10 \- all events received" 4 |
| 683 |
.IX Item "10 - all events received" |
| 684 |
.PD |
| 685 |
.SH "AUTHOR" |
| 686 |
.IX Header "AUTHOR" |
| 687 |
.Vb 2 |
| 688 |
\& Marc Lehmann <pcg@goof.com> |
| 689 |
\& http://software.schmorp.de/pkg/rxvt-unicode |
| 690 |
.Ve |
