… | |
… | |
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> |
|
|
100 | <p>The selection works by trying to match a number of regexes and displaying |
|
|
101 | them in increasing order of length. You can add your own regexes by |
|
|
102 | specifying resources of the form:</p> |
|
|
103 | </dd> |
|
|
104 | <dd> |
|
|
105 | <pre> |
|
|
106 | URxvt.selection.pattern-0: perl-regex |
|
|
107 | URxvt.selection.pattern-1: perl-regex |
|
|
108 | ...</pre> |
|
|
109 | </dd> |
|
|
110 | <dd> |
|
|
111 | <p>The index number (0, 1...) must not have any holes, and each regex must |
|
|
112 | contain at least one pair of capturing parentheses, which will be used for |
|
|
113 | the match. For example, the followign adds a regex that matches everything |
|
|
114 | between two vertical bars:</p> |
|
|
115 | </dd> |
|
|
116 | <dd> |
|
|
117 | <pre> |
|
|
118 | URxvt.selection.pattern-0: \\|([^|]+)\\|</pre> |
|
|
119 | </dd> |
|
|
120 | <dd> |
|
|
121 | <p>You can look at the source of the selection extension to see more |
|
|
122 | interesting uses, such as parsing a line from beginning to end.</p> |
|
|
123 | </dd> |
|
|
124 | <dd> |
92 | <p>It also offers the following bindable event:</p> |
125 | <p>This extension also offers the following bindable keyboard command:</p> |
93 | </dd> |
126 | </dd> |
94 | <dl> |
127 | <dl> |
95 | <dt><strong><a name="item_rot13">rot13</a></strong><br /> |
128 | <dt><strong><a name="item_rot13">rot13</a></strong><br /> |
96 | </dt> |
129 | </dt> |
97 | <dd> |
130 | <dd> |
… | |
… | |
103 | </dd> |
136 | </dd> |
104 | <p></p></dl> |
137 | <p></p></dl> |
105 | <dt><strong><a name="item_popup">option-popup (enabled by default)</a></strong><br /> |
138 | <dt><strong><a name="item_popup">option-popup (enabled by default)</a></strong><br /> |
106 | </dt> |
139 | </dt> |
107 | <dd> |
140 | <dd> |
108 | Binds a popup menu to Ctrl-Button3 that lets you toggle (some) options at |
141 | Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at |
109 | runtime. |
142 | runtime. |
110 | </dd> |
143 | </dd> |
111 | <p></p> |
144 | <p></p> |
112 | <dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> |
145 | <dt><strong>selection-popup (enabled by default)</strong><br /> |
113 | </dt> |
146 | </dt> |
|
|
147 | <dd> |
|
|
148 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
|
|
149 | text into various other formats/action (such as uri unescaping, perl |
|
|
150 | evalution, web-browser starting etc.), depending on content. |
114 | <dd> |
151 | </dd> |
115 | Displays a digital clock using the built-in overlay. |
152 | <p></p> |
|
|
153 | <dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback<hotkey> (enabled by default)</a></strong><br /> |
|
|
154 | </dt> |
|
|
155 | <dd> |
|
|
156 | Adds regex search functionality to the scrollback buffer, triggered |
|
|
157 | by a hotkey (default: <code>M-s</code>). While in search mode, normal terminal |
|
|
158 | input/output is suspended and a regex is displayed at the bottom of the |
|
|
159 | screen. |
|
|
160 | </dd> |
|
|
161 | <dd> |
|
|
162 | <p>Inputting characters appends them to the regex and continues incremental |
|
|
163 | search. <code>BackSpace</code> removes a character from the regex, <code>Up</code> and <code>Down</code> |
|
|
164 | search upwards/downwards in the scrollback buffer, <code>End</code> jumps to the |
|
|
165 | bottom. <code>Escape</code> leaves search mode and returns to the point where search |
|
|
166 | was started, while <code>Enter</code> or <code>Return</code> stay at the current position and |
|
|
167 | additionally stores the first match in the current line into the primary |
|
|
168 | selection.</p> |
|
|
169 | </dd> |
|
|
170 | <p></p> |
|
|
171 | <dt><strong><a name="item_selection_2dautotransform">selection-autotransform</a></strong><br /> |
|
|
172 | </dt> |
|
|
173 | <dd> |
|
|
174 | This selection allows you to do automatic transforms on a selection |
|
|
175 | whenever a selection is made. |
|
|
176 | </dd> |
|
|
177 | <dd> |
|
|
178 | <p>It works by specifying perl snippets (most useful is a single <code>s///</code> |
|
|
179 | operator) that modify <code>$_</code> as resources:</p> |
|
|
180 | </dd> |
|
|
181 | <dd> |
|
|
182 | <pre> |
|
|
183 | URxvt.selection-autotransform.0: transform |
|
|
184 | URxvt.selection-autotransform.1: transform |
|
|
185 | ...</pre> |
|
|
186 | </dd> |
|
|
187 | <dd> |
|
|
188 | <p>For example, the following will transform selections of the form |
|
|
189 | <code>filename:number</code>, often seen in compiler messages, into <code>vi +$filename |
|
|
190 | $word</code>:</p> |
|
|
191 | </dd> |
|
|
192 | <dd> |
|
|
193 | <pre> |
|
|
194 | URxvt.selection-autotransform.0: s/^(\\S+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/</pre> |
|
|
195 | </dd> |
|
|
196 | <dd> |
|
|
197 | <p>And this example matches the same,but replaces it with vi-commands you can |
|
|
198 | paste directly into your (vi :) editor:</p> |
|
|
199 | </dd> |
|
|
200 | <dd> |
|
|
201 | <pre> |
|
|
202 | URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/</pre> |
|
|
203 | </dd> |
|
|
204 | <dd> |
|
|
205 | <p>Of course, this can be modified to suit your needs and your editor :)</p> |
|
|
206 | </dd> |
|
|
207 | <dd> |
|
|
208 | <p>To expand the example above to typical perl error messages (``XXX at |
|
|
209 | FILENAME line YYY.''), you need a slightly more elaborate solution:</p> |
|
|
210 | </dd> |
|
|
211 | <dd> |
|
|
212 | <pre> |
|
|
213 | URxvt.selection.pattern-0: ( at .*? line \\d+\\.) |
|
|
214 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/</pre> |
|
|
215 | </dd> |
|
|
216 | <dd> |
|
|
217 | <p>The first line tells the selection code to treat the unchanging part of |
|
|
218 | every error message as a selection pattern, and the second line transforms |
|
|
219 | the message into vi commands to load the file.</p> |
116 | </dd> |
220 | </dd> |
117 | <p></p> |
221 | <p></p> |
118 | <dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> |
222 | <dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> |
119 | </dt> |
223 | </dt> |
120 | <dd> |
224 | <dd> |
121 | Uses per-line display filtering (<code>on_line_update</code>) to underline urls. |
225 | Uses per-line display filtering (<code>on_line_update</code>) to underline urls and |
|
|
226 | make them clickable. When middle-clicked, the program specified in the |
|
|
227 | resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with |
|
|
228 | the URL as first argument. |
122 | </dd> |
229 | </dd> |
123 | <p></p> |
230 | <p></p> |
124 | <dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br /> |
231 | <dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br /> |
125 | </dt> |
232 | </dt> |
126 | <dd> |
233 | <dd> |
127 | A not very useful example of filtering all text output to the terminal, |
234 | A not very useful example of filtering all text output to the terminal, |
128 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
235 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
129 | similar-looking ascii character. |
236 | similar-looking ascii character. |
130 | </dd> |
237 | </dd> |
131 | <p></p> |
238 | <p></p> |
|
|
239 | <dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> |
|
|
240 | </dt> |
|
|
241 | <dd> |
|
|
242 | Displays a digital clock using the built-in overlay. |
|
|
243 | </dd> |
|
|
244 | <p></p> |
132 | <dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> |
245 | <dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> |
133 | </dt> |
246 | </dt> |
134 | <dd> |
247 | <dd> |
135 | Displays a very simple digital clock in the upper right corner of the |
248 | Displays a very simple digital clock in the upper right corner of the |
136 | window. Illustrates overwriting the refresh callbacks to create your own |
249 | window. Illustrates overwriting the refresh callbacks to create your own |
137 | overlays or changes. |
250 | overlays or changes. |
138 | </dd> |
251 | </dd> |
139 | <p></p></dl> |
252 | <p></p></dl> |
|
|
253 | <p> |
|
|
254 | </p> |
|
|
255 | <hr /> |
|
|
256 | <h1><a name="api_documentation">API DOCUMENTATION</a></h1> |
140 | <p> |
257 | <p> |
141 | </p> |
258 | </p> |
142 | <h2><a name="general_api_considerations">General API Considerations</a></h2> |
259 | <h2><a name="general_api_considerations">General API Considerations</a></h2> |
143 | <p>All objects (such as terminals, time watchers etc.) are typical |
260 | <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 |
261 | reference-to-hash objects. The hash can be used to store anything you |
… | |
… | |
154 | <dl> |
271 | <dl> |
155 | <dt><strong><a name="item__24text">$text</a></strong><br /> |
272 | <dt><strong><a name="item__24text">$text</a></strong><br /> |
156 | </dt> |
273 | </dt> |
157 | <dd> |
274 | <dd> |
158 | Rxvt-unicodes special way of encoding text, where one ``unicode'' character |
275 | 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. |
276 | always represents one screen cell. See <a href="#item_row_t">ROW_t</a> for a discussion of this format. |
160 | </dd> |
277 | </dd> |
161 | <p></p> |
278 | <p></p> |
162 | <dt><strong><a name="item__24string">$string</a></strong><br /> |
279 | <dt><strong><a name="item__24string">$string</a></strong><br /> |
163 | </dt> |
280 | </dt> |
164 | <dd> |
281 | <dd> |
… | |
… | |
174 | locale-specific way. |
291 | locale-specific way. |
175 | </dd> |
292 | </dd> |
176 | <p></p></dl> |
293 | <p></p></dl> |
177 | <p> |
294 | <p> |
178 | </p> |
295 | </p> |
|
|
296 | <h2><a name="extension_objects">Extension Objects</a></h2> |
|
|
297 | <p>Very perl extension is a perl class. A separate perl object is created |
|
|
298 | for each terminal and each extension and passed as the first parameter to |
|
|
299 | hooks. So extensions can use their <code>$self</code> object without having to think |
|
|
300 | about other extensions, with the exception of methods and members that |
|
|
301 | begin with an underscore character <code>_</code>: these are reserved for internal |
|
|
302 | use.</p> |
|
|
303 | <p>Although it isn't a <code>urxvt::term</code> object, you can call all methods of the |
|
|
304 | <code>urxvt::term</code> class on this object.</p> |
|
|
305 | <p>It has the following methods and data members:</p> |
|
|
306 | <dl> |
|
|
307 | <dt><strong><a name="item__24urxvt_term__3d__24self_2d_3e_7bterm_7d">$urxvt_term = $self->{term}</a></strong><br /> |
|
|
308 | </dt> |
|
|
309 | <dd> |
|
|
310 | Returns the <code>urxvt::term</code> object associated with this instance of the |
|
|
311 | extension. This member <em>must not</em> be changed in any way. |
|
|
312 | </dd> |
|
|
313 | <p></p> |
|
|
314 | <dt><strong><a name="item_enable">$self->enable ($hook_name => $cb, [$hook_name => $cb..])</a></strong><br /> |
|
|
315 | </dt> |
|
|
316 | <dd> |
|
|
317 | Dynamically enable the given hooks (named without the <code>on_</code> prefix) for |
|
|
318 | this extension, replacing any previous hook. This is useful when you want |
|
|
319 | to overwrite time-critical hooks only temporarily. |
|
|
320 | </dd> |
|
|
321 | <p></p> |
|
|
322 | <dt><strong><a name="item_disable">$self->disable ($hook_name[, $hook_name..])</a></strong><br /> |
|
|
323 | </dt> |
|
|
324 | <dd> |
|
|
325 | Dynamically disable the given hooks. |
|
|
326 | </dd> |
|
|
327 | <p></p></dl> |
|
|
328 | <p> |
|
|
329 | </p> |
179 | <h2><a name="hooks">Hooks</a></h2> |
330 | <h2><a name="hooks">Hooks</a></h2> |
180 | <p>The following subroutines can be declared in extension files, and will be |
331 | <p>The following subroutines can be declared in extension files, and will be |
181 | called whenever the relevant event happens.</p> |
332 | called whenever the relevant event happens.</p> |
182 | <p>The first argument passed to them is an object private to each terminal |
333 | <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 |
334 | 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 |
335 | <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, |
336 | 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> |
337 | 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> |
338 | <p><em>When in doubt, return a false value (preferably <code>()</code>). </em>></p> |
192 | <dl> |
339 | <dl> |
193 | <dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> |
340 | <dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> |
194 | </dt> |
341 | </dt> |
195 | <dd> |
342 | <dd> |
196 | Called after a new terminal object has been initialized, but before |
343 | Called after a new terminal object has been initialized, but before |
… | |
… | |
242 | </dt> |
389 | </dt> |
243 | <dd> |
390 | <dd> |
244 | Called whenever the user tries to extend the selection (e.g. with a double |
391 | 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 |
392 | 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 |
393 | should extend the selection itelf and return true to suppress the built-in |
247 | processing. |
394 | processing. This can happen multiple times, as long as the callback |
|
|
395 | returns true, it will be called on every further click by the user and is |
|
|
396 | supposed to enlarge the selection more and more, if possible. |
248 | </dd> |
397 | </dd> |
249 | <dd> |
398 | <dd> |
250 | <p>See the <em>selection</em> example extension.</p> |
399 | <p>See the <em>selection</em> example extension.</p> |
251 | </dd> |
400 | </dd> |
252 | <p></p> |
401 | <p></p> |
… | |
… | |
267 | </dd> |
416 | </dd> |
268 | <dd> |
417 | <dd> |
269 | <p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
418 | <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 |
419 | $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> |
420 | 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> |
421 | </dd> |
279 | <p></p> |
422 | <p></p> |
280 | <dt><strong><a name="item_on_osc_seq__24term_2c__24string">on_osc_seq $term, $string</a></strong><br /> |
423 | <dt><strong><a name="item_on_osc_seq__24term_2c__24string">on_osc_seq $term, $string</a></strong><br /> |
281 | </dt> |
424 | </dt> |
282 | <dd> |
425 | <dd> |
… | |
… | |
301 | and calling <a href="#item_scr_add_lines"><code>$term->scr_add_lines</code></a> yourself. Please note that this |
444 | 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 |
445 | might be very slow, however, as your hook is called for <strong>all</strong> text being |
303 | output. |
446 | output. |
304 | </dd> |
447 | </dd> |
305 | <p></p> |
448 | <p></p> |
|
|
449 | <dt><strong><a name="item_on_tt_write__24term_2c__24octets">on_tt_write $term, $octets</a></strong><br /> |
|
|
450 | </dt> |
|
|
451 | <dd> |
|
|
452 | Called whenever some data is written to the tty/pty and can be used to |
|
|
453 | suppress or filter tty input. |
|
|
454 | </dd> |
|
|
455 | <p></p> |
306 | <dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong><br /> |
456 | <dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong><br /> |
307 | </dt> |
457 | </dt> |
308 | <dd> |
458 | <dd> |
309 | Called whenever a line was updated or changed. Can be used to filter |
459 | 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 |
460 | screen output (e.g. underline urls or other useless stuff). Only lines |
… | |
… | |
356 | <dd> |
506 | <dd> |
357 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
507 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
358 | focus out processing. |
508 | focus out processing. |
359 | </dd> |
509 | </dd> |
360 | <p></p> |
510 | <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 /> |
511 | <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> |
512 | </dt> |
363 | <dt><strong><a name="item_on_key_release__24term_2c__24event">on_key_release $term, $event</a></strong><br /> |
513 | <dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br /> |
364 | </dt> |
514 | </dt> |
365 | <dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br /> |
515 | <dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br /> |
366 | </dt> |
516 | </dt> |
367 | <dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br /> |
517 | <dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br /> |
368 | </dt> |
518 | </dt> |
… | |
… | |
391 | <p></p></dl> |
541 | <p></p></dl> |
392 | <p> |
542 | <p> |
393 | </p> |
543 | </p> |
394 | <h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> |
544 | <h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> |
395 | <dl> |
545 | <dl> |
|
|
546 | <dt><strong><a name="item__24urxvt_3a_3alibdir">$urxvt::LIBDIR</a></strong><br /> |
|
|
547 | </dt> |
|
|
548 | <dd> |
|
|
549 | The rxvt-unicode library directory, where, among other things, the perl |
|
|
550 | modules and scripts are stored. |
|
|
551 | </dd> |
|
|
552 | <p></p> |
|
|
553 | <dt><strong><a name="item__24urxvt_3a_3aresclass_2c__24urxvt_3a_3aresclass">$urxvt::RESCLASS, $urxvt::RESCLASS</a></strong><br /> |
|
|
554 | </dt> |
|
|
555 | <dd> |
|
|
556 | The resource class and name rxvt-unicode uses to look up X resources. |
|
|
557 | </dd> |
|
|
558 | <p></p> |
|
|
559 | <dt><strong><a name="item__24urxvt_3a_3arxvtname">$urxvt::RXVTNAME</a></strong><br /> |
|
|
560 | </dt> |
|
|
561 | <dd> |
|
|
562 | The basename of the installed binaries, usually <code>urxvt</code>. |
|
|
563 | </dd> |
|
|
564 | <p></p> |
396 | <dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br /> |
565 | <dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br /> |
397 | </dt> |
566 | </dt> |
398 | <dd> |
567 | <dd> |
399 | The current terminal. This variable stores the current <code>urxvt::term</code> |
568 | The current terminal. This variable stores the current <code>urxvt::term</code> |
400 | object, whenever a callback/hook is executing. |
569 | object, whenever a callback/hook is executing. |
… | |
… | |
402 | <p></p></dl> |
571 | <p></p></dl> |
403 | <p> |
572 | <p> |
404 | </p> |
573 | </p> |
405 | <h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> |
574 | <h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> |
406 | <dl> |
575 | <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 /> |
576 | <dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br /> |
418 | </dt> |
577 | </dt> |
419 | <dd> |
578 | <dd> |
420 | Fatally aborts execution with the given error message. Avoid at all |
579 | Fatally aborts execution with the given error message. Avoid at all |
421 | costs! The only time this is acceptable is when the terminal process |
580 | costs! The only time this is acceptable is when the terminal process |
… | |
… | |
430 | that calls this function. |
589 | that calls this function. |
431 | </dd> |
590 | </dd> |
432 | <dd> |
591 | <dd> |
433 | <p>Using this function has the advantage that its output ends up in the |
592 | <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> |
593 | correct place, e.g. on stderr of the connecting urxvtc client.</p> |
|
|
594 | </dd> |
|
|
595 | <dd> |
|
|
596 | <p>Messages have a size limit of 1023 bytes currently.</p> |
|
|
597 | </dd> |
|
|
598 | <p></p> |
|
|
599 | <dt><strong><a name="item__24is_safe__3d_urxvt_3a_3asafe">$is_safe = urxvt::safe</a></strong><br /> |
|
|
600 | </dt> |
|
|
601 | <dd> |
|
|
602 | Returns true when it is safe to do potentially unsafe things, such as |
|
|
603 | evaluating perl code specified by the user. This is true when urxvt was |
|
|
604 | started setuid or setgid. |
435 | </dd> |
605 | </dd> |
436 | <p></p> |
606 | <p></p> |
437 | <dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> |
607 | <dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> |
438 | </dt> |
608 | </dt> |
439 | <dd> |
609 | <dd> |
… | |
… | |
487 | </dt> |
657 | </dt> |
488 | <dd> |
658 | <dd> |
489 | Return the foreground/background colour index, respectively. |
659 | Return the foreground/background colour index, respectively. |
490 | </dd> |
660 | </dd> |
491 | <p></p> |
661 | <p></p> |
492 | <dt><strong><a name="item_set_fgcolor">$rend = urxvt::SET_FGCOLOR ($rend, $new_colour)</a></strong><br /> |
662 | <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> |
663 | </dt> |
494 | <dt><strong><a name="item_set_bgcolor">$rend = urxvt::SET_BGCOLOR ($rend, $new_colour)</a></strong><br /> |
664 | <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> |
665 | </dt> |
496 | <dd> |
666 | <dd> |
497 | Replace the foreground/background colour in the rendition mask with the |
667 | Replace the foreground/background colour in the rendition mask with the |
498 | specified one. |
668 | specified one. |
499 | </dd> |
669 | </dd> |
500 | <p></p> |
670 | <p></p> |
501 | <dt><strong><a name="item_get_custom">$value = urxvt::GET_CUSTOM ($rend)</a></strong><br /> |
671 | <dt><strong><a name="item__24value__3d_urxvt_3a_3aget_custom__24rend">$value = urxvt::GET_CUSTOM $rend</a></strong><br /> |
502 | </dt> |
672 | </dt> |
503 | <dd> |
673 | <dd> |
504 | Return the ``custom'' value: Every rendition has 5 bits for use by |
674 | 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 |
675 | extensions. They can be set and changed as you like and are initially |
506 | zero. |
676 | zero. |
507 | </dd> |
677 | </dd> |
508 | <p></p> |
678 | <p></p> |
509 | <dt><strong><a name="item_set_custom">$rend = urxvt::SET_CUSTOM ($rend, $new_value)</a></strong><br /> |
679 | <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> |
680 | </dt> |
511 | <dd> |
681 | <dd> |
512 | Change the custom value. |
682 | Change the custom value. |
513 | </dd> |
683 | </dd> |
514 | <p></p></dl> |
684 | <p></p></dl> |
515 | <p> |
685 | <p> |
516 | </p> |
686 | </p> |
517 | <h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2> |
687 | <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 |
688 | <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 |
689 | <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 |
690 | 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 |
691 | 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> |
692 | is that you cannot use blocking APIs, but the non-blocking variant should |
|
|
693 | work.</p> |
523 | <p> |
694 | <p> |
524 | </p> |
695 | </p> |
525 | <h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> |
696 | <h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> |
526 | <dl> |
697 | <dl> |
|
|
698 | <dt><strong><a name="item__24term__3d_new_urxvt_3a_3aterm__24envhashref_2c__">$term = new urxvt::term $envhashref, $rxvtname, [arg...]</a></strong><br /> |
|
|
699 | </dt> |
|
|
700 | <dd> |
|
|
701 | Creates a new terminal, very similar as if you had started it with system |
|
|
702 | <code>$rxvtname, arg...</code>. <code>$envhashref</code> must be a reference to a <code>%ENV</code>-like |
|
|
703 | hash which defines the environment of the new terminal. |
|
|
704 | </dd> |
|
|
705 | <dd> |
|
|
706 | <p>Croaks (and probably outputs an error message) if the new instance |
|
|
707 | couldn't be created. Returns <code>undef</code> if the new instance didn't |
|
|
708 | initialise perl, and the terminal object otherwise. The <code>init</code> and |
|
|
709 | <a href="#item_start"><code>start</code></a> hooks will be called during this call.</p> |
|
|
710 | </dd> |
|
|
711 | <p></p> |
527 | <dt><strong><a name="item_destroy">$term->destroy</a></strong><br /> |
712 | <dt><strong><a name="item_destroy">$term->destroy</a></strong><br /> |
528 | </dt> |
713 | </dt> |
529 | <dd> |
714 | <dd> |
530 | Destroy the terminal object (close the window, free resources etc.). |
715 | Destroy the terminal object (close the window, free resources |
|
|
716 | etc.). Please note that rxvt will not exit as long as any event |
|
|
717 | watchers (timers, io watchers) are still active. |
531 | </dd> |
718 | </dd> |
532 | <p></p> |
719 | <p></p> |
533 | <dt><strong><a name="item_option">$isset = $term->option ($optval[, $set])</a></strong><br /> |
720 | <dt><strong><a name="item_option">$isset = $term->option ($optval[, $set])</a></strong><br /> |
534 | </dt> |
721 | </dt> |
535 | <dd> |
722 | <dd> |
… | |
… | |
591 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
778 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
592 | shade term_name title transparent transparent_all tripleclickwords |
779 | shade term_name title transparent transparent_all tripleclickwords |
593 | utmpInhibit visualBell</pre> |
780 | utmpInhibit visualBell</pre> |
594 | </dd> |
781 | </dd> |
595 | <p></p> |
782 | <p></p> |
|
|
783 | <dt><strong><a name="item_x_resource">$value = $term->x_resource ($pattern)</a></strong><br /> |
|
|
784 | </dt> |
|
|
785 | <dd> |
|
|
786 | Returns the X-Resource for the given pattern, excluding the program or |
|
|
787 | class name, i.e. <a href="#item_x_resource"><code>$term->x_resource ("boldFont")</code></a> should return the |
|
|
788 | same value as used by this instance of rxvt-unicode. Returns <code>undef</code> if no |
|
|
789 | resource with that pattern exists. |
|
|
790 | </dd> |
|
|
791 | <dd> |
|
|
792 | <p>This method should only be called during the <code>on_start</code> hook, as there is |
|
|
793 | only one resource database per display, and later invocations might return |
|
|
794 | the wrong resources.</p> |
|
|
795 | </dd> |
|
|
796 | <p></p> |
|
|
797 | <dt><strong><a name="item_parse_keysym">$success = $term->parse_keysym ($keysym_spec, $command_string)</a></strong><br /> |
|
|
798 | </dt> |
|
|
799 | <dd> |
|
|
800 | Adds a keymap translation exactly as specified via a resource. See the |
|
|
801 | <code>keysym</code> resource in the <code>rxvt(1)</code> manpage. |
|
|
802 | </dd> |
|
|
803 | <p></p> |
596 | <dt><strong><a name="item_rstyle">$rend = $term->rstyle ([$new_rstyle])</a></strong><br /> |
804 | <dt><strong><a name="item_rstyle">$rend = $term->rstyle ([$new_rstyle])</a></strong><br /> |
597 | </dt> |
805 | </dt> |
598 | <dd> |
806 | <dd> |
599 | Return and optionally change the current rendition. Text that is output by |
807 | Return and optionally change the current rendition. Text that is output by |
600 | the terminal application will use this style. |
808 | the terminal application will use this style. |
… | |
… | |
616 | <dd> |
824 | <dd> |
617 | Return the current values of the selection mark, begin or end positions, |
825 | Return the current values of the selection mark, begin or end positions, |
618 | and optionally set them to new values. |
826 | and optionally set them to new values. |
619 | </dd> |
827 | </dd> |
620 | <p></p> |
828 | <p></p> |
|
|
829 | <dt><strong><a name="item_selection_make">$term->selection_make ($eventtime[, $rectangular])</a></strong><br /> |
|
|
830 | </dt> |
|
|
831 | <dd> |
|
|
832 | Tries to make a selection as set by <a href="#item_selection_beg"><code>selection_beg</code></a> and |
|
|
833 | <a href="#item_selection_end"><code>selection_end</code></a>. If <code>$rectangular</code> is true (default: false), a |
|
|
834 | rectangular selection will be made. This is the prefered function to make |
|
|
835 | a selection. |
|
|
836 | </dd> |
|
|
837 | <p></p> |
621 | <dt><strong><a name="item_selection_grab">$success = $term->selection_grab ($eventtime)</a></strong><br /> |
838 | <dt><strong><a name="item_selection_grab">$success = $term->selection_grab ($eventtime)</a></strong><br /> |
622 | </dt> |
839 | </dt> |
623 | <dd> |
840 | <dd> |
624 | Try to request the primary selection from the server (for example, as set |
841 | Try to request the primary selection text from the server (for example, as |
625 | by the next method). |
842 | set by the next method). No visual feedback will be given. This function |
|
|
843 | is mostly useful from within <code>on_sel_grab</code> hooks. |
626 | </dd> |
844 | </dd> |
627 | <p></p> |
845 | <p></p> |
628 | <dt><strong>$oldtext = $term->selection ([$newtext])</strong><br /> |
846 | <dt><strong>$oldtext = $term->selection ([$newtext])</strong><br /> |
629 | </dt> |
847 | </dt> |
630 | <dd> |
848 | <dd> |
631 | Return the current selection text and optionally replace it by <code>$newtext</code>. |
849 | Return the current selection text and optionally replace it by <code>$newtext</code>. |
632 | </dd> |
850 | </dd> |
|
|
851 | <p></p> |
|
|
852 | <dt><strong><a name="item_overlay_simple">$term->overlay_simple ($x, $y, $text)</a></strong><br /> |
|
|
853 | </dt> |
633 | <dd> |
854 | <dd> |
634 | <p>#=item $term->overlay ($x, $y, $text) |
|
|
635 | # |
|
|
636 | #Create a simple multi-line overlay box. See the next method for details. |
855 | 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> |
856 | </dd> |
654 | <p></p> |
857 | <p></p> |
655 | <dt><strong><a name="item_overlay">$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br /> |
858 | <dt><strong><a name="item_overlay">$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br /> |
656 | </dt> |
859 | </dt> |
657 | <dd> |
860 | <dd> |
… | |
… | |
718 | <p></p> |
921 | <p></p> |
719 | <dt><strong><a name="item_locale_decode">$string = $term->locale_decode ($octets)</a></strong><br /> |
922 | <dt><strong><a name="item_locale_decode">$string = $term->locale_decode ($octets)</a></strong><br /> |
720 | </dt> |
923 | </dt> |
721 | <dd> |
924 | <dd> |
722 | Convert the given locale-encoded octets into a perl string. |
925 | Convert the given locale-encoded octets into a perl string. |
|
|
926 | </dd> |
|
|
927 | <p></p> |
|
|
928 | <dt><strong><a name="item_scr_xor_span">$term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])</a></strong><br /> |
|
|
929 | </dt> |
|
|
930 | <dd> |
|
|
931 | XORs the rendition values in the given span with the provided value |
|
|
932 | (default: <code>RS_RVid</code>), which <em>MUST NOT</em> contain font styles. Useful in |
|
|
933 | refresh hooks to provide effects similar to the selection. |
|
|
934 | </dd> |
|
|
935 | <p></p> |
|
|
936 | <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 /> |
|
|
937 | </dt> |
|
|
938 | <dd> |
|
|
939 | Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing |
|
|
940 | whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults |
|
|
941 | to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines |
|
|
942 | it instead. Both styles <em>MUST NOT</em> contain font styles. |
|
|
943 | </dd> |
|
|
944 | <p></p> |
|
|
945 | <dt><strong><a name="item_scr_bell">$term->scr_bell</a></strong><br /> |
|
|
946 | </dt> |
|
|
947 | <dd> |
|
|
948 | Ring the bell! |
723 | </dd> |
949 | </dd> |
724 | <p></p> |
950 | <p></p> |
725 | <dt><strong><a name="item_scr_add_lines">$term->scr_add_lines ($string)</a></strong><br /> |
951 | <dt><strong><a name="item_scr_add_lines">$term->scr_add_lines ($string)</a></strong><br /> |
726 | </dt> |
952 | </dt> |
727 | <dd> |
953 | <dd> |
… | |
… | |
750 | Write the octets given in <code>$data</code> to the tty (i.e. as program input). To |
976 | 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 |
977 | 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>. |
978 | to the locale-specific encoding using <a href="#item_locale_encode"><code>$term->locale_encode</code></a>. |
753 | </dd> |
979 | </dd> |
754 | <p></p> |
980 | <p></p> |
|
|
981 | <dt><strong><a name="item_pty_ev_events">$old_events = $term->pty_ev_events ([$new_events])</a></strong><br /> |
|
|
982 | </dt> |
|
|
983 | <dd> |
|
|
984 | Replaces the event mask of the pty watcher by the given event mask. Can |
|
|
985 | be used to suppress input and output handling to the pty/tty. See the |
|
|
986 | description of <a href="#item_events"><code>urxvt::timer->events</code></a>. Make sure to always restore |
|
|
987 | the previous value. |
|
|
988 | </dd> |
|
|
989 | <p></p> |
755 | <dt><strong><a name="item_parent">$windowid = $term->parent</a></strong><br /> |
990 | <dt><strong><a name="item_parent">$windowid = $term->parent</a></strong><br /> |
756 | </dt> |
991 | </dt> |
757 | <dd> |
992 | <dd> |
758 | Return the window id of the toplevel window. |
993 | Return the window id of the toplevel window. |
759 | </dd> |
994 | </dd> |
… | |
… | |
788 | </dt> |
1023 | </dt> |
789 | <dt><strong><a name="item_nsaved">$lines_in_scrollback = $term->nsaved</a></strong><br /> |
1024 | <dt><strong><a name="item_nsaved">$lines_in_scrollback = $term->nsaved</a></strong><br /> |
790 | </dt> |
1025 | </dt> |
791 | <dd> |
1026 | <dd> |
792 | Return various integers describing terminal characteristics. |
1027 | Return various integers describing terminal characteristics. |
|
|
1028 | </dd> |
|
|
1029 | <p></p> |
|
|
1030 | <dt><strong><a name="item_display_id">$x_display = $term->display_id</a></strong><br /> |
|
|
1031 | </dt> |
|
|
1032 | <dd> |
|
|
1033 | Return the DISPLAY used by rxvt-unicode. |
|
|
1034 | </dd> |
|
|
1035 | <p></p> |
|
|
1036 | <dt><strong><a name="item_locale">$lc_ctype = $term->locale</a></strong><br /> |
|
|
1037 | </dt> |
|
|
1038 | <dd> |
|
|
1039 | Returns the LC_CTYPE category string used by this rxvt-unicode. |
|
|
1040 | </dd> |
|
|
1041 | <p></p> |
|
|
1042 | <dt><strong><a name="item_env">$env = $term->env</a></strong><br /> |
|
|
1043 | </dt> |
|
|
1044 | <dd> |
|
|
1045 | Returns a copy of the environment in effect for the terminal as a hashref |
|
|
1046 | similar to <code>\%ENV</code>. |
793 | </dd> |
1047 | </dd> |
794 | <p></p> |
1048 | <p></p> |
795 | <dt><strong><a name="item_modlevel3mask">$modifiermask = $term->ModLevel3Mask</a></strong><br /> |
1049 | <dt><strong><a name="item_modlevel3mask">$modifiermask = $term->ModLevel3Mask</a></strong><br /> |
796 | </dt> |
1050 | </dt> |
797 | <dt><strong><a name="item_modmetamask">$modifiermask = $term->ModMetaMask</a></strong><br /> |
1051 | <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 |
1102 | <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 |
1103 | that <code>substr</code> and similar functions work on screen cells and not on |
850 | characters.</p> |
1104 | characters.</p> |
851 | </dd> |
1105 | </dd> |
852 | <dd> |
1106 | <dd> |
853 | <p>The methods <code>$term->special_encode</code> and <a href="#item_special_decode"><code>$term->special_decode</code></a> |
1107 | <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> |
1108 | can be used to convert normal strings into this encoding and vice versa.</p> |
855 | </dd> |
1109 | </dd> |
856 | <p></p> |
1110 | <p></p> |
857 | <dt><strong><a name="item_row_r">$rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br /> |
1111 | <dt><strong><a name="item_row_r">$rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br /> |
858 | </dt> |
1112 | </dt> |
… | |
… | |
921 | <p></p> |
1175 | <p></p> |
922 | <dt><strong><a name="item_offset_of">$offset = $line->offset_of ($row, $col)</a></strong><br /> |
1176 | <dt><strong><a name="item_offset_of">$offset = $line->offset_of ($row, $col)</a></strong><br /> |
923 | </dt> |
1177 | </dt> |
924 | <dd> |
1178 | <dd> |
925 | Returns the character offset of the given row|col pair within the logical |
1179 | Returns the character offset of the given row|col pair within the logical |
926 | line. |
1180 | line. Works for rows outside the line, too, and returns corresponding |
|
|
1181 | offsets outside the string. |
927 | </dd> |
1182 | </dd> |
928 | <p></p> |
1183 | <p></p> |
929 | <dt><strong><a name="item_coord_of">($row, $col) = $line->coord_of ($offset)</a></strong><br /> |
1184 | <dt><strong><a name="item_coord_of">($row, $col) = $line->coord_of ($offset)</a></strong><br /> |
930 | </dt> |
1185 | </dt> |
931 | <dd> |
1186 | <dd> |
932 | Translates a string offset into terminal coordinates again. |
1187 | Translates a string offset into terminal coordinates again. |
933 | </dd> |
1188 | </dd> |
934 | <p></p></dl> |
1189 | <p></p></dl> |
935 | <dt><strong>($row, $col) = $line->coord_of ($offset) |
1190 | <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> |
1191 | </dt> |
938 | <dd> |
1192 | <dd> |
939 | Converts a perl string into the special encoding used by rxvt-unicode, |
1193 | Converts a perl string into the special encoding used by rxvt-unicode, |
940 | where one character corresponds to one screen cell. See |
1194 | where one character corresponds to one screen cell. See |
941 | <a href="#item_row_t"><code>$term->ROW_t</code></a> for details. |
1195 | <a href="#item_row_t"><code>$term->ROW_t</code></a> for details. |
… | |
… | |
945 | </dt> |
1199 | </dt> |
946 | <dd> |
1200 | <dd> |
947 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1201 | Converts rxvt-unicodes text reprsentation into a perl string. See |
948 | <a href="#item_row_t"><code>$term->ROW_t</code></a> for details. |
1202 | <a href="#item_row_t"><code>$term->ROW_t</code></a> for details. |
949 | </dd> |
1203 | </dd> |
|
|
1204 | <p></p> |
|
|
1205 | <dt><strong><a name="item_grab_button">$success = $term->grab_button ($button, $modifiermask)</a></strong><br /> |
|
|
1206 | </dt> |
|
|
1207 | <dd> |
|
|
1208 | Registers a synchronous button grab. See the XGrabButton manpage. |
|
|
1209 | </dd> |
|
|
1210 | <p></p> |
|
|
1211 | <dt><strong><a name="item_grab">$success = $term->grab ($eventtime[, $sync])</a></strong><br /> |
|
|
1212 | </dt> |
|
|
1213 | <dd> |
|
|
1214 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
|
|
1215 | synchronous (<code>$sync</code> is true). Also remembers the grab timestampe. |
|
|
1216 | </dd> |
|
|
1217 | <p></p> |
|
|
1218 | <dt><strong><a name="item_allow_events_async">$term->allow_events_async</a></strong><br /> |
|
|
1219 | </dt> |
|
|
1220 | <dd> |
|
|
1221 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
|
|
1222 | </dd> |
|
|
1223 | <p></p> |
|
|
1224 | <dt><strong><a name="item_allow_events_sync">$term->allow_events_sync</a></strong><br /> |
|
|
1225 | </dt> |
|
|
1226 | <dd> |
|
|
1227 | Calls XAllowEvents with SyncBoth for the most recent grab. |
|
|
1228 | </dd> |
|
|
1229 | <p></p> |
|
|
1230 | <dt><strong><a name="item_allow_events_replay">$term->allow_events_replay</a></strong><br /> |
|
|
1231 | </dt> |
|
|
1232 | <dd> |
|
|
1233 | Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most |
|
|
1234 | recent grab. |
|
|
1235 | </dd> |
|
|
1236 | <p></p> |
|
|
1237 | <dt><strong><a name="item_ungrab">$term->ungrab</a></strong><br /> |
|
|
1238 | </dt> |
|
|
1239 | <dd> |
|
|
1240 | Calls XUngrab for the most recent grab. Is called automatically on |
|
|
1241 | evaluation errors, as it is better to lose the grab in the error case as |
|
|
1242 | the session. |
|
|
1243 | </dd> |
950 | <p></p></dl> |
1244 | <p></p></dl> |
951 | <p> |
1245 | <p> |
952 | </p> |
1246 | </p> |
953 | <h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> |
1247 | <h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> |
|
|
1248 | <dl> |
|
|
1249 | <dt><strong><a name="item_add_title">$popup->add_title ($title)</a></strong><br /> |
|
|
1250 | </dt> |
|
|
1251 | <dd> |
|
|
1252 | Adds a non-clickable title to the popup. |
|
|
1253 | </dd> |
|
|
1254 | <p></p> |
|
|
1255 | <dt><strong><a name="item_add_separator">$popup->add_separator ([$sepchr])</a></strong><br /> |
|
|
1256 | </dt> |
|
|
1257 | <dd> |
|
|
1258 | Creates a separator, optionally using the character given as <code>$sepchr</code>. |
|
|
1259 | </dd> |
|
|
1260 | <p></p> |
|
|
1261 | <dt><strong><a name="item_add_button">$popup->add_button ($text, $cb)</a></strong><br /> |
|
|
1262 | </dt> |
|
|
1263 | <dd> |
|
|
1264 | Adds a clickable button to the popup. <code>$cb</code> is called whenever it is |
|
|
1265 | selected. |
|
|
1266 | </dd> |
|
|
1267 | <p></p> |
|
|
1268 | <dt><strong><a name="item_add_toggle">$popup->add_toggle ($text, $cb, $initial_value)</a></strong><br /> |
|
|
1269 | </dt> |
|
|
1270 | <dd> |
|
|
1271 | Adds a toggle/checkbox item to the popup. Teh callback gets called |
|
|
1272 | whenever it gets toggled, with a boolean indicating its value as its first |
|
|
1273 | argument. |
|
|
1274 | </dd> |
|
|
1275 | <p></p> |
|
|
1276 | <dt><strong>$popup->show</strong><br /> |
|
|
1277 | </dt> |
|
|
1278 | <dd> |
|
|
1279 | Displays the popup (which is initially hidden). |
|
|
1280 | </dd> |
|
|
1281 | <p></p></dl> |
954 | <p> |
1282 | <p> |
955 | </p> |
1283 | </p> |
956 | <h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> |
1284 | <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 |
1285 | <p>This class implements timer watchers/events. Time is represented as a |
958 | fractional number of seconds since the epoch. Example:</p> |
1286 | fractional number of seconds since the epoch. Example:</p> |
… | |
… | |
1024 | <pre> |
1352 | <pre> |
1025 | $term->{socket} = ... |
1353 | $term->{socket} = ... |
1026 | $term->{iow} = urxvt::iow |
1354 | $term->{iow} = urxvt::iow |
1027 | ->new |
1355 | ->new |
1028 | ->fd (fileno $term->{socket}) |
1356 | ->fd (fileno $term->{socket}) |
1029 | ->events (1) # wait for read data |
1357 | ->events (urxvt::EVENT_READ) |
1030 | ->start |
1358 | ->start |
1031 | ->cb (sub { |
1359 | ->cb (sub { |
1032 | my ($iow, $revents) = @_; |
1360 | my ($iow, $revents) = @_; |
1033 | # $revents must be 1 here, no need to check |
1361 | # $revents must be 1 here, no need to check |
1034 | sysread $term->{socket}, my $buf, 8192 |
1362 | sysread $term->{socket}, my $buf, 8192 |
… | |
… | |
1055 | </dd> |
1383 | </dd> |
1056 | <p></p> |
1384 | <p></p> |
1057 | <dt><strong><a name="item_events">$iow = $iow->events ($eventmask)</a></strong><br /> |
1385 | <dt><strong><a name="item_events">$iow = $iow->events ($eventmask)</a></strong><br /> |
1058 | </dt> |
1386 | </dt> |
1059 | <dd> |
1387 | <dd> |
1060 | Set the event mask to watch. Bit #0 (value <code>1</code>) enables watching for read |
1388 | Set the event mask to watch. The only allowed values are |
1061 | data, Bit #1 (value <code>2</code>) enables watching for write data. |
1389 | <code>urxvt::EVENT_READ</code> and <code>urxvt::EVENT_WRITE</code>, which might be ORed |
|
|
1390 | together, or <code>urxvt::EVENT_NONE</code>. |
1062 | </dd> |
1391 | </dd> |
1063 | <p></p> |
1392 | <p></p> |
1064 | <dt><strong>$iow = $iow->start</strong><br /> |
1393 | <dt><strong>$iow = $iow->start</strong><br /> |
1065 | </dt> |
1394 | </dt> |
1066 | <dd> |
1395 | <dd> |
… | |
… | |
1081 | </p> |
1410 | </p> |
1082 | <h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> |
1411 | <h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> |
1083 | <p>This variable controls the verbosity level of the perl extension. Higher |
1412 | <p>This variable controls the verbosity level of the perl extension. Higher |
1084 | numbers indicate more verbose output.</p> |
1413 | numbers indicate more verbose output.</p> |
1085 | <dl> |
1414 | <dl> |
1086 | <dt><strong><a name="item__3d0__2d_only_fatal_messages">=0 - only fatal messages</a></strong><br /> |
1415 | <dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br /> |
1087 | </dt> |
1416 | </dt> |
1088 | <dt><strong><a name="item__3d3__2d_script_loading_and_management">=3 - script loading and management</a></strong><br /> |
1417 | <dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">>= 3 - script loading and management</a></strong><br /> |
1089 | </dt> |
1418 | </dt> |
1090 | <dt><strong><a name="item__3d10__2d_all_events_received">=10 - all events received</a></strong><br /> |
1419 | <dt><strong><a name="item__3e_3d10__2d_all_called_hooks">>=10 - all called hooks</a></strong><br /> |
|
|
1420 | </dt> |
|
|
1421 | <dt><strong><a name="item__3e_3d11__2d_hook_reutrn_values">>=11 - hook reutrn values</a></strong><br /> |
1091 | </dt> |
1422 | </dt> |
1092 | </dl> |
1423 | </dl> |
1093 | <p> |
1424 | <p> |
1094 | </p> |
1425 | </p> |
1095 | <hr /> |
1426 | <hr /> |