… | |
… | |
17 | <li><a href="#description">DESCRIPTION</a></li> |
17 | <li><a href="#description">DESCRIPTION</a></li> |
18 | <ul> |
18 | <ul> |
19 | |
19 | |
20 | <li><a href="#prepackaged_extensions">Prepackaged Extensions</a></li> |
20 | <li><a href="#prepackaged_extensions">Prepackaged Extensions</a></li> |
21 | <li><a href="#general_api_considerations">General API Considerations</a></li> |
21 | <li><a href="#general_api_considerations">General API Considerations</a></li> |
|
|
22 | <li><a href="#extension_objects">Extension Objects</a></li> |
22 | <li><a href="#hooks">Hooks</a></li> |
23 | <li><a href="#hooks">Hooks</a></li> |
23 | <li><a href="#variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></li> |
24 | <li><a href="#variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></li> |
24 | <li><a href="#functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></li> |
25 | <li><a href="#functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></li> |
25 | <li><a href="#rendition">RENDITION</a></li> |
26 | <li><a href="#rendition">RENDITION</a></li> |
|
|
27 | <li><a href="#the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></li> |
26 | <li><a href="#the_urxvt__term_class">The <code>urxvt::term</code> Class</a></li> |
28 | <li><a href="#the_urxvt__term_class">The <code>urxvt::term</code> Class</a></li> |
|
|
29 | <li><a href="#the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></li> |
27 | <li><a href="#the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></li> |
30 | <li><a href="#the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></li> |
28 | <li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li> |
31 | <li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li> |
29 | </ul> |
32 | </ul> |
30 | |
33 | |
31 | <li><a href="#environment">ENVIRONMENT</a></li> |
34 | <li><a href="#environment">ENVIRONMENT</a></li> |
… | |
… | |
61 | rxvt --perl-lib $HOME -pe grab_test</pre> |
64 | rxvt --perl-lib $HOME -pe grab_test</pre> |
62 | <p> |
65 | <p> |
63 | </p> |
66 | </p> |
64 | <hr /> |
67 | <hr /> |
65 | <h1><a name="description">DESCRIPTION</a></h1> |
68 | <h1><a name="description">DESCRIPTION</a></h1> |
66 | <p>Everytime a terminal object gets created, scripts specified via the |
69 | <p>Everytime a terminal object gets created, extension scripts specified via |
67 | <code>perl</code> resource are loaded and associated with it.</p> |
70 | the <code>perl</code> resource are loaded and associated with it.</p> |
68 | <p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and |
71 | <p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and |
69 | thus must be encoded as UTF-8.</p> |
72 | thus must be encoded as UTF-8.</p> |
70 | <p>Each script will only ever be loaded once, even in rxvtd, where |
73 | <p>Each script will only ever be loaded once, even in rxvtd, where |
71 | scripts will be shared (but not enabled) for all terminals.</p> |
74 | scripts will be shared (but not enabled) for all terminals.</p> |
72 | <p> |
75 | <p> |
… | |
… | |
76 | find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> |
79 | find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> |
77 | <p>You can activate them like this:</p> |
80 | <p>You can activate them like this:</p> |
78 | <pre> |
81 | <pre> |
79 | rxvt -pe <extensionname></pre> |
82 | rxvt -pe <extensionname></pre> |
80 | <dl> |
83 | <dl> |
81 | <dt><strong><a name="item_selection">selection</a></strong><br /> |
84 | <dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br /> |
82 | </dt> |
85 | </dt> |
83 | <dd> |
86 | <dd> |
84 | Intelligent selection. This extension tries to be more intelligent when |
87 | Intelligent selection. This extension tries to be more intelligent when |
85 | the user extends selections (double-click). Right now, it tries to select |
88 | the user extends selections (double-click). Right now, it tries to select |
86 | urls and complete shell-quoted arguments, which is very convenient, too, |
89 | urls and complete shell-quoted arguments, which is very convenient, too, |
… | |
… | |
98 | <dd> |
101 | <dd> |
99 | <pre> |
102 | <pre> |
100 | URxvt.keysym.C-M-r: perl:selection:rot13</pre> |
103 | URxvt.keysym.C-M-r: perl:selection:rot13</pre> |
101 | </dd> |
104 | </dd> |
102 | <p></p></dl> |
105 | <p></p></dl> |
|
|
106 | <dt><strong><a name="item_popup">option-popup (enabled by default)</a></strong><br /> |
|
|
107 | </dt> |
|
|
108 | <dd> |
|
|
109 | Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at |
|
|
110 | runtime. |
|
|
111 | </dd> |
|
|
112 | <p></p> |
|
|
113 | <dt><strong>selection-popup (enabled by default)</strong><br /> |
|
|
114 | </dt> |
|
|
115 | <dd> |
|
|
116 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
|
|
117 | text into various other formats/action. |
|
|
118 | </dd> |
|
|
119 | <p></p> |
|
|
120 | <dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback<hotkey> (enabled by default)</a></strong><br /> |
|
|
121 | </dt> |
|
|
122 | <dd> |
|
|
123 | Adds regex search functionality to the scrollback buffer, triggered |
|
|
124 | by a hotkey (default: <code>M-s</code>). When in search mode, normal terminal |
|
|
125 | input/output is suspended. |
|
|
126 | </dd> |
|
|
127 | <dd> |
|
|
128 | <p><code>/</code> starts an incremental regex search, <code>n</code> searches further, <code>p</code> or |
|
|
129 | <code>N</code> jump to the previous match, <code>G</code> jumps to the bottom and clears the |
|
|
130 | history, <code>enter</code> leaves search mode at the current position and <code>escape</code> |
|
|
131 | returns to the original position.</p> |
|
|
132 | </dd> |
|
|
133 | <p></p> |
103 | <dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> |
134 | <dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> |
104 | </dt> |
135 | </dt> |
105 | <dd> |
136 | <dd> |
106 | Displays a digital clock using the built-in overlay. |
137 | Displays a digital clock using the built-in overlay. |
|
|
138 | </dd> |
|
|
139 | <p></p> |
|
|
140 | <dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> |
|
|
141 | </dt> |
|
|
142 | <dd> |
|
|
143 | Uses per-line display filtering (<code>on_line_update</code>) to underline urls. |
|
|
144 | </dd> |
|
|
145 | <p></p> |
|
|
146 | <dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br /> |
|
|
147 | </dt> |
|
|
148 | <dd> |
|
|
149 | A not very useful example of filtering all text output to the terminal, |
|
|
150 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
|
|
151 | similar-looking ascii character. |
107 | </dd> |
152 | </dd> |
108 | <p></p> |
153 | <p></p> |
109 | <dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> |
154 | <dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> |
110 | </dt> |
155 | </dt> |
111 | <dd> |
156 | <dd> |
… | |
… | |
124 | modified).</p> |
169 | modified).</p> |
125 | <p>When objects are destroyed on the C++ side, the perl object hashes are |
170 | <p>When objects are destroyed on the C++ side, the perl object hashes are |
126 | emptied, so its best to store related objects such as time watchers and |
171 | emptied, so its best to store related objects such as time watchers and |
127 | the like inside the terminal object so they get destroyed as soon as the |
172 | the like inside the terminal object so they get destroyed as soon as the |
128 | terminal is destroyed.</p> |
173 | terminal is destroyed.</p> |
|
|
174 | <p>Argument names also often indicate the type of a parameter. Here are some |
|
|
175 | hints on what they mean:</p> |
|
|
176 | <dl> |
|
|
177 | <dt><strong><a name="item__24text">$text</a></strong><br /> |
|
|
178 | </dt> |
|
|
179 | <dd> |
|
|
180 | Rxvt-unicodes special way of encoding text, where one ``unicode'' character |
|
|
181 | always represents one screen cell. See <em>row_t</em> for a discussion of this format. |
|
|
182 | </dd> |
|
|
183 | <p></p> |
|
|
184 | <dt><strong><a name="item__24string">$string</a></strong><br /> |
|
|
185 | </dt> |
|
|
186 | <dd> |
|
|
187 | A perl text string, with an emphasis on <em>text</em>. It can store all unicode |
|
|
188 | characters and is to be distinguished with text encoded in a specific |
|
|
189 | encoding (often locale-specific) and binary data. |
|
|
190 | </dd> |
|
|
191 | <p></p> |
|
|
192 | <dt><strong><a name="item__24octets">$octets</a></strong><br /> |
|
|
193 | </dt> |
|
|
194 | <dd> |
|
|
195 | Either binary data or - more common - a text string encoded in a |
|
|
196 | locale-specific way. |
|
|
197 | </dd> |
|
|
198 | <p></p></dl> |
|
|
199 | <p> |
|
|
200 | </p> |
|
|
201 | <h2><a name="extension_objects">Extension Objects</a></h2> |
|
|
202 | <p>Very perl extension is a perl class. A separate perl object is created |
|
|
203 | for each terminal and each extension and passed as the first parameter to |
|
|
204 | hooks. So extensions can use their <code>$self</code> object without having to think |
|
|
205 | about other extensions, with the exception of methods and members that |
|
|
206 | begin with an underscore character <code>_</code>: these are reserved for internal |
|
|
207 | use.</p> |
|
|
208 | <p>Although it isn't a <code>urxvt::term</code> object, you can call all methods of the |
|
|
209 | <code>urxvt::term</code> class on this object.</p> |
|
|
210 | <p>It has the following methods and data members:</p> |
|
|
211 | <dl> |
|
|
212 | <dt><strong><a name="item__24urxvt_term__3d__24self_2d_3e_7bterm_7d">$urxvt_term = $self->{term}</a></strong><br /> |
|
|
213 | </dt> |
|
|
214 | <dd> |
|
|
215 | Returns the <code>urxvt::term</code> object associated with this instance of the |
|
|
216 | extension. This member <em>must not</em> be changed in any way. |
|
|
217 | </dd> |
|
|
218 | <p></p> |
|
|
219 | <dt><strong><a name="item_enable">$self->enable ($hook_name => $cb, [$hook_name => $cb..])</a></strong><br /> |
|
|
220 | </dt> |
|
|
221 | <dd> |
|
|
222 | Dynamically enable the given hooks (named without the <code>on_</code> prefix) for |
|
|
223 | this extension, replacing any previous hook. This is useful when you want |
|
|
224 | to overwrite time-critical hooks only temporarily. |
|
|
225 | </dd> |
|
|
226 | <p></p> |
|
|
227 | <dt><strong><a name="item_disable">$self->disable ($hook_name[, $hook_name..])</a></strong><br /> |
|
|
228 | </dt> |
|
|
229 | <dd> |
|
|
230 | Dynamically disable the given hooks. |
|
|
231 | </dd> |
|
|
232 | <p></p></dl> |
129 | <p> |
233 | <p> |
130 | </p> |
234 | </p> |
131 | <h2><a name="hooks">Hooks</a></h2> |
235 | <h2><a name="hooks">Hooks</a></h2> |
132 | <p>The following subroutines can be declared in loaded scripts, and will be |
236 | <p>The following subroutines can be declared in extension files, and will be |
133 | called whenever the relevant event happens.</p> |
237 | called whenever the relevant event happens.</p> |
134 | <p>The first argument passed to them is an object private to each terminal |
238 | <p>The first argument passed to them is an extension oject as described in |
135 | and extension package. You can call all <code>urxvt::term</code> methods on it, but |
239 | the in the <code>Extension Objects</code> section.</p> |
136 | its not a real <code>urxvt::term</code> object. Instead, the real <code>urxvt::term</code> |
|
|
137 | object that is shared between all packages is stored in the <code>term</code> |
|
|
138 | member.</p> |
|
|
139 | <p>All of them must return a boolean value. If it is true, then the event |
240 | <p><strong>All</strong> of these hooks must return a boolean value. If it is true, then the |
140 | counts as being <em>consumed</em>, and the invocation of other hooks is skipped, |
241 | event counts as being <em>consumed</em>, and the invocation of other hooks is |
141 | and the relevant action might not be carried out by the C++ code.</p> |
242 | skipped, and the relevant action might not be carried out by the C++ code.</p> |
142 | <p>When in doubt, return a false value (preferably <code>()</code>).</p> |
243 | <p><em>When in doubt, return a false value (preferably <code>()</code>). </em>></p> |
143 | <dl> |
244 | <dl> |
144 | <dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> |
245 | <dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> |
145 | </dt> |
246 | </dt> |
146 | <dd> |
247 | <dd> |
147 | Called after a new terminal object has been initialized, but before |
248 | Called after a new terminal object has been initialized, but before |
148 | windows are created or the command gets run. |
249 | windows are created or the command gets run. Most methods are unsafe to |
|
|
250 | call or deliver senseless data, as terminal size and other characteristics |
|
|
251 | have not yet been determined. You can safely query and change resources, |
|
|
252 | though. |
149 | </dd> |
253 | </dd> |
150 | <p></p> |
254 | <p></p> |
151 | <dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> |
255 | <dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> |
152 | </dt> |
256 | </dt> |
153 | <dd> |
257 | <dd> |
… | |
… | |
196 | </dd> |
300 | </dd> |
197 | <dd> |
301 | <dd> |
198 | <p>See the <em>selection</em> example extension.</p> |
302 | <p>See the <em>selection</em> example extension.</p> |
199 | </dd> |
303 | </dd> |
200 | <p></p> |
304 | <p></p> |
201 | <dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> |
|
|
202 | </dt> |
|
|
203 | <dd> |
|
|
204 | Called whenever the window gets the keyboard focus, before urxvt does |
|
|
205 | focus in processing. |
|
|
206 | </dd> |
|
|
207 | <p></p> |
|
|
208 | <dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong><br /> |
|
|
209 | </dt> |
|
|
210 | <dd> |
|
|
211 | Called wheneever the window loses keyboard focus, before urxvt does focus |
|
|
212 | out processing. |
|
|
213 | </dd> |
|
|
214 | <p></p> |
|
|
215 | <dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong><br /> |
305 | <dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong><br /> |
216 | </dt> |
306 | </dt> |
217 | <dd> |
307 | <dd> |
218 | Called whenever the view offset changes, i..e the user or program |
308 | Called whenever the view offset changes, i..e the user or program |
219 | scrolls. Offset <code>0</code> means display the normal terminal, positive values |
309 | scrolls. Offset <code>0</code> means display the normal terminal, positive values |
… | |
… | |
229 | </dd> |
319 | </dd> |
230 | <dd> |
320 | <dd> |
231 | <p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
321 | <p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
232 | $nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total |
322 | $nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total |
233 | number of lines that will be in the scrollback buffer.</p> |
323 | number of lines that will be in the scrollback buffer.</p> |
234 | </dd> |
|
|
235 | <p></p> |
|
|
236 | <dt><strong><a name="item_on_tty_activity__24term__2anyi_2a">on_tty_activity $term *NYI*</a></strong><br /> |
|
|
237 | </dt> |
|
|
238 | <dd> |
|
|
239 | Called whenever the <code>program(s)</code> running in the urxvt window send output. |
|
|
240 | </dd> |
324 | </dd> |
241 | <p></p> |
325 | <p></p> |
242 | <dt><strong><a name="item_on_osc_seq__24term_2c__24string">on_osc_seq $term, $string</a></strong><br /> |
326 | <dt><strong><a name="item_on_osc_seq__24term_2c__24string">on_osc_seq $term, $string</a></strong><br /> |
243 | </dt> |
327 | </dt> |
244 | <dd> |
328 | <dd> |
… | |
… | |
253 | <p>Be careful not ever to trust (in a security sense) the data you receive, |
337 | <p>Be careful not ever to trust (in a security sense) the data you receive, |
254 | as its source can not easily be controleld (e-mail content, messages from |
338 | as its source can not easily be controleld (e-mail content, messages from |
255 | other users on the same system etc.).</p> |
339 | other users on the same system etc.).</p> |
256 | </dd> |
340 | </dd> |
257 | <p></p> |
341 | <p></p> |
|
|
342 | <dt><strong><a name="item_on_add_lines__24term_2c__24string">on_add_lines $term, $string</a></strong><br /> |
|
|
343 | </dt> |
|
|
344 | <dd> |
|
|
345 | Called whenever text is about to be output, with the text as argument. You |
|
|
346 | can filter/change and output the text yourself by returning a true value |
|
|
347 | and calling <a href="#item_scr_add_lines"><code>$term->scr_add_lines</code></a> yourself. Please note that this |
|
|
348 | might be very slow, however, as your hook is called for <strong>all</strong> text being |
|
|
349 | output. |
|
|
350 | </dd> |
|
|
351 | <p></p> |
|
|
352 | <dt><strong><a name="item_on_tt_write__24term_2c__24octets">on_tt_write $term, $octets</a></strong><br /> |
|
|
353 | </dt> |
|
|
354 | <dd> |
|
|
355 | Called whenever some data is written to the tty/pty and can be used to |
|
|
356 | suppress or filter tty input. |
|
|
357 | </dd> |
|
|
358 | <p></p> |
|
|
359 | <dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong><br /> |
|
|
360 | </dt> |
|
|
361 | <dd> |
|
|
362 | Called whenever a line was updated or changed. Can be used to filter |
|
|
363 | screen output (e.g. underline urls or other useless stuff). Only lines |
|
|
364 | that are being shown will be filtered, and, due to performance reasons, |
|
|
365 | not always immediately. |
|
|
366 | </dd> |
|
|
367 | <dd> |
|
|
368 | <p>The row number is always the topmost row of the line if the line spans |
|
|
369 | multiple rows.</p> |
|
|
370 | </dd> |
|
|
371 | <dd> |
|
|
372 | <p>Please note that, if you change the line, then the hook might get called |
|
|
373 | later with the already-modified line (e.g. if unrelated parts change), so |
|
|
374 | you cannot just toggle rendition bits, but only set them.</p> |
|
|
375 | </dd> |
|
|
376 | <p></p> |
258 | <dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong><br /> |
377 | <dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong><br /> |
259 | </dt> |
378 | </dt> |
260 | <dd> |
379 | <dd> |
261 | Called just before the screen gets redrawn. Can be used for overlay |
380 | Called just before the screen gets redrawn. Can be used for overlay |
262 | or similar effects by modify terminal contents in refresh_begin, and |
381 | or similar effects by modify terminal contents in refresh_begin, and |
… | |
… | |
275 | <dd> |
394 | <dd> |
276 | Called whenever the user presses a key combination that has a |
395 | Called whenever the user presses a key combination that has a |
277 | <code>perl:string</code> action bound to it (see description of the <strong>keysym</strong> |
396 | <code>perl:string</code> action bound to it (see description of the <strong>keysym</strong> |
278 | resource in the <code>rxvt(1)</code> manpage). |
397 | resource in the <code>rxvt(1)</code> manpage). |
279 | </dd> |
398 | </dd> |
|
|
399 | <p></p> |
|
|
400 | <dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> |
|
|
401 | </dt> |
|
|
402 | <dd> |
|
|
403 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
|
|
404 | does focus in processing. |
|
|
405 | </dd> |
|
|
406 | <p></p> |
|
|
407 | <dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong><br /> |
|
|
408 | </dt> |
|
|
409 | <dd> |
|
|
410 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
|
|
411 | focus out processing. |
|
|
412 | </dd> |
|
|
413 | <p></p> |
|
|
414 | <dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a></strong><br /> |
|
|
415 | </dt> |
|
|
416 | <dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br /> |
|
|
417 | </dt> |
|
|
418 | <dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br /> |
|
|
419 | </dt> |
|
|
420 | <dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br /> |
|
|
421 | </dt> |
|
|
422 | <dt><strong><a name="item_on_motion_notify__24term_2c__24event">on_motion_notify $term, $event</a></strong><br /> |
|
|
423 | </dt> |
|
|
424 | <dt><strong><a name="item_on_map_notify__24term_2c__24event">on_map_notify $term, $event</a></strong><br /> |
|
|
425 | </dt> |
|
|
426 | <dt><strong><a name="item_on_unmap_notify__24term_2c__24event">on_unmap_notify $term, $event</a></strong><br /> |
|
|
427 | </dt> |
|
|
428 | <dd> |
|
|
429 | Called whenever the corresponding X event is received for the terminal If |
|
|
430 | the hook returns true, then the even will be ignored by rxvt-unicode. |
|
|
431 | </dd> |
|
|
432 | <dd> |
|
|
433 | <p>The event is a hash with most values as named by Xlib (see the XEvent |
|
|
434 | manpage), with the additional members <code>row</code> and <code>col</code>, which are the row |
|
|
435 | and column under the mouse cursor.</p> |
|
|
436 | </dd> |
|
|
437 | <dd> |
|
|
438 | <p><code>on_key_press</code> additionally receives the string rxvt-unicode would |
|
|
439 | output, if any, in locale-specific encoding.</p> |
|
|
440 | </dd> |
|
|
441 | <dd> |
|
|
442 | <p>subwindow.</p> |
|
|
443 | </dd> |
280 | <p></p></dl> |
444 | <p></p></dl> |
281 | <p> |
445 | <p> |
282 | </p> |
446 | </p> |
283 | <h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> |
447 | <h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> |
284 | <dl> |
448 | <dl> |
285 | <dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br /> |
449 | <dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br /> |
286 | </dt> |
450 | </dt> |
287 | <dd> |
451 | <dd> |
288 | The current terminal. Whenever a callback/Hook is bein executed, this |
452 | The current terminal. This variable stores the current <code>urxvt::term</code> |
289 | variable stores the current <code>urxvt::term</code> object. |
453 | object, whenever a callback/hook is executing. |
290 | </dd> |
454 | </dd> |
291 | <p></p></dl> |
455 | <p></p></dl> |
292 | <p> |
456 | <p> |
293 | </p> |
457 | </p> |
294 | <h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> |
458 | <h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> |
295 | <dl> |
459 | <dl> |
|
|
460 | <dt><strong><a name="item__24term__3d_new_urxvt__5barg_2e_2e_2e_5d">$term = new urxvt [arg...]</a></strong><br /> |
|
|
461 | </dt> |
|
|
462 | <dd> |
|
|
463 | Creates a new terminal, very similar as if you had started it with |
|
|
464 | <code>system $binfile, arg...</code>. Croaks (and probably outputs an error message) |
|
|
465 | if the new instance couldn't be created. Returns <code>undef</code> if the new |
|
|
466 | instance didn't initialise perl, and the terminal object otherwise. The |
|
|
467 | <code>init</code> and <a href="#item_start"><code>start</code></a> hooks will be called during the call. |
|
|
468 | </dd> |
|
|
469 | <p></p> |
296 | <dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br /> |
470 | <dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br /> |
297 | </dt> |
471 | </dt> |
298 | <dd> |
472 | <dd> |
299 | Fatally aborts execution with the given error message. Avoid at all |
473 | Fatally aborts execution with the given error message. Avoid at all |
300 | costs! The only time this is acceptable is when the terminal process |
474 | costs! The only time this is acceptable is when the terminal process |
… | |
… | |
311 | <dd> |
485 | <dd> |
312 | <p>Using this function has the advantage that its output ends up in the |
486 | <p>Using this function has the advantage that its output ends up in the |
313 | correct place, e.g. on stderr of the connecting urxvtc client.</p> |
487 | correct place, e.g. on stderr of the connecting urxvtc client.</p> |
314 | </dd> |
488 | </dd> |
315 | <p></p> |
489 | <p></p> |
|
|
490 | <dt><strong><a name="item__24is_safe__3d_urxvt_3a_3asafe">$is_safe = urxvt::safe</a></strong><br /> |
|
|
491 | </dt> |
|
|
492 | <dd> |
|
|
493 | Returns true when it is safe to do potentially unsafe things, such as |
|
|
494 | evaluating perl code specified by the user. This is true when urxvt was |
|
|
495 | started setuid or setgid. |
|
|
496 | </dd> |
|
|
497 | <p></p> |
316 | <dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> |
498 | <dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> |
317 | </dt> |
499 | </dt> |
318 | <dd> |
500 | <dd> |
319 | Returns the ``current time'' (as per the event loop). |
501 | Returns the ``current time'' (as per the event loop). |
|
|
502 | </dd> |
|
|
503 | <p></p> |
|
|
504 | <dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br /> |
|
|
505 | </dt> |
|
|
506 | <dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
|
|
507 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
|
|
508 | Button4Mask, Button5Mask, AnyModifier</a></strong><br /> |
|
|
509 | </dt> |
|
|
510 | <dd> |
|
|
511 | Various constants for use in X calls and event processing. |
320 | </dd> |
512 | </dd> |
321 | <p></p></dl> |
513 | <p></p></dl> |
322 | <p> |
514 | <p> |
323 | </p> |
515 | </p> |
324 | <h2><a name="rendition">RENDITION</a></h2> |
516 | <h2><a name="rendition">RENDITION</a></h2> |
… | |
… | |
381 | Change the custom value. |
573 | Change the custom value. |
382 | </dd> |
574 | </dd> |
383 | <p></p></dl> |
575 | <p></p></dl> |
384 | <p> |
576 | <p> |
385 | </p> |
577 | </p> |
|
|
578 | <h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2> |
|
|
579 | <p>The sole purpose of this class is to deliver an interface to the |
|
|
580 | <code>AnyEvent</code> module - any module using it will work inside urxvt without |
|
|
581 | further work. The only exception is that you cannot wait on condition |
|
|
582 | variables, but non-blocking condvar use is ok. What this means is that you |
|
|
583 | cannot use blocking APIs, but the non-blocking variant should work.</p> |
|
|
584 | <p> |
|
|
585 | </p> |
386 | <h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> |
586 | <h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> |
387 | <dl> |
587 | <dl> |
|
|
588 | <dt><strong><a name="item_destroy">$term->destroy</a></strong><br /> |
|
|
589 | </dt> |
|
|
590 | <dd> |
|
|
591 | Destroy the terminal object (close the window, free resources etc.). |
|
|
592 | </dd> |
|
|
593 | <p></p> |
|
|
594 | <dt><strong><a name="item_option">$isset = $term->option ($optval[, $set])</a></strong><br /> |
|
|
595 | </dt> |
|
|
596 | <dd> |
|
|
597 | Returns true if the option specified by <code>$optval</code> is enabled, and |
|
|
598 | optionally change it. All option values are stored by name in the hash |
|
|
599 | <code>%urxvt::OPTION</code>. Options not enabled in this binary are not in the hash. |
|
|
600 | </dd> |
|
|
601 | <dd> |
|
|
602 | <p>Here is a a likely non-exhaustive list of option names, please see the |
|
|
603 | source file <em>/src/optinc.h</em> to see the actual list:</p> |
|
|
604 | </dd> |
|
|
605 | <dd> |
|
|
606 | <pre> |
|
|
607 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
|
|
608 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
|
|
609 | pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating |
|
|
610 | scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer |
|
|
611 | secondaryScreen secondaryScroll skipBuiltinGlyphs transparent |
|
|
612 | tripleclickwords utmpInhibit visualBell</pre> |
|
|
613 | </dd> |
|
|
614 | <p></p> |
388 | <dt><strong><a name="item_resource">$value = $term->resource ($name[, $newval])</a></strong><br /> |
615 | <dt><strong><a name="item_resource">$value = $term->resource ($name[, $newval])</a></strong><br /> |
389 | </dt> |
616 | </dt> |
390 | <dd> |
617 | <dd> |
391 | Returns the current resource value associated with a given name and |
618 | Returns the current resource value associated with a given name and |
392 | optionally sets a new value. Setting values is most useful in the <code>init</code> |
619 | optionally sets a new value. Setting values is most useful in the <code>init</code> |
… | |
… | |
406 | <p>Please note that resource strings will currently only be freed when the |
633 | <p>Please note that resource strings will currently only be freed when the |
407 | terminal is destroyed, so changing options frequently will eat memory.</p> |
634 | terminal is destroyed, so changing options frequently will eat memory.</p> |
408 | </dd> |
635 | </dd> |
409 | <dd> |
636 | <dd> |
410 | <p>Here is a a likely non-exhaustive list of resource names, not all of which |
637 | <p>Here is a a likely non-exhaustive list of resource names, not all of which |
411 | are supported in every build, please see the source to see the actual |
638 | are supported in every build, please see the source file <em>/src/rsinc.h</em> |
412 | list:</p> |
639 | to see the actual list:</p> |
413 | </dd> |
640 | </dd> |
414 | <dd> |
641 | <dd> |
415 | <pre> |
642 | <pre> |
416 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
643 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
417 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
644 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
… | |
… | |
425 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
652 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
426 | shade term_name title transparent transparent_all tripleclickwords |
653 | shade term_name title transparent transparent_all tripleclickwords |
427 | utmpInhibit visualBell</pre> |
654 | utmpInhibit visualBell</pre> |
428 | </dd> |
655 | </dd> |
429 | <p></p> |
656 | <p></p> |
|
|
657 | <dt><strong><a name="item_parse_keysym">$success = $term->parse_keysym ($keysym_spec, $command_string)</a></strong><br /> |
|
|
658 | </dt> |
|
|
659 | <dd> |
|
|
660 | Adds a keymap translation exactly as specified via a resource. See the |
|
|
661 | <code>keysym</code> resource in the <code>rxvt(1)</code> manpage. |
|
|
662 | </dd> |
|
|
663 | <p></p> |
430 | <dt><strong><a name="item_screen_rstyle">$rend = $term->screen_rstyle ([$new_rstyle])</a></strong><br /> |
664 | <dt><strong><a name="item_rstyle">$rend = $term->rstyle ([$new_rstyle])</a></strong><br /> |
431 | </dt> |
665 | </dt> |
432 | <dd> |
666 | <dd> |
433 | Return and optionally change the current rendition. Text thta is output by |
667 | Return and optionally change the current rendition. Text that is output by |
434 | the temrianl application will use this style. |
668 | the terminal application will use this style. |
435 | </dd> |
669 | </dd> |
436 | <p></p> |
670 | <p></p> |
437 | <dt><strong><a name="item_screen_cur">($row, $col) = $term->screen_cur ([$row, $col])</a></strong><br /> |
671 | <dt><strong><a name="item_screen_cur">($row, $col) = $term->screen_cur ([$row, $col])</a></strong><br /> |
438 | </dt> |
672 | </dt> |
439 | <dd> |
673 | <dd> |
… | |
… | |
462 | <dt><strong>$oldtext = $term->selection ([$newtext])</strong><br /> |
696 | <dt><strong>$oldtext = $term->selection ([$newtext])</strong><br /> |
463 | </dt> |
697 | </dt> |
464 | <dd> |
698 | <dd> |
465 | Return the current selection text and optionally replace it by <code>$newtext</code>. |
699 | Return the current selection text and optionally replace it by <code>$newtext</code>. |
466 | </dd> |
700 | </dd> |
|
|
701 | <p></p> |
|
|
702 | <dt><strong><a name="item_overlay_simple">$term->overlay_simple ($x, $y, $text)</a></strong><br /> |
|
|
703 | </dt> |
467 | <dd> |
704 | <dd> |
468 | <p>#=item $term->overlay ($x, $y, $text) |
|
|
469 | # |
|
|
470 | #Create a simple multi-line overlay box. See the next method for details. |
705 | Create a simple multi-line overlay box. See the next method for details. |
471 | # |
|
|
472 | #=cut</p> |
|
|
473 | </dd> |
|
|
474 | <dd> |
|
|
475 | <p>sub urxvt::term::scr_overlay { |
|
|
476 | die; |
|
|
477 | my ($self, $x, $y, $text) = @_;</p> |
|
|
478 | </dd> |
|
|
479 | <dd> |
|
|
480 | <pre> |
|
|
481 | my @lines = split /\n/, $text;</pre> |
|
|
482 | </dd> |
|
|
483 | <dd> |
|
|
484 | <pre> |
|
|
485 | my $w = 0; |
|
|
486 | for (map $self->strwidth ($_), @lines) { |
|
|
487 | $w = $_ if $w < $_; |
|
|
488 | }</pre> |
|
|
489 | </dd> |
|
|
490 | <dd> |
|
|
491 | <pre> |
|
|
492 | $self->scr_overlay_new ($x, $y, $w, scalar @lines); |
|
|
493 | $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; |
|
|
494 | }</pre> |
|
|
495 | </dd> |
706 | </dd> |
496 | <p></p> |
707 | <p></p> |
497 | <dt><strong><a name="item_overlay">$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br /> |
708 | <dt><strong><a name="item_overlay">$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br /> |
498 | </dt> |
709 | </dt> |
499 | <dd> |
710 | <dd> |
… | |
… | |
535 | </dt> |
746 | </dt> |
536 | <dd> |
747 | <dd> |
537 | If hidden, display the overlay again. |
748 | If hidden, display the overlay again. |
538 | </dd> |
749 | </dd> |
539 | <p></p></dl> |
750 | <p></p></dl> |
|
|
751 | <dt><strong>$popup = $term->popup ($event)</strong><br /> |
|
|
752 | </dt> |
|
|
753 | <dd> |
|
|
754 | Creates a new <code>urxvt::popup</code> object that implements a popup menu. The |
|
|
755 | <code>$event</code> <em>must</em> be the event causing the menu to pop up (a button event, |
|
|
756 | currently). |
|
|
757 | </dd> |
|
|
758 | <p></p> |
540 | <dt><strong><a name="item_strwidth">$cellwidth = $term->strwidth $string</a></strong><br /> |
759 | <dt><strong><a name="item_strwidth">$cellwidth = $term->strwidth ($string)</a></strong><br /> |
541 | </dt> |
760 | </dt> |
542 | <dd> |
761 | <dd> |
543 | Returns the number of screen-cells this string would need. Correctly |
762 | Returns the number of screen-cells this string would need. Correctly |
544 | accounts for wide and combining characters. |
763 | accounts for wide and combining characters. |
545 | </dd> |
764 | </dd> |
546 | <p></p> |
765 | <p></p> |
547 | <dt><strong><a name="item_locale_encode">$octets = $term->locale_encode $string</a></strong><br /> |
766 | <dt><strong><a name="item_locale_encode">$octets = $term->locale_encode ($string)</a></strong><br /> |
548 | </dt> |
767 | </dt> |
549 | <dd> |
768 | <dd> |
550 | Convert the given text string into the corresponding locale encoding. |
769 | Convert the given text string into the corresponding locale encoding. |
551 | </dd> |
770 | </dd> |
552 | <p></p> |
771 | <p></p> |
553 | <dt><strong><a name="item_locale_decode">$string = $term->locale_decode $octets</a></strong><br /> |
772 | <dt><strong><a name="item_locale_decode">$string = $term->locale_decode ($octets)</a></strong><br /> |
554 | </dt> |
773 | </dt> |
555 | <dd> |
774 | <dd> |
556 | Convert the given locale-encoded octets into a perl string. |
775 | Convert the given locale-encoded octets into a perl string. |
|
|
776 | </dd> |
|
|
777 | <p></p> |
|
|
778 | <dt><strong><a name="item_scr_xor_span">$term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])</a></strong><br /> |
|
|
779 | </dt> |
|
|
780 | <dd> |
|
|
781 | XORs the rendition values in the given span with the provided value |
|
|
782 | (default: <code>RS_RVid</code>). Useful in refresh hooks to provide effects similar |
|
|
783 | to the selection. |
|
|
784 | </dd> |
|
|
785 | <p></p> |
|
|
786 | <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 /> |
|
|
787 | </dt> |
|
|
788 | <dd> |
|
|
789 | Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing |
|
|
790 | whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults |
|
|
791 | to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines |
|
|
792 | it instead. |
|
|
793 | </dd> |
|
|
794 | <p></p> |
|
|
795 | <dt><strong><a name="item_scr_bell">$term->scr_bell</a></strong><br /> |
|
|
796 | </dt> |
|
|
797 | <dd> |
|
|
798 | Ring the bell! |
|
|
799 | </dd> |
|
|
800 | <p></p> |
|
|
801 | <dt><strong><a name="item_scr_add_lines">$term->scr_add_lines ($string)</a></strong><br /> |
|
|
802 | </dt> |
|
|
803 | <dd> |
|
|
804 | Write the given text string to the screen, as if output by the application |
|
|
805 | running inside the terminal. It may not contain command sequences (escape |
|
|
806 | codes), but is free to use line feeds, carriage returns and tabs. The |
|
|
807 | string is a normal text string, not in locale-dependent encoding. |
|
|
808 | </dd> |
|
|
809 | <dd> |
|
|
810 | <p>Normally its not a good idea to use this function, as programs might be |
|
|
811 | confused by changes in cursor position or scrolling. Its useful inside a |
|
|
812 | <code>on_add_lines</code> hook, though.</p> |
|
|
813 | </dd> |
|
|
814 | <p></p> |
|
|
815 | <dt><strong><a name="item_cmd_parse">$term->cmd_parse ($octets)</a></strong><br /> |
|
|
816 | </dt> |
|
|
817 | <dd> |
|
|
818 | Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the |
|
|
819 | locale-specific encoding of the terminal and can contain command sequences |
|
|
820 | (escape codes) that will be interpreted. |
557 | </dd> |
821 | </dd> |
558 | <p></p> |
822 | <p></p> |
559 | <dt><strong><a name="item_tt_write">$term->tt_write ($octets)</a></strong><br /> |
823 | <dt><strong><a name="item_tt_write">$term->tt_write ($octets)</a></strong><br /> |
560 | </dt> |
824 | </dt> |
561 | <dd> |
825 | <dd> |
562 | Write the octets given in <code>$data</code> to the tty (i.e. as program input). To |
826 | Write the octets given in <code>$data</code> to the tty (i.e. as program input). To |
563 | pass characters instead of octets, you should convert your strings first |
827 | pass characters instead of octets, you should convert your strings first |
564 | to the locale-specific encoding using <a href="#item_locale_encode"><code>$term->locale_encode</code></a>. |
828 | to the locale-specific encoding using <a href="#item_locale_encode"><code>$term->locale_encode</code></a>. |
565 | </dd> |
829 | </dd> |
566 | <p></p> |
830 | <p></p> |
|
|
831 | <dt><strong><a name="item_pty_ev_events">$old_events = $term->pty_ev_events ([$new_events])</a></strong><br /> |
|
|
832 | </dt> |
|
|
833 | <dd> |
|
|
834 | Replaces the event mask of the pty watcher by the given event mask. Can |
|
|
835 | be used to suppress input and output handling to the pty/tty. See the |
|
|
836 | description of <a href="#item_events"><code>urxvt::timer->events</code></a>. Make sure to always restore |
|
|
837 | the previous value. |
|
|
838 | </dd> |
|
|
839 | <p></p> |
|
|
840 | <dt><strong><a name="item_parent">$windowid = $term->parent</a></strong><br /> |
|
|
841 | </dt> |
|
|
842 | <dd> |
|
|
843 | Return the window id of the toplevel window. |
|
|
844 | </dd> |
|
|
845 | <p></p> |
|
|
846 | <dt><strong><a name="item_vt">$windowid = $term->vt</a></strong><br /> |
|
|
847 | </dt> |
|
|
848 | <dd> |
|
|
849 | Return the window id of the terminal window. |
|
|
850 | </dd> |
|
|
851 | <p></p> |
567 | <dt><strong><a name="item_width">$window_width = $term->width</a></strong><br /> |
852 | <dt><strong><a name="item_width">$window_width = $term->width</a></strong><br /> |
568 | </dt> |
853 | </dt> |
569 | <dt><strong><a name="item_height">$window_height = $term->height</a></strong><br /> |
854 | <dt><strong><a name="item_height">$window_height = $term->height</a></strong><br /> |
570 | </dt> |
855 | </dt> |
571 | <dt><strong><a name="item_fwidth">$font_width = $term->fwidth</a></strong><br /> |
856 | <dt><strong><a name="item_fwidth">$font_width = $term->fwidth</a></strong><br /> |
… | |
… | |
588 | </dt> |
873 | </dt> |
589 | <dt><strong><a name="item_nsaved">$lines_in_scrollback = $term->nsaved</a></strong><br /> |
874 | <dt><strong><a name="item_nsaved">$lines_in_scrollback = $term->nsaved</a></strong><br /> |
590 | </dt> |
875 | </dt> |
591 | <dd> |
876 | <dd> |
592 | Return various integers describing terminal characteristics. |
877 | Return various integers describing terminal characteristics. |
|
|
878 | </dd> |
|
|
879 | <p></p> |
|
|
880 | <dt><strong><a name="item_locale">$lc_ctype = $term->locale</a></strong><br /> |
|
|
881 | </dt> |
|
|
882 | <dd> |
|
|
883 | Returns the LC_CTYPE category string used by this rxvt-unicode. |
|
|
884 | </dd> |
|
|
885 | <p></p> |
|
|
886 | <dt><strong><a name="item_display_id">$x_display = $term->display_id</a></strong><br /> |
|
|
887 | </dt> |
|
|
888 | <dd> |
|
|
889 | Return the DISPLAY used by rxvt-unicode. |
|
|
890 | </dd> |
|
|
891 | <p></p> |
|
|
892 | <dt><strong><a name="item_modlevel3mask">$modifiermask = $term->ModLevel3Mask</a></strong><br /> |
|
|
893 | </dt> |
|
|
894 | <dt><strong><a name="item_modmetamask">$modifiermask = $term->ModMetaMask</a></strong><br /> |
|
|
895 | </dt> |
|
|
896 | <dt><strong><a name="item_modnumlockmask">$modifiermask = $term->ModNumLockMask</a></strong><br /> |
|
|
897 | </dt> |
|
|
898 | <dd> |
|
|
899 | Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often |
|
|
900 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
593 | </dd> |
901 | </dd> |
594 | <p></p> |
902 | <p></p> |
595 | <dt><strong><a name="item_view_start">$view_start = $term->view_start ([$newvalue])</a></strong><br /> |
903 | <dt><strong><a name="item_view_start">$view_start = $term->view_start ([$newvalue])</a></strong><br /> |
596 | </dt> |
904 | </dt> |
597 | <dd> |
905 | <dd> |
… | |
… | |
625 | line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful |
933 | line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful |
626 | to replace only parts of a line. The font index in the rendition will |
934 | to replace only parts of a line. The font index in the rendition will |
627 | automatically be updated.</p> |
935 | automatically be updated.</p> |
628 | </dd> |
936 | </dd> |
629 | <dd> |
937 | <dd> |
630 | <p><code>$text</code> is in a special encoding: tabs and wide characters that use more |
938 | <p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more |
631 | than one cell when displayed are padded with urxvt::NOCHAR characters |
939 | than one cell when displayed are padded with urxvt::NOCHAR characters |
632 | (<code>chr 65535</code>). Characters with combining characters and other characters |
940 | (<code>chr 65535</code>). Characters with combining characters and other characters |
633 | that do not fit into the normal tetx encoding will be replaced with |
941 | that do not fit into the normal tetx encoding will be replaced with |
634 | characters in the private use area.</p> |
942 | characters in the private use area.</p> |
635 | </dd> |
943 | </dd> |
… | |
… | |
637 | <p>You have to obey this encoding when changing text. The advantage is |
945 | <p>You have to obey this encoding when changing text. The advantage is |
638 | that <code>substr</code> and similar functions work on screen cells and not on |
946 | that <code>substr</code> and similar functions work on screen cells and not on |
639 | characters.</p> |
947 | characters.</p> |
640 | </dd> |
948 | </dd> |
641 | <dd> |
949 | <dd> |
642 | <p>The methods <code>$term->special_encode</code> and <a href="#item_special_decode"><code>$term->special_decode</code></a> |
950 | <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> |
643 | can be used to convert normal strings into this encoding and vice versa.</p> |
951 | can be used to convert normal strings into this encoding and vice versa.</p> |
644 | </dd> |
952 | </dd> |
645 | <p></p> |
953 | <p></p> |
646 | <dt><strong><a name="item_row_r">$rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br /> |
954 | <dt><strong><a name="item_row_r">$rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br /> |
647 | </dt> |
955 | </dt> |
… | |
… | |
680 | Create and return a new <code>urxvt::line</code> object that stores information |
988 | Create and return a new <code>urxvt::line</code> object that stores information |
681 | about the logical line that row <code>$row_number</code> is part of. It supports the |
989 | about the logical line that row <code>$row_number</code> is part of. It supports the |
682 | following methods: |
990 | following methods: |
683 | </dd> |
991 | </dd> |
684 | <dl> |
992 | <dl> |
685 | <dt><strong><a name="item_t">$text = $line->t</a></strong><br /> |
993 | <dt><strong><a name="item_t">$text = $line->t ([$new_text])</a></strong><br /> |
686 | </dt> |
994 | </dt> |
687 | <dd> |
995 | <dd> |
688 | Returns the full text of the line, similar to <a href="#item_row_t"><code>ROW_t</code></a> |
996 | Returns or replaces the full text of the line, similar to <a href="#item_row_t"><code>ROW_t</code></a> |
689 | </dd> |
997 | </dd> |
690 | <p></p> |
998 | <p></p> |
691 | <dt><strong><a name="item_r">$rend = $line->r</a></strong><br /> |
999 | <dt><strong><a name="item_r">$rend = $line->r ([$new_rend])</a></strong><br /> |
692 | </dt> |
1000 | </dt> |
693 | <dd> |
1001 | <dd> |
694 | Returns the full rendition array of the line, similar to <a href="#item_row_r"><code>ROW_r</code></a> |
1002 | Returns or replaces the full rendition array of the line, similar to <a href="#item_row_r"><code>ROW_r</code></a> |
695 | </dd> |
1003 | </dd> |
696 | <p></p> |
1004 | <p></p> |
697 | <dt><strong><a name="item_l">$length = $line->l</a></strong><br /> |
1005 | <dt><strong><a name="item_l">$length = $line->l</a></strong><br /> |
698 | </dt> |
1006 | </dt> |
699 | <dd> |
1007 | <dd> |
… | |
… | |
719 | </dt> |
1027 | </dt> |
720 | <dd> |
1028 | <dd> |
721 | Translates a string offset into terminal coordinates again. |
1029 | Translates a string offset into terminal coordinates again. |
722 | </dd> |
1030 | </dd> |
723 | <p></p></dl> |
1031 | <p></p></dl> |
724 | <dt><strong>($row, $col) = $line->coord_of ($offset) |
1032 | <dt><strong><a name="item_special_encode">$text = $term->special_encode $string</a></strong><br /> |
725 | =item $text = $term->special_encode $string</strong><br /> |
|
|
726 | </dt> |
1033 | </dt> |
727 | <dd> |
1034 | <dd> |
728 | Converts a perl string into the special encoding used by rxvt-unicode, |
1035 | Converts a perl string into the special encoding used by rxvt-unicode, |
729 | where one character corresponds to one screen cell. See |
1036 | where one character corresponds to one screen cell. See |
730 | <a href="#item_row_t"><code>$term->ROW_t</code></a> for details. |
1037 | <a href="#item_row_t"><code>$term->ROW_t</code></a> for details. |
… | |
… | |
734 | </dt> |
1041 | </dt> |
735 | <dd> |
1042 | <dd> |
736 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1043 | Converts rxvt-unicodes text reprsentation into a perl string. See |
737 | <a href="#item_row_t"><code>$term->ROW_t</code></a> for details. |
1044 | <a href="#item_row_t"><code>$term->ROW_t</code></a> for details. |
738 | </dd> |
1045 | </dd> |
|
|
1046 | <p></p> |
|
|
1047 | <dt><strong><a name="item_grab_button">$success = $term->grab_button ($button, $modifiermask)</a></strong><br /> |
|
|
1048 | </dt> |
|
|
1049 | <dd> |
|
|
1050 | Registers a synchronous button grab. See the XGrabButton manpage. |
|
|
1051 | </dd> |
|
|
1052 | <p></p> |
|
|
1053 | <dt><strong><a name="item_grab">$success = $term->grab ($eventtime[, $sync])</a></strong><br /> |
|
|
1054 | </dt> |
|
|
1055 | <dd> |
|
|
1056 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
|
|
1057 | synchronous (<code>$sync</code> is true). Also remembers the grab timestampe. |
|
|
1058 | </dd> |
|
|
1059 | <p></p> |
|
|
1060 | <dt><strong><a name="item_allow_events_async">$term->allow_events_async</a></strong><br /> |
|
|
1061 | </dt> |
|
|
1062 | <dd> |
|
|
1063 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
|
|
1064 | </dd> |
|
|
1065 | <p></p> |
|
|
1066 | <dt><strong><a name="item_allow_events_sync">$term->allow_events_sync</a></strong><br /> |
|
|
1067 | </dt> |
|
|
1068 | <dd> |
|
|
1069 | Calls XAllowEvents with SyncBoth for the most recent grab. |
|
|
1070 | </dd> |
|
|
1071 | <p></p> |
|
|
1072 | <dt><strong><a name="item_allow_events_replay">$term->allow_events_replay</a></strong><br /> |
|
|
1073 | </dt> |
|
|
1074 | <dd> |
|
|
1075 | Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most |
|
|
1076 | recent grab. |
|
|
1077 | </dd> |
|
|
1078 | <p></p> |
|
|
1079 | <dt><strong><a name="item_ungrab">$term->ungrab</a></strong><br /> |
|
|
1080 | </dt> |
|
|
1081 | <dd> |
|
|
1082 | Calls XUngrab for the most recent grab. Is called automatically on |
|
|
1083 | evaluation errors, as it is better to lose the grab in the error case as |
|
|
1084 | the session. |
|
|
1085 | </dd> |
739 | <p></p></dl> |
1086 | <p></p></dl> |
|
|
1087 | <p> |
|
|
1088 | </p> |
|
|
1089 | <h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> |
740 | <p> |
1090 | <p> |
741 | </p> |
1091 | </p> |
742 | <h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> |
1092 | <h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> |
743 | <p>This class implements timer watchers/events. Time is represented as a |
1093 | <p>This class implements timer watchers/events. Time is represented as a |
744 | fractional number of seconds since the epoch. Example:</p> |
1094 | fractional number of seconds since the epoch. Example:</p> |
… | |
… | |
810 | <pre> |
1160 | <pre> |
811 | $term->{socket} = ... |
1161 | $term->{socket} = ... |
812 | $term->{iow} = urxvt::iow |
1162 | $term->{iow} = urxvt::iow |
813 | ->new |
1163 | ->new |
814 | ->fd (fileno $term->{socket}) |
1164 | ->fd (fileno $term->{socket}) |
815 | ->events (1) # wait for read data |
1165 | ->events (urxvt::EVENT_READ) |
816 | ->start |
1166 | ->start |
817 | ->cb (sub { |
1167 | ->cb (sub { |
818 | my ($iow, $revents) = @_; |
1168 | my ($iow, $revents) = @_; |
819 | # $revents must be 1 here, no need to check |
1169 | # $revents must be 1 here, no need to check |
820 | sysread $term->{socket}, my $buf, 8192 |
1170 | sysread $term->{socket}, my $buf, 8192 |
… | |
… | |
841 | </dd> |
1191 | </dd> |
842 | <p></p> |
1192 | <p></p> |
843 | <dt><strong><a name="item_events">$iow = $iow->events ($eventmask)</a></strong><br /> |
1193 | <dt><strong><a name="item_events">$iow = $iow->events ($eventmask)</a></strong><br /> |
844 | </dt> |
1194 | </dt> |
845 | <dd> |
1195 | <dd> |
846 | Set the event mask to watch. Bit #0 (value <code>1</code>) enables watching for read |
1196 | Set the event mask to watch. The only allowed values are |
847 | data, Bit #1 (value <code>2</code>) enables watching for write data. |
1197 | <code>urxvt::EVENT_READ</code> and <code>urxvt::EVENT_WRITE</code>, which might be ORed |
|
|
1198 | together, or <code>urxvt::EVENT_NONE</code>. |
848 | </dd> |
1199 | </dd> |
849 | <p></p> |
1200 | <p></p> |
850 | <dt><strong>$iow = $iow->start</strong><br /> |
1201 | <dt><strong>$iow = $iow->start</strong><br /> |
851 | </dt> |
1202 | </dt> |
852 | <dd> |
1203 | <dd> |
… | |
… | |
867 | </p> |
1218 | </p> |
868 | <h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> |
1219 | <h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> |
869 | <p>This variable controls the verbosity level of the perl extension. Higher |
1220 | <p>This variable controls the verbosity level of the perl extension. Higher |
870 | numbers indicate more verbose output.</p> |
1221 | numbers indicate more verbose output.</p> |
871 | <dl> |
1222 | <dl> |
872 | <dt><strong><a name="item__3d0__2d_only_fatal_messages">=0 - only fatal messages</a></strong><br /> |
1223 | <dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br /> |
873 | </dt> |
1224 | </dt> |
874 | <dt><strong><a name="item__3d3__2d_script_loading_and_management">=3 - script loading and management</a></strong><br /> |
1225 | <dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">>= 3 - script loading and management</a></strong><br /> |
875 | </dt> |
1226 | </dt> |
876 | <dt><strong><a name="item__3d10__2d_all_events_received">=10 - all events received</a></strong><br /> |
1227 | <dt><strong><a name="item__3e_3d10__2d_all_events_received">>=10 - all events received</a></strong><br /> |
877 | </dt> |
1228 | </dt> |
878 | </dl> |
1229 | </dl> |
879 | <p> |
1230 | <p> |
880 | </p> |
1231 | </p> |
881 | <hr /> |
1232 | <hr /> |