… | |
… | |
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> |
92 | <p>It also offers the following bindable event:</p> |
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> |
|
|
125 | <p>This extension also offers following bindable keyboard commands:</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> |
… | |
… | |
111 | <p></p> |
144 | <p></p> |
112 | <dt><strong>selection-popup (enabled by default)</strong><br /> |
145 | <dt><strong>selection-popup (enabled by default)</strong><br /> |
113 | </dt> |
146 | </dt> |
114 | <dd> |
147 | <dd> |
115 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
148 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
116 | text into various other formats/action. |
149 | text into various other formats/action (such as uri unescaping, perl |
117 | </dd> |
150 | evalution, web-browser starting etc.), depending on content. |
118 | <p></p> |
|
|
119 | <dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> |
|
|
120 | </dt> |
|
|
121 | <dd> |
151 | </dd> |
122 | 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/^([^:[:space:]]+):(\\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/^([^:[:space:]]+(\\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> |
123 | </dd> |
220 | </dd> |
124 | <p></p> |
221 | <p></p> |
125 | <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 /> |
126 | </dt> |
223 | </dt> |
127 | <dd> |
224 | <dd> |
128 | 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. |
129 | </dd> |
229 | </dd> |
130 | <p></p> |
230 | <p></p> |
131 | <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 /> |
132 | </dt> |
232 | </dt> |
133 | <dd> |
233 | <dd> |
134 | 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, |
135 | 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 |
136 | similar-looking ascii character. |
236 | similar-looking ascii character. |
137 | </dd> |
237 | </dd> |
138 | <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> |
139 | <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 /> |
140 | </dt> |
246 | </dt> |
141 | <dd> |
247 | <dd> |
142 | 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 |
143 | window. Illustrates overwriting the refresh callbacks to create your own |
249 | window. Illustrates overwriting the refresh callbacks to create your own |
144 | overlays or changes. |
250 | overlays or changes. |
145 | </dd> |
251 | </dd> |
|
|
252 | <p></p> |
|
|
253 | <dt><strong><a name="item_selection_2dpastebin">selection-pastebin</a></strong><br /> |
|
|
254 | </dt> |
|
|
255 | <dd> |
|
|
256 | This is a little rarely useful extension that Uploads the selection as |
|
|
257 | textfile to a remote site (or does other things). (The implementation is |
|
|
258 | not currently secure for use in a multiuser environment as it writes to |
|
|
259 | <em>/tmp</em> directly.). |
|
|
260 | </dd> |
|
|
261 | <dd> |
|
|
262 | <p>It listens to the <code>selection-pastebin:remote-pastebin</code> keyboard command, |
|
|
263 | i.e.</p> |
|
|
264 | </dd> |
|
|
265 | <dd> |
|
|
266 | <pre> |
|
|
267 | URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin</pre> |
|
|
268 | </dd> |
|
|
269 | <dd> |
|
|
270 | <p>Pressing this combination runs a command with <code>%</code> replaced by the name of |
|
|
271 | the textfile. This command can be set via a resource:</p> |
|
|
272 | </dd> |
|
|
273 | <dd> |
|
|
274 | <pre> |
|
|
275 | URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.</pre> |
|
|
276 | </dd> |
|
|
277 | <dd> |
|
|
278 | <p>And the default is likely not useful to anybody but the few people around |
|
|
279 | here :)</p> |
|
|
280 | </dd> |
|
|
281 | <dd> |
|
|
282 | <p>The name of the textfile is the hex encoded md5 sum of the selection, so |
|
|
283 | the same content should lead to the same filename.</p> |
|
|
284 | </dd> |
|
|
285 | <dd> |
|
|
286 | <p>After a successful upload the selection will be replaced by the text given |
|
|
287 | in the <code>selection-pastebin-url</code> resource (again, the % is the placeholder |
|
|
288 | for the filename):</p> |
|
|
289 | </dd> |
|
|
290 | <dd> |
|
|
291 | <pre> |
|
|
292 | URxvt.selection-pastebin.url: <a href="http://www.ta-sa.org/files/txt/%">http://www.ta-sa.org/files/txt/%</a></pre> |
|
|
293 | </dd> |
146 | <p></p></dl> |
294 | <p></p></dl> |
|
|
295 | <p> |
|
|
296 | </p> |
|
|
297 | <hr /> |
|
|
298 | <h1><a name="api_documentation">API DOCUMENTATION</a></h1> |
147 | <p> |
299 | <p> |
148 | </p> |
300 | </p> |
149 | <h2><a name="general_api_considerations">General API Considerations</a></h2> |
301 | <h2><a name="general_api_considerations">General API Considerations</a></h2> |
150 | <p>All objects (such as terminals, time watchers etc.) are typical |
302 | <p>All objects (such as terminals, time watchers etc.) are typical |
151 | reference-to-hash objects. The hash can be used to store anything you |
303 | reference-to-hash objects. The hash can be used to store anything you |
… | |
… | |
161 | <dl> |
313 | <dl> |
162 | <dt><strong><a name="item__24text">$text</a></strong><br /> |
314 | <dt><strong><a name="item__24text">$text</a></strong><br /> |
163 | </dt> |
315 | </dt> |
164 | <dd> |
316 | <dd> |
165 | Rxvt-unicodes special way of encoding text, where one ``unicode'' character |
317 | Rxvt-unicodes special way of encoding text, where one ``unicode'' character |
166 | always represents one screen cell. See <em>row_t</em> for a discussion of this format. |
318 | always represents one screen cell. See <a href="#item_row_t">ROW_t</a> for a discussion of this format. |
167 | </dd> |
319 | </dd> |
168 | <p></p> |
320 | <p></p> |
169 | <dt><strong><a name="item__24string">$string</a></strong><br /> |
321 | <dt><strong><a name="item__24string">$string</a></strong><br /> |
170 | </dt> |
322 | </dt> |
171 | <dd> |
323 | <dd> |
… | |
… | |
181 | locale-specific way. |
333 | locale-specific way. |
182 | </dd> |
334 | </dd> |
183 | <p></p></dl> |
335 | <p></p></dl> |
184 | <p> |
336 | <p> |
185 | </p> |
337 | </p> |
|
|
338 | <h2><a name="extension_objects">Extension Objects</a></h2> |
|
|
339 | <p>Very perl extension is a perl class. A separate perl object is created |
|
|
340 | for each terminal and each extension and passed as the first parameter to |
|
|
341 | hooks. So extensions can use their <code>$self</code> object without having to think |
|
|
342 | about other extensions, with the exception of methods and members that |
|
|
343 | begin with an underscore character <code>_</code>: these are reserved for internal |
|
|
344 | use.</p> |
|
|
345 | <p>Although it isn't a <code>urxvt::term</code> object, you can call all methods of the |
|
|
346 | <code>urxvt::term</code> class on this object.</p> |
|
|
347 | <p>It has the following methods and data members:</p> |
|
|
348 | <dl> |
|
|
349 | <dt><strong><a name="item__24urxvt_term__3d__24self_2d_3e_7bterm_7d">$urxvt_term = $self->{term}</a></strong><br /> |
|
|
350 | </dt> |
|
|
351 | <dd> |
|
|
352 | Returns the <code>urxvt::term</code> object associated with this instance of the |
|
|
353 | extension. This member <em>must not</em> be changed in any way. |
|
|
354 | </dd> |
|
|
355 | <p></p> |
|
|
356 | <dt><strong><a name="item_enable">$self->enable ($hook_name => $cb, [$hook_name => $cb..])</a></strong><br /> |
|
|
357 | </dt> |
|
|
358 | <dd> |
|
|
359 | Dynamically enable the given hooks (named without the <code>on_</code> prefix) for |
|
|
360 | this extension, replacing any previous hook. This is useful when you want |
|
|
361 | to overwrite time-critical hooks only temporarily. |
|
|
362 | </dd> |
|
|
363 | <p></p> |
|
|
364 | <dt><strong><a name="item_disable">$self->disable ($hook_name[, $hook_name..])</a></strong><br /> |
|
|
365 | </dt> |
|
|
366 | <dd> |
|
|
367 | Dynamically disable the given hooks. |
|
|
368 | </dd> |
|
|
369 | <p></p></dl> |
|
|
370 | <p> |
|
|
371 | </p> |
186 | <h2><a name="hooks">Hooks</a></h2> |
372 | <h2><a name="hooks">Hooks</a></h2> |
187 | <p>The following subroutines can be declared in extension files, and will be |
373 | <p>The following subroutines can be declared in extension files, and will be |
188 | called whenever the relevant event happens.</p> |
374 | called whenever the relevant event happens.</p> |
189 | <p>The first argument passed to them is an object private to each terminal |
375 | <p>The first argument passed to them is an extension oject as described in |
190 | and extension package. You can call all <code>urxvt::term</code> methods on it, but |
376 | the in the <code>Extension Objects</code> section.</p> |
191 | its not a real <code>urxvt::term</code> object. Instead, the real <code>urxvt::term</code> |
|
|
192 | object that is shared between all packages is stored in the <code>term</code> |
|
|
193 | member. It is, however, blessed intot he package of the extension script, |
|
|
194 | so for all practical purposes you can treat an extension script as a class.</p> |
|
|
195 | <p>All of them must return a boolean value. If it is true, then the event |
377 | <p><strong>All</strong> of these hooks must return a boolean value. If it is true, then the |
196 | counts as being <em>consumed</em>, and the invocation of other hooks is skipped, |
378 | event counts as being <em>consumed</em>, and the invocation of other hooks is |
197 | and the relevant action might not be carried out by the C++ code.</p> |
379 | skipped, and the relevant action might not be carried out by the C++ code.</p> |
198 | <p>When in doubt, return a false value (preferably <code>()</code>).</p> |
380 | <p><em>When in doubt, return a false value (preferably <code>()</code>). </em>></p> |
199 | <dl> |
381 | <dl> |
200 | <dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> |
382 | <dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> |
201 | </dt> |
383 | </dt> |
202 | <dd> |
384 | <dd> |
203 | Called after a new terminal object has been initialized, but before |
385 | Called after a new terminal object has been initialized, but before |
… | |
… | |
249 | </dt> |
431 | </dt> |
250 | <dd> |
432 | <dd> |
251 | Called whenever the user tries to extend the selection (e.g. with a double |
433 | Called whenever the user tries to extend the selection (e.g. with a double |
252 | click) and is either supposed to return false (normal operation), or |
434 | click) and is either supposed to return false (normal operation), or |
253 | should extend the selection itelf and return true to suppress the built-in |
435 | should extend the selection itelf and return true to suppress the built-in |
254 | processing. |
436 | processing. This can happen multiple times, as long as the callback |
|
|
437 | returns true, it will be called on every further click by the user and is |
|
|
438 | supposed to enlarge the selection more and more, if possible. |
255 | </dd> |
439 | </dd> |
256 | <dd> |
440 | <dd> |
257 | <p>See the <em>selection</em> example extension.</p> |
441 | <p>See the <em>selection</em> example extension.</p> |
258 | </dd> |
442 | </dd> |
259 | <p></p> |
443 | <p></p> |
… | |
… | |
302 | and calling <a href="#item_scr_add_lines"><code>$term->scr_add_lines</code></a> yourself. Please note that this |
486 | and calling <a href="#item_scr_add_lines"><code>$term->scr_add_lines</code></a> yourself. Please note that this |
303 | might be very slow, however, as your hook is called for <strong>all</strong> text being |
487 | might be very slow, however, as your hook is called for <strong>all</strong> text being |
304 | output. |
488 | output. |
305 | </dd> |
489 | </dd> |
306 | <p></p> |
490 | <p></p> |
|
|
491 | <dt><strong><a name="item_on_tt_write__24term_2c__24octets">on_tt_write $term, $octets</a></strong><br /> |
|
|
492 | </dt> |
|
|
493 | <dd> |
|
|
494 | Called whenever some data is written to the tty/pty and can be used to |
|
|
495 | suppress or filter tty input. |
|
|
496 | </dd> |
|
|
497 | <p></p> |
307 | <dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong><br /> |
498 | <dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong><br /> |
308 | </dt> |
499 | </dt> |
309 | <dd> |
500 | <dd> |
310 | Called whenever a line was updated or changed. Can be used to filter |
501 | Called whenever a line was updated or changed. Can be used to filter |
311 | screen output (e.g. underline urls or other useless stuff). Only lines |
502 | screen output (e.g. underline urls or other useless stuff). Only lines |
… | |
… | |
343 | Called whenever the user presses a key combination that has a |
534 | Called whenever the user presses a key combination that has a |
344 | <code>perl:string</code> action bound to it (see description of the <strong>keysym</strong> |
535 | <code>perl:string</code> action bound to it (see description of the <strong>keysym</strong> |
345 | resource in the <code>rxvt(1)</code> manpage). |
536 | resource in the <code>rxvt(1)</code> manpage). |
346 | </dd> |
537 | </dd> |
347 | <p></p> |
538 | <p></p> |
|
|
539 | <dt><strong><a name="item_on_x_event__24term_2c__24event">on_x_event $term, $event</a></strong><br /> |
|
|
540 | </dt> |
|
|
541 | <dd> |
|
|
542 | Called on every X event received on the vt window (and possibly other |
|
|
543 | windows). Should only be used as a last resort. Most event structure |
|
|
544 | members are not passed. |
|
|
545 | </dd> |
|
|
546 | <p></p> |
348 | <dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> |
547 | <dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> |
349 | </dt> |
548 | </dt> |
350 | <dd> |
549 | <dd> |
351 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
550 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
352 | does focus in processing. |
551 | does focus in processing. |
… | |
… | |
357 | <dd> |
556 | <dd> |
358 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
557 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
359 | focus out processing. |
558 | focus out processing. |
360 | </dd> |
559 | </dd> |
361 | <p></p> |
560 | <p></p> |
362 | <dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24octets">on_key_press $term, $event, $octets</a></strong><br /> |
561 | <dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a></strong><br /> |
363 | </dt> |
562 | </dt> |
364 | <dt><strong><a name="item_on_key_release__24term_2c__24event">on_key_release $term, $event</a></strong><br /> |
563 | <dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br /> |
365 | </dt> |
564 | </dt> |
366 | <dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br /> |
565 | <dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br /> |
367 | </dt> |
566 | </dt> |
368 | <dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br /> |
567 | <dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br /> |
369 | </dt> |
568 | </dt> |
… | |
… | |
392 | <p></p></dl> |
591 | <p></p></dl> |
393 | <p> |
592 | <p> |
394 | </p> |
593 | </p> |
395 | <h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> |
594 | <h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> |
396 | <dl> |
595 | <dl> |
|
|
596 | <dt><strong><a name="item__24urxvt_3a_3alibdir">$urxvt::LIBDIR</a></strong><br /> |
|
|
597 | </dt> |
|
|
598 | <dd> |
|
|
599 | The rxvt-unicode library directory, where, among other things, the perl |
|
|
600 | modules and scripts are stored. |
|
|
601 | </dd> |
|
|
602 | <p></p> |
|
|
603 | <dt><strong><a name="item__24urxvt_3a_3aresclass_2c__24urxvt_3a_3aresclass">$urxvt::RESCLASS, $urxvt::RESCLASS</a></strong><br /> |
|
|
604 | </dt> |
|
|
605 | <dd> |
|
|
606 | The resource class and name rxvt-unicode uses to look up X resources. |
|
|
607 | </dd> |
|
|
608 | <p></p> |
|
|
609 | <dt><strong><a name="item__24urxvt_3a_3arxvtname">$urxvt::RXVTNAME</a></strong><br /> |
|
|
610 | </dt> |
|
|
611 | <dd> |
|
|
612 | The basename of the installed binaries, usually <code>urxvt</code>. |
|
|
613 | </dd> |
|
|
614 | <p></p> |
397 | <dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br /> |
615 | <dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br /> |
398 | </dt> |
616 | </dt> |
399 | <dd> |
617 | <dd> |
400 | The current terminal. This variable stores the current <code>urxvt::term</code> |
618 | The current terminal. This variable stores the current <code>urxvt::term</code> |
401 | object, whenever a callback/hook is executing. |
619 | object, whenever a callback/hook is executing. |
… | |
… | |
403 | <p></p></dl> |
621 | <p></p></dl> |
404 | <p> |
622 | <p> |
405 | </p> |
623 | </p> |
406 | <h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> |
624 | <h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> |
407 | <dl> |
625 | <dl> |
408 | <dt><strong><a name="item__24term__3d_new_urxvt__5barg_2e_2e_2e_5d">$term = new urxvt [arg...]</a></strong><br /> |
|
|
409 | </dt> |
|
|
410 | <dd> |
|
|
411 | Creates a new terminal, very similar as if you had started it with |
|
|
412 | <code>system $binfile, arg...</code>. Croaks (and probably outputs an error message) |
|
|
413 | if the new instance couldn't be created. Returns <code>undef</code> if the new |
|
|
414 | instance didn't initialise perl, and the terminal object otherwise. The |
|
|
415 | <code>init</code> and <a href="#item_start"><code>start</code></a> hooks will be called during the call. |
|
|
416 | </dd> |
|
|
417 | <p></p> |
|
|
418 | <dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br /> |
626 | <dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br /> |
419 | </dt> |
627 | </dt> |
420 | <dd> |
628 | <dd> |
421 | Fatally aborts execution with the given error message. Avoid at all |
629 | Fatally aborts execution with the given error message. Avoid at all |
422 | costs! The only time this is acceptable is when the terminal process |
630 | costs! The only time this is acceptable is when the terminal process |
… | |
… | |
432 | </dd> |
640 | </dd> |
433 | <dd> |
641 | <dd> |
434 | <p>Using this function has the advantage that its output ends up in the |
642 | <p>Using this function has the advantage that its output ends up in the |
435 | correct place, e.g. on stderr of the connecting urxvtc client.</p> |
643 | correct place, e.g. on stderr of the connecting urxvtc client.</p> |
436 | </dd> |
644 | </dd> |
437 | <p></p> |
|
|
438 | <dt><strong><a name="item__24is_safe__3d_urxvt_3a_3asafe">$is_safe = urxvt::safe</a></strong><br /> |
|
|
439 | </dt> |
|
|
440 | <dd> |
645 | <dd> |
441 | Returns true when it is safe to do potentially unsafe things, such as |
646 | <p>Messages have a size limit of 1023 bytes currently.</p> |
442 | evaluating perl code specified by the user. This is true when urxvt was |
|
|
443 | started setuid or setgid. |
|
|
444 | </dd> |
647 | </dd> |
445 | <p></p> |
648 | <p></p> |
446 | <dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> |
649 | <dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> |
447 | </dt> |
650 | </dt> |
448 | <dd> |
651 | <dd> |
… | |
… | |
452 | <dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br /> |
655 | <dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br /> |
453 | </dt> |
656 | </dt> |
454 | <dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
657 | <dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
455 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
658 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
456 | Button4Mask, Button5Mask, AnyModifier</a></strong><br /> |
659 | Button4Mask, Button5Mask, AnyModifier</a></strong><br /> |
|
|
660 | </dt> |
|
|
661 | <dt><strong><a name="item_urxvt_3a_3anoeventmask_2c_keypressmask_2c_keyrelea">urxvt::NoEventMask, KeyPressMask, KeyReleaseMask, |
|
|
662 | ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, |
|
|
663 | PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask, |
|
|
664 | Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask, |
|
|
665 | KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask, |
|
|
666 | ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask, |
|
|
667 | FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask</a></strong><br /> |
|
|
668 | </dt> |
|
|
669 | <dt><strong><a name="item_urxvt_3a_3akeypress_2c_keyrelease_2c_buttonpress_2">urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify, |
|
|
670 | EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose, |
|
|
671 | GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify, |
|
|
672 | UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify, |
|
|
673 | ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify, |
|
|
674 | CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, |
|
|
675 | SelectionNotify, ColormapNotify, ClientMessage, MappingNotify</a></strong><br /> |
457 | </dt> |
676 | </dt> |
458 | <dd> |
677 | <dd> |
459 | Various constants for use in X calls and event processing. |
678 | Various constants for use in X calls and event processing. |
460 | </dd> |
679 | </dd> |
461 | <p></p></dl> |
680 | <p></p></dl> |
… | |
… | |
496 | </dt> |
715 | </dt> |
497 | <dd> |
716 | <dd> |
498 | Return the foreground/background colour index, respectively. |
717 | Return the foreground/background colour index, respectively. |
499 | </dd> |
718 | </dd> |
500 | <p></p> |
719 | <p></p> |
501 | <dt><strong><a name="item_set_fgcolor">$rend = urxvt::SET_FGCOLOR ($rend, $new_colour)</a></strong><br /> |
720 | <dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_fgcolor__24rend_2c__24n">$rend = urxvt::SET_FGCOLOR $rend, $new_colour</a></strong><br /> |
502 | </dt> |
721 | </dt> |
503 | <dt><strong><a name="item_set_bgcolor">$rend = urxvt::SET_BGCOLOR ($rend, $new_colour)</a></strong><br /> |
722 | <dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_bgcolor__24rend_2c__24n">$rend = urxvt::SET_BGCOLOR $rend, $new_colour</a></strong><br /> |
504 | </dt> |
723 | </dt> |
505 | <dd> |
724 | <dd> |
506 | Replace the foreground/background colour in the rendition mask with the |
725 | Replace the foreground/background colour in the rendition mask with the |
507 | specified one. |
726 | specified one. |
508 | </dd> |
727 | </dd> |
509 | <p></p> |
728 | <p></p> |
510 | <dt><strong><a name="item_get_custom">$value = urxvt::GET_CUSTOM ($rend)</a></strong><br /> |
729 | <dt><strong><a name="item__24value__3d_urxvt_3a_3aget_custom__24rend">$value = urxvt::GET_CUSTOM $rend</a></strong><br /> |
511 | </dt> |
730 | </dt> |
512 | <dd> |
731 | <dd> |
513 | Return the ``custom'' value: Every rendition has 5 bits for use by |
732 | Return the ``custom'' value: Every rendition has 5 bits for use by |
514 | extensions. They can be set and changed as you like and are initially |
733 | extensions. They can be set and changed as you like and are initially |
515 | zero. |
734 | zero. |
516 | </dd> |
735 | </dd> |
517 | <p></p> |
736 | <p></p> |
518 | <dt><strong><a name="item_set_custom">$rend = urxvt::SET_CUSTOM ($rend, $new_value)</a></strong><br /> |
737 | <dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_custom__24rend_2c__24ne">$rend = urxvt::SET_CUSTOM $rend, $new_value</a></strong><br /> |
519 | </dt> |
738 | </dt> |
520 | <dd> |
739 | <dd> |
521 | Change the custom value. |
740 | Change the custom value. |
522 | </dd> |
741 | </dd> |
523 | <p></p></dl> |
742 | <p></p></dl> |
524 | <p> |
743 | <p> |
525 | </p> |
744 | </p> |
526 | <h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2> |
745 | <h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2> |
527 | <p>The sole purpose of this class is to deliver an interface to the |
746 | <p>The sole purpose of this class is to deliver an interface to the |
528 | <code>AnyEvent</code> module - any module using it will work inside urxvt without |
747 | <code>AnyEvent</code> module - any module using it will work inside urxvt without |
529 | further work. The only exception is that you cannot wait on condition |
748 | further programming. The only exception is that you cannot wait on |
530 | variables, but non-blocking condvar use is ok. What this means is that you |
749 | condition variables, but non-blocking condvar use is ok. What this means |
531 | cannot use blocking APIs, but the non-blocking variant should work.</p> |
750 | is that you cannot use blocking APIs, but the non-blocking variant should |
|
|
751 | work.</p> |
532 | <p> |
752 | <p> |
533 | </p> |
753 | </p> |
534 | <h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> |
754 | <h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> |
535 | <dl> |
755 | <dl> |
|
|
756 | <dt><strong><a name="item__24term__3d_new_urxvt_3a_3aterm__24envhashref_2c__">$term = new urxvt::term $envhashref, $rxvtname, [arg...]</a></strong><br /> |
|
|
757 | </dt> |
|
|
758 | <dd> |
|
|
759 | Creates a new terminal, very similar as if you had started it with system |
|
|
760 | <code>$rxvtname, arg...</code>. <code>$envhashref</code> must be a reference to a <code>%ENV</code>-like |
|
|
761 | hash which defines the environment of the new terminal. |
|
|
762 | </dd> |
|
|
763 | <dd> |
|
|
764 | <p>Croaks (and probably outputs an error message) if the new instance |
|
|
765 | couldn't be created. Returns <code>undef</code> if the new instance didn't |
|
|
766 | initialise perl, and the terminal object otherwise. The <code>init</code> and |
|
|
767 | <a href="#item_start"><code>start</code></a> hooks will be called during this call.</p> |
|
|
768 | </dd> |
|
|
769 | <p></p> |
536 | <dt><strong><a name="item_destroy">$term->destroy</a></strong><br /> |
770 | <dt><strong><a name="item_destroy">$term->destroy</a></strong><br /> |
537 | </dt> |
771 | </dt> |
538 | <dd> |
772 | <dd> |
539 | Destroy the terminal object (close the window, free resources etc.). |
773 | Destroy the terminal object (close the window, free resources |
|
|
774 | etc.). Please note that rxvt will not exit as long as any event |
|
|
775 | watchers (timers, io watchers) are still active. |
540 | </dd> |
776 | </dd> |
541 | <p></p> |
777 | <p></p> |
542 | <dt><strong><a name="item_option">$isset = $term->option ($optval[, $set])</a></strong><br /> |
778 | <dt><strong><a name="item_option">$isset = $term->option ($optval[, $set])</a></strong><br /> |
543 | </dt> |
779 | </dt> |
544 | <dd> |
780 | <dd> |
… | |
… | |
600 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
836 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
601 | shade term_name title transparent transparent_all tripleclickwords |
837 | shade term_name title transparent transparent_all tripleclickwords |
602 | utmpInhibit visualBell</pre> |
838 | utmpInhibit visualBell</pre> |
603 | </dd> |
839 | </dd> |
604 | <p></p> |
840 | <p></p> |
|
|
841 | <dt><strong><a name="item_x_resource">$value = $term->x_resource ($pattern)</a></strong><br /> |
|
|
842 | </dt> |
|
|
843 | <dd> |
|
|
844 | Returns the X-Resource for the given pattern, excluding the program or |
|
|
845 | class name, i.e. <a href="#item_x_resource"><code>$term->x_resource ("boldFont")</code></a> should return the |
|
|
846 | same value as used by this instance of rxvt-unicode. Returns <code>undef</code> if no |
|
|
847 | resource with that pattern exists. |
|
|
848 | </dd> |
|
|
849 | <dd> |
|
|
850 | <p>This method should only be called during the <code>on_start</code> hook, as there is |
|
|
851 | only one resource database per display, and later invocations might return |
|
|
852 | the wrong resources.</p> |
|
|
853 | </dd> |
|
|
854 | <p></p> |
|
|
855 | <dt><strong><a name="item_parse_keysym">$success = $term->parse_keysym ($keysym_spec, $command_string)</a></strong><br /> |
|
|
856 | </dt> |
|
|
857 | <dd> |
|
|
858 | Adds a keymap translation exactly as specified via a resource. See the |
|
|
859 | <code>keysym</code> resource in the <code>rxvt(1)</code> manpage. |
|
|
860 | </dd> |
|
|
861 | <p></p> |
605 | <dt><strong><a name="item_rstyle">$rend = $term->rstyle ([$new_rstyle])</a></strong><br /> |
862 | <dt><strong><a name="item_rstyle">$rend = $term->rstyle ([$new_rstyle])</a></strong><br /> |
606 | </dt> |
863 | </dt> |
607 | <dd> |
864 | <dd> |
608 | Return and optionally change the current rendition. Text that is output by |
865 | Return and optionally change the current rendition. Text that is output by |
609 | the terminal application will use this style. |
866 | the terminal application will use this style. |
… | |
… | |
625 | <dd> |
882 | <dd> |
626 | Return the current values of the selection mark, begin or end positions, |
883 | Return the current values of the selection mark, begin or end positions, |
627 | and optionally set them to new values. |
884 | and optionally set them to new values. |
628 | </dd> |
885 | </dd> |
629 | <p></p> |
886 | <p></p> |
|
|
887 | <dt><strong><a name="item_selection_make">$term->selection_make ($eventtime[, $rectangular])</a></strong><br /> |
|
|
888 | </dt> |
|
|
889 | <dd> |
|
|
890 | Tries to make a selection as set by <a href="#item_selection_beg"><code>selection_beg</code></a> and |
|
|
891 | <a href="#item_selection_end"><code>selection_end</code></a>. If <code>$rectangular</code> is true (default: false), a |
|
|
892 | rectangular selection will be made. This is the prefered function to make |
|
|
893 | a selection. |
|
|
894 | </dd> |
|
|
895 | <p></p> |
630 | <dt><strong><a name="item_selection_grab">$success = $term->selection_grab ($eventtime)</a></strong><br /> |
896 | <dt><strong><a name="item_selection_grab">$success = $term->selection_grab ($eventtime)</a></strong><br /> |
631 | </dt> |
897 | </dt> |
632 | <dd> |
898 | <dd> |
633 | Try to request the primary selection from the server (for example, as set |
899 | Try to request the primary selection text from the server (for example, as |
634 | by the next method). |
900 | set by the next method). No visual feedback will be given. This function |
|
|
901 | is mostly useful from within <code>on_sel_grab</code> hooks. |
635 | </dd> |
902 | </dd> |
636 | <p></p> |
903 | <p></p> |
637 | <dt><strong>$oldtext = $term->selection ([$newtext])</strong><br /> |
904 | <dt><strong>$oldtext = $term->selection ([$newtext])</strong><br /> |
638 | </dt> |
905 | </dt> |
639 | <dd> |
906 | <dd> |
640 | Return the current selection text and optionally replace it by <code>$newtext</code>. |
907 | Return the current selection text and optionally replace it by <code>$newtext</code>. |
641 | </dd> |
908 | </dd> |
|
|
909 | <p></p> |
|
|
910 | <dt><strong><a name="item_overlay_simple">$term->overlay_simple ($x, $y, $text)</a></strong><br /> |
|
|
911 | </dt> |
642 | <dd> |
912 | <dd> |
643 | <p>#=item $term->overlay ($x, $y, $text) |
|
|
644 | # |
|
|
645 | #Create a simple multi-line overlay box. See the next method for details. |
913 | Create a simple multi-line overlay box. See the next method for details. |
646 | # |
|
|
647 | #=cut |
|
|
648 | # |
|
|
649 | #sub urxvt::term::scr_overlay { |
|
|
650 | # my ($self, $x, $y, $text) = @_; |
|
|
651 | # |
|
|
652 | # my @lines = split /\n/, $text; |
|
|
653 | # |
|
|
654 | # my $w = 0; |
|
|
655 | # for (map $self->strwidth ($_), @lines) { |
|
|
656 | # $w = $_ if $w < $_; |
|
|
657 | # } |
|
|
658 | # |
|
|
659 | # $self->scr_overlay_new ($x, $y, $w, scalar @lines); |
|
|
660 | # $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; |
|
|
661 | #}</p> |
|
|
662 | </dd> |
914 | </dd> |
663 | <p></p> |
915 | <p></p> |
664 | <dt><strong><a name="item_overlay">$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br /> |
916 | <dt><strong><a name="item_overlay">$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br /> |
665 | </dt> |
917 | </dt> |
666 | <dd> |
918 | <dd> |
… | |
… | |
727 | <p></p> |
979 | <p></p> |
728 | <dt><strong><a name="item_locale_decode">$string = $term->locale_decode ($octets)</a></strong><br /> |
980 | <dt><strong><a name="item_locale_decode">$string = $term->locale_decode ($octets)</a></strong><br /> |
729 | </dt> |
981 | </dt> |
730 | <dd> |
982 | <dd> |
731 | Convert the given locale-encoded octets into a perl string. |
983 | Convert the given locale-encoded octets into a perl string. |
|
|
984 | </dd> |
|
|
985 | <p></p> |
|
|
986 | <dt><strong><a name="item_scr_xor_span">$term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])</a></strong><br /> |
|
|
987 | </dt> |
|
|
988 | <dd> |
|
|
989 | XORs the rendition values in the given span with the provided value |
|
|
990 | (default: <code>RS_RVid</code>), which <em>MUST NOT</em> contain font styles. Useful in |
|
|
991 | refresh hooks to provide effects similar to the selection. |
|
|
992 | </dd> |
|
|
993 | <p></p> |
|
|
994 | <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 /> |
|
|
995 | </dt> |
|
|
996 | <dd> |
|
|
997 | Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing |
|
|
998 | whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults |
|
|
999 | to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines |
|
|
1000 | it instead. Both styles <em>MUST NOT</em> contain font styles. |
|
|
1001 | </dd> |
|
|
1002 | <p></p> |
|
|
1003 | <dt><strong><a name="item_scr_bell">$term->scr_bell</a></strong><br /> |
|
|
1004 | </dt> |
|
|
1005 | <dd> |
|
|
1006 | Ring the bell! |
732 | </dd> |
1007 | </dd> |
733 | <p></p> |
1008 | <p></p> |
734 | <dt><strong><a name="item_scr_add_lines">$term->scr_add_lines ($string)</a></strong><br /> |
1009 | <dt><strong><a name="item_scr_add_lines">$term->scr_add_lines ($string)</a></strong><br /> |
735 | </dt> |
1010 | </dt> |
736 | <dd> |
1011 | <dd> |
… | |
… | |
759 | Write the octets given in <code>$data</code> to the tty (i.e. as program input). To |
1034 | Write the octets given in <code>$data</code> to the tty (i.e. as program input). To |
760 | pass characters instead of octets, you should convert your strings first |
1035 | pass characters instead of octets, you should convert your strings first |
761 | to the locale-specific encoding using <a href="#item_locale_encode"><code>$term->locale_encode</code></a>. |
1036 | to the locale-specific encoding using <a href="#item_locale_encode"><code>$term->locale_encode</code></a>. |
762 | </dd> |
1037 | </dd> |
763 | <p></p> |
1038 | <p></p> |
|
|
1039 | <dt><strong><a name="item_pty_ev_events">$old_events = $term->pty_ev_events ([$new_events])</a></strong><br /> |
|
|
1040 | </dt> |
|
|
1041 | <dd> |
|
|
1042 | Replaces the event mask of the pty watcher by the given event mask. Can |
|
|
1043 | be used to suppress input and output handling to the pty/tty. See the |
|
|
1044 | description of <a href="#item_events"><code>urxvt::timer->events</code></a>. Make sure to always restore |
|
|
1045 | the previous value. |
|
|
1046 | </dd> |
|
|
1047 | <p></p> |
764 | <dt><strong><a name="item_parent">$windowid = $term->parent</a></strong><br /> |
1048 | <dt><strong><a name="item_parent">$windowid = $term->parent</a></strong><br /> |
765 | </dt> |
1049 | </dt> |
766 | <dd> |
1050 | <dd> |
767 | Return the window id of the toplevel window. |
1051 | Return the window id of the toplevel window. |
768 | </dd> |
1052 | </dd> |
… | |
… | |
771 | </dt> |
1055 | </dt> |
772 | <dd> |
1056 | <dd> |
773 | Return the window id of the terminal window. |
1057 | Return the window id of the terminal window. |
774 | </dd> |
1058 | </dd> |
775 | <p></p> |
1059 | <p></p> |
|
|
1060 | <dt><strong><a name="item_vt_emask_add">$term->vt_emask_add ($x_event_mask)</a></strong><br /> |
|
|
1061 | </dt> |
|
|
1062 | <dd> |
|
|
1063 | Adds the specified events to the vt event mask. Useful e.g. when you want |
|
|
1064 | to receive pointer events all the times: |
|
|
1065 | </dd> |
|
|
1066 | <dd> |
|
|
1067 | <pre> |
|
|
1068 | $term->vt_emask_add (urxvt::PointerMotionMask);</pre> |
|
|
1069 | </dd> |
|
|
1070 | <p></p> |
776 | <dt><strong><a name="item_width">$window_width = $term->width</a></strong><br /> |
1071 | <dt><strong><a name="item_width">$window_width = $term->width</a></strong><br /> |
777 | </dt> |
1072 | </dt> |
778 | <dt><strong><a name="item_height">$window_height = $term->height</a></strong><br /> |
1073 | <dt><strong><a name="item_height">$window_height = $term->height</a></strong><br /> |
779 | </dt> |
1074 | </dt> |
780 | <dt><strong><a name="item_fwidth">$font_width = $term->fwidth</a></strong><br /> |
1075 | <dt><strong><a name="item_fwidth">$font_width = $term->fwidth</a></strong><br /> |
… | |
… | |
793 | </dt> |
1088 | </dt> |
794 | <dt><strong><a name="item_savelines">$max_scrollback = $term->saveLines</a></strong><br /> |
1089 | <dt><strong><a name="item_savelines">$max_scrollback = $term->saveLines</a></strong><br /> |
795 | </dt> |
1090 | </dt> |
796 | <dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term->total_rows</a></strong><br /> |
1091 | <dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term->total_rows</a></strong><br /> |
797 | </dt> |
1092 | </dt> |
798 | <dt><strong><a name="item_nsaved">$lines_in_scrollback = $term->nsaved</a></strong><br /> |
1093 | <dt><strong><a name="item_top_row">$topmost_scrollback_row = $term->top_row</a></strong><br /> |
799 | </dt> |
1094 | </dt> |
800 | <dd> |
1095 | <dd> |
801 | Return various integers describing terminal characteristics. |
1096 | Return various integers describing terminal characteristics. |
|
|
1097 | </dd> |
|
|
1098 | <p></p> |
|
|
1099 | <dt><strong><a name="item_display_id">$x_display = $term->display_id</a></strong><br /> |
|
|
1100 | </dt> |
|
|
1101 | <dd> |
|
|
1102 | Return the DISPLAY used by rxvt-unicode. |
|
|
1103 | </dd> |
|
|
1104 | <p></p> |
|
|
1105 | <dt><strong><a name="item_locale">$lc_ctype = $term->locale</a></strong><br /> |
|
|
1106 | </dt> |
|
|
1107 | <dd> |
|
|
1108 | Returns the LC_CTYPE category string used by this rxvt-unicode. |
|
|
1109 | </dd> |
|
|
1110 | <p></p> |
|
|
1111 | <dt><strong><a name="item_env">$env = $term->env</a></strong><br /> |
|
|
1112 | </dt> |
|
|
1113 | <dd> |
|
|
1114 | Returns a copy of the environment in effect for the terminal as a hashref |
|
|
1115 | similar to <code>\%ENV</code>. |
802 | </dd> |
1116 | </dd> |
803 | <p></p> |
1117 | <p></p> |
804 | <dt><strong><a name="item_modlevel3mask">$modifiermask = $term->ModLevel3Mask</a></strong><br /> |
1118 | <dt><strong><a name="item_modlevel3mask">$modifiermask = $term->ModLevel3Mask</a></strong><br /> |
805 | </dt> |
1119 | </dt> |
806 | <dt><strong><a name="item_modmetamask">$modifiermask = $term->ModMetaMask</a></strong><br /> |
1120 | <dt><strong><a name="item_modmetamask">$modifiermask = $term->ModMetaMask</a></strong><br /> |
… | |
… | |
813 | </dd> |
1127 | </dd> |
814 | <p></p> |
1128 | <p></p> |
815 | <dt><strong><a name="item_view_start">$view_start = $term->view_start ([$newvalue])</a></strong><br /> |
1129 | <dt><strong><a name="item_view_start">$view_start = $term->view_start ([$newvalue])</a></strong><br /> |
816 | </dt> |
1130 | </dt> |
817 | <dd> |
1131 | <dd> |
818 | Returns the negative row number of the topmost line. Minimum value is |
1132 | Returns the row number of the topmost displayed line. Maximum value is |
819 | <code>0</code>, which displays the normal terminal contents. Larger values scroll |
1133 | <code>0</code>, which displays the normal terminal contents. Lower values scroll |
820 | this many lines into the scrollback buffer. |
1134 | this many lines into the scrollback buffer. |
821 | </dd> |
1135 | </dd> |
822 | <p></p> |
1136 | <p></p> |
823 | <dt><strong><a name="item_want_refresh">$term->want_refresh</a></strong><br /> |
1137 | <dt><strong><a name="item_want_refresh">$term->want_refresh</a></strong><br /> |
824 | </dt> |
1138 | </dt> |
… | |
… | |
835 | </dt> |
1149 | </dt> |
836 | <dd> |
1150 | <dd> |
837 | Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code> |
1151 | Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code> |
838 | is the topmost terminal line, row <code>$term->$ncol-1</code> is the bottommost |
1152 | is the topmost terminal line, row <code>$term->$ncol-1</code> is the bottommost |
839 | terminal line. The scrollback buffer starts at line <code>-1</code> and extends to |
1153 | terminal line. The scrollback buffer starts at line <code>-1</code> and extends to |
840 | line <a href="#item_nsaved"><code>-$term->nsaved</code></a>. Nothing will be returned if a nonexistent line |
1154 | line <code>-$term->nsaved</code>. Nothing will be returned if a nonexistent line |
841 | is requested. |
1155 | is requested. |
842 | </dd> |
1156 | </dd> |
843 | <dd> |
1157 | <dd> |
844 | <p>If <code>$new_text</code> is specified, it will replace characters in the current |
1158 | <p>If <code>$new_text</code> is specified, it will replace characters in the current |
845 | line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful |
1159 | line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful |
… | |
… | |
930 | <p></p> |
1244 | <p></p> |
931 | <dt><strong><a name="item_offset_of">$offset = $line->offset_of ($row, $col)</a></strong><br /> |
1245 | <dt><strong><a name="item_offset_of">$offset = $line->offset_of ($row, $col)</a></strong><br /> |
932 | </dt> |
1246 | </dt> |
933 | <dd> |
1247 | <dd> |
934 | Returns the character offset of the given row|col pair within the logical |
1248 | Returns the character offset of the given row|col pair within the logical |
935 | line. |
1249 | line. Works for rows outside the line, too, and returns corresponding |
|
|
1250 | offsets outside the string. |
936 | </dd> |
1251 | </dd> |
937 | <p></p> |
1252 | <p></p> |
938 | <dt><strong><a name="item_coord_of">($row, $col) = $line->coord_of ($offset)</a></strong><br /> |
1253 | <dt><strong><a name="item_coord_of">($row, $col) = $line->coord_of ($offset)</a></strong><br /> |
939 | </dt> |
1254 | </dt> |
940 | <dd> |
1255 | <dd> |
… | |
… | |
997 | </dd> |
1312 | </dd> |
998 | <p></p></dl> |
1313 | <p></p></dl> |
999 | <p> |
1314 | <p> |
1000 | </p> |
1315 | </p> |
1001 | <h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> |
1316 | <h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> |
|
|
1317 | <dl> |
|
|
1318 | <dt><strong><a name="item_add_title">$popup->add_title ($title)</a></strong><br /> |
|
|
1319 | </dt> |
|
|
1320 | <dd> |
|
|
1321 | Adds a non-clickable title to the popup. |
|
|
1322 | </dd> |
|
|
1323 | <p></p> |
|
|
1324 | <dt><strong><a name="item_add_separator">$popup->add_separator ([$sepchr])</a></strong><br /> |
|
|
1325 | </dt> |
|
|
1326 | <dd> |
|
|
1327 | Creates a separator, optionally using the character given as <code>$sepchr</code>. |
|
|
1328 | </dd> |
|
|
1329 | <p></p> |
|
|
1330 | <dt><strong><a name="item_add_button">$popup->add_button ($text, $cb)</a></strong><br /> |
|
|
1331 | </dt> |
|
|
1332 | <dd> |
|
|
1333 | Adds a clickable button to the popup. <code>$cb</code> is called whenever it is |
|
|
1334 | selected. |
|
|
1335 | </dd> |
|
|
1336 | <p></p> |
|
|
1337 | <dt><strong><a name="item_add_toggle">$popup->add_toggle ($text, $cb, $initial_value)</a></strong><br /> |
|
|
1338 | </dt> |
|
|
1339 | <dd> |
|
|
1340 | Adds a toggle/checkbox item to the popup. Teh callback gets called |
|
|
1341 | whenever it gets toggled, with a boolean indicating its value as its first |
|
|
1342 | argument. |
|
|
1343 | </dd> |
|
|
1344 | <p></p> |
|
|
1345 | <dt><strong>$popup->show</strong><br /> |
|
|
1346 | </dt> |
|
|
1347 | <dd> |
|
|
1348 | Displays the popup (which is initially hidden). |
|
|
1349 | </dd> |
|
|
1350 | <p></p></dl> |
1002 | <p> |
1351 | <p> |
1003 | </p> |
1352 | </p> |
1004 | <h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> |
1353 | <h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> |
1005 | <p>This class implements timer watchers/events. Time is represented as a |
1354 | <p>This class implements timer watchers/events. Time is represented as a |
1006 | fractional number of seconds since the epoch. Example:</p> |
1355 | fractional number of seconds since the epoch. Example:</p> |
… | |
… | |
1072 | <pre> |
1421 | <pre> |
1073 | $term->{socket} = ... |
1422 | $term->{socket} = ... |
1074 | $term->{iow} = urxvt::iow |
1423 | $term->{iow} = urxvt::iow |
1075 | ->new |
1424 | ->new |
1076 | ->fd (fileno $term->{socket}) |
1425 | ->fd (fileno $term->{socket}) |
1077 | ->events (1) # wait for read data |
1426 | ->events (urxvt::EVENT_READ) |
1078 | ->start |
1427 | ->start |
1079 | ->cb (sub { |
1428 | ->cb (sub { |
1080 | my ($iow, $revents) = @_; |
1429 | my ($iow, $revents) = @_; |
1081 | # $revents must be 1 here, no need to check |
1430 | # $revents must be 1 here, no need to check |
1082 | sysread $term->{socket}, my $buf, 8192 |
1431 | sysread $term->{socket}, my $buf, 8192 |
… | |
… | |
1103 | </dd> |
1452 | </dd> |
1104 | <p></p> |
1453 | <p></p> |
1105 | <dt><strong><a name="item_events">$iow = $iow->events ($eventmask)</a></strong><br /> |
1454 | <dt><strong><a name="item_events">$iow = $iow->events ($eventmask)</a></strong><br /> |
1106 | </dt> |
1455 | </dt> |
1107 | <dd> |
1456 | <dd> |
1108 | Set the event mask to watch. Bit #0 (value <code>1</code>) enables watching for read |
1457 | Set the event mask to watch. The only allowed values are |
1109 | data, Bit #1 (value <code>2</code>) enables watching for write data. |
1458 | <code>urxvt::EVENT_READ</code> and <code>urxvt::EVENT_WRITE</code>, which might be ORed |
|
|
1459 | together, or <code>urxvt::EVENT_NONE</code>. |
1110 | </dd> |
1460 | </dd> |
1111 | <p></p> |
1461 | <p></p> |
1112 | <dt><strong>$iow = $iow->start</strong><br /> |
1462 | <dt><strong>$iow = $iow->start</strong><br /> |
1113 | </dt> |
1463 | </dt> |
1114 | <dd> |
1464 | <dd> |
… | |
… | |
1133 | <dl> |
1483 | <dl> |
1134 | <dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br /> |
1484 | <dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br /> |
1135 | </dt> |
1485 | </dt> |
1136 | <dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">>= 3 - script loading and management</a></strong><br /> |
1486 | <dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">>= 3 - script loading and management</a></strong><br /> |
1137 | </dt> |
1487 | </dt> |
1138 | <dt><strong><a name="item__3e_3d10__2d_all_events_received">>=10 - all events received</a></strong><br /> |
1488 | <dt><strong><a name="item__3e_3d10__2d_all_called_hooks">>=10 - all called hooks</a></strong><br /> |
|
|
1489 | </dt> |
|
|
1490 | <dt><strong><a name="item__3e_3d11__2d_hook_reutrn_values">>=11 - hook reutrn values</a></strong><br /> |
1139 | </dt> |
1491 | </dt> |
1140 | </dl> |
1492 | </dl> |
1141 | <p> |
1493 | <p> |
1142 | </p> |
1494 | </p> |
1143 | <hr /> |
1495 | <hr /> |