| 1 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> |
| 2 |
<html xmlns="http://www.w3.org/1999/xhtml"> |
| 3 |
<head> |
| 4 |
<title>rxvtperl - rxvt-unicode's embedded perl interpreter</title> |
| 5 |
<link rev="made" href="mailto:perl-binary@plan9.de" /> |
| 6 |
</head> |
| 7 |
|
| 8 |
<body style="background-color: white"> |
| 9 |
|
| 10 |
<p><a name="__index__"></a></p> |
| 11 |
<!-- INDEX BEGIN --> |
| 12 |
|
| 13 |
<ul> |
| 14 |
|
| 15 |
<li><a href="#name">NAME</a></li> |
| 16 |
<li><a href="#synopsis">SYNOPSIS</a></li> |
| 17 |
<li><a href="#description">DESCRIPTION</a></li> |
| 18 |
<ul> |
| 19 |
|
| 20 |
<li><a href="#prepackaged_extensions">Prepackaged Extensions</a></li> |
| 21 |
<li><a href="#general_api_considerations">General API Considerations</a></li> |
| 22 |
<li><a href="#hooks">Hooks</a></li> |
| 23 |
<li><a href="#variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></li> |
| 24 |
<li><a href="#functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></li> |
| 25 |
<li><a href="#rendition">RENDITION</a></li> |
| 26 |
<li><a href="#the_urxvt__term_class">The <code>urxvt::term</code> Class</a></li> |
| 27 |
<li><a href="#the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></li> |
| 28 |
<li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li> |
| 29 |
</ul> |
| 30 |
|
| 31 |
<li><a href="#environment">ENVIRONMENT</a></li> |
| 32 |
<ul> |
| 33 |
|
| 34 |
<li><a href="#urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></li> |
| 35 |
</ul> |
| 36 |
|
| 37 |
<li><a href="#author">AUTHOR</a></li> |
| 38 |
</ul> |
| 39 |
<!-- INDEX END --> |
| 40 |
|
| 41 |
<hr /> |
| 42 |
<p> |
| 43 |
</p> |
| 44 |
<hr /> |
| 45 |
<h1><a name="name">NAME</a></h1> |
| 46 |
<p>rxvtperl - rxvt-unicode's embedded perl interpreter</p> |
| 47 |
<p> |
| 48 |
</p> |
| 49 |
<hr /> |
| 50 |
<h1><a name="synopsis">SYNOPSIS</a></h1> |
| 51 |
<pre> |
| 52 |
# create a file grab_test in $HOME:</pre> |
| 53 |
<pre> |
| 54 |
sub on_sel_grab { |
| 55 |
warn "you selected ", $_[0]->selection; |
| 56 |
() |
| 57 |
}</pre> |
| 58 |
<pre> |
| 59 |
# start a rxvt using it:</pre> |
| 60 |
<pre> |
| 61 |
rxvt --perl-lib $HOME -pe grab_test</pre> |
| 62 |
<p> |
| 63 |
</p> |
| 64 |
<hr /> |
| 65 |
<h1><a name="description">DESCRIPTION</a></h1> |
| 66 |
<p>Everytime a terminal object gets created, scripts specified via the |
| 67 |
<code>perl</code> resource are loaded and associated with it.</p> |
| 68 |
<p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and |
| 69 |
thus must be encoded as UTF-8.</p> |
| 70 |
<p>Each script will only ever be loaded once, even in rxvtd, where |
| 71 |
scripts will be shared (but not enabled) for all terminals.</p> |
| 72 |
<p> |
| 73 |
</p> |
| 74 |
<h2><a name="prepackaged_extensions">Prepackaged Extensions</a></h2> |
| 75 |
<p>This section describes the extensiosn delivered with this version. You can |
| 76 |
find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> |
| 77 |
<p>You can activate them like this:</p> |
| 78 |
<pre> |
| 79 |
rxvt -pe <extensionname></pre> |
| 80 |
<dl> |
| 81 |
<dt><strong><a name="item_selection">selection</a></strong><br /> |
| 82 |
</dt> |
| 83 |
<dd> |
| 84 |
Intelligent selection. This extension tries to be more intelligent when |
| 85 |
the user extends selections (double-click). Right now, it tries to select |
| 86 |
urls and complete shell-quoted arguments, which is very convenient, too, |
| 87 |
if your <em>ls</em> supports <code>--quoting-style=shell</code>. |
| 88 |
</dd> |
| 89 |
<dd> |
| 90 |
<p>It also offers the following bindable event:</p> |
| 91 |
</dd> |
| 92 |
<dl> |
| 93 |
<dt><strong><a name="item_rot13">rot13</a></strong><br /> |
| 94 |
</dt> |
| 95 |
<dd> |
| 96 |
Rot-13 the selection when activated. Used via keyboard trigger: |
| 97 |
</dd> |
| 98 |
<dd> |
| 99 |
<pre> |
| 100 |
URxvt.keysym.C-M-r: perl:selection:rot13</pre> |
| 101 |
</dd> |
| 102 |
<p></p></dl> |
| 103 |
<dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> |
| 104 |
</dt> |
| 105 |
<dd> |
| 106 |
Displays a digital clock using the built-in overlay. |
| 107 |
</dd> |
| 108 |
<p></p> |
| 109 |
<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> |
| 110 |
</dt> |
| 111 |
<dd> |
| 112 |
Displays a very simple digital clock in the upper right corner of the |
| 113 |
window. Illustrates overwriting the refresh callbacks to create your own |
| 114 |
overlays or changes. |
| 115 |
</dd> |
| 116 |
<p></p></dl> |
| 117 |
<p> |
| 118 |
</p> |
| 119 |
<h2><a name="general_api_considerations">General API Considerations</a></h2> |
| 120 |
<p>All objects (such as terminals, time watchers etc.) are typical |
| 121 |
reference-to-hash objects. The hash can be used to store anything you |
| 122 |
like. All members starting with an underscore (such as <code>_ptr</code> or |
| 123 |
<code>_hook</code>) are reserved for internal uses and <strong>MUST NOT</strong> be accessed or |
| 124 |
modified).</p> |
| 125 |
<p>When objects are destroyed on the C++ side, the perl object hashes are |
| 126 |
emptied, so its best to store related objects such as time watchers and |
| 127 |
the like inside the terminal object so they get destroyed as soon as the |
| 128 |
terminal is destroyed.</p> |
| 129 |
<p> |
| 130 |
</p> |
| 131 |
<h2><a name="hooks">Hooks</a></h2> |
| 132 |
<p>The following subroutines can be declared in loaded scripts, and will be |
| 133 |
called whenever the relevant event happens.</p> |
| 134 |
<p>The first argument passed to them is an object private to each terminal |
| 135 |
and extension package. You can call all <code>urxvt::term</code> methods on it, but |
| 136 |
its not a real <code>urxvt::term</code> object. Instead, the real <code>urxvt::term</code> |
| 137 |
object that is shared between all packages is stored in the <code>term</code> |
| 138 |
member.</p> |
| 139 |
<p>All of them must return a boolean value. If it is true, then the event |
| 140 |
counts as being <em>consumed</em>, and the invocation of other hooks is skipped, |
| 141 |
and the relevant action might not be carried out by the C++ code.</p> |
| 142 |
<p>When in doubt, return a false value (preferably <code>()</code>).</p> |
| 143 |
<dl> |
| 144 |
<dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> |
| 145 |
</dt> |
| 146 |
<dd> |
| 147 |
Called after a new terminal object has been initialized, but before |
| 148 |
windows are created or the command gets run. |
| 149 |
</dd> |
| 150 |
<p></p> |
| 151 |
<dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> |
| 152 |
</dt> |
| 153 |
<dd> |
| 154 |
Called after the screen is ``reset'' for any reason, such as resizing or |
| 155 |
control sequences. Here is where you can react on changes to size-related |
| 156 |
variables. |
| 157 |
</dd> |
| 158 |
<p></p> |
| 159 |
<dt><strong><a name="item_on_start__24term">on_start $term</a></strong><br /> |
| 160 |
</dt> |
| 161 |
<dd> |
| 162 |
Called at the very end of initialisation of a new terminal, just before |
| 163 |
returning to the mainloop. |
| 164 |
</dd> |
| 165 |
<p></p> |
| 166 |
<dt><strong><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a></strong><br /> |
| 167 |
</dt> |
| 168 |
<dd> |
| 169 |
Called whenever a selection has been made by the user, but before the |
| 170 |
selection text is copied, so changes to the beginning, end or type of the |
| 171 |
selection will be honored. |
| 172 |
</dd> |
| 173 |
<dd> |
| 174 |
<p>Returning a true value aborts selection making by urxvt, in which case you |
| 175 |
have to make a selection yourself by calling <a href="#item_selection_grab"><code>$term->selection_grab</code></a>.</p> |
| 176 |
</dd> |
| 177 |
<p></p> |
| 178 |
<dt><strong><a name="item_on_sel_grab__24term_2c__24eventtime">on_sel_grab $term, $eventtime</a></strong><br /> |
| 179 |
</dt> |
| 180 |
<dd> |
| 181 |
Called whenever a selection has been copied, but before the selection is |
| 182 |
requested from the server. The selection text can be queried and changed |
| 183 |
by calling <a href="#item_selection"><code>$term->selection</code></a>. |
| 184 |
</dd> |
| 185 |
<dd> |
| 186 |
<p>Returning a true value aborts selection grabbing. It will still be hilighted.</p> |
| 187 |
</dd> |
| 188 |
<p></p> |
| 189 |
<dt><strong><a name="item_on_sel_extend__24term">on_sel_extend $term</a></strong><br /> |
| 190 |
</dt> |
| 191 |
<dd> |
| 192 |
Called whenever the user tries to extend the selection (e.g. with a double |
| 193 |
click) and is either supposed to return false (normal operation), or |
| 194 |
should extend the selection itelf and return true to suppress the built-in |
| 195 |
processing. |
| 196 |
</dd> |
| 197 |
<dd> |
| 198 |
<p>See the <em>selection</em> example extension.</p> |
| 199 |
</dd> |
| 200 |
<p></p> |
| 201 |
<dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> |
| 202 |
</dt> |
| 203 |
<dd> |
| 204 |
Called whenever the window gets the keyboard focus, before urxvt does |
| 205 |
focus in processing. |
| 206 |
</dd> |
| 207 |
<p></p> |
| 208 |
<dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong><br /> |
| 209 |
</dt> |
| 210 |
<dd> |
| 211 |
Called wheneever the window loses keyboard focus, before urxvt does focus |
| 212 |
out processing. |
| 213 |
</dd> |
| 214 |
<p></p> |
| 215 |
<dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong><br /> |
| 216 |
</dt> |
| 217 |
<dd> |
| 218 |
Called whenever the view offset changes, i..e the user or program |
| 219 |
scrolls. Offset <code>0</code> means display the normal terminal, positive values |
| 220 |
show this many lines of scrollback. |
| 221 |
</dd> |
| 222 |
<p></p> |
| 223 |
<dt><strong><a name="item_on_scroll_back__24term_2c__24lines_2c__24saved">on_scroll_back $term, $lines, $saved</a></strong><br /> |
| 224 |
</dt> |
| 225 |
<dd> |
| 226 |
Called whenever lines scroll out of the terminal area into the scrollback |
| 227 |
buffer. <code>$lines</code> is the number of lines scrolled out and may be larger |
| 228 |
than the scroll back buffer or the terminal. |
| 229 |
</dd> |
| 230 |
<dd> |
| 231 |
<p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
| 232 |
$nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total |
| 233 |
number of lines that will be in the scrollback buffer.</p> |
| 234 |
</dd> |
| 235 |
<p></p> |
| 236 |
<dt><strong><a name="item_on_tty_activity__24term__2anyi_2a">on_tty_activity $term *NYI*</a></strong><br /> |
| 237 |
</dt> |
| 238 |
<dd> |
| 239 |
Called whenever the <code>program(s)</code> running in the urxvt window send output. |
| 240 |
</dd> |
| 241 |
<p></p> |
| 242 |
<dt><strong><a name="item_on_osc_seq__24term_2c__24string">on_osc_seq $term, $string</a></strong><br /> |
| 243 |
</dt> |
| 244 |
<dd> |
| 245 |
Called whenever the <strong>ESC ] 777 ; string ST</strong> command sequence (OSC = |
| 246 |
operating system command) is processed. Cursor position and other state |
| 247 |
information is up-to-date when this happens. For interoperability, the |
| 248 |
string should start with the extension name and a colon, to distinguish |
| 249 |
it from commands for other extensions, and this might be enforced in the |
| 250 |
future. |
| 251 |
</dd> |
| 252 |
<dd> |
| 253 |
<p>Be careful not ever to trust (in a security sense) the data you receive, |
| 254 |
as its source can not easily be controleld (e-mail content, messages from |
| 255 |
other users on the same system etc.).</p> |
| 256 |
</dd> |
| 257 |
<p></p> |
| 258 |
<dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong><br /> |
| 259 |
</dt> |
| 260 |
<dd> |
| 261 |
Called just before the screen gets redrawn. Can be used for overlay |
| 262 |
or similar effects by modify terminal contents in refresh_begin, and |
| 263 |
restoring them in refresh_end. The built-in overlay and selection display |
| 264 |
code is run after this hook, and takes precedence. |
| 265 |
</dd> |
| 266 |
<p></p> |
| 267 |
<dt><strong><a name="item_on_refresh_end__24term">on_refresh_end $term</a></strong><br /> |
| 268 |
</dt> |
| 269 |
<dd> |
| 270 |
Called just after the screen gets redrawn. See <code>on_refresh_begin</code>. |
| 271 |
</dd> |
| 272 |
<p></p> |
| 273 |
<dt><strong><a name="item_on_keyboard_command__24term_2c__24string">on_keyboard_command $term, $string</a></strong><br /> |
| 274 |
</dt> |
| 275 |
<dd> |
| 276 |
Called whenever the user presses a key combination that has a |
| 277 |
<code>perl:string</code> action bound to it (see description of the <strong>keysym</strong> |
| 278 |
resource in the <code>rxvt(1)</code> manpage). |
| 279 |
</dd> |
| 280 |
<p></p></dl> |
| 281 |
<p> |
| 282 |
</p> |
| 283 |
<h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> |
| 284 |
<dl> |
| 285 |
<dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br /> |
| 286 |
</dt> |
| 287 |
<dd> |
| 288 |
The current terminal. Whenever a callback/Hook is bein executed, this |
| 289 |
variable stores the current <code>urxvt::term</code> object. |
| 290 |
</dd> |
| 291 |
<p></p></dl> |
| 292 |
<p> |
| 293 |
</p> |
| 294 |
<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> |
| 295 |
<dl> |
| 296 |
<dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br /> |
| 297 |
</dt> |
| 298 |
<dd> |
| 299 |
Fatally aborts execution with the given error message. Avoid at all |
| 300 |
costs! The only time this is acceptable is when the terminal process |
| 301 |
starts up. |
| 302 |
</dd> |
| 303 |
<p></p> |
| 304 |
<dt><strong><a name="item_urxvt_3a_3awarn__24string">urxvt::warn $string</a></strong><br /> |
| 305 |
</dt> |
| 306 |
<dd> |
| 307 |
Calls <code>rxvt_warn</code> with the given string which should not include a |
| 308 |
newline. The module also overwrites the <code>warn</code> builtin with a function |
| 309 |
that calls this function. |
| 310 |
</dd> |
| 311 |
<dd> |
| 312 |
<p>Using this function has the advantage that its output ends up in the |
| 313 |
correct place, e.g. on stderr of the connecting urxvtc client.</p> |
| 314 |
</dd> |
| 315 |
<p></p> |
| 316 |
<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> |
| 317 |
</dt> |
| 318 |
<dd> |
| 319 |
Returns the ``current time'' (as per the event loop). |
| 320 |
</dd> |
| 321 |
<p></p></dl> |
| 322 |
<p> |
| 323 |
</p> |
| 324 |
<h2><a name="rendition">RENDITION</a></h2> |
| 325 |
<p>Rendition bitsets contain information about colour, font, font styles and |
| 326 |
similar information for each screen cell.</p> |
| 327 |
<p>The following ``macros'' deal with changes in rendition sets. You should |
| 328 |
never just create a bitset, you should always modify an existing one, |
| 329 |
as they contain important information required for correct operation of |
| 330 |
rxvt-unicode.</p> |
| 331 |
<dl> |
| 332 |
<dt><strong><a name="item__24rend__3d_urxvt_3a_3adefault_rstyle">$rend = urxvt::DEFAULT_RSTYLE</a></strong><br /> |
| 333 |
</dt> |
| 334 |
<dd> |
| 335 |
Returns the default rendition, as used when the terminal is starting up or |
| 336 |
being reset. Useful as a base to start when creating renditions. |
| 337 |
</dd> |
| 338 |
<p></p> |
| 339 |
<dt><strong><a name="item__24rend__3d_urxvt_3a_3aoverlay_rstyle">$rend = urxvt::OVERLAY_RSTYLE</a></strong><br /> |
| 340 |
</dt> |
| 341 |
<dd> |
| 342 |
Return the rendition mask used for overlays by default. |
| 343 |
</dd> |
| 344 |
<p></p> |
| 345 |
<dt><strong><a name="item__24rendbit__3d_urxvt_3a_3ars_bold_2c_rs_italic_2c_">$rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline</a></strong><br /> |
| 346 |
</dt> |
| 347 |
<dd> |
| 348 |
Return the bit that enabled bold, italic, blink, reverse-video and |
| 349 |
underline, respectively. To enable such a style, just logically OR it into |
| 350 |
the bitset. |
| 351 |
</dd> |
| 352 |
<p></p> |
| 353 |
<dt><strong><a name="item__24foreground__3d_urxvt_3a_3aget_basefg__24rend">$foreground = urxvt::GET_BASEFG $rend</a></strong><br /> |
| 354 |
</dt> |
| 355 |
<dt><strong><a name="item__24background__3d_urxvt_3a_3aget_basebg__24rend">$background = urxvt::GET_BASEBG $rend</a></strong><br /> |
| 356 |
</dt> |
| 357 |
<dd> |
| 358 |
Return the foreground/background colour index, respectively. |
| 359 |
</dd> |
| 360 |
<p></p> |
| 361 |
<dt><strong><a name="item_set_fgcolor">$rend = urxvt::SET_FGCOLOR ($rend, $new_colour)</a></strong><br /> |
| 362 |
</dt> |
| 363 |
<dt><strong><a name="item_set_bgcolor">$rend = urxvt::SET_BGCOLOR ($rend, $new_colour)</a></strong><br /> |
| 364 |
</dt> |
| 365 |
<dd> |
| 366 |
Replace the foreground/background colour in the rendition mask with the |
| 367 |
specified one. |
| 368 |
</dd> |
| 369 |
<p></p> |
| 370 |
<dt><strong><a name="item_get_custom">$value = urxvt::GET_CUSTOM ($rend)</a></strong><br /> |
| 371 |
</dt> |
| 372 |
<dd> |
| 373 |
Return the ``custom'' value: Every rendition has 5 bits for use by |
| 374 |
extensions. They can be set and changed as you like and are initially |
| 375 |
zero. |
| 376 |
</dd> |
| 377 |
<p></p> |
| 378 |
<dt><strong><a name="item_set_custom">$rend = urxvt::SET_CUSTOM ($rend, $new_value)</a></strong><br /> |
| 379 |
</dt> |
| 380 |
<dd> |
| 381 |
Change the custom value. |
| 382 |
</dd> |
| 383 |
<p></p></dl> |
| 384 |
<p> |
| 385 |
</p> |
| 386 |
<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> |
| 387 |
<dl> |
| 388 |
<dt><strong><a name="item_resource">$value = $term->resource ($name[, $newval])</a></strong><br /> |
| 389 |
</dt> |
| 390 |
<dd> |
| 391 |
Returns the current resource value associated with a given name and |
| 392 |
optionally sets a new value. Setting values is most useful in the <code>init</code> |
| 393 |
hook. Unset resources are returned and accepted as <code>undef</code>. |
| 394 |
</dd> |
| 395 |
<dd> |
| 396 |
<p>The new value must be properly encoded to a suitable character encoding |
| 397 |
before passing it to this method. Similarly, the returned value may need |
| 398 |
to be converted from the used encoding to text.</p> |
| 399 |
</dd> |
| 400 |
<dd> |
| 401 |
<p>Resource names are as defined in <em>src/rsinc.h</em>. Colours can be specified |
| 402 |
as resource names of the form <code>color+<index></code>, e.g. <code>color+5</code>. (will |
| 403 |
likely change).</p> |
| 404 |
</dd> |
| 405 |
<dd> |
| 406 |
<p>Please note that resource strings will currently only be freed when the |
| 407 |
terminal is destroyed, so changing options frequently will eat memory.</p> |
| 408 |
</dd> |
| 409 |
<dd> |
| 410 |
<p>Here is a a likely non-exhaustive list of resource names, not all of which |
| 411 |
are supported in every build, please see the source to see the actual |
| 412 |
list:</p> |
| 413 |
</dd> |
| 414 |
<dd> |
| 415 |
<pre> |
| 416 |
answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
| 417 |
borderLess color cursorBlink cursorUnderline cutchars delete_key |
| 418 |
display_name embed ext_bwidth fade font geometry hold iconName |
| 419 |
imFont imLocale inputMethod insecure int_bwidth intensityStyles |
| 420 |
italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
| 421 |
mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 |
| 422 |
perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
| 423 |
reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
| 424 |
scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
| 425 |
scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
| 426 |
shade term_name title transparent transparent_all tripleclickwords |
| 427 |
utmpInhibit visualBell</pre> |
| 428 |
</dd> |
| 429 |
<p></p> |
| 430 |
<dt><strong><a name="item_screen_rstyle">$rend = $term->screen_rstyle ([$new_rstyle])</a></strong><br /> |
| 431 |
</dt> |
| 432 |
<dd> |
| 433 |
Return and optionally change the current rendition. Text thta is output by |
| 434 |
the temrianl application will use this style. |
| 435 |
</dd> |
| 436 |
<p></p> |
| 437 |
<dt><strong><a name="item_screen_cur">($row, $col) = $term->screen_cur ([$row, $col])</a></strong><br /> |
| 438 |
</dt> |
| 439 |
<dd> |
| 440 |
Return the current coordinates of the text cursor position and optionally |
| 441 |
set it (which is usually bad as applications don't expect that). |
| 442 |
</dd> |
| 443 |
<p></p> |
| 444 |
<dt><strong><a name="item_selection_mark">($row, $col) = $term->selection_mark ([$row, $col])</a></strong><br /> |
| 445 |
</dt> |
| 446 |
<dt><strong><a name="item_selection_beg">($row, $col) = $term->selection_beg ([$row, $col])</a></strong><br /> |
| 447 |
</dt> |
| 448 |
<dt><strong><a name="item_selection_end">($row, $col) = $term->selection_end ([$row, $col])</a></strong><br /> |
| 449 |
</dt> |
| 450 |
<dd> |
| 451 |
Return the current values of the selection mark, begin or end positions, |
| 452 |
and optionally set them to new values. |
| 453 |
</dd> |
| 454 |
<p></p> |
| 455 |
<dt><strong><a name="item_selection_grab">$success = $term->selection_grab ($eventtime)</a></strong><br /> |
| 456 |
</dt> |
| 457 |
<dd> |
| 458 |
Try to request the primary selection from the server (for example, as set |
| 459 |
by the next method). |
| 460 |
</dd> |
| 461 |
<p></p> |
| 462 |
<dt><strong>$oldtext = $term->selection ([$newtext])</strong><br /> |
| 463 |
</dt> |
| 464 |
<dd> |
| 465 |
Return the current selection text and optionally replace it by <code>$newtext</code>. |
| 466 |
</dd> |
| 467 |
<dd> |
| 468 |
<p>#=item $term->overlay ($x, $y, $text) |
| 469 |
# |
| 470 |
#Create a simple multi-line overlay box. See the next method for details. |
| 471 |
# |
| 472 |
#=cut</p> |
| 473 |
</dd> |
| 474 |
<dd> |
| 475 |
<p>sub urxvt::term::scr_overlay { |
| 476 |
die; |
| 477 |
my ($self, $x, $y, $text) = @_;</p> |
| 478 |
</dd> |
| 479 |
<dd> |
| 480 |
<pre> |
| 481 |
my @lines = split /\n/, $text;</pre> |
| 482 |
</dd> |
| 483 |
<dd> |
| 484 |
<pre> |
| 485 |
my $w = 0; |
| 486 |
for (map $self->strwidth ($_), @lines) { |
| 487 |
$w = $_ if $w < $_; |
| 488 |
}</pre> |
| 489 |
</dd> |
| 490 |
<dd> |
| 491 |
<pre> |
| 492 |
$self->scr_overlay_new ($x, $y, $w, scalar @lines); |
| 493 |
$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; |
| 494 |
}</pre> |
| 495 |
</dd> |
| 496 |
<p></p> |
| 497 |
<dt><strong><a name="item_overlay">$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br /> |
| 498 |
</dt> |
| 499 |
<dd> |
| 500 |
Create a new (empty) overlay at the given position with the given |
| 501 |
width/height. <code>$rstyle</code> defines the initial rendition style |
| 502 |
(default: <code>OVERLAY_RSTYLE</code>). |
| 503 |
</dd> |
| 504 |
<dd> |
| 505 |
<p>If <code>$border</code> is <code>2</code> (default), then a decorative border will be put |
| 506 |
around the box.</p> |
| 507 |
</dd> |
| 508 |
<dd> |
| 509 |
<p>If either <code>$x</code> or <code>$y</code> is negative, then this is counted from the |
| 510 |
right/bottom side, respectively.</p> |
| 511 |
</dd> |
| 512 |
<dd> |
| 513 |
<p>This method returns an urxvt::overlay object. The overlay will be visible |
| 514 |
as long as the perl object is referenced.</p> |
| 515 |
</dd> |
| 516 |
<dd> |
| 517 |
<p>The methods currently supported on <code>urxvt::overlay</code> objects are:</p> |
| 518 |
</dd> |
| 519 |
<dl> |
| 520 |
<dt><strong><a name="item_set">$overlay->set ($x, $y, $text, $rend)</a></strong><br /> |
| 521 |
</dt> |
| 522 |
<dd> |
| 523 |
Similar to <a href="#item_row_t"><code>$term->ROW_t</code></a> and <a href="#item_row_r"><code>$term->ROW_r</code></a> in that it puts |
| 524 |
text in rxvt-unicode's special encoding and an array of rendition values |
| 525 |
at a specific position inside the overlay. |
| 526 |
</dd> |
| 527 |
<p></p> |
| 528 |
<dt><strong><a name="item_hide">$overlay->hide</a></strong><br /> |
| 529 |
</dt> |
| 530 |
<dd> |
| 531 |
If visible, hide the overlay, but do not destroy it. |
| 532 |
</dd> |
| 533 |
<p></p> |
| 534 |
<dt><strong><a name="item_show">$overlay->show</a></strong><br /> |
| 535 |
</dt> |
| 536 |
<dd> |
| 537 |
If hidden, display the overlay again. |
| 538 |
</dd> |
| 539 |
<p></p></dl> |
| 540 |
<dt><strong><a name="item_strwidth">$cellwidth = $term->strwidth $string</a></strong><br /> |
| 541 |
</dt> |
| 542 |
<dd> |
| 543 |
Returns the number of screen-cells this string would need. Correctly |
| 544 |
accounts for wide and combining characters. |
| 545 |
</dd> |
| 546 |
<p></p> |
| 547 |
<dt><strong><a name="item_locale_encode">$octets = $term->locale_encode $string</a></strong><br /> |
| 548 |
</dt> |
| 549 |
<dd> |
| 550 |
Convert the given text string into the corresponding locale encoding. |
| 551 |
</dd> |
| 552 |
<p></p> |
| 553 |
<dt><strong><a name="item_locale_decode">$string = $term->locale_decode $octets</a></strong><br /> |
| 554 |
</dt> |
| 555 |
<dd> |
| 556 |
Convert the given locale-encoded octets into a perl string. |
| 557 |
</dd> |
| 558 |
<p></p> |
| 559 |
<dt><strong><a name="item_tt_write">$term->tt_write ($octets)</a></strong><br /> |
| 560 |
</dt> |
| 561 |
<dd> |
| 562 |
Write the octets given in <code>$data</code> to the tty (i.e. as program input). To |
| 563 |
pass characters instead of octets, you should convert your strings first |
| 564 |
to the locale-specific encoding using <a href="#item_locale_encode"><code>$term->locale_encode</code></a>. |
| 565 |
</dd> |
| 566 |
<p></p> |
| 567 |
<dt><strong><a name="item_width">$window_width = $term->width</a></strong><br /> |
| 568 |
</dt> |
| 569 |
<dt><strong><a name="item_height">$window_height = $term->height</a></strong><br /> |
| 570 |
</dt> |
| 571 |
<dt><strong><a name="item_fwidth">$font_width = $term->fwidth</a></strong><br /> |
| 572 |
</dt> |
| 573 |
<dt><strong><a name="item_fheight">$font_height = $term->fheight</a></strong><br /> |
| 574 |
</dt> |
| 575 |
<dt><strong><a name="item_fbase">$font_ascent = $term->fbase</a></strong><br /> |
| 576 |
</dt> |
| 577 |
<dt><strong><a name="item_nrow">$terminal_rows = $term->nrow</a></strong><br /> |
| 578 |
</dt> |
| 579 |
<dt><strong><a name="item_ncol">$terminal_columns = $term->ncol</a></strong><br /> |
| 580 |
</dt> |
| 581 |
<dt><strong><a name="item_focus">$has_focus = $term->focus</a></strong><br /> |
| 582 |
</dt> |
| 583 |
<dt><strong><a name="item_mapped">$is_mapped = $term->mapped</a></strong><br /> |
| 584 |
</dt> |
| 585 |
<dt><strong><a name="item_savelines">$max_scrollback = $term->saveLines</a></strong><br /> |
| 586 |
</dt> |
| 587 |
<dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term->total_rows</a></strong><br /> |
| 588 |
</dt> |
| 589 |
<dt><strong><a name="item_nsaved">$lines_in_scrollback = $term->nsaved</a></strong><br /> |
| 590 |
</dt> |
| 591 |
<dd> |
| 592 |
Return various integers describing terminal characteristics. |
| 593 |
</dd> |
| 594 |
<p></p> |
| 595 |
<dt><strong><a name="item_view_start">$view_start = $term->view_start ([$newvalue])</a></strong><br /> |
| 596 |
</dt> |
| 597 |
<dd> |
| 598 |
Returns the negative row number of the topmost line. Minimum value is |
| 599 |
<code>0</code>, which displays the normal terminal contents. Larger values scroll |
| 600 |
this many lines into the scrollback buffer. |
| 601 |
</dd> |
| 602 |
<p></p> |
| 603 |
<dt><strong><a name="item_want_refresh">$term->want_refresh</a></strong><br /> |
| 604 |
</dt> |
| 605 |
<dd> |
| 606 |
Requests a screen refresh. At the next opportunity, rxvt-unicode will |
| 607 |
compare the on-screen display with its stored representation. If they |
| 608 |
differ, it redraws the differences. |
| 609 |
</dd> |
| 610 |
<dd> |
| 611 |
<p>Used after changing terminal contents to display them.</p> |
| 612 |
</dd> |
| 613 |
<p></p> |
| 614 |
<dt><strong><a name="item_row_t">$text = $term->ROW_t ($row_number[, $new_text[, $start_col]])</a></strong><br /> |
| 615 |
</dt> |
| 616 |
<dd> |
| 617 |
Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code> |
| 618 |
is the topmost terminal line, row <code>$term->$ncol-1</code> is the bottommost |
| 619 |
terminal line. The scrollback buffer starts at line <code>-1</code> and extends to |
| 620 |
line <a href="#item_nsaved"><code>-$term->nsaved</code></a>. Nothing will be returned if a nonexistent line |
| 621 |
is requested. |
| 622 |
</dd> |
| 623 |
<dd> |
| 624 |
<p>If <code>$new_text</code> is specified, it will replace characters in the current |
| 625 |
line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful |
| 626 |
to replace only parts of a line. The font index in the rendition will |
| 627 |
automatically be updated.</p> |
| 628 |
</dd> |
| 629 |
<dd> |
| 630 |
<p><code>$text</code> is in a special encoding: tabs and wide characters that use more |
| 631 |
than one cell when displayed are padded with urxvt::NOCHAR characters |
| 632 |
(<code>chr 65535</code>). Characters with combining characters and other characters |
| 633 |
that do not fit into the normal tetx encoding will be replaced with |
| 634 |
characters in the private use area.</p> |
| 635 |
</dd> |
| 636 |
<dd> |
| 637 |
<p>You have to obey this encoding when changing text. The advantage is |
| 638 |
that <code>substr</code> and similar functions work on screen cells and not on |
| 639 |
characters.</p> |
| 640 |
</dd> |
| 641 |
<dd> |
| 642 |
<p>The methods <code>$term->special_encode</code> and <a href="#item_special_decode"><code>$term->special_decode</code></a> |
| 643 |
can be used to convert normal strings into this encoding and vice versa.</p> |
| 644 |
</dd> |
| 645 |
<p></p> |
| 646 |
<dt><strong><a name="item_row_r">$rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br /> |
| 647 |
</dt> |
| 648 |
<dd> |
| 649 |
Like <a href="#item_row_t"><code>$term->ROW_t</code></a>, but returns an arrayref with rendition |
| 650 |
bitsets. Rendition bitsets contain information about colour, font, font |
| 651 |
styles and similar information. See also <a href="#item_row_t"><code>$term->ROW_t</code></a>. |
| 652 |
</dd> |
| 653 |
<dd> |
| 654 |
<p>When setting rendition, the font mask will be ignored.</p> |
| 655 |
</dd> |
| 656 |
<dd> |
| 657 |
<p>See the section on RENDITION, above.</p> |
| 658 |
</dd> |
| 659 |
<p></p> |
| 660 |
<dt><strong><a name="item_row_l">$length = $term->ROW_l ($row_number[, $new_length])</a></strong><br /> |
| 661 |
</dt> |
| 662 |
<dd> |
| 663 |
Returns the number of screen cells that are in use (``the line |
| 664 |
length''). Unlike the urxvt core, this returns <a href="#item_ncol"><code>$term->ncol</code></a> if the |
| 665 |
line is joined with the following one. |
| 666 |
</dd> |
| 667 |
<p></p> |
| 668 |
<dt><strong><a name="item_is_longer">$bool = $term->is_longer ($row_number)</a></strong><br /> |
| 669 |
</dt> |
| 670 |
<dd> |
| 671 |
Returns true if the row is part of a multiple-row logical ``line'' (i.e. |
| 672 |
joined with the following row), which means all characters are in use |
| 673 |
and it is continued on the next row (and possibly a continuation of the |
| 674 |
previous row(s)). |
| 675 |
</dd> |
| 676 |
<p></p> |
| 677 |
<dt><strong><a name="item_line">$line = $term->line ($row_number)</a></strong><br /> |
| 678 |
</dt> |
| 679 |
<dd> |
| 680 |
Create and return a new <code>urxvt::line</code> object that stores information |
| 681 |
about the logical line that row <code>$row_number</code> is part of. It supports the |
| 682 |
following methods: |
| 683 |
</dd> |
| 684 |
<dl> |
| 685 |
<dt><strong><a name="item_t">$text = $line->t</a></strong><br /> |
| 686 |
</dt> |
| 687 |
<dd> |
| 688 |
Returns the full text of the line, similar to <a href="#item_row_t"><code>ROW_t</code></a> |
| 689 |
</dd> |
| 690 |
<p></p> |
| 691 |
<dt><strong><a name="item_r">$rend = $line->r</a></strong><br /> |
| 692 |
</dt> |
| 693 |
<dd> |
| 694 |
Returns the full rendition array of the line, similar to <a href="#item_row_r"><code>ROW_r</code></a> |
| 695 |
</dd> |
| 696 |
<p></p> |
| 697 |
<dt><strong><a name="item_l">$length = $line->l</a></strong><br /> |
| 698 |
</dt> |
| 699 |
<dd> |
| 700 |
Returns the length of the line in cells, similar to <a href="#item_row_l"><code>ROW_l</code></a>. |
| 701 |
</dd> |
| 702 |
<p></p> |
| 703 |
<dt><strong><a name="item_beg">$rownum = $line->beg</a></strong><br /> |
| 704 |
</dt> |
| 705 |
<dt><strong><a name="item_end">$rownum = $line->end</a></strong><br /> |
| 706 |
</dt> |
| 707 |
<dd> |
| 708 |
Return the row number of the first/last row of the line, respectively. |
| 709 |
</dd> |
| 710 |
<p></p> |
| 711 |
<dt><strong><a name="item_offset_of">$offset = $line->offset_of ($row, $col)</a></strong><br /> |
| 712 |
</dt> |
| 713 |
<dd> |
| 714 |
Returns the character offset of the given row|col pair within the logical |
| 715 |
line. |
| 716 |
</dd> |
| 717 |
<p></p> |
| 718 |
<dt><strong><a name="item_coord_of">($row, $col) = $line->coord_of ($offset)</a></strong><br /> |
| 719 |
</dt> |
| 720 |
<dd> |
| 721 |
Translates a string offset into terminal coordinates again. |
| 722 |
</dd> |
| 723 |
<p></p></dl> |
| 724 |
<dt><strong>($row, $col) = $line->coord_of ($offset) |
| 725 |
=item $text = $term->special_encode $string</strong><br /> |
| 726 |
</dt> |
| 727 |
<dd> |
| 728 |
Converts a perl string into the special encoding used by rxvt-unicode, |
| 729 |
where one character corresponds to one screen cell. See |
| 730 |
<a href="#item_row_t"><code>$term->ROW_t</code></a> for details. |
| 731 |
</dd> |
| 732 |
<p></p> |
| 733 |
<dt><strong><a name="item_special_decode">$string = $term->special_decode $text</a></strong><br /> |
| 734 |
</dt> |
| 735 |
<dd> |
| 736 |
Converts rxvt-unicodes text reprsentation into a perl string. See |
| 737 |
<a href="#item_row_t"><code>$term->ROW_t</code></a> for details. |
| 738 |
</dd> |
| 739 |
<p></p></dl> |
| 740 |
<p> |
| 741 |
</p> |
| 742 |
<h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> |
| 743 |
<p>This class implements timer watchers/events. Time is represented as a |
| 744 |
fractional number of seconds since the epoch. Example:</p> |
| 745 |
<pre> |
| 746 |
$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0); |
| 747 |
$term->{timer} = urxvt::timer |
| 748 |
->new |
| 749 |
->interval (1) |
| 750 |
->cb (sub { |
| 751 |
$term->{overlay}->set (0, 0, |
| 752 |
sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
| 753 |
});</pre> |
| 754 |
<dl> |
| 755 |
<dt><strong><a name="item__24timer__3d_new_urxvt_3a_3atimer">$timer = new urxvt::timer</a></strong><br /> |
| 756 |
</dt> |
| 757 |
<dd> |
| 758 |
Create a new timer object in started state. It is scheduled to fire |
| 759 |
immediately. |
| 760 |
</dd> |
| 761 |
<p></p> |
| 762 |
<dt><strong><a name="item_cb">$timer = $timer->cb (sub { my ($timer) = @_; ... })</a></strong><br /> |
| 763 |
</dt> |
| 764 |
<dd> |
| 765 |
Set the callback to be called when the timer triggers. |
| 766 |
</dd> |
| 767 |
<p></p> |
| 768 |
<dt><strong><a name="item_at">$tstamp = $timer->at</a></strong><br /> |
| 769 |
</dt> |
| 770 |
<dd> |
| 771 |
Return the time this watcher will fire next. |
| 772 |
</dd> |
| 773 |
<p></p> |
| 774 |
<dt><strong>$timer = $timer->set ($tstamp)</strong><br /> |
| 775 |
</dt> |
| 776 |
<dd> |
| 777 |
Set the time the event is generated to $tstamp. |
| 778 |
</dd> |
| 779 |
<p></p> |
| 780 |
<dt><strong><a name="item_interval">$timer = $timer->interval ($interval)</a></strong><br /> |
| 781 |
</dt> |
| 782 |
<dd> |
| 783 |
Normally (and when <code>$interval</code> is <code>0</code>), the timer will automatically |
| 784 |
stop after it has fired once. If <code>$interval</code> is non-zero, then the timer |
| 785 |
is automatically rescheduled at the given intervals. |
| 786 |
</dd> |
| 787 |
<p></p> |
| 788 |
<dt><strong><a name="item_start">$timer = $timer->start</a></strong><br /> |
| 789 |
</dt> |
| 790 |
<dd> |
| 791 |
Start the timer. |
| 792 |
</dd> |
| 793 |
<p></p> |
| 794 |
<dt><strong>$timer = $timer->start ($tstamp)</strong><br /> |
| 795 |
</dt> |
| 796 |
<dd> |
| 797 |
Set the event trigger time to <code>$tstamp</code> and start the timer. |
| 798 |
</dd> |
| 799 |
<p></p> |
| 800 |
<dt><strong><a name="item_stop">$timer = $timer->stop</a></strong><br /> |
| 801 |
</dt> |
| 802 |
<dd> |
| 803 |
Stop the timer. |
| 804 |
</dd> |
| 805 |
<p></p></dl> |
| 806 |
<p> |
| 807 |
</p> |
| 808 |
<h2><a name="the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></h2> |
| 809 |
<p>This class implements io watchers/events. Example:</p> |
| 810 |
<pre> |
| 811 |
$term->{socket} = ... |
| 812 |
$term->{iow} = urxvt::iow |
| 813 |
->new |
| 814 |
->fd (fileno $term->{socket}) |
| 815 |
->events (1) # wait for read data |
| 816 |
->start |
| 817 |
->cb (sub { |
| 818 |
my ($iow, $revents) = @_; |
| 819 |
# $revents must be 1 here, no need to check |
| 820 |
sysread $term->{socket}, my $buf, 8192 |
| 821 |
or end-of-file; |
| 822 |
});</pre> |
| 823 |
<dl> |
| 824 |
<dt><strong><a name="item__24iow__3d_new_urxvt_3a_3aiow">$iow = new urxvt::iow</a></strong><br /> |
| 825 |
</dt> |
| 826 |
<dd> |
| 827 |
Create a new io watcher object in stopped state. |
| 828 |
</dd> |
| 829 |
<p></p> |
| 830 |
<dt><strong>$iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... })</strong><br /> |
| 831 |
</dt> |
| 832 |
<dd> |
| 833 |
Set the callback to be called when io events are triggered. <code>$reventmask</code> |
| 834 |
is a bitset as described in the <a href="#item_events"><code>events</code></a> method. |
| 835 |
</dd> |
| 836 |
<p></p> |
| 837 |
<dt><strong><a name="item_fd">$iow = $iow->fd ($fd)</a></strong><br /> |
| 838 |
</dt> |
| 839 |
<dd> |
| 840 |
Set the filedescriptor (not handle) to watch. |
| 841 |
</dd> |
| 842 |
<p></p> |
| 843 |
<dt><strong><a name="item_events">$iow = $iow->events ($eventmask)</a></strong><br /> |
| 844 |
</dt> |
| 845 |
<dd> |
| 846 |
Set the event mask to watch. Bit #0 (value <code>1</code>) enables watching for read |
| 847 |
data, Bit #1 (value <code>2</code>) enables watching for write data. |
| 848 |
</dd> |
| 849 |
<p></p> |
| 850 |
<dt><strong>$iow = $iow->start</strong><br /> |
| 851 |
</dt> |
| 852 |
<dd> |
| 853 |
Start watching for requested events on the given handle. |
| 854 |
</dd> |
| 855 |
<p></p> |
| 856 |
<dt><strong>$iow = $iow->stop</strong><br /> |
| 857 |
</dt> |
| 858 |
<dd> |
| 859 |
Stop watching for events on the given filehandle. |
| 860 |
</dd> |
| 861 |
<p></p></dl> |
| 862 |
<p> |
| 863 |
</p> |
| 864 |
<hr /> |
| 865 |
<h1><a name="environment">ENVIRONMENT</a></h1> |
| 866 |
<p> |
| 867 |
</p> |
| 868 |
<h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> |
| 869 |
<p>This variable controls the verbosity level of the perl extension. Higher |
| 870 |
numbers indicate more verbose output.</p> |
| 871 |
<dl> |
| 872 |
<dt><strong><a name="item__3d0__2d_only_fatal_messages">=0 - only fatal messages</a></strong><br /> |
| 873 |
</dt> |
| 874 |
<dt><strong><a name="item__3d3__2d_script_loading_and_management">=3 - script loading and management</a></strong><br /> |
| 875 |
</dt> |
| 876 |
<dt><strong><a name="item__3d10__2d_all_events_received">=10 - all events received</a></strong><br /> |
| 877 |
</dt> |
| 878 |
</dl> |
| 879 |
<p> |
| 880 |
</p> |
| 881 |
<hr /> |
| 882 |
<h1><a name="author">AUTHOR</a></h1> |
| 883 |
<pre> |
| 884 |
Marc Lehmann <pcg@goof.com> |
| 885 |
<a href="http://software.schmorp.de/pkg/rxvt-unicode">http://software.schmorp.de/pkg/rxvt-unicode</a></pre> |
| 886 |
|
| 887 |
</body> |
| 888 |
|
| 889 |
</html> |
