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