… | |
… | |
13 | <ul> |
13 | <ul> |
14 | |
14 | |
15 | <li><a href="#name">NAME</a></li> |
15 | <li><a href="#name">NAME</a></li> |
16 | <li><a href="#synopsis">SYNOPSIS</a></li> |
16 | <li><a href="#synopsis">SYNOPSIS</a></li> |
17 | <li><a href="#description">DESCRIPTION</a></li> |
17 | <li><a href="#description">DESCRIPTION</a></li> |
|
|
18 | <li><a href="#prepackaged_extensions">PREPACKAGED EXTENSIONS</a></li> |
|
|
19 | <li><a href="#api_documentation">API DOCUMENTATION</a></li> |
18 | <ul> |
20 | <ul> |
19 | |
21 | |
20 | <li><a href="#general_api_considerations">General API Considerations</a></li> |
22 | <li><a href="#general_api_considerations">General API Considerations</a></li> |
|
|
23 | <li><a href="#extension_objects">Extension Objects</a></li> |
21 | <li><a href="#hooks">Hooks</a></li> |
24 | <li><a href="#hooks">Hooks</a></li> |
|
|
25 | <li><a href="#variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></li> |
22 | <li><a href="#functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></li> |
26 | <li><a href="#functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></li> |
|
|
27 | <li><a href="#rendition">RENDITION</a></li> |
|
|
28 | <li><a href="#the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></li> |
23 | <li><a href="#the_urxvt__term_class">The <code>urxvt::term</code> Class</a></li> |
29 | <li><a href="#the_urxvt__term_class">The <code>urxvt::term</code> Class</a></li> |
|
|
30 | <li><a href="#the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></li> |
24 | <li><a href="#the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></li> |
31 | <li><a href="#the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></li> |
25 | <li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li> |
32 | <li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li> |
|
|
33 | <li><a href="#the_urxvt__iw_class">The <code>urxvt::iw</code> Class</a></li> |
|
|
34 | <li><a href="#the_urxvt__pw_class">The <code>urxvt::pw</code> Class</a></li> |
26 | </ul> |
35 | </ul> |
27 | |
36 | |
28 | <li><a href="#environment">ENVIRONMENT</a></li> |
37 | <li><a href="#environment">ENVIRONMENT</a></li> |
29 | <ul> |
38 | <ul> |
30 | |
39 | |
… | |
… | |
36 | <!-- INDEX END --> |
45 | <!-- INDEX END --> |
37 | |
46 | |
38 | <hr /> |
47 | <hr /> |
39 | <p> |
48 | <p> |
40 | </p> |
49 | </p> |
|
|
50 | <hr /> |
41 | <h1><a name="name">NAME</a></h1> |
51 | <h1><a name="name">NAME</a></h1> |
42 | <p>rxvtperl - rxvt-unicode's embedded perl interpreter</p> |
52 | <p>rxvtperl - rxvt-unicode's embedded perl interpreter</p> |
43 | <p> |
53 | <p> |
44 | </p> |
54 | </p> |
45 | <hr /> |
55 | <hr /> |
… | |
… | |
57 | rxvt --perl-lib $HOME -pe grab_test</pre> |
67 | rxvt --perl-lib $HOME -pe grab_test</pre> |
58 | <p> |
68 | <p> |
59 | </p> |
69 | </p> |
60 | <hr /> |
70 | <hr /> |
61 | <h1><a name="description">DESCRIPTION</a></h1> |
71 | <h1><a name="description">DESCRIPTION</a></h1> |
62 | <p>Everytime a terminal object gets created, scripts specified via the |
72 | <p>Everytime a terminal object gets created, extension scripts specified via |
63 | <code>perl</code> resource are loaded and associated with it.</p> |
73 | the <code>perl</code> resource are loaded and associated with it.</p> |
64 | <p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and |
74 | <p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and |
65 | thus must be encoded as UTF-8.</p> |
75 | thus must be encoded as UTF-8.</p> |
66 | <p>Each script will only ever be loaded once, even in rxvtd, where |
76 | <p>Each script will only ever be loaded once, even in rxvtd, where |
67 | scripts will be shared (But not enabled) for all terminals.</p> |
77 | scripts will be shared (but not enabled) for all terminals.</p> |
|
|
78 | <p> |
|
|
79 | </p> |
|
|
80 | <hr /> |
|
|
81 | <h1><a name="prepackaged_extensions">PREPACKAGED EXTENSIONS</a></h1> |
|
|
82 | <p>This section describes the extensions delivered with this release. You can |
|
|
83 | find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> |
|
|
84 | <p>You can activate them like this:</p> |
|
|
85 | <pre> |
|
|
86 | rxvt -pe <extensionname></pre> |
|
|
87 | <p>Or by adding them to the resource for extensions loaded by default:</p> |
|
|
88 | <pre> |
|
|
89 | URxvt.perl-ext-common: default,automove-background,selection-autotransform</pre> |
|
|
90 | <dl> |
|
|
91 | <dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br /> |
|
|
92 | </dt> |
|
|
93 | <dd> |
|
|
94 | (More) intelligent selection. This extension tries to be more intelligent |
|
|
95 | when the user extends selections (double-click and further clicks). Right |
|
|
96 | now, it tries to select words, urls and complete shell-quoted |
|
|
97 | arguments, which is very convenient, too, if your <em>ls</em> supports |
|
|
98 | <code>--quoting-style=shell</code>. |
|
|
99 | </dd> |
|
|
100 | <dd> |
|
|
101 | <p>A double-click usually selects the word under the cursor, further clicks |
|
|
102 | will enlarge the selection.</p> |
|
|
103 | </dd> |
|
|
104 | <dd> |
|
|
105 | <p>The selection works by trying to match a number of regexes and displaying |
|
|
106 | them in increasing order of length. You can add your own regexes by |
|
|
107 | specifying resources of the form:</p> |
|
|
108 | </dd> |
|
|
109 | <dd> |
|
|
110 | <pre> |
|
|
111 | URxvt.selection.pattern-0: perl-regex |
|
|
112 | URxvt.selection.pattern-1: perl-regex |
|
|
113 | ...</pre> |
|
|
114 | </dd> |
|
|
115 | <dd> |
|
|
116 | <p>The index number (0, 1...) must not have any holes, and each regex must |
|
|
117 | contain at least one pair of capturing parentheses, which will be used for |
|
|
118 | the match. For example, the followign adds a regex that matches everything |
|
|
119 | between two vertical bars:</p> |
|
|
120 | </dd> |
|
|
121 | <dd> |
|
|
122 | <pre> |
|
|
123 | URxvt.selection.pattern-0: \\|([^|]+)\\|</pre> |
|
|
124 | </dd> |
|
|
125 | <dd> |
|
|
126 | <p>Another example: Programs I use often output ``absolute path: '' at the |
|
|
127 | beginning of a line when they process multiple files. The following |
|
|
128 | pattern matches the filename (note, there is a single space at the very |
|
|
129 | end):</p> |
|
|
130 | </dd> |
|
|
131 | <dd> |
|
|
132 | <pre> |
|
|
133 | URxvt.selection.pattern-0: ^(/[^:]+):\</pre> |
|
|
134 | </dd> |
|
|
135 | <dd> |
|
|
136 | <p>You can look at the source of the selection extension to see more |
|
|
137 | interesting uses, such as parsing a line from beginning to end.</p> |
|
|
138 | </dd> |
|
|
139 | <dd> |
|
|
140 | <p>This extension also offers following bindable keyboard commands:</p> |
|
|
141 | </dd> |
|
|
142 | <dl> |
|
|
143 | <dt><strong><a name="item_rot13">rot13</a></strong><br /> |
|
|
144 | </dt> |
|
|
145 | <dd> |
|
|
146 | Rot-13 the selection when activated. Used via keyboard trigger: |
|
|
147 | </dd> |
|
|
148 | <dd> |
|
|
149 | <pre> |
|
|
150 | URxvt.keysym.C-M-r: perl:selection:rot13</pre> |
|
|
151 | </dd> |
|
|
152 | <p></p></dl> |
|
|
153 | <dt><strong><a name="item_popup">option-popup (enabled by default)</a></strong><br /> |
|
|
154 | </dt> |
|
|
155 | <dd> |
|
|
156 | Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at |
|
|
157 | runtime. |
|
|
158 | </dd> |
|
|
159 | <p></p> |
|
|
160 | <dt><strong>selection-popup (enabled by default)</strong><br /> |
|
|
161 | </dt> |
|
|
162 | <dd> |
|
|
163 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
|
|
164 | text into various other formats/action (such as uri unescaping, perl |
|
|
165 | evaluation, web-browser starting etc.), depending on content. |
|
|
166 | </dd> |
|
|
167 | <dd> |
|
|
168 | <p>Other extensions can extend this popup menu by pushing a code reference |
|
|
169 | onto <code>@{ $term-</code>{selection_popup_hook} }>, that is called whenever the |
|
|
170 | popup is displayed.</p> |
|
|
171 | </dd> |
|
|
172 | <dd> |
|
|
173 | <p>It's sole argument is the popup menu, which can be modified. The selection |
|
|
174 | is in <code>$_</code>, which can be used to decide wether to add something or not. |
|
|
175 | It should either return nothing or a string and a code reference. The |
|
|
176 | string will be used as button text and the code reference will be called |
|
|
177 | when the button gets activated and should transform <code>$_</code>.</p> |
|
|
178 | </dd> |
|
|
179 | <dd> |
|
|
180 | <p>The following will add an entry <code>a to b</code> that transforms all <code>a</code>s in |
|
|
181 | the selection to <code>b</code>s, but only if the selection currently contains any |
|
|
182 | <code>a</code>s:</p> |
|
|
183 | </dd> |
|
|
184 | <dd> |
|
|
185 | <pre> |
|
|
186 | push @{ $self->{term}{selection_popup_hook} }, sub { |
|
|
187 | /a/ ? ("a to be" => sub { s/a/b/g } |
|
|
188 | : () |
|
|
189 | };</pre> |
|
|
190 | </dd> |
|
|
191 | <p></p> |
|
|
192 | <dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback<hotkey> (enabled by default)</a></strong><br /> |
|
|
193 | </dt> |
|
|
194 | <dd> |
|
|
195 | Adds regex search functionality to the scrollback buffer, triggered |
|
|
196 | by a hotkey (default: <code>M-s</code>). While in search mode, normal terminal |
|
|
197 | input/output is suspended and a regex is displayed at the bottom of the |
|
|
198 | screen. |
|
|
199 | </dd> |
|
|
200 | <dd> |
|
|
201 | <p>Inputting characters appends them to the regex and continues incremental |
|
|
202 | search. <code>BackSpace</code> removes a character from the regex, <code>Up</code> and <code>Down</code> |
|
|
203 | search upwards/downwards in the scrollback buffer, <code>End</code> jumps to the |
|
|
204 | bottom. <code>Escape</code> leaves search mode and returns to the point where search |
|
|
205 | was started, while <code>Enter</code> or <code>Return</code> stay at the current position and |
|
|
206 | additionally stores the first match in the current line into the primary |
|
|
207 | selection.</p> |
|
|
208 | </dd> |
|
|
209 | <p></p> |
|
|
210 | <dt><strong><a name="item_readline">readline (enabled by default)</a></strong><br /> |
|
|
211 | </dt> |
|
|
212 | <dd> |
|
|
213 | A support package that tries to make editing with readline easier. At the |
|
|
214 | moment, it reacts to clicking with the left mouse button by trying to |
|
|
215 | move the text cursor to this position. It does so by generating as many |
|
|
216 | cursor-left or cursor-right keypresses as required (the this only works |
|
|
217 | for programs that correctly support wide characters). |
|
|
218 | </dd> |
|
|
219 | <dd> |
|
|
220 | <p>To avoid too many false positives, this is only done when:</p> |
|
|
221 | </dd> |
|
|
222 | <dl> |
|
|
223 | <dt><strong><a name="item__2d_the_tty_is_in_icanon_state_2e">- the tty is in ICANON state.</a></strong><br /> |
|
|
224 | </dt> |
|
|
225 | <dt><strong><a name="item__2d_the_text_cursor_is_visible_2e">- the text cursor is visible.</a></strong><br /> |
|
|
226 | </dt> |
|
|
227 | <dt><strong><a name="item__2d_the_primary_screen_is_currently_being_displaye">- the primary screen is currently being displayed.</a></strong><br /> |
|
|
228 | </dt> |
|
|
229 | <dt><strong><a name="item_same">- the mouse is on the same (multi-row-) line as the text cursor.</a></strong><br /> |
|
|
230 | </dt> |
|
|
231 | </dl> |
|
|
232 | <p>The normal selection mechanism isn't disabled, so quick successive clicks |
|
|
233 | might interfere with selection creation in harmless ways.</p> |
|
|
234 | <dt><strong><a name="item_selection_2dautotransform">selection-autotransform</a></strong><br /> |
|
|
235 | </dt> |
|
|
236 | <dd> |
|
|
237 | This selection allows you to do automatic transforms on a selection |
|
|
238 | whenever a selection is made. |
|
|
239 | </dd> |
|
|
240 | <dd> |
|
|
241 | <p>It works by specifying perl snippets (most useful is a single <code>s///</code> |
|
|
242 | operator) that modify <code>$_</code> as resources:</p> |
|
|
243 | </dd> |
|
|
244 | <dd> |
|
|
245 | <pre> |
|
|
246 | URxvt.selection-autotransform.0: transform |
|
|
247 | URxvt.selection-autotransform.1: transform |
|
|
248 | ...</pre> |
|
|
249 | </dd> |
|
|
250 | <dd> |
|
|
251 | <p>For example, the following will transform selections of the form |
|
|
252 | <code>filename:number</code>, often seen in compiler messages, into <code>vi +$filename |
|
|
253 | $word</code>:</p> |
|
|
254 | </dd> |
|
|
255 | <dd> |
|
|
256 | <pre> |
|
|
257 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/</pre> |
|
|
258 | </dd> |
|
|
259 | <dd> |
|
|
260 | <p>And this example matches the same,but replaces it with vi-commands you can |
|
|
261 | paste directly into your (vi :) editor:</p> |
|
|
262 | </dd> |
|
|
263 | <dd> |
|
|
264 | <pre> |
|
|
265 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/</pre> |
|
|
266 | </dd> |
|
|
267 | <dd> |
|
|
268 | <p>Of course, this can be modified to suit your needs and your editor :)</p> |
|
|
269 | </dd> |
|
|
270 | <dd> |
|
|
271 | <p>To expand the example above to typical perl error messages (``XXX at |
|
|
272 | FILENAME line YYY.''), you need a slightly more elaborate solution:</p> |
|
|
273 | </dd> |
|
|
274 | <dd> |
|
|
275 | <pre> |
|
|
276 | URxvt.selection.pattern-0: ( at .*? line \\d+[,.]) |
|
|
277 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/</pre> |
|
|
278 | </dd> |
|
|
279 | <dd> |
|
|
280 | <p>The first line tells the selection code to treat the unchanging part of |
|
|
281 | every error message as a selection pattern, and the second line transforms |
|
|
282 | the message into vi commands to load the file.</p> |
|
|
283 | </dd> |
|
|
284 | <p></p> |
|
|
285 | <dt><strong><a name="item_tabbed">tabbed</a></strong><br /> |
|
|
286 | </dt> |
|
|
287 | <dd> |
|
|
288 | This transforms the terminal into a tabbar with additional terminals, that |
|
|
289 | is, it implements what is commonly refered to as ``tabbed terminal''. The topmost line |
|
|
290 | displays a ``[NEW]'' button, which, when clicked, will add a new tab, followed by one |
|
|
291 | button per tab. |
|
|
292 | </dd> |
|
|
293 | <dd> |
|
|
294 | <p>Clicking a button will activate that tab. Pressing <strong>Shift-Left</strong> and |
|
|
295 | <strong>Shift-Right</strong> will switch to the tab left or right of the current one, |
|
|
296 | while <strong>Shift-Down</strong> creates a new tab.</p> |
|
|
297 | </dd> |
|
|
298 | <dd> |
|
|
299 | <p>The tabbar itself can be configured similarly to a normal terminal, but |
|
|
300 | with a resource class of <code>URxvt.tabbed</code>. In addition, it supports the |
|
|
301 | following four resources (shown with defaults):</p> |
|
|
302 | </dd> |
|
|
303 | <dd> |
|
|
304 | <pre> |
|
|
305 | URxvt.tabbed.tabbar-fg: <colour-index, default 3> |
|
|
306 | URxvt.tabbed.tabbar-bg: <colour-index, default 0> |
|
|
307 | URxvt.tabbed.tab-fg: <colour-index, default 0> |
|
|
308 | URxvt.tabbed.tab-bg: <colour-index, default 1></pre> |
|
|
309 | </dd> |
|
|
310 | <dd> |
|
|
311 | <p>See <em>COLOR AND GRAPHICS</em> in the <code>rxvt(1)</code> manpage for valid |
|
|
312 | indices.</p> |
|
|
313 | </dd> |
|
|
314 | <p></p> |
|
|
315 | <dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> |
|
|
316 | </dt> |
|
|
317 | <dd> |
|
|
318 | Uses per-line display filtering (<code>on_line_update</code>) to underline urls and |
|
|
319 | make them clickable. When middle-clicked, the program specified in the |
|
|
320 | resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with |
|
|
321 | the URL as first argument. |
|
|
322 | </dd> |
|
|
323 | <p></p> |
|
|
324 | <dt><strong><a name="item_xim_2donthespot">xim-onthespot</a></strong><br /> |
|
|
325 | </dt> |
|
|
326 | <dd> |
|
|
327 | This (experimental) perl extension implements OnTheSpot editing. It does |
|
|
328 | not work perfectly, and some input methods don't seem to work well with |
|
|
329 | OnTheSpot editing in general, but it seems to work at leats for SCIM and |
|
|
330 | kinput2. |
|
|
331 | </dd> |
|
|
332 | <dd> |
|
|
333 | <p>You enable it by specifying this extension and a preedit style of |
|
|
334 | <code>OnTheSpot</code>, i.e.:</p> |
|
|
335 | </dd> |
|
|
336 | <dd> |
|
|
337 | <pre> |
|
|
338 | rxvt -pt OnTheSpot -pe xim-onthespot</pre> |
|
|
339 | </dd> |
|
|
340 | <p></p> |
|
|
341 | <dt><strong><a name="item_automove_2dbackground">automove-background</a></strong><br /> |
|
|
342 | </dt> |
|
|
343 | <dd> |
|
|
344 | This is basically a one-line extension that dynamically changes the background pixmap offset |
|
|
345 | to the window position, in effect creating the same effect as pseudo transparency with |
|
|
346 | a custom pixmap. No scaling is supported in this mode. Exmaple: |
|
|
347 | </dd> |
|
|
348 | <dd> |
|
|
349 | <pre> |
|
|
350 | rxvt -pixmap background.xpm -pe automove-background</pre> |
|
|
351 | </dd> |
|
|
352 | <p></p> |
|
|
353 | <dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br /> |
|
|
354 | </dt> |
|
|
355 | <dd> |
|
|
356 | A not very useful example of filtering all text output to the terminal, |
|
|
357 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
|
|
358 | similar-looking ascii character. |
|
|
359 | </dd> |
|
|
360 | <p></p> |
|
|
361 | <dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> |
|
|
362 | </dt> |
|
|
363 | <dd> |
|
|
364 | Displays a digital clock using the built-in overlay. |
|
|
365 | </dd> |
|
|
366 | <p></p> |
|
|
367 | <dt><strong><a name="item_remote_2dclipboard">remote-clipboard</a></strong><br /> |
|
|
368 | </dt> |
|
|
369 | <dd> |
|
|
370 | Somewhat of a misnomer, this extension adds two menu entries to the |
|
|
371 | selection popup that allows one ti run external commands to store the |
|
|
372 | selection somewhere and fetch it again. |
|
|
373 | </dd> |
|
|
374 | <dd> |
|
|
375 | <p>We use it to implement a ``distributed selection mechanism'', which just |
|
|
376 | means that one command uploads the file to a remote server, and another |
|
|
377 | reads it.</p> |
|
|
378 | </dd> |
|
|
379 | <dd> |
|
|
380 | <p>The commands can be set using the <code>URxvt.remote-selection.store</code> and |
|
|
381 | <code>URxvt.remote-selection.fetch</code> resources. The first should read the |
|
|
382 | selection to store from STDIN (always in UTF-8), the second should provide |
|
|
383 | the selection data on STDOUT (also in UTF-8).</p> |
|
|
384 | </dd> |
|
|
385 | <dd> |
|
|
386 | <p>The defaults (which are likely useless to you) use rsh and cat:</p> |
|
|
387 | </dd> |
|
|
388 | <dd> |
|
|
389 | <pre> |
|
|
390 | URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' |
|
|
391 | URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'</pre> |
|
|
392 | </dd> |
|
|
393 | <p></p> |
|
|
394 | <dt><strong><a name="item_selection_2dpastebin">selection-pastebin</a></strong><br /> |
|
|
395 | </dt> |
|
|
396 | <dd> |
|
|
397 | This is a little rarely useful extension that Uploads the selection as |
|
|
398 | textfile to a remote site (or does other things). (The implementation is |
|
|
399 | not currently secure for use in a multiuser environment as it writes to |
|
|
400 | <em>/tmp</em> directly.). |
|
|
401 | </dd> |
|
|
402 | <dd> |
|
|
403 | <p>It listens to the <code>selection-pastebin:remote-pastebin</code> keyboard command, |
|
|
404 | i.e.</p> |
|
|
405 | </dd> |
|
|
406 | <dd> |
|
|
407 | <pre> |
|
|
408 | URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin</pre> |
|
|
409 | </dd> |
|
|
410 | <dd> |
|
|
411 | <p>Pressing this combination runs a command with <code>%</code> replaced by the name of |
|
|
412 | the textfile. This command can be set via a resource:</p> |
|
|
413 | </dd> |
|
|
414 | <dd> |
|
|
415 | <pre> |
|
|
416 | URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.</pre> |
|
|
417 | </dd> |
|
|
418 | <dd> |
|
|
419 | <p>And the default is likely not useful to anybody but the few people around |
|
|
420 | here :)</p> |
|
|
421 | </dd> |
|
|
422 | <dd> |
|
|
423 | <p>The name of the textfile is the hex encoded md5 sum of the selection, so |
|
|
424 | the same content should lead to the same filename.</p> |
|
|
425 | </dd> |
|
|
426 | <dd> |
|
|
427 | <p>After a successful upload the selection will be replaced by the text given |
|
|
428 | in the <code>selection-pastebin-url</code> resource (again, the % is the placeholder |
|
|
429 | for the filename):</p> |
|
|
430 | </dd> |
|
|
431 | <dd> |
|
|
432 | <pre> |
|
|
433 | URxvt.selection-pastebin.url: <a href="http://www.ta-sa.org/files/txt/%">http://www.ta-sa.org/files/txt/%</a></pre> |
|
|
434 | </dd> |
|
|
435 | <p></p> |
|
|
436 | <dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> |
|
|
437 | </dt> |
|
|
438 | <dd> |
|
|
439 | Displays a very simple digital clock in the upper right corner of the |
|
|
440 | window. Illustrates overwriting the refresh callbacks to create your own |
|
|
441 | overlays or changes. |
|
|
442 | </dd> |
|
|
443 | <p></p></dl> |
|
|
444 | <p> |
|
|
445 | </p> |
|
|
446 | <hr /> |
|
|
447 | <h1><a name="api_documentation">API DOCUMENTATION</a></h1> |
68 | <p> |
448 | <p> |
69 | </p> |
449 | </p> |
70 | <h2><a name="general_api_considerations">General API Considerations</a></h2> |
450 | <h2><a name="general_api_considerations">General API Considerations</a></h2> |
71 | <p>All objects (such as terminals, time watchers etc.) are typical |
451 | <p>All objects (such as terminals, time watchers etc.) are typical |
72 | reference-to-hash objects. The hash can be used to store anything you |
452 | reference-to-hash objects. The hash can be used to store anything you |
73 | like. All members starting with an underscore (such as <code>_ptr</code> or |
453 | like. All members starting with an underscore (such as <code>_ptr</code> or |
74 | <code>_hook</code>) are reserved for internal uses and must not be accessed or |
454 | <code>_hook</code>) are reserved for internal uses and <strong>MUST NOT</strong> be accessed or |
75 | modified).</p> |
455 | modified).</p> |
76 | <p>When objects are destroyed on the C++ side, the perl object hashes are |
456 | <p>When objects are destroyed on the C++ side, the perl object hashes are |
77 | emptied, so its best to store related objects such as time watchers and |
457 | emptied, so its best to store related objects such as time watchers and |
78 | the like inside the terminal object so they get destroyed as soon as the |
458 | the like inside the terminal object so they get destroyed as soon as the |
79 | terminal is destroyed.</p> |
459 | terminal is destroyed.</p> |
|
|
460 | <p>Argument names also often indicate the type of a parameter. Here are some |
|
|
461 | hints on what they mean:</p> |
|
|
462 | <dl> |
|
|
463 | <dt><strong><a name="item__24text">$text</a></strong><br /> |
|
|
464 | </dt> |
|
|
465 | <dd> |
|
|
466 | Rxvt-unicodes special way of encoding text, where one ``unicode'' character |
|
|
467 | always represents one screen cell. See <a href="#item_row_t">ROW_t</a> for a discussion of this format. |
|
|
468 | </dd> |
|
|
469 | <p></p> |
|
|
470 | <dt><strong><a name="item__24string">$string</a></strong><br /> |
|
|
471 | </dt> |
|
|
472 | <dd> |
|
|
473 | A perl text string, with an emphasis on <em>text</em>. It can store all unicode |
|
|
474 | characters and is to be distinguished with text encoded in a specific |
|
|
475 | encoding (often locale-specific) and binary data. |
|
|
476 | </dd> |
|
|
477 | <p></p> |
|
|
478 | <dt><strong><a name="item__24octets">$octets</a></strong><br /> |
|
|
479 | </dt> |
|
|
480 | <dd> |
|
|
481 | Either binary data or - more common - a text string encoded in a |
|
|
482 | locale-specific way. |
|
|
483 | </dd> |
|
|
484 | <p></p></dl> |
|
|
485 | <p> |
|
|
486 | </p> |
|
|
487 | <h2><a name="extension_objects">Extension Objects</a></h2> |
|
|
488 | <p>Very perl extension is a perl class. A separate perl object is created |
|
|
489 | for each terminal and each extension and passed as the first parameter to |
|
|
490 | hooks. So extensions can use their <code>$self</code> object without having to think |
|
|
491 | about other extensions, with the exception of methods and members that |
|
|
492 | begin with an underscore character <code>_</code>: these are reserved for internal |
|
|
493 | use.</p> |
|
|
494 | <p>Although it isn't a <code>urxvt::term</code> object, you can call all methods of the |
|
|
495 | <code>urxvt::term</code> class on this object.</p> |
|
|
496 | <p>It has the following methods and data members:</p> |
|
|
497 | <dl> |
|
|
498 | <dt><strong><a name="item__24urxvt_term__3d__24self_2d_3e_7bterm_7d">$urxvt_term = $self->{term}</a></strong><br /> |
|
|
499 | </dt> |
|
|
500 | <dd> |
|
|
501 | Returns the <code>urxvt::term</code> object associated with this instance of the |
|
|
502 | extension. This member <em>must not</em> be changed in any way. |
|
|
503 | </dd> |
|
|
504 | <p></p> |
|
|
505 | <dt><strong><a name="item_enable">$self->enable ($hook_name => $cb, [$hook_name => $cb..])</a></strong><br /> |
|
|
506 | </dt> |
|
|
507 | <dd> |
|
|
508 | Dynamically enable the given hooks (named without the <code>on_</code> prefix) for |
|
|
509 | this extension, replacing any previous hook. This is useful when you want |
|
|
510 | to overwrite time-critical hooks only temporarily. |
|
|
511 | </dd> |
|
|
512 | <p></p> |
|
|
513 | <dt><strong><a name="item_disable">$self->disable ($hook_name[, $hook_name..])</a></strong><br /> |
|
|
514 | </dt> |
|
|
515 | <dd> |
|
|
516 | Dynamically disable the given hooks. |
|
|
517 | </dd> |
|
|
518 | <p></p></dl> |
80 | <p> |
519 | <p> |
81 | </p> |
520 | </p> |
82 | <h2><a name="hooks">Hooks</a></h2> |
521 | <h2><a name="hooks">Hooks</a></h2> |
83 | <p>The following subroutines can be declared in loaded scripts, and will be called |
522 | <p>The following subroutines can be declared in extension files, and will be |
84 | whenever the relevant event happens.</p> |
523 | called whenever the relevant event happens.</p> |
85 | <p>All of them must return a boolean value. If it is true, then the event |
524 | <p>The first argument passed to them is an extension oject as described in |
86 | counts as being <em>consumed</em>, and the invocation of other hooks is skipped, |
525 | the in the <code>Extension Objects</code> section.</p> |
|
|
526 | <p><strong>All</strong> of these hooks must return a boolean value. If any of the called |
|
|
527 | hooks returns true, then the event counts as being <em>consumed</em>, and the |
87 | and the relevant action might not be carried out by the C++ code.</p> |
528 | relevant action might not be carried out by the C++ code.</p> |
88 | <p>When in doubt, return a false value (preferably <code>()</code>).</p> |
529 | <p><em>When in doubt, return a false value (preferably <code>()</code>). </em>></p> |
89 | <dl> |
530 | <dl> |
90 | <dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> |
531 | <dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> |
91 | </dt> |
532 | </dt> |
92 | <dd> |
533 | <dd> |
93 | Called after a new terminal object has been initialized, but before |
534 | Called after a new terminal object has been initialized, but before |
94 | windows are created or the command gets run. |
535 | windows are created or the command gets run. Most methods are unsafe to |
|
|
536 | call or deliver senseless data, as terminal size and other characteristics |
|
|
537 | have not yet been determined. You can safely query and change resources |
|
|
538 | and options, though. For many purposes the <code>on_start</code> hook is a better |
|
|
539 | place. |
|
|
540 | </dd> |
|
|
541 | <p></p> |
|
|
542 | <dt><strong><a name="item_on_start__24term">on_start $term</a></strong><br /> |
|
|
543 | </dt> |
|
|
544 | <dd> |
|
|
545 | Called at the very end of initialisation of a new terminal, just before |
|
|
546 | trying to map (display) the toplevel and returning to the mainloop. |
|
|
547 | </dd> |
|
|
548 | <p></p> |
|
|
549 | <dt><strong><a name="item_on_destroy__24term">on_destroy $term</a></strong><br /> |
|
|
550 | </dt> |
|
|
551 | <dd> |
|
|
552 | Called whenever something tries to destroy terminal, when the terminal is |
|
|
553 | still fully functional (not for long, though). |
95 | </dd> |
554 | </dd> |
96 | <p></p> |
555 | <p></p> |
97 | <dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> |
556 | <dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> |
98 | </dt> |
557 | </dt> |
99 | <dd> |
558 | <dd> |
100 | Called after the screen is ``reset'' for any reason, such as resizing or |
559 | Called after the screen is ``reset'' for any reason, such as resizing or |
101 | control sequences. Here is where you can react on changes to size-related |
560 | control sequences. Here is where you can react on changes to size-related |
102 | variables. |
561 | variables. |
103 | </dd> |
562 | </dd> |
104 | <p></p> |
563 | <p></p> |
105 | <dt><strong><a name="item_on_start__24term">on_start $term</a></strong><br /> |
564 | <dt><strong><a name="item_on_child_start__24term_2c__24pid">on_child_start $term, $pid</a></strong><br /> |
106 | </dt> |
565 | </dt> |
|
|
566 | <dd> |
|
|
567 | Called just after the child process has been <code>fork</code>ed. |
107 | <dd> |
568 | </dd> |
108 | Called at the very end of initialisation of a new terminal, just before |
569 | <p></p> |
109 | returning to the mainloop. |
570 | <dt><strong><a name="item_on_child_exit__24term_2c__24status">on_child_exit $term, $status</a></strong><br /> |
|
|
571 | </dt> |
|
|
572 | <dd> |
|
|
573 | Called just after the child process has exited. <code>$status</code> is the status |
|
|
574 | from <code>waitpid</code>. |
110 | </dd> |
575 | </dd> |
111 | <p></p> |
576 | <p></p> |
112 | <dt><strong><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a></strong><br /> |
577 | <dt><strong><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a></strong><br /> |
113 | </dt> |
578 | </dt> |
114 | <dd> |
579 | <dd> |
… | |
… | |
130 | </dd> |
595 | </dd> |
131 | <dd> |
596 | <dd> |
132 | <p>Returning a true value aborts selection grabbing. It will still be hilighted.</p> |
597 | <p>Returning a true value aborts selection grabbing. It will still be hilighted.</p> |
133 | </dd> |
598 | </dd> |
134 | <p></p> |
599 | <p></p> |
135 | <dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> |
600 | <dt><strong><a name="item_on_sel_extend__24term">on_sel_extend $term</a></strong><br /> |
136 | </dt> |
601 | </dt> |
137 | <dd> |
|
|
138 | Called whenever the window gets the keyboard focus, before urxvt does |
|
|
139 | focus in processing. |
|
|
140 | </dd> |
602 | <dd> |
141 | <p></p> |
603 | Called whenever the user tries to extend the selection (e.g. with a double |
142 | <dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong><br /> |
604 | click) and is either supposed to return false (normal operation), or |
143 | </dt> |
605 | should extend the selection itelf and return true to suppress the built-in |
|
|
606 | processing. This can happen multiple times, as long as the callback |
|
|
607 | returns true, it will be called on every further click by the user and is |
|
|
608 | supposed to enlarge the selection more and more, if possible. |
144 | <dd> |
609 | </dd> |
145 | Called wheneever the window loses keyboard focus, before urxvt does focus |
610 | <dd> |
146 | out processing. |
611 | <p>See the <em>selection</em> example extension.</p> |
147 | </dd> |
612 | </dd> |
148 | <p></p> |
613 | <p></p> |
149 | <dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong><br /> |
614 | <dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong><br /> |
150 | </dt> |
615 | </dt> |
151 | <dd> |
616 | <dd> |
… | |
… | |
165 | <p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
630 | <p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
166 | $nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total |
631 | $nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total |
167 | number of lines that will be in the scrollback buffer.</p> |
632 | number of lines that will be in the scrollback buffer.</p> |
168 | </dd> |
633 | </dd> |
169 | <p></p> |
634 | <p></p> |
170 | <dt><strong><a name="item_on_tty_activity__24term__2anyi_2a">on_tty_activity $term *NYI*</a></strong><br /> |
635 | <dt><strong><a name="item_on_osc_seq__24term_2c__24string">on_osc_seq $term, $string</a></strong><br /> |
171 | </dt> |
636 | </dt> |
|
|
637 | <dd> |
|
|
638 | Called whenever the <strong>ESC ] 777 ; string ST</strong> command sequence (OSC = |
|
|
639 | operating system command) is processed. Cursor position and other state |
|
|
640 | information is up-to-date when this happens. For interoperability, the |
|
|
641 | string should start with the extension name and a colon, to distinguish |
|
|
642 | it from commands for other extensions, and this might be enforced in the |
|
|
643 | future. |
172 | <dd> |
644 | </dd> |
173 | Called whenever the <code>program(s)</code> running in the urxvt window send output. |
645 | <dd> |
|
|
646 | <p>Be careful not ever to trust (in a security sense) the data you receive, |
|
|
647 | as its source can not easily be controleld (e-mail content, messages from |
|
|
648 | other users on the same system etc.).</p> |
|
|
649 | </dd> |
|
|
650 | <p></p> |
|
|
651 | <dt><strong><a name="item_on_add_lines__24term_2c__24string">on_add_lines $term, $string</a></strong><br /> |
|
|
652 | </dt> |
|
|
653 | <dd> |
|
|
654 | Called whenever text is about to be output, with the text as argument. You |
|
|
655 | can filter/change and output the text yourself by returning a true value |
|
|
656 | and calling <a href="#item_scr_add_lines"><code>$term->scr_add_lines</code></a> yourself. Please note that this |
|
|
657 | might be very slow, however, as your hook is called for <strong>all</strong> text being |
|
|
658 | output. |
|
|
659 | </dd> |
|
|
660 | <p></p> |
|
|
661 | <dt><strong><a name="item_on_tt_write__24term_2c__24octets">on_tt_write $term, $octets</a></strong><br /> |
|
|
662 | </dt> |
|
|
663 | <dd> |
|
|
664 | Called whenever some data is written to the tty/pty and can be used to |
|
|
665 | suppress or filter tty input. |
|
|
666 | </dd> |
|
|
667 | <p></p> |
|
|
668 | <dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong><br /> |
|
|
669 | </dt> |
|
|
670 | <dd> |
|
|
671 | Called whenever a line was updated or changed. Can be used to filter |
|
|
672 | screen output (e.g. underline urls or other useless stuff). Only lines |
|
|
673 | that are being shown will be filtered, and, due to performance reasons, |
|
|
674 | not always immediately. |
|
|
675 | </dd> |
|
|
676 | <dd> |
|
|
677 | <p>The row number is always the topmost row of the line if the line spans |
|
|
678 | multiple rows.</p> |
|
|
679 | </dd> |
|
|
680 | <dd> |
|
|
681 | <p>Please note that, if you change the line, then the hook might get called |
|
|
682 | later with the already-modified line (e.g. if unrelated parts change), so |
|
|
683 | you cannot just toggle rendition bits, but only set them.</p> |
174 | </dd> |
684 | </dd> |
175 | <p></p> |
685 | <p></p> |
176 | <dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong><br /> |
686 | <dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong><br /> |
177 | </dt> |
687 | </dt> |
178 | <dd> |
688 | <dd> |
… | |
… | |
186 | </dt> |
696 | </dt> |
187 | <dd> |
697 | <dd> |
188 | Called just after the screen gets redrawn. See <code>on_refresh_begin</code>. |
698 | Called just after the screen gets redrawn. See <code>on_refresh_begin</code>. |
189 | </dd> |
699 | </dd> |
190 | <p></p> |
700 | <p></p> |
191 | <dt><strong><a name="item_on_keyboard_command__24term_2c__24string">on_keyboard_command $term, $string</a></strong><br /> |
701 | <dt><strong><a name="item_on_user_command__24term_2c__24string">on_user_command $term, $string</a></strong><br /> |
192 | </dt> |
702 | </dt> |
193 | <dd> |
703 | <dd> |
194 | Called whenever the user presses a key combination that has a |
704 | Called whenever the a user-configured event is being activated (e.g. via |
195 | <code>perl:string</code> action bound to it (see description of the <strong>keysym</strong> |
705 | a <code>perl:string</code> action bound to a key, see description of the <strong>keysym</strong> |
196 | resource in the <code>rxvt(1)</code> manpage). |
706 | resource in the <code>rxvt(1)</code> manpage). |
|
|
707 | </dd> |
|
|
708 | <dd> |
|
|
709 | <p>The event is simply the action string. This interface is assumed to change |
|
|
710 | slightly in the future.</p> |
|
|
711 | </dd> |
|
|
712 | <p></p> |
|
|
713 | <dt><strong><a name="item_on_x_event__24term_2c__24event">on_x_event $term, $event</a></strong><br /> |
|
|
714 | </dt> |
|
|
715 | <dd> |
|
|
716 | Called on every X event received on the vt window (and possibly other |
|
|
717 | windows). Should only be used as a last resort. Most event structure |
|
|
718 | members are not passed. |
|
|
719 | </dd> |
|
|
720 | <p></p> |
|
|
721 | <dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> |
|
|
722 | </dt> |
|
|
723 | <dd> |
|
|
724 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
|
|
725 | does focus in processing. |
|
|
726 | </dd> |
|
|
727 | <p></p> |
|
|
728 | <dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong><br /> |
|
|
729 | </dt> |
|
|
730 | <dd> |
|
|
731 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
|
|
732 | focus out processing. |
|
|
733 | </dd> |
|
|
734 | <p></p> |
|
|
735 | <dt><strong><a name="item_on_configure_notify__24term_2c__24event">on_configure_notify $term, $event</a></strong><br /> |
|
|
736 | </dt> |
|
|
737 | <dt><strong><a name="item_on_property_notify__24term_2c__24event">on_property_notify $term, $event</a></strong><br /> |
|
|
738 | </dt> |
|
|
739 | <dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a></strong><br /> |
|
|
740 | </dt> |
|
|
741 | <dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br /> |
|
|
742 | </dt> |
|
|
743 | <dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br /> |
|
|
744 | </dt> |
|
|
745 | <dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br /> |
|
|
746 | </dt> |
|
|
747 | <dt><strong><a name="item_on_motion_notify__24term_2c__24event">on_motion_notify $term, $event</a></strong><br /> |
|
|
748 | </dt> |
|
|
749 | <dt><strong><a name="item_on_map_notify__24term_2c__24event">on_map_notify $term, $event</a></strong><br /> |
|
|
750 | </dt> |
|
|
751 | <dt><strong><a name="item_on_unmap_notify__24term_2c__24event">on_unmap_notify $term, $event</a></strong><br /> |
|
|
752 | </dt> |
|
|
753 | <dd> |
|
|
754 | Called whenever the corresponding X event is received for the terminal If |
|
|
755 | the hook returns true, then the even will be ignored by rxvt-unicode. |
|
|
756 | </dd> |
|
|
757 | <dd> |
|
|
758 | <p>The event is a hash with most values as named by Xlib (see the XEvent |
|
|
759 | manpage), with the additional members <code>row</code> and <code>col</code>, which are the |
|
|
760 | (real, not screen-based) row and column under the mouse cursor.</p> |
|
|
761 | </dd> |
|
|
762 | <dd> |
|
|
763 | <p><code>on_key_press</code> additionally receives the string rxvt-unicode would |
|
|
764 | output, if any, in locale-specific encoding.</p> |
|
|
765 | </dd> |
|
|
766 | <dd> |
|
|
767 | <p>subwindow.</p> |
|
|
768 | </dd> |
|
|
769 | <p></p> |
|
|
770 | <dt><strong><a name="item_on_client_message__24term_2c__24event">on_client_message $term, $event</a></strong><br /> |
|
|
771 | </dt> |
|
|
772 | <dt><strong><a name="item_on_wm_protocols__24term_2c__24event">on_wm_protocols $term, $event</a></strong><br /> |
|
|
773 | </dt> |
|
|
774 | <dt><strong><a name="item_on_wm_delete_window__24term_2c__24event">on_wm_delete_window $term, $event</a></strong><br /> |
|
|
775 | </dt> |
|
|
776 | <dd> |
|
|
777 | Called when various types of ClientMessage events are received (all with |
|
|
778 | format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
|
|
779 | </dd> |
|
|
780 | <p></p></dl> |
|
|
781 | <p> |
|
|
782 | </p> |
|
|
783 | <h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> |
|
|
784 | <dl> |
|
|
785 | <dt><strong><a name="item__24urxvt_3a_3alibdir">$urxvt::LIBDIR</a></strong><br /> |
|
|
786 | </dt> |
|
|
787 | <dd> |
|
|
788 | The rxvt-unicode library directory, where, among other things, the perl |
|
|
789 | modules and scripts are stored. |
|
|
790 | </dd> |
|
|
791 | <p></p> |
|
|
792 | <dt><strong><a name="item__24urxvt_3a_3aresclass_2c__24urxvt_3a_3aresclass">$urxvt::RESCLASS, $urxvt::RESCLASS</a></strong><br /> |
|
|
793 | </dt> |
|
|
794 | <dd> |
|
|
795 | The resource class and name rxvt-unicode uses to look up X resources. |
|
|
796 | </dd> |
|
|
797 | <p></p> |
|
|
798 | <dt><strong><a name="item__24urxvt_3a_3arxvtname">$urxvt::RXVTNAME</a></strong><br /> |
|
|
799 | </dt> |
|
|
800 | <dd> |
|
|
801 | The basename of the installed binaries, usually <code>urxvt</code>. |
|
|
802 | </dd> |
|
|
803 | <p></p> |
|
|
804 | <dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br /> |
|
|
805 | </dt> |
|
|
806 | <dd> |
|
|
807 | The current terminal. This variable stores the current <code>urxvt::term</code> |
|
|
808 | object, whenever a callback/hook is executing. |
|
|
809 | </dd> |
|
|
810 | <p></p> |
|
|
811 | <dt><strong><a name="item__40urxvt_3a_3aterm_init">@urxvt::TERM_INIT</a></strong><br /> |
|
|
812 | </dt> |
|
|
813 | <dd> |
|
|
814 | All coderefs in this array will be called as methods of the next newly |
|
|
815 | created <code>urxvt::term</code> object (during the <code>on_init</code> phase). The array |
|
|
816 | gets cleared before the codereferences that were in it are being executed, |
|
|
817 | so coderefs can push themselves onto it again if they so desire. |
|
|
818 | </dd> |
|
|
819 | <dd> |
|
|
820 | <p>This complements to the perl-eval commandline option, but gets executed |
|
|
821 | first.</p> |
|
|
822 | </dd> |
|
|
823 | <p></p> |
|
|
824 | <dt><strong><a name="item__40urxvt_3a_3aterm_ext">@urxvt::TERM_EXT</a></strong><br /> |
|
|
825 | </dt> |
|
|
826 | <dd> |
|
|
827 | Works similar to <code>@TERM_INIT</code>, but contains perl package/class names, which |
|
|
828 | get registered as normal extensions after calling the hooks in <code>@TERM_INIT</code> |
|
|
829 | but before other extensions. Gets cleared just like <code>@TERM_INIT</code>. |
197 | </dd> |
830 | </dd> |
198 | <p></p></dl> |
831 | <p></p></dl> |
199 | <p> |
832 | <p> |
200 | </p> |
833 | </p> |
201 | <h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> |
834 | <h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> |
… | |
… | |
217 | </dd> |
850 | </dd> |
218 | <dd> |
851 | <dd> |
219 | <p>Using this function has the advantage that its output ends up in the |
852 | <p>Using this function has the advantage that its output ends up in the |
220 | correct place, e.g. on stderr of the connecting urxvtc client.</p> |
853 | correct place, e.g. on stderr of the connecting urxvtc client.</p> |
221 | </dd> |
854 | </dd> |
|
|
855 | <dd> |
|
|
856 | <p>Messages have a size limit of 1023 bytes currently.</p> |
|
|
857 | </dd> |
|
|
858 | <p></p> |
|
|
859 | <dt><strong><a name="item__40terms__3d_urxvt_3a_3atermlist">@terms = urxvt::termlist</a></strong><br /> |
|
|
860 | </dt> |
|
|
861 | <dd> |
|
|
862 | Returns all urxvt::term objects that exist in this process, regardless of |
|
|
863 | wether they are started, being destroyed etc., so be careful. Only term |
|
|
864 | objects that have perl extensions attached will be returned (because there |
|
|
865 | is no urxvt::term objet associated with others). |
|
|
866 | </dd> |
222 | <p></p> |
867 | <p></p> |
223 | <dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> |
868 | <dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> |
224 | </dt> |
869 | </dt> |
225 | <dd> |
870 | <dd> |
226 | Returns the ``current time'' (as per the event loop). |
871 | Returns the ``current time'' (as per the event loop). |
227 | </dd> |
872 | </dd> |
|
|
873 | <p></p> |
|
|
874 | <dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br /> |
|
|
875 | </dt> |
|
|
876 | <dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
|
|
877 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
|
|
878 | Button4Mask, Button5Mask, AnyModifier</a></strong><br /> |
|
|
879 | </dt> |
|
|
880 | <dt><strong><a name="item_urxvt_3a_3anoeventmask_2c_keypressmask_2c_keyrelea">urxvt::NoEventMask, KeyPressMask, KeyReleaseMask, |
|
|
881 | ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, |
|
|
882 | PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask, |
|
|
883 | Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask, |
|
|
884 | KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask, |
|
|
885 | ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask, |
|
|
886 | FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask</a></strong><br /> |
|
|
887 | </dt> |
|
|
888 | <dt><strong><a name="item_urxvt_3a_3akeypress_2c_keyrelease_2c_buttonpress_2">urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify, |
|
|
889 | EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose, |
|
|
890 | GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify, |
|
|
891 | UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify, |
|
|
892 | ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify, |
|
|
893 | CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, |
|
|
894 | SelectionNotify, ColormapNotify, ClientMessage, MappingNotify</a></strong><br /> |
|
|
895 | </dt> |
|
|
896 | <dd> |
|
|
897 | Various constants for use in X calls and event processing. |
|
|
898 | </dd> |
228 | <p></p></dl> |
899 | <p></p></dl> |
|
|
900 | <p> |
|
|
901 | </p> |
|
|
902 | <h2><a name="rendition">RENDITION</a></h2> |
|
|
903 | <p>Rendition bitsets contain information about colour, font, font styles and |
|
|
904 | similar information for each screen cell.</p> |
|
|
905 | <p>The following ``macros'' deal with changes in rendition sets. You should |
|
|
906 | never just create a bitset, you should always modify an existing one, |
|
|
907 | as they contain important information required for correct operation of |
|
|
908 | rxvt-unicode.</p> |
|
|
909 | <dl> |
|
|
910 | <dt><strong><a name="item__24rend__3d_urxvt_3a_3adefault_rstyle">$rend = urxvt::DEFAULT_RSTYLE</a></strong><br /> |
|
|
911 | </dt> |
|
|
912 | <dd> |
|
|
913 | Returns the default rendition, as used when the terminal is starting up or |
|
|
914 | being reset. Useful as a base to start when creating renditions. |
|
|
915 | </dd> |
|
|
916 | <p></p> |
|
|
917 | <dt><strong><a name="item__24rend__3d_urxvt_3a_3aoverlay_rstyle">$rend = urxvt::OVERLAY_RSTYLE</a></strong><br /> |
|
|
918 | </dt> |
|
|
919 | <dd> |
|
|
920 | Return the rendition mask used for overlays by default. |
|
|
921 | </dd> |
|
|
922 | <p></p> |
|
|
923 | <dt><strong><a name="item__24rendbit__3d_urxvt_3a_3ars_bold_2c_rs_italic_2c_">$rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline</a></strong><br /> |
|
|
924 | </dt> |
|
|
925 | <dd> |
|
|
926 | Return the bit that enabled bold, italic, blink, reverse-video and |
|
|
927 | underline, respectively. To enable such a style, just logically OR it into |
|
|
928 | the bitset. |
|
|
929 | </dd> |
|
|
930 | <p></p> |
|
|
931 | <dt><strong><a name="item__24foreground__3d_urxvt_3a_3aget_basefg__24rend">$foreground = urxvt::GET_BASEFG $rend</a></strong><br /> |
|
|
932 | </dt> |
|
|
933 | <dt><strong><a name="item__24background__3d_urxvt_3a_3aget_basebg__24rend">$background = urxvt::GET_BASEBG $rend</a></strong><br /> |
|
|
934 | </dt> |
|
|
935 | <dd> |
|
|
936 | Return the foreground/background colour index, respectively. |
|
|
937 | </dd> |
|
|
938 | <p></p> |
|
|
939 | <dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_fgcolor__24rend_2c__24n">$rend = urxvt::SET_FGCOLOR $rend, $new_colour</a></strong><br /> |
|
|
940 | </dt> |
|
|
941 | <dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_bgcolor__24rend_2c__24n">$rend = urxvt::SET_BGCOLOR $rend, $new_colour</a></strong><br /> |
|
|
942 | </dt> |
|
|
943 | <dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_color__24rend_2c__24new">$rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg</a></strong><br /> |
|
|
944 | </dt> |
|
|
945 | <dd> |
|
|
946 | Replace the foreground/background colour in the rendition mask with the |
|
|
947 | specified one. |
|
|
948 | </dd> |
|
|
949 | <p></p> |
|
|
950 | <dt><strong><a name="item__24value__3d_urxvt_3a_3aget_custom__24rend">$value = urxvt::GET_CUSTOM $rend</a></strong><br /> |
|
|
951 | </dt> |
|
|
952 | <dd> |
|
|
953 | Return the ``custom'' value: Every rendition has 5 bits for use by |
|
|
954 | extensions. They can be set and changed as you like and are initially |
|
|
955 | zero. |
|
|
956 | </dd> |
|
|
957 | <p></p> |
|
|
958 | <dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_custom__24rend_2c__24ne">$rend = urxvt::SET_CUSTOM $rend, $new_value</a></strong><br /> |
|
|
959 | </dt> |
|
|
960 | <dd> |
|
|
961 | Change the custom value. |
|
|
962 | </dd> |
|
|
963 | <p></p></dl> |
|
|
964 | <p> |
|
|
965 | </p> |
|
|
966 | <h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2> |
|
|
967 | <p>The sole purpose of this class is to deliver an interface to the |
|
|
968 | <code>AnyEvent</code> module - any module using it will work inside urxvt without |
|
|
969 | further programming. The only exception is that you cannot wait on |
|
|
970 | condition variables, but non-blocking condvar use is ok. What this means |
|
|
971 | is that you cannot use blocking APIs, but the non-blocking variant should |
|
|
972 | work.</p> |
229 | <p> |
973 | <p> |
230 | </p> |
974 | </p> |
231 | <h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> |
975 | <h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> |
232 | <dl> |
976 | <dl> |
|
|
977 | <dt><strong><a name="item__24term__3d_new_urxvt_3a_3aterm__24envhashref_2c__">$term = new urxvt::term $envhashref, $rxvtname, [arg...]</a></strong><br /> |
|
|
978 | </dt> |
|
|
979 | <dd> |
|
|
980 | Creates a new terminal, very similar as if you had started it with system |
|
|
981 | <code>$rxvtname, arg...</code>. <code>$envhashref</code> must be a reference to a <code>%ENV</code>-like |
|
|
982 | hash which defines the environment of the new terminal. |
|
|
983 | </dd> |
|
|
984 | <dd> |
|
|
985 | <p>Croaks (and probably outputs an error message) if the new instance |
|
|
986 | couldn't be created. Returns <code>undef</code> if the new instance didn't |
|
|
987 | initialise perl, and the terminal object otherwise. The <code>init</code> and |
|
|
988 | <a href="#item_start"><code>start</code></a> hooks will be called before this call returns, and are free to |
|
|
989 | refer to global data (which is race free).</p> |
|
|
990 | </dd> |
|
|
991 | <p></p> |
|
|
992 | <dt><strong><a name="item_destroy">$term->destroy</a></strong><br /> |
|
|
993 | </dt> |
|
|
994 | <dd> |
|
|
995 | Destroy the terminal object (close the window, free resources |
|
|
996 | etc.). Please note that rxvt will not exit as long as any event |
|
|
997 | watchers (timers, io watchers) are still active. |
|
|
998 | </dd> |
|
|
999 | <p></p> |
|
|
1000 | <dt><strong><a name="item_exec_async">$term->exec_async ($cmd[, @args])</a></strong><br /> |
|
|
1001 | </dt> |
|
|
1002 | <dd> |
|
|
1003 | Works like the combination of the <code>fork</code>/<code>exec</code> builtins, which executes |
|
|
1004 | (``starts'') programs in the background. This function takes care of setting |
|
|
1005 | the user environment before exec'ing the command (e.g. <code>PATH</code>) and should |
|
|
1006 | be preferred over explicit calls to <code>exec</code> or <code>system</code>. |
|
|
1007 | </dd> |
|
|
1008 | <dd> |
|
|
1009 | <p>Returns the pid of the subprocess or <code>undef</code> on error.</p> |
|
|
1010 | </dd> |
|
|
1011 | <p></p> |
|
|
1012 | <dt><strong><a name="item_option">$isset = $term->option ($optval[, $set])</a></strong><br /> |
|
|
1013 | </dt> |
|
|
1014 | <dd> |
|
|
1015 | Returns true if the option specified by <code>$optval</code> is enabled, and |
|
|
1016 | optionally change it. All option values are stored by name in the hash |
|
|
1017 | <code>%urxvt::OPTION</code>. Options not enabled in this binary are not in the hash. |
|
|
1018 | </dd> |
|
|
1019 | <dd> |
|
|
1020 | <p>Here is a a likely non-exhaustive list of option names, please see the |
|
|
1021 | source file <em>/src/optinc.h</em> to see the actual list:</p> |
|
|
1022 | </dd> |
|
|
1023 | <dd> |
|
|
1024 | <pre> |
|
|
1025 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
|
|
1026 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
|
|
1027 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
|
|
1028 | scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput |
|
|
1029 | scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs |
|
|
1030 | transparent tripleclickwords utmpInhibit visualBell</pre> |
|
|
1031 | </dd> |
|
|
1032 | <p></p> |
233 | <dt><strong><a name="item_resource">$value = $term->resource ($name[, $newval])</a></strong><br /> |
1033 | <dt><strong><a name="item_resource">$value = $term->resource ($name[, $newval])</a></strong><br /> |
234 | </dt> |
1034 | </dt> |
235 | <dd> |
1035 | <dd> |
236 | Returns the current resource value associated with a given name and |
1036 | Returns the current resource value associated with a given name and |
237 | optionally sets a new value. Setting values is most useful in the <code>init</code> |
1037 | optionally sets a new value. Setting values is most useful in the <code>init</code> |
… | |
… | |
251 | <p>Please note that resource strings will currently only be freed when the |
1051 | <p>Please note that resource strings will currently only be freed when the |
252 | terminal is destroyed, so changing options frequently will eat memory.</p> |
1052 | terminal is destroyed, so changing options frequently will eat memory.</p> |
253 | </dd> |
1053 | </dd> |
254 | <dd> |
1054 | <dd> |
255 | <p>Here is a a likely non-exhaustive list of resource names, not all of which |
1055 | <p>Here is a a likely non-exhaustive list of resource names, not all of which |
256 | are supported in every build, please see the source to see the actual |
1056 | are supported in every build, please see the source file <em>/src/rsinc.h</em> |
257 | list:</p> |
1057 | to see the actual list:</p> |
258 | </dd> |
1058 | </dd> |
259 | <dd> |
1059 | <dd> |
260 | <pre> |
1060 | <pre> |
261 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1061 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
262 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
1062 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
263 | display_name embed ext_bwidth fade font geometry hold iconName |
1063 | display_name embed ext_bwidth fade font geometry hold iconName |
264 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
1064 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
265 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
1065 | italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier |
266 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext |
1066 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
267 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
1067 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
268 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
1068 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
269 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
1069 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
270 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
1070 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
271 | shade term_name title transparent transparent_all tripleclickwords |
1071 | secondaryScreen secondaryScroll selectstyle shade term_name title |
|
|
1072 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
272 | utmpInhibit visualBell</pre> |
1073 | visualBell</pre> |
|
|
1074 | </dd> |
|
|
1075 | <p></p> |
|
|
1076 | <dt><strong><a name="item_x_resource">$value = $term->x_resource ($pattern)</a></strong><br /> |
|
|
1077 | </dt> |
|
|
1078 | <dd> |
|
|
1079 | Returns the X-Resource for the given pattern, excluding the program or |
|
|
1080 | class name, i.e. <a href="#item_x_resource"><code>$term->x_resource ("boldFont")</code></a> should return the |
|
|
1081 | same value as used by this instance of rxvt-unicode. Returns <code>undef</code> if no |
|
|
1082 | resource with that pattern exists. |
|
|
1083 | </dd> |
|
|
1084 | <dd> |
|
|
1085 | <p>This method should only be called during the <code>on_start</code> hook, as there is |
|
|
1086 | only one resource database per display, and later invocations might return |
|
|
1087 | the wrong resources.</p> |
|
|
1088 | </dd> |
|
|
1089 | <p></p> |
|
|
1090 | <dt><strong><a name="item_parse_keysym">$success = $term->parse_keysym ($keysym_spec, $command_string)</a></strong><br /> |
|
|
1091 | </dt> |
|
|
1092 | <dd> |
|
|
1093 | Adds a keymap translation exactly as specified via a resource. See the |
|
|
1094 | <code>keysym</code> resource in the <code>rxvt(1)</code> manpage. |
|
|
1095 | </dd> |
|
|
1096 | <p></p> |
|
|
1097 | <dt><strong><a name="item_rstyle">$rend = $term->rstyle ([$new_rstyle])</a></strong><br /> |
|
|
1098 | </dt> |
|
|
1099 | <dd> |
|
|
1100 | Return and optionally change the current rendition. Text that is output by |
|
|
1101 | the terminal application will use this style. |
|
|
1102 | </dd> |
|
|
1103 | <p></p> |
|
|
1104 | <dt><strong><a name="item_screen_cur">($row, $col) = $term->screen_cur ([$row, $col])</a></strong><br /> |
|
|
1105 | </dt> |
|
|
1106 | <dd> |
|
|
1107 | Return the current coordinates of the text cursor position and optionally |
|
|
1108 | set it (which is usually bad as applications don't expect that). |
273 | </dd> |
1109 | </dd> |
274 | <p></p> |
1110 | <p></p> |
275 | <dt><strong><a name="item_selection_mark">($row, $col) = $term->selection_mark ([$row, $col])</a></strong><br /> |
1111 | <dt><strong><a name="item_selection_mark">($row, $col) = $term->selection_mark ([$row, $col])</a></strong><br /> |
276 | </dt> |
1112 | </dt> |
277 | <dt><strong><a name="item_selection_beg">($row, $col) = $term->selection_beg ([$row, $col])</a></strong><br /> |
1113 | <dt><strong><a name="item_selection_beg">($row, $col) = $term->selection_beg ([$row, $col])</a></strong><br /> |
… | |
… | |
281 | <dd> |
1117 | <dd> |
282 | Return the current values of the selection mark, begin or end positions, |
1118 | Return the current values of the selection mark, begin or end positions, |
283 | and optionally set them to new values. |
1119 | and optionally set them to new values. |
284 | </dd> |
1120 | </dd> |
285 | <p></p> |
1121 | <p></p> |
|
|
1122 | <dt><strong><a name="item_selection_make">$term->selection_make ($eventtime[, $rectangular])</a></strong><br /> |
|
|
1123 | </dt> |
|
|
1124 | <dd> |
|
|
1125 | Tries to make a selection as set by <a href="#item_selection_beg"><code>selection_beg</code></a> and |
|
|
1126 | <a href="#item_selection_end"><code>selection_end</code></a>. If <code>$rectangular</code> is true (default: false), a |
|
|
1127 | rectangular selection will be made. This is the prefered function to make |
|
|
1128 | a selection. |
|
|
1129 | </dd> |
|
|
1130 | <p></p> |
286 | <dt><strong><a name="item_selection_grab">$success = $term->selection_grab ($eventtime)</a></strong><br /> |
1131 | <dt><strong><a name="item_selection_grab">$success = $term->selection_grab ($eventtime)</a></strong><br /> |
287 | </dt> |
1132 | </dt> |
288 | <dd> |
1133 | <dd> |
289 | Try to request the primary selection from the server (for example, as set |
1134 | Try to request the primary selection text from the server (for example, as |
290 | by the next method). |
1135 | set by the next method). No visual feedback will be given. This function |
|
|
1136 | is mostly useful from within <code>on_sel_grab</code> hooks. |
291 | </dd> |
1137 | </dd> |
292 | <p></p> |
1138 | <p></p> |
293 | <dt><strong><a name="item_selection">$oldtext = $term->selection ([$newtext])</a></strong><br /> |
1139 | <dt><strong>$oldtext = $term->selection ([$newtext])</strong><br /> |
294 | </dt> |
1140 | </dt> |
295 | <dd> |
1141 | <dd> |
296 | Return the current selection text and optionally replace it by <code>$newtext</code>. |
1142 | Return the current selection text and optionally replace it by <code>$newtext</code>. |
297 | </dd> |
1143 | </dd> |
298 | <p></p> |
1144 | <p></p> |
299 | <dt><strong><a name="item_scr_overlay">$term->scr_overlay ($x, $y, $text)</a></strong><br /> |
1145 | <dt><strong><a name="item_overlay_simple">$term->overlay_simple ($x, $y, $text)</a></strong><br /> |
300 | </dt> |
1146 | </dt> |
301 | <dd> |
1147 | <dd> |
302 | Create a simple multi-line overlay box. See the next method for details. |
1148 | Create a simple multi-line overlay box. See the next method for details. |
303 | </dd> |
1149 | </dd> |
304 | <p></p> |
1150 | <p></p> |
305 | <dt><strong><a name="item_scr_overlay_new">$term->scr_overlay_new ($x, $y, $width, $height)</a></strong><br /> |
1151 | <dt><strong><a name="item_overlay">$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br /> |
306 | </dt> |
1152 | </dt> |
307 | <dd> |
1153 | <dd> |
308 | Create a new (empty) overlay at the given position with the given |
1154 | Create a new (empty) overlay at the given position with the given |
309 | width/height. A border will be put around the box. If either <code>$x</code> or |
1155 | width/height. <code>$rstyle</code> defines the initial rendition style |
310 | <code>$y</code> is negative, then this is counted from the right/bottom side, |
1156 | (default: <code>OVERLAY_RSTYLE</code>). |
311 | respectively. |
|
|
312 | </dd> |
|
|
313 | <p></p> |
|
|
314 | <dt><strong><a name="item_scr_overlay_off">$term->scr_overlay_off</a></strong><br /> |
|
|
315 | </dt> |
|
|
316 | <dd> |
1157 | </dd> |
317 | Switch the overlay off again. |
|
|
318 | </dd> |
1158 | <dd> |
319 | <p></p> |
1159 | <p>If <code>$border</code> is <code>2</code> (default), then a decorative border will be put |
320 | <dt><strong><a name="item_scr_overlay_set_char">$term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE)</a></strong><br /> |
1160 | around the box.</p> |
321 | </dt> |
|
|
322 | <dd> |
1161 | </dd> |
323 | Put a single character (specified numerically) at the given overlay |
|
|
324 | position. |
|
|
325 | </dd> |
1162 | <dd> |
326 | <p></p> |
1163 | <p>If either <code>$x</code> or <code>$y</code> is negative, then this is counted from the |
327 | <dt><strong><a name="item_scr_overlay_set">$term->scr_overlay_set ($x, $y, $text)</a></strong><br /> |
1164 | right/bottom side, respectively.</p> |
328 | </dt> |
|
|
329 | <dd> |
1165 | </dd> |
330 | Write a string at the given position into the overlay. |
|
|
331 | </dd> |
1166 | <dd> |
|
|
1167 | <p>This method returns an urxvt::overlay object. The overlay will be visible |
|
|
1168 | as long as the perl object is referenced.</p> |
|
|
1169 | </dd> |
|
|
1170 | <dd> |
|
|
1171 | <p>The methods currently supported on <code>urxvt::overlay</code> objects are:</p> |
|
|
1172 | </dd> |
|
|
1173 | <dl> |
|
|
1174 | <dt><strong><a name="item_set">$overlay->set ($x, $y, $text, $rend)</a></strong><br /> |
|
|
1175 | </dt> |
|
|
1176 | <dd> |
|
|
1177 | Similar to <a href="#item_row_t"><code>$term->ROW_t</code></a> and <a href="#item_row_r"><code>$term->ROW_r</code></a> in that it puts |
|
|
1178 | text in rxvt-unicode's special encoding and an array of rendition values |
|
|
1179 | at a specific position inside the overlay. |
|
|
1180 | </dd> |
332 | <p></p> |
1181 | <p></p> |
|
|
1182 | <dt><strong><a name="item_hide">$overlay->hide</a></strong><br /> |
|
|
1183 | </dt> |
|
|
1184 | <dd> |
|
|
1185 | If visible, hide the overlay, but do not destroy it. |
|
|
1186 | </dd> |
|
|
1187 | <p></p> |
|
|
1188 | <dt><strong><a name="item_show">$overlay->show</a></strong><br /> |
|
|
1189 | </dt> |
|
|
1190 | <dd> |
|
|
1191 | If hidden, display the overlay again. |
|
|
1192 | </dd> |
|
|
1193 | <p></p></dl> |
|
|
1194 | <dt><strong>$popup = $term->popup ($event)</strong><br /> |
|
|
1195 | </dt> |
|
|
1196 | <dd> |
|
|
1197 | Creates a new <code>urxvt::popup</code> object that implements a popup menu. The |
|
|
1198 | <code>$event</code> <em>must</em> be the event causing the menu to pop up (a button event, |
|
|
1199 | currently). |
|
|
1200 | </dd> |
|
|
1201 | <p></p> |
333 | <dt><strong><a name="item_strwidth">$cellwidth = $term->strwidth $string</a></strong><br /> |
1202 | <dt><strong><a name="item_strwidth">$cellwidth = $term->strwidth ($string)</a></strong><br /> |
334 | </dt> |
1203 | </dt> |
335 | <dd> |
1204 | <dd> |
336 | Returns the number of screen-cells this string would need. Correctly |
1205 | Returns the number of screen-cells this string would need. Correctly |
337 | accounts for wide and combining characters. |
1206 | accounts for wide and combining characters. |
338 | </dd> |
1207 | </dd> |
339 | <p></p> |
1208 | <p></p> |
340 | <dt><strong><a name="item_locale_encode">$octets = $term->locale_encode $string</a></strong><br /> |
1209 | <dt><strong><a name="item_locale_encode">$octets = $term->locale_encode ($string)</a></strong><br /> |
341 | </dt> |
1210 | </dt> |
342 | <dd> |
1211 | <dd> |
343 | Convert the given text string into the corresponding locale encoding. |
1212 | Convert the given text string into the corresponding locale encoding. |
344 | </dd> |
1213 | </dd> |
345 | <p></p> |
1214 | <p></p> |
346 | <dt><strong><a name="item_locale_decode">$string = $term->locale_decode $octets</a></strong><br /> |
1215 | <dt><strong><a name="item_locale_decode">$string = $term->locale_decode ($octets)</a></strong><br /> |
347 | </dt> |
1216 | </dt> |
348 | <dd> |
1217 | <dd> |
349 | Convert the given locale-encoded octets into a perl string. |
1218 | Convert the given locale-encoded octets into a perl string. |
350 | </dd> |
1219 | </dd> |
351 | <p></p> |
1220 | <p></p> |
|
|
1221 | <dt><strong><a name="item_scr_xor_span">$term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])</a></strong><br /> |
|
|
1222 | </dt> |
|
|
1223 | <dd> |
|
|
1224 | XORs the rendition values in the given span with the provided value |
|
|
1225 | (default: <code>RS_RVid</code>), which <em>MUST NOT</em> contain font styles. Useful in |
|
|
1226 | refresh hooks to provide effects similar to the selection. |
|
|
1227 | </dd> |
|
|
1228 | <p></p> |
|
|
1229 | <dt><strong><a name="item_scr_xor_rect">$term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])</a></strong><br /> |
|
|
1230 | </dt> |
|
|
1231 | <dd> |
|
|
1232 | Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing |
|
|
1233 | whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults |
|
|
1234 | to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines |
|
|
1235 | it instead. Both styles <em>MUST NOT</em> contain font styles. |
|
|
1236 | </dd> |
|
|
1237 | <p></p> |
|
|
1238 | <dt><strong><a name="item_scr_bell">$term->scr_bell</a></strong><br /> |
|
|
1239 | </dt> |
|
|
1240 | <dd> |
|
|
1241 | Ring the bell! |
|
|
1242 | </dd> |
|
|
1243 | <p></p> |
|
|
1244 | <dt><strong><a name="item_scr_add_lines">$term->scr_add_lines ($string)</a></strong><br /> |
|
|
1245 | </dt> |
|
|
1246 | <dd> |
|
|
1247 | Write the given text string to the screen, as if output by the application |
|
|
1248 | running inside the terminal. It may not contain command sequences (escape |
|
|
1249 | codes), but is free to use line feeds, carriage returns and tabs. The |
|
|
1250 | string is a normal text string, not in locale-dependent encoding. |
|
|
1251 | </dd> |
|
|
1252 | <dd> |
|
|
1253 | <p>Normally its not a good idea to use this function, as programs might be |
|
|
1254 | confused by changes in cursor position or scrolling. Its useful inside a |
|
|
1255 | <code>on_add_lines</code> hook, though.</p> |
|
|
1256 | </dd> |
|
|
1257 | <p></p> |
|
|
1258 | <dt><strong><a name="item_scr_change_screen">$term->scr_change_screen ($screen)</a></strong><br /> |
|
|
1259 | </dt> |
|
|
1260 | <dd> |
|
|
1261 | Switch to given screen - 0 primary, 1 secondary. |
|
|
1262 | </dd> |
|
|
1263 | <p></p> |
|
|
1264 | <dt><strong><a name="item_cmd_parse">$term->cmd_parse ($octets)</a></strong><br /> |
|
|
1265 | </dt> |
|
|
1266 | <dd> |
|
|
1267 | Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the |
|
|
1268 | locale-specific encoding of the terminal and can contain command sequences |
|
|
1269 | (escape codes) that will be interpreted. |
|
|
1270 | </dd> |
|
|
1271 | <p></p> |
352 | <dt><strong><a name="item_tt_write">$term->tt_write ($octets)</a></strong><br /> |
1272 | <dt><strong><a name="item_tt_write">$term->tt_write ($octets)</a></strong><br /> |
353 | </dt> |
1273 | </dt> |
354 | <dd> |
1274 | <dd> |
355 | Write the octets given in <code>$data</code> to the tty (i.e. as program input). To |
1275 | Write the octets given in <code>$data</code> to the tty (i.e. as program input). To |
356 | pass characters instead of octets, you should convetr you strings first to |
1276 | pass characters instead of octets, you should convert your strings first |
357 | the locale-specific encoding using <a href="#item_locale_encode"><code>$term->locale_encode</code></a>. |
1277 | to the locale-specific encoding using <a href="#item_locale_encode"><code>$term->locale_encode</code></a>. |
|
|
1278 | </dd> |
|
|
1279 | <p></p> |
|
|
1280 | <dt><strong><a name="item_pty_ev_events">$old_events = $term->pty_ev_events ([$new_events])</a></strong><br /> |
|
|
1281 | </dt> |
|
|
1282 | <dd> |
|
|
1283 | Replaces the event mask of the pty watcher by the given event mask. Can |
|
|
1284 | be used to suppress input and output handling to the pty/tty. See the |
|
|
1285 | description of <a href="#item_events"><code>urxvt::timer->events</code></a>. Make sure to always restore |
|
|
1286 | the previous value. |
|
|
1287 | </dd> |
|
|
1288 | <p></p> |
|
|
1289 | <dt><strong><a name="item_pty_fd">$fd = $term->pty_fd</a></strong><br /> |
|
|
1290 | </dt> |
|
|
1291 | <dd> |
|
|
1292 | Returns the master file descriptor for the pty in use, or <code>-1</code> if no pty |
|
|
1293 | is used. |
|
|
1294 | </dd> |
|
|
1295 | <p></p> |
|
|
1296 | <dt><strong><a name="item_parent">$windowid = $term->parent</a></strong><br /> |
|
|
1297 | </dt> |
|
|
1298 | <dd> |
|
|
1299 | Return the window id of the toplevel window. |
|
|
1300 | </dd> |
|
|
1301 | <p></p> |
|
|
1302 | <dt><strong><a name="item_vt">$windowid = $term->vt</a></strong><br /> |
|
|
1303 | </dt> |
|
|
1304 | <dd> |
|
|
1305 | Return the window id of the terminal window. |
|
|
1306 | </dd> |
|
|
1307 | <p></p> |
|
|
1308 | <dt><strong><a name="item_vt_emask_add">$term->vt_emask_add ($x_event_mask)</a></strong><br /> |
|
|
1309 | </dt> |
|
|
1310 | <dd> |
|
|
1311 | Adds the specified events to the vt event mask. Useful e.g. when you want |
|
|
1312 | to receive pointer events all the times: |
|
|
1313 | </dd> |
|
|
1314 | <dd> |
|
|
1315 | <pre> |
|
|
1316 | $term->vt_emask_add (urxvt::PointerMotionMask);</pre> |
|
|
1317 | </dd> |
|
|
1318 | <p></p> |
|
|
1319 | <dt><strong><a name="item_focus_in">$term->focus_in</a></strong><br /> |
|
|
1320 | </dt> |
|
|
1321 | <dt><strong><a name="item_focus_out">$term->focus_out</a></strong><br /> |
|
|
1322 | </dt> |
|
|
1323 | <dt><strong><a name="item_key_press">$term->key_press ($state, $keycode[, $time])</a></strong><br /> |
|
|
1324 | </dt> |
|
|
1325 | <dt><strong><a name="item_key_release">$term->key_release ($state, $keycode[, $time])</a></strong><br /> |
|
|
1326 | </dt> |
|
|
1327 | <dd> |
|
|
1328 | Deliver various fake events to to terminal. |
|
|
1329 | </dd> |
|
|
1330 | <p></p> |
|
|
1331 | <dt><strong><a name="item_width">$window_width = $term->width</a></strong><br /> |
|
|
1332 | </dt> |
|
|
1333 | <dt><strong><a name="item_height">$window_height = $term->height</a></strong><br /> |
|
|
1334 | </dt> |
|
|
1335 | <dt><strong><a name="item_fwidth">$font_width = $term->fwidth</a></strong><br /> |
|
|
1336 | </dt> |
|
|
1337 | <dt><strong><a name="item_fheight">$font_height = $term->fheight</a></strong><br /> |
|
|
1338 | </dt> |
|
|
1339 | <dt><strong><a name="item_fbase">$font_ascent = $term->fbase</a></strong><br /> |
|
|
1340 | </dt> |
|
|
1341 | <dt><strong><a name="item_nrow">$terminal_rows = $term->nrow</a></strong><br /> |
|
|
1342 | </dt> |
|
|
1343 | <dt><strong><a name="item_ncol">$terminal_columns = $term->ncol</a></strong><br /> |
|
|
1344 | </dt> |
|
|
1345 | <dt><strong><a name="item_focus">$has_focus = $term->focus</a></strong><br /> |
|
|
1346 | </dt> |
|
|
1347 | <dt><strong><a name="item_mapped">$is_mapped = $term->mapped</a></strong><br /> |
|
|
1348 | </dt> |
|
|
1349 | <dt><strong><a name="item_savelines">$max_scrollback = $term->saveLines</a></strong><br /> |
|
|
1350 | </dt> |
|
|
1351 | <dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term->total_rows</a></strong><br /> |
|
|
1352 | </dt> |
|
|
1353 | <dt><strong><a name="item_top_row">$topmost_scrollback_row = $term->top_row</a></strong><br /> |
|
|
1354 | </dt> |
|
|
1355 | <dd> |
|
|
1356 | Return various integers describing terminal characteristics. |
|
|
1357 | </dd> |
|
|
1358 | <p></p> |
|
|
1359 | <dt><strong><a name="item_display_id">$x_display = $term->display_id</a></strong><br /> |
|
|
1360 | </dt> |
|
|
1361 | <dd> |
|
|
1362 | Return the DISPLAY used by rxvt-unicode. |
|
|
1363 | </dd> |
|
|
1364 | <p></p> |
|
|
1365 | <dt><strong><a name="item_locale">$lc_ctype = $term->locale</a></strong><br /> |
|
|
1366 | </dt> |
|
|
1367 | <dd> |
|
|
1368 | Returns the LC_CTYPE category string used by this rxvt-unicode. |
|
|
1369 | </dd> |
|
|
1370 | <p></p> |
|
|
1371 | <dt><strong><a name="item_env">$env = $term->env</a></strong><br /> |
|
|
1372 | </dt> |
|
|
1373 | <dd> |
|
|
1374 | Returns a copy of the environment in effect for the terminal as a hashref |
|
|
1375 | similar to <code>\%ENV</code>. |
|
|
1376 | </dd> |
|
|
1377 | <p></p> |
|
|
1378 | <dt><strong><a name="item_modlevel3mask">$modifiermask = $term->ModLevel3Mask</a></strong><br /> |
|
|
1379 | </dt> |
|
|
1380 | <dt><strong><a name="item_modmetamask">$modifiermask = $term->ModMetaMask</a></strong><br /> |
|
|
1381 | </dt> |
|
|
1382 | <dt><strong><a name="item_modnumlockmask">$modifiermask = $term->ModNumLockMask</a></strong><br /> |
|
|
1383 | </dt> |
|
|
1384 | <dd> |
|
|
1385 | Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often |
|
|
1386 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
|
|
1387 | </dd> |
|
|
1388 | <p></p> |
|
|
1389 | <dt><strong><a name="item_current_screen">$screen = $term->current_screen</a></strong><br /> |
|
|
1390 | </dt> |
|
|
1391 | <dd> |
|
|
1392 | Returns the currently displayed screen (0 primary, 1 secondary). |
|
|
1393 | </dd> |
|
|
1394 | <p></p> |
|
|
1395 | <dt><strong><a name="item_hidden_cursor">$cursor_is_hidden = $term->hidden_cursor</a></strong><br /> |
|
|
1396 | </dt> |
|
|
1397 | <dd> |
|
|
1398 | Returns wether the cursor is currently hidden or not. |
|
|
1399 | </dd> |
|
|
1400 | <p></p> |
|
|
1401 | <dt><strong><a name="item_view_start">$view_start = $term->view_start ([$newvalue])</a></strong><br /> |
|
|
1402 | </dt> |
|
|
1403 | <dd> |
|
|
1404 | Returns the row number of the topmost displayed line. Maximum value is |
|
|
1405 | <code>0</code>, which displays the normal terminal contents. Lower values scroll |
|
|
1406 | this many lines into the scrollback buffer. |
|
|
1407 | </dd> |
|
|
1408 | <p></p> |
|
|
1409 | <dt><strong><a name="item_want_refresh">$term->want_refresh</a></strong><br /> |
|
|
1410 | </dt> |
|
|
1411 | <dd> |
|
|
1412 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
|
|
1413 | compare the on-screen display with its stored representation. If they |
|
|
1414 | differ, it redraws the differences. |
|
|
1415 | </dd> |
|
|
1416 | <dd> |
|
|
1417 | <p>Used after changing terminal contents to display them.</p> |
|
|
1418 | </dd> |
|
|
1419 | <p></p> |
|
|
1420 | <dt><strong><a name="item_row_t">$text = $term->ROW_t ($row_number[, $new_text[, $start_col]])</a></strong><br /> |
|
|
1421 | </dt> |
|
|
1422 | <dd> |
|
|
1423 | Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code> |
|
|
1424 | is the topmost terminal line, row <code>$term->$ncol-1</code> is the bottommost |
|
|
1425 | terminal line. The scrollback buffer starts at line <code>-1</code> and extends to |
|
|
1426 | line <code>-$term->nsaved</code>. Nothing will be returned if a nonexistent line |
|
|
1427 | is requested. |
|
|
1428 | </dd> |
|
|
1429 | <dd> |
|
|
1430 | <p>If <code>$new_text</code> is specified, it will replace characters in the current |
|
|
1431 | line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful |
|
|
1432 | to replace only parts of a line. The font index in the rendition will |
|
|
1433 | automatically be updated.</p> |
|
|
1434 | </dd> |
|
|
1435 | <dd> |
|
|
1436 | <p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more |
|
|
1437 | than one cell when displayed are padded with <code>$urxvt::NOCHAR</code> (chr 65535) |
|
|
1438 | characters. Characters with combining characters and other characters that |
|
|
1439 | do not fit into the normal tetx encoding will be replaced with characters |
|
|
1440 | in the private use area.</p> |
|
|
1441 | </dd> |
|
|
1442 | <dd> |
|
|
1443 | <p>You have to obey this encoding when changing text. The advantage is |
|
|
1444 | that <code>substr</code> and similar functions work on screen cells and not on |
|
|
1445 | characters.</p> |
|
|
1446 | </dd> |
|
|
1447 | <dd> |
|
|
1448 | <p>The methods <a href="#item_special_encode"><code>$term->special_encode</code></a> and <a href="#item_special_decode"><code>$term->special_decode</code></a> |
|
|
1449 | can be used to convert normal strings into this encoding and vice versa.</p> |
|
|
1450 | </dd> |
|
|
1451 | <p></p> |
|
|
1452 | <dt><strong><a name="item_row_r">$rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br /> |
|
|
1453 | </dt> |
|
|
1454 | <dd> |
|
|
1455 | Like <a href="#item_row_t"><code>$term->ROW_t</code></a>, but returns an arrayref with rendition |
|
|
1456 | bitsets. Rendition bitsets contain information about colour, font, font |
|
|
1457 | styles and similar information. See also <a href="#item_row_t"><code>$term->ROW_t</code></a>. |
|
|
1458 | </dd> |
|
|
1459 | <dd> |
|
|
1460 | <p>When setting rendition, the font mask will be ignored.</p> |
|
|
1461 | </dd> |
|
|
1462 | <dd> |
|
|
1463 | <p>See the section on RENDITION, above.</p> |
|
|
1464 | </dd> |
|
|
1465 | <p></p> |
|
|
1466 | <dt><strong><a name="item_row_l">$length = $term->ROW_l ($row_number[, $new_length])</a></strong><br /> |
|
|
1467 | </dt> |
|
|
1468 | <dd> |
|
|
1469 | Returns the number of screen cells that are in use (``the line |
|
|
1470 | length''). Unlike the urxvt core, this returns <a href="#item_ncol"><code>$term->ncol</code></a> if the |
|
|
1471 | line is joined with the following one. |
|
|
1472 | </dd> |
|
|
1473 | <p></p> |
|
|
1474 | <dt><strong><a name="item_is_longer">$bool = $term->is_longer ($row_number)</a></strong><br /> |
|
|
1475 | </dt> |
|
|
1476 | <dd> |
|
|
1477 | Returns true if the row is part of a multiple-row logical ``line'' (i.e. |
|
|
1478 | joined with the following row), which means all characters are in use |
|
|
1479 | and it is continued on the next row (and possibly a continuation of the |
|
|
1480 | previous row(s)). |
|
|
1481 | </dd> |
|
|
1482 | <p></p> |
|
|
1483 | <dt><strong><a name="item_line">$line = $term->line ($row_number)</a></strong><br /> |
|
|
1484 | </dt> |
|
|
1485 | <dd> |
|
|
1486 | Create and return a new <code>urxvt::line</code> object that stores information |
|
|
1487 | about the logical line that row <code>$row_number</code> is part of. It supports the |
|
|
1488 | following methods: |
|
|
1489 | </dd> |
|
|
1490 | <dl> |
|
|
1491 | <dt><strong><a name="item_t">$text = $line->t ([$new_text])</a></strong><br /> |
|
|
1492 | </dt> |
|
|
1493 | <dd> |
|
|
1494 | Returns or replaces the full text of the line, similar to <a href="#item_row_t"><code>ROW_t</code></a> |
|
|
1495 | </dd> |
|
|
1496 | <p></p> |
|
|
1497 | <dt><strong><a name="item_r">$rend = $line->r ([$new_rend])</a></strong><br /> |
|
|
1498 | </dt> |
|
|
1499 | <dd> |
|
|
1500 | Returns or replaces the full rendition array of the line, similar to <a href="#item_row_r"><code>ROW_r</code></a> |
|
|
1501 | </dd> |
|
|
1502 | <p></p> |
|
|
1503 | <dt><strong><a name="item_l">$length = $line->l</a></strong><br /> |
|
|
1504 | </dt> |
|
|
1505 | <dd> |
|
|
1506 | Returns the length of the line in cells, similar to <a href="#item_row_l"><code>ROW_l</code></a>. |
|
|
1507 | </dd> |
|
|
1508 | <p></p> |
|
|
1509 | <dt><strong><a name="item_beg">$rownum = $line->beg</a></strong><br /> |
|
|
1510 | </dt> |
|
|
1511 | <dt><strong><a name="item_end">$rownum = $line->end</a></strong><br /> |
|
|
1512 | </dt> |
|
|
1513 | <dd> |
|
|
1514 | Return the row number of the first/last row of the line, respectively. |
|
|
1515 | </dd> |
|
|
1516 | <p></p> |
|
|
1517 | <dt><strong><a name="item_offset_of">$offset = $line->offset_of ($row, $col)</a></strong><br /> |
|
|
1518 | </dt> |
|
|
1519 | <dd> |
|
|
1520 | Returns the character offset of the given row|col pair within the logical |
|
|
1521 | line. Works for rows outside the line, too, and returns corresponding |
|
|
1522 | offsets outside the string. |
|
|
1523 | </dd> |
|
|
1524 | <p></p> |
|
|
1525 | <dt><strong><a name="item_coord_of">($row, $col) = $line->coord_of ($offset)</a></strong><br /> |
|
|
1526 | </dt> |
|
|
1527 | <dd> |
|
|
1528 | Translates a string offset into terminal coordinates again. |
|
|
1529 | </dd> |
|
|
1530 | <p></p></dl> |
|
|
1531 | <dt><strong><a name="item_special_encode">$text = $term->special_encode $string</a></strong><br /> |
|
|
1532 | </dt> |
|
|
1533 | <dd> |
|
|
1534 | Converts a perl string into the special encoding used by rxvt-unicode, |
|
|
1535 | where one character corresponds to one screen cell. See |
|
|
1536 | <a href="#item_row_t"><code>$term->ROW_t</code></a> for details. |
|
|
1537 | </dd> |
|
|
1538 | <p></p> |
|
|
1539 | <dt><strong><a name="item_special_decode">$string = $term->special_decode $text</a></strong><br /> |
|
|
1540 | </dt> |
|
|
1541 | <dd> |
|
|
1542 | Converts rxvt-unicodes text reprsentation into a perl string. See |
|
|
1543 | <a href="#item_row_t"><code>$term->ROW_t</code></a> for details. |
|
|
1544 | </dd> |
|
|
1545 | <p></p> |
|
|
1546 | <dt><strong><a name="item_grab_button">$success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])</a></strong><br /> |
|
|
1547 | </dt> |
|
|
1548 | <dt><strong><a name="item_ungrab_button">$term->ungrab_button ($button, $modifiermask[, $window = $term->vt])</a></strong><br /> |
|
|
1549 | </dt> |
|
|
1550 | <dd> |
|
|
1551 | Register/unregister a synchronous button grab. See the XGrabButton |
|
|
1552 | manpage. |
|
|
1553 | </dd> |
|
|
1554 | <p></p> |
|
|
1555 | <dt><strong><a name="item_grab">$success = $term->grab ($eventtime[, $sync])</a></strong><br /> |
|
|
1556 | </dt> |
|
|
1557 | <dd> |
|
|
1558 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
|
|
1559 | synchronous (<code>$sync</code> is true). Also remembers the grab timestampe. |
|
|
1560 | </dd> |
|
|
1561 | <p></p> |
|
|
1562 | <dt><strong><a name="item_allow_events_async">$term->allow_events_async</a></strong><br /> |
|
|
1563 | </dt> |
|
|
1564 | <dd> |
|
|
1565 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
|
|
1566 | </dd> |
|
|
1567 | <p></p> |
|
|
1568 | <dt><strong><a name="item_allow_events_sync">$term->allow_events_sync</a></strong><br /> |
|
|
1569 | </dt> |
|
|
1570 | <dd> |
|
|
1571 | Calls XAllowEvents with SyncBoth for the most recent grab. |
|
|
1572 | </dd> |
|
|
1573 | <p></p> |
|
|
1574 | <dt><strong><a name="item_allow_events_replay">$term->allow_events_replay</a></strong><br /> |
|
|
1575 | </dt> |
|
|
1576 | <dd> |
|
|
1577 | Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most |
|
|
1578 | recent grab. |
|
|
1579 | </dd> |
|
|
1580 | <p></p> |
|
|
1581 | <dt><strong><a name="item_ungrab">$term->ungrab</a></strong><br /> |
|
|
1582 | </dt> |
|
|
1583 | <dd> |
|
|
1584 | Calls XUngrab for the most recent grab. Is called automatically on |
|
|
1585 | evaluation errors, as it is better to lose the grab in the error case as |
|
|
1586 | the session. |
|
|
1587 | </dd> |
|
|
1588 | <p></p> |
|
|
1589 | <dt><strong><a name="item_xinternatom">$atom = $term->XInternAtom ($atom_name[, $only_if_exists])</a></strong><br /> |
|
|
1590 | </dt> |
|
|
1591 | <dt><strong><a name="item_xgetatomname">$atom_name = $term->XGetAtomName ($atom)</a></strong><br /> |
|
|
1592 | </dt> |
|
|
1593 | <dt><strong><a name="item_xlistproperties">@atoms = $term->XListProperties ($window)</a></strong><br /> |
|
|
1594 | </dt> |
|
|
1595 | <dt><strong><a name="item_xgetwindowproperty">($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)</a></strong><br /> |
|
|
1596 | </dt> |
|
|
1597 | <dt><strong><a name="item_xchangewindowproperty">$term->XChangeWindowProperty ($window, $property, $type, $format, $octets)</a></strong><br /> |
|
|
1598 | </dt> |
|
|
1599 | <dt><strong><a name="item_xdeleteproperty">$term->XDeleteProperty ($window, $property)</a></strong><br /> |
|
|
1600 | </dt> |
|
|
1601 | <dt><strong><a name="item_defaultrootwindow">$window = $term->DefaultRootWindow</a></strong><br /> |
|
|
1602 | </dt> |
|
|
1603 | <dt><strong><a name="item_xreparentwindow">$term->XReparentWindow ($window, $parent, [$x, $y])</a></strong><br /> |
|
|
1604 | </dt> |
|
|
1605 | <dt><strong><a name="item_xmapwindow">$term->XMapWindow ($window)</a></strong><br /> |
|
|
1606 | </dt> |
|
|
1607 | <dt><strong><a name="item_xunmapwindow">$term->XUnmapWindow ($window)</a></strong><br /> |
|
|
1608 | </dt> |
|
|
1609 | <dt><strong><a name="item_xmoveresizewindow">$term->XMoveResizeWindow ($window, $x, $y, $width, $height)</a></strong><br /> |
|
|
1610 | </dt> |
|
|
1611 | <dt><strong><a name="item_xtranslatecoordinates">($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)</a></strong><br /> |
|
|
1612 | </dt> |
|
|
1613 | <dt><strong><a name="item_xchangeinput">$term->XChangeInput ($window, $add_events[, $del_events])</a></strong><br /> |
|
|
1614 | </dt> |
|
|
1615 | <dd> |
|
|
1616 | Various X or X-related functions. The <code>$term</code> object only serves as |
|
|
1617 | the source of the display, otherwise those functions map more-or-less |
|
|
1618 | directory onto the X functions of the same name. |
|
|
1619 | </dd> |
|
|
1620 | <p></p></dl> |
|
|
1621 | <p> |
|
|
1622 | </p> |
|
|
1623 | <h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> |
|
|
1624 | <dl> |
|
|
1625 | <dt><strong><a name="item_add_title">$popup->add_title ($title)</a></strong><br /> |
|
|
1626 | </dt> |
|
|
1627 | <dd> |
|
|
1628 | Adds a non-clickable title to the popup. |
|
|
1629 | </dd> |
|
|
1630 | <p></p> |
|
|
1631 | <dt><strong><a name="item_add_separator">$popup->add_separator ([$sepchr])</a></strong><br /> |
|
|
1632 | </dt> |
|
|
1633 | <dd> |
|
|
1634 | Creates a separator, optionally using the character given as <code>$sepchr</code>. |
|
|
1635 | </dd> |
|
|
1636 | <p></p> |
|
|
1637 | <dt><strong><a name="item_add_button">$popup->add_button ($text, $cb)</a></strong><br /> |
|
|
1638 | </dt> |
|
|
1639 | <dd> |
|
|
1640 | Adds a clickable button to the popup. <code>$cb</code> is called whenever it is |
|
|
1641 | selected. |
|
|
1642 | </dd> |
|
|
1643 | <p></p> |
|
|
1644 | <dt><strong><a name="item_add_toggle">$popup->add_toggle ($text, $cb, $initial_value)</a></strong><br /> |
|
|
1645 | </dt> |
|
|
1646 | <dd> |
|
|
1647 | Adds a toggle/checkbox item to the popup. Teh callback gets called |
|
|
1648 | whenever it gets toggled, with a boolean indicating its value as its first |
|
|
1649 | argument. |
|
|
1650 | </dd> |
|
|
1651 | <p></p> |
|
|
1652 | <dt><strong>$popup->show</strong><br /> |
|
|
1653 | </dt> |
|
|
1654 | <dd> |
|
|
1655 | Displays the popup (which is initially hidden). |
358 | </dd> |
1656 | </dd> |
359 | <p></p></dl> |
1657 | <p></p></dl> |
360 | <p> |
1658 | <p> |
361 | </p> |
1659 | </p> |
362 | <h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> |
1660 | <h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> |
363 | <p>This class implements timer watchers/events. Time is represented as a |
1661 | <p>This class implements timer watchers/events. Time is represented as a |
364 | fractional number of seconds since the epoch. Example:</p> |
1662 | fractional number of seconds since the epoch. Example:</p> |
365 | <pre> |
1663 | <pre> |
366 | # create a digital clock display in upper right corner |
1664 | $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0); |
367 | $term->{timer} = urxvt::timer |
1665 | $term->{timer} = urxvt::timer |
368 | ->new |
1666 | ->new |
369 | ->start (urxvt::NOW) |
1667 | ->interval (1) |
370 | ->cb (sub { |
1668 | ->cb (sub { |
371 | my ($timer) = @_; |
|
|
372 | my $time = $timer->at; |
|
|
373 | $timer->start ($time + 1); |
|
|
374 | $self->scr_overlay (-1, 0, |
1669 | $term->{overlay}->set (0, 0, |
375 | POSIX::strftime "%H:%M:%S", localtime $time); |
1670 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
376 | });</pre> |
1671 | });</pre> |
377 | <dl> |
1672 | <dl> |
378 | <dt><strong><a name="item__24timer__3d_new_urxvt_3a_3atimer">$timer = new urxvt::timer</a></strong><br /> |
1673 | <dt><strong><a name="item__24timer__3d_new_urxvt_3a_3atimer">$timer = new urxvt::timer</a></strong><br /> |
379 | </dt> |
1674 | </dt> |
380 | <dd> |
1675 | <dd> |
381 | Create a new timer object in stopped state. |
1676 | Create a new timer object in started state. It is scheduled to fire |
|
|
1677 | immediately. |
382 | </dd> |
1678 | </dd> |
383 | <p></p> |
1679 | <p></p> |
384 | <dt><strong><a name="item_cb">$timer = $timer->cb (sub { my ($timer) = @_; ... })</a></strong><br /> |
1680 | <dt><strong><a name="item_cb">$timer = $timer->cb (sub { my ($timer) = @_; ... })</a></strong><br /> |
385 | </dt> |
1681 | </dt> |
386 | <dd> |
1682 | <dd> |
… | |
… | |
391 | </dt> |
1687 | </dt> |
392 | <dd> |
1688 | <dd> |
393 | Return the time this watcher will fire next. |
1689 | Return the time this watcher will fire next. |
394 | </dd> |
1690 | </dd> |
395 | <p></p> |
1691 | <p></p> |
396 | <dt><strong><a name="item_set">$timer = $timer->set ($tstamp)</a></strong><br /> |
1692 | <dt><strong>$timer = $timer->set ($tstamp)</strong><br /> |
397 | </dt> |
1693 | </dt> |
398 | <dd> |
1694 | <dd> |
399 | Set the time the event is generated to $tstamp. |
1695 | Set the time the event is generated to $tstamp. |
400 | </dd> |
1696 | </dd> |
401 | <p></p> |
1697 | <p></p> |
|
|
1698 | <dt><strong><a name="item_interval">$timer = $timer->interval ($interval)</a></strong><br /> |
|
|
1699 | </dt> |
|
|
1700 | <dd> |
|
|
1701 | Normally (and when <code>$interval</code> is <code>0</code>), the timer will automatically |
|
|
1702 | stop after it has fired once. If <code>$interval</code> is non-zero, then the timer |
|
|
1703 | is automatically rescheduled at the given intervals. |
|
|
1704 | </dd> |
|
|
1705 | <p></p> |
402 | <dt><strong><a name="item_start">$timer = $timer->start</a></strong><br /> |
1706 | <dt><strong><a name="item_start">$timer = $timer->start</a></strong><br /> |
403 | </dt> |
1707 | </dt> |
404 | <dd> |
1708 | <dd> |
405 | Start the timer. |
1709 | Start the timer. |
406 | </dd> |
1710 | </dd> |
407 | <p></p> |
1711 | <p></p> |
408 | <dt><strong>$timer = $timer->start ($tstamp)</strong><br /> |
1712 | <dt><strong>$timer = $timer->start ($tstamp)</strong><br /> |
409 | </dt> |
1713 | </dt> |
410 | <dd> |
1714 | <dd> |
411 | Set the event trigger time to <code>$tstamp</code> and start the timer. |
1715 | Set the event trigger time to <code>$tstamp</code> and start the timer. |
|
|
1716 | </dd> |
|
|
1717 | <p></p> |
|
|
1718 | <dt><strong><a name="item_after">$timer = $timer->after ($delay)</a></strong><br /> |
|
|
1719 | </dt> |
|
|
1720 | <dd> |
|
|
1721 | Like <a href="#item_start"><code>start</code></a>, but sets the expiry timer to c<urxvt::NOW + $delay>. |
412 | </dd> |
1722 | </dd> |
413 | <p></p> |
1723 | <p></p> |
414 | <dt><strong><a name="item_stop">$timer = $timer->stop</a></strong><br /> |
1724 | <dt><strong><a name="item_stop">$timer = $timer->stop</a></strong><br /> |
415 | </dt> |
1725 | </dt> |
416 | <dd> |
1726 | <dd> |
… | |
… | |
424 | <pre> |
1734 | <pre> |
425 | $term->{socket} = ... |
1735 | $term->{socket} = ... |
426 | $term->{iow} = urxvt::iow |
1736 | $term->{iow} = urxvt::iow |
427 | ->new |
1737 | ->new |
428 | ->fd (fileno $term->{socket}) |
1738 | ->fd (fileno $term->{socket}) |
429 | ->events (1) # wait for read data |
1739 | ->events (urxvt::EVENT_READ) |
430 | ->start |
1740 | ->start |
431 | ->cb (sub { |
1741 | ->cb (sub { |
432 | my ($iow, $revents) = @_; |
1742 | my ($iow, $revents) = @_; |
433 | # $revents must be 1 here, no need to check |
1743 | # $revents must be 1 here, no need to check |
434 | sysread $term->{socket}, my $buf, 8192 |
1744 | sysread $term->{socket}, my $buf, 8192 |
… | |
… | |
455 | </dd> |
1765 | </dd> |
456 | <p></p> |
1766 | <p></p> |
457 | <dt><strong><a name="item_events">$iow = $iow->events ($eventmask)</a></strong><br /> |
1767 | <dt><strong><a name="item_events">$iow = $iow->events ($eventmask)</a></strong><br /> |
458 | </dt> |
1768 | </dt> |
459 | <dd> |
1769 | <dd> |
460 | Set the event mask to watch. Bit #0 (value <code>1</code>) enables watching for read |
1770 | Set the event mask to watch. The only allowed values are |
461 | data, Bit #1 (value <code>2</code>) enables watching for write data. |
1771 | <code>urxvt::EVENT_READ</code> and <code>urxvt::EVENT_WRITE</code>, which might be ORed |
|
|
1772 | together, or <code>urxvt::EVENT_NONE</code>. |
462 | </dd> |
1773 | </dd> |
463 | <p></p> |
1774 | <p></p> |
464 | <dt><strong>$iow = $iow->start</strong><br /> |
1775 | <dt><strong>$iow = $iow->start</strong><br /> |
465 | </dt> |
1776 | </dt> |
466 | <dd> |
1777 | <dd> |
… | |
… | |
469 | <p></p> |
1780 | <p></p> |
470 | <dt><strong>$iow = $iow->stop</strong><br /> |
1781 | <dt><strong>$iow = $iow->stop</strong><br /> |
471 | </dt> |
1782 | </dt> |
472 | <dd> |
1783 | <dd> |
473 | Stop watching for events on the given filehandle. |
1784 | Stop watching for events on the given filehandle. |
|
|
1785 | </dd> |
|
|
1786 | <p></p></dl> |
|
|
1787 | <p> |
|
|
1788 | </p> |
|
|
1789 | <h2><a name="the_urxvt__iw_class">The <code>urxvt::iw</code> Class</a></h2> |
|
|
1790 | <p>This class implements idle watchers, that get called automatically when |
|
|
1791 | the process is idle. They should return as fast as possible, after doing |
|
|
1792 | some useful work.</p> |
|
|
1793 | <dl> |
|
|
1794 | <dt><strong><a name="item__24iw__3d_new_urxvt_3a_3aiw">$iw = new urxvt::iw</a></strong><br /> |
|
|
1795 | </dt> |
|
|
1796 | <dd> |
|
|
1797 | Create a new idle watcher object in stopped state. |
|
|
1798 | </dd> |
|
|
1799 | <p></p> |
|
|
1800 | <dt><strong>$iw = $iw->cb (sub { my ($iw) = @_; ... })</strong><br /> |
|
|
1801 | </dt> |
|
|
1802 | <dd> |
|
|
1803 | Set the callback to be called when the watcher triggers. |
|
|
1804 | </dd> |
|
|
1805 | <p></p> |
|
|
1806 | <dt><strong>$timer = $timer->start</strong><br /> |
|
|
1807 | </dt> |
|
|
1808 | <dd> |
|
|
1809 | Start the watcher. |
|
|
1810 | </dd> |
|
|
1811 | <p></p> |
|
|
1812 | <dt><strong>$timer = $timer->stop</strong><br /> |
|
|
1813 | </dt> |
|
|
1814 | <dd> |
|
|
1815 | Stop the watcher. |
|
|
1816 | </dd> |
|
|
1817 | <p></p></dl> |
|
|
1818 | <p> |
|
|
1819 | </p> |
|
|
1820 | <h2><a name="the_urxvt__pw_class">The <code>urxvt::pw</code> Class</a></h2> |
|
|
1821 | <p>This class implements process watchers. They create an event whenever a |
|
|
1822 | process exits, after which they stop automatically.</p> |
|
|
1823 | <pre> |
|
|
1824 | my $pid = fork; |
|
|
1825 | ... |
|
|
1826 | $term->{pw} = urxvt::pw |
|
|
1827 | ->new |
|
|
1828 | ->start ($pid) |
|
|
1829 | ->cb (sub { |
|
|
1830 | my ($pw, $exit_status) = @_; |
|
|
1831 | ... |
|
|
1832 | });</pre> |
|
|
1833 | <dl> |
|
|
1834 | <dt><strong><a name="item__24pw__3d_new_urxvt_3a_3apw">$pw = new urxvt::pw</a></strong><br /> |
|
|
1835 | </dt> |
|
|
1836 | <dd> |
|
|
1837 | Create a new process watcher in stopped state. |
|
|
1838 | </dd> |
|
|
1839 | <p></p> |
|
|
1840 | <dt><strong>$pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })</strong><br /> |
|
|
1841 | </dt> |
|
|
1842 | <dd> |
|
|
1843 | Set the callback to be called when the timer triggers. |
|
|
1844 | </dd> |
|
|
1845 | <p></p> |
|
|
1846 | <dt><strong>$pw = $timer->start ($pid)</strong><br /> |
|
|
1847 | </dt> |
|
|
1848 | <dd> |
|
|
1849 | Tells the wqtcher to start watching for process <code>$pid</code>. |
|
|
1850 | </dd> |
|
|
1851 | <p></p> |
|
|
1852 | <dt><strong>$pw = $pw->stop</strong><br /> |
|
|
1853 | </dt> |
|
|
1854 | <dd> |
|
|
1855 | Stop the watcher. |
474 | </dd> |
1856 | </dd> |
475 | <p></p></dl> |
1857 | <p></p></dl> |
476 | <p> |
1858 | <p> |
477 | </p> |
1859 | </p> |
478 | <hr /> |
1860 | <hr /> |
… | |
… | |
480 | <p> |
1862 | <p> |
481 | </p> |
1863 | </p> |
482 | <h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> |
1864 | <h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> |
483 | <p>This variable controls the verbosity level of the perl extension. Higher |
1865 | <p>This variable controls the verbosity level of the perl extension. Higher |
484 | numbers indicate more verbose output.</p> |
1866 | numbers indicate more verbose output.</p> |
485 | <ol> |
1867 | <dl> |
486 | <li><strong><a name="item__2d_only_fatal_messages">- only fatal messages</a></strong><br /> |
1868 | <dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br /> |
487 | </li> |
1869 | </dt> |
488 | <li><strong><a name="item__2d_script_loading_and_management">- script loading and management</a></strong><br /> |
1870 | <dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">>= 3 - script loading and management</a></strong><br /> |
|
|
1871 | </dt> |
|
|
1872 | <dt><strong><a name="item__3e_3d10__2d_all_called_hooks">>=10 - all called hooks</a></strong><br /> |
|
|
1873 | </dt> |
|
|
1874 | <dt><strong><a name="item__3e_3d11__2d_hook_reutrn_values">>=11 - hook reutrn values</a></strong><br /> |
|
|
1875 | </dt> |
489 | </li> |
1876 | </dl> |
490 | <li><strong><a name="item__2d_all_events_received">- all events received</a></strong><br /> |
|
|
491 | </li> |
|
|
492 | </ol> |
|
|
493 | <p> |
1877 | <p> |
494 | </p> |
1878 | </p> |
495 | <hr /> |
1879 | <hr /> |
496 | <h1><a name="author">AUTHOR</a></h1> |
1880 | <h1><a name="author">AUTHOR</a></h1> |
497 | <pre> |
1881 | <pre> |