| 1 |
<?xml version="1.0" encoding="UTF-8"?> |
| 2 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> |
| 3 |
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> |
| 4 |
<head> |
| 5 |
<title>rxvtperl</title> |
| 6 |
<meta name="description" content="Pod documentation for rxvtperl" /> |
| 7 |
<meta name="inputfile" content="<standard input>" /> |
| 8 |
<meta name="outputfile" content="<standard output>" /> |
| 9 |
<meta name="created" content="Mon Jun 25 00:30:34 2007" /> |
| 10 |
<meta name="generator" content="Pod::Xhtml 1.57" /> |
| 11 |
<link rel="stylesheet" href="http://res.tst.eu/pod.css"/></head> |
| 12 |
<body> |
| 13 |
<div class="pod"> |
| 14 |
<!-- INDEX START --> |
| 15 |
<h3 id="TOP">Index</h3> |
| 16 |
|
| 17 |
<ul><li><a href="#NAME">NAME</a></li> |
| 18 |
<li><a href="#SYNOPSIS">SYNOPSIS</a></li> |
| 19 |
<li><a href="#DESCRIPTION">DESCRIPTION</a></li> |
| 20 |
<li><a href="#PREPACKAGED_EXTENSIONS">PREPACKAGED EXTENSIONS</a></li> |
| 21 |
<li><a href="#API_DOCUMENTATION">API DOCUMENTATION</a> |
| 22 |
<ul><li><a href="#General_API_Considerations">General API Considerations</a></li> |
| 23 |
<li><a href="#Extension_Objects">Extension Objects</a></li> |
| 24 |
<li><a href="#Hooks">Hooks</a></li> |
| 25 |
<li><a href="#Variables_in_the_code_urxvt_code_Pac">Variables in the <code>urxvt</code> Package</a></li> |
| 26 |
<li><a href="#Functions_in_the_code_urxvt_code_Pac">Functions in the <code>urxvt</code> Package</a></li> |
| 27 |
<li><a href="#RENDITION">RENDITION</a></li> |
| 28 |
<li><a href="#The_code_urxvt_anyevent_code_Class">The <code>urxvt::anyevent</code> Class</a></li> |
| 29 |
<li><a href="#The_code_urxvt_term_code_Class">The <code>urxvt::term</code> Class</a></li> |
| 30 |
<li><a href="#The_code_urxvt_popup_code_Class">The <code>urxvt::popup</code> Class</a></li> |
| 31 |
<li><a href="#The_code_urxvt_timer_code_Class">The <code>urxvt::timer</code> Class</a></li> |
| 32 |
<li><a href="#The_code_urxvt_iow_code_Class">The <code>urxvt::iow</code> Class</a></li> |
| 33 |
<li><a href="#The_code_urxvt_iw_code_Class">The <code>urxvt::iw</code> Class</a></li> |
| 34 |
<li><a href="#The_code_urxvt_pw_code_Class">The <code>urxvt::pw</code> Class</a></li> |
| 35 |
</ul> |
| 36 |
</li> |
| 37 |
<li><a href="#ENVIRONMENT">ENVIRONMENT</a> |
| 38 |
<ul><li><a href="#URXVT_PERL_VERBOSITY">URXVT_PERL_VERBOSITY</a></li> |
| 39 |
</ul> |
| 40 |
</li> |
| 41 |
<li><a href="#AUTHOR">AUTHOR</a> |
| 42 |
</li> |
| 43 |
</ul><hr /> |
| 44 |
<!-- INDEX END --> |
| 45 |
|
| 46 |
<h1 id="NAME">NAME</h1><p><a href="#TOP" class="toplink">Top</a></p> |
| 47 |
<div id="NAME_CONTENT"> |
| 48 |
<p>rxvtperl - rxvt-unicode's embedded perl interpreter</p> |
| 49 |
|
| 50 |
</div> |
| 51 |
<h1 id="SYNOPSIS">SYNOPSIS</h1><p><a href="#TOP" class="toplink">Top</a></p> |
| 52 |
<div id="SYNOPSIS_CONTENT"> |
| 53 |
<pre> # create a file grab_test in $HOME: |
| 54 |
|
| 55 |
sub on_sel_grab { |
| 56 |
warn "you selected ", $_[0]->selection; |
| 57 |
() |
| 58 |
} |
| 59 |
|
| 60 |
# start a rxvt using it: |
| 61 |
|
| 62 |
rxvt --perl-lib $HOME -pe grab_test |
| 63 |
|
| 64 |
</pre> |
| 65 |
|
| 66 |
</div> |
| 67 |
<h1 id="DESCRIPTION">DESCRIPTION</h1><p><a href="#TOP" class="toplink">Top</a></p> |
| 68 |
<div id="DESCRIPTION_CONTENT"> |
| 69 |
<p>Every time a terminal object gets created, extension scripts specified via |
| 70 |
the <code>perl</code> resource are loaded and associated with it.</p> |
| 71 |
<p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and |
| 72 |
thus must be encoded as UTF-8.</p> |
| 73 |
<p>Each script will only ever be loaded once, even in rxvtd, where |
| 74 |
scripts will be shared (but not enabled) for all terminals.</p> |
| 75 |
<p>You can disable the embedded perl interpreter by setting both "perl-ext" |
| 76 |
and "perl-ext-common" resources to the empty string.</p> |
| 77 |
|
| 78 |
</div> |
| 79 |
<h1 id="PREPACKAGED_EXTENSIONS">PREPACKAGED EXTENSIONS</h1><p><a href="#TOP" class="toplink">Top</a></p> |
| 80 |
<div id="PREPACKAGED_EXTENSIONS_CONTENT"> |
| 81 |
<p>This section describes the extensions delivered with this release. You can |
| 82 |
find them in <cite>/opt/rxvt/lib/urxvt/perl/</cite>.</p> |
| 83 |
<p>You can activate them like this:</p> |
| 84 |
<pre> rxvt -pe <extensionname> |
| 85 |
|
| 86 |
</pre> |
| 87 |
<p>Or by adding them to the resource for extensions loaded by default:</p> |
| 88 |
<pre> URxvt.perl-ext-common: default,automove-background,selection-autotransform |
| 89 |
|
| 90 |
</pre> |
| 91 |
<dl> |
| 92 |
<dt>selection (enabled by default)</dt> |
| 93 |
<dd> |
| 94 |
<p>(More) intelligent selection. This extension tries to be more intelligent |
| 95 |
when the user extends selections (double-click and further clicks). Right |
| 96 |
now, it tries to select words, urls and complete shell-quoted |
| 97 |
arguments, which is very convenient, too, if your <cite>ls</cite> supports |
| 98 |
<code>--quoting-style=shell</code>.</p> |
| 99 |
<p>A double-click usually selects the word under the cursor, further clicks |
| 100 |
will enlarge the selection.</p> |
| 101 |
<p>The selection works by trying to match a number of regexes and displaying |
| 102 |
them in increasing order of length. You can add your own regexes by |
| 103 |
specifying resources of the form:</p> |
| 104 |
<pre> URxvt.selection.pattern-0: perl-regex |
| 105 |
URxvt.selection.pattern-1: perl-regex |
| 106 |
... |
| 107 |
|
| 108 |
</pre> |
| 109 |
<p>The index number (0, 1...) must not have any holes, and each regex must |
| 110 |
contain at least one pair of capturing parentheses, which will be used for |
| 111 |
the match. For example, the following adds a regex that matches everything |
| 112 |
between two vertical bars:</p> |
| 113 |
<pre> URxvt.selection.pattern-0: \\|([^|]+)\\| |
| 114 |
|
| 115 |
</pre> |
| 116 |
<p>Another example: Programs I use often output "absolute path: " at the |
| 117 |
beginning of a line when they process multiple files. The following |
| 118 |
pattern matches the filename (note, there is a single space at the very |
| 119 |
end):</p> |
| 120 |
<pre> URxvt.selection.pattern-0: ^(/[^:]+):\ |
| 121 |
|
| 122 |
</pre> |
| 123 |
<p>You can look at the source of the selection extension to see more |
| 124 |
interesting uses, such as parsing a line from beginning to end.</p> |
| 125 |
<p>This extension also offers following bindable keyboard commands:</p> |
| 126 |
<p> |
| 127 |
<dl> |
| 128 |
<dt>rot13</dt> |
| 129 |
<dd> |
| 130 |
<p>Rot-13 the selection when activated. Used via keyboard trigger:</p> |
| 131 |
<pre> URxvt.keysym.C-M-r: perl:selection:rot13 |
| 132 |
|
| 133 |
</pre> |
| 134 |
</dd> |
| 135 |
</dl> |
| 136 |
</p> |
| 137 |
</dd> |
| 138 |
<dt>option-popup (enabled by default)</dt> |
| 139 |
<dd> |
| 140 |
<p>Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at |
| 141 |
runtime.</p> |
| 142 |
<p>Other extensions can extend this popup menu by pushing a code reference |
| 143 |
onto <code>@{ $term-</code>{option_popup_hook} }>, which gets called whenever the |
| 144 |
popup is being displayed.</p> |
| 145 |
<p>It's sole argument is the popup menu, which can be modified. It should |
| 146 |
either return nothing or a string, the initial boolean value and a code |
| 147 |
reference. The string will be used as button text and the code reference |
| 148 |
will be called when the toggle changes, with the new boolean value as |
| 149 |
first argument.</p> |
| 150 |
<p>The following will add an entry <code>myoption</code> that changes |
| 151 |
<code>$self-</code>{myoption}>:</p> |
| 152 |
<pre> push @{ $self->{term}{option_popup_hook} }, sub { |
| 153 |
("my option" => $myoption, sub { $self->{myoption} = $_[0] }) |
| 154 |
}; |
| 155 |
|
| 156 |
</pre> |
| 157 |
</dd> |
| 158 |
<dt>selection-popup (enabled by default)</dt> |
| 159 |
<dd> |
| 160 |
<p>Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
| 161 |
text into various other formats/action (such as uri unescaping, perl |
| 162 |
evaluation, web-browser starting etc.), depending on content.</p> |
| 163 |
<p>Other extensions can extend this popup menu by pushing a code reference |
| 164 |
onto <code>@{ $term-</code>{selection_popup_hook} }>, which gets called whenever the |
| 165 |
popup is being displayed.</p> |
| 166 |
<p>It's sole argument is the popup menu, which can be modified. The selection |
| 167 |
is in <code>$_</code>, which can be used to decide whether to add something or not. |
| 168 |
It should either return nothing or a string and a code reference. The |
| 169 |
string will be used as button text and the code reference will be called |
| 170 |
when the button gets activated and should transform <code>$_</code>.</p> |
| 171 |
<p>The following will add an entry <code>a to b</code> that transforms all <code>a</code>s in |
| 172 |
the selection to <code>b</code>s, but only if the selection currently contains any |
| 173 |
<code>a</code>s:</p> |
| 174 |
<pre> push @{ $self->{term}{selection_popup_hook} }, sub { |
| 175 |
/a/ ? ("a to be" => sub { s/a/b/g } |
| 176 |
: () |
| 177 |
}; |
| 178 |
|
| 179 |
</pre> |
| 180 |
</dd> |
| 181 |
<dt>searchable-scrollback<hotkey> (enabled by default)</dt> |
| 182 |
<dd> |
| 183 |
<p>Adds regex search functionality to the scrollback buffer, triggered |
| 184 |
by a hotkey (default: <code>M-s</code>). While in search mode, normal terminal |
| 185 |
input/output is suspended and a regex is displayed at the bottom of the |
| 186 |
screen.</p> |
| 187 |
<p>Inputting characters appends them to the regex and continues incremental |
| 188 |
search. <code>BackSpace</code> removes a character from the regex, <code>Up</code> and <code>Down</code> |
| 189 |
search upwards/downwards in the scrollback buffer, <code>End</code> jumps to the |
| 190 |
bottom. <code>Escape</code> leaves search mode and returns to the point where search |
| 191 |
was started, while <code>Enter</code> or <code>Return</code> stay at the current position and |
| 192 |
additionally stores the first match in the current line into the primary |
| 193 |
selection.</p> |
| 194 |
<p>The regex defaults to "(?i)", resulting in a case-insensitive search. To |
| 195 |
get a case-sensitive search you can delete this prefix using <code>BackSpace</code> |
| 196 |
or simply use an uppercase character which removes the "(?i)" prefix.</p> |
| 197 |
<p>See <cite>perlre</cite> for more info about perl regular expression syntax.</p> |
| 198 |
</dd> |
| 199 |
<dt>readline (enabled by default)</dt> |
| 200 |
<dd> |
| 201 |
<p>A support package that tries to make editing with readline easier. At |
| 202 |
the moment, it reacts to clicking shift-left mouse button by trying to |
| 203 |
move the text cursor to this position. It does so by generating as many |
| 204 |
cursor-left or cursor-right keypresses as required (the this only works |
| 205 |
for programs that correctly support wide characters).</p> |
| 206 |
<p>To avoid too many false positives, this is only done when:</p> |
| 207 |
<p> |
| 208 |
<dl> |
| 209 |
<dt>- the tty is in ICANON state.</dt> |
| 210 |
<dt>- the text cursor is visible.</dt> |
| 211 |
<dt>- the primary screen is currently being displayed.</dt> |
| 212 |
<dt>- the mouse is on the same (multi-row-) line as the text cursor.</dt> |
| 213 |
</dl> |
| 214 |
</p> |
| 215 |
<p>The normal selection mechanism isn't disabled, so quick successive clicks |
| 216 |
might interfere with selection creation in harmless ways.</p> |
| 217 |
</dd> |
| 218 |
<dt>selection-autotransform</dt> |
| 219 |
<dd> |
| 220 |
<p>This selection allows you to do automatic transforms on a selection |
| 221 |
whenever a selection is made.</p> |
| 222 |
<p>It works by specifying perl snippets (most useful is a single <code>s///</code> |
| 223 |
operator) that modify <code>$_</code> as resources:</p> |
| 224 |
<pre> URxvt.selection-autotransform.0: transform |
| 225 |
URxvt.selection-autotransform.1: transform |
| 226 |
... |
| 227 |
|
| 228 |
</pre> |
| 229 |
<p>For example, the following will transform selections of the form |
| 230 |
<code>filename:number</code>, often seen in compiler messages, into <code>vi +$filename |
| 231 |
$word</code>:</p> |
| 232 |
<pre> URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ |
| 233 |
|
| 234 |
</pre> |
| 235 |
<p>And this example matches the same,but replaces it with vi-commands you can |
| 236 |
paste directly into your (vi :) editor:</p> |
| 237 |
<pre> URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/ |
| 238 |
|
| 239 |
</pre> |
| 240 |
<p>Of course, this can be modified to suit your needs and your editor :)</p> |
| 241 |
<p>To expand the example above to typical perl error messages ("XXX at |
| 242 |
FILENAME line YYY."), you need a slightly more elaborate solution:</p> |
| 243 |
<pre> URxvt.selection.pattern-0: ( at .*? line \\d+[,.]) |
| 244 |
URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/ |
| 245 |
|
| 246 |
</pre> |
| 247 |
<p>The first line tells the selection code to treat the unchanging part of |
| 248 |
every error message as a selection pattern, and the second line transforms |
| 249 |
the message into vi commands to load the file.</p> |
| 250 |
</dd> |
| 251 |
<dt>tabbed</dt> |
| 252 |
<dd> |
| 253 |
<p>This transforms the terminal into a tabbar with additional terminals, that |
| 254 |
is, it implements what is commonly referred to as "tabbed terminal". The topmost line |
| 255 |
displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one |
| 256 |
button per tab.</p> |
| 257 |
<p>Clicking a button will activate that tab. Pressing <strong>Shift-Left</strong> and |
| 258 |
<strong>Shift-Right</strong> will switch to the tab left or right of the current one, |
| 259 |
while <strong>Shift-Down</strong> creates a new tab.</p> |
| 260 |
<p>The tabbar itself can be configured similarly to a normal terminal, but |
| 261 |
with a resource class of <code>URxvt.tabbed</code>. In addition, it supports the |
| 262 |
following four resources (shown with defaults):</p> |
| 263 |
<pre> URxvt.tabbed.tabbar-fg: <colour-index, default 3> |
| 264 |
URxvt.tabbed.tabbar-bg: <colour-index, default 0> |
| 265 |
URxvt.tabbed.tab-fg: <colour-index, default 0> |
| 266 |
URxvt.tabbed.tab-bg: <colour-index, default 1> |
| 267 |
|
| 268 |
</pre> |
| 269 |
<p>See <i>COLOR AND GRAPHICS</i> in the rxvt(1) manpage for valid |
| 270 |
indices.</p> |
| 271 |
</dd> |
| 272 |
<dt>matcher</dt> |
| 273 |
<dd> |
| 274 |
<p>Uses per-line display filtering (<code>on_line_update</code>) to underline text |
| 275 |
matching a certain pattern and make it clickable. When clicked with the |
| 276 |
mouse button specified in the <code>matcher.button</code> resource (default 2, or |
| 277 |
middle), the program specified in the <code>matcher.launcher</code> resource |
| 278 |
(default, the <code>urlLauncher</code> resource, <code>sensible-browser</code>) will be started |
| 279 |
with the matched text as first argument. The default configuration is |
| 280 |
suitable for matching URLs and launching a web browser, like the |
| 281 |
former "mark-urls" extension.</p> |
| 282 |
<p>The default pattern to match URLs can be overridden with the |
| 283 |
<code>matcher.pattern.0</code> resource, and additional patterns can be specified |
| 284 |
with numbered patterns, in a manner similar to the "selection" extension. |
| 285 |
The launcher can also be overridden on a per-pattern basis.</p> |
| 286 |
<p>It is possible to activate the most recently seen match from the keyboard. |
| 287 |
Simply bind a keysym to "perl:matcher" as seen in the example below.</p> |
| 288 |
<p>Example configuration:</p> |
| 289 |
<pre> URxvt.perl-ext: default,matcher |
| 290 |
URxvt.urlLauncher: sensible-browser |
| 291 |
URxvt.keysym.C-Delete: perl:matcher |
| 292 |
URxvt.matcher.button: 1 |
| 293 |
URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-] |
| 294 |
URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$) |
| 295 |
URxvt.matcher.launcher.2: gvim +$2 $1 |
| 296 |
|
| 297 |
</pre> |
| 298 |
</dd> |
| 299 |
<dt>xim-onthespot</dt> |
| 300 |
<dd> |
| 301 |
<p>This (experimental) perl extension implements OnTheSpot editing. It does |
| 302 |
not work perfectly, and some input methods don't seem to work well with |
| 303 |
OnTheSpot editing in general, but it seems to work at leats for SCIM and |
| 304 |
kinput2.</p> |
| 305 |
<p>You enable it by specifying this extension and a preedit style of |
| 306 |
<code>OnTheSpot</code>, i.e.:</p> |
| 307 |
<pre> rxvt -pt OnTheSpot -pe xim-onthespot |
| 308 |
|
| 309 |
</pre> |
| 310 |
</dd> |
| 311 |
<dt>kuake<hotkey></dt> |
| 312 |
<dd> |
| 313 |
<p>A very primitive quake-console-like extension. It was inspired by a |
| 314 |
description of how the programs <code>kuake</code> and <code>yakuake</code> work: Whenever the |
| 315 |
user presses a global accelerator key (by default <code>F10</code>), the terminal |
| 316 |
will show or hide itself. Another press of the accelerator key will hide |
| 317 |
or show it again.</p> |
| 318 |
<p>Initially, the window will not be shown when using this extension.</p> |
| 319 |
<p>This is useful if you need a single terminal thats not using any desktop |
| 320 |
space most of the time but is quickly available at the press of a key.</p> |
| 321 |
<p>The accelerator key is grabbed regardless of any modifiers, so this |
| 322 |
extension will actually grab a physical key just for this function.</p> |
| 323 |
<p>If you want a quake-like animation, tell your window manager to do so |
| 324 |
(fvwm can do it).</p> |
| 325 |
</dd> |
| 326 |
<dt>automove-background</dt> |
| 327 |
<dd> |
| 328 |
<p>This is basically a very small extension that dynamically changes the |
| 329 |
background pixmap offset to the window position, in effect creating the |
| 330 |
same effect as pseudo transparency with a custom pixmap. No scaling is |
| 331 |
supported in this mode. Example:</p> |
| 332 |
<pre> rxvt -pixmap background.xpm -pe automove-background |
| 333 |
|
| 334 |
</pre> |
| 335 |
<p><a href="http://wiki.archlinux.org/index.php/Perl_Background_Rotation/Extensions">http://wiki.archlinux.org/index.php/Perl_Background_Rotation/Extensions</a> |
| 336 |
shows how this extension can be used to implement an automatically blurred |
| 337 |
transparent background.</p> |
| 338 |
</dd> |
| 339 |
<dt>block-graphics-to-ascii</dt> |
| 340 |
<dd> |
| 341 |
<p>A not very useful example of filtering all text output to the terminal |
| 342 |
by replacing all line-drawing characters (U+2500 .. U+259F) by a |
| 343 |
similar-looking ascii character.</p> |
| 344 |
</dd> |
| 345 |
<dt>digital-clock</dt> |
| 346 |
<dd> |
| 347 |
<p>Displays a digital clock using the built-in overlay.</p> |
| 348 |
</dd> |
| 349 |
<dt>remote-clipboard</dt> |
| 350 |
<dd> |
| 351 |
<p>Somewhat of a misnomer, this extension adds two menu entries to the |
| 352 |
selection popup that allows one ti run external commands to store the |
| 353 |
selection somewhere and fetch it again.</p> |
| 354 |
<p>We use it to implement a "distributed selection mechanism", which just |
| 355 |
means that one command uploads the file to a remote server, and another |
| 356 |
reads it.</p> |
| 357 |
<p>The commands can be set using the <code>URxvt.remote-selection.store</code> and |
| 358 |
<code>URxvt.remote-selection.fetch</code> resources. The first should read the |
| 359 |
selection to store from STDIN (always in UTF-8), the second should provide |
| 360 |
the selection data on STDOUT (also in UTF-8).</p> |
| 361 |
<p>The defaults (which are likely useless to you) use rsh and cat:</p> |
| 362 |
<pre> URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' |
| 363 |
URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' |
| 364 |
|
| 365 |
</pre> |
| 366 |
</dd> |
| 367 |
<dt>selection-pastebin</dt> |
| 368 |
<dd> |
| 369 |
<p>This is a little rarely useful extension that Uploads the selection as |
| 370 |
textfile to a remote site (or does other things). (The implementation is |
| 371 |
not currently secure for use in a multiuser environment as it writes to |
| 372 |
<cite>/tmp</cite> directly.).</p> |
| 373 |
<p>It listens to the <code>selection-pastebin:remote-pastebin</code> keyboard command, |
| 374 |
i.e.</p> |
| 375 |
<pre> URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin |
| 376 |
|
| 377 |
</pre> |
| 378 |
<p>Pressing this combination runs a command with <code>%</code> replaced by the name of |
| 379 |
the textfile. This command can be set via a resource:</p> |
| 380 |
<pre> URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/. |
| 381 |
|
| 382 |
</pre> |
| 383 |
<p>And the default is likely not useful to anybody but the few people around |
| 384 |
here :)</p> |
| 385 |
<p>The name of the textfile is the hex encoded md5 sum of the selection, so |
| 386 |
the same content should lead to the same filename.</p> |
| 387 |
<p>After a successful upload the selection will be replaced by the text given |
| 388 |
in the <code>selection-pastebin-url</code> resource (again, the % is the placeholder |
| 389 |
for the filename):</p> |
| 390 |
<pre> URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
| 391 |
|
| 392 |
</pre> |
| 393 |
<p><i>Note to xrdb users:</i> xrdb uses the C preprocessor, which might interpret |
| 394 |
the double <code>/</code> characters as comment start. Use <code>\057\057</code> instead, |
| 395 |
which works regardless of wether xrdb is used to parse the resource file |
| 396 |
or not.</p> |
| 397 |
</dd> |
| 398 |
<dt>example-refresh-hooks</dt> |
| 399 |
<dd> |
| 400 |
<p>Displays a very simple digital clock in the upper right corner of the |
| 401 |
window. Illustrates overwriting the refresh callbacks to create your own |
| 402 |
overlays or changes.</p> |
| 403 |
</dd> |
| 404 |
</dl> |
| 405 |
|
| 406 |
</div> |
| 407 |
<h1 id="API_DOCUMENTATION">API DOCUMENTATION</h1><p><a href="#TOP" class="toplink">Top</a></p> |
| 408 |
<div id="API_DOCUMENTATION_CONTENT"> |
| 409 |
|
| 410 |
</div> |
| 411 |
<h2 id="General_API_Considerations">General API Considerations</h2> |
| 412 |
<div id="General_API_Considerations_CONTENT"> |
| 413 |
<p>All objects (such as terminals, time watchers etc.) are typical |
| 414 |
reference-to-hash objects. The hash can be used to store anything you |
| 415 |
like. All members starting with an underscore (such as <code>_ptr</code> or |
| 416 |
<code>_hook</code>) are reserved for internal uses and <strong>MUST NOT</strong> be accessed or |
| 417 |
modified).</p> |
| 418 |
<p>When objects are destroyed on the C++ side, the perl object hashes are |
| 419 |
emptied, so its best to store related objects such as time watchers and |
| 420 |
the like inside the terminal object so they get destroyed as soon as the |
| 421 |
terminal is destroyed.</p> |
| 422 |
<p>Argument names also often indicate the type of a parameter. Here are some |
| 423 |
hints on what they mean:</p> |
| 424 |
<dl> |
| 425 |
<dt>$text</dt> |
| 426 |
<dd> |
| 427 |
<p>Rxvt-unicodes special way of encoding text, where one "unicode" character |
| 428 |
always represents one screen cell. See <cite>ROW_t</cite> for a discussion of this format.</p> |
| 429 |
</dd> |
| 430 |
<dt>$string</dt> |
| 431 |
<dd> |
| 432 |
<p>A perl text string, with an emphasis on <i>text</i>. It can store all unicode |
| 433 |
characters and is to be distinguished with text encoded in a specific |
| 434 |
encoding (often locale-specific) and binary data.</p> |
| 435 |
</dd> |
| 436 |
<dt>$octets</dt> |
| 437 |
<dd> |
| 438 |
<p>Either binary data or - more common - a text string encoded in a |
| 439 |
locale-specific way.</p> |
| 440 |
</dd> |
| 441 |
</dl> |
| 442 |
|
| 443 |
</div> |
| 444 |
<h2 id="Extension_Objects">Extension Objects</h2> |
| 445 |
<div id="Extension_Objects_CONTENT"> |
| 446 |
<p>Every perl extension is a perl class. A separate perl object is created |
| 447 |
for each terminal, and each terminal has its own set of extenion objects, |
| 448 |
which are passed as the first parameter to hooks. So extensions can use |
| 449 |
their <code>$self</code> object without having to think about clashes with other |
| 450 |
extensions or other terminals, with the exception of methods and members |
| 451 |
that begin with an underscore character <code>_</code>: these are reserved for |
| 452 |
internal use.</p> |
| 453 |
<p>Although it isn't a <code>urxvt::term</code> object, you can call all methods of the |
| 454 |
<code>urxvt::term</code> class on this object.</p> |
| 455 |
<p>It has the following methods and data members:</p> |
| 456 |
<dl> |
| 457 |
<dt>$urxvt_term = $self->{term}</dt> |
| 458 |
<dd> |
| 459 |
<p>Returns the <code>urxvt::term</code> object associated with this instance of the |
| 460 |
extension. This member <i>must not</i> be changed in any way.</p> |
| 461 |
</dd> |
| 462 |
<dt>$self->enable ($hook_name => $cb, [$hook_name => $cb..])</dt> |
| 463 |
<dd> |
| 464 |
<p>Dynamically enable the given hooks (named without the <code>on_</code> prefix) for |
| 465 |
this extension, replacing any previous hook. This is useful when you want |
| 466 |
to overwrite time-critical hooks only temporarily.</p> |
| 467 |
</dd> |
| 468 |
<dt>$self->disable ($hook_name[, $hook_name..])</dt> |
| 469 |
<dd> |
| 470 |
<p>Dynamically disable the given hooks.</p> |
| 471 |
</dd> |
| 472 |
</dl> |
| 473 |
|
| 474 |
</div> |
| 475 |
<h2 id="Hooks">Hooks</h2> |
| 476 |
<div id="Hooks_CONTENT"> |
| 477 |
<p>The following subroutines can be declared in extension files, and will be |
| 478 |
called whenever the relevant event happens.</p> |
| 479 |
<p>The first argument passed to them is an extension object as described in |
| 480 |
the in the <code>Extension Objects</code> section.</p> |
| 481 |
<p><strong>All</strong> of these hooks must return a boolean value. If any of the called |
| 482 |
hooks returns true, then the event counts as being <i>consumed</i>, and the |
| 483 |
relevant action might not be carried out by the C++ code.</p> |
| 484 |
<p><i>When in doubt, return a false value (preferably <code>()</code>).</i></p> |
| 485 |
<dl> |
| 486 |
<dt>on_init $term</dt> |
| 487 |
<dd> |
| 488 |
<p>Called after a new terminal object has been initialized, but before |
| 489 |
windows are created or the command gets run. Most methods are unsafe to |
| 490 |
call or deliver senseless data, as terminal size and other characteristics |
| 491 |
have not yet been determined. You can safely query and change resources |
| 492 |
and options, though. For many purposes the <code>on_start</code> hook is a better |
| 493 |
place.</p> |
| 494 |
</dd> |
| 495 |
<dt>on_start $term</dt> |
| 496 |
<dd> |
| 497 |
<p>Called at the very end of initialisation of a new terminal, just before |
| 498 |
trying to map (display) the toplevel and returning to the main loop.</p> |
| 499 |
</dd> |
| 500 |
<dt>on_destroy $term</dt> |
| 501 |
<dd> |
| 502 |
<p>Called whenever something tries to destroy terminal, when the terminal is |
| 503 |
still fully functional (not for long, though).</p> |
| 504 |
</dd> |
| 505 |
<dt>on_reset $term</dt> |
| 506 |
<dd> |
| 507 |
<p>Called after the screen is "reset" for any reason, such as resizing or |
| 508 |
control sequences. Here is where you can react on changes to size-related |
| 509 |
variables.</p> |
| 510 |
</dd> |
| 511 |
<dt>on_child_start $term, $pid</dt> |
| 512 |
<dd> |
| 513 |
<p>Called just after the child process has been <code>fork</code>ed.</p> |
| 514 |
</dd> |
| 515 |
<dt>on_child_exit $term, $status</dt> |
| 516 |
<dd> |
| 517 |
<p>Called just after the child process has exited. <code>$status</code> is the status |
| 518 |
from <code>waitpid</code>.</p> |
| 519 |
</dd> |
| 520 |
<dt>on_sel_make $term, $eventtime</dt> |
| 521 |
<dd> |
| 522 |
<p>Called whenever a selection has been made by the user, but before the |
| 523 |
selection text is copied, so changes to the beginning, end or type of the |
| 524 |
selection will be honored.</p> |
| 525 |
<p>Returning a true value aborts selection making by urxvt, in which case you |
| 526 |
have to make a selection yourself by calling <code>$term->selection_grab</code>.</p> |
| 527 |
</dd> |
| 528 |
<dt>on_sel_grab $term, $eventtime</dt> |
| 529 |
<dd> |
| 530 |
<p>Called whenever a selection has been copied, but before the selection is |
| 531 |
requested from the server. The selection text can be queried and changed |
| 532 |
by calling <code>$term->selection</code>.</p> |
| 533 |
<p>Returning a true value aborts selection grabbing. It will still be highlighted.</p> |
| 534 |
</dd> |
| 535 |
<dt>on_sel_extend $term</dt> |
| 536 |
<dd> |
| 537 |
<p>Called whenever the user tries to extend the selection (e.g. with a double |
| 538 |
click) and is either supposed to return false (normal operation), or |
| 539 |
should extend the selection itself and return true to suppress the built-in |
| 540 |
processing. This can happen multiple times, as long as the callback |
| 541 |
returns true, it will be called on every further click by the user and is |
| 542 |
supposed to enlarge the selection more and more, if possible.</p> |
| 543 |
<p>See the <cite>selection</cite> example extension.</p> |
| 544 |
</dd> |
| 545 |
<dt>on_view_change $term, $offset</dt> |
| 546 |
<dd> |
| 547 |
<p>Called whenever the view offset changes, i.e. the user or program |
| 548 |
scrolls. Offset <code>0</code> means display the normal terminal, positive values |
| 549 |
show this many lines of scrollback.</p> |
| 550 |
</dd> |
| 551 |
<dt>on_scroll_back $term, $lines, $saved</dt> |
| 552 |
<dd> |
| 553 |
<p>Called whenever lines scroll out of the terminal area into the scrollback |
| 554 |
buffer. <code>$lines</code> is the number of lines scrolled out and may be larger |
| 555 |
than the scroll back buffer or the terminal.</p> |
| 556 |
<p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
| 557 |
$nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total |
| 558 |
number of lines that will be in the scrollback buffer.</p> |
| 559 |
</dd> |
| 560 |
<dt>on_osc_seq $term, $op, $args</dt> |
| 561 |
<dd> |
| 562 |
<p>Called on every OSC sequence and can be used to suppress it or modify its |
| 563 |
behaviour. The default should be to return an empty list. A true value |
| 564 |
suppresses execution of the request completely. Make sure you don't get |
| 565 |
confused by recursive invocations when you output an osc sequence within |
| 566 |
this callback.</p> |
| 567 |
<p><code>on_osc_seq_perl</code> should be used for new behaviour.</p> |
| 568 |
</dd> |
| 569 |
<dt>on_osc_seq_perl $term, $string</dt> |
| 570 |
<dd> |
| 571 |
<p>Called whenever the <strong>ESC ] 777 ; string ST</strong> command sequence (OSC = |
| 572 |
operating system command) is processed. Cursor position and other state |
| 573 |
information is up-to-date when this happens. For interoperability, the |
| 574 |
string should start with the extension name and a colon, to distinguish |
| 575 |
it from commands for other extensions, and this might be enforced in the |
| 576 |
future.</p> |
| 577 |
<p>Be careful not ever to trust (in a security sense) the data you receive, |
| 578 |
as its source can not easily be controlled (e-mail content, messages from |
| 579 |
other users on the same system etc.).</p> |
| 580 |
</dd> |
| 581 |
<dt>on_add_lines $term, $string</dt> |
| 582 |
<dd> |
| 583 |
<p>Called whenever text is about to be output, with the text as argument. You |
| 584 |
can filter/change and output the text yourself by returning a true value |
| 585 |
and calling <code>$term->scr_add_lines</code> yourself. Please note that this |
| 586 |
might be very slow, however, as your hook is called for <strong>all</strong> text being |
| 587 |
output.</p> |
| 588 |
</dd> |
| 589 |
<dt>on_tt_write $term, $octets</dt> |
| 590 |
<dd> |
| 591 |
<p>Called whenever some data is written to the tty/pty and can be used to |
| 592 |
suppress or filter tty input.</p> |
| 593 |
</dd> |
| 594 |
<dt>on_line_update $term, $row</dt> |
| 595 |
<dd> |
| 596 |
<p>Called whenever a line was updated or changed. Can be used to filter |
| 597 |
screen output (e.g. underline urls or other useless stuff). Only lines |
| 598 |
that are being shown will be filtered, and, due to performance reasons, |
| 599 |
not always immediately.</p> |
| 600 |
<p>The row number is always the topmost row of the line if the line spans |
| 601 |
multiple rows.</p> |
| 602 |
<p>Please note that, if you change the line, then the hook might get called |
| 603 |
later with the already-modified line (e.g. if unrelated parts change), so |
| 604 |
you cannot just toggle rendition bits, but only set them.</p> |
| 605 |
</dd> |
| 606 |
<dt>on_refresh_begin $term</dt> |
| 607 |
<dd> |
| 608 |
<p>Called just before the screen gets redrawn. Can be used for overlay |
| 609 |
or similar effects by modify terminal contents in refresh_begin, and |
| 610 |
restoring them in refresh_end. The built-in overlay and selection display |
| 611 |
code is run after this hook, and takes precedence.</p> |
| 612 |
</dd> |
| 613 |
<dt>on_refresh_end $term</dt> |
| 614 |
<dd> |
| 615 |
<p>Called just after the screen gets redrawn. See <code>on_refresh_begin</code>.</p> |
| 616 |
</dd> |
| 617 |
<dt>on_user_command $term, $string</dt> |
| 618 |
<dd> |
| 619 |
<p>Called whenever a user-configured event is being activated (e.g. via |
| 620 |
a <code>perl:string</code> action bound to a key, see description of the <strong>keysym</strong> |
| 621 |
resource in the rxvt(1) manpage).</p> |
| 622 |
<p>The event is simply the action string. This interface is assumed to change |
| 623 |
slightly in the future.</p> |
| 624 |
</dd> |
| 625 |
<dt>on_resize_all_windows $tern, $new_width, $new_height</dt> |
| 626 |
<dd> |
| 627 |
<p>Called just after the new window size has been calculated, but before |
| 628 |
windows are actually being resized or hints are being set. If this hook |
| 629 |
returns TRUE, setting of the window hints is being skipped.</p> |
| 630 |
</dd> |
| 631 |
<dt>on_x_event $term, $event</dt> |
| 632 |
<dd> |
| 633 |
<p>Called on every X event received on the vt window (and possibly other |
| 634 |
windows). Should only be used as a last resort. Most event structure |
| 635 |
members are not passed.</p> |
| 636 |
</dd> |
| 637 |
<dt>on_root_event $term, $event</dt> |
| 638 |
<dd> |
| 639 |
<p>Like <code>on_x_event</code>, but is called for events on the root window.</p> |
| 640 |
</dd> |
| 641 |
<dt>on_focus_in $term</dt> |
| 642 |
<dd> |
| 643 |
<p>Called whenever the window gets the keyboard focus, before rxvt-unicode |
| 644 |
does focus in processing.</p> |
| 645 |
</dd> |
| 646 |
<dt>on_focus_out $term</dt> |
| 647 |
<dd> |
| 648 |
<p>Called whenever the window loses keyboard focus, before rxvt-unicode does |
| 649 |
focus out processing.</p> |
| 650 |
</dd> |
| 651 |
<dt>on_configure_notify $term, $event</dt> |
| 652 |
<dt>on_property_notify $term, $event</dt> |
| 653 |
<dt>on_key_press $term, $event, $keysym, $octets</dt> |
| 654 |
<dt>on_key_release $term, $event, $keysym</dt> |
| 655 |
<dt>on_button_press $term, $event</dt> |
| 656 |
<dt>on_button_release $term, $event</dt> |
| 657 |
<dt>on_motion_notify $term, $event</dt> |
| 658 |
<dt>on_map_notify $term, $event</dt> |
| 659 |
<dt>on_unmap_notify $term, $event</dt> |
| 660 |
<dd> |
| 661 |
<p>Called whenever the corresponding X event is received for the terminal If |
| 662 |
the hook returns true, then the even will be ignored by rxvt-unicode.</p> |
| 663 |
<p>The event is a hash with most values as named by Xlib (see the XEvent |
| 664 |
manpage), with the additional members <code>row</code> and <code>col</code>, which are the |
| 665 |
(real, not screen-based) row and column under the mouse cursor.</p> |
| 666 |
<p><code>on_key_press</code> additionally receives the string rxvt-unicode would |
| 667 |
output, if any, in locale-specific encoding.</p> |
| 668 |
<p>subwindow.</p> |
| 669 |
</dd> |
| 670 |
<dt>on_client_message $term, $event</dt> |
| 671 |
<dt>on_wm_protocols $term, $event</dt> |
| 672 |
<dt>on_wm_delete_window $term, $event</dt> |
| 673 |
<dd> |
| 674 |
<p>Called when various types of ClientMessage events are received (all with |
| 675 |
format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).</p> |
| 676 |
</dd> |
| 677 |
</dl> |
| 678 |
|
| 679 |
</div> |
| 680 |
<h2 id="Variables_in_the_code_urxvt_code_Pac">Variables in the <code>urxvt</code> Package</h2> |
| 681 |
<div id="Variables_in_the_code_urxvt_code_Pac-2"> |
| 682 |
<dl> |
| 683 |
<dt>$urxvt::LIBDIR</dt> |
| 684 |
<dd> |
| 685 |
<p>The rxvt-unicode library directory, where, among other things, the perl |
| 686 |
modules and scripts are stored.</p> |
| 687 |
</dd> |
| 688 |
<dt>$urxvt::RESCLASS, $urxvt::RESCLASS</dt> |
| 689 |
<dd> |
| 690 |
<p>The resource class and name rxvt-unicode uses to look up X resources.</p> |
| 691 |
</dd> |
| 692 |
<dt>$urxvt::RXVTNAME</dt> |
| 693 |
<dd> |
| 694 |
<p>The basename of the installed binaries, usually <code>urxvt</code>.</p> |
| 695 |
</dd> |
| 696 |
<dt>$urxvt::TERM</dt> |
| 697 |
<dd> |
| 698 |
<p>The current terminal. This variable stores the current <code>urxvt::term</code> |
| 699 |
object, whenever a callback/hook is executing.</p> |
| 700 |
</dd> |
| 701 |
<dt>@urxvt::TERM_INIT</dt> |
| 702 |
<dd> |
| 703 |
<p>All code references in this array will be called as methods of the next newly |
| 704 |
created <code>urxvt::term</code> object (during the <code>on_init</code> phase). The array |
| 705 |
gets cleared before the code references that were in it are being executed, |
| 706 |
so references can push themselves onto it again if they so desire.</p> |
| 707 |
<p>This complements to the perl-eval command line option, but gets executed |
| 708 |
first.</p> |
| 709 |
</dd> |
| 710 |
<dt>@urxvt::TERM_EXT</dt> |
| 711 |
<dd> |
| 712 |
<p>Works similar to <code>@TERM_INIT</code>, but contains perl package/class names, which |
| 713 |
get registered as normal extensions after calling the hooks in <code>@TERM_INIT</code> |
| 714 |
but before other extensions. Gets cleared just like <code>@TERM_INIT</code>.</p> |
| 715 |
</dd> |
| 716 |
</dl> |
| 717 |
|
| 718 |
</div> |
| 719 |
<h2 id="Functions_in_the_code_urxvt_code_Pac">Functions in the <code>urxvt</code> Package</h2> |
| 720 |
<div id="Functions_in_the_code_urxvt_code_Pac-2"> |
| 721 |
<dl> |
| 722 |
<dt>urxvt::fatal $errormessage</dt> |
| 723 |
<dd> |
| 724 |
<p>Fatally aborts execution with the given error message. Avoid at all |
| 725 |
costs! The only time this is acceptable is when the terminal process |
| 726 |
starts up.</p> |
| 727 |
</dd> |
| 728 |
<dt>urxvt::warn $string</dt> |
| 729 |
<dd> |
| 730 |
<p>Calls <code>rxvt_warn</code> with the given string which should not include a |
| 731 |
newline. The module also overwrites the <code>warn</code> builtin with a function |
| 732 |
that calls this function.</p> |
| 733 |
<p>Using this function has the advantage that its output ends up in the |
| 734 |
correct place, e.g. on stderr of the connecting urxvtc client.</p> |
| 735 |
<p>Messages have a size limit of 1023 bytes currently.</p> |
| 736 |
</dd> |
| 737 |
<dt>@terms = urxvt::termlist</dt> |
| 738 |
<dd> |
| 739 |
<p>Returns all urxvt::term objects that exist in this process, regardless of |
| 740 |
whether they are started, being destroyed etc., so be careful. Only term |
| 741 |
objects that have perl extensions attached will be returned (because there |
| 742 |
is no urxvt::term objet associated with others).</p> |
| 743 |
</dd> |
| 744 |
<dt>$time = urxvt::NOW</dt> |
| 745 |
<dd> |
| 746 |
<p>Returns the "current time" (as per the event loop).</p> |
| 747 |
</dd> |
| 748 |
<dt>urxvt::CurrentTime</dt> |
| 749 |
<dt>urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
| 750 |
Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
| 751 |
Button4Mask, Button5Mask, AnyModifier</dt> |
| 752 |
<dt>urxvt::NoEventMask, KeyPressMask, KeyReleaseMask, |
| 753 |
ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, |
| 754 |
PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask, |
| 755 |
Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask, |
| 756 |
KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask, |
| 757 |
ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask, |
| 758 |
FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask</dt> |
| 759 |
<dt>urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify, |
| 760 |
EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose, |
| 761 |
GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify, |
| 762 |
UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify, |
| 763 |
ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify, |
| 764 |
CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, |
| 765 |
SelectionNotify, ColormapNotify, ClientMessage, MappingNotify</dt> |
| 766 |
<dd> |
| 767 |
<p>Various constants for use in X calls and event processing.</p> |
| 768 |
</dd> |
| 769 |
</dl> |
| 770 |
|
| 771 |
</div> |
| 772 |
<h2 id="RENDITION">RENDITION</h2> |
| 773 |
<div id="RENDITION_CONTENT"> |
| 774 |
<p>Rendition bitsets contain information about colour, font, font styles and |
| 775 |
similar information for each screen cell.</p> |
| 776 |
<p>The following "macros" deal with changes in rendition sets. You should |
| 777 |
never just create a bitset, you should always modify an existing one, |
| 778 |
as they contain important information required for correct operation of |
| 779 |
rxvt-unicode.</p> |
| 780 |
<dl> |
| 781 |
<dt>$rend = urxvt::DEFAULT_RSTYLE</dt> |
| 782 |
<dd> |
| 783 |
<p>Returns the default rendition, as used when the terminal is starting up or |
| 784 |
being reset. Useful as a base to start when creating renditions.</p> |
| 785 |
</dd> |
| 786 |
<dt>$rend = urxvt::OVERLAY_RSTYLE</dt> |
| 787 |
<dd> |
| 788 |
<p>Return the rendition mask used for overlays by default.</p> |
| 789 |
</dd> |
| 790 |
<dt>$rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline</dt> |
| 791 |
<dd> |
| 792 |
<p>Return the bit that enabled bold, italic, blink, reverse-video and |
| 793 |
underline, respectively. To enable such a style, just logically OR it into |
| 794 |
the bitset.</p> |
| 795 |
</dd> |
| 796 |
<dt>$foreground = urxvt::GET_BASEFG $rend</dt> |
| 797 |
<dt>$background = urxvt::GET_BASEBG $rend</dt> |
| 798 |
<dd> |
| 799 |
<p>Return the foreground/background colour index, respectively.</p> |
| 800 |
</dd> |
| 801 |
<dt>$rend = urxvt::SET_FGCOLOR $rend, $new_colour</dt> |
| 802 |
<dt>$rend = urxvt::SET_BGCOLOR $rend, $new_colour</dt> |
| 803 |
<dt>$rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg</dt> |
| 804 |
<dd> |
| 805 |
<p>Replace the foreground/background colour in the rendition mask with the |
| 806 |
specified one.</p> |
| 807 |
</dd> |
| 808 |
<dt>$value = urxvt::GET_CUSTOM $rend</dt> |
| 809 |
<dd> |
| 810 |
<p>Return the "custom" value: Every rendition has 5 bits for use by |
| 811 |
extensions. They can be set and changed as you like and are initially |
| 812 |
zero.</p> |
| 813 |
</dd> |
| 814 |
<dt>$rend = urxvt::SET_CUSTOM $rend, $new_value</dt> |
| 815 |
<dd> |
| 816 |
<p>Change the custom value.</p> |
| 817 |
</dd> |
| 818 |
</dl> |
| 819 |
|
| 820 |
</div> |
| 821 |
<h2 id="The_code_urxvt_anyevent_code_Class">The <code>urxvt::anyevent</code> Class</h2> |
| 822 |
<div id="The_code_urxvt_anyevent_code_Class_C"> |
| 823 |
<p>The sole purpose of this class is to deliver an interface to the |
| 824 |
<code>AnyEvent</code> module - any module using it will work inside urxvt without |
| 825 |
further programming. The only exception is that you cannot wait on |
| 826 |
condition variables, but non-blocking condvar use is ok. What this means |
| 827 |
is that you cannot use blocking APIs, but the non-blocking variant should |
| 828 |
work.</p> |
| 829 |
|
| 830 |
</div> |
| 831 |
<h2 id="The_code_urxvt_term_code_Class">The <code>urxvt::term</code> Class</h2> |
| 832 |
<div id="The_code_urxvt_term_code_Class_CONTE"> |
| 833 |
<dl> |
| 834 |
<dt>$term = new urxvt::term $envhashref, $rxvtname, [arg...]</dt> |
| 835 |
<dd> |
| 836 |
<p>Creates a new terminal, very similar as if you had started it with system |
| 837 |
<code>$rxvtname, arg...</code>. <code>$envhashref</code> must be a reference to a <code>%ENV</code>-like |
| 838 |
hash which defines the environment of the new terminal.</p> |
| 839 |
<p>Croaks (and probably outputs an error message) if the new instance |
| 840 |
couldn't be created. Returns <code>undef</code> if the new instance didn't |
| 841 |
initialise perl, and the terminal object otherwise. The <code>init</code> and |
| 842 |
<code>start</code> hooks will be called before this call returns, and are free to |
| 843 |
refer to global data (which is race free).</p> |
| 844 |
</dd> |
| 845 |
<dt>$term->destroy</dt> |
| 846 |
<dd> |
| 847 |
<p>Destroy the terminal object (close the window, free resources |
| 848 |
etc.). Please note that rxvt will not exit as long as any event |
| 849 |
watchers (timers, io watchers) are still active.</p> |
| 850 |
</dd> |
| 851 |
<dt>$term->exec_async ($cmd[, @args])</dt> |
| 852 |
<dd> |
| 853 |
<p>Works like the combination of the <code>fork</code>/<code>exec</code> builtins, which executes |
| 854 |
("starts") programs in the background. This function takes care of setting |
| 855 |
the user environment before exec'ing the command (e.g. <code>PATH</code>) and should |
| 856 |
be preferred over explicit calls to <code>exec</code> or <code>system</code>.</p> |
| 857 |
<p>Returns the pid of the subprocess or <code>undef</code> on error.</p> |
| 858 |
</dd> |
| 859 |
<dt>$isset = $term->option ($optval[, $set])</dt> |
| 860 |
<dd> |
| 861 |
<p>Returns true if the option specified by <code>$optval</code> is enabled, and |
| 862 |
optionally change it. All option values are stored by name in the hash |
| 863 |
<code>%urxvt::OPTION</code>. Options not enabled in this binary are not in the hash.</p> |
| 864 |
<p>Here is a likely non-exhaustive list of option names, please see the |
| 865 |
source file <cite>/src/optinc.h</cite> to see the actual list:</p> |
| 866 |
<pre> borderLess console cursorBlink cursorUnderline hold iconic insecure |
| 867 |
intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
| 868 |
override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
| 869 |
scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput |
| 870 |
scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs |
| 871 |
transparent tripleclickwords utmpInhibit visualBell |
| 872 |
|
| 873 |
</pre> |
| 874 |
</dd> |
| 875 |
<dt>$value = $term->resource ($name[, $newval])</dt> |
| 876 |
<dd> |
| 877 |
<p>Returns the current resource value associated with a given name and |
| 878 |
optionally sets a new value. Setting values is most useful in the <code>init</code> |
| 879 |
hook. Unset resources are returned and accepted as <code>undef</code>.</p> |
| 880 |
<p>The new value must be properly encoded to a suitable character encoding |
| 881 |
before passing it to this method. Similarly, the returned value may need |
| 882 |
to be converted from the used encoding to text.</p> |
| 883 |
<p>Resource names are as defined in <cite>src/rsinc.h</cite>. Colours can be specified |
| 884 |
as resource names of the form <code>color+<index></code>, e.g. <code>color+5</code>. (will |
| 885 |
likely change).</p> |
| 886 |
<p>Please note that resource strings will currently only be freed when the |
| 887 |
terminal is destroyed, so changing options frequently will eat memory.</p> |
| 888 |
<p>Here is a likely non-exhaustive list of resource names, not all of which |
| 889 |
are supported in every build, please see the source file <cite>/src/rsinc.h</cite> |
| 890 |
to see the actual list:</p> |
| 891 |
<pre> answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
| 892 |
borderLess color cursorBlink cursorUnderline cutchars delete_key |
| 893 |
display_name embed ext_bwidth fade font geometry hold iconName |
| 894 |
imFont imLocale inputMethod insecure int_bwidth intensityStyles |
| 895 |
italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier |
| 896 |
mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
| 897 |
perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
| 898 |
preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
| 899 |
scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
| 900 |
scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
| 901 |
secondaryScreen secondaryScroll selectstyle shade term_name title |
| 902 |
transient_for transparent transparent_all tripleclickwords utmpInhibit |
| 903 |
visualBell |
| 904 |
|
| 905 |
</pre> |
| 906 |
</dd> |
| 907 |
<dt>$value = $term->x_resource ($pattern)</dt> |
| 908 |
<dd> |
| 909 |
<p>Returns the X-Resource for the given pattern, excluding the program or |
| 910 |
class name, i.e. <code>$term->x_resource ("boldFont")</code> should return the |
| 911 |
same value as used by this instance of rxvt-unicode. Returns <code>undef</code> if no |
| 912 |
resource with that pattern exists.</p> |
| 913 |
<p>This method should only be called during the <code>on_start</code> hook, as there is |
| 914 |
only one resource database per display, and later invocations might return |
| 915 |
the wrong resources.</p> |
| 916 |
</dd> |
| 917 |
<dt>$success = $term->parse_keysym ($keysym_spec, $command_string)</dt> |
| 918 |
<dd> |
| 919 |
<p>Adds a keymap translation exactly as specified via a resource. See the |
| 920 |
<code>keysym</code> resource in the rxvt(1) manpage.</p> |
| 921 |
</dd> |
| 922 |
<dt>$rend = $term->rstyle ([$new_rstyle])</dt> |
| 923 |
<dd> |
| 924 |
<p>Return and optionally change the current rendition. Text that is output by |
| 925 |
the terminal application will use this style.</p> |
| 926 |
</dd> |
| 927 |
<dt>($row, $col) = $term->screen_cur ([$row, $col])</dt> |
| 928 |
<dd> |
| 929 |
<p>Return the current coordinates of the text cursor position and optionally |
| 930 |
set it (which is usually bad as applications don't expect that).</p> |
| 931 |
</dd> |
| 932 |
<dt>($row, $col) = $term->selection_mark ([$row, $col])</dt> |
| 933 |
<dt>($row, $col) = $term->selection_beg ([$row, $col])</dt> |
| 934 |
<dt>($row, $col) = $term->selection_end ([$row, $col])</dt> |
| 935 |
<dd> |
| 936 |
<p>Return the current values of the selection mark, begin or end positions, |
| 937 |
and optionally set them to new values.</p> |
| 938 |
</dd> |
| 939 |
<dt>$term->selection_make ($eventtime[, $rectangular])</dt> |
| 940 |
<dd> |
| 941 |
<p>Tries to make a selection as set by <code>selection_beg</code> and |
| 942 |
<code>selection_end</code>. If <code>$rectangular</code> is true (default: false), a |
| 943 |
rectangular selection will be made. This is the prefered function to make |
| 944 |
a selection.</p> |
| 945 |
</dd> |
| 946 |
<dt>$success = $term->selection_grab ($eventtime)</dt> |
| 947 |
<dd> |
| 948 |
<p>Try to request the primary selection text from the server (for example, as |
| 949 |
set by the next method). No visual feedback will be given. This function |
| 950 |
is mostly useful from within <code>on_sel_grab</code> hooks.</p> |
| 951 |
</dd> |
| 952 |
<dt>$oldtext = $term->selection ([$newtext])</dt> |
| 953 |
<dd> |
| 954 |
<p>Return the current selection text and optionally replace it by <code>$newtext</code>.</p> |
| 955 |
</dd> |
| 956 |
<dt>$term->overlay_simple ($x, $y, $text)</dt> |
| 957 |
<dd> |
| 958 |
<p>Create a simple multi-line overlay box. See the next method for details.</p> |
| 959 |
</dd> |
| 960 |
<dt>$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])</dt> |
| 961 |
<dd> |
| 962 |
<p>Create a new (empty) overlay at the given position with the given |
| 963 |
width/height. <code>$rstyle</code> defines the initial rendition style |
| 964 |
(default: <code>OVERLAY_RSTYLE</code>).</p> |
| 965 |
<p>If <code>$border</code> is <code>2</code> (default), then a decorative border will be put |
| 966 |
around the box.</p> |
| 967 |
<p>If either <code>$x</code> or <code>$y</code> is negative, then this is counted from the |
| 968 |
right/bottom side, respectively.</p> |
| 969 |
<p>This method returns an urxvt::overlay object. The overlay will be visible |
| 970 |
as long as the perl object is referenced.</p> |
| 971 |
<p>The methods currently supported on <code>urxvt::overlay</code> objects are:</p> |
| 972 |
<p> |
| 973 |
<dl> |
| 974 |
<dt>$overlay->set ($x, $y, $text, $rend)</dt> |
| 975 |
<dd> |
| 976 |
<p>Similar to <code>$term->ROW_t</code> and <code>$term->ROW_r</code> in that it puts |
| 977 |
text in rxvt-unicode's special encoding and an array of rendition values |
| 978 |
at a specific position inside the overlay.</p> |
| 979 |
</dd> |
| 980 |
<dt>$overlay->hide</dt> |
| 981 |
<dd> |
| 982 |
<p>If visible, hide the overlay, but do not destroy it.</p> |
| 983 |
</dd> |
| 984 |
<dt>$overlay->show</dt> |
| 985 |
<dd> |
| 986 |
<p>If hidden, display the overlay again.</p> |
| 987 |
</dd> |
| 988 |
</dl> |
| 989 |
</p> |
| 990 |
</dd> |
| 991 |
<dt>$popup = $term->popup ($event)</dt> |
| 992 |
<dd> |
| 993 |
<p>Creates a new <code>urxvt::popup</code> object that implements a popup menu. The |
| 994 |
<code>$event</code> <i>must</i> be the event causing the menu to pop up (a button event, |
| 995 |
currently).</p> |
| 996 |
</dd> |
| 997 |
<dt>$cellwidth = $term->strwidth ($string)</dt> |
| 998 |
<dd> |
| 999 |
<p>Returns the number of screen-cells this string would need. Correctly |
| 1000 |
accounts for wide and combining characters.</p> |
| 1001 |
</dd> |
| 1002 |
<dt>$octets = $term->locale_encode ($string)</dt> |
| 1003 |
<dd> |
| 1004 |
<p>Convert the given text string into the corresponding locale encoding.</p> |
| 1005 |
</dd> |
| 1006 |
<dt>$string = $term->locale_decode ($octets)</dt> |
| 1007 |
<dd> |
| 1008 |
<p>Convert the given locale-encoded octets into a perl string.</p> |
| 1009 |
</dd> |
| 1010 |
<dt>$term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])</dt> |
| 1011 |
<dd> |
| 1012 |
<p>XORs the rendition values in the given span with the provided value |
| 1013 |
(default: <code>RS_RVid</code>), which <i>MUST NOT</i> contain font styles. Useful in |
| 1014 |
refresh hooks to provide effects similar to the selection.</p> |
| 1015 |
</dd> |
| 1016 |
<dt>$term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])</dt> |
| 1017 |
<dd> |
| 1018 |
<p>Similar to <code>scr_xor_span</code>, but xors a rectangle instead. Trailing |
| 1019 |
whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults |
| 1020 |
to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines |
| 1021 |
it instead. Both styles <i>MUST NOT</i> contain font styles.</p> |
| 1022 |
</dd> |
| 1023 |
<dt>$term->scr_bell</dt> |
| 1024 |
<dd> |
| 1025 |
<p>Ring the bell!</p> |
| 1026 |
</dd> |
| 1027 |
<dt>$term->scr_add_lines ($string)</dt> |
| 1028 |
<dd> |
| 1029 |
<p>Write the given text string to the screen, as if output by the application |
| 1030 |
running inside the terminal. It may not contain command sequences (escape |
| 1031 |
codes), but is free to use line feeds, carriage returns and tabs. The |
| 1032 |
string is a normal text string, not in locale-dependent encoding.</p> |
| 1033 |
<p>Normally its not a good idea to use this function, as programs might be |
| 1034 |
confused by changes in cursor position or scrolling. Its useful inside a |
| 1035 |
<code>on_add_lines</code> hook, though.</p> |
| 1036 |
</dd> |
| 1037 |
<dt>$term->scr_change_screen ($screen)</dt> |
| 1038 |
<dd> |
| 1039 |
<p>Switch to given screen - 0 primary, 1 secondary.</p> |
| 1040 |
</dd> |
| 1041 |
<dt>$term->cmd_parse ($octets)</dt> |
| 1042 |
<dd> |
| 1043 |
<p>Similar to <code>scr_add_lines</code>, but the argument must be in the |
| 1044 |
locale-specific encoding of the terminal and can contain command sequences |
| 1045 |
(escape codes) that will be interpreted.</p> |
| 1046 |
</dd> |
| 1047 |
<dt>$term->tt_write ($octets)</dt> |
| 1048 |
<dd> |
| 1049 |
<p>Write the octets given in <code>$data</code> to the tty (i.e. as program input). To |
| 1050 |
pass characters instead of octets, you should convert your strings first |
| 1051 |
to the locale-specific encoding using <code>$term->locale_encode</code>.</p> |
| 1052 |
</dd> |
| 1053 |
<dt>$old_events = $term->pty_ev_events ([$new_events])</dt> |
| 1054 |
<dd> |
| 1055 |
<p>Replaces the event mask of the pty watcher by the given event mask. Can |
| 1056 |
be used to suppress input and output handling to the pty/tty. See the |
| 1057 |
description of <code>urxvt::timer->events</code>. Make sure to always restore |
| 1058 |
the previous value.</p> |
| 1059 |
</dd> |
| 1060 |
<dt>$fd = $term->pty_fd</dt> |
| 1061 |
<dd> |
| 1062 |
<p>Returns the master file descriptor for the pty in use, or <code>-1</code> if no pty |
| 1063 |
is used.</p> |
| 1064 |
</dd> |
| 1065 |
<dt>$windowid = $term->parent</dt> |
| 1066 |
<dd> |
| 1067 |
<p>Return the window id of the toplevel window.</p> |
| 1068 |
</dd> |
| 1069 |
<dt>$windowid = $term->vt</dt> |
| 1070 |
<dd> |
| 1071 |
<p>Return the window id of the terminal window.</p> |
| 1072 |
</dd> |
| 1073 |
<dt>$term->vt_emask_add ($x_event_mask)</dt> |
| 1074 |
<dd> |
| 1075 |
<p>Adds the specified events to the vt event mask. Useful e.g. when you want |
| 1076 |
to receive pointer events all the times:</p> |
| 1077 |
<pre> $term->vt_emask_add (urxvt::PointerMotionMask); |
| 1078 |
|
| 1079 |
</pre> |
| 1080 |
</dd> |
| 1081 |
<dt>$term->focus_in</dt> |
| 1082 |
<dt>$term->focus_out</dt> |
| 1083 |
<dt>$term->key_press ($state, $keycode[, $time])</dt> |
| 1084 |
<dt>$term->key_release ($state, $keycode[, $time])</dt> |
| 1085 |
<dd> |
| 1086 |
<p>Deliver various fake events to to terminal.</p> |
| 1087 |
</dd> |
| 1088 |
<dt>$window_width = $term->width</dt> |
| 1089 |
<dt>$window_height = $term->height</dt> |
| 1090 |
<dt>$font_width = $term->fwidth</dt> |
| 1091 |
<dt>$font_height = $term->fheight</dt> |
| 1092 |
<dt>$font_ascent = $term->fbase</dt> |
| 1093 |
<dt>$terminal_rows = $term->nrow</dt> |
| 1094 |
<dt>$terminal_columns = $term->ncol</dt> |
| 1095 |
<dt>$has_focus = $term->focus</dt> |
| 1096 |
<dt>$is_mapped = $term->mapped</dt> |
| 1097 |
<dt>$max_scrollback = $term->saveLines</dt> |
| 1098 |
<dt>$nrow_plus_saveLines = $term->total_rows</dt> |
| 1099 |
<dt>$topmost_scrollback_row = $term->top_row</dt> |
| 1100 |
<dd> |
| 1101 |
<p>Return various integers describing terminal characteristics.</p> |
| 1102 |
</dd> |
| 1103 |
<dt>$x_display = $term->display_id</dt> |
| 1104 |
<dd> |
| 1105 |
<p>Return the DISPLAY used by rxvt-unicode.</p> |
| 1106 |
</dd> |
| 1107 |
<dt>$lc_ctype = $term->locale</dt> |
| 1108 |
<dd> |
| 1109 |
<p>Returns the LC_CTYPE category string used by this rxvt-unicode.</p> |
| 1110 |
</dd> |
| 1111 |
<dt>$env = $term->env</dt> |
| 1112 |
<dd> |
| 1113 |
<p>Returns a copy of the environment in effect for the terminal as a hashref |
| 1114 |
similar to <code>\%ENV</code>.</p> |
| 1115 |
</dd> |
| 1116 |
<dt>@envv = $term->envv</dt> |
| 1117 |
<dd> |
| 1118 |
<p>Returns the environment as array of strings of the form <code>VAR=VALUE</code>.</p> |
| 1119 |
</dd> |
| 1120 |
<dt>@argv = $term->argv</dt> |
| 1121 |
<dd> |
| 1122 |
<p>Return the argument vector as this terminal, similar to @ARGV, but |
| 1123 |
includes the program name as first element.</p> |
| 1124 |
</dd> |
| 1125 |
<dt>$modifiermask = $term->ModLevel3Mask</dt> |
| 1126 |
<dt>$modifiermask = $term->ModMetaMask</dt> |
| 1127 |
<dt>$modifiermask = $term->ModNumLockMask</dt> |
| 1128 |
<dd> |
| 1129 |
<p>Return the modifier masks corresponding to the "ISO Level 3 Shift" (often |
| 1130 |
AltGr), the meta key (often Alt) and the num lock key, if applicable.</p> |
| 1131 |
</dd> |
| 1132 |
<dt>$screen = $term->current_screen</dt> |
| 1133 |
<dd> |
| 1134 |
<p>Returns the currently displayed screen (0 primary, 1 secondary).</p> |
| 1135 |
</dd> |
| 1136 |
<dt>$cursor_is_hidden = $term->hidden_cursor</dt> |
| 1137 |
<dd> |
| 1138 |
<p>Returns whether the cursor is currently hidden or not.</p> |
| 1139 |
</dd> |
| 1140 |
<dt>$view_start = $term->view_start ([$newvalue])</dt> |
| 1141 |
<dd> |
| 1142 |
<p>Returns the row number of the topmost displayed line. Maximum value is |
| 1143 |
<code>0</code>, which displays the normal terminal contents. Lower values scroll |
| 1144 |
this many lines into the scrollback buffer.</p> |
| 1145 |
</dd> |
| 1146 |
<dt>$term->want_refresh</dt> |
| 1147 |
<dd> |
| 1148 |
<p>Requests a screen refresh. At the next opportunity, rxvt-unicode will |
| 1149 |
compare the on-screen display with its stored representation. If they |
| 1150 |
differ, it redraws the differences.</p> |
| 1151 |
<p>Used after changing terminal contents to display them.</p> |
| 1152 |
</dd> |
| 1153 |
<dt>$text = $term->ROW_t ($row_number[, $new_text[, $start_col]])</dt> |
| 1154 |
<dd> |
| 1155 |
<p>Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code> |
| 1156 |
is the topmost terminal line, row <code>$term->$ncol-1</code> is the bottommost |
| 1157 |
terminal line. The scrollback buffer starts at line <code>-1</code> and extends to |
| 1158 |
line <code>-$term->nsaved</code>. Nothing will be returned if a nonexistent line |
| 1159 |
is requested.</p> |
| 1160 |
<p>If <code>$new_text</code> is specified, it will replace characters in the current |
| 1161 |
line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful |
| 1162 |
to replace only parts of a line. The font index in the rendition will |
| 1163 |
automatically be updated.</p> |
| 1164 |
<p><code>$text</code> is in a special encoding: tabs and wide characters that use more |
| 1165 |
than one cell when displayed are padded with <code>$urxvt::NOCHAR</code> (chr 65535) |
| 1166 |
characters. Characters with combining characters and other characters that |
| 1167 |
do not fit into the normal tetx encoding will be replaced with characters |
| 1168 |
in the private use area.</p> |
| 1169 |
<p>You have to obey this encoding when changing text. The advantage is |
| 1170 |
that <code>substr</code> and similar functions work on screen cells and not on |
| 1171 |
characters.</p> |
| 1172 |
<p>The methods <code>$term->special_encode</code> and <code>$term->special_decode</code> |
| 1173 |
can be used to convert normal strings into this encoding and vice versa.</p> |
| 1174 |
</dd> |
| 1175 |
<dt>$rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])</dt> |
| 1176 |
<dd> |
| 1177 |
<p>Like <code>$term->ROW_t</code>, but returns an arrayref with rendition |
| 1178 |
bitsets. Rendition bitsets contain information about colour, font, font |
| 1179 |
styles and similar information. See also <code>$term->ROW_t</code>.</p> |
| 1180 |
<p>When setting rendition, the font mask will be ignored.</p> |
| 1181 |
<p>See the section on RENDITION, above.</p> |
| 1182 |
</dd> |
| 1183 |
<dt>$length = $term->ROW_l ($row_number[, $new_length])</dt> |
| 1184 |
<dd> |
| 1185 |
<p>Returns the number of screen cells that are in use ("the line |
| 1186 |
length"). Unlike the urxvt core, this returns <code>$term->ncol</code> if the |
| 1187 |
line is joined with the following one.</p> |
| 1188 |
</dd> |
| 1189 |
<dt>$bool = $term->is_longer ($row_number)</dt> |
| 1190 |
<dd> |
| 1191 |
<p>Returns true if the row is part of a multiple-row logical "line" (i.e. |
| 1192 |
joined with the following row), which means all characters are in use |
| 1193 |
and it is continued on the next row (and possibly a continuation of the |
| 1194 |
previous row(s)).</p> |
| 1195 |
</dd> |
| 1196 |
<dt>$line = $term->line ($row_number)</dt> |
| 1197 |
<dd> |
| 1198 |
<p>Create and return a new <code>urxvt::line</code> object that stores information |
| 1199 |
about the logical line that row <code>$row_number</code> is part of. It supports the |
| 1200 |
following methods:</p> |
| 1201 |
<p> |
| 1202 |
<dl> |
| 1203 |
<dt>$text = $line->t ([$new_text])</dt> |
| 1204 |
<dd> |
| 1205 |
<p>Returns or replaces the full text of the line, similar to <code>ROW_t</code></p> |
| 1206 |
</dd> |
| 1207 |
<dt>$rend = $line->r ([$new_rend])</dt> |
| 1208 |
<dd> |
| 1209 |
<p>Returns or replaces the full rendition array of the line, similar to <code>ROW_r</code></p> |
| 1210 |
</dd> |
| 1211 |
<dt>$length = $line->l</dt> |
| 1212 |
<dd> |
| 1213 |
<p>Returns the length of the line in cells, similar to <code>ROW_l</code>.</p> |
| 1214 |
</dd> |
| 1215 |
<dt>$rownum = $line->beg</dt> |
| 1216 |
<dt>$rownum = $line->end</dt> |
| 1217 |
<dd> |
| 1218 |
<p>Return the row number of the first/last row of the line, respectively.</p> |
| 1219 |
</dd> |
| 1220 |
<dt>$offset = $line->offset_of ($row, $col)</dt> |
| 1221 |
<dd> |
| 1222 |
<p>Returns the character offset of the given row|col pair within the logical |
| 1223 |
line. Works for rows outside the line, too, and returns corresponding |
| 1224 |
offsets outside the string.</p> |
| 1225 |
</dd> |
| 1226 |
<dt>($row, $col) = $line->coord_of ($offset)</dt> |
| 1227 |
<dd> |
| 1228 |
<p>Translates a string offset into terminal coordinates again.</p> |
| 1229 |
</dd> |
| 1230 |
</dl> |
| 1231 |
</p> |
| 1232 |
</dd> |
| 1233 |
<dt>$text = $term->special_encode $string</dt> |
| 1234 |
<dd> |
| 1235 |
<p>Converts a perl string into the special encoding used by rxvt-unicode, |
| 1236 |
where one character corresponds to one screen cell. See |
| 1237 |
<code>$term->ROW_t</code> for details.</p> |
| 1238 |
</dd> |
| 1239 |
<dt>$string = $term->special_decode $text</dt> |
| 1240 |
<dd> |
| 1241 |
<p>Converts rxvt-unicodes text representation into a perl string. See |
| 1242 |
<code>$term->ROW_t</code> for details.</p> |
| 1243 |
</dd> |
| 1244 |
<dt>$success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])</dt> |
| 1245 |
<dt>$term->ungrab_button ($button, $modifiermask[, $window = $term->vt])</dt> |
| 1246 |
<dd> |
| 1247 |
<p>Register/unregister a synchronous button grab. See the XGrabButton |
| 1248 |
manpage.</p> |
| 1249 |
</dd> |
| 1250 |
<dt>$success = $term->grab ($eventtime[, $sync])</dt> |
| 1251 |
<dd> |
| 1252 |
<p>Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
| 1253 |
synchronous (<code>$sync</code> is true). Also remembers the grab timestamp.</p> |
| 1254 |
</dd> |
| 1255 |
<dt>$term->allow_events_async</dt> |
| 1256 |
<dd> |
| 1257 |
<p>Calls XAllowEvents with AsyncBoth for the most recent grab.</p> |
| 1258 |
</dd> |
| 1259 |
<dt>$term->allow_events_sync</dt> |
| 1260 |
<dd> |
| 1261 |
<p>Calls XAllowEvents with SyncBoth for the most recent grab.</p> |
| 1262 |
</dd> |
| 1263 |
<dt>$term->allow_events_replay</dt> |
| 1264 |
<dd> |
| 1265 |
<p>Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most |
| 1266 |
recent grab.</p> |
| 1267 |
</dd> |
| 1268 |
<dt>$term->ungrab</dt> |
| 1269 |
<dd> |
| 1270 |
<p>Calls XUngrab for the most recent grab. Is called automatically on |
| 1271 |
evaluation errors, as it is better to lose the grab in the error case as |
| 1272 |
the session.</p> |
| 1273 |
</dd> |
| 1274 |
<dt>$atom = $term->XInternAtom ($atom_name[, $only_if_exists])</dt> |
| 1275 |
<dt>$atom_name = $term->XGetAtomName ($atom)</dt> |
| 1276 |
<dt>@atoms = $term->XListProperties ($window)</dt> |
| 1277 |
<dt>($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)</dt> |
| 1278 |
<dt>$term->XChangeWindowProperty ($window, $property, $type, $format, $octets)</dt> |
| 1279 |
<dt>$term->XDeleteProperty ($window, $property)</dt> |
| 1280 |
<dt>$window = $term->DefaultRootWindow</dt> |
| 1281 |
<dt>$term->XReparentWindow ($window, $parent, [$x, $y])</dt> |
| 1282 |
<dt>$term->XMapWindow ($window)</dt> |
| 1283 |
<dt>$term->XUnmapWindow ($window)</dt> |
| 1284 |
<dt>$term->XMoveResizeWindow ($window, $x, $y, $width, $height)</dt> |
| 1285 |
<dt>($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)</dt> |
| 1286 |
<dt>$term->XChangeInput ($window, $add_events[, $del_events])</dt> |
| 1287 |
<dd> |
| 1288 |
<p>Various X or X-related functions. The <code>$term</code> object only serves as |
| 1289 |
the source of the display, otherwise those functions map more-or-less |
| 1290 |
directory onto the X functions of the same name.</p> |
| 1291 |
</dd> |
| 1292 |
</dl> |
| 1293 |
|
| 1294 |
</div> |
| 1295 |
<h2 id="The_code_urxvt_popup_code_Class">The <code>urxvt::popup</code> Class</h2> |
| 1296 |
<div id="The_code_urxvt_popup_code_Class_CONT"> |
| 1297 |
<dl> |
| 1298 |
<dt>$popup->add_title ($title)</dt> |
| 1299 |
<dd> |
| 1300 |
<p>Adds a non-clickable title to the popup.</p> |
| 1301 |
</dd> |
| 1302 |
<dt>$popup->add_separator ([$sepchr])</dt> |
| 1303 |
<dd> |
| 1304 |
<p>Creates a separator, optionally using the character given as <code>$sepchr</code>.</p> |
| 1305 |
</dd> |
| 1306 |
<dt>$popup->add_button ($text, $cb)</dt> |
| 1307 |
<dd> |
| 1308 |
<p>Adds a clickable button to the popup. <code>$cb</code> is called whenever it is |
| 1309 |
selected.</p> |
| 1310 |
</dd> |
| 1311 |
<dt>$popup->add_toggle ($text, $initial_value, $cb)</dt> |
| 1312 |
<dd> |
| 1313 |
<p>Adds a toggle/checkbox item to the popup. The callback gets called |
| 1314 |
whenever it gets toggled, with a boolean indicating its new value as its |
| 1315 |
first argument.</p> |
| 1316 |
</dd> |
| 1317 |
<dt>$popup->show</dt> |
| 1318 |
<dd> |
| 1319 |
<p>Displays the popup (which is initially hidden).</p> |
| 1320 |
</dd> |
| 1321 |
</dl> |
| 1322 |
|
| 1323 |
</div> |
| 1324 |
<h2 id="The_code_urxvt_timer_code_Class">The <code>urxvt::timer</code> Class</h2> |
| 1325 |
<div id="The_code_urxvt_timer_code_Class_CONT"> |
| 1326 |
<p>This class implements timer watchers/events. Time is represented as a |
| 1327 |
fractional number of seconds since the epoch. Example:</p> |
| 1328 |
<pre> $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0); |
| 1329 |
$term->{timer} = urxvt::timer |
| 1330 |
->new |
| 1331 |
->interval (1) |
| 1332 |
->cb (sub { |
| 1333 |
$term->{overlay}->set (0, 0, |
| 1334 |
sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
| 1335 |
}); |
| 1336 |
|
| 1337 |
</pre> |
| 1338 |
<dl> |
| 1339 |
<dt>$timer = new urxvt::timer</dt> |
| 1340 |
<dd> |
| 1341 |
<p>Create a new timer object in started state. It is scheduled to fire |
| 1342 |
immediately.</p> |
| 1343 |
</dd> |
| 1344 |
<dt>$timer = $timer->cb (sub { my ($timer) = @_; ... })</dt> |
| 1345 |
<dd> |
| 1346 |
<p>Set the callback to be called when the timer triggers.</p> |
| 1347 |
</dd> |
| 1348 |
<dt>$tstamp = $timer->at</dt> |
| 1349 |
<dd> |
| 1350 |
<p>Return the time this watcher will fire next.</p> |
| 1351 |
</dd> |
| 1352 |
<dt>$timer = $timer->set ($tstamp)</dt> |
| 1353 |
<dd> |
| 1354 |
<p>Set the time the event is generated to $tstamp.</p> |
| 1355 |
</dd> |
| 1356 |
<dt>$timer = $timer->interval ($interval)</dt> |
| 1357 |
<dd> |
| 1358 |
<p>Normally (and when <code>$interval</code> is <code>0</code>), the timer will automatically |
| 1359 |
stop after it has fired once. If <code>$interval</code> is non-zero, then the timer |
| 1360 |
is automatically rescheduled at the given intervals.</p> |
| 1361 |
</dd> |
| 1362 |
<dt>$timer = $timer->start</dt> |
| 1363 |
<dd> |
| 1364 |
<p>Start the timer.</p> |
| 1365 |
</dd> |
| 1366 |
<dt>$timer = $timer->start ($tstamp)</dt> |
| 1367 |
<dd> |
| 1368 |
<p>Set the event trigger time to <code>$tstamp</code> and start the timer.</p> |
| 1369 |
</dd> |
| 1370 |
<dt>$timer = $timer->after ($delay)</dt> |
| 1371 |
<dd> |
| 1372 |
<p>Like <code>start</code>, but sets the expiry timer to c<urxvt::NOW + $delay>.</p> |
| 1373 |
</dd> |
| 1374 |
<dt>$timer = $timer->stop</dt> |
| 1375 |
<dd> |
| 1376 |
<p>Stop the timer.</p> |
| 1377 |
</dd> |
| 1378 |
</dl> |
| 1379 |
|
| 1380 |
</div> |
| 1381 |
<h2 id="The_code_urxvt_iow_code_Class">The <code>urxvt::iow</code> Class</h2> |
| 1382 |
<div id="The_code_urxvt_iow_code_Class_CONTEN"> |
| 1383 |
<p>This class implements io watchers/events. Example:</p> |
| 1384 |
<pre> $term->{socket} = ... |
| 1385 |
$term->{iow} = urxvt::iow |
| 1386 |
->new |
| 1387 |
->fd (fileno $term->{socket}) |
| 1388 |
->events (urxvt::EVENT_READ) |
| 1389 |
->start |
| 1390 |
->cb (sub { |
| 1391 |
my ($iow, $revents) = @_; |
| 1392 |
# $revents must be 1 here, no need to check |
| 1393 |
sysread $term->{socket}, my $buf, 8192 |
| 1394 |
or end-of-file; |
| 1395 |
}); |
| 1396 |
|
| 1397 |
|
| 1398 |
|
| 1399 |
|
| 1400 |
</pre> |
| 1401 |
<dl> |
| 1402 |
<dt>$iow = new urxvt::iow</dt> |
| 1403 |
<dd> |
| 1404 |
<p>Create a new io watcher object in stopped state.</p> |
| 1405 |
</dd> |
| 1406 |
<dt>$iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... })</dt> |
| 1407 |
<dd> |
| 1408 |
<p>Set the callback to be called when io events are triggered. <code>$reventmask</code> |
| 1409 |
is a bitset as described in the <code>events</code> method.</p> |
| 1410 |
</dd> |
| 1411 |
<dt>$iow = $iow->fd ($fd)</dt> |
| 1412 |
<dd> |
| 1413 |
<p>Set the file descriptor (not handle) to watch.</p> |
| 1414 |
</dd> |
| 1415 |
<dt>$iow = $iow->events ($eventmask)</dt> |
| 1416 |
<dd> |
| 1417 |
<p>Set the event mask to watch. The only allowed values are |
| 1418 |
<code>urxvt::EVENT_READ</code> and <code>urxvt::EVENT_WRITE</code>, which might be ORed |
| 1419 |
together, or <code>urxvt::EVENT_NONE</code>.</p> |
| 1420 |
</dd> |
| 1421 |
<dt>$iow = $iow->start</dt> |
| 1422 |
<dd> |
| 1423 |
<p>Start watching for requested events on the given handle.</p> |
| 1424 |
</dd> |
| 1425 |
<dt>$iow = $iow->stop</dt> |
| 1426 |
<dd> |
| 1427 |
<p>Stop watching for events on the given file handle.</p> |
| 1428 |
</dd> |
| 1429 |
</dl> |
| 1430 |
|
| 1431 |
</div> |
| 1432 |
<h2 id="The_code_urxvt_iw_code_Class">The <code>urxvt::iw</code> Class</h2> |
| 1433 |
<div id="The_code_urxvt_iw_code_Class_CONTENT"> |
| 1434 |
<p>This class implements idle watchers, that get called automatically when |
| 1435 |
the process is idle. They should return as fast as possible, after doing |
| 1436 |
some useful work.</p> |
| 1437 |
<dl> |
| 1438 |
<dt>$iw = new urxvt::iw</dt> |
| 1439 |
<dd> |
| 1440 |
<p>Create a new idle watcher object in stopped state.</p> |
| 1441 |
</dd> |
| 1442 |
<dt>$iw = $iw->cb (sub { my ($iw) = @_; ... })</dt> |
| 1443 |
<dd> |
| 1444 |
<p>Set the callback to be called when the watcher triggers.</p> |
| 1445 |
</dd> |
| 1446 |
<dt>$timer = $timer->start</dt> |
| 1447 |
<dd> |
| 1448 |
<p>Start the watcher.</p> |
| 1449 |
</dd> |
| 1450 |
<dt>$timer = $timer->stop</dt> |
| 1451 |
<dd> |
| 1452 |
<p>Stop the watcher.</p> |
| 1453 |
</dd> |
| 1454 |
</dl> |
| 1455 |
|
| 1456 |
</div> |
| 1457 |
<h2 id="The_code_urxvt_pw_code_Class">The <code>urxvt::pw</code> Class</h2> |
| 1458 |
<div id="The_code_urxvt_pw_code_Class_CONTENT"> |
| 1459 |
<p>This class implements process watchers. They create an event whenever a |
| 1460 |
process exits, after which they stop automatically.</p> |
| 1461 |
<pre> my $pid = fork; |
| 1462 |
... |
| 1463 |
$term->{pw} = urxvt::pw |
| 1464 |
->new |
| 1465 |
->start ($pid) |
| 1466 |
->cb (sub { |
| 1467 |
my ($pw, $exit_status) = @_; |
| 1468 |
... |
| 1469 |
}); |
| 1470 |
|
| 1471 |
</pre> |
| 1472 |
<dl> |
| 1473 |
<dt>$pw = new urxvt::pw</dt> |
| 1474 |
<dd> |
| 1475 |
<p>Create a new process watcher in stopped state.</p> |
| 1476 |
</dd> |
| 1477 |
<dt>$pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })</dt> |
| 1478 |
<dd> |
| 1479 |
<p>Set the callback to be called when the timer triggers.</p> |
| 1480 |
</dd> |
| 1481 |
<dt>$pw = $timer->start ($pid)</dt> |
| 1482 |
<dd> |
| 1483 |
<p>Tells the watcher to start watching for process <code>$pid</code>.</p> |
| 1484 |
</dd> |
| 1485 |
<dt>$pw = $pw->stop</dt> |
| 1486 |
<dd> |
| 1487 |
<p>Stop the watcher.</p> |
| 1488 |
</dd> |
| 1489 |
</dl> |
| 1490 |
|
| 1491 |
</div> |
| 1492 |
<h1 id="ENVIRONMENT">ENVIRONMENT</h1><p><a href="#TOP" class="toplink">Top</a></p> |
| 1493 |
<div id="ENVIRONMENT_CONTENT"> |
| 1494 |
|
| 1495 |
</div> |
| 1496 |
<h2 id="URXVT_PERL_VERBOSITY">URXVT_PERL_VERBOSITY</h2> |
| 1497 |
<div id="URXVT_PERL_VERBOSITY_CONTENT"> |
| 1498 |
<p>This variable controls the verbosity level of the perl extension. Higher |
| 1499 |
numbers indicate more verbose output.</p> |
| 1500 |
<dl> |
| 1501 |
<dt>== 0 - fatal messages</dt> |
| 1502 |
<dt>>= 3 - script loading and management</dt> |
| 1503 |
<dt>>=10 - all called hooks</dt> |
| 1504 |
<dt>>=11 - hook return values</dt> |
| 1505 |
</dl> |
| 1506 |
|
| 1507 |
</div> |
| 1508 |
<h1 id="AUTHOR">AUTHOR</h1><p><a href="#TOP" class="toplink">Top</a></p> |
| 1509 |
<div id="AUTHOR_CONTENT"> |
| 1510 |
<pre> Marc Lehmann <pcg@goof.com> |
| 1511 |
http://software.schmorp.de/pkg/rxvt-unicode |
| 1512 |
|
| 1513 |
</pre> |
| 1514 |
|
| 1515 |
</div> |
| 1516 |
</div></body> |
| 1517 |
</html> |
