| 1 |
.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14 |
| 2 |
.\" |
| 3 |
.\" Standard preamble: |
| 4 |
.\" ======================================================================== |
| 5 |
.de Sh \" Subsection heading |
| 6 |
.br |
| 7 |
.if t .Sp |
| 8 |
.ne 5 |
| 9 |
.PP |
| 10 |
\fB\\$1\fR |
| 11 |
.PP |
| 12 |
.. |
| 13 |
.de Sp \" Vertical space (when we can't use .PP) |
| 14 |
.if t .sp .5v |
| 15 |
.if n .sp |
| 16 |
.. |
| 17 |
.de Vb \" Begin verbatim text |
| 18 |
.ft CW |
| 19 |
.nf |
| 20 |
.ne \\$1 |
| 21 |
.. |
| 22 |
.de Ve \" End verbatim text |
| 23 |
.ft R |
| 24 |
.fi |
| 25 |
.. |
| 26 |
.\" Set up some character translations and predefined strings. \*(-- will |
| 27 |
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left |
| 28 |
.\" double quote, and \*(R" will give a right double quote. | will give a |
| 29 |
.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to |
| 30 |
.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' |
| 31 |
.\" expand to `' in nroff, nothing in troff, for use with C<>. |
| 32 |
.tr \(*W-|\(bv\*(Tr |
| 33 |
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' |
| 34 |
.ie n \{\ |
| 35 |
. ds -- \(*W- |
| 36 |
. ds PI pi |
| 37 |
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch |
| 38 |
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch |
| 39 |
. ds L" "" |
| 40 |
. ds R" "" |
| 41 |
. ds C` "" |
| 42 |
. ds C' "" |
| 43 |
'br\} |
| 44 |
.el\{\ |
| 45 |
. ds -- \|\(em\| |
| 46 |
. ds PI \(*p |
| 47 |
. ds L" `` |
| 48 |
. ds R" '' |
| 49 |
'br\} |
| 50 |
.\" |
| 51 |
.\" If the F register is turned on, we'll generate index entries on stderr for |
| 52 |
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index |
| 53 |
.\" entries marked with X<> in POD. Of course, you'll have to process the |
| 54 |
.\" output yourself in some meaningful fashion. |
| 55 |
.if \nF \{\ |
| 56 |
. de IX |
| 57 |
. tm Index:\\$1\t\\n%\t"\\$2" |
| 58 |
.. |
| 59 |
. nr % 0 |
| 60 |
. rr F |
| 61 |
.\} |
| 62 |
.\" |
| 63 |
.\" For nroff, turn off justification. Always turn off hyphenation; it makes |
| 64 |
.\" way too many mistakes in technical documents. |
| 65 |
.hy 0 |
| 66 |
.if n .na |
| 67 |
.\" |
| 68 |
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). |
| 69 |
.\" Fear. Run. Save yourself. No user-serviceable parts. |
| 70 |
. \" fudge factors for nroff and troff |
| 71 |
.if n \{\ |
| 72 |
. ds #H 0 |
| 73 |
. ds #V .8m |
| 74 |
. ds #F .3m |
| 75 |
. ds #[ \f1 |
| 76 |
. ds #] \fP |
| 77 |
.\} |
| 78 |
.if t \{\ |
| 79 |
. ds #H ((1u-(\\\\n(.fu%2u))*.13m) |
| 80 |
. ds #V .6m |
| 81 |
. ds #F 0 |
| 82 |
. ds #[ \& |
| 83 |
. ds #] \& |
| 84 |
.\} |
| 85 |
. \" simple accents for nroff and troff |
| 86 |
.if n \{\ |
| 87 |
. ds ' \& |
| 88 |
. ds ` \& |
| 89 |
. ds ^ \& |
| 90 |
. ds , \& |
| 91 |
. ds ~ ~ |
| 92 |
. ds / |
| 93 |
.\} |
| 94 |
.if t \{\ |
| 95 |
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" |
| 96 |
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' |
| 97 |
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' |
| 98 |
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' |
| 99 |
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' |
| 100 |
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' |
| 101 |
.\} |
| 102 |
. \" troff and (daisy-wheel) nroff accents |
| 103 |
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' |
| 104 |
.ds 8 \h'\*(#H'\(*b\h'-\*(#H' |
| 105 |
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] |
| 106 |
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' |
| 107 |
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' |
| 108 |
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] |
| 109 |
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] |
| 110 |
.ds ae a\h'-(\w'a'u*4/10)'e |
| 111 |
.ds Ae A\h'-(\w'A'u*4/10)'E |
| 112 |
. \" corrections for vroff |
| 113 |
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' |
| 114 |
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' |
| 115 |
. \" for low resolution devices (crt and lpr) |
| 116 |
.if \n(.H>23 .if \n(.V>19 \ |
| 117 |
\{\ |
| 118 |
. ds : e |
| 119 |
. ds 8 ss |
| 120 |
. ds o a |
| 121 |
. ds d- d\h'-1'\(ga |
| 122 |
. ds D- D\h'-1'\(hy |
| 123 |
. ds th \o'bp' |
| 124 |
. ds Th \o'LP' |
| 125 |
. ds ae ae |
| 126 |
. ds Ae AE |
| 127 |
.\} |
| 128 |
.rm #[ #] #H #V #F C |
| 129 |
.\" ======================================================================== |
| 130 |
.\" |
| 131 |
.IX Title "rxvt 3" |
| 132 |
.TH rxvt 3 "2006-01-18" "7.1" "RXVT-UNICODE" |
| 133 |
.SH "NAME" |
| 134 |
@@RXVT_NAME@@perl \- rxvt\-unicode's embedded perl interpreter |
| 135 |
.SH "SYNOPSIS" |
| 136 |
.IX Header "SYNOPSIS" |
| 137 |
.Vb 1 |
| 138 |
\& # create a file grab_test in $HOME: |
| 139 |
.Ve |
| 140 |
.PP |
| 141 |
.Vb 4 |
| 142 |
\& sub on_sel_grab { |
| 143 |
\& warn "you selected ", $_[0]->selection; |
| 144 |
\& () |
| 145 |
\& } |
| 146 |
.Ve |
| 147 |
.PP |
| 148 |
.Vb 1 |
| 149 |
\& # start a @@RXVT_NAME@@ using it: |
| 150 |
.Ve |
| 151 |
.PP |
| 152 |
.Vb 1 |
| 153 |
\& @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test |
| 154 |
.Ve |
| 155 |
.SH "DESCRIPTION" |
| 156 |
.IX Header "DESCRIPTION" |
| 157 |
Everytime a terminal object gets created, extension scripts specified via |
| 158 |
the \f(CW\*(C`perl\*(C'\fR resource are loaded and associated with it. |
| 159 |
.PP |
| 160 |
Scripts are compiled in a 'use strict' and 'use utf8' environment, and |
| 161 |
thus must be encoded as \s-1UTF\-8\s0. |
| 162 |
.PP |
| 163 |
Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where |
| 164 |
scripts will be shared (but not enabled) for all terminals. |
| 165 |
.SH "PREPACKAGED EXTENSIONS" |
| 166 |
.IX Header "PREPACKAGED EXTENSIONS" |
| 167 |
This section describes the extensions delivered with this release. You can |
| 168 |
find them in \fI@@RXVT_LIBDIR@@/urxvt/perl/\fR. |
| 169 |
.PP |
| 170 |
You can activate them like this: |
| 171 |
.PP |
| 172 |
.Vb 1 |
| 173 |
\& @@RXVT_NAME@@ -pe <extensionname> |
| 174 |
.Ve |
| 175 |
.IP "selection (enabled by default)" 4 |
| 176 |
.IX Item "selection (enabled by default)" |
| 177 |
(More) intelligent selection. This extension tries to be more intelligent |
| 178 |
when the user extends selections (double\-click and further clicks). Right |
| 179 |
now, it tries to select words, urls and complete shell-quoted |
| 180 |
arguments, which is very convenient, too, if your \fIls\fR supports |
| 181 |
\&\f(CW\*(C`\-\-quoting\-style=shell\*(C'\fR. |
| 182 |
.Sp |
| 183 |
A double-click usually selects the word under the cursor, further clicks |
| 184 |
will enlarge the selection. |
| 185 |
.Sp |
| 186 |
The selection works by trying to match a number of regexes and displaying |
| 187 |
them in increasing order of length. You can add your own regexes by |
| 188 |
specifying resources of the form: |
| 189 |
.Sp |
| 190 |
.Vb 3 |
| 191 |
\& URxvt.selection.pattern-0: perl-regex |
| 192 |
\& URxvt.selection.pattern-1: perl-regex |
| 193 |
\& ... |
| 194 |
.Ve |
| 195 |
.Sp |
| 196 |
The index number (0, 1...) must not have any holes, and each regex must |
| 197 |
contain at least one pair of capturing parentheses, which will be used for |
| 198 |
the match. For example, the followign adds a regex that matches everything |
| 199 |
between two vertical bars: |
| 200 |
.Sp |
| 201 |
.Vb 1 |
| 202 |
\& URxvt.selection.pattern-0: \e\e|([^|]+)\e\e| |
| 203 |
.Ve |
| 204 |
.Sp |
| 205 |
You can look at the source of the selection extension to see more |
| 206 |
interesting uses, such as parsing a line from beginning to end. |
| 207 |
.Sp |
| 208 |
This extension also offers following bindable keyboard commands: |
| 209 |
.RS 4 |
| 210 |
.IP "rot13" 4 |
| 211 |
.IX Item "rot13" |
| 212 |
Rot\-13 the selection when activated. Used via keyboard trigger: |
| 213 |
.Sp |
| 214 |
.Vb 1 |
| 215 |
\& URxvt.keysym.C-M-r: perl:selection:rot13 |
| 216 |
.Ve |
| 217 |
.RE |
| 218 |
.RS 4 |
| 219 |
.RE |
| 220 |
.IP "option-popup (enabled by default)" 4 |
| 221 |
.IX Item "option-popup (enabled by default)" |
| 222 |
Binds a popup menu to Ctrl\-Button2 that lets you toggle (some) options at |
| 223 |
runtime. |
| 224 |
.IP "selection-popup (enabled by default)" 4 |
| 225 |
.IX Item "selection-popup (enabled by default)" |
| 226 |
Binds a popup menu to Ctrl\-Button3 that lets you convert the selection |
| 227 |
text into various other formats/action (such as uri unescaping, perl |
| 228 |
evalution, web-browser starting etc.), depending on content. |
| 229 |
.IP "searchable\-scrollback<hotkey> (enabled by default)" 4 |
| 230 |
.IX Item "searchable-scrollback<hotkey> (enabled by default)" |
| 231 |
Adds regex search functionality to the scrollback buffer, triggered |
| 232 |
by a hotkey (default: \f(CW\*(C`M\-s\*(C'\fR). While in search mode, normal terminal |
| 233 |
input/output is suspended and a regex is displayed at the bottom of the |
| 234 |
screen. |
| 235 |
.Sp |
| 236 |
Inputting characters appends them to the regex and continues incremental |
| 237 |
search. \f(CW\*(C`BackSpace\*(C'\fR removes a character from the regex, \f(CW\*(C`Up\*(C'\fR and \f(CW\*(C`Down\*(C'\fR |
| 238 |
search upwards/downwards in the scrollback buffer, \f(CW\*(C`End\*(C'\fR jumps to the |
| 239 |
bottom. \f(CW\*(C`Escape\*(C'\fR leaves search mode and returns to the point where search |
| 240 |
was started, while \f(CW\*(C`Enter\*(C'\fR or \f(CW\*(C`Return\*(C'\fR stay at the current position and |
| 241 |
additionally stores the first match in the current line into the primary |
| 242 |
selection. |
| 243 |
.IP "selection-autotransform" 4 |
| 244 |
.IX Item "selection-autotransform" |
| 245 |
This selection allows you to do automatic transforms on a selection |
| 246 |
whenever a selection is made. |
| 247 |
.Sp |
| 248 |
It works by specifying perl snippets (most useful is a single \f(CW\*(C`s///\*(C'\fR |
| 249 |
operator) that modify \f(CW$_\fR as resources: |
| 250 |
.Sp |
| 251 |
.Vb 3 |
| 252 |
\& URxvt.selection-autotransform.0: transform |
| 253 |
\& URxvt.selection-autotransform.1: transform |
| 254 |
\& ... |
| 255 |
.Ve |
| 256 |
.Sp |
| 257 |
For example, the following will transform selections of the form |
| 258 |
\&\f(CW\*(C`filename:number\*(C'\fR, often seen in compiler messages, into \f(CW\*(C`vi +$filename |
| 259 |
$word\*(C'\fR: |
| 260 |
.Sp |
| 261 |
.Vb 1 |
| 262 |
\& URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\e\ed+):?$/vi +$2 \e\eQ$1\e\eE\e\ex0d/ |
| 263 |
.Ve |
| 264 |
.Sp |
| 265 |
And this example matches the same,but replaces it with vi-commands you can |
| 266 |
paste directly into your (vi :) editor: |
| 267 |
.Sp |
| 268 |
.Vb 1 |
| 269 |
\& URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\e\ed+):?$/\e\ex1b:e \e\eQ$1\e\eE\e\ex0d:$2\e\ex0d/ |
| 270 |
.Ve |
| 271 |
.Sp |
| 272 |
Of course, this can be modified to suit your needs and your editor :) |
| 273 |
.Sp |
| 274 |
To expand the example above to typical perl error messages (\*(L"\s-1XXX\s0 at |
| 275 |
\&\s-1FILENAME\s0 line \s-1YYY\s0.\*(R"), you need a slightly more elaborate solution: |
| 276 |
.Sp |
| 277 |
.Vb 2 |
| 278 |
\& URxvt.selection.pattern-0: ( at .*? line \e\ed+\e\e.) |
| 279 |
\& URxvt.selection-autotransform.0: s/^ at (.*?) line (\e\ed+)\e\e.$/\ex1b:e \e\eQ$1\eE\e\ex0d:$2\e\ex0d/ |
| 280 |
.Ve |
| 281 |
.Sp |
| 282 |
The first line tells the selection code to treat the unchanging part of |
| 283 |
every error message as a selection pattern, and the second line transforms |
| 284 |
the message into vi commands to load the file. |
| 285 |
.IP "mark-urls" 4 |
| 286 |
.IX Item "mark-urls" |
| 287 |
Uses per-line display filtering (\f(CW\*(C`on_line_update\*(C'\fR) to underline urls and |
| 288 |
make them clickable. When middle\-clicked, the program specified in the |
| 289 |
resource \f(CW\*(C`urlLauncher\*(C'\fR (default \f(CW\*(C`x\-www\-browser\*(C'\fR) will be started with |
| 290 |
the \s-1URL\s0 as first argument. |
| 291 |
.IP "block-graphics-to-ascii" 4 |
| 292 |
.IX Item "block-graphics-to-ascii" |
| 293 |
A not very useful example of filtering all text output to the terminal, |
| 294 |
by replacing all line-drawing characters (U+2500 .. U+259F) by a |
| 295 |
similar-looking ascii character. |
| 296 |
.IP "digital-clock" 4 |
| 297 |
.IX Item "digital-clock" |
| 298 |
Displays a digital clock using the built-in overlay. |
| 299 |
.IP "example-refresh-hooks" 4 |
| 300 |
.IX Item "example-refresh-hooks" |
| 301 |
Displays a very simple digital clock in the upper right corner of the |
| 302 |
window. Illustrates overwriting the refresh callbacks to create your own |
| 303 |
overlays or changes. |
| 304 |
.IP "selection-pastebin" 4 |
| 305 |
.IX Item "selection-pastebin" |
| 306 |
This is a little rarely useful extension that Uploads the selection as |
| 307 |
textfile to a remote site (or does other things). (The implementation is |
| 308 |
not currently secure for use in a multiuser environment as it writes to |
| 309 |
\&\fI/tmp\fR directly.). |
| 310 |
.Sp |
| 311 |
It listens to the \f(CW\*(C`selection\-pastebin:remote\-pastebin\*(C'\fR keyboard command, |
| 312 |
i.e. |
| 313 |
.Sp |
| 314 |
.Vb 1 |
| 315 |
\& URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin |
| 316 |
.Ve |
| 317 |
.Sp |
| 318 |
Pressing this combination runs a command with \f(CW\*(C`%\*(C'\fR replaced by the name of |
| 319 |
the textfile. This command can be set via a resource: |
| 320 |
.Sp |
| 321 |
.Vb 1 |
| 322 |
\& URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/. |
| 323 |
.Ve |
| 324 |
.Sp |
| 325 |
And the default is likely not useful to anybody but the few people around |
| 326 |
here :) |
| 327 |
.Sp |
| 328 |
The name of the textfile is the hex encoded md5 sum of the selection, so |
| 329 |
the same content should lead to the same filename. |
| 330 |
.Sp |
| 331 |
After a successful upload the selection will be replaced by the text given |
| 332 |
in the \f(CW\*(C`selection\-pastebin\-url\*(C'\fR resource (again, the % is the placeholder |
| 333 |
for the filename): |
| 334 |
.Sp |
| 335 |
.Vb 1 |
| 336 |
\& URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% |
| 337 |
.Ve |
| 338 |
.SH "API DOCUMENTATION" |
| 339 |
.IX Header "API DOCUMENTATION" |
| 340 |
.Sh "General \s-1API\s0 Considerations" |
| 341 |
.IX Subsection "General API Considerations" |
| 342 |
All objects (such as terminals, time watchers etc.) are typical |
| 343 |
reference-to-hash objects. The hash can be used to store anything you |
| 344 |
like. All members starting with an underscore (such as \f(CW\*(C`_ptr\*(C'\fR or |
| 345 |
\&\f(CW\*(C`_hook\*(C'\fR) are reserved for internal uses and \fB\s-1MUST\s0 \s-1NOT\s0\fR be accessed or |
| 346 |
modified). |
| 347 |
.PP |
| 348 |
When objects are destroyed on the \*(C+ side, the perl object hashes are |
| 349 |
emptied, so its best to store related objects such as time watchers and |
| 350 |
the like inside the terminal object so they get destroyed as soon as the |
| 351 |
terminal is destroyed. |
| 352 |
.PP |
| 353 |
Argument names also often indicate the type of a parameter. Here are some |
| 354 |
hints on what they mean: |
| 355 |
.IP "$text" 4 |
| 356 |
.IX Item "$text" |
| 357 |
Rxvt-unicodes special way of encoding text, where one \*(L"unicode\*(R" character |
| 358 |
always represents one screen cell. See ROW_t for a discussion of this format. |
| 359 |
.IP "$string" 4 |
| 360 |
.IX Item "$string" |
| 361 |
A perl text string, with an emphasis on \fItext\fR. It can store all unicode |
| 362 |
characters and is to be distinguished with text encoded in a specific |
| 363 |
encoding (often locale\-specific) and binary data. |
| 364 |
.IP "$octets" 4 |
| 365 |
.IX Item "$octets" |
| 366 |
Either binary data or \- more common \- a text string encoded in a |
| 367 |
locale-specific way. |
| 368 |
.Sh "Extension Objects" |
| 369 |
.IX Subsection "Extension Objects" |
| 370 |
Very perl extension is a perl class. A separate perl object is created |
| 371 |
for each terminal and each extension and passed as the first parameter to |
| 372 |
hooks. So extensions can use their \f(CW$self\fR object without having to think |
| 373 |
about other extensions, with the exception of methods and members that |
| 374 |
begin with an underscore character \f(CW\*(C`_\*(C'\fR: these are reserved for internal |
| 375 |
use. |
| 376 |
.PP |
| 377 |
Although it isn't a \f(CW\*(C`urxvt::term\*(C'\fR object, you can call all methods of the |
| 378 |
\&\f(CW\*(C`urxvt::term\*(C'\fR class on this object. |
| 379 |
.PP |
| 380 |
It has the following methods and data members: |
| 381 |
.ie n .IP "$urxvt_term = $self\->{term}" 4 |
| 382 |
.el .IP "$urxvt_term = \f(CW$self\fR\->{term}" 4 |
| 383 |
.IX Item "$urxvt_term = $self->{term}" |
| 384 |
Returns the \f(CW\*(C`urxvt::term\*(C'\fR object associated with this instance of the |
| 385 |
extension. This member \fImust not\fR be changed in any way. |
| 386 |
.ie n .IP "$self\->enable ($hook_name => $cb\fR, [$hook_name => \f(CW$cb..])" 4 |
| 387 |
.el .IP "$self\->enable ($hook_name => \f(CW$cb\fR, [$hook_name => \f(CW$cb\fR..])" 4 |
| 388 |
.IX Item "$self->enable ($hook_name => $cb, [$hook_name => $cb..])" |
| 389 |
Dynamically enable the given hooks (named without the \f(CW\*(C`on_\*(C'\fR prefix) for |
| 390 |
this extension, replacing any previous hook. This is useful when you want |
| 391 |
to overwrite time-critical hooks only temporarily. |
| 392 |
.ie n .IP "$self\->disable ($hook_name[, $hook_name..])" 4 |
| 393 |
.el .IP "$self\->disable ($hook_name[, \f(CW$hook_name\fR..])" 4 |
| 394 |
.IX Item "$self->disable ($hook_name[, $hook_name..])" |
| 395 |
Dynamically disable the given hooks. |
| 396 |
.Sh "Hooks" |
| 397 |
.IX Subsection "Hooks" |
| 398 |
The following subroutines can be declared in extension files, and will be |
| 399 |
called whenever the relevant event happens. |
| 400 |
.PP |
| 401 |
The first argument passed to them is an extension oject as described in |
| 402 |
the in the \f(CW\*(C`Extension Objects\*(C'\fR section. |
| 403 |
.PP |
| 404 |
\&\fBAll\fR of these hooks must return a boolean value. If it is true, then the |
| 405 |
event counts as being \fIconsumed\fR, and the invocation of other hooks is |
| 406 |
skipped, and the relevant action might not be carried out by the \*(C+ code. |
| 407 |
.PP |
| 408 |
\&\fIWhen in doubt, return a false value (preferably \f(CI\*(C`()\*(C'\fI).\fR |
| 409 |
.ie n .IP "on_init $term" 4 |
| 410 |
.el .IP "on_init \f(CW$term\fR" 4 |
| 411 |
.IX Item "on_init $term" |
| 412 |
Called after a new terminal object has been initialized, but before |
| 413 |
windows are created or the command gets run. Most methods are unsafe to |
| 414 |
call or deliver senseless data, as terminal size and other characteristics |
| 415 |
have not yet been determined. You can safely query and change resources, |
| 416 |
though. |
| 417 |
.ie n .IP "on_reset $term" 4 |
| 418 |
.el .IP "on_reset \f(CW$term\fR" 4 |
| 419 |
.IX Item "on_reset $term" |
| 420 |
Called after the screen is \*(L"reset\*(R" for any reason, such as resizing or |
| 421 |
control sequences. Here is where you can react on changes to size-related |
| 422 |
variables. |
| 423 |
.ie n .IP "on_start $term" 4 |
| 424 |
.el .IP "on_start \f(CW$term\fR" 4 |
| 425 |
.IX Item "on_start $term" |
| 426 |
Called at the very end of initialisation of a new terminal, just before |
| 427 |
returning to the mainloop. |
| 428 |
.ie n .IP "on_sel_make $term\fR, \f(CW$eventtime" 4 |
| 429 |
.el .IP "on_sel_make \f(CW$term\fR, \f(CW$eventtime\fR" 4 |
| 430 |
.IX Item "on_sel_make $term, $eventtime" |
| 431 |
Called whenever a selection has been made by the user, but before the |
| 432 |
selection text is copied, so changes to the beginning, end or type of the |
| 433 |
selection will be honored. |
| 434 |
.Sp |
| 435 |
Returning a true value aborts selection making by urxvt, in which case you |
| 436 |
have to make a selection yourself by calling \f(CW\*(C`$term\->selection_grab\*(C'\fR. |
| 437 |
.ie n .IP "on_sel_grab $term\fR, \f(CW$eventtime" 4 |
| 438 |
.el .IP "on_sel_grab \f(CW$term\fR, \f(CW$eventtime\fR" 4 |
| 439 |
.IX Item "on_sel_grab $term, $eventtime" |
| 440 |
Called whenever a selection has been copied, but before the selection is |
| 441 |
requested from the server. The selection text can be queried and changed |
| 442 |
by calling \f(CW\*(C`$term\->selection\*(C'\fR. |
| 443 |
.Sp |
| 444 |
Returning a true value aborts selection grabbing. It will still be hilighted. |
| 445 |
.ie n .IP "on_sel_extend $term" 4 |
| 446 |
.el .IP "on_sel_extend \f(CW$term\fR" 4 |
| 447 |
.IX Item "on_sel_extend $term" |
| 448 |
Called whenever the user tries to extend the selection (e.g. with a double |
| 449 |
click) and is either supposed to return false (normal operation), or |
| 450 |
should extend the selection itelf and return true to suppress the built-in |
| 451 |
processing. This can happen multiple times, as long as the callback |
| 452 |
returns true, it will be called on every further click by the user and is |
| 453 |
supposed to enlarge the selection more and more, if possible. |
| 454 |
.Sp |
| 455 |
See the \fIselection\fR example extension. |
| 456 |
.ie n .IP "on_view_change $term\fR, \f(CW$offset" 4 |
| 457 |
.el .IP "on_view_change \f(CW$term\fR, \f(CW$offset\fR" 4 |
| 458 |
.IX Item "on_view_change $term, $offset" |
| 459 |
Called whenever the view offset changes, i..e the user or program |
| 460 |
scrolls. Offset \f(CW0\fR means display the normal terminal, positive values |
| 461 |
show this many lines of scrollback. |
| 462 |
.ie n .IP "on_scroll_back $term\fR, \f(CW$lines\fR, \f(CW$saved" 4 |
| 463 |
.el .IP "on_scroll_back \f(CW$term\fR, \f(CW$lines\fR, \f(CW$saved\fR" 4 |
| 464 |
.IX Item "on_scroll_back $term, $lines, $saved" |
| 465 |
Called whenever lines scroll out of the terminal area into the scrollback |
| 466 |
buffer. \f(CW$lines\fR is the number of lines scrolled out and may be larger |
| 467 |
than the scroll back buffer or the terminal. |
| 468 |
.Sp |
| 469 |
It is called before lines are scrolled out (so rows 0 .. min ($lines \- 1, |
| 470 |
\&\f(CW$nrow\fR \- 1) represent the lines to be scrolled out). \f(CW$saved\fR is the total |
| 471 |
number of lines that will be in the scrollback buffer. |
| 472 |
.ie n .IP "on_osc_seq $term\fR, \f(CW$string" 4 |
| 473 |
.el .IP "on_osc_seq \f(CW$term\fR, \f(CW$string\fR" 4 |
| 474 |
.IX Item "on_osc_seq $term, $string" |
| 475 |
Called whenever the \fB\s-1ESC\s0 ] 777 ; string \s-1ST\s0\fR command sequence (\s-1OSC\s0 = |
| 476 |
operating system command) is processed. Cursor position and other state |
| 477 |
information is up-to-date when this happens. For interoperability, the |
| 478 |
string should start with the extension name and a colon, to distinguish |
| 479 |
it from commands for other extensions, and this might be enforced in the |
| 480 |
future. |
| 481 |
.Sp |
| 482 |
Be careful not ever to trust (in a security sense) the data you receive, |
| 483 |
as its source can not easily be controleld (e\-mail content, messages from |
| 484 |
other users on the same system etc.). |
| 485 |
.ie n .IP "on_add_lines $term\fR, \f(CW$string" 4 |
| 486 |
.el .IP "on_add_lines \f(CW$term\fR, \f(CW$string\fR" 4 |
| 487 |
.IX Item "on_add_lines $term, $string" |
| 488 |
Called whenever text is about to be output, with the text as argument. You |
| 489 |
can filter/change and output the text yourself by returning a true value |
| 490 |
and calling \f(CW\*(C`$term\->scr_add_lines\*(C'\fR yourself. Please note that this |
| 491 |
might be very slow, however, as your hook is called for \fBall\fR text being |
| 492 |
output. |
| 493 |
.ie n .IP "on_tt_write $term\fR, \f(CW$octets" 4 |
| 494 |
.el .IP "on_tt_write \f(CW$term\fR, \f(CW$octets\fR" 4 |
| 495 |
.IX Item "on_tt_write $term, $octets" |
| 496 |
Called whenever some data is written to the tty/pty and can be used to |
| 497 |
suppress or filter tty input. |
| 498 |
.ie n .IP "on_line_update $term\fR, \f(CW$row" 4 |
| 499 |
.el .IP "on_line_update \f(CW$term\fR, \f(CW$row\fR" 4 |
| 500 |
.IX Item "on_line_update $term, $row" |
| 501 |
Called whenever a line was updated or changed. Can be used to filter |
| 502 |
screen output (e.g. underline urls or other useless stuff). Only lines |
| 503 |
that are being shown will be filtered, and, due to performance reasons, |
| 504 |
not always immediately. |
| 505 |
.Sp |
| 506 |
The row number is always the topmost row of the line if the line spans |
| 507 |
multiple rows. |
| 508 |
.Sp |
| 509 |
Please note that, if you change the line, then the hook might get called |
| 510 |
later with the already-modified line (e.g. if unrelated parts change), so |
| 511 |
you cannot just toggle rendition bits, but only set them. |
| 512 |
.ie n .IP "on_refresh_begin $term" 4 |
| 513 |
.el .IP "on_refresh_begin \f(CW$term\fR" 4 |
| 514 |
.IX Item "on_refresh_begin $term" |
| 515 |
Called just before the screen gets redrawn. Can be used for overlay |
| 516 |
or similar effects by modify terminal contents in refresh_begin, and |
| 517 |
restoring them in refresh_end. The built-in overlay and selection display |
| 518 |
code is run after this hook, and takes precedence. |
| 519 |
.ie n .IP "on_refresh_end $term" 4 |
| 520 |
.el .IP "on_refresh_end \f(CW$term\fR" 4 |
| 521 |
.IX Item "on_refresh_end $term" |
| 522 |
Called just after the screen gets redrawn. See \f(CW\*(C`on_refresh_begin\*(C'\fR. |
| 523 |
.ie n .IP "on_keyboard_command $term\fR, \f(CW$string" 4 |
| 524 |
.el .IP "on_keyboard_command \f(CW$term\fR, \f(CW$string\fR" 4 |
| 525 |
.IX Item "on_keyboard_command $term, $string" |
| 526 |
Called whenever the user presses a key combination that has a |
| 527 |
\&\f(CW\*(C`perl:string\*(C'\fR action bound to it (see description of the \fBkeysym\fR |
| 528 |
resource in the @@RXVT_NAME@@(1) manpage). |
| 529 |
.ie n .IP "on_x_event $term\fR, \f(CW$event" 4 |
| 530 |
.el .IP "on_x_event \f(CW$term\fR, \f(CW$event\fR" 4 |
| 531 |
.IX Item "on_x_event $term, $event" |
| 532 |
Called on every X event received on the vt window (and possibly other |
| 533 |
windows). Should only be used as a last resort. Most event structure |
| 534 |
members are not passed. |
| 535 |
.ie n .IP "on_focus_in $term" 4 |
| 536 |
.el .IP "on_focus_in \f(CW$term\fR" 4 |
| 537 |
.IX Item "on_focus_in $term" |
| 538 |
Called whenever the window gets the keyboard focus, before rxvt-unicode |
| 539 |
does focus in processing. |
| 540 |
.ie n .IP "on_focus_out $term" 4 |
| 541 |
.el .IP "on_focus_out \f(CW$term\fR" 4 |
| 542 |
.IX Item "on_focus_out $term" |
| 543 |
Called wheneever the window loses keyboard focus, before rxvt-unicode does |
| 544 |
focus out processing. |
| 545 |
.ie n .IP "on_key_press $term\fR, \f(CW$event\fR, \f(CW$keysym\fR, \f(CW$octets" 4 |
| 546 |
.el .IP "on_key_press \f(CW$term\fR, \f(CW$event\fR, \f(CW$keysym\fR, \f(CW$octets\fR" 4 |
| 547 |
.IX Item "on_key_press $term, $event, $keysym, $octets" |
| 548 |
.PD 0 |
| 549 |
.ie n .IP "on_key_release $term\fR, \f(CW$event\fR, \f(CW$keysym" 4 |
| 550 |
.el .IP "on_key_release \f(CW$term\fR, \f(CW$event\fR, \f(CW$keysym\fR" 4 |
| 551 |
.IX Item "on_key_release $term, $event, $keysym" |
| 552 |
.ie n .IP "on_button_press $term\fR, \f(CW$event" 4 |
| 553 |
.el .IP "on_button_press \f(CW$term\fR, \f(CW$event\fR" 4 |
| 554 |
.IX Item "on_button_press $term, $event" |
| 555 |
.ie n .IP "on_button_release $term\fR, \f(CW$event" 4 |
| 556 |
.el .IP "on_button_release \f(CW$term\fR, \f(CW$event\fR" 4 |
| 557 |
.IX Item "on_button_release $term, $event" |
| 558 |
.ie n .IP "on_motion_notify $term\fR, \f(CW$event" 4 |
| 559 |
.el .IP "on_motion_notify \f(CW$term\fR, \f(CW$event\fR" 4 |
| 560 |
.IX Item "on_motion_notify $term, $event" |
| 561 |
.ie n .IP "on_map_notify $term\fR, \f(CW$event" 4 |
| 562 |
.el .IP "on_map_notify \f(CW$term\fR, \f(CW$event\fR" 4 |
| 563 |
.IX Item "on_map_notify $term, $event" |
| 564 |
.ie n .IP "on_unmap_notify $term\fR, \f(CW$event" 4 |
| 565 |
.el .IP "on_unmap_notify \f(CW$term\fR, \f(CW$event\fR" 4 |
| 566 |
.IX Item "on_unmap_notify $term, $event" |
| 567 |
.PD |
| 568 |
Called whenever the corresponding X event is received for the terminal If |
| 569 |
the hook returns true, then the even will be ignored by rxvt\-unicode. |
| 570 |
.Sp |
| 571 |
The event is a hash with most values as named by Xlib (see the XEvent |
| 572 |
manpage), with the additional members \f(CW\*(C`row\*(C'\fR and \f(CW\*(C`col\*(C'\fR, which are the row |
| 573 |
and column under the mouse cursor. |
| 574 |
.Sp |
| 575 |
\&\f(CW\*(C`on_key_press\*(C'\fR additionally receives the string rxvt-unicode would |
| 576 |
output, if any, in locale-specific encoding. |
| 577 |
.Sp |
| 578 |
subwindow. |
| 579 |
.ie n .Sh "Variables in the ""urxvt"" Package" |
| 580 |
.el .Sh "Variables in the \f(CWurxvt\fP Package" |
| 581 |
.IX Subsection "Variables in the urxvt Package" |
| 582 |
.IP "$urxvt::LIBDIR" 4 |
| 583 |
.IX Item "$urxvt::LIBDIR" |
| 584 |
The rxvt-unicode library directory, where, among other things, the perl |
| 585 |
modules and scripts are stored. |
| 586 |
.ie n .IP "$urxvt::RESCLASS, $urxvt::RESCLASS" 4 |
| 587 |
.el .IP "$urxvt::RESCLASS, \f(CW$urxvt::RESCLASS\fR" 4 |
| 588 |
.IX Item "$urxvt::RESCLASS, $urxvt::RESCLASS" |
| 589 |
The resource class and name rxvt-unicode uses to look up X resources. |
| 590 |
.IP "$urxvt::RXVTNAME" 4 |
| 591 |
.IX Item "$urxvt::RXVTNAME" |
| 592 |
The basename of the installed binaries, usually \f(CW\*(C`urxvt\*(C'\fR. |
| 593 |
.IP "$urxvt::TERM" 4 |
| 594 |
.IX Item "$urxvt::TERM" |
| 595 |
The current terminal. This variable stores the current \f(CW\*(C`urxvt::term\*(C'\fR |
| 596 |
object, whenever a callback/hook is executing. |
| 597 |
.ie n .Sh "Functions in the ""urxvt"" Package" |
| 598 |
.el .Sh "Functions in the \f(CWurxvt\fP Package" |
| 599 |
.IX Subsection "Functions in the urxvt Package" |
| 600 |
.ie n .IP "urxvt::fatal $errormessage" 4 |
| 601 |
.el .IP "urxvt::fatal \f(CW$errormessage\fR" 4 |
| 602 |
.IX Item "urxvt::fatal $errormessage" |
| 603 |
Fatally aborts execution with the given error message. Avoid at all |
| 604 |
costs! The only time this is acceptable is when the terminal process |
| 605 |
starts up. |
| 606 |
.ie n .IP "urxvt::warn $string" 4 |
| 607 |
.el .IP "urxvt::warn \f(CW$string\fR" 4 |
| 608 |
.IX Item "urxvt::warn $string" |
| 609 |
Calls \f(CW\*(C`rxvt_warn\*(C'\fR with the given string which should not include a |
| 610 |
newline. The module also overwrites the \f(CW\*(C`warn\*(C'\fR builtin with a function |
| 611 |
that calls this function. |
| 612 |
.Sp |
| 613 |
Using this function has the advantage that its output ends up in the |
| 614 |
correct place, e.g. on stderr of the connecting urxvtc client. |
| 615 |
.Sp |
| 616 |
Messages have a size limit of 1023 bytes currently. |
| 617 |
.IP "$time = urxvt::NOW" 4 |
| 618 |
.IX Item "$time = urxvt::NOW" |
| 619 |
Returns the \*(L"current time\*(R" (as per the event loop). |
| 620 |
.IP "urxvt::CurrentTime" 4 |
| 621 |
.IX Item "urxvt::CurrentTime" |
| 622 |
.PD 0 |
| 623 |
.IP "urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, Button4Mask, Button5Mask, AnyModifier" 4 |
| 624 |
.IX Item "urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, Button4Mask, Button5Mask, AnyModifier" |
| 625 |
.IP "urxvt::NoEventMask, KeyPressMask, KeyReleaseMask, ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask, Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask, KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask, ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask, FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask" 4 |
| 626 |
.IX Item "urxvt::NoEventMask, KeyPressMask, KeyReleaseMask, ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask, Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask, KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask, ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask, FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask" |
| 627 |
.IP "urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify, EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose, GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify, UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify, ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify, CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, SelectionNotify, ColormapNotify, ClientMessage, MappingNotify" 4 |
| 628 |
.IX Item "urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify, EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose, GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify, UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify, ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify, CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, SelectionNotify, ColormapNotify, ClientMessage, MappingNotify" |
| 629 |
.PD |
| 630 |
Various constants for use in X calls and event processing. |
| 631 |
.Sh "\s-1RENDITION\s0" |
| 632 |
.IX Subsection "RENDITION" |
| 633 |
Rendition bitsets contain information about colour, font, font styles and |
| 634 |
similar information for each screen cell. |
| 635 |
.PP |
| 636 |
The following \*(L"macros\*(R" deal with changes in rendition sets. You should |
| 637 |
never just create a bitset, you should always modify an existing one, |
| 638 |
as they contain important information required for correct operation of |
| 639 |
rxvt\-unicode. |
| 640 |
.IP "$rend = urxvt::DEFAULT_RSTYLE" 4 |
| 641 |
.IX Item "$rend = urxvt::DEFAULT_RSTYLE" |
| 642 |
Returns the default rendition, as used when the terminal is starting up or |
| 643 |
being reset. Useful as a base to start when creating renditions. |
| 644 |
.IP "$rend = urxvt::OVERLAY_RSTYLE" 4 |
| 645 |
.IX Item "$rend = urxvt::OVERLAY_RSTYLE" |
| 646 |
Return the rendition mask used for overlays by default. |
| 647 |
.IP "$rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline" 4 |
| 648 |
.IX Item "$rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline" |
| 649 |
Return the bit that enabled bold, italic, blink, reverse-video and |
| 650 |
underline, respectively. To enable such a style, just logically \s-1OR\s0 it into |
| 651 |
the bitset. |
| 652 |
.ie n .IP "$foreground = urxvt::GET_BASEFG $rend" 4 |
| 653 |
.el .IP "$foreground = urxvt::GET_BASEFG \f(CW$rend\fR" 4 |
| 654 |
.IX Item "$foreground = urxvt::GET_BASEFG $rend" |
| 655 |
.PD 0 |
| 656 |
.ie n .IP "$background = urxvt::GET_BASEBG $rend" 4 |
| 657 |
.el .IP "$background = urxvt::GET_BASEBG \f(CW$rend\fR" 4 |
| 658 |
.IX Item "$background = urxvt::GET_BASEBG $rend" |
| 659 |
.PD |
| 660 |
Return the foreground/background colour index, respectively. |
| 661 |
.ie n .IP "$rend = urxvt::SET_FGCOLOR $rend\fR, \f(CW$new_colour" 4 |
| 662 |
.el .IP "$rend = urxvt::SET_FGCOLOR \f(CW$rend\fR, \f(CW$new_colour\fR" 4 |
| 663 |
.IX Item "$rend = urxvt::SET_FGCOLOR $rend, $new_colour" |
| 664 |
.PD 0 |
| 665 |
.ie n .IP "$rend = urxvt::SET_BGCOLOR $rend\fR, \f(CW$new_colour" 4 |
| 666 |
.el .IP "$rend = urxvt::SET_BGCOLOR \f(CW$rend\fR, \f(CW$new_colour\fR" 4 |
| 667 |
.IX Item "$rend = urxvt::SET_BGCOLOR $rend, $new_colour" |
| 668 |
.PD |
| 669 |
Replace the foreground/background colour in the rendition mask with the |
| 670 |
specified one. |
| 671 |
.ie n .IP "$value = urxvt::GET_CUSTOM $rend" 4 |
| 672 |
.el .IP "$value = urxvt::GET_CUSTOM \f(CW$rend\fR" 4 |
| 673 |
.IX Item "$value = urxvt::GET_CUSTOM $rend" |
| 674 |
Return the \*(L"custom\*(R" value: Every rendition has 5 bits for use by |
| 675 |
extensions. They can be set and changed as you like and are initially |
| 676 |
zero. |
| 677 |
.ie n .IP "$rend = urxvt::SET_CUSTOM $rend\fR, \f(CW$new_value" 4 |
| 678 |
.el .IP "$rend = urxvt::SET_CUSTOM \f(CW$rend\fR, \f(CW$new_value\fR" 4 |
| 679 |
.IX Item "$rend = urxvt::SET_CUSTOM $rend, $new_value" |
| 680 |
Change the custom value. |
| 681 |
.ie n .Sh "The ""urxvt::anyevent"" Class" |
| 682 |
.el .Sh "The \f(CWurxvt::anyevent\fP Class" |
| 683 |
.IX Subsection "The urxvt::anyevent Class" |
| 684 |
The sole purpose of this class is to deliver an interface to the |
| 685 |
\&\f(CW\*(C`AnyEvent\*(C'\fR module \- any module using it will work inside urxvt without |
| 686 |
further programming. The only exception is that you cannot wait on |
| 687 |
condition variables, but non-blocking condvar use is ok. What this means |
| 688 |
is that you cannot use blocking APIs, but the non-blocking variant should |
| 689 |
work. |
| 690 |
.ie n .Sh "The ""urxvt::term"" Class" |
| 691 |
.el .Sh "The \f(CWurxvt::term\fP Class" |
| 692 |
.IX Subsection "The urxvt::term Class" |
| 693 |
.ie n .IP "$term = new urxvt::term $envhashref\fR, \f(CW$rxvtname, [arg...]" 4 |
| 694 |
.el .IP "$term = new urxvt::term \f(CW$envhashref\fR, \f(CW$rxvtname\fR, [arg...]" 4 |
| 695 |
.IX Item "$term = new urxvt::term $envhashref, $rxvtname, [arg...]" |
| 696 |
Creates a new terminal, very similar as if you had started it with system |
| 697 |
\&\f(CW\*(C`$rxvtname, arg...\*(C'\fR. \f(CW$envhashref\fR must be a reference to a \f(CW%ENV\fR\-like |
| 698 |
hash which defines the environment of the new terminal. |
| 699 |
.Sp |
| 700 |
Croaks (and probably outputs an error message) if the new instance |
| 701 |
couldn't be created. Returns \f(CW\*(C`undef\*(C'\fR if the new instance didn't |
| 702 |
initialise perl, and the terminal object otherwise. The \f(CW\*(C`init\*(C'\fR and |
| 703 |
\&\f(CW\*(C`start\*(C'\fR hooks will be called during this call. |
| 704 |
.IP "$term\->destroy" 4 |
| 705 |
.IX Item "$term->destroy" |
| 706 |
Destroy the terminal object (close the window, free resources |
| 707 |
etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event |
| 708 |
watchers (timers, io watchers) are still active. |
| 709 |
.ie n .IP "$isset = $term\fR\->option ($optval[, \f(CW$set])" 4 |
| 710 |
.el .IP "$isset = \f(CW$term\fR\->option ($optval[, \f(CW$set\fR])" 4 |
| 711 |
.IX Item "$isset = $term->option ($optval[, $set])" |
| 712 |
Returns true if the option specified by \f(CW$optval\fR is enabled, and |
| 713 |
optionally change it. All option values are stored by name in the hash |
| 714 |
\&\f(CW%urxvt::OPTION\fR. Options not enabled in this binary are not in the hash. |
| 715 |
.Sp |
| 716 |
Here is a a likely non-exhaustive list of option names, please see the |
| 717 |
source file \fI/src/optinc.h\fR to see the actual list: |
| 718 |
.Sp |
| 719 |
.Vb 6 |
| 720 |
\& borderLess console cursorBlink cursorUnderline hold iconic insecure |
| 721 |
\& intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
| 722 |
\& pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating |
| 723 |
\& scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer |
| 724 |
\& secondaryScreen secondaryScroll skipBuiltinGlyphs transparent |
| 725 |
\& tripleclickwords utmpInhibit visualBell |
| 726 |
.Ve |
| 727 |
.ie n .IP "$value = $term\fR\->resource ($name[, \f(CW$newval])" 4 |
| 728 |
.el .IP "$value = \f(CW$term\fR\->resource ($name[, \f(CW$newval\fR])" 4 |
| 729 |
.IX Item "$value = $term->resource ($name[, $newval])" |
| 730 |
Returns the current resource value associated with a given name and |
| 731 |
optionally sets a new value. Setting values is most useful in the \f(CW\*(C`init\*(C'\fR |
| 732 |
hook. Unset resources are returned and accepted as \f(CW\*(C`undef\*(C'\fR. |
| 733 |
.Sp |
| 734 |
The new value must be properly encoded to a suitable character encoding |
| 735 |
before passing it to this method. Similarly, the returned value may need |
| 736 |
to be converted from the used encoding to text. |
| 737 |
.Sp |
| 738 |
Resource names are as defined in \fIsrc/rsinc.h\fR. Colours can be specified |
| 739 |
as resource names of the form \f(CW\*(C`color+<index>\*(C'\fR, e.g. \f(CW\*(C`color+5\*(C'\fR. (will |
| 740 |
likely change). |
| 741 |
.Sp |
| 742 |
Please note that resource strings will currently only be freed when the |
| 743 |
terminal is destroyed, so changing options frequently will eat memory. |
| 744 |
.Sp |
| 745 |
Here is a a likely non-exhaustive list of resource names, not all of which |
| 746 |
are supported in every build, please see the source file \fI/src/rsinc.h\fR |
| 747 |
to see the actual list: |
| 748 |
.Sp |
| 749 |
.Vb 12 |
| 750 |
\& answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
| 751 |
\& borderLess color cursorBlink cursorUnderline cutchars delete_key |
| 752 |
\& display_name embed ext_bwidth fade font geometry hold iconName |
| 753 |
\& imFont imLocale inputMethod insecure int_bwidth intensityStyles |
| 754 |
\& italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
| 755 |
\& mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 |
| 756 |
\& perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
| 757 |
\& reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
| 758 |
\& scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
| 759 |
\& scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
| 760 |
\& shade term_name title transparent transparent_all tripleclickwords |
| 761 |
\& utmpInhibit visualBell |
| 762 |
.Ve |
| 763 |
.ie n .IP "$value = $term\->x_resource ($pattern)" 4 |
| 764 |
.el .IP "$value = \f(CW$term\fR\->x_resource ($pattern)" 4 |
| 765 |
.IX Item "$value = $term->x_resource ($pattern)" |
| 766 |
Returns the X\-Resource for the given pattern, excluding the program or |
| 767 |
class name, i.e. \f(CW\*(C`$term\->x_resource ("boldFont")\*(C'\fR should return the |
| 768 |
same value as used by this instance of rxvt\-unicode. Returns \f(CW\*(C`undef\*(C'\fR if no |
| 769 |
resource with that pattern exists. |
| 770 |
.Sp |
| 771 |
This method should only be called during the \f(CW\*(C`on_start\*(C'\fR hook, as there is |
| 772 |
only one resource database per display, and later invocations might return |
| 773 |
the wrong resources. |
| 774 |
.ie n .IP "$success = $term\fR\->parse_keysym ($keysym_spec, \f(CW$command_string)" 4 |
| 775 |
.el .IP "$success = \f(CW$term\fR\->parse_keysym ($keysym_spec, \f(CW$command_string\fR)" 4 |
| 776 |
.IX Item "$success = $term->parse_keysym ($keysym_spec, $command_string)" |
| 777 |
Adds a keymap translation exactly as specified via a resource. See the |
| 778 |
\&\f(CW\*(C`keysym\*(C'\fR resource in the @@RXVT_NAME@@(1) manpage. |
| 779 |
.ie n .IP "$rend = $term\->rstyle ([$new_rstyle])" 4 |
| 780 |
.el .IP "$rend = \f(CW$term\fR\->rstyle ([$new_rstyle])" 4 |
| 781 |
.IX Item "$rend = $term->rstyle ([$new_rstyle])" |
| 782 |
Return and optionally change the current rendition. Text that is output by |
| 783 |
the terminal application will use this style. |
| 784 |
.ie n .IP "($row, $col\fR) = \f(CW$term\fR\->screen_cur ([$row, \f(CW$col])" 4 |
| 785 |
.el .IP "($row, \f(CW$col\fR) = \f(CW$term\fR\->screen_cur ([$row, \f(CW$col\fR])" 4 |
| 786 |
.IX Item "($row, $col) = $term->screen_cur ([$row, $col])" |
| 787 |
Return the current coordinates of the text cursor position and optionally |
| 788 |
set it (which is usually bad as applications don't expect that). |
| 789 |
.ie n .IP "($row, $col\fR) = \f(CW$term\fR\->selection_mark ([$row, \f(CW$col])" 4 |
| 790 |
.el .IP "($row, \f(CW$col\fR) = \f(CW$term\fR\->selection_mark ([$row, \f(CW$col\fR])" 4 |
| 791 |
.IX Item "($row, $col) = $term->selection_mark ([$row, $col])" |
| 792 |
.PD 0 |
| 793 |
.ie n .IP "($row, $col\fR) = \f(CW$term\fR\->selection_beg ([$row, \f(CW$col])" 4 |
| 794 |
.el .IP "($row, \f(CW$col\fR) = \f(CW$term\fR\->selection_beg ([$row, \f(CW$col\fR])" 4 |
| 795 |
.IX Item "($row, $col) = $term->selection_beg ([$row, $col])" |
| 796 |
.ie n .IP "($row, $col\fR) = \f(CW$term\fR\->selection_end ([$row, \f(CW$col])" 4 |
| 797 |
.el .IP "($row, \f(CW$col\fR) = \f(CW$term\fR\->selection_end ([$row, \f(CW$col\fR])" 4 |
| 798 |
.IX Item "($row, $col) = $term->selection_end ([$row, $col])" |
| 799 |
.PD |
| 800 |
Return the current values of the selection mark, begin or end positions, |
| 801 |
and optionally set them to new values. |
| 802 |
.ie n .IP "$term\->selection_make ($eventtime[, $rectangular])" 4 |
| 803 |
.el .IP "$term\->selection_make ($eventtime[, \f(CW$rectangular\fR])" 4 |
| 804 |
.IX Item "$term->selection_make ($eventtime[, $rectangular])" |
| 805 |
Tries to make a selection as set by \f(CW\*(C`selection_beg\*(C'\fR and |
| 806 |
\&\f(CW\*(C`selection_end\*(C'\fR. If \f(CW$rectangular\fR is true (default: false), a |
| 807 |
rectangular selection will be made. This is the prefered function to make |
| 808 |
a selection. |
| 809 |
.ie n .IP "$success = $term\->selection_grab ($eventtime)" 4 |
| 810 |
.el .IP "$success = \f(CW$term\fR\->selection_grab ($eventtime)" 4 |
| 811 |
.IX Item "$success = $term->selection_grab ($eventtime)" |
| 812 |
Try to request the primary selection text from the server (for example, as |
| 813 |
set by the next method). No visual feedback will be given. This function |
| 814 |
is mostly useful from within \f(CW\*(C`on_sel_grab\*(C'\fR hooks. |
| 815 |
.ie n .IP "$oldtext = $term\->selection ([$newtext])" 4 |
| 816 |
.el .IP "$oldtext = \f(CW$term\fR\->selection ([$newtext])" 4 |
| 817 |
.IX Item "$oldtext = $term->selection ([$newtext])" |
| 818 |
Return the current selection text and optionally replace it by \f(CW$newtext\fR. |
| 819 |
.ie n .IP "$term\->overlay_simple ($x, $y\fR, \f(CW$text)" 4 |
| 820 |
.el .IP "$term\->overlay_simple ($x, \f(CW$y\fR, \f(CW$text\fR)" 4 |
| 821 |
.IX Item "$term->overlay_simple ($x, $y, $text)" |
| 822 |
Create a simple multi-line overlay box. See the next method for details. |
| 823 |
.ie n .IP "$term\->overlay ($x, $y\fR, \f(CW$width\fR, \f(CW$height\fR[, \f(CW$rstyle\fR[, \f(CW$border]])" 4 |
| 824 |
.el .IP "$term\->overlay ($x, \f(CW$y\fR, \f(CW$width\fR, \f(CW$height\fR[, \f(CW$rstyle\fR[, \f(CW$border\fR]])" 4 |
| 825 |
.IX Item "$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])" |
| 826 |
Create a new (empty) overlay at the given position with the given |
| 827 |
width/height. \f(CW$rstyle\fR defines the initial rendition style |
| 828 |
(default: \f(CW\*(C`OVERLAY_RSTYLE\*(C'\fR). |
| 829 |
.Sp |
| 830 |
If \f(CW$border\fR is \f(CW2\fR (default), then a decorative border will be put |
| 831 |
around the box. |
| 832 |
.Sp |
| 833 |
If either \f(CW$x\fR or \f(CW$y\fR is negative, then this is counted from the |
| 834 |
right/bottom side, respectively. |
| 835 |
.Sp |
| 836 |
This method returns an urxvt::overlay object. The overlay will be visible |
| 837 |
as long as the perl object is referenced. |
| 838 |
.Sp |
| 839 |
The methods currently supported on \f(CW\*(C`urxvt::overlay\*(C'\fR objects are: |
| 840 |
.RS 4 |
| 841 |
.ie n .IP "$overlay\->set ($x, $y\fR, \f(CW$text\fR, \f(CW$rend)" 4 |
| 842 |
.el .IP "$overlay\->set ($x, \f(CW$y\fR, \f(CW$text\fR, \f(CW$rend\fR)" 4 |
| 843 |
.IX Item "$overlay->set ($x, $y, $text, $rend)" |
| 844 |
Similar to \f(CW\*(C`$term\->ROW_t\*(C'\fR and \f(CW\*(C`$term\->ROW_r\*(C'\fR in that it puts |
| 845 |
text in rxvt\-unicode's special encoding and an array of rendition values |
| 846 |
at a specific position inside the overlay. |
| 847 |
.IP "$overlay\->hide" 4 |
| 848 |
.IX Item "$overlay->hide" |
| 849 |
If visible, hide the overlay, but do not destroy it. |
| 850 |
.IP "$overlay\->show" 4 |
| 851 |
.IX Item "$overlay->show" |
| 852 |
If hidden, display the overlay again. |
| 853 |
.RE |
| 854 |
.RS 4 |
| 855 |
.RE |
| 856 |
.ie n .IP "$popup = $term\->popup ($event)" 4 |
| 857 |
.el .IP "$popup = \f(CW$term\fR\->popup ($event)" 4 |
| 858 |
.IX Item "$popup = $term->popup ($event)" |
| 859 |
Creates a new \f(CW\*(C`urxvt::popup\*(C'\fR object that implements a popup menu. The |
| 860 |
\&\f(CW$event\fR \fImust\fR be the event causing the menu to pop up (a button event, |
| 861 |
currently). |
| 862 |
.ie n .IP "$cellwidth = $term\->strwidth ($string)" 4 |
| 863 |
.el .IP "$cellwidth = \f(CW$term\fR\->strwidth ($string)" 4 |
| 864 |
.IX Item "$cellwidth = $term->strwidth ($string)" |
| 865 |
Returns the number of screen-cells this string would need. Correctly |
| 866 |
accounts for wide and combining characters. |
| 867 |
.ie n .IP "$octets = $term\->locale_encode ($string)" 4 |
| 868 |
.el .IP "$octets = \f(CW$term\fR\->locale_encode ($string)" 4 |
| 869 |
.IX Item "$octets = $term->locale_encode ($string)" |
| 870 |
Convert the given text string into the corresponding locale encoding. |
| 871 |
.ie n .IP "$string = $term\->locale_decode ($octets)" 4 |
| 872 |
.el .IP "$string = \f(CW$term\fR\->locale_decode ($octets)" 4 |
| 873 |
.IX Item "$string = $term->locale_decode ($octets)" |
| 874 |
Convert the given locale-encoded octets into a perl string. |
| 875 |
.ie n .IP "$term\->scr_xor_span ($beg_row, $beg_col\fR, \f(CW$end_row\fR, \f(CW$end_col\fR[, \f(CW$rstyle])" 4 |
| 876 |
.el .IP "$term\->scr_xor_span ($beg_row, \f(CW$beg_col\fR, \f(CW$end_row\fR, \f(CW$end_col\fR[, \f(CW$rstyle\fR])" 4 |
| 877 |
.IX Item "$term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])" |
| 878 |
XORs the rendition values in the given span with the provided value |
| 879 |
(default: \f(CW\*(C`RS_RVid\*(C'\fR), which \fI\s-1MUST\s0 \s-1NOT\s0\fR contain font styles. Useful in |
| 880 |
refresh hooks to provide effects similar to the selection. |
| 881 |
.ie n .IP "$term\->scr_xor_rect ($beg_row, $beg_col\fR, \f(CW$end_row\fR, \f(CW$end_col\fR[, \f(CW$rstyle1\fR[, \f(CW$rstyle2]])" 4 |
| 882 |
.el .IP "$term\->scr_xor_rect ($beg_row, \f(CW$beg_col\fR, \f(CW$end_row\fR, \f(CW$end_col\fR[, \f(CW$rstyle1\fR[, \f(CW$rstyle2\fR]])" 4 |
| 883 |
.IX Item "$term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])" |
| 884 |
Similar to \f(CW\*(C`scr_xor_span\*(C'\fR, but xors a rectangle instead. Trailing |
| 885 |
whitespace will additionally be xored with the \f(CW$rstyle2\fR, which defaults |
| 886 |
to \f(CW\*(C`RS_RVid | RS_Uline\*(C'\fR, which removes reverse video again and underlines |
| 887 |
it instead. Both styles \fI\s-1MUST\s0 \s-1NOT\s0\fR contain font styles. |
| 888 |
.IP "$term\->scr_bell" 4 |
| 889 |
.IX Item "$term->scr_bell" |
| 890 |
Ring the bell! |
| 891 |
.IP "$term\->scr_add_lines ($string)" 4 |
| 892 |
.IX Item "$term->scr_add_lines ($string)" |
| 893 |
Write the given text string to the screen, as if output by the application |
| 894 |
running inside the terminal. It may not contain command sequences (escape |
| 895 |
codes), but is free to use line feeds, carriage returns and tabs. The |
| 896 |
string is a normal text string, not in locale-dependent encoding. |
| 897 |
.Sp |
| 898 |
Normally its not a good idea to use this function, as programs might be |
| 899 |
confused by changes in cursor position or scrolling. Its useful inside a |
| 900 |
\&\f(CW\*(C`on_add_lines\*(C'\fR hook, though. |
| 901 |
.IP "$term\->cmd_parse ($octets)" 4 |
| 902 |
.IX Item "$term->cmd_parse ($octets)" |
| 903 |
Similar to \f(CW\*(C`scr_add_lines\*(C'\fR, but the argument must be in the |
| 904 |
locale-specific encoding of the terminal and can contain command sequences |
| 905 |
(escape codes) that will be interpreted. |
| 906 |
.IP "$term\->tt_write ($octets)" 4 |
| 907 |
.IX Item "$term->tt_write ($octets)" |
| 908 |
Write the octets given in \f(CW$data\fR to the tty (i.e. as program input). To |
| 909 |
pass characters instead of octets, you should convert your strings first |
| 910 |
to the locale-specific encoding using \f(CW\*(C`$term\->locale_encode\*(C'\fR. |
| 911 |
.ie n .IP "$old_events = $term\->pty_ev_events ([$new_events])" 4 |
| 912 |
.el .IP "$old_events = \f(CW$term\fR\->pty_ev_events ([$new_events])" 4 |
| 913 |
.IX Item "$old_events = $term->pty_ev_events ([$new_events])" |
| 914 |
Replaces the event mask of the pty watcher by the given event mask. Can |
| 915 |
be used to suppress input and output handling to the pty/tty. See the |
| 916 |
description of \f(CW\*(C`urxvt::timer\->events\*(C'\fR. Make sure to always restore |
| 917 |
the previous value. |
| 918 |
.ie n .IP "$windowid = $term\->parent" 4 |
| 919 |
.el .IP "$windowid = \f(CW$term\fR\->parent" 4 |
| 920 |
.IX Item "$windowid = $term->parent" |
| 921 |
Return the window id of the toplevel window. |
| 922 |
.ie n .IP "$windowid = $term\->vt" 4 |
| 923 |
.el .IP "$windowid = \f(CW$term\fR\->vt" 4 |
| 924 |
.IX Item "$windowid = $term->vt" |
| 925 |
Return the window id of the terminal window. |
| 926 |
.IP "$term\->vt_emask_add ($x_event_mask)" 4 |
| 927 |
.IX Item "$term->vt_emask_add ($x_event_mask)" |
| 928 |
Adds the specified events to the vt event mask. Useful e.g. when you want |
| 929 |
to receive pointer events all the times: |
| 930 |
.Sp |
| 931 |
.Vb 1 |
| 932 |
\& $term->vt_emask_add (urxvt::PointerMotionMask); |
| 933 |
.Ve |
| 934 |
.ie n .IP "$window_width = $term\->width" 4 |
| 935 |
.el .IP "$window_width = \f(CW$term\fR\->width" 4 |
| 936 |
.IX Item "$window_width = $term->width" |
| 937 |
.PD 0 |
| 938 |
.ie n .IP "$window_height = $term\->height" 4 |
| 939 |
.el .IP "$window_height = \f(CW$term\fR\->height" 4 |
| 940 |
.IX Item "$window_height = $term->height" |
| 941 |
.ie n .IP "$font_width = $term\->fwidth" 4 |
| 942 |
.el .IP "$font_width = \f(CW$term\fR\->fwidth" 4 |
| 943 |
.IX Item "$font_width = $term->fwidth" |
| 944 |
.ie n .IP "$font_height = $term\->fheight" 4 |
| 945 |
.el .IP "$font_height = \f(CW$term\fR\->fheight" 4 |
| 946 |
.IX Item "$font_height = $term->fheight" |
| 947 |
.ie n .IP "$font_ascent = $term\->fbase" 4 |
| 948 |
.el .IP "$font_ascent = \f(CW$term\fR\->fbase" 4 |
| 949 |
.IX Item "$font_ascent = $term->fbase" |
| 950 |
.ie n .IP "$terminal_rows = $term\->nrow" 4 |
| 951 |
.el .IP "$terminal_rows = \f(CW$term\fR\->nrow" 4 |
| 952 |
.IX Item "$terminal_rows = $term->nrow" |
| 953 |
.ie n .IP "$terminal_columns = $term\->ncol" 4 |
| 954 |
.el .IP "$terminal_columns = \f(CW$term\fR\->ncol" 4 |
| 955 |
.IX Item "$terminal_columns = $term->ncol" |
| 956 |
.ie n .IP "$has_focus = $term\->focus" 4 |
| 957 |
.el .IP "$has_focus = \f(CW$term\fR\->focus" 4 |
| 958 |
.IX Item "$has_focus = $term->focus" |
| 959 |
.ie n .IP "$is_mapped = $term\->mapped" 4 |
| 960 |
.el .IP "$is_mapped = \f(CW$term\fR\->mapped" 4 |
| 961 |
.IX Item "$is_mapped = $term->mapped" |
| 962 |
.ie n .IP "$max_scrollback = $term\->saveLines" 4 |
| 963 |
.el .IP "$max_scrollback = \f(CW$term\fR\->saveLines" 4 |
| 964 |
.IX Item "$max_scrollback = $term->saveLines" |
| 965 |
.ie n .IP "$nrow_plus_saveLines = $term\->total_rows" 4 |
| 966 |
.el .IP "$nrow_plus_saveLines = \f(CW$term\fR\->total_rows" 4 |
| 967 |
.IX Item "$nrow_plus_saveLines = $term->total_rows" |
| 968 |
.ie n .IP "$topmost_scrollback_row = $term\->top_row" 4 |
| 969 |
.el .IP "$topmost_scrollback_row = \f(CW$term\fR\->top_row" 4 |
| 970 |
.IX Item "$topmost_scrollback_row = $term->top_row" |
| 971 |
.PD |
| 972 |
Return various integers describing terminal characteristics. |
| 973 |
.ie n .IP "$x_display = $term\->display_id" 4 |
| 974 |
.el .IP "$x_display = \f(CW$term\fR\->display_id" 4 |
| 975 |
.IX Item "$x_display = $term->display_id" |
| 976 |
Return the \s-1DISPLAY\s0 used by rxvt\-unicode. |
| 977 |
.ie n .IP "$lc_ctype = $term\->locale" 4 |
| 978 |
.el .IP "$lc_ctype = \f(CW$term\fR\->locale" 4 |
| 979 |
.IX Item "$lc_ctype = $term->locale" |
| 980 |
Returns the \s-1LC_CTYPE\s0 category string used by this rxvt\-unicode. |
| 981 |
.ie n .IP "$env = $term\->env" 4 |
| 982 |
.el .IP "$env = \f(CW$term\fR\->env" 4 |
| 983 |
.IX Item "$env = $term->env" |
| 984 |
Returns a copy of the environment in effect for the terminal as a hashref |
| 985 |
similar to \f(CW\*(C`\e%ENV\*(C'\fR. |
| 986 |
.ie n .IP "$modifiermask = $term\->ModLevel3Mask" 4 |
| 987 |
.el .IP "$modifiermask = \f(CW$term\fR\->ModLevel3Mask" 4 |
| 988 |
.IX Item "$modifiermask = $term->ModLevel3Mask" |
| 989 |
.PD 0 |
| 990 |
.ie n .IP "$modifiermask = $term\->ModMetaMask" 4 |
| 991 |
.el .IP "$modifiermask = \f(CW$term\fR\->ModMetaMask" 4 |
| 992 |
.IX Item "$modifiermask = $term->ModMetaMask" |
| 993 |
.ie n .IP "$modifiermask = $term\->ModNumLockMask" 4 |
| 994 |
.el .IP "$modifiermask = \f(CW$term\fR\->ModNumLockMask" 4 |
| 995 |
.IX Item "$modifiermask = $term->ModNumLockMask" |
| 996 |
.PD |
| 997 |
Return the modifier masks corresponding to the \*(L"\s-1ISO\s0 Level 3 Shift\*(R" (often |
| 998 |
AltGr), the meta key (often Alt) and the num lock key, if applicable. |
| 999 |
.ie n .IP "$view_start = $term\->view_start ([$newvalue])" 4 |
| 1000 |
.el .IP "$view_start = \f(CW$term\fR\->view_start ([$newvalue])" 4 |
| 1001 |
.IX Item "$view_start = $term->view_start ([$newvalue])" |
| 1002 |
Returns the row number of the topmost displayed line. Maximum value is |
| 1003 |
\&\f(CW0\fR, which displays the normal terminal contents. Lower values scroll |
| 1004 |
this many lines into the scrollback buffer. |
| 1005 |
.IP "$term\->want_refresh" 4 |
| 1006 |
.IX Item "$term->want_refresh" |
| 1007 |
Requests a screen refresh. At the next opportunity, rxvt-unicode will |
| 1008 |
compare the on-screen display with its stored representation. If they |
| 1009 |
differ, it redraws the differences. |
| 1010 |
.Sp |
| 1011 |
Used after changing terminal contents to display them. |
| 1012 |
.ie n .IP "$text = $term\fR\->ROW_t ($row_number[, \f(CW$new_text\fR[, \f(CW$start_col]])" 4 |
| 1013 |
.el .IP "$text = \f(CW$term\fR\->ROW_t ($row_number[, \f(CW$new_text\fR[, \f(CW$start_col\fR]])" 4 |
| 1014 |
.IX Item "$text = $term->ROW_t ($row_number[, $new_text[, $start_col]])" |
| 1015 |
Returns the text of the entire row with number \f(CW$row_number\fR. Row \f(CW0\fR |
| 1016 |
is the topmost terminal line, row \f(CW\*(C`$term\->$ncol\-1\*(C'\fR is the bottommost |
| 1017 |
terminal line. The scrollback buffer starts at line \f(CW\*(C`\-1\*(C'\fR and extends to |
| 1018 |
line \f(CW\*(C`\-$term\->nsaved\*(C'\fR. Nothing will be returned if a nonexistent line |
| 1019 |
is requested. |
| 1020 |
.Sp |
| 1021 |
If \f(CW$new_text\fR is specified, it will replace characters in the current |
| 1022 |
line, starting at column \f(CW$start_col\fR (default \f(CW0\fR), which is useful |
| 1023 |
to replace only parts of a line. The font index in the rendition will |
| 1024 |
automatically be updated. |
| 1025 |
.Sp |
| 1026 |
\&\f(CW$text\fR is in a special encoding: tabs and wide characters that use more |
| 1027 |
than one cell when displayed are padded with urxvt::NOCHAR characters |
| 1028 |
(\f(CW\*(C`chr 65535\*(C'\fR). Characters with combining characters and other characters |
| 1029 |
that do not fit into the normal tetx encoding will be replaced with |
| 1030 |
characters in the private use area. |
| 1031 |
.Sp |
| 1032 |
You have to obey this encoding when changing text. The advantage is |
| 1033 |
that \f(CW\*(C`substr\*(C'\fR and similar functions work on screen cells and not on |
| 1034 |
characters. |
| 1035 |
.Sp |
| 1036 |
The methods \f(CW\*(C`$term\->special_encode\*(C'\fR and \f(CW\*(C`$term\->special_decode\*(C'\fR |
| 1037 |
can be used to convert normal strings into this encoding and vice versa. |
| 1038 |
.ie n .IP "$rend = $term\fR\->ROW_r ($row_number[, \f(CW$new_rend\fR[, \f(CW$start_col]])" 4 |
| 1039 |
.el .IP "$rend = \f(CW$term\fR\->ROW_r ($row_number[, \f(CW$new_rend\fR[, \f(CW$start_col\fR]])" 4 |
| 1040 |
.IX Item "$rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])" |
| 1041 |
Like \f(CW\*(C`$term\->ROW_t\*(C'\fR, but returns an arrayref with rendition |
| 1042 |
bitsets. Rendition bitsets contain information about colour, font, font |
| 1043 |
styles and similar information. See also \f(CW\*(C`$term\->ROW_t\*(C'\fR. |
| 1044 |
.Sp |
| 1045 |
When setting rendition, the font mask will be ignored. |
| 1046 |
.Sp |
| 1047 |
See the section on \s-1RENDITION\s0, above. |
| 1048 |
.ie n .IP "$length = $term\fR\->ROW_l ($row_number[, \f(CW$new_length])" 4 |
| 1049 |
.el .IP "$length = \f(CW$term\fR\->ROW_l ($row_number[, \f(CW$new_length\fR])" 4 |
| 1050 |
.IX Item "$length = $term->ROW_l ($row_number[, $new_length])" |
| 1051 |
Returns the number of screen cells that are in use (\*(L"the line |
| 1052 |
length\*(R"). Unlike the urxvt core, this returns \f(CW\*(C`$term\->ncol\*(C'\fR if the |
| 1053 |
line is joined with the following one. |
| 1054 |
.ie n .IP "$bool = $term\->is_longer ($row_number)" 4 |
| 1055 |
.el .IP "$bool = \f(CW$term\fR\->is_longer ($row_number)" 4 |
| 1056 |
.IX Item "$bool = $term->is_longer ($row_number)" |
| 1057 |
Returns true if the row is part of a multiple-row logical \*(L"line\*(R" (i.e. |
| 1058 |
joined with the following row), which means all characters are in use |
| 1059 |
and it is continued on the next row (and possibly a continuation of the |
| 1060 |
previous row(s)). |
| 1061 |
.ie n .IP "$line = $term\->line ($row_number)" 4 |
| 1062 |
.el .IP "$line = \f(CW$term\fR\->line ($row_number)" 4 |
| 1063 |
.IX Item "$line = $term->line ($row_number)" |
| 1064 |
Create and return a new \f(CW\*(C`urxvt::line\*(C'\fR object that stores information |
| 1065 |
about the logical line that row \f(CW$row_number\fR is part of. It supports the |
| 1066 |
following methods: |
| 1067 |
.RS 4 |
| 1068 |
.ie n .IP "$text = $line\->t ([$new_text])" 4 |
| 1069 |
.el .IP "$text = \f(CW$line\fR\->t ([$new_text])" 4 |
| 1070 |
.IX Item "$text = $line->t ([$new_text])" |
| 1071 |
Returns or replaces the full text of the line, similar to \f(CW\*(C`ROW_t\*(C'\fR |
| 1072 |
.ie n .IP "$rend = $line\->r ([$new_rend])" 4 |
| 1073 |
.el .IP "$rend = \f(CW$line\fR\->r ([$new_rend])" 4 |
| 1074 |
.IX Item "$rend = $line->r ([$new_rend])" |
| 1075 |
Returns or replaces the full rendition array of the line, similar to \f(CW\*(C`ROW_r\*(C'\fR |
| 1076 |
.ie n .IP "$length = $line\->l" 4 |
| 1077 |
.el .IP "$length = \f(CW$line\fR\->l" 4 |
| 1078 |
.IX Item "$length = $line->l" |
| 1079 |
Returns the length of the line in cells, similar to \f(CW\*(C`ROW_l\*(C'\fR. |
| 1080 |
.ie n .IP "$rownum = $line\->beg" 4 |
| 1081 |
.el .IP "$rownum = \f(CW$line\fR\->beg" 4 |
| 1082 |
.IX Item "$rownum = $line->beg" |
| 1083 |
.PD 0 |
| 1084 |
.ie n .IP "$rownum = $line\->end" 4 |
| 1085 |
.el .IP "$rownum = \f(CW$line\fR\->end" 4 |
| 1086 |
.IX Item "$rownum = $line->end" |
| 1087 |
.PD |
| 1088 |
Return the row number of the first/last row of the line, respectively. |
| 1089 |
.ie n .IP "$offset = $line\fR\->offset_of ($row, \f(CW$col)" 4 |
| 1090 |
.el .IP "$offset = \f(CW$line\fR\->offset_of ($row, \f(CW$col\fR)" 4 |
| 1091 |
.IX Item "$offset = $line->offset_of ($row, $col)" |
| 1092 |
Returns the character offset of the given row|col pair within the logical |
| 1093 |
line. Works for rows outside the line, too, and returns corresponding |
| 1094 |
offsets outside the string. |
| 1095 |
.ie n .IP "($row, $col\fR) = \f(CW$line\->coord_of ($offset)" 4 |
| 1096 |
.el .IP "($row, \f(CW$col\fR) = \f(CW$line\fR\->coord_of ($offset)" 4 |
| 1097 |
.IX Item "($row, $col) = $line->coord_of ($offset)" |
| 1098 |
Translates a string offset into terminal coordinates again. |
| 1099 |
.RE |
| 1100 |
.RS 4 |
| 1101 |
.RE |
| 1102 |
.ie n .IP "$text = $term\fR\->special_encode \f(CW$string" 4 |
| 1103 |
.el .IP "$text = \f(CW$term\fR\->special_encode \f(CW$string\fR" 4 |
| 1104 |
.IX Item "$text = $term->special_encode $string" |
| 1105 |
Converts a perl string into the special encoding used by rxvt\-unicode, |
| 1106 |
where one character corresponds to one screen cell. See |
| 1107 |
\&\f(CW\*(C`$term\->ROW_t\*(C'\fR for details. |
| 1108 |
.ie n .IP "$string = $term\fR\->special_decode \f(CW$text" 4 |
| 1109 |
.el .IP "$string = \f(CW$term\fR\->special_decode \f(CW$text\fR" 4 |
| 1110 |
.IX Item "$string = $term->special_decode $text" |
| 1111 |
Converts rxvt-unicodes text reprsentation into a perl string. See |
| 1112 |
\&\f(CW\*(C`$term\->ROW_t\*(C'\fR for details. |
| 1113 |
.ie n .IP "$success = $term\fR\->grab_button ($button, \f(CW$modifiermask)" 4 |
| 1114 |
.el .IP "$success = \f(CW$term\fR\->grab_button ($button, \f(CW$modifiermask\fR)" 4 |
| 1115 |
.IX Item "$success = $term->grab_button ($button, $modifiermask)" |
| 1116 |
Registers a synchronous button grab. See the XGrabButton manpage. |
| 1117 |
.ie n .IP "$success = $term\fR\->grab ($eventtime[, \f(CW$sync])" 4 |
| 1118 |
.el .IP "$success = \f(CW$term\fR\->grab ($eventtime[, \f(CW$sync\fR])" 4 |
| 1119 |
.IX Item "$success = $term->grab ($eventtime[, $sync])" |
| 1120 |
Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
| 1121 |
synchronous (\f(CW$sync\fR is true). Also remembers the grab timestampe. |
| 1122 |
.IP "$term\->allow_events_async" 4 |
| 1123 |
.IX Item "$term->allow_events_async" |
| 1124 |
Calls XAllowEvents with AsyncBoth for the most recent grab. |
| 1125 |
.IP "$term\->allow_events_sync" 4 |
| 1126 |
.IX Item "$term->allow_events_sync" |
| 1127 |
Calls XAllowEvents with SyncBoth for the most recent grab. |
| 1128 |
.IP "$term\->allow_events_replay" 4 |
| 1129 |
.IX Item "$term->allow_events_replay" |
| 1130 |
Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most |
| 1131 |
recent grab. |
| 1132 |
.IP "$term\->ungrab" 4 |
| 1133 |
.IX Item "$term->ungrab" |
| 1134 |
Calls XUngrab for the most recent grab. Is called automatically on |
| 1135 |
evaluation errors, as it is better to lose the grab in the error case as |
| 1136 |
the session. |
| 1137 |
.ie n .Sh "The ""urxvt::popup"" Class" |
| 1138 |
.el .Sh "The \f(CWurxvt::popup\fP Class" |
| 1139 |
.IX Subsection "The urxvt::popup Class" |
| 1140 |
.IP "$popup\->add_title ($title)" 4 |
| 1141 |
.IX Item "$popup->add_title ($title)" |
| 1142 |
Adds a non-clickable title to the popup. |
| 1143 |
.IP "$popup\->add_separator ([$sepchr])" 4 |
| 1144 |
.IX Item "$popup->add_separator ([$sepchr])" |
| 1145 |
Creates a separator, optionally using the character given as \f(CW$sepchr\fR. |
| 1146 |
.ie n .IP "$popup\->add_button ($text, $cb)" 4 |
| 1147 |
.el .IP "$popup\->add_button ($text, \f(CW$cb\fR)" 4 |
| 1148 |
.IX Item "$popup->add_button ($text, $cb)" |
| 1149 |
Adds a clickable button to the popup. \f(CW$cb\fR is called whenever it is |
| 1150 |
selected. |
| 1151 |
.ie n .IP "$popup\->add_toggle ($text, $cb\fR, \f(CW$initial_value)" 4 |
| 1152 |
.el .IP "$popup\->add_toggle ($text, \f(CW$cb\fR, \f(CW$initial_value\fR)" 4 |
| 1153 |
.IX Item "$popup->add_toggle ($text, $cb, $initial_value)" |
| 1154 |
Adds a toggle/checkbox item to the popup. Teh callback gets called |
| 1155 |
whenever it gets toggled, with a boolean indicating its value as its first |
| 1156 |
argument. |
| 1157 |
.IP "$popup\->show" 4 |
| 1158 |
.IX Item "$popup->show" |
| 1159 |
Displays the popup (which is initially hidden). |
| 1160 |
.ie n .Sh "The ""urxvt::timer"" Class" |
| 1161 |
.el .Sh "The \f(CWurxvt::timer\fP Class" |
| 1162 |
.IX Subsection "The urxvt::timer Class" |
| 1163 |
This class implements timer watchers/events. Time is represented as a |
| 1164 |
fractional number of seconds since the epoch. Example: |
| 1165 |
.PP |
| 1166 |
.Vb 8 |
| 1167 |
\& $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0); |
| 1168 |
\& $term->{timer} = urxvt::timer |
| 1169 |
\& ->new |
| 1170 |
\& ->interval (1) |
| 1171 |
\& ->cb (sub { |
| 1172 |
\& $term->{overlay}->set (0, 0, |
| 1173 |
\& sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
| 1174 |
\& }); |
| 1175 |
.Ve |
| 1176 |
.IP "$timer = new urxvt::timer" 4 |
| 1177 |
.IX Item "$timer = new urxvt::timer" |
| 1178 |
Create a new timer object in started state. It is scheduled to fire |
| 1179 |
immediately. |
| 1180 |
.ie n .IP "$timer = $timer\fR\->cb (sub { my ($timer) = \f(CW@_; ... })" 4 |
| 1181 |
.el .IP "$timer = \f(CW$timer\fR\->cb (sub { my ($timer) = \f(CW@_\fR; ... })" 4 |
| 1182 |
.IX Item "$timer = $timer->cb (sub { my ($timer) = @_; ... })" |
| 1183 |
Set the callback to be called when the timer triggers. |
| 1184 |
.ie n .IP "$tstamp = $timer\->at" 4 |
| 1185 |
.el .IP "$tstamp = \f(CW$timer\fR\->at" 4 |
| 1186 |
.IX Item "$tstamp = $timer->at" |
| 1187 |
Return the time this watcher will fire next. |
| 1188 |
.ie n .IP "$timer = $timer\->set ($tstamp)" 4 |
| 1189 |
.el .IP "$timer = \f(CW$timer\fR\->set ($tstamp)" 4 |
| 1190 |
.IX Item "$timer = $timer->set ($tstamp)" |
| 1191 |
Set the time the event is generated to \f(CW$tstamp\fR. |
| 1192 |
.ie n .IP "$timer = $timer\->interval ($interval)" 4 |
| 1193 |
.el .IP "$timer = \f(CW$timer\fR\->interval ($interval)" 4 |
| 1194 |
.IX Item "$timer = $timer->interval ($interval)" |
| 1195 |
Normally (and when \f(CW$interval\fR is \f(CW0\fR), the timer will automatically |
| 1196 |
stop after it has fired once. If \f(CW$interval\fR is non\-zero, then the timer |
| 1197 |
is automatically rescheduled at the given intervals. |
| 1198 |
.ie n .IP "$timer = $timer\->start" 4 |
| 1199 |
.el .IP "$timer = \f(CW$timer\fR\->start" 4 |
| 1200 |
.IX Item "$timer = $timer->start" |
| 1201 |
Start the timer. |
| 1202 |
.ie n .IP "$timer = $timer\->start ($tstamp)" 4 |
| 1203 |
.el .IP "$timer = \f(CW$timer\fR\->start ($tstamp)" 4 |
| 1204 |
.IX Item "$timer = $timer->start ($tstamp)" |
| 1205 |
Set the event trigger time to \f(CW$tstamp\fR and start the timer. |
| 1206 |
.ie n .IP "$timer = $timer\->stop" 4 |
| 1207 |
.el .IP "$timer = \f(CW$timer\fR\->stop" 4 |
| 1208 |
.IX Item "$timer = $timer->stop" |
| 1209 |
Stop the timer. |
| 1210 |
.ie n .Sh "The ""urxvt::iow"" Class" |
| 1211 |
.el .Sh "The \f(CWurxvt::iow\fP Class" |
| 1212 |
.IX Subsection "The urxvt::iow Class" |
| 1213 |
This class implements io watchers/events. Example: |
| 1214 |
.PP |
| 1215 |
.Vb 12 |
| 1216 |
\& $term->{socket} = ... |
| 1217 |
\& $term->{iow} = urxvt::iow |
| 1218 |
\& ->new |
| 1219 |
\& ->fd (fileno $term->{socket}) |
| 1220 |
\& ->events (urxvt::EVENT_READ) |
| 1221 |
\& ->start |
| 1222 |
\& ->cb (sub { |
| 1223 |
\& my ($iow, $revents) = @_; |
| 1224 |
\& # $revents must be 1 here, no need to check |
| 1225 |
\& sysread $term->{socket}, my $buf, 8192 |
| 1226 |
\& or end-of-file; |
| 1227 |
\& }); |
| 1228 |
.Ve |
| 1229 |
.IP "$iow = new urxvt::iow" 4 |
| 1230 |
.IX Item "$iow = new urxvt::iow" |
| 1231 |
Create a new io watcher object in stopped state. |
| 1232 |
.ie n .IP "$iow = $iow\fR\->cb (sub { my ($iow, \f(CW$reventmask\fR) = \f(CW@_; ... })" 4 |
| 1233 |
.el .IP "$iow = \f(CW$iow\fR\->cb (sub { my ($iow, \f(CW$reventmask\fR) = \f(CW@_\fR; ... })" 4 |
| 1234 |
.IX Item "$iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... })" |
| 1235 |
Set the callback to be called when io events are triggered. \f(CW$reventmask\fR |
| 1236 |
is a bitset as described in the \f(CW\*(C`events\*(C'\fR method. |
| 1237 |
.ie n .IP "$iow = $iow\->fd ($fd)" 4 |
| 1238 |
.el .IP "$iow = \f(CW$iow\fR\->fd ($fd)" 4 |
| 1239 |
.IX Item "$iow = $iow->fd ($fd)" |
| 1240 |
Set the filedescriptor (not handle) to watch. |
| 1241 |
.ie n .IP "$iow = $iow\->events ($eventmask)" 4 |
| 1242 |
.el .IP "$iow = \f(CW$iow\fR\->events ($eventmask)" 4 |
| 1243 |
.IX Item "$iow = $iow->events ($eventmask)" |
| 1244 |
Set the event mask to watch. The only allowed values are |
| 1245 |
\&\f(CW\*(C`urxvt::EVENT_READ\*(C'\fR and \f(CW\*(C`urxvt::EVENT_WRITE\*(C'\fR, which might be ORed |
| 1246 |
together, or \f(CW\*(C`urxvt::EVENT_NONE\*(C'\fR. |
| 1247 |
.ie n .IP "$iow = $iow\->start" 4 |
| 1248 |
.el .IP "$iow = \f(CW$iow\fR\->start" 4 |
| 1249 |
.IX Item "$iow = $iow->start" |
| 1250 |
Start watching for requested events on the given handle. |
| 1251 |
.ie n .IP "$iow = $iow\->stop" 4 |
| 1252 |
.el .IP "$iow = \f(CW$iow\fR\->stop" 4 |
| 1253 |
.IX Item "$iow = $iow->stop" |
| 1254 |
Stop watching for events on the given filehandle. |
| 1255 |
.SH "ENVIRONMENT" |
| 1256 |
.IX Header "ENVIRONMENT" |
| 1257 |
.Sh "\s-1URXVT_PERL_VERBOSITY\s0" |
| 1258 |
.IX Subsection "URXVT_PERL_VERBOSITY" |
| 1259 |
This variable controls the verbosity level of the perl extension. Higher |
| 1260 |
numbers indicate more verbose output. |
| 1261 |
.IP "== 0 \- fatal messages" 4 |
| 1262 |
.IX Item "== 0 - fatal messages" |
| 1263 |
.PD 0 |
| 1264 |
.IP ">= 3 \- script loading and management" 4 |
| 1265 |
.IX Item ">= 3 - script loading and management" |
| 1266 |
.IP ">=10 \- all called hooks" 4 |
| 1267 |
.IX Item ">=10 - all called hooks" |
| 1268 |
.IP ">=11 \- hook reutrn values" 4 |
| 1269 |
.IX Item ">=11 - hook reutrn values" |
| 1270 |
.PD |
| 1271 |
.SH "AUTHOR" |
| 1272 |
.IX Header "AUTHOR" |
| 1273 |
.Vb 2 |
| 1274 |
\& Marc Lehmann <pcg@goof.com> |
| 1275 |
\& http://software.schmorp.de/pkg/rxvt-unicode |
| 1276 |
.Ve |
