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