… | |
… | |
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 | |
|
|
22 | <li><a href="#general_api_considerations">General API Considerations</a></li> |
|
|
23 | <li><a href="#extension_objects">Extension Objects</a></li> |
20 | <li><a href="#hooks">Hooks</a></li> |
24 | <li><a href="#hooks">Hooks</a></li> |
|
|
25 | <li><a href="#variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></li> |
21 | <li><a href="#functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></li> |
26 | <li><a href="#functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></li> |
|
|
27 | <li><a href="#rendition">RENDITION</a></li> |
|
|
28 | <li><a href="#the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></li> |
22 | <li><a href="#the_urxvt__term_class">The <code>urxvt::term</code> Class</a></li> |
29 | <li><a href="#the_urxvt__term_class">The <code>urxvt::term</code> Class</a></li> |
|
|
30 | <li><a href="#the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></li> |
23 | <li><a href="#the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></li> |
31 | <li><a href="#the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></li> |
24 | <li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li> |
32 | <li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li> |
25 | </ul> |
33 | </ul> |
26 | |
34 | |
27 | <li><a href="#environment">ENVIRONMENT</a></li> |
35 | <li><a href="#environment">ENVIRONMENT</a></li> |
… | |
… | |
35 | <!-- INDEX END --> |
43 | <!-- INDEX END --> |
36 | |
44 | |
37 | <hr /> |
45 | <hr /> |
38 | <p> |
46 | <p> |
39 | </p> |
47 | </p> |
|
|
48 | <hr /> |
40 | <h1><a name="name">NAME</a></h1> |
49 | <h1><a name="name">NAME</a></h1> |
41 | <p>rxvtperl - rxvt-unicode's embedded perl interpreter</p> |
50 | <p>rxvtperl - rxvt-unicode's embedded perl interpreter</p> |
42 | <p> |
51 | <p> |
43 | </p> |
52 | </p> |
44 | <hr /> |
53 | <hr /> |
45 | <h1><a name="synopsis">SYNOPSIS</a></h1> |
54 | <h1><a name="synopsis">SYNOPSIS</a></h1> |
46 | <p>* Put your scripts into <em>/opt/rxvt/lib/urxvt/perl-ext/</em>, they will be loaded automatically.</p> |
55 | <pre> |
47 | <p>* Each script will only be loaded once, even in urxvtd, and will be valid |
56 | # create a file grab_test in $HOME:</pre> |
48 | globally.</p> |
|
|
49 | <p>* Scripts are evaluated in a 'use strict' and 'use utf8' environment, and |
|
|
50 | thus must be encoded as UTF-8.</p> |
|
|
51 | <pre> |
57 | <pre> |
52 | sub on_sel_grab { |
58 | sub on_sel_grab { |
53 | warn "you selected ", $_[0]->selection; |
59 | warn "you selected ", $_[0]->selection; |
54 | () |
60 | () |
55 | }</pre> |
61 | }</pre> |
56 | <pre> |
62 | <pre> |
57 | 1</pre> |
63 | # start a rxvt using it:</pre> |
|
|
64 | <pre> |
|
|
65 | rxvt --perl-lib $HOME -pe grab_test</pre> |
58 | <p> |
66 | <p> |
59 | </p> |
67 | </p> |
60 | <hr /> |
68 | <hr /> |
61 | <h1><a name="description">DESCRIPTION</a></h1> |
69 | <h1><a name="description">DESCRIPTION</a></h1> |
|
|
70 | <p>Everytime a terminal object gets created, extension scripts specified via |
|
|
71 | the <code>perl</code> resource are loaded and associated with it.</p> |
|
|
72 | <p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and |
|
|
73 | thus must be encoded as UTF-8.</p> |
|
|
74 | <p>Each script will only ever be loaded once, even in rxvtd, where |
|
|
75 | scripts will be shared (but not enabled) for all terminals.</p> |
|
|
76 | <p> |
|
|
77 | </p> |
|
|
78 | <hr /> |
|
|
79 | <h1><a name="prepackaged_extensions">PREPACKAGED EXTENSIONS</a></h1> |
|
|
80 | <p>This section describes the extensions delivered with this release. You can |
|
|
81 | find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> |
|
|
82 | <p>You can activate them like this:</p> |
|
|
83 | <pre> |
|
|
84 | rxvt -pe <extensionname></pre> |
|
|
85 | <dl> |
|
|
86 | <dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br /> |
|
|
87 | </dt> |
|
|
88 | <dd> |
|
|
89 | (More) intelligent selection. This extension tries to be more intelligent |
|
|
90 | when the user extends selections (double-click). Right now, it tries to |
|
|
91 | select urls and complete shell-quoted arguments, which is very convenient, |
|
|
92 | too, if your <em>ls</em> supports <code>--quoting-style=shell</code>. |
|
|
93 | </dd> |
|
|
94 | <dd> |
|
|
95 | <p>It also offers the following bindable keyboard command:</p> |
|
|
96 | </dd> |
|
|
97 | <dl> |
|
|
98 | <dt><strong><a name="item_rot13">rot13</a></strong><br /> |
|
|
99 | </dt> |
|
|
100 | <dd> |
|
|
101 | Rot-13 the selection when activated. Used via keyboard trigger: |
|
|
102 | </dd> |
|
|
103 | <dd> |
|
|
104 | <pre> |
|
|
105 | URxvt.keysym.C-M-r: perl:selection:rot13</pre> |
|
|
106 | </dd> |
|
|
107 | <p></p></dl> |
|
|
108 | <dt><strong><a name="item_popup">option-popup (enabled by default)</a></strong><br /> |
|
|
109 | </dt> |
|
|
110 | <dd> |
|
|
111 | Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at |
|
|
112 | runtime. |
|
|
113 | </dd> |
|
|
114 | <p></p> |
|
|
115 | <dt><strong>selection-popup (enabled by default)</strong><br /> |
|
|
116 | </dt> |
|
|
117 | <dd> |
|
|
118 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
|
|
119 | text into various other formats/action (such as uri unescaping, perl |
|
|
120 | evalution, web-browser starting etc.), depending on content. |
|
|
121 | </dd> |
|
|
122 | <p></p> |
|
|
123 | <dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback<hotkey> (enabled by default)</a></strong><br /> |
|
|
124 | </dt> |
|
|
125 | <dd> |
|
|
126 | Adds regex search functionality to the scrollback buffer, triggered |
|
|
127 | by a hotkey (default: <code>M-s</code>). When in search mode, normal terminal |
|
|
128 | input/output is suspended. |
|
|
129 | </dd> |
|
|
130 | <dd> |
|
|
131 | <p><code>/</code> starts an incremental regex search, <code>n</code> searches further, <code>p</code> or |
|
|
132 | <code>N</code> jump to the previous match, <code>G</code> jumps to the bottom and clears the |
|
|
133 | history, <code>enter</code> leaves search mode at the current position and <code>escape</code> |
|
|
134 | returns to the original position.</p> |
|
|
135 | </dd> |
|
|
136 | <p></p> |
|
|
137 | <dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> |
|
|
138 | </dt> |
|
|
139 | <dd> |
|
|
140 | Displays a digital clock using the built-in overlay. |
|
|
141 | </dd> |
|
|
142 | <p></p> |
|
|
143 | <dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> |
|
|
144 | </dt> |
|
|
145 | <dd> |
|
|
146 | Uses per-line display filtering (<code>on_line_update</code>) to underline urls. |
|
|
147 | </dd> |
|
|
148 | <p></p> |
|
|
149 | <dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br /> |
|
|
150 | </dt> |
|
|
151 | <dd> |
|
|
152 | A not very useful example of filtering all text output to the terminal, |
|
|
153 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
|
|
154 | similar-looking ascii character. |
|
|
155 | </dd> |
|
|
156 | <p></p> |
|
|
157 | <dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> |
|
|
158 | </dt> |
|
|
159 | <dd> |
|
|
160 | Displays a very simple digital clock in the upper right corner of the |
|
|
161 | window. Illustrates overwriting the refresh callbacks to create your own |
|
|
162 | overlays or changes. |
|
|
163 | </dd> |
|
|
164 | <p></p></dl> |
|
|
165 | <p> |
|
|
166 | </p> |
|
|
167 | <hr /> |
|
|
168 | <h1><a name="api_documentation">API DOCUMENTATION</a></h1> |
|
|
169 | <p> |
|
|
170 | </p> |
|
|
171 | <h2><a name="general_api_considerations">General API Considerations</a></h2> |
|
|
172 | <p>All objects (such as terminals, time watchers etc.) are typical |
|
|
173 | reference-to-hash objects. The hash can be used to store anything you |
|
|
174 | like. All members starting with an underscore (such as <code>_ptr</code> or |
|
|
175 | <code>_hook</code>) are reserved for internal uses and <strong>MUST NOT</strong> be accessed or |
|
|
176 | modified).</p> |
|
|
177 | <p>When objects are destroyed on the C++ side, the perl object hashes are |
|
|
178 | emptied, so its best to store related objects such as time watchers and |
|
|
179 | the like inside the terminal object so they get destroyed as soon as the |
|
|
180 | terminal is destroyed.</p> |
|
|
181 | <p>Argument names also often indicate the type of a parameter. Here are some |
|
|
182 | hints on what they mean:</p> |
|
|
183 | <dl> |
|
|
184 | <dt><strong><a name="item__24text">$text</a></strong><br /> |
|
|
185 | </dt> |
|
|
186 | <dd> |
|
|
187 | Rxvt-unicodes special way of encoding text, where one ``unicode'' character |
|
|
188 | always represents one screen cell. See <a href="#item_row_t">ROW_t</a> for a discussion of this format. |
|
|
189 | </dd> |
|
|
190 | <p></p> |
|
|
191 | <dt><strong><a name="item__24string">$string</a></strong><br /> |
|
|
192 | </dt> |
|
|
193 | <dd> |
|
|
194 | A perl text string, with an emphasis on <em>text</em>. It can store all unicode |
|
|
195 | characters and is to be distinguished with text encoded in a specific |
|
|
196 | encoding (often locale-specific) and binary data. |
|
|
197 | </dd> |
|
|
198 | <p></p> |
|
|
199 | <dt><strong><a name="item__24octets">$octets</a></strong><br /> |
|
|
200 | </dt> |
|
|
201 | <dd> |
|
|
202 | Either binary data or - more common - a text string encoded in a |
|
|
203 | locale-specific way. |
|
|
204 | </dd> |
|
|
205 | <p></p></dl> |
|
|
206 | <p> |
|
|
207 | </p> |
|
|
208 | <h2><a name="extension_objects">Extension Objects</a></h2> |
|
|
209 | <p>Very perl extension is a perl class. A separate perl object is created |
|
|
210 | for each terminal and each extension and passed as the first parameter to |
|
|
211 | hooks. So extensions can use their <code>$self</code> object without having to think |
|
|
212 | about other extensions, with the exception of methods and members that |
|
|
213 | begin with an underscore character <code>_</code>: these are reserved for internal |
|
|
214 | use.</p> |
|
|
215 | <p>Although it isn't a <code>urxvt::term</code> object, you can call all methods of the |
|
|
216 | <code>urxvt::term</code> class on this object.</p> |
|
|
217 | <p>It has the following methods and data members:</p> |
|
|
218 | <dl> |
|
|
219 | <dt><strong><a name="item__24urxvt_term__3d__24self_2d_3e_7bterm_7d">$urxvt_term = $self->{term}</a></strong><br /> |
|
|
220 | </dt> |
|
|
221 | <dd> |
|
|
222 | Returns the <code>urxvt::term</code> object associated with this instance of the |
|
|
223 | extension. This member <em>must not</em> be changed in any way. |
|
|
224 | </dd> |
|
|
225 | <p></p> |
|
|
226 | <dt><strong><a name="item_enable">$self->enable ($hook_name => $cb, [$hook_name => $cb..])</a></strong><br /> |
|
|
227 | </dt> |
|
|
228 | <dd> |
|
|
229 | Dynamically enable the given hooks (named without the <code>on_</code> prefix) for |
|
|
230 | this extension, replacing any previous hook. This is useful when you want |
|
|
231 | to overwrite time-critical hooks only temporarily. |
|
|
232 | </dd> |
|
|
233 | <p></p> |
|
|
234 | <dt><strong><a name="item_disable">$self->disable ($hook_name[, $hook_name..])</a></strong><br /> |
|
|
235 | </dt> |
|
|
236 | <dd> |
|
|
237 | Dynamically disable the given hooks. |
|
|
238 | </dd> |
|
|
239 | <p></p></dl> |
62 | <p> |
240 | <p> |
63 | </p> |
241 | </p> |
64 | <h2><a name="hooks">Hooks</a></h2> |
242 | <h2><a name="hooks">Hooks</a></h2> |
65 | <p>The following subroutines can be declared in loaded scripts, and will be called |
243 | <p>The following subroutines can be declared in extension files, and will be |
66 | whenever the relevant event happens.</p> |
244 | called whenever the relevant event happens.</p> |
|
|
245 | <p>The first argument passed to them is an extension oject as described in |
|
|
246 | the in the <code>Extension Objects</code> section.</p> |
67 | <p>All of them must return a boolean value. If it is true, then the event |
247 | <p><strong>All</strong> of these hooks must return a boolean value. If it is true, then the |
68 | counts as being <em>consumed</em>, and the invocation of other hooks is skipped, |
248 | event counts as being <em>consumed</em>, and the invocation of other hooks is |
69 | and the relevant action might not be carried out by the C++ code.</p> |
249 | skipped, and the relevant action might not be carried out by the C++ code.</p> |
70 | <p>When in doubt, return a false value (preferably <code>()</code>).</p> |
250 | <p><em>When in doubt, return a false value (preferably <code>()</code>). </em>></p> |
71 | <dl> |
251 | <dl> |
72 | <dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> |
252 | <dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> |
73 | </dt> |
253 | </dt> |
74 | <dd> |
254 | <dd> |
75 | Called after a new terminal object has been initialized, but before |
255 | Called after a new terminal object has been initialized, but before |
76 | windows are created or the command gets run. |
256 | windows are created or the command gets run. Most methods are unsafe to |
|
|
257 | call or deliver senseless data, as terminal size and other characteristics |
|
|
258 | have not yet been determined. You can safely query and change resources, |
|
|
259 | though. |
77 | </dd> |
260 | </dd> |
78 | <p></p> |
261 | <p></p> |
79 | <dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> |
262 | <dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> |
80 | </dt> |
263 | </dt> |
81 | <dd> |
264 | <dd> |
… | |
… | |
112 | </dd> |
295 | </dd> |
113 | <dd> |
296 | <dd> |
114 | <p>Returning a true value aborts selection grabbing. It will still be hilighted.</p> |
297 | <p>Returning a true value aborts selection grabbing. It will still be hilighted.</p> |
115 | </dd> |
298 | </dd> |
116 | <p></p> |
299 | <p></p> |
117 | <dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> |
300 | <dt><strong><a name="item_on_sel_extend__24term">on_sel_extend $term</a></strong><br /> |
118 | </dt> |
301 | </dt> |
119 | <dd> |
|
|
120 | Called whenever the window gets the keyboard focus, before urxvt does |
|
|
121 | focus in processing. |
|
|
122 | </dd> |
302 | <dd> |
123 | <p></p> |
303 | Called whenever the user tries to extend the selection (e.g. with a double |
124 | <dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong><br /> |
304 | click) and is either supposed to return false (normal operation), or |
125 | </dt> |
305 | should extend the selection itelf and return true to suppress the built-in |
|
|
306 | processing. |
126 | <dd> |
307 | </dd> |
127 | Called wheneever the window loses keyboard focus, before urxvt does focus |
308 | <dd> |
128 | out processing. |
309 | <p>See the <em>selection</em> example extension.</p> |
129 | </dd> |
310 | </dd> |
130 | <p></p> |
311 | <p></p> |
131 | <dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong><br /> |
312 | <dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong><br /> |
132 | </dt> |
313 | </dt> |
133 | <dd> |
314 | <dd> |
… | |
… | |
147 | <p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
328 | <p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
148 | $nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total |
329 | $nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total |
149 | number of lines that will be in the scrollback buffer.</p> |
330 | number of lines that will be in the scrollback buffer.</p> |
150 | </dd> |
331 | </dd> |
151 | <p></p> |
332 | <p></p> |
152 | <dt><strong><a name="item_on_tty_activity__24term__2anyi_2a">on_tty_activity $term *NYI*</a></strong><br /> |
333 | <dt><strong><a name="item_on_osc_seq__24term_2c__24string">on_osc_seq $term, $string</a></strong><br /> |
153 | </dt> |
334 | </dt> |
|
|
335 | <dd> |
|
|
336 | Called whenever the <strong>ESC ] 777 ; string ST</strong> command sequence (OSC = |
|
|
337 | operating system command) is processed. Cursor position and other state |
|
|
338 | information is up-to-date when this happens. For interoperability, the |
|
|
339 | string should start with the extension name and a colon, to distinguish |
|
|
340 | it from commands for other extensions, and this might be enforced in the |
|
|
341 | future. |
154 | <dd> |
342 | </dd> |
155 | Called whenever the <code>program(s)</code> running in the urxvt window send output. |
343 | <dd> |
|
|
344 | <p>Be careful not ever to trust (in a security sense) the data you receive, |
|
|
345 | as its source can not easily be controleld (e-mail content, messages from |
|
|
346 | other users on the same system etc.).</p> |
|
|
347 | </dd> |
|
|
348 | <p></p> |
|
|
349 | <dt><strong><a name="item_on_add_lines__24term_2c__24string">on_add_lines $term, $string</a></strong><br /> |
|
|
350 | </dt> |
|
|
351 | <dd> |
|
|
352 | Called whenever text is about to be output, with the text as argument. You |
|
|
353 | can filter/change and output the text yourself by returning a true value |
|
|
354 | and calling <a href="#item_scr_add_lines"><code>$term->scr_add_lines</code></a> yourself. Please note that this |
|
|
355 | might be very slow, however, as your hook is called for <strong>all</strong> text being |
|
|
356 | output. |
|
|
357 | </dd> |
|
|
358 | <p></p> |
|
|
359 | <dt><strong><a name="item_on_tt_write__24term_2c__24octets">on_tt_write $term, $octets</a></strong><br /> |
|
|
360 | </dt> |
|
|
361 | <dd> |
|
|
362 | Called whenever some data is written to the tty/pty and can be used to |
|
|
363 | suppress or filter tty input. |
|
|
364 | </dd> |
|
|
365 | <p></p> |
|
|
366 | <dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong><br /> |
|
|
367 | </dt> |
|
|
368 | <dd> |
|
|
369 | Called whenever a line was updated or changed. Can be used to filter |
|
|
370 | screen output (e.g. underline urls or other useless stuff). Only lines |
|
|
371 | that are being shown will be filtered, and, due to performance reasons, |
|
|
372 | not always immediately. |
|
|
373 | </dd> |
|
|
374 | <dd> |
|
|
375 | <p>The row number is always the topmost row of the line if the line spans |
|
|
376 | multiple rows.</p> |
|
|
377 | </dd> |
|
|
378 | <dd> |
|
|
379 | <p>Please note that, if you change the line, then the hook might get called |
|
|
380 | later with the already-modified line (e.g. if unrelated parts change), so |
|
|
381 | you cannot just toggle rendition bits, but only set them.</p> |
156 | </dd> |
382 | </dd> |
157 | <p></p> |
383 | <p></p> |
158 | <dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong><br /> |
384 | <dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong><br /> |
159 | </dt> |
385 | </dt> |
160 | <dd> |
386 | <dd> |
… | |
… | |
167 | <dt><strong><a name="item_on_refresh_end__24term">on_refresh_end $term</a></strong><br /> |
393 | <dt><strong><a name="item_on_refresh_end__24term">on_refresh_end $term</a></strong><br /> |
168 | </dt> |
394 | </dt> |
169 | <dd> |
395 | <dd> |
170 | Called just after the screen gets redrawn. See <code>on_refresh_begin</code>. |
396 | Called just after the screen gets redrawn. See <code>on_refresh_begin</code>. |
171 | </dd> |
397 | </dd> |
|
|
398 | <p></p> |
|
|
399 | <dt><strong><a name="item_on_keyboard_command__24term_2c__24string">on_keyboard_command $term, $string</a></strong><br /> |
|
|
400 | </dt> |
|
|
401 | <dd> |
|
|
402 | Called whenever the user presses a key combination that has a |
|
|
403 | <code>perl:string</code> action bound to it (see description of the <strong>keysym</strong> |
|
|
404 | resource in the <code>rxvt(1)</code> manpage). |
|
|
405 | </dd> |
|
|
406 | <p></p> |
|
|
407 | <dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> |
|
|
408 | </dt> |
|
|
409 | <dd> |
|
|
410 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
|
|
411 | does focus in processing. |
|
|
412 | </dd> |
|
|
413 | <p></p> |
|
|
414 | <dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong><br /> |
|
|
415 | </dt> |
|
|
416 | <dd> |
|
|
417 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
|
|
418 | focus out processing. |
|
|
419 | </dd> |
|
|
420 | <p></p> |
|
|
421 | <dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a></strong><br /> |
|
|
422 | </dt> |
|
|
423 | <dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br /> |
|
|
424 | </dt> |
|
|
425 | <dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br /> |
|
|
426 | </dt> |
|
|
427 | <dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br /> |
|
|
428 | </dt> |
|
|
429 | <dt><strong><a name="item_on_motion_notify__24term_2c__24event">on_motion_notify $term, $event</a></strong><br /> |
|
|
430 | </dt> |
|
|
431 | <dt><strong><a name="item_on_map_notify__24term_2c__24event">on_map_notify $term, $event</a></strong><br /> |
|
|
432 | </dt> |
|
|
433 | <dt><strong><a name="item_on_unmap_notify__24term_2c__24event">on_unmap_notify $term, $event</a></strong><br /> |
|
|
434 | </dt> |
|
|
435 | <dd> |
|
|
436 | Called whenever the corresponding X event is received for the terminal If |
|
|
437 | the hook returns true, then the even will be ignored by rxvt-unicode. |
|
|
438 | </dd> |
|
|
439 | <dd> |
|
|
440 | <p>The event is a hash with most values as named by Xlib (see the XEvent |
|
|
441 | manpage), with the additional members <code>row</code> and <code>col</code>, which are the row |
|
|
442 | and column under the mouse cursor.</p> |
|
|
443 | </dd> |
|
|
444 | <dd> |
|
|
445 | <p><code>on_key_press</code> additionally receives the string rxvt-unicode would |
|
|
446 | output, if any, in locale-specific encoding.</p> |
|
|
447 | </dd> |
|
|
448 | <dd> |
|
|
449 | <p>subwindow.</p> |
|
|
450 | </dd> |
|
|
451 | <p></p></dl> |
|
|
452 | <p> |
|
|
453 | </p> |
|
|
454 | <h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> |
|
|
455 | <dl> |
|
|
456 | <dt><strong><a name="item__24urxvt_3a_3alibdir">$urxvt::LIBDIR</a></strong><br /> |
|
|
457 | </dt> |
|
|
458 | <dd> |
|
|
459 | The rxvt-unicode library directory, where, among other things, the perl |
|
|
460 | modules and scripts are stored. |
|
|
461 | </dd> |
|
|
462 | <p></p> |
|
|
463 | <dt><strong><a name="item__24urxvt_3a_3aresclass_2c__24urxvt_3a_3aresclass">$urxvt::RESCLASS, $urxvt::RESCLASS</a></strong><br /> |
|
|
464 | </dt> |
|
|
465 | <dd> |
|
|
466 | The resource class and name rxvt-unicode uses to look up X resources. |
|
|
467 | </dd> |
|
|
468 | <p></p> |
|
|
469 | <dt><strong><a name="item__24urxvt_3a_3arxvtname">$urxvt::RXVTNAME</a></strong><br /> |
|
|
470 | </dt> |
|
|
471 | <dd> |
|
|
472 | The basename of the installed binaries, usually <code>urxvt</code>. |
|
|
473 | </dd> |
|
|
474 | <p></p> |
|
|
475 | <dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br /> |
|
|
476 | </dt> |
|
|
477 | <dd> |
|
|
478 | The current terminal. This variable stores the current <code>urxvt::term</code> |
|
|
479 | object, whenever a callback/hook is executing. |
|
|
480 | </dd> |
172 | <p></p></dl> |
481 | <p></p></dl> |
173 | <p> |
482 | <p> |
174 | </p> |
483 | </p> |
175 | <h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> |
484 | <h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> |
176 | <dl> |
485 | <dl> |
… | |
… | |
183 | </dd> |
492 | </dd> |
184 | <p></p> |
493 | <p></p> |
185 | <dt><strong><a name="item_urxvt_3a_3awarn__24string">urxvt::warn $string</a></strong><br /> |
494 | <dt><strong><a name="item_urxvt_3a_3awarn__24string">urxvt::warn $string</a></strong><br /> |
186 | </dt> |
495 | </dt> |
187 | <dd> |
496 | <dd> |
188 | Calls <code>rxvt_warn</code> witht eh given string which should not include a |
497 | Calls <code>rxvt_warn</code> with the given string which should not include a |
189 | newline. The module also overwrites the <code>warn</code> builtin with a function |
498 | newline. The module also overwrites the <code>warn</code> builtin with a function |
190 | that calls this function. |
499 | that calls this function. |
191 | </dd> |
500 | </dd> |
192 | <dd> |
501 | <dd> |
193 | <p>Using this function has the advantage that its output ends up in the |
502 | <p>Using this function has the advantage that its output ends up in the |
194 | correct place, e.g. on stderr of the connecting urxvtc client.</p> |
503 | correct place, e.g. on stderr of the connecting urxvtc client.</p> |
195 | </dd> |
504 | </dd> |
196 | <p></p> |
505 | <dd> |
197 | <dt><strong><a name="item__24cellwidth__3d_urxvt_3a_3awcswidth__24string">$cellwidth = urxvt::wcswidth $string</a></strong><br /> |
506 | <p>Messages have a size limit of 1023 bytes currently.</p> |
198 | </dt> |
|
|
199 | <dd> |
507 | </dd> |
200 | Returns the number of screen-cells this string would need. Correctly |
508 | <p></p> |
201 | accounts for wide and combining characters. |
509 | <dt><strong><a name="item__24is_safe__3d_urxvt_3a_3asafe">$is_safe = urxvt::safe</a></strong><br /> |
|
|
510 | </dt> |
|
|
511 | <dd> |
|
|
512 | Returns true when it is safe to do potentially unsafe things, such as |
|
|
513 | evaluating perl code specified by the user. This is true when urxvt was |
|
|
514 | started setuid or setgid. |
202 | </dd> |
515 | </dd> |
203 | <p></p> |
516 | <p></p> |
204 | <dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> |
517 | <dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> |
205 | </dt> |
518 | </dt> |
206 | <dd> |
519 | <dd> |
207 | Returns the ``current time'' (as per the event loop). |
520 | Returns the ``current time'' (as per the event loop). |
208 | </dd> |
521 | </dd> |
|
|
522 | <p></p> |
|
|
523 | <dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br /> |
|
|
524 | </dt> |
|
|
525 | <dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
|
|
526 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
|
|
527 | Button4Mask, Button5Mask, AnyModifier</a></strong><br /> |
|
|
528 | </dt> |
|
|
529 | <dd> |
|
|
530 | Various constants for use in X calls and event processing. |
|
|
531 | </dd> |
209 | <p></p></dl> |
532 | <p></p></dl> |
210 | <p> |
533 | <p> |
211 | </p> |
534 | </p> |
|
|
535 | <h2><a name="rendition">RENDITION</a></h2> |
|
|
536 | <p>Rendition bitsets contain information about colour, font, font styles and |
|
|
537 | similar information for each screen cell.</p> |
|
|
538 | <p>The following ``macros'' deal with changes in rendition sets. You should |
|
|
539 | never just create a bitset, you should always modify an existing one, |
|
|
540 | as they contain important information required for correct operation of |
|
|
541 | rxvt-unicode.</p> |
|
|
542 | <dl> |
|
|
543 | <dt><strong><a name="item__24rend__3d_urxvt_3a_3adefault_rstyle">$rend = urxvt::DEFAULT_RSTYLE</a></strong><br /> |
|
|
544 | </dt> |
|
|
545 | <dd> |
|
|
546 | Returns the default rendition, as used when the terminal is starting up or |
|
|
547 | being reset. Useful as a base to start when creating renditions. |
|
|
548 | </dd> |
|
|
549 | <p></p> |
|
|
550 | <dt><strong><a name="item__24rend__3d_urxvt_3a_3aoverlay_rstyle">$rend = urxvt::OVERLAY_RSTYLE</a></strong><br /> |
|
|
551 | </dt> |
|
|
552 | <dd> |
|
|
553 | Return the rendition mask used for overlays by default. |
|
|
554 | </dd> |
|
|
555 | <p></p> |
|
|
556 | <dt><strong><a name="item__24rendbit__3d_urxvt_3a_3ars_bold_2c_rs_italic_2c_">$rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline</a></strong><br /> |
|
|
557 | </dt> |
|
|
558 | <dd> |
|
|
559 | Return the bit that enabled bold, italic, blink, reverse-video and |
|
|
560 | underline, respectively. To enable such a style, just logically OR it into |
|
|
561 | the bitset. |
|
|
562 | </dd> |
|
|
563 | <p></p> |
|
|
564 | <dt><strong><a name="item__24foreground__3d_urxvt_3a_3aget_basefg__24rend">$foreground = urxvt::GET_BASEFG $rend</a></strong><br /> |
|
|
565 | </dt> |
|
|
566 | <dt><strong><a name="item__24background__3d_urxvt_3a_3aget_basebg__24rend">$background = urxvt::GET_BASEBG $rend</a></strong><br /> |
|
|
567 | </dt> |
|
|
568 | <dd> |
|
|
569 | Return the foreground/background colour index, respectively. |
|
|
570 | </dd> |
|
|
571 | <p></p> |
|
|
572 | <dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_fgcolor__24rend_2c__24n">$rend = urxvt::SET_FGCOLOR $rend, $new_colour</a></strong><br /> |
|
|
573 | </dt> |
|
|
574 | <dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_bgcolor__24rend_2c__24n">$rend = urxvt::SET_BGCOLOR $rend, $new_colour</a></strong><br /> |
|
|
575 | </dt> |
|
|
576 | <dd> |
|
|
577 | Replace the foreground/background colour in the rendition mask with the |
|
|
578 | specified one. |
|
|
579 | </dd> |
|
|
580 | <p></p> |
|
|
581 | <dt><strong><a name="item__24value__3d_urxvt_3a_3aget_custom__24rend">$value = urxvt::GET_CUSTOM $rend</a></strong><br /> |
|
|
582 | </dt> |
|
|
583 | <dd> |
|
|
584 | Return the ``custom'' value: Every rendition has 5 bits for use by |
|
|
585 | extensions. They can be set and changed as you like and are initially |
|
|
586 | zero. |
|
|
587 | </dd> |
|
|
588 | <p></p> |
|
|
589 | <dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_custom__24rend_2c__24ne">$rend = urxvt::SET_CUSTOM $rend, $new_value</a></strong><br /> |
|
|
590 | </dt> |
|
|
591 | <dd> |
|
|
592 | Change the custom value. |
|
|
593 | </dd> |
|
|
594 | <p></p></dl> |
|
|
595 | <p> |
|
|
596 | </p> |
|
|
597 | <h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2> |
|
|
598 | <p>The sole purpose of this class is to deliver an interface to the |
|
|
599 | <code>AnyEvent</code> module - any module using it will work inside urxvt without |
|
|
600 | further programming. The only exception is that you cannot wait on |
|
|
601 | condition variables, but non-blocking condvar use is ok. What this means |
|
|
602 | is that you cannot use blocking APIs, but the non-blocking variant should |
|
|
603 | work.</p> |
|
|
604 | <p> |
|
|
605 | </p> |
212 | <h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> |
606 | <h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> |
213 | <dl> |
607 | <dl> |
|
|
608 | <dt><strong><a name="item__24term__3d_new_urxvt_3a_3aterm__24envhashref_2c__">$term = new urxvt::term $envhashref, $rxvtname, [arg...]</a></strong><br /> |
|
|
609 | </dt> |
|
|
610 | <dd> |
|
|
611 | Creates a new terminal, very similar as if you had started it with system |
|
|
612 | <code>$rxvtname, arg...</code>. <code>$envhashref</code> must be a reference to a <code>%ENV</code>-like |
|
|
613 | hash which defines the environment of the new terminal. |
|
|
614 | </dd> |
|
|
615 | <dd> |
|
|
616 | <p>Croaks (and probably outputs an error message) if the new instance |
|
|
617 | couldn't be created. Returns <code>undef</code> if the new instance didn't |
|
|
618 | initialise perl, and the terminal object otherwise. The <code>init</code> and |
|
|
619 | <a href="#item_start"><code>start</code></a> hooks will be called during this call.</p> |
|
|
620 | </dd> |
|
|
621 | <p></p> |
|
|
622 | <dt><strong><a name="item_destroy">$term->destroy</a></strong><br /> |
|
|
623 | </dt> |
|
|
624 | <dd> |
|
|
625 | Destroy the terminal object (close the window, free resources |
|
|
626 | etc.). Please note that rxvt will not exit as long as any event |
|
|
627 | watchers (timers, io watchers) are still active. |
|
|
628 | </dd> |
|
|
629 | <p></p> |
|
|
630 | <dt><strong><a name="item_option">$isset = $term->option ($optval[, $set])</a></strong><br /> |
|
|
631 | </dt> |
|
|
632 | <dd> |
|
|
633 | Returns true if the option specified by <code>$optval</code> is enabled, and |
|
|
634 | optionally change it. All option values are stored by name in the hash |
|
|
635 | <code>%urxvt::OPTION</code>. Options not enabled in this binary are not in the hash. |
|
|
636 | </dd> |
|
|
637 | <dd> |
|
|
638 | <p>Here is a a likely non-exhaustive list of option names, please see the |
|
|
639 | source file <em>/src/optinc.h</em> to see the actual list:</p> |
|
|
640 | </dd> |
|
|
641 | <dd> |
|
|
642 | <pre> |
|
|
643 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
|
|
644 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
|
|
645 | pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating |
|
|
646 | scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer |
|
|
647 | secondaryScreen secondaryScroll skipBuiltinGlyphs transparent |
|
|
648 | tripleclickwords utmpInhibit visualBell</pre> |
|
|
649 | </dd> |
|
|
650 | <p></p> |
214 | <dt><strong><a name="item_resource">$value = $term->resource ($name[, $newval])</a></strong><br /> |
651 | <dt><strong><a name="item_resource">$value = $term->resource ($name[, $newval])</a></strong><br /> |
215 | </dt> |
652 | </dt> |
216 | <dd> |
653 | <dd> |
217 | Returns the current resource value associated with a given name and |
654 | Returns the current resource value associated with a given name and |
218 | optionally sets a new value. Setting values is most useful in the <code>init</code> |
655 | optionally sets a new value. Setting values is most useful in the <code>init</code> |
… | |
… | |
232 | <p>Please note that resource strings will currently only be freed when the |
669 | <p>Please note that resource strings will currently only be freed when the |
233 | terminal is destroyed, so changing options frequently will eat memory.</p> |
670 | terminal is destroyed, so changing options frequently will eat memory.</p> |
234 | </dd> |
671 | </dd> |
235 | <dd> |
672 | <dd> |
236 | <p>Here is a a likely non-exhaustive list of resource names, not all of which |
673 | <p>Here is a a likely non-exhaustive list of resource names, not all of which |
237 | are supported in every build, please see the source to see the actual |
674 | are supported in every build, please see the source file <em>/src/rsinc.h</em> |
238 | list:</p> |
675 | to see the actual list:</p> |
239 | </dd> |
676 | </dd> |
240 | <dd> |
677 | <dd> |
241 | <pre> |
678 | <pre> |
242 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
679 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
243 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
680 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
244 | display_name embed ext_bwidth fade font geometry hold iconName |
681 | display_name embed ext_bwidth fade font geometry hold iconName |
245 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
682 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
246 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 |
683 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
247 | modifier mouseWheelScrollPage name pastableTabs path pointerBlank |
684 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 |
248 | pointerBlankDelay preeditType print_pipe pty_fd reverseVideo saveLines |
685 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
249 | scrollBar scrollBar_align scrollBar_floating scrollBar_right |
686 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
250 | scrollBar_thickness scrollTtyKeypress scrollTtyOutput scrollWithBuffer |
687 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
251 | scrollstyle secondaryScreen secondaryScroll selectstyle shade term_name |
688 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
252 | title transparent transparent_all tripleclickwords utmpInhibit |
689 | shade term_name title transparent transparent_all tripleclickwords |
253 | visualBell</pre> |
690 | utmpInhibit visualBell</pre> |
|
|
691 | </dd> |
|
|
692 | <p></p> |
|
|
693 | <dt><strong><a name="item_parse_keysym">$success = $term->parse_keysym ($keysym_spec, $command_string)</a></strong><br /> |
|
|
694 | </dt> |
|
|
695 | <dd> |
|
|
696 | Adds a keymap translation exactly as specified via a resource. See the |
|
|
697 | <code>keysym</code> resource in the <code>rxvt(1)</code> manpage. |
|
|
698 | </dd> |
|
|
699 | <p></p> |
|
|
700 | <dt><strong><a name="item_rstyle">$rend = $term->rstyle ([$new_rstyle])</a></strong><br /> |
|
|
701 | </dt> |
|
|
702 | <dd> |
|
|
703 | Return and optionally change the current rendition. Text that is output by |
|
|
704 | the terminal application will use this style. |
|
|
705 | </dd> |
|
|
706 | <p></p> |
|
|
707 | <dt><strong><a name="item_screen_cur">($row, $col) = $term->screen_cur ([$row, $col])</a></strong><br /> |
|
|
708 | </dt> |
|
|
709 | <dd> |
|
|
710 | Return the current coordinates of the text cursor position and optionally |
|
|
711 | set it (which is usually bad as applications don't expect that). |
254 | </dd> |
712 | </dd> |
255 | <p></p> |
713 | <p></p> |
256 | <dt><strong><a name="item_selection_mark">($row, $col) = $term->selection_mark ([$row, $col])</a></strong><br /> |
714 | <dt><strong><a name="item_selection_mark">($row, $col) = $term->selection_mark ([$row, $col])</a></strong><br /> |
257 | </dt> |
715 | </dt> |
258 | <dt><strong><a name="item_selection_beg">($row, $col) = $term->selection_beg ([$row, $col])</a></strong><br /> |
716 | <dt><strong><a name="item_selection_beg">($row, $col) = $term->selection_beg ([$row, $col])</a></strong><br /> |
… | |
… | |
269 | <dd> |
727 | <dd> |
270 | Try to request the primary selection from the server (for example, as set |
728 | Try to request the primary selection from the server (for example, as set |
271 | by the next method). |
729 | by the next method). |
272 | </dd> |
730 | </dd> |
273 | <p></p> |
731 | <p></p> |
274 | <dt><strong><a name="item_selection">$oldtext = $term->selection ([$newtext])</a></strong><br /> |
732 | <dt><strong>$oldtext = $term->selection ([$newtext])</strong><br /> |
275 | </dt> |
733 | </dt> |
276 | <dd> |
734 | <dd> |
277 | Return the current selection text and optionally replace it by <code>$newtext</code>. |
735 | Return the current selection text and optionally replace it by <code>$newtext</code>. |
278 | </dd> |
736 | </dd> |
279 | <p></p> |
737 | <p></p> |
280 | <dt><strong><a name="item_scr_overlay">$term->scr_overlay ($x, $y, $text)</a></strong><br /> |
738 | <dt><strong><a name="item_overlay_simple">$term->overlay_simple ($x, $y, $text)</a></strong><br /> |
281 | </dt> |
739 | </dt> |
282 | <dd> |
740 | <dd> |
283 | Create a simple multi-line overlay box. See the next method for details. |
741 | Create a simple multi-line overlay box. See the next method for details. |
284 | </dd> |
742 | </dd> |
285 | <p></p> |
743 | <p></p> |
286 | <dt><strong><a name="item_scr_overlay_new">$term->scr_overlay_new ($x, $y, $width, $height)</a></strong><br /> |
744 | <dt><strong><a name="item_overlay">$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br /> |
287 | </dt> |
745 | </dt> |
288 | <dd> |
746 | <dd> |
289 | Create a new (empty) overlay at the given position with the given |
747 | Create a new (empty) overlay at the given position with the given |
290 | width/height. A border will be put around the box. If either <code>$x</code> or |
748 | width/height. <code>$rstyle</code> defines the initial rendition style |
291 | <code>$y</code> is negative, then this is counted from the right/bottom side, |
749 | (default: <code>OVERLAY_RSTYLE</code>). |
292 | respectively. |
|
|
293 | </dd> |
|
|
294 | <p></p> |
|
|
295 | <dt><strong><a name="item_scr_overlay_off">$term->scr_overlay_off</a></strong><br /> |
|
|
296 | </dt> |
|
|
297 | <dd> |
750 | </dd> |
298 | Switch the overlay off again. |
|
|
299 | </dd> |
751 | <dd> |
300 | <p></p> |
752 | <p>If <code>$border</code> is <code>2</code> (default), then a decorative border will be put |
301 | <dt><strong><a name="item_scr_overlay_set_char">$term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE)</a></strong><br /> |
753 | around the box.</p> |
302 | </dt> |
|
|
303 | <dd> |
754 | </dd> |
304 | Put a single character (specified numerically) at the given overlay |
|
|
305 | position. |
|
|
306 | </dd> |
755 | <dd> |
307 | <p></p> |
756 | <p>If either <code>$x</code> or <code>$y</code> is negative, then this is counted from the |
308 | <dt><strong><a name="item_scr_overlay_set">$term->scr_overlay_set ($x, $y, $text)</a></strong><br /> |
757 | right/bottom side, respectively.</p> |
309 | </dt> |
|
|
310 | <dd> |
758 | </dd> |
311 | Write a string at the given position into the overlay. |
759 | <dd> |
|
|
760 | <p>This method returns an urxvt::overlay object. The overlay will be visible |
|
|
761 | as long as the perl object is referenced.</p> |
|
|
762 | </dd> |
|
|
763 | <dd> |
|
|
764 | <p>The methods currently supported on <code>urxvt::overlay</code> objects are:</p> |
|
|
765 | </dd> |
|
|
766 | <dl> |
|
|
767 | <dt><strong><a name="item_set">$overlay->set ($x, $y, $text, $rend)</a></strong><br /> |
|
|
768 | </dt> |
|
|
769 | <dd> |
|
|
770 | Similar to <a href="#item_row_t"><code>$term->ROW_t</code></a> and <a href="#item_row_r"><code>$term->ROW_r</code></a> in that it puts |
|
|
771 | text in rxvt-unicode's special encoding and an array of rendition values |
|
|
772 | at a specific position inside the overlay. |
|
|
773 | </dd> |
|
|
774 | <p></p> |
|
|
775 | <dt><strong><a name="item_hide">$overlay->hide</a></strong><br /> |
|
|
776 | </dt> |
|
|
777 | <dd> |
|
|
778 | If visible, hide the overlay, but do not destroy it. |
|
|
779 | </dd> |
|
|
780 | <p></p> |
|
|
781 | <dt><strong><a name="item_show">$overlay->show</a></strong><br /> |
|
|
782 | </dt> |
|
|
783 | <dd> |
|
|
784 | If hidden, display the overlay again. |
|
|
785 | </dd> |
|
|
786 | <p></p></dl> |
|
|
787 | <dt><strong>$popup = $term->popup ($event)</strong><br /> |
|
|
788 | </dt> |
|
|
789 | <dd> |
|
|
790 | Creates a new <code>urxvt::popup</code> object that implements a popup menu. The |
|
|
791 | <code>$event</code> <em>must</em> be the event causing the menu to pop up (a button event, |
|
|
792 | currently). |
|
|
793 | </dd> |
|
|
794 | <p></p> |
|
|
795 | <dt><strong><a name="item_strwidth">$cellwidth = $term->strwidth ($string)</a></strong><br /> |
|
|
796 | </dt> |
|
|
797 | <dd> |
|
|
798 | Returns the number of screen-cells this string would need. Correctly |
|
|
799 | accounts for wide and combining characters. |
|
|
800 | </dd> |
|
|
801 | <p></p> |
|
|
802 | <dt><strong><a name="item_locale_encode">$octets = $term->locale_encode ($string)</a></strong><br /> |
|
|
803 | </dt> |
|
|
804 | <dd> |
|
|
805 | Convert the given text string into the corresponding locale encoding. |
|
|
806 | </dd> |
|
|
807 | <p></p> |
|
|
808 | <dt><strong><a name="item_locale_decode">$string = $term->locale_decode ($octets)</a></strong><br /> |
|
|
809 | </dt> |
|
|
810 | <dd> |
|
|
811 | Convert the given locale-encoded octets into a perl string. |
|
|
812 | </dd> |
|
|
813 | <p></p> |
|
|
814 | <dt><strong><a name="item_scr_xor_span">$term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])</a></strong><br /> |
|
|
815 | </dt> |
|
|
816 | <dd> |
|
|
817 | XORs the rendition values in the given span with the provided value |
|
|
818 | (default: <code>RS_RVid</code>). Useful in refresh hooks to provide effects similar |
|
|
819 | to the selection. |
|
|
820 | </dd> |
|
|
821 | <p></p> |
|
|
822 | <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 /> |
|
|
823 | </dt> |
|
|
824 | <dd> |
|
|
825 | Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing |
|
|
826 | whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults |
|
|
827 | to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines |
|
|
828 | it instead. |
|
|
829 | </dd> |
|
|
830 | <p></p> |
|
|
831 | <dt><strong><a name="item_scr_bell">$term->scr_bell</a></strong><br /> |
|
|
832 | </dt> |
|
|
833 | <dd> |
|
|
834 | Ring the bell! |
|
|
835 | </dd> |
|
|
836 | <p></p> |
|
|
837 | <dt><strong><a name="item_scr_add_lines">$term->scr_add_lines ($string)</a></strong><br /> |
|
|
838 | </dt> |
|
|
839 | <dd> |
|
|
840 | Write the given text string to the screen, as if output by the application |
|
|
841 | running inside the terminal. It may not contain command sequences (escape |
|
|
842 | codes), but is free to use line feeds, carriage returns and tabs. The |
|
|
843 | string is a normal text string, not in locale-dependent encoding. |
|
|
844 | </dd> |
|
|
845 | <dd> |
|
|
846 | <p>Normally its not a good idea to use this function, as programs might be |
|
|
847 | confused by changes in cursor position or scrolling. Its useful inside a |
|
|
848 | <code>on_add_lines</code> hook, though.</p> |
|
|
849 | </dd> |
|
|
850 | <p></p> |
|
|
851 | <dt><strong><a name="item_cmd_parse">$term->cmd_parse ($octets)</a></strong><br /> |
|
|
852 | </dt> |
|
|
853 | <dd> |
|
|
854 | Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the |
|
|
855 | locale-specific encoding of the terminal and can contain command sequences |
|
|
856 | (escape codes) that will be interpreted. |
|
|
857 | </dd> |
|
|
858 | <p></p> |
|
|
859 | <dt><strong><a name="item_tt_write">$term->tt_write ($octets)</a></strong><br /> |
|
|
860 | </dt> |
|
|
861 | <dd> |
|
|
862 | Write the octets given in <code>$data</code> to the tty (i.e. as program input). To |
|
|
863 | pass characters instead of octets, you should convert your strings first |
|
|
864 | to the locale-specific encoding using <a href="#item_locale_encode"><code>$term->locale_encode</code></a>. |
|
|
865 | </dd> |
|
|
866 | <p></p> |
|
|
867 | <dt><strong><a name="item_pty_ev_events">$old_events = $term->pty_ev_events ([$new_events])</a></strong><br /> |
|
|
868 | </dt> |
|
|
869 | <dd> |
|
|
870 | Replaces the event mask of the pty watcher by the given event mask. Can |
|
|
871 | be used to suppress input and output handling to the pty/tty. See the |
|
|
872 | description of <a href="#item_events"><code>urxvt::timer->events</code></a>. Make sure to always restore |
|
|
873 | the previous value. |
|
|
874 | </dd> |
|
|
875 | <p></p> |
|
|
876 | <dt><strong><a name="item_parent">$windowid = $term->parent</a></strong><br /> |
|
|
877 | </dt> |
|
|
878 | <dd> |
|
|
879 | Return the window id of the toplevel window. |
|
|
880 | </dd> |
|
|
881 | <p></p> |
|
|
882 | <dt><strong><a name="item_vt">$windowid = $term->vt</a></strong><br /> |
|
|
883 | </dt> |
|
|
884 | <dd> |
|
|
885 | Return the window id of the terminal window. |
|
|
886 | </dd> |
|
|
887 | <p></p> |
|
|
888 | <dt><strong><a name="item_width">$window_width = $term->width</a></strong><br /> |
|
|
889 | </dt> |
|
|
890 | <dt><strong><a name="item_height">$window_height = $term->height</a></strong><br /> |
|
|
891 | </dt> |
|
|
892 | <dt><strong><a name="item_fwidth">$font_width = $term->fwidth</a></strong><br /> |
|
|
893 | </dt> |
|
|
894 | <dt><strong><a name="item_fheight">$font_height = $term->fheight</a></strong><br /> |
|
|
895 | </dt> |
|
|
896 | <dt><strong><a name="item_fbase">$font_ascent = $term->fbase</a></strong><br /> |
|
|
897 | </dt> |
|
|
898 | <dt><strong><a name="item_nrow">$terminal_rows = $term->nrow</a></strong><br /> |
|
|
899 | </dt> |
|
|
900 | <dt><strong><a name="item_ncol">$terminal_columns = $term->ncol</a></strong><br /> |
|
|
901 | </dt> |
|
|
902 | <dt><strong><a name="item_focus">$has_focus = $term->focus</a></strong><br /> |
|
|
903 | </dt> |
|
|
904 | <dt><strong><a name="item_mapped">$is_mapped = $term->mapped</a></strong><br /> |
|
|
905 | </dt> |
|
|
906 | <dt><strong><a name="item_savelines">$max_scrollback = $term->saveLines</a></strong><br /> |
|
|
907 | </dt> |
|
|
908 | <dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term->total_rows</a></strong><br /> |
|
|
909 | </dt> |
|
|
910 | <dt><strong><a name="item_nsaved">$lines_in_scrollback = $term->nsaved</a></strong><br /> |
|
|
911 | </dt> |
|
|
912 | <dd> |
|
|
913 | Return various integers describing terminal characteristics. |
|
|
914 | </dd> |
|
|
915 | <p></p> |
|
|
916 | <dt><strong><a name="item_display_id">$x_display = $term->display_id</a></strong><br /> |
|
|
917 | </dt> |
|
|
918 | <dd> |
|
|
919 | Return the DISPLAY used by rxvt-unicode. |
|
|
920 | </dd> |
|
|
921 | <p></p> |
|
|
922 | <dt><strong><a name="item_locale">$lc_ctype = $term->locale</a></strong><br /> |
|
|
923 | </dt> |
|
|
924 | <dd> |
|
|
925 | Returns the LC_CTYPE category string used by this rxvt-unicode. |
|
|
926 | </dd> |
|
|
927 | <p></p> |
|
|
928 | <dt><strong><a name="item_env">$env = $term->env</a></strong><br /> |
|
|
929 | </dt> |
|
|
930 | <dd> |
|
|
931 | Returns a copy of the environment in effect for the terminal as a hashref |
|
|
932 | similar to <code>\%ENV</code>. |
|
|
933 | </dd> |
|
|
934 | <p></p> |
|
|
935 | <dt><strong><a name="item_modlevel3mask">$modifiermask = $term->ModLevel3Mask</a></strong><br /> |
|
|
936 | </dt> |
|
|
937 | <dt><strong><a name="item_modmetamask">$modifiermask = $term->ModMetaMask</a></strong><br /> |
|
|
938 | </dt> |
|
|
939 | <dt><strong><a name="item_modnumlockmask">$modifiermask = $term->ModNumLockMask</a></strong><br /> |
|
|
940 | </dt> |
|
|
941 | <dd> |
|
|
942 | Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often |
|
|
943 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
|
|
944 | </dd> |
|
|
945 | <p></p> |
|
|
946 | <dt><strong><a name="item_view_start">$view_start = $term->view_start ([$newvalue])</a></strong><br /> |
|
|
947 | </dt> |
|
|
948 | <dd> |
|
|
949 | Returns the negative row number of the topmost line. Minimum value is |
|
|
950 | <code>0</code>, which displays the normal terminal contents. Larger values scroll |
|
|
951 | this many lines into the scrollback buffer. |
|
|
952 | </dd> |
|
|
953 | <p></p> |
|
|
954 | <dt><strong><a name="item_want_refresh">$term->want_refresh</a></strong><br /> |
|
|
955 | </dt> |
|
|
956 | <dd> |
|
|
957 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
|
|
958 | compare the on-screen display with its stored representation. If they |
|
|
959 | differ, it redraws the differences. |
|
|
960 | </dd> |
|
|
961 | <dd> |
|
|
962 | <p>Used after changing terminal contents to display them.</p> |
|
|
963 | </dd> |
|
|
964 | <p></p> |
|
|
965 | <dt><strong><a name="item_row_t">$text = $term->ROW_t ($row_number[, $new_text[, $start_col]])</a></strong><br /> |
|
|
966 | </dt> |
|
|
967 | <dd> |
|
|
968 | Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code> |
|
|
969 | is the topmost terminal line, row <code>$term->$ncol-1</code> is the bottommost |
|
|
970 | terminal line. The scrollback buffer starts at line <code>-1</code> and extends to |
|
|
971 | line <a href="#item_nsaved"><code>-$term->nsaved</code></a>. Nothing will be returned if a nonexistent line |
|
|
972 | is requested. |
|
|
973 | </dd> |
|
|
974 | <dd> |
|
|
975 | <p>If <code>$new_text</code> is specified, it will replace characters in the current |
|
|
976 | line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful |
|
|
977 | to replace only parts of a line. The font index in the rendition will |
|
|
978 | automatically be updated.</p> |
|
|
979 | </dd> |
|
|
980 | <dd> |
|
|
981 | <p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more |
|
|
982 | than one cell when displayed are padded with urxvt::NOCHAR characters |
|
|
983 | (<code>chr 65535</code>). Characters with combining characters and other characters |
|
|
984 | that do not fit into the normal tetx encoding will be replaced with |
|
|
985 | characters in the private use area.</p> |
|
|
986 | </dd> |
|
|
987 | <dd> |
|
|
988 | <p>You have to obey this encoding when changing text. The advantage is |
|
|
989 | that <code>substr</code> and similar functions work on screen cells and not on |
|
|
990 | characters.</p> |
|
|
991 | </dd> |
|
|
992 | <dd> |
|
|
993 | <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> |
|
|
994 | can be used to convert normal strings into this encoding and vice versa.</p> |
|
|
995 | </dd> |
|
|
996 | <p></p> |
|
|
997 | <dt><strong><a name="item_row_r">$rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br /> |
|
|
998 | </dt> |
|
|
999 | <dd> |
|
|
1000 | Like <a href="#item_row_t"><code>$term->ROW_t</code></a>, but returns an arrayref with rendition |
|
|
1001 | bitsets. Rendition bitsets contain information about colour, font, font |
|
|
1002 | styles and similar information. See also <a href="#item_row_t"><code>$term->ROW_t</code></a>. |
|
|
1003 | </dd> |
|
|
1004 | <dd> |
|
|
1005 | <p>When setting rendition, the font mask will be ignored.</p> |
|
|
1006 | </dd> |
|
|
1007 | <dd> |
|
|
1008 | <p>See the section on RENDITION, above.</p> |
|
|
1009 | </dd> |
|
|
1010 | <p></p> |
|
|
1011 | <dt><strong><a name="item_row_l">$length = $term->ROW_l ($row_number[, $new_length])</a></strong><br /> |
|
|
1012 | </dt> |
|
|
1013 | <dd> |
|
|
1014 | Returns the number of screen cells that are in use (``the line |
|
|
1015 | length''). Unlike the urxvt core, this returns <a href="#item_ncol"><code>$term->ncol</code></a> if the |
|
|
1016 | line is joined with the following one. |
|
|
1017 | </dd> |
|
|
1018 | <p></p> |
|
|
1019 | <dt><strong><a name="item_is_longer">$bool = $term->is_longer ($row_number)</a></strong><br /> |
|
|
1020 | </dt> |
|
|
1021 | <dd> |
|
|
1022 | Returns true if the row is part of a multiple-row logical ``line'' (i.e. |
|
|
1023 | joined with the following row), which means all characters are in use |
|
|
1024 | and it is continued on the next row (and possibly a continuation of the |
|
|
1025 | previous row(s)). |
|
|
1026 | </dd> |
|
|
1027 | <p></p> |
|
|
1028 | <dt><strong><a name="item_line">$line = $term->line ($row_number)</a></strong><br /> |
|
|
1029 | </dt> |
|
|
1030 | <dd> |
|
|
1031 | Create and return a new <code>urxvt::line</code> object that stores information |
|
|
1032 | about the logical line that row <code>$row_number</code> is part of. It supports the |
|
|
1033 | following methods: |
|
|
1034 | </dd> |
|
|
1035 | <dl> |
|
|
1036 | <dt><strong><a name="item_t">$text = $line->t ([$new_text])</a></strong><br /> |
|
|
1037 | </dt> |
|
|
1038 | <dd> |
|
|
1039 | Returns or replaces the full text of the line, similar to <a href="#item_row_t"><code>ROW_t</code></a> |
|
|
1040 | </dd> |
|
|
1041 | <p></p> |
|
|
1042 | <dt><strong><a name="item_r">$rend = $line->r ([$new_rend])</a></strong><br /> |
|
|
1043 | </dt> |
|
|
1044 | <dd> |
|
|
1045 | Returns or replaces the full rendition array of the line, similar to <a href="#item_row_r"><code>ROW_r</code></a> |
|
|
1046 | </dd> |
|
|
1047 | <p></p> |
|
|
1048 | <dt><strong><a name="item_l">$length = $line->l</a></strong><br /> |
|
|
1049 | </dt> |
|
|
1050 | <dd> |
|
|
1051 | Returns the length of the line in cells, similar to <a href="#item_row_l"><code>ROW_l</code></a>. |
|
|
1052 | </dd> |
|
|
1053 | <p></p> |
|
|
1054 | <dt><strong><a name="item_beg">$rownum = $line->beg</a></strong><br /> |
|
|
1055 | </dt> |
|
|
1056 | <dt><strong><a name="item_end">$rownum = $line->end</a></strong><br /> |
|
|
1057 | </dt> |
|
|
1058 | <dd> |
|
|
1059 | Return the row number of the first/last row of the line, respectively. |
|
|
1060 | </dd> |
|
|
1061 | <p></p> |
|
|
1062 | <dt><strong><a name="item_offset_of">$offset = $line->offset_of ($row, $col)</a></strong><br /> |
|
|
1063 | </dt> |
|
|
1064 | <dd> |
|
|
1065 | Returns the character offset of the given row|col pair within the logical |
|
|
1066 | line. |
|
|
1067 | </dd> |
|
|
1068 | <p></p> |
|
|
1069 | <dt><strong><a name="item_coord_of">($row, $col) = $line->coord_of ($offset)</a></strong><br /> |
|
|
1070 | </dt> |
|
|
1071 | <dd> |
|
|
1072 | Translates a string offset into terminal coordinates again. |
|
|
1073 | </dd> |
|
|
1074 | <p></p></dl> |
|
|
1075 | <dt><strong><a name="item_special_encode">$text = $term->special_encode $string</a></strong><br /> |
|
|
1076 | </dt> |
|
|
1077 | <dd> |
|
|
1078 | Converts a perl string into the special encoding used by rxvt-unicode, |
|
|
1079 | where one character corresponds to one screen cell. See |
|
|
1080 | <a href="#item_row_t"><code>$term->ROW_t</code></a> for details. |
|
|
1081 | </dd> |
|
|
1082 | <p></p> |
|
|
1083 | <dt><strong><a name="item_special_decode">$string = $term->special_decode $text</a></strong><br /> |
|
|
1084 | </dt> |
|
|
1085 | <dd> |
|
|
1086 | Converts rxvt-unicodes text reprsentation into a perl string. See |
|
|
1087 | <a href="#item_row_t"><code>$term->ROW_t</code></a> for details. |
|
|
1088 | </dd> |
|
|
1089 | <p></p> |
|
|
1090 | <dt><strong><a name="item_grab_button">$success = $term->grab_button ($button, $modifiermask)</a></strong><br /> |
|
|
1091 | </dt> |
|
|
1092 | <dd> |
|
|
1093 | Registers a synchronous button grab. See the XGrabButton manpage. |
|
|
1094 | </dd> |
|
|
1095 | <p></p> |
|
|
1096 | <dt><strong><a name="item_grab">$success = $term->grab ($eventtime[, $sync])</a></strong><br /> |
|
|
1097 | </dt> |
|
|
1098 | <dd> |
|
|
1099 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
|
|
1100 | synchronous (<code>$sync</code> is true). Also remembers the grab timestampe. |
|
|
1101 | </dd> |
|
|
1102 | <p></p> |
|
|
1103 | <dt><strong><a name="item_allow_events_async">$term->allow_events_async</a></strong><br /> |
|
|
1104 | </dt> |
|
|
1105 | <dd> |
|
|
1106 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
|
|
1107 | </dd> |
|
|
1108 | <p></p> |
|
|
1109 | <dt><strong><a name="item_allow_events_sync">$term->allow_events_sync</a></strong><br /> |
|
|
1110 | </dt> |
|
|
1111 | <dd> |
|
|
1112 | Calls XAllowEvents with SyncBoth for the most recent grab. |
|
|
1113 | </dd> |
|
|
1114 | <p></p> |
|
|
1115 | <dt><strong><a name="item_allow_events_replay">$term->allow_events_replay</a></strong><br /> |
|
|
1116 | </dt> |
|
|
1117 | <dd> |
|
|
1118 | Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most |
|
|
1119 | recent grab. |
|
|
1120 | </dd> |
|
|
1121 | <p></p> |
|
|
1122 | <dt><strong><a name="item_ungrab">$term->ungrab</a></strong><br /> |
|
|
1123 | </dt> |
|
|
1124 | <dd> |
|
|
1125 | Calls XUngrab for the most recent grab. Is called automatically on |
|
|
1126 | evaluation errors, as it is better to lose the grab in the error case as |
|
|
1127 | the session. |
|
|
1128 | </dd> |
|
|
1129 | <p></p></dl> |
|
|
1130 | <p> |
|
|
1131 | </p> |
|
|
1132 | <h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> |
|
|
1133 | <dl> |
|
|
1134 | <dt><strong><a name="item_add_title">$popup->add_title ($title)</a></strong><br /> |
|
|
1135 | </dt> |
|
|
1136 | <dd> |
|
|
1137 | Adds a non-clickable title to the popup. |
|
|
1138 | </dd> |
|
|
1139 | <p></p> |
|
|
1140 | <dt><strong><a name="item_add_separator">$popup->add_separator ([$sepchr])</a></strong><br /> |
|
|
1141 | </dt> |
|
|
1142 | <dd> |
|
|
1143 | Creates a separator, optionally using the character given as <code>$sepchr</code>. |
|
|
1144 | </dd> |
|
|
1145 | <p></p> |
|
|
1146 | <dt><strong><a name="item_add_button">$popup->add_button ($text, $cb)</a></strong><br /> |
|
|
1147 | </dt> |
|
|
1148 | <dd> |
|
|
1149 | Adds a clickable button to the popup. <code>$cb</code> is called whenever it is |
|
|
1150 | selected. |
|
|
1151 | </dd> |
|
|
1152 | <p></p> |
|
|
1153 | <dt><strong><a name="item_add_toggle">$popup->add_toggle ($text, $cb, $initial_value)</a></strong><br /> |
|
|
1154 | </dt> |
|
|
1155 | <dd> |
|
|
1156 | Adds a toggle/checkbox item to the popup. Teh callback gets called |
|
|
1157 | whenever it gets toggled, with a boolean indicating its value as its first |
|
|
1158 | argument. |
|
|
1159 | </dd> |
|
|
1160 | <p></p> |
|
|
1161 | <dt><strong>$popup->show</strong><br /> |
|
|
1162 | </dt> |
|
|
1163 | <dd> |
|
|
1164 | Displays the popup (which is initially hidden). |
312 | </dd> |
1165 | </dd> |
313 | <p></p></dl> |
1166 | <p></p></dl> |
314 | <p> |
1167 | <p> |
315 | </p> |
1168 | </p> |
316 | <h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> |
1169 | <h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> |
317 | <p>This class implements timer watchers/events. Time is represented as a |
1170 | <p>This class implements timer watchers/events. Time is represented as a |
318 | fractional number of seconds since the epoch. Example:</p> |
1171 | fractional number of seconds since the epoch. Example:</p> |
319 | <pre> |
1172 | <pre> |
320 | # create a digital clock display in upper right corner |
1173 | $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0); |
321 | $term->{timer} = urxvt::timer |
1174 | $term->{timer} = urxvt::timer |
322 | ->new |
1175 | ->new |
323 | ->start (urxvt::NOW) |
1176 | ->interval (1) |
324 | ->cb (sub { |
1177 | ->cb (sub { |
325 | my ($timer) = @_; |
|
|
326 | my $time = $timer->at; |
|
|
327 | $timer->start ($time + 1); |
|
|
328 | $self->scr_overlay (-1, 0, |
1178 | $term->{overlay}->set (0, 0, |
329 | POSIX::strftime "%H:%M:%S", localtime $time); |
1179 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
330 | });</pre> |
1180 | });</pre> |
331 | <dl> |
1181 | <dl> |
332 | <dt><strong><a name="item__24timer__3d_new_urxvt_3a_3atimer">$timer = new urxvt::timer</a></strong><br /> |
1182 | <dt><strong><a name="item__24timer__3d_new_urxvt_3a_3atimer">$timer = new urxvt::timer</a></strong><br /> |
333 | </dt> |
1183 | </dt> |
334 | <dd> |
1184 | <dd> |
335 | Create a new timer object in stopped state. |
1185 | Create a new timer object in started state. It is scheduled to fire |
|
|
1186 | immediately. |
336 | </dd> |
1187 | </dd> |
337 | <p></p> |
1188 | <p></p> |
338 | <dt><strong><a name="item_cb">$timer = $timer->cb (sub { my ($timer) = @_; ... })</a></strong><br /> |
1189 | <dt><strong><a name="item_cb">$timer = $timer->cb (sub { my ($timer) = @_; ... })</a></strong><br /> |
339 | </dt> |
1190 | </dt> |
340 | <dd> |
1191 | <dd> |
… | |
… | |
345 | </dt> |
1196 | </dt> |
346 | <dd> |
1197 | <dd> |
347 | Return the time this watcher will fire next. |
1198 | Return the time this watcher will fire next. |
348 | </dd> |
1199 | </dd> |
349 | <p></p> |
1200 | <p></p> |
350 | <dt><strong><a name="item_set">$timer = $timer->set ($tstamp)</a></strong><br /> |
1201 | <dt><strong>$timer = $timer->set ($tstamp)</strong><br /> |
351 | </dt> |
1202 | </dt> |
352 | <dd> |
1203 | <dd> |
353 | Set the time the event is generated to $tstamp. |
1204 | Set the time the event is generated to $tstamp. |
|
|
1205 | </dd> |
|
|
1206 | <p></p> |
|
|
1207 | <dt><strong><a name="item_interval">$timer = $timer->interval ($interval)</a></strong><br /> |
|
|
1208 | </dt> |
|
|
1209 | <dd> |
|
|
1210 | Normally (and when <code>$interval</code> is <code>0</code>), the timer will automatically |
|
|
1211 | stop after it has fired once. If <code>$interval</code> is non-zero, then the timer |
|
|
1212 | is automatically rescheduled at the given intervals. |
354 | </dd> |
1213 | </dd> |
355 | <p></p> |
1214 | <p></p> |
356 | <dt><strong><a name="item_start">$timer = $timer->start</a></strong><br /> |
1215 | <dt><strong><a name="item_start">$timer = $timer->start</a></strong><br /> |
357 | </dt> |
1216 | </dt> |
358 | <dd> |
1217 | <dd> |
… | |
… | |
378 | <pre> |
1237 | <pre> |
379 | $term->{socket} = ... |
1238 | $term->{socket} = ... |
380 | $term->{iow} = urxvt::iow |
1239 | $term->{iow} = urxvt::iow |
381 | ->new |
1240 | ->new |
382 | ->fd (fileno $term->{socket}) |
1241 | ->fd (fileno $term->{socket}) |
383 | ->events (1) # wait for read data |
1242 | ->events (urxvt::EVENT_READ) |
384 | ->start |
1243 | ->start |
385 | ->cb (sub { |
1244 | ->cb (sub { |
386 | my ($iow, $revents) = @_; |
1245 | my ($iow, $revents) = @_; |
387 | # $revents must be 1 here, no need to check |
1246 | # $revents must be 1 here, no need to check |
388 | sysread $term->{socket}, my $buf, 8192 |
1247 | sysread $term->{socket}, my $buf, 8192 |
… | |
… | |
409 | </dd> |
1268 | </dd> |
410 | <p></p> |
1269 | <p></p> |
411 | <dt><strong><a name="item_events">$iow = $iow->events ($eventmask)</a></strong><br /> |
1270 | <dt><strong><a name="item_events">$iow = $iow->events ($eventmask)</a></strong><br /> |
412 | </dt> |
1271 | </dt> |
413 | <dd> |
1272 | <dd> |
414 | Set the event mask to watch. Bit #0 (value <code>1</code>) enables watching for read |
1273 | Set the event mask to watch. The only allowed values are |
415 | data, Bit #1 (value <code>2</code>) enables watching for write data. |
1274 | <code>urxvt::EVENT_READ</code> and <code>urxvt::EVENT_WRITE</code>, which might be ORed |
|
|
1275 | together, or <code>urxvt::EVENT_NONE</code>. |
416 | </dd> |
1276 | </dd> |
417 | <p></p> |
1277 | <p></p> |
418 | <dt><strong>$iow = $iow->start</strong><br /> |
1278 | <dt><strong>$iow = $iow->start</strong><br /> |
419 | </dt> |
1279 | </dt> |
420 | <dd> |
1280 | <dd> |
… | |
… | |
434 | <p> |
1294 | <p> |
435 | </p> |
1295 | </p> |
436 | <h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> |
1296 | <h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> |
437 | <p>This variable controls the verbosity level of the perl extension. Higher |
1297 | <p>This variable controls the verbosity level of the perl extension. Higher |
438 | numbers indicate more verbose output.</p> |
1298 | numbers indicate more verbose output.</p> |
439 | <ol> |
1299 | <dl> |
440 | <li><strong><a name="item__2d_only_fatal_messages">- only fatal messages</a></strong><br /> |
1300 | <dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br /> |
441 | </li> |
1301 | </dt> |
442 | <li><strong><a name="item__2d_script_loading_and_management">- script loading and management</a></strong><br /> |
1302 | <dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">>= 3 - script loading and management</a></strong><br /> |
443 | </li> |
1303 | </dt> |
444 | <li><strong><a name="item__2d_all_events_received">- all events received</a></strong><br /> |
1304 | <dt><strong><a name="item__3e_3d10__2d_all_events_received">>=10 - all events received</a></strong><br /> |
|
|
1305 | </dt> |
445 | </li> |
1306 | </dl> |
446 | </ol> |
|
|
447 | <p> |
1307 | <p> |
448 | </p> |
1308 | </p> |
449 | <hr /> |
1309 | <hr /> |
450 | <h1><a name="author">AUTHOR</a></h1> |
1310 | <h1><a name="author">AUTHOR</a></h1> |
451 | <pre> |
1311 | <pre> |