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