1 |
root |
1.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-02" "6.2" "RXVT-UNICODE" |
133 |
|
|
.SH "NAME" |
134 |
|
|
rxvtperl \- rxvt\-unicode's embedded perl interpreter |
135 |
|
|
.SH "SYNOPSIS" |
136 |
|
|
.IX Header "SYNOPSIS" |
137 |
|
|
* Put your scripts into \fI@@RXVT_LIBDIR@@/urxvt/perl\-ext/\fR, they will be loaded automatically. |
138 |
|
|
.PP |
139 |
|
|
* Scripts are evaluated in a 'use strict' and 'use utf8' environment, and |
140 |
|
|
thus must be encoded as \s-1UTF\-8\s0. |
141 |
|
|
.PP |
142 |
|
|
.Vb 4 |
143 |
|
|
\& sub on_sel_grab { |
144 |
|
|
\& warn "you selected ", $_[0]->selection; |
145 |
|
|
\& () |
146 |
|
|
\& } |
147 |
|
|
.Ve |
148 |
|
|
.PP |
149 |
|
|
.Vb 1 |
150 |
|
|
\& 1 |
151 |
|
|
.Ve |
152 |
|
|
.SH "DESCRIPTION" |
153 |
|
|
.IX Header "DESCRIPTION" |
154 |
root |
1.4 |
Everytime a terminal object gets created, scripts specified via the |
155 |
|
|
\&\f(CW\*(C`perl\*(C'\fR resource are associated with it. |
156 |
root |
1.3 |
.PP |
157 |
|
|
Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where |
158 |
root |
1.4 |
scripts will be shared (But not enabled) for all terminals. |
159 |
root |
1.3 |
.Sh "General \s-1API\s0 Considerations" |
160 |
|
|
.IX Subsection "General API Considerations" |
161 |
|
|
All objects (such as terminals, time watchers etc.) are typical |
162 |
|
|
reference-to-hash objects. The hash can be used to store anything you |
163 |
|
|
like. All members starting with an underscore (such as \f(CW\*(C`_ptr\*(C'\fR or |
164 |
|
|
\&\f(CW\*(C`_hook\*(C'\fR) are reserved for internal uses and must not be accessed or |
165 |
|
|
modified). |
166 |
|
|
.PP |
167 |
|
|
When objects are destroyed on the \*(C+ side, the perl object hashes are |
168 |
|
|
emptied, so its best to store related objects such as time watchers and |
169 |
|
|
the like inside the terminal object so they get destroyed as soon as the |
170 |
|
|
terminal is destroyed. |
171 |
root |
1.1 |
.Sh "Hooks" |
172 |
|
|
.IX Subsection "Hooks" |
173 |
|
|
The following subroutines can be declared in loaded scripts, and will be called |
174 |
|
|
whenever the relevant event happens. |
175 |
|
|
.PP |
176 |
|
|
All of them must return a boolean value. If it is true, then the event |
177 |
|
|
counts as being \fIconsumed\fR, and the invocation of other hooks is skipped, |
178 |
|
|
and the relevant action might not be carried out by the \*(C+ code. |
179 |
|
|
.PP |
180 |
|
|
When in doubt, return a false value (preferably \f(CW\*(C`()\*(C'\fR). |
181 |
|
|
.ie n .IP "on_init $term" 4 |
182 |
|
|
.el .IP "on_init \f(CW$term\fR" 4 |
183 |
|
|
.IX Item "on_init $term" |
184 |
|
|
Called after a new terminal object has been initialized, but before |
185 |
|
|
windows are created or the command gets run. |
186 |
|
|
.ie n .IP "on_reset $term" 4 |
187 |
|
|
.el .IP "on_reset \f(CW$term\fR" 4 |
188 |
|
|
.IX Item "on_reset $term" |
189 |
|
|
Called after the screen is \*(L"reset\*(R" for any reason, such as resizing or |
190 |
|
|
control sequences. Here is where you can react on changes to size-related |
191 |
|
|
variables. |
192 |
|
|
.ie n .IP "on_start $term" 4 |
193 |
|
|
.el .IP "on_start \f(CW$term\fR" 4 |
194 |
|
|
.IX Item "on_start $term" |
195 |
|
|
Called at the very end of initialisation of a new terminal, just before |
196 |
|
|
returning to the mainloop. |
197 |
|
|
.ie n .IP "on_sel_make $term\fR, \f(CW$eventtime" 4 |
198 |
|
|
.el .IP "on_sel_make \f(CW$term\fR, \f(CW$eventtime\fR" 4 |
199 |
|
|
.IX Item "on_sel_make $term, $eventtime" |
200 |
|
|
Called whenever a selection has been made by the user, but before the |
201 |
|
|
selection text is copied, so changes to the beginning, end or type of the |
202 |
|
|
selection will be honored. |
203 |
|
|
.Sp |
204 |
|
|
Returning a true value aborts selection making by urxvt, in which case you |
205 |
|
|
have to make a selection yourself by calling \f(CW\*(C`$term\->selection_grab\*(C'\fR. |
206 |
|
|
.ie n .IP "on_sel_grab $term\fR, \f(CW$eventtime" 4 |
207 |
|
|
.el .IP "on_sel_grab \f(CW$term\fR, \f(CW$eventtime\fR" 4 |
208 |
|
|
.IX Item "on_sel_grab $term, $eventtime" |
209 |
|
|
Called whenever a selection has been copied, but before the selection is |
210 |
|
|
requested from the server. The selection text can be queried and changed |
211 |
|
|
by calling \f(CW\*(C`$term\->selection\*(C'\fR. |
212 |
|
|
.Sp |
213 |
|
|
Returning a true value aborts selection grabbing. It will still be hilighted. |
214 |
|
|
.ie n .IP "on_focus_in $term" 4 |
215 |
|
|
.el .IP "on_focus_in \f(CW$term\fR" 4 |
216 |
|
|
.IX Item "on_focus_in $term" |
217 |
|
|
Called whenever the window gets the keyboard focus, before urxvt does |
218 |
|
|
focus in processing. |
219 |
|
|
.ie n .IP "on_focus_out $term" 4 |
220 |
|
|
.el .IP "on_focus_out \f(CW$term\fR" 4 |
221 |
|
|
.IX Item "on_focus_out $term" |
222 |
|
|
Called wheneever the window loses keyboard focus, before urxvt does focus |
223 |
|
|
out processing. |
224 |
|
|
.ie n .IP "on_view_change $term\fR, \f(CW$offset" 4 |
225 |
|
|
.el .IP "on_view_change \f(CW$term\fR, \f(CW$offset\fR" 4 |
226 |
|
|
.IX Item "on_view_change $term, $offset" |
227 |
|
|
Called whenever the view offset changes, i..e the user or program |
228 |
|
|
scrolls. Offset \f(CW0\fR means display the normal terminal, positive values |
229 |
|
|
show this many lines of scrollback. |
230 |
|
|
.ie n .IP "on_scroll_back $term\fR, \f(CW$lines\fR, \f(CW$saved" 4 |
231 |
|
|
.el .IP "on_scroll_back \f(CW$term\fR, \f(CW$lines\fR, \f(CW$saved\fR" 4 |
232 |
|
|
.IX Item "on_scroll_back $term, $lines, $saved" |
233 |
|
|
Called whenever lines scroll out of the terminal area into the scrollback |
234 |
|
|
buffer. \f(CW$lines\fR is the number of lines scrolled out and may be larger |
235 |
|
|
than the scroll back buffer or the terminal. |
236 |
|
|
.Sp |
237 |
|
|
It is called before lines are scrolled out (so rows 0 .. min ($lines \- 1, |
238 |
|
|
\&\f(CW$nrow\fR \- 1) represent the lines to be scrolled out). \f(CW$saved\fR is the total |
239 |
|
|
number of lines that will be in the scrollback buffer. |
240 |
|
|
.ie n .IP "on_tty_activity $term *NYI*" 4 |
241 |
|
|
.el .IP "on_tty_activity \f(CW$term\fR *NYI*" 4 |
242 |
|
|
.IX Item "on_tty_activity $term *NYI*" |
243 |
|
|
Called whenever the program(s) running in the urxvt window send output. |
244 |
|
|
.ie n .IP "on_refresh_begin $term" 4 |
245 |
|
|
.el .IP "on_refresh_begin \f(CW$term\fR" 4 |
246 |
|
|
.IX Item "on_refresh_begin $term" |
247 |
|
|
Called just before the screen gets redrawn. Can be used for overlay |
248 |
|
|
or similar effects by modify terminal contents in refresh_begin, and |
249 |
|
|
restoring them in refresh_end. The built-in overlay and selection display |
250 |
|
|
code is run after this hook, and takes precedence. |
251 |
|
|
.ie n .IP "on_refresh_end $term" 4 |
252 |
|
|
.el .IP "on_refresh_end \f(CW$term\fR" 4 |
253 |
|
|
.IX Item "on_refresh_end $term" |
254 |
|
|
Called just after the screen gets redrawn. See \f(CW\*(C`on_refresh_begin\*(C'\fR. |
255 |
|
|
.ie n .Sh "Functions in the ""urxvt"" Package" |
256 |
|
|
.el .Sh "Functions in the \f(CWurxvt\fP Package" |
257 |
|
|
.IX Subsection "Functions in the urxvt Package" |
258 |
|
|
.ie n .IP "urxvt::fatal $errormessage" 4 |
259 |
|
|
.el .IP "urxvt::fatal \f(CW$errormessage\fR" 4 |
260 |
|
|
.IX Item "urxvt::fatal $errormessage" |
261 |
|
|
Fatally aborts execution with the given error message. Avoid at all |
262 |
|
|
costs! The only time this is acceptable is when the terminal process |
263 |
|
|
starts up. |
264 |
|
|
.ie n .IP "urxvt::warn $string" 4 |
265 |
|
|
.el .IP "urxvt::warn \f(CW$string\fR" 4 |
266 |
|
|
.IX Item "urxvt::warn $string" |
267 |
root |
1.3 |
Calls \f(CW\*(C`rxvt_warn\*(C'\fR with the given string which should not include a |
268 |
root |
1.1 |
newline. The module also overwrites the \f(CW\*(C`warn\*(C'\fR builtin with a function |
269 |
|
|
that calls this function. |
270 |
|
|
.Sp |
271 |
|
|
Using this function has the advantage that its output ends up in the |
272 |
|
|
correct place, e.g. on stderr of the connecting urxvtc client. |
273 |
|
|
.IP "$time = urxvt::NOW" 4 |
274 |
|
|
.IX Item "$time = urxvt::NOW" |
275 |
|
|
Returns the \*(L"current time\*(R" (as per the event loop). |
276 |
|
|
.ie n .Sh "The ""urxvt::term"" Class" |
277 |
|
|
.el .Sh "The \f(CWurxvt::term\fP Class" |
278 |
|
|
.IX Subsection "The urxvt::term Class" |
279 |
root |
1.2 |
.ie n .IP "$value = $term\fR\->resource ($name[, \f(CW$newval])" 4 |
280 |
|
|
.el .IP "$value = \f(CW$term\fR\->resource ($name[, \f(CW$newval\fR])" 4 |
281 |
|
|
.IX Item "$value = $term->resource ($name[, $newval])" |
282 |
|
|
Returns the current resource value associated with a given name and |
283 |
|
|
optionally sets a new value. Setting values is most useful in the \f(CW\*(C`init\*(C'\fR |
284 |
|
|
hook. Unset resources are returned and accepted as \f(CW\*(C`undef\*(C'\fR. |
285 |
|
|
.Sp |
286 |
|
|
The new value must be properly encoded to a suitable character encoding |
287 |
|
|
before passing it to this method. Similarly, the returned value may need |
288 |
|
|
to be converted from the used encoding to text. |
289 |
|
|
.Sp |
290 |
|
|
Resource names are as defined in \fIsrc/rsinc.h\fR. Colours can be specified |
291 |
|
|
as resource names of the form \f(CW\*(C`color+<index>\*(C'\fR, e.g. \f(CW\*(C`color+5\*(C'\fR. (will |
292 |
|
|
likely change). |
293 |
|
|
.Sp |
294 |
|
|
Please note that resource strings will currently only be freed when the |
295 |
|
|
terminal is destroyed, so changing options frequently will eat memory. |
296 |
|
|
.Sp |
297 |
|
|
Here is a a likely non-exhaustive list of resource names, not all of which |
298 |
|
|
are supported in every build, please see the source to see the actual |
299 |
|
|
list: |
300 |
|
|
.Sp |
301 |
|
|
.Vb 12 |
302 |
|
|
\& answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
303 |
|
|
\& borderLess color cursorBlink cursorUnderline cutchars delete_key |
304 |
|
|
\& display_name embed ext_bwidth fade font geometry hold iconName |
305 |
|
|
\& imFont imLocale inputMethod insecure int_bwidth intensityStyles |
306 |
root |
1.4 |
\& italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
307 |
|
|
\& mouseWheelScrollPage name pastableTabs path perl_eval perl_ext |
308 |
root |
1.3 |
\& perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
309 |
|
|
\& reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
310 |
|
|
\& scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
311 |
|
|
\& scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
312 |
|
|
\& shade term_name title transparent transparent_all tripleclickwords |
313 |
|
|
\& utmpInhibit visualBell |
314 |
root |
1.2 |
.Ve |
315 |
root |
1.1 |
.ie n .IP "($row, $col\fR) = \f(CW$term\fR\->selection_mark ([$row, \f(CW$col])" 4 |
316 |
|
|
.el .IP "($row, \f(CW$col\fR) = \f(CW$term\fR\->selection_mark ([$row, \f(CW$col\fR])" 4 |
317 |
|
|
.IX Item "($row, $col) = $term->selection_mark ([$row, $col])" |
318 |
|
|
.PD 0 |
319 |
|
|
.ie n .IP "($row, $col\fR) = \f(CW$term\fR\->selection_beg ([$row, \f(CW$col])" 4 |
320 |
|
|
.el .IP "($row, \f(CW$col\fR) = \f(CW$term\fR\->selection_beg ([$row, \f(CW$col\fR])" 4 |
321 |
|
|
.IX Item "($row, $col) = $term->selection_beg ([$row, $col])" |
322 |
|
|
.ie n .IP "($row, $col\fR) = \f(CW$term\fR\->selection_end ([$row, \f(CW$col])" 4 |
323 |
|
|
.el .IP "($row, \f(CW$col\fR) = \f(CW$term\fR\->selection_end ([$row, \f(CW$col\fR])" 4 |
324 |
|
|
.IX Item "($row, $col) = $term->selection_end ([$row, $col])" |
325 |
|
|
.PD |
326 |
|
|
Return the current values of the selection mark, begin or end positions, |
327 |
|
|
and optionally set them to new values. |
328 |
|
|
.ie n .IP "$success = $term\->selection_grab ($eventtime)" 4 |
329 |
|
|
.el .IP "$success = \f(CW$term\fR\->selection_grab ($eventtime)" 4 |
330 |
|
|
.IX Item "$success = $term->selection_grab ($eventtime)" |
331 |
|
|
Try to request the primary selection from the server (for example, as set |
332 |
|
|
by the next method). |
333 |
|
|
.ie n .IP "$oldtext = $term\->selection ([$newtext])" 4 |
334 |
|
|
.el .IP "$oldtext = \f(CW$term\fR\->selection ([$newtext])" 4 |
335 |
|
|
.IX Item "$oldtext = $term->selection ([$newtext])" |
336 |
|
|
Return the current selection text and optionally replace it by \f(CW$newtext\fR. |
337 |
|
|
.ie n .IP "$term\->scr_overlay ($x, $y\fR, \f(CW$text)" 4 |
338 |
|
|
.el .IP "$term\->scr_overlay ($x, \f(CW$y\fR, \f(CW$text\fR)" 4 |
339 |
|
|
.IX Item "$term->scr_overlay ($x, $y, $text)" |
340 |
|
|
Create a simple multi-line overlay box. See the next method for details. |
341 |
|
|
.ie n .IP "$term\->scr_overlay_new ($x, $y\fR, \f(CW$width\fR, \f(CW$height)" 4 |
342 |
|
|
.el .IP "$term\->scr_overlay_new ($x, \f(CW$y\fR, \f(CW$width\fR, \f(CW$height\fR)" 4 |
343 |
|
|
.IX Item "$term->scr_overlay_new ($x, $y, $width, $height)" |
344 |
|
|
Create a new (empty) overlay at the given position with the given |
345 |
|
|
width/height. A border will be put around the box. If either \f(CW$x\fR or |
346 |
|
|
\&\f(CW$y\fR is negative, then this is counted from the right/bottom side, |
347 |
|
|
respectively. |
348 |
|
|
.IP "$term\->scr_overlay_off" 4 |
349 |
|
|
.IX Item "$term->scr_overlay_off" |
350 |
|
|
Switch the overlay off again. |
351 |
|
|
.ie n .IP "$term\->scr_overlay_set_char ($x, $y\fR, \f(CW$char\fR, \f(CW$rend = \s-1OVERLAY_RSTYLE\s0)" 4 |
352 |
|
|
.el .IP "$term\->scr_overlay_set_char ($x, \f(CW$y\fR, \f(CW$char\fR, \f(CW$rend\fR = \s-1OVERLAY_RSTYLE\s0)" 4 |
353 |
|
|
.IX Item "$term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE)" |
354 |
|
|
Put a single character (specified numerically) at the given overlay |
355 |
|
|
position. |
356 |
|
|
.ie n .IP "$term\->scr_overlay_set ($x, $y\fR, \f(CW$text)" 4 |
357 |
|
|
.el .IP "$term\->scr_overlay_set ($x, \f(CW$y\fR, \f(CW$text\fR)" 4 |
358 |
|
|
.IX Item "$term->scr_overlay_set ($x, $y, $text)" |
359 |
|
|
Write a string at the given position into the overlay. |
360 |
root |
1.3 |
.ie n .IP "$cellwidth = $term\fR\->strwidth \f(CW$string" 4 |
361 |
|
|
.el .IP "$cellwidth = \f(CW$term\fR\->strwidth \f(CW$string\fR" 4 |
362 |
|
|
.IX Item "$cellwidth = $term->strwidth $string" |
363 |
|
|
Returns the number of screen-cells this string would need. Correctly |
364 |
|
|
accounts for wide and combining characters. |
365 |
|
|
.ie n .IP "$octets = $term\fR\->locale_encode \f(CW$string" 4 |
366 |
|
|
.el .IP "$octets = \f(CW$term\fR\->locale_encode \f(CW$string\fR" 4 |
367 |
|
|
.IX Item "$octets = $term->locale_encode $string" |
368 |
|
|
Convert the given text string into the corresponding locale encoding. |
369 |
|
|
.ie n .IP "$string = $term\fR\->locale_decode \f(CW$octets" 4 |
370 |
|
|
.el .IP "$string = \f(CW$term\fR\->locale_decode \f(CW$octets\fR" 4 |
371 |
|
|
.IX Item "$string = $term->locale_decode $octets" |
372 |
|
|
Convert the given locale-encoded octets into a perl string. |
373 |
|
|
.IP "$term\->tt_write ($octets)" 4 |
374 |
|
|
.IX Item "$term->tt_write ($octets)" |
375 |
|
|
Write the octets given in \f(CW$data\fR to the tty (i.e. as program input). To |
376 |
|
|
pass characters instead of octets, you should convetr you strings first to |
377 |
|
|
the locale-specific encoding using \f(CW\*(C`$term\->locale_encode\*(C'\fR. |
378 |
root |
1.1 |
.ie n .Sh "The ""urxvt::timer"" Class" |
379 |
|
|
.el .Sh "The \f(CWurxvt::timer\fP Class" |
380 |
|
|
.IX Subsection "The urxvt::timer Class" |
381 |
|
|
This class implements timer watchers/events. Time is represented as a |
382 |
|
|
fractional number of seconds since the epoch. Example: |
383 |
|
|
.PP |
384 |
|
|
.Vb 11 |
385 |
|
|
\& # create a digital clock display in upper right corner |
386 |
|
|
\& $term->{timer} = urxvt::timer |
387 |
|
|
\& ->new |
388 |
|
|
\& ->start (urxvt::NOW) |
389 |
|
|
\& ->cb (sub { |
390 |
|
|
\& my ($timer) = @_; |
391 |
|
|
\& my $time = $timer->at; |
392 |
|
|
\& $timer->start ($time + 1); |
393 |
|
|
\& $self->scr_overlay (-1, 0, |
394 |
|
|
\& POSIX::strftime "%H:%M:%S", localtime $time); |
395 |
|
|
\& }); |
396 |
|
|
.Ve |
397 |
|
|
.IP "$timer = new urxvt::timer" 4 |
398 |
|
|
.IX Item "$timer = new urxvt::timer" |
399 |
|
|
Create a new timer object in stopped state. |
400 |
|
|
.ie n .IP "$timer = $timer\fR\->cb (sub { my ($timer) = \f(CW@_; ... })" 4 |
401 |
|
|
.el .IP "$timer = \f(CW$timer\fR\->cb (sub { my ($timer) = \f(CW@_\fR; ... })" 4 |
402 |
|
|
.IX Item "$timer = $timer->cb (sub { my ($timer) = @_; ... })" |
403 |
|
|
Set the callback to be called when the timer triggers. |
404 |
|
|
.ie n .IP "$tstamp = $timer\->at" 4 |
405 |
|
|
.el .IP "$tstamp = \f(CW$timer\fR\->at" 4 |
406 |
|
|
.IX Item "$tstamp = $timer->at" |
407 |
|
|
Return the time this watcher will fire next. |
408 |
|
|
.ie n .IP "$timer = $timer\->set ($tstamp)" 4 |
409 |
|
|
.el .IP "$timer = \f(CW$timer\fR\->set ($tstamp)" 4 |
410 |
|
|
.IX Item "$timer = $timer->set ($tstamp)" |
411 |
|
|
Set the time the event is generated to \f(CW$tstamp\fR. |
412 |
|
|
.ie n .IP "$timer = $timer\->start" 4 |
413 |
|
|
.el .IP "$timer = \f(CW$timer\fR\->start" 4 |
414 |
|
|
.IX Item "$timer = $timer->start" |
415 |
|
|
Start the timer. |
416 |
|
|
.ie n .IP "$timer = $timer\->start ($tstamp)" 4 |
417 |
|
|
.el .IP "$timer = \f(CW$timer\fR\->start ($tstamp)" 4 |
418 |
|
|
.IX Item "$timer = $timer->start ($tstamp)" |
419 |
|
|
Set the event trigger time to \f(CW$tstamp\fR and start the timer. |
420 |
|
|
.ie n .IP "$timer = $timer\->stop" 4 |
421 |
|
|
.el .IP "$timer = \f(CW$timer\fR\->stop" 4 |
422 |
|
|
.IX Item "$timer = $timer->stop" |
423 |
|
|
Stop the timer. |
424 |
|
|
.ie n .Sh "The ""urxvt::iow"" Class" |
425 |
|
|
.el .Sh "The \f(CWurxvt::iow\fP Class" |
426 |
|
|
.IX Subsection "The urxvt::iow Class" |
427 |
|
|
This class implements io watchers/events. Example: |
428 |
|
|
.PP |
429 |
|
|
.Vb 12 |
430 |
|
|
\& $term->{socket} = ... |
431 |
|
|
\& $term->{iow} = urxvt::iow |
432 |
|
|
\& ->new |
433 |
|
|
\& ->fd (fileno $term->{socket}) |
434 |
|
|
\& ->events (1) # wait for read data |
435 |
|
|
\& ->start |
436 |
|
|
\& ->cb (sub { |
437 |
|
|
\& my ($iow, $revents) = @_; |
438 |
|
|
\& # $revents must be 1 here, no need to check |
439 |
|
|
\& sysread $term->{socket}, my $buf, 8192 |
440 |
|
|
\& or end-of-file; |
441 |
|
|
\& }); |
442 |
|
|
.Ve |
443 |
|
|
.IP "$iow = new urxvt::iow" 4 |
444 |
|
|
.IX Item "$iow = new urxvt::iow" |
445 |
|
|
Create a new io watcher object in stopped state. |
446 |
|
|
.ie n .IP "$iow = $iow\fR\->cb (sub { my ($iow, \f(CW$reventmask\fR) = \f(CW@_; ... })" 4 |
447 |
|
|
.el .IP "$iow = \f(CW$iow\fR\->cb (sub { my ($iow, \f(CW$reventmask\fR) = \f(CW@_\fR; ... })" 4 |
448 |
|
|
.IX Item "$iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... })" |
449 |
|
|
Set the callback to be called when io events are triggered. \f(CW$reventmask\fR |
450 |
|
|
is a bitset as described in the \f(CW\*(C`events\*(C'\fR method. |
451 |
|
|
.ie n .IP "$iow = $iow\->fd ($fd)" 4 |
452 |
|
|
.el .IP "$iow = \f(CW$iow\fR\->fd ($fd)" 4 |
453 |
|
|
.IX Item "$iow = $iow->fd ($fd)" |
454 |
|
|
Set the filedescriptor (not handle) to watch. |
455 |
|
|
.ie n .IP "$iow = $iow\->events ($eventmask)" 4 |
456 |
|
|
.el .IP "$iow = \f(CW$iow\fR\->events ($eventmask)" 4 |
457 |
|
|
.IX Item "$iow = $iow->events ($eventmask)" |
458 |
|
|
Set the event mask to watch. Bit #0 (value \f(CW1\fR) enables watching for read |
459 |
|
|
data, Bit #1 (value \f(CW2\fR) enables watching for write data. |
460 |
|
|
.ie n .IP "$iow = $iow\->start" 4 |
461 |
|
|
.el .IP "$iow = \f(CW$iow\fR\->start" 4 |
462 |
|
|
.IX Item "$iow = $iow->start" |
463 |
|
|
Start watching for requested events on the given handle. |
464 |
|
|
.ie n .IP "$iow = $iow\->stop" 4 |
465 |
|
|
.el .IP "$iow = \f(CW$iow\fR\->stop" 4 |
466 |
|
|
.IX Item "$iow = $iow->stop" |
467 |
|
|
Stop watching for events on the given filehandle. |
468 |
root |
1.2 |
.SH "ENVIRONMENT" |
469 |
|
|
.IX Header "ENVIRONMENT" |
470 |
|
|
.Sh "\s-1URXVT_PERL_VERBOSITY\s0" |
471 |
|
|
.IX Subsection "URXVT_PERL_VERBOSITY" |
472 |
|
|
This variable controls the verbosity level of the perl extension. Higher |
473 |
|
|
numbers indicate more verbose output. |
474 |
|
|
.IP "0 \- only fatal messages" 4 |
475 |
|
|
.IX Item "0 - only fatal messages" |
476 |
|
|
.PD 0 |
477 |
|
|
.IP "3 \- script loading and management" 4 |
478 |
|
|
.IX Item "3 - script loading and management" |
479 |
|
|
.IP "10 \- all events received" 4 |
480 |
|
|
.IX Item "10 - all events received" |
481 |
|
|
.PD |
482 |
root |
1.1 |
.SH "AUTHOR" |
483 |
|
|
.IX Header "AUTHOR" |
484 |
|
|
.Vb 2 |
485 |
|
|
\& Marc Lehmann <pcg@goof.com> |
486 |
|
|
\& http://software.schmorp.de/pkg/rxvt-unicode |
487 |
|
|
.Ve |