… | |
… | |
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="#prepackaged_extensions">Prepackaged Extensions</a></li> |
|
|
21 | <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> |
22 | <li><a href="#hooks">Hooks</a></li> |
24 | <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> |
25 | <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> |
26 | <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> |
27 | <li><a href="#rendition">RENDITION</a></li> |
26 | <li><a href="#the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></li> |
28 | <li><a href="#the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></li> |
… | |
… | |
71 | thus must be encoded as UTF-8.</p> |
73 | thus must be encoded as UTF-8.</p> |
72 | <p>Each script will only ever be loaded once, even in rxvtd, where |
74 | <p>Each script will only ever be loaded once, even in rxvtd, where |
73 | scripts will be shared (but not enabled) for all terminals.</p> |
75 | scripts will be shared (but not enabled) for all terminals.</p> |
74 | <p> |
76 | <p> |
75 | </p> |
77 | </p> |
76 | <h2><a name="prepackaged_extensions">Prepackaged Extensions</a></h2> |
78 | <hr /> |
|
|
79 | <h1><a name="prepackaged_extensions">PREPACKAGED EXTENSIONS</a></h1> |
77 | <p>This section describes the extensiosn delivered with this version. You can |
80 | <p>This section describes the extensions delivered with this release. You can |
78 | find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> |
81 | find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> |
79 | <p>You can activate them like this:</p> |
82 | <p>You can activate them like this:</p> |
80 | <pre> |
83 | <pre> |
81 | rxvt -pe <extensionname></pre> |
84 | rxvt -pe <extensionname></pre> |
82 | <dl> |
85 | <dl> |
83 | <dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br /> |
86 | <dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br /> |
84 | </dt> |
87 | </dt> |
85 | <dd> |
88 | <dd> |
86 | Intelligent selection. This extension tries to be more intelligent when |
89 | (More) intelligent selection. This extension tries to be more intelligent |
87 | the user extends selections (double-click). Right now, it tries to select |
90 | when the user extends selections (double-click and further clicks). Right |
88 | urls and complete shell-quoted arguments, which is very convenient, too, |
91 | now, it tries to select words, urls and complete shell-quoted |
89 | if your <em>ls</em> supports <code>--quoting-style=shell</code>. |
92 | arguments, which is very convenient, too, if your <em>ls</em> supports |
90 | </dd> |
93 | <code>--quoting-style=shell</code>. |
91 | <dd> |
94 | </dd> |
|
|
95 | <dd> |
|
|
96 | <p>A double-click usually selects the word under the cursor, further clicks |
|
|
97 | will enlarge the selection.</p> |
|
|
98 | </dd> |
|
|
99 | <dd> |
92 | <p>It also offers the following bindable event:</p> |
100 | <p>It also offers the following bindable keyboard command:</p> |
93 | </dd> |
101 | </dd> |
94 | <dl> |
102 | <dl> |
95 | <dt><strong><a name="item_rot13">rot13</a></strong><br /> |
103 | <dt><strong><a name="item_rot13">rot13</a></strong><br /> |
96 | </dt> |
104 | </dt> |
97 | <dd> |
105 | <dd> |
… | |
… | |
103 | </dd> |
111 | </dd> |
104 | <p></p></dl> |
112 | <p></p></dl> |
105 | <dt><strong><a name="item_popup">option-popup (enabled by default)</a></strong><br /> |
113 | <dt><strong><a name="item_popup">option-popup (enabled by default)</a></strong><br /> |
106 | </dt> |
114 | </dt> |
107 | <dd> |
115 | <dd> |
108 | Binds a popup menu to Ctrl-Button3 that lets you toggle (some) options at |
116 | Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at |
109 | runtime. |
117 | runtime. |
110 | </dd> |
118 | </dd> |
111 | <p></p> |
119 | <p></p> |
|
|
120 | <dt><strong>selection-popup (enabled by default)</strong><br /> |
|
|
121 | </dt> |
|
|
122 | <dd> |
|
|
123 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
|
|
124 | text into various other formats/action (such as uri unescaping, perl |
|
|
125 | evalution, web-browser starting etc.), depending on content. |
|
|
126 | </dd> |
|
|
127 | <p></p> |
|
|
128 | <dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback<hotkey> (enabled by default)</a></strong><br /> |
|
|
129 | </dt> |
|
|
130 | <dd> |
|
|
131 | Adds regex search functionality to the scrollback buffer, triggered |
|
|
132 | by a hotkey (default: <code>M-s</code>). While in search mode, normal terminal |
|
|
133 | input/output is suspended and a regex is displayed at the bottom of the |
|
|
134 | screen. |
|
|
135 | </dd> |
|
|
136 | <dd> |
|
|
137 | <p>Inputting characters appends them to the regex and continues incremental |
|
|
138 | search. <code>BackSpace</code> removes a character from the regex, <code>Up</code> and <code>Down</code> |
|
|
139 | search upwards/downwards in the scrollback buffer, <code>End</code> jumps to the |
|
|
140 | bottom. <code>Escape</code> leaves search mode and returns to the point where search |
|
|
141 | was started, while <code>Enter</code> or <code>Return</code> stay at the current position and |
|
|
142 | additionally stores the first match in the current line into the primary |
|
|
143 | selection.</p> |
|
|
144 | </dd> |
|
|
145 | <p></p> |
112 | <dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> |
146 | <dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> |
113 | </dt> |
147 | </dt> |
114 | <dd> |
148 | <dd> |
115 | Displays a digital clock using the built-in overlay. |
149 | Displays a digital clock using the built-in overlay. |
116 | </dd> |
150 | </dd> |
117 | <p></p> |
151 | <p></p> |
118 | <dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> |
152 | <dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> |
119 | </dt> |
153 | </dt> |
120 | <dd> |
154 | <dd> |
121 | Uses per-line display filtering (<code>on_line_update</code>) to underline urls. |
155 | Uses per-line display filtering (<code>on_line_update</code>) to underline urls and |
|
|
156 | make them clickable. When middle-clicked, the program specified in the |
|
|
157 | resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with |
|
|
158 | the URL as first argument. |
122 | </dd> |
159 | </dd> |
123 | <p></p> |
160 | <p></p> |
124 | <dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br /> |
161 | <dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br /> |
125 | </dt> |
162 | </dt> |
126 | <dd> |
163 | <dd> |
… | |
… | |
135 | Displays a very simple digital clock in the upper right corner of the |
172 | Displays a very simple digital clock in the upper right corner of the |
136 | window. Illustrates overwriting the refresh callbacks to create your own |
173 | window. Illustrates overwriting the refresh callbacks to create your own |
137 | overlays or changes. |
174 | overlays or changes. |
138 | </dd> |
175 | </dd> |
139 | <p></p></dl> |
176 | <p></p></dl> |
|
|
177 | <p> |
|
|
178 | </p> |
|
|
179 | <hr /> |
|
|
180 | <h1><a name="api_documentation">API DOCUMENTATION</a></h1> |
140 | <p> |
181 | <p> |
141 | </p> |
182 | </p> |
142 | <h2><a name="general_api_considerations">General API Considerations</a></h2> |
183 | <h2><a name="general_api_considerations">General API Considerations</a></h2> |
143 | <p>All objects (such as terminals, time watchers etc.) are typical |
184 | <p>All objects (such as terminals, time watchers etc.) are typical |
144 | reference-to-hash objects. The hash can be used to store anything you |
185 | reference-to-hash objects. The hash can be used to store anything you |
… | |
… | |
154 | <dl> |
195 | <dl> |
155 | <dt><strong><a name="item__24text">$text</a></strong><br /> |
196 | <dt><strong><a name="item__24text">$text</a></strong><br /> |
156 | </dt> |
197 | </dt> |
157 | <dd> |
198 | <dd> |
158 | Rxvt-unicodes special way of encoding text, where one ``unicode'' character |
199 | Rxvt-unicodes special way of encoding text, where one ``unicode'' character |
159 | always represents one screen cell. See <em>row_t</em> for a discussion of this format. |
200 | always represents one screen cell. See <a href="#item_row_t">ROW_t</a> for a discussion of this format. |
160 | </dd> |
201 | </dd> |
161 | <p></p> |
202 | <p></p> |
162 | <dt><strong><a name="item__24string">$string</a></strong><br /> |
203 | <dt><strong><a name="item__24string">$string</a></strong><br /> |
163 | </dt> |
204 | </dt> |
164 | <dd> |
205 | <dd> |
… | |
… | |
174 | locale-specific way. |
215 | locale-specific way. |
175 | </dd> |
216 | </dd> |
176 | <p></p></dl> |
217 | <p></p></dl> |
177 | <p> |
218 | <p> |
178 | </p> |
219 | </p> |
|
|
220 | <h2><a name="extension_objects">Extension Objects</a></h2> |
|
|
221 | <p>Very perl extension is a perl class. A separate perl object is created |
|
|
222 | for each terminal and each extension and passed as the first parameter to |
|
|
223 | hooks. So extensions can use their <code>$self</code> object without having to think |
|
|
224 | about other extensions, with the exception of methods and members that |
|
|
225 | begin with an underscore character <code>_</code>: these are reserved for internal |
|
|
226 | use.</p> |
|
|
227 | <p>Although it isn't a <code>urxvt::term</code> object, you can call all methods of the |
|
|
228 | <code>urxvt::term</code> class on this object.</p> |
|
|
229 | <p>It has the following methods and data members:</p> |
|
|
230 | <dl> |
|
|
231 | <dt><strong><a name="item__24urxvt_term__3d__24self_2d_3e_7bterm_7d">$urxvt_term = $self->{term}</a></strong><br /> |
|
|
232 | </dt> |
|
|
233 | <dd> |
|
|
234 | Returns the <code>urxvt::term</code> object associated with this instance of the |
|
|
235 | extension. This member <em>must not</em> be changed in any way. |
|
|
236 | </dd> |
|
|
237 | <p></p> |
|
|
238 | <dt><strong><a name="item_enable">$self->enable ($hook_name => $cb, [$hook_name => $cb..])</a></strong><br /> |
|
|
239 | </dt> |
|
|
240 | <dd> |
|
|
241 | Dynamically enable the given hooks (named without the <code>on_</code> prefix) for |
|
|
242 | this extension, replacing any previous hook. This is useful when you want |
|
|
243 | to overwrite time-critical hooks only temporarily. |
|
|
244 | </dd> |
|
|
245 | <p></p> |
|
|
246 | <dt><strong><a name="item_disable">$self->disable ($hook_name[, $hook_name..])</a></strong><br /> |
|
|
247 | </dt> |
|
|
248 | <dd> |
|
|
249 | Dynamically disable the given hooks. |
|
|
250 | </dd> |
|
|
251 | <p></p></dl> |
|
|
252 | <p> |
|
|
253 | </p> |
179 | <h2><a name="hooks">Hooks</a></h2> |
254 | <h2><a name="hooks">Hooks</a></h2> |
180 | <p>The following subroutines can be declared in extension files, and will be |
255 | <p>The following subroutines can be declared in extension files, and will be |
181 | called whenever the relevant event happens.</p> |
256 | called whenever the relevant event happens.</p> |
182 | <p>The first argument passed to them is an object private to each terminal |
257 | <p>The first argument passed to them is an extension oject as described in |
183 | and extension package. You can call all <code>urxvt::term</code> methods on it, but |
258 | the in the <code>Extension Objects</code> section.</p> |
184 | its not a real <code>urxvt::term</code> object. Instead, the real <code>urxvt::term</code> |
|
|
185 | object that is shared between all packages is stored in the <code>term</code> |
|
|
186 | member. It is, however, blessed intot he package of the extension script, |
|
|
187 | so for all practical purposes you can treat an extension script as a class.</p> |
|
|
188 | <p>All of them must return a boolean value. If it is true, then the event |
259 | <p><strong>All</strong> of these hooks must return a boolean value. If it is true, then the |
189 | counts as being <em>consumed</em>, and the invocation of other hooks is skipped, |
260 | event counts as being <em>consumed</em>, and the invocation of other hooks is |
190 | and the relevant action might not be carried out by the C++ code.</p> |
261 | skipped, and the relevant action might not be carried out by the C++ code.</p> |
191 | <p>When in doubt, return a false value (preferably <code>()</code>).</p> |
262 | <p><em>When in doubt, return a false value (preferably <code>()</code>). </em>></p> |
192 | <dl> |
263 | <dl> |
193 | <dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> |
264 | <dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> |
194 | </dt> |
265 | </dt> |
195 | <dd> |
266 | <dd> |
196 | Called after a new terminal object has been initialized, but before |
267 | Called after a new terminal object has been initialized, but before |
… | |
… | |
242 | </dt> |
313 | </dt> |
243 | <dd> |
314 | <dd> |
244 | Called whenever the user tries to extend the selection (e.g. with a double |
315 | Called whenever the user tries to extend the selection (e.g. with a double |
245 | click) and is either supposed to return false (normal operation), or |
316 | click) and is either supposed to return false (normal operation), or |
246 | should extend the selection itelf and return true to suppress the built-in |
317 | should extend the selection itelf and return true to suppress the built-in |
247 | processing. |
318 | processing. This can happen multiple times, as long as the callback |
|
|
319 | returns true, it will be called on every further click by the user and is |
|
|
320 | supposed to enlarge the selection more and more, if possible. |
248 | </dd> |
321 | </dd> |
249 | <dd> |
322 | <dd> |
250 | <p>See the <em>selection</em> example extension.</p> |
323 | <p>See the <em>selection</em> example extension.</p> |
251 | </dd> |
324 | </dd> |
252 | <p></p> |
325 | <p></p> |
… | |
… | |
267 | </dd> |
340 | </dd> |
268 | <dd> |
341 | <dd> |
269 | <p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
342 | <p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
270 | $nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total |
343 | $nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total |
271 | number of lines that will be in the scrollback buffer.</p> |
344 | number of lines that will be in the scrollback buffer.</p> |
272 | </dd> |
|
|
273 | <p></p> |
|
|
274 | <dt><strong><a name="item_on_tty_activity__24term__2anyi_2a">on_tty_activity $term *NYI*</a></strong><br /> |
|
|
275 | </dt> |
|
|
276 | <dd> |
|
|
277 | Called whenever the <code>program(s)</code> running in the urxvt window send output. |
|
|
278 | </dd> |
345 | </dd> |
279 | <p></p> |
346 | <p></p> |
280 | <dt><strong><a name="item_on_osc_seq__24term_2c__24string">on_osc_seq $term, $string</a></strong><br /> |
347 | <dt><strong><a name="item_on_osc_seq__24term_2c__24string">on_osc_seq $term, $string</a></strong><br /> |
281 | </dt> |
348 | </dt> |
282 | <dd> |
349 | <dd> |
… | |
… | |
301 | and calling <a href="#item_scr_add_lines"><code>$term->scr_add_lines</code></a> yourself. Please note that this |
368 | and calling <a href="#item_scr_add_lines"><code>$term->scr_add_lines</code></a> yourself. Please note that this |
302 | might be very slow, however, as your hook is called for <strong>all</strong> text being |
369 | might be very slow, however, as your hook is called for <strong>all</strong> text being |
303 | output. |
370 | output. |
304 | </dd> |
371 | </dd> |
305 | <p></p> |
372 | <p></p> |
|
|
373 | <dt><strong><a name="item_on_tt_write__24term_2c__24octets">on_tt_write $term, $octets</a></strong><br /> |
|
|
374 | </dt> |
|
|
375 | <dd> |
|
|
376 | Called whenever some data is written to the tty/pty and can be used to |
|
|
377 | suppress or filter tty input. |
|
|
378 | </dd> |
|
|
379 | <p></p> |
306 | <dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong><br /> |
380 | <dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong><br /> |
307 | </dt> |
381 | </dt> |
308 | <dd> |
382 | <dd> |
309 | Called whenever a line was updated or changed. Can be used to filter |
383 | Called whenever a line was updated or changed. Can be used to filter |
310 | screen output (e.g. underline urls or other useless stuff). Only lines |
384 | screen output (e.g. underline urls or other useless stuff). Only lines |
… | |
… | |
356 | <dd> |
430 | <dd> |
357 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
431 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
358 | focus out processing. |
432 | focus out processing. |
359 | </dd> |
433 | </dd> |
360 | <p></p> |
434 | <p></p> |
361 | <dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24octets">on_key_press $term, $event, $octets</a></strong><br /> |
435 | <dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a></strong><br /> |
362 | </dt> |
436 | </dt> |
363 | <dt><strong><a name="item_on_key_release__24term_2c__24event">on_key_release $term, $event</a></strong><br /> |
437 | <dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br /> |
364 | </dt> |
438 | </dt> |
365 | <dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br /> |
439 | <dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br /> |
366 | </dt> |
440 | </dt> |
367 | <dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br /> |
441 | <dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br /> |
368 | </dt> |
442 | </dt> |
… | |
… | |
391 | <p></p></dl> |
465 | <p></p></dl> |
392 | <p> |
466 | <p> |
393 | </p> |
467 | </p> |
394 | <h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> |
468 | <h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> |
395 | <dl> |
469 | <dl> |
|
|
470 | <dt><strong><a name="item__24urxvt_3a_3alibdir">$urxvt::LIBDIR</a></strong><br /> |
|
|
471 | </dt> |
|
|
472 | <dd> |
|
|
473 | The rxvt-unicode library directory, where, among other things, the perl |
|
|
474 | modules and scripts are stored. |
|
|
475 | </dd> |
|
|
476 | <p></p> |
|
|
477 | <dt><strong><a name="item__24urxvt_3a_3aresclass_2c__24urxvt_3a_3aresclass">$urxvt::RESCLASS, $urxvt::RESCLASS</a></strong><br /> |
|
|
478 | </dt> |
|
|
479 | <dd> |
|
|
480 | The resource class and name rxvt-unicode uses to look up X resources. |
|
|
481 | </dd> |
|
|
482 | <p></p> |
|
|
483 | <dt><strong><a name="item__24urxvt_3a_3arxvtname">$urxvt::RXVTNAME</a></strong><br /> |
|
|
484 | </dt> |
|
|
485 | <dd> |
|
|
486 | The basename of the installed binaries, usually <code>urxvt</code>. |
|
|
487 | </dd> |
|
|
488 | <p></p> |
396 | <dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br /> |
489 | <dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br /> |
397 | </dt> |
490 | </dt> |
398 | <dd> |
491 | <dd> |
399 | The current terminal. This variable stores the current <code>urxvt::term</code> |
492 | The current terminal. This variable stores the current <code>urxvt::term</code> |
400 | object, whenever a callback/hook is executing. |
493 | object, whenever a callback/hook is executing. |
… | |
… | |
402 | <p></p></dl> |
495 | <p></p></dl> |
403 | <p> |
496 | <p> |
404 | </p> |
497 | </p> |
405 | <h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> |
498 | <h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> |
406 | <dl> |
499 | <dl> |
407 | <dt><strong><a name="item__24term__3d_new_urxvt__5barg_2e_2e_2e_5d">$term = new urxvt [arg...]</a></strong><br /> |
|
|
408 | </dt> |
|
|
409 | <dd> |
|
|
410 | Creates a new terminal, very similar as if you had started it with |
|
|
411 | <code>system $binfile, arg...</code>. Croaks (and probably outputs an error message) |
|
|
412 | if the new instance couldn't be created. Returns <code>undef</code> if the new |
|
|
413 | instance didn't initialise perl, and the terminal object otherwise. The |
|
|
414 | <code>init</code> and <a href="#item_start"><code>start</code></a> hooks will be called during the call. |
|
|
415 | </dd> |
|
|
416 | <p></p> |
|
|
417 | <dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br /> |
500 | <dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br /> |
418 | </dt> |
501 | </dt> |
419 | <dd> |
502 | <dd> |
420 | Fatally aborts execution with the given error message. Avoid at all |
503 | Fatally aborts execution with the given error message. Avoid at all |
421 | costs! The only time this is acceptable is when the terminal process |
504 | costs! The only time this is acceptable is when the terminal process |
… | |
… | |
430 | that calls this function. |
513 | that calls this function. |
431 | </dd> |
514 | </dd> |
432 | <dd> |
515 | <dd> |
433 | <p>Using this function has the advantage that its output ends up in the |
516 | <p>Using this function has the advantage that its output ends up in the |
434 | correct place, e.g. on stderr of the connecting urxvtc client.</p> |
517 | correct place, e.g. on stderr of the connecting urxvtc client.</p> |
|
|
518 | </dd> |
|
|
519 | <dd> |
|
|
520 | <p>Messages have a size limit of 1023 bytes currently.</p> |
|
|
521 | </dd> |
|
|
522 | <p></p> |
|
|
523 | <dt><strong><a name="item__24is_safe__3d_urxvt_3a_3asafe">$is_safe = urxvt::safe</a></strong><br /> |
|
|
524 | </dt> |
|
|
525 | <dd> |
|
|
526 | Returns true when it is safe to do potentially unsafe things, such as |
|
|
527 | evaluating perl code specified by the user. This is true when urxvt was |
|
|
528 | started setuid or setgid. |
435 | </dd> |
529 | </dd> |
436 | <p></p> |
530 | <p></p> |
437 | <dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> |
531 | <dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> |
438 | </dt> |
532 | </dt> |
439 | <dd> |
533 | <dd> |
… | |
… | |
487 | </dt> |
581 | </dt> |
488 | <dd> |
582 | <dd> |
489 | Return the foreground/background colour index, respectively. |
583 | Return the foreground/background colour index, respectively. |
490 | </dd> |
584 | </dd> |
491 | <p></p> |
585 | <p></p> |
492 | <dt><strong><a name="item_set_fgcolor">$rend = urxvt::SET_FGCOLOR ($rend, $new_colour)</a></strong><br /> |
586 | <dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_fgcolor__24rend_2c__24n">$rend = urxvt::SET_FGCOLOR $rend, $new_colour</a></strong><br /> |
493 | </dt> |
587 | </dt> |
494 | <dt><strong><a name="item_set_bgcolor">$rend = urxvt::SET_BGCOLOR ($rend, $new_colour)</a></strong><br /> |
588 | <dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_bgcolor__24rend_2c__24n">$rend = urxvt::SET_BGCOLOR $rend, $new_colour</a></strong><br /> |
495 | </dt> |
589 | </dt> |
496 | <dd> |
590 | <dd> |
497 | Replace the foreground/background colour in the rendition mask with the |
591 | Replace the foreground/background colour in the rendition mask with the |
498 | specified one. |
592 | specified one. |
499 | </dd> |
593 | </dd> |
500 | <p></p> |
594 | <p></p> |
501 | <dt><strong><a name="item_get_custom">$value = urxvt::GET_CUSTOM ($rend)</a></strong><br /> |
595 | <dt><strong><a name="item__24value__3d_urxvt_3a_3aget_custom__24rend">$value = urxvt::GET_CUSTOM $rend</a></strong><br /> |
502 | </dt> |
596 | </dt> |
503 | <dd> |
597 | <dd> |
504 | Return the ``custom'' value: Every rendition has 5 bits for use by |
598 | Return the ``custom'' value: Every rendition has 5 bits for use by |
505 | extensions. They can be set and changed as you like and are initially |
599 | extensions. They can be set and changed as you like and are initially |
506 | zero. |
600 | zero. |
507 | </dd> |
601 | </dd> |
508 | <p></p> |
602 | <p></p> |
509 | <dt><strong><a name="item_set_custom">$rend = urxvt::SET_CUSTOM ($rend, $new_value)</a></strong><br /> |
603 | <dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_custom__24rend_2c__24ne">$rend = urxvt::SET_CUSTOM $rend, $new_value</a></strong><br /> |
510 | </dt> |
604 | </dt> |
511 | <dd> |
605 | <dd> |
512 | Change the custom value. |
606 | Change the custom value. |
513 | </dd> |
607 | </dd> |
514 | <p></p></dl> |
608 | <p></p></dl> |
515 | <p> |
609 | <p> |
516 | </p> |
610 | </p> |
517 | <h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2> |
611 | <h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2> |
518 | <p>The sole purpose of this class is to deliver an interface to the |
612 | <p>The sole purpose of this class is to deliver an interface to the |
519 | <code>AnyEvent</code> module - any module using it will work inside urxvt without |
613 | <code>AnyEvent</code> module - any module using it will work inside urxvt without |
520 | further work. The only exception is that you cannot wait on condition |
614 | further programming. The only exception is that you cannot wait on |
521 | variables, but non-blocking condvar use is ok. What this means is that you |
615 | condition variables, but non-blocking condvar use is ok. What this means |
522 | cannot use blocking APIs, but the non-blocking variant should work.</p> |
616 | is that you cannot use blocking APIs, but the non-blocking variant should |
|
|
617 | work.</p> |
523 | <p> |
618 | <p> |
524 | </p> |
619 | </p> |
525 | <h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> |
620 | <h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> |
526 | <dl> |
621 | <dl> |
|
|
622 | <dt><strong><a name="item__24term__3d_new_urxvt_3a_3aterm__24envhashref_2c__">$term = new urxvt::term $envhashref, $rxvtname, [arg...]</a></strong><br /> |
|
|
623 | </dt> |
|
|
624 | <dd> |
|
|
625 | Creates a new terminal, very similar as if you had started it with system |
|
|
626 | <code>$rxvtname, arg...</code>. <code>$envhashref</code> must be a reference to a <code>%ENV</code>-like |
|
|
627 | hash which defines the environment of the new terminal. |
|
|
628 | </dd> |
|
|
629 | <dd> |
|
|
630 | <p>Croaks (and probably outputs an error message) if the new instance |
|
|
631 | couldn't be created. Returns <code>undef</code> if the new instance didn't |
|
|
632 | initialise perl, and the terminal object otherwise. The <code>init</code> and |
|
|
633 | <a href="#item_start"><code>start</code></a> hooks will be called during this call.</p> |
|
|
634 | </dd> |
|
|
635 | <p></p> |
527 | <dt><strong><a name="item_destroy">$term->destroy</a></strong><br /> |
636 | <dt><strong><a name="item_destroy">$term->destroy</a></strong><br /> |
528 | </dt> |
637 | </dt> |
529 | <dd> |
638 | <dd> |
530 | Destroy the terminal object (close the window, free resources etc.). |
639 | Destroy the terminal object (close the window, free resources |
|
|
640 | etc.). Please note that rxvt will not exit as long as any event |
|
|
641 | watchers (timers, io watchers) are still active. |
531 | </dd> |
642 | </dd> |
532 | <p></p> |
643 | <p></p> |
533 | <dt><strong><a name="item_option">$isset = $term->option ($optval[, $set])</a></strong><br /> |
644 | <dt><strong><a name="item_option">$isset = $term->option ($optval[, $set])</a></strong><br /> |
534 | </dt> |
645 | </dt> |
535 | <dd> |
646 | <dd> |
… | |
… | |
591 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
702 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
592 | shade term_name title transparent transparent_all tripleclickwords |
703 | shade term_name title transparent transparent_all tripleclickwords |
593 | utmpInhibit visualBell</pre> |
704 | utmpInhibit visualBell</pre> |
594 | </dd> |
705 | </dd> |
595 | <p></p> |
706 | <p></p> |
|
|
707 | <dt><strong><a name="item_x_resource">$value = $term->x_resource ($pattern)</a></strong><br /> |
|
|
708 | </dt> |
|
|
709 | <dd> |
|
|
710 | Returns the X-Resource for the given pattern, excluding the program or |
|
|
711 | class name, i.e. <a href="#item_x_resource"><code>$term->x_resource ("boldFont")</code></a> should return the |
|
|
712 | same value as used by this instance of rxvt-unicode. Returns <code>undef</code> if no |
|
|
713 | resource with that pattern exists. |
|
|
714 | </dd> |
|
|
715 | <dd> |
|
|
716 | <p>This method should only be called during the <code>on_start</code> hook, as there is |
|
|
717 | only one resource database per display, and later invocations might return |
|
|
718 | the wrong resources.</p> |
|
|
719 | </dd> |
|
|
720 | <p></p> |
|
|
721 | <dt><strong><a name="item_parse_keysym">$success = $term->parse_keysym ($keysym_spec, $command_string)</a></strong><br /> |
|
|
722 | </dt> |
|
|
723 | <dd> |
|
|
724 | Adds a keymap translation exactly as specified via a resource. See the |
|
|
725 | <code>keysym</code> resource in the <code>rxvt(1)</code> manpage. |
|
|
726 | </dd> |
|
|
727 | <p></p> |
596 | <dt><strong><a name="item_rstyle">$rend = $term->rstyle ([$new_rstyle])</a></strong><br /> |
728 | <dt><strong><a name="item_rstyle">$rend = $term->rstyle ([$new_rstyle])</a></strong><br /> |
597 | </dt> |
729 | </dt> |
598 | <dd> |
730 | <dd> |
599 | Return and optionally change the current rendition. Text that is output by |
731 | Return and optionally change the current rendition. Text that is output by |
600 | the terminal application will use this style. |
732 | the terminal application will use this style. |
… | |
… | |
616 | <dd> |
748 | <dd> |
617 | Return the current values of the selection mark, begin or end positions, |
749 | Return the current values of the selection mark, begin or end positions, |
618 | and optionally set them to new values. |
750 | and optionally set them to new values. |
619 | </dd> |
751 | </dd> |
620 | <p></p> |
752 | <p></p> |
|
|
753 | <dt><strong><a name="item_selection_make">$term->selection_make ($eventtime[, $rectangular])</a></strong><br /> |
|
|
754 | </dt> |
|
|
755 | <dd> |
|
|
756 | Tries to make a selection as set by <a href="#item_selection_beg"><code>selection_beg</code></a> and |
|
|
757 | <a href="#item_selection_end"><code>selection_end</code></a>. If <code>$rectangular</code> is true (default: false), a |
|
|
758 | rectangular selection will be made. This is the prefered function to make |
|
|
759 | a selection. |
|
|
760 | </dd> |
|
|
761 | <p></p> |
621 | <dt><strong><a name="item_selection_grab">$success = $term->selection_grab ($eventtime)</a></strong><br /> |
762 | <dt><strong><a name="item_selection_grab">$success = $term->selection_grab ($eventtime)</a></strong><br /> |
622 | </dt> |
763 | </dt> |
623 | <dd> |
764 | <dd> |
624 | Try to request the primary selection from the server (for example, as set |
765 | Try to request the primary selection text from the server (for example, as |
625 | by the next method). |
766 | set by the next method). No visual feedback will be given. This function |
|
|
767 | is mostly useful from within <code>on_sel_grab</code> hooks. |
626 | </dd> |
768 | </dd> |
627 | <p></p> |
769 | <p></p> |
628 | <dt><strong>$oldtext = $term->selection ([$newtext])</strong><br /> |
770 | <dt><strong>$oldtext = $term->selection ([$newtext])</strong><br /> |
629 | </dt> |
771 | </dt> |
630 | <dd> |
772 | <dd> |
631 | Return the current selection text and optionally replace it by <code>$newtext</code>. |
773 | Return the current selection text and optionally replace it by <code>$newtext</code>. |
632 | </dd> |
774 | </dd> |
|
|
775 | <p></p> |
|
|
776 | <dt><strong><a name="item_overlay_simple">$term->overlay_simple ($x, $y, $text)</a></strong><br /> |
|
|
777 | </dt> |
633 | <dd> |
778 | <dd> |
634 | <p>#=item $term->overlay ($x, $y, $text) |
|
|
635 | # |
|
|
636 | #Create a simple multi-line overlay box. See the next method for details. |
779 | Create a simple multi-line overlay box. See the next method for details. |
637 | # |
|
|
638 | #=cut |
|
|
639 | # |
|
|
640 | #sub urxvt::term::scr_overlay { |
|
|
641 | # my ($self, $x, $y, $text) = @_; |
|
|
642 | # |
|
|
643 | # my @lines = split /\n/, $text; |
|
|
644 | # |
|
|
645 | # my $w = 0; |
|
|
646 | # for (map $self->strwidth ($_), @lines) { |
|
|
647 | # $w = $_ if $w < $_; |
|
|
648 | # } |
|
|
649 | # |
|
|
650 | # $self->scr_overlay_new ($x, $y, $w, scalar @lines); |
|
|
651 | # $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; |
|
|
652 | #}</p> |
|
|
653 | </dd> |
780 | </dd> |
654 | <p></p> |
781 | <p></p> |
655 | <dt><strong><a name="item_overlay">$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br /> |
782 | <dt><strong><a name="item_overlay">$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br /> |
656 | </dt> |
783 | </dt> |
657 | <dd> |
784 | <dd> |
… | |
… | |
718 | <p></p> |
845 | <p></p> |
719 | <dt><strong><a name="item_locale_decode">$string = $term->locale_decode ($octets)</a></strong><br /> |
846 | <dt><strong><a name="item_locale_decode">$string = $term->locale_decode ($octets)</a></strong><br /> |
720 | </dt> |
847 | </dt> |
721 | <dd> |
848 | <dd> |
722 | Convert the given locale-encoded octets into a perl string. |
849 | Convert the given locale-encoded octets into a perl string. |
|
|
850 | </dd> |
|
|
851 | <p></p> |
|
|
852 | <dt><strong><a name="item_scr_xor_span">$term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])</a></strong><br /> |
|
|
853 | </dt> |
|
|
854 | <dd> |
|
|
855 | XORs the rendition values in the given span with the provided value |
|
|
856 | (default: <code>RS_RVid</code>), which <em>MUST NOT</em> contain font styles. Useful in |
|
|
857 | refresh hooks to provide effects similar to the selection. |
|
|
858 | </dd> |
|
|
859 | <p></p> |
|
|
860 | <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 /> |
|
|
861 | </dt> |
|
|
862 | <dd> |
|
|
863 | Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing |
|
|
864 | whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults |
|
|
865 | to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines |
|
|
866 | it instead. Both styles <em>MUST NOT</em> contain font styles. |
|
|
867 | </dd> |
|
|
868 | <p></p> |
|
|
869 | <dt><strong><a name="item_scr_bell">$term->scr_bell</a></strong><br /> |
|
|
870 | </dt> |
|
|
871 | <dd> |
|
|
872 | Ring the bell! |
723 | </dd> |
873 | </dd> |
724 | <p></p> |
874 | <p></p> |
725 | <dt><strong><a name="item_scr_add_lines">$term->scr_add_lines ($string)</a></strong><br /> |
875 | <dt><strong><a name="item_scr_add_lines">$term->scr_add_lines ($string)</a></strong><br /> |
726 | </dt> |
876 | </dt> |
727 | <dd> |
877 | <dd> |
… | |
… | |
750 | Write the octets given in <code>$data</code> to the tty (i.e. as program input). To |
900 | Write the octets given in <code>$data</code> to the tty (i.e. as program input). To |
751 | pass characters instead of octets, you should convert your strings first |
901 | pass characters instead of octets, you should convert your strings first |
752 | to the locale-specific encoding using <a href="#item_locale_encode"><code>$term->locale_encode</code></a>. |
902 | to the locale-specific encoding using <a href="#item_locale_encode"><code>$term->locale_encode</code></a>. |
753 | </dd> |
903 | </dd> |
754 | <p></p> |
904 | <p></p> |
|
|
905 | <dt><strong><a name="item_pty_ev_events">$old_events = $term->pty_ev_events ([$new_events])</a></strong><br /> |
|
|
906 | </dt> |
|
|
907 | <dd> |
|
|
908 | Replaces the event mask of the pty watcher by the given event mask. Can |
|
|
909 | be used to suppress input and output handling to the pty/tty. See the |
|
|
910 | description of <a href="#item_events"><code>urxvt::timer->events</code></a>. Make sure to always restore |
|
|
911 | the previous value. |
|
|
912 | </dd> |
|
|
913 | <p></p> |
755 | <dt><strong><a name="item_parent">$windowid = $term->parent</a></strong><br /> |
914 | <dt><strong><a name="item_parent">$windowid = $term->parent</a></strong><br /> |
756 | </dt> |
915 | </dt> |
757 | <dd> |
916 | <dd> |
758 | Return the window id of the toplevel window. |
917 | Return the window id of the toplevel window. |
759 | </dd> |
918 | </dd> |
… | |
… | |
788 | </dt> |
947 | </dt> |
789 | <dt><strong><a name="item_nsaved">$lines_in_scrollback = $term->nsaved</a></strong><br /> |
948 | <dt><strong><a name="item_nsaved">$lines_in_scrollback = $term->nsaved</a></strong><br /> |
790 | </dt> |
949 | </dt> |
791 | <dd> |
950 | <dd> |
792 | Return various integers describing terminal characteristics. |
951 | Return various integers describing terminal characteristics. |
|
|
952 | </dd> |
|
|
953 | <p></p> |
|
|
954 | <dt><strong><a name="item_display_id">$x_display = $term->display_id</a></strong><br /> |
|
|
955 | </dt> |
|
|
956 | <dd> |
|
|
957 | Return the DISPLAY used by rxvt-unicode. |
|
|
958 | </dd> |
|
|
959 | <p></p> |
|
|
960 | <dt><strong><a name="item_locale">$lc_ctype = $term->locale</a></strong><br /> |
|
|
961 | </dt> |
|
|
962 | <dd> |
|
|
963 | Returns the LC_CTYPE category string used by this rxvt-unicode. |
|
|
964 | </dd> |
|
|
965 | <p></p> |
|
|
966 | <dt><strong><a name="item_env">$env = $term->env</a></strong><br /> |
|
|
967 | </dt> |
|
|
968 | <dd> |
|
|
969 | Returns a copy of the environment in effect for the terminal as a hashref |
|
|
970 | similar to <code>\%ENV</code>. |
793 | </dd> |
971 | </dd> |
794 | <p></p> |
972 | <p></p> |
795 | <dt><strong><a name="item_modlevel3mask">$modifiermask = $term->ModLevel3Mask</a></strong><br /> |
973 | <dt><strong><a name="item_modlevel3mask">$modifiermask = $term->ModLevel3Mask</a></strong><br /> |
796 | </dt> |
974 | </dt> |
797 | <dt><strong><a name="item_modmetamask">$modifiermask = $term->ModMetaMask</a></strong><br /> |
975 | <dt><strong><a name="item_modmetamask">$modifiermask = $term->ModMetaMask</a></strong><br /> |
… | |
… | |
848 | <p>You have to obey this encoding when changing text. The advantage is |
1026 | <p>You have to obey this encoding when changing text. The advantage is |
849 | that <code>substr</code> and similar functions work on screen cells and not on |
1027 | that <code>substr</code> and similar functions work on screen cells and not on |
850 | characters.</p> |
1028 | characters.</p> |
851 | </dd> |
1029 | </dd> |
852 | <dd> |
1030 | <dd> |
853 | <p>The methods <code>$term->special_encode</code> and <a href="#item_special_decode"><code>$term->special_decode</code></a> |
1031 | <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> |
854 | can be used to convert normal strings into this encoding and vice versa.</p> |
1032 | can be used to convert normal strings into this encoding and vice versa.</p> |
855 | </dd> |
1033 | </dd> |
856 | <p></p> |
1034 | <p></p> |
857 | <dt><strong><a name="item_row_r">$rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br /> |
1035 | <dt><strong><a name="item_row_r">$rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br /> |
858 | </dt> |
1036 | </dt> |
… | |
… | |
921 | <p></p> |
1099 | <p></p> |
922 | <dt><strong><a name="item_offset_of">$offset = $line->offset_of ($row, $col)</a></strong><br /> |
1100 | <dt><strong><a name="item_offset_of">$offset = $line->offset_of ($row, $col)</a></strong><br /> |
923 | </dt> |
1101 | </dt> |
924 | <dd> |
1102 | <dd> |
925 | Returns the character offset of the given row|col pair within the logical |
1103 | Returns the character offset of the given row|col pair within the logical |
926 | line. |
1104 | line. Works for rows outside the line, too, and returns corresponding |
|
|
1105 | offsets outside the string. |
927 | </dd> |
1106 | </dd> |
928 | <p></p> |
1107 | <p></p> |
929 | <dt><strong><a name="item_coord_of">($row, $col) = $line->coord_of ($offset)</a></strong><br /> |
1108 | <dt><strong><a name="item_coord_of">($row, $col) = $line->coord_of ($offset)</a></strong><br /> |
930 | </dt> |
1109 | </dt> |
931 | <dd> |
1110 | <dd> |
932 | Translates a string offset into terminal coordinates again. |
1111 | Translates a string offset into terminal coordinates again. |
933 | </dd> |
1112 | </dd> |
934 | <p></p></dl> |
1113 | <p></p></dl> |
935 | <dt><strong>($row, $col) = $line->coord_of ($offset) |
1114 | <dt><strong><a name="item_special_encode">$text = $term->special_encode $string</a></strong><br /> |
936 | =item $text = $term->special_encode $string</strong><br /> |
|
|
937 | </dt> |
1115 | </dt> |
938 | <dd> |
1116 | <dd> |
939 | Converts a perl string into the special encoding used by rxvt-unicode, |
1117 | Converts a perl string into the special encoding used by rxvt-unicode, |
940 | where one character corresponds to one screen cell. See |
1118 | where one character corresponds to one screen cell. See |
941 | <a href="#item_row_t"><code>$term->ROW_t</code></a> for details. |
1119 | <a href="#item_row_t"><code>$term->ROW_t</code></a> for details. |
… | |
… | |
945 | </dt> |
1123 | </dt> |
946 | <dd> |
1124 | <dd> |
947 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1125 | Converts rxvt-unicodes text reprsentation into a perl string. See |
948 | <a href="#item_row_t"><code>$term->ROW_t</code></a> for details. |
1126 | <a href="#item_row_t"><code>$term->ROW_t</code></a> for details. |
949 | </dd> |
1127 | </dd> |
|
|
1128 | <p></p> |
|
|
1129 | <dt><strong><a name="item_grab_button">$success = $term->grab_button ($button, $modifiermask)</a></strong><br /> |
|
|
1130 | </dt> |
|
|
1131 | <dd> |
|
|
1132 | Registers a synchronous button grab. See the XGrabButton manpage. |
|
|
1133 | </dd> |
|
|
1134 | <p></p> |
|
|
1135 | <dt><strong><a name="item_grab">$success = $term->grab ($eventtime[, $sync])</a></strong><br /> |
|
|
1136 | </dt> |
|
|
1137 | <dd> |
|
|
1138 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
|
|
1139 | synchronous (<code>$sync</code> is true). Also remembers the grab timestampe. |
|
|
1140 | </dd> |
|
|
1141 | <p></p> |
|
|
1142 | <dt><strong><a name="item_allow_events_async">$term->allow_events_async</a></strong><br /> |
|
|
1143 | </dt> |
|
|
1144 | <dd> |
|
|
1145 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
|
|
1146 | </dd> |
|
|
1147 | <p></p> |
|
|
1148 | <dt><strong><a name="item_allow_events_sync">$term->allow_events_sync</a></strong><br /> |
|
|
1149 | </dt> |
|
|
1150 | <dd> |
|
|
1151 | Calls XAllowEvents with SyncBoth for the most recent grab. |
|
|
1152 | </dd> |
|
|
1153 | <p></p> |
|
|
1154 | <dt><strong><a name="item_allow_events_replay">$term->allow_events_replay</a></strong><br /> |
|
|
1155 | </dt> |
|
|
1156 | <dd> |
|
|
1157 | Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most |
|
|
1158 | recent grab. |
|
|
1159 | </dd> |
|
|
1160 | <p></p> |
|
|
1161 | <dt><strong><a name="item_ungrab">$term->ungrab</a></strong><br /> |
|
|
1162 | </dt> |
|
|
1163 | <dd> |
|
|
1164 | Calls XUngrab for the most recent grab. Is called automatically on |
|
|
1165 | evaluation errors, as it is better to lose the grab in the error case as |
|
|
1166 | the session. |
|
|
1167 | </dd> |
950 | <p></p></dl> |
1168 | <p></p></dl> |
951 | <p> |
1169 | <p> |
952 | </p> |
1170 | </p> |
953 | <h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> |
1171 | <h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> |
|
|
1172 | <dl> |
|
|
1173 | <dt><strong><a name="item_add_title">$popup->add_title ($title)</a></strong><br /> |
|
|
1174 | </dt> |
|
|
1175 | <dd> |
|
|
1176 | Adds a non-clickable title to the popup. |
|
|
1177 | </dd> |
|
|
1178 | <p></p> |
|
|
1179 | <dt><strong><a name="item_add_separator">$popup->add_separator ([$sepchr])</a></strong><br /> |
|
|
1180 | </dt> |
|
|
1181 | <dd> |
|
|
1182 | Creates a separator, optionally using the character given as <code>$sepchr</code>. |
|
|
1183 | </dd> |
|
|
1184 | <p></p> |
|
|
1185 | <dt><strong><a name="item_add_button">$popup->add_button ($text, $cb)</a></strong><br /> |
|
|
1186 | </dt> |
|
|
1187 | <dd> |
|
|
1188 | Adds a clickable button to the popup. <code>$cb</code> is called whenever it is |
|
|
1189 | selected. |
|
|
1190 | </dd> |
|
|
1191 | <p></p> |
|
|
1192 | <dt><strong><a name="item_add_toggle">$popup->add_toggle ($text, $cb, $initial_value)</a></strong><br /> |
|
|
1193 | </dt> |
|
|
1194 | <dd> |
|
|
1195 | Adds a toggle/checkbox item to the popup. Teh callback gets called |
|
|
1196 | whenever it gets toggled, with a boolean indicating its value as its first |
|
|
1197 | argument. |
|
|
1198 | </dd> |
|
|
1199 | <p></p> |
|
|
1200 | <dt><strong>$popup->show</strong><br /> |
|
|
1201 | </dt> |
|
|
1202 | <dd> |
|
|
1203 | Displays the popup (which is initially hidden). |
|
|
1204 | </dd> |
|
|
1205 | <p></p></dl> |
954 | <p> |
1206 | <p> |
955 | </p> |
1207 | </p> |
956 | <h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> |
1208 | <h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> |
957 | <p>This class implements timer watchers/events. Time is represented as a |
1209 | <p>This class implements timer watchers/events. Time is represented as a |
958 | fractional number of seconds since the epoch. Example:</p> |
1210 | fractional number of seconds since the epoch. Example:</p> |
… | |
… | |
1024 | <pre> |
1276 | <pre> |
1025 | $term->{socket} = ... |
1277 | $term->{socket} = ... |
1026 | $term->{iow} = urxvt::iow |
1278 | $term->{iow} = urxvt::iow |
1027 | ->new |
1279 | ->new |
1028 | ->fd (fileno $term->{socket}) |
1280 | ->fd (fileno $term->{socket}) |
1029 | ->events (1) # wait for read data |
1281 | ->events (urxvt::EVENT_READ) |
1030 | ->start |
1282 | ->start |
1031 | ->cb (sub { |
1283 | ->cb (sub { |
1032 | my ($iow, $revents) = @_; |
1284 | my ($iow, $revents) = @_; |
1033 | # $revents must be 1 here, no need to check |
1285 | # $revents must be 1 here, no need to check |
1034 | sysread $term->{socket}, my $buf, 8192 |
1286 | sysread $term->{socket}, my $buf, 8192 |
… | |
… | |
1055 | </dd> |
1307 | </dd> |
1056 | <p></p> |
1308 | <p></p> |
1057 | <dt><strong><a name="item_events">$iow = $iow->events ($eventmask)</a></strong><br /> |
1309 | <dt><strong><a name="item_events">$iow = $iow->events ($eventmask)</a></strong><br /> |
1058 | </dt> |
1310 | </dt> |
1059 | <dd> |
1311 | <dd> |
1060 | Set the event mask to watch. Bit #0 (value <code>1</code>) enables watching for read |
1312 | Set the event mask to watch. The only allowed values are |
1061 | data, Bit #1 (value <code>2</code>) enables watching for write data. |
1313 | <code>urxvt::EVENT_READ</code> and <code>urxvt::EVENT_WRITE</code>, which might be ORed |
|
|
1314 | together, or <code>urxvt::EVENT_NONE</code>. |
1062 | </dd> |
1315 | </dd> |
1063 | <p></p> |
1316 | <p></p> |
1064 | <dt><strong>$iow = $iow->start</strong><br /> |
1317 | <dt><strong>$iow = $iow->start</strong><br /> |
1065 | </dt> |
1318 | </dt> |
1066 | <dd> |
1319 | <dd> |
… | |
… | |
1081 | </p> |
1334 | </p> |
1082 | <h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> |
1335 | <h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> |
1083 | <p>This variable controls the verbosity level of the perl extension. Higher |
1336 | <p>This variable controls the verbosity level of the perl extension. Higher |
1084 | numbers indicate more verbose output.</p> |
1337 | numbers indicate more verbose output.</p> |
1085 | <dl> |
1338 | <dl> |
1086 | <dt><strong><a name="item__3d0__2d_only_fatal_messages">=0 - only fatal messages</a></strong><br /> |
1339 | <dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br /> |
1087 | </dt> |
1340 | </dt> |
1088 | <dt><strong><a name="item__3d3__2d_script_loading_and_management">=3 - script loading and management</a></strong><br /> |
1341 | <dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">>= 3 - script loading and management</a></strong><br /> |
1089 | </dt> |
1342 | </dt> |
1090 | <dt><strong><a name="item__3d10__2d_all_events_received">=10 - all events received</a></strong><br /> |
1343 | <dt><strong><a name="item__3e_3d10__2d_all_called_hooks">>=10 - all called hooks</a></strong><br /> |
|
|
1344 | </dt> |
|
|
1345 | <dt><strong><a name="item__3e_3d11__2d_hook_reutrn_values">>=11 - hook reutrn values</a></strong><br /> |
1091 | </dt> |
1346 | </dt> |
1092 | </dl> |
1347 | </dl> |
1093 | <p> |
1348 | <p> |
1094 | </p> |
1349 | </p> |
1095 | <hr /> |
1350 | <hr /> |