… | |
… | |
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 | <ul> |
18 | <ul> |
19 | |
19 | |
|
|
20 | <li><a href="#prepackaged_extensions">Prepackaged Extensions</a></li> |
20 | <li><a href="#general_api_considerations">General API Considerations</a></li> |
21 | <li><a href="#general_api_considerations">General API Considerations</a></li> |
21 | <li><a href="#hooks">Hooks</a></li> |
22 | <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> |
22 | <li><a href="#functions_in_the_urxvt_package">Functions 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> |
|
|
25 | <li><a href="#rendition">RENDITION</a></li> |
23 | <li><a href="#the_urxvt__term_class">The <code>urxvt::term</code> Class</a></li> |
26 | <li><a href="#the_urxvt__term_class">The <code>urxvt::term</code> Class</a></li> |
|
|
27 | <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> |
28 | <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> |
29 | <li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li> |
26 | </ul> |
30 | </ul> |
27 | |
31 | |
28 | <li><a href="#environment">ENVIRONMENT</a></li> |
32 | <li><a href="#environment">ENVIRONMENT</a></li> |
… | |
… | |
36 | <!-- INDEX END --> |
40 | <!-- INDEX END --> |
37 | |
41 | |
38 | <hr /> |
42 | <hr /> |
39 | <p> |
43 | <p> |
40 | </p> |
44 | </p> |
|
|
45 | <hr /> |
41 | <h1><a name="name">NAME</a></h1> |
46 | <h1><a name="name">NAME</a></h1> |
42 | <p>rxvtperl - rxvt-unicode's embedded perl interpreter</p> |
47 | <p>rxvtperl - rxvt-unicode's embedded perl interpreter</p> |
43 | <p> |
48 | <p> |
44 | </p> |
49 | </p> |
45 | <hr /> |
50 | <hr /> |
… | |
… | |
57 | rxvt --perl-lib $HOME -pe grab_test</pre> |
62 | rxvt --perl-lib $HOME -pe grab_test</pre> |
58 | <p> |
63 | <p> |
59 | </p> |
64 | </p> |
60 | <hr /> |
65 | <hr /> |
61 | <h1><a name="description">DESCRIPTION</a></h1> |
66 | <h1><a name="description">DESCRIPTION</a></h1> |
62 | <p>Everytime a terminal object gets created, scripts specified via the |
67 | <p>Everytime a terminal object gets created, extension scripts specified via |
63 | <code>perl</code> resource are loaded and associated with it.</p> |
68 | the <code>perl</code> resource are loaded and associated with it.</p> |
64 | <p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and |
69 | <p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and |
65 | thus must be encoded as UTF-8.</p> |
70 | thus must be encoded as UTF-8.</p> |
66 | <p>Each script will only ever be loaded once, even in rxvtd, where |
71 | <p>Each script will only ever be loaded once, even in rxvtd, where |
67 | scripts will be shared (But not enabled) for all terminals.</p> |
72 | scripts will be shared (but not enabled) for all terminals.</p> |
|
|
73 | <p> |
|
|
74 | </p> |
|
|
75 | <h2><a name="prepackaged_extensions">Prepackaged Extensions</a></h2> |
|
|
76 | <p>This section describes the extensiosn delivered with this version. You can |
|
|
77 | find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> |
|
|
78 | <p>You can activate them like this:</p> |
|
|
79 | <pre> |
|
|
80 | rxvt -pe <extensionname></pre> |
|
|
81 | <dl> |
|
|
82 | <dt><strong><a name="item_selection">selection</a></strong><br /> |
|
|
83 | </dt> |
|
|
84 | <dd> |
|
|
85 | Intelligent selection. This extension tries to be more intelligent when |
|
|
86 | the user extends selections (double-click). Right now, it tries to select |
|
|
87 | urls and complete shell-quoted arguments, which is very convenient, too, |
|
|
88 | if your <em>ls</em> supports <code>--quoting-style=shell</code>. |
|
|
89 | </dd> |
|
|
90 | <dd> |
|
|
91 | <p>It also offers the following bindable event:</p> |
|
|
92 | </dd> |
|
|
93 | <dl> |
|
|
94 | <dt><strong><a name="item_rot13">rot13</a></strong><br /> |
|
|
95 | </dt> |
|
|
96 | <dd> |
|
|
97 | Rot-13 the selection when activated. Used via keyboard trigger: |
|
|
98 | </dd> |
|
|
99 | <dd> |
|
|
100 | <pre> |
|
|
101 | URxvt.keysym.C-M-r: perl:selection:rot13</pre> |
|
|
102 | </dd> |
|
|
103 | <p></p></dl> |
|
|
104 | <dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> |
|
|
105 | </dt> |
|
|
106 | <dd> |
|
|
107 | Displays a digital clock using the built-in overlay. |
|
|
108 | </dd> |
|
|
109 | <p></p> |
|
|
110 | <dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> |
|
|
111 | </dt> |
|
|
112 | <dd> |
|
|
113 | Uses per-line display filtering (<code>on_line_update</code>) to underline urls. |
|
|
114 | </dd> |
|
|
115 | <p></p> |
|
|
116 | <dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br /> |
|
|
117 | </dt> |
|
|
118 | <dd> |
|
|
119 | A not very useful example of filtering all text output to the terminal, |
|
|
120 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
|
|
121 | similar-looking ascii character. |
|
|
122 | </dd> |
|
|
123 | <p></p> |
|
|
124 | <dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> |
|
|
125 | </dt> |
|
|
126 | <dd> |
|
|
127 | Displays a very simple digital clock in the upper right corner of the |
|
|
128 | window. Illustrates overwriting the refresh callbacks to create your own |
|
|
129 | overlays or changes. |
|
|
130 | </dd> |
|
|
131 | <p></p></dl> |
68 | <p> |
132 | <p> |
69 | </p> |
133 | </p> |
70 | <h2><a name="general_api_considerations">General API Considerations</a></h2> |
134 | <h2><a name="general_api_considerations">General API Considerations</a></h2> |
71 | <p>All objects (such as terminals, time watchers etc.) are typical |
135 | <p>All objects (such as terminals, time watchers etc.) are typical |
72 | reference-to-hash objects. The hash can be used to store anything you |
136 | reference-to-hash objects. The hash can be used to store anything you |
73 | like. All members starting with an underscore (such as <code>_ptr</code> or |
137 | like. All members starting with an underscore (such as <code>_ptr</code> or |
74 | <code>_hook</code>) are reserved for internal uses and must not be accessed or |
138 | <code>_hook</code>) are reserved for internal uses and <strong>MUST NOT</strong> be accessed or |
75 | modified).</p> |
139 | modified).</p> |
76 | <p>When objects are destroyed on the C++ side, the perl object hashes are |
140 | <p>When objects are destroyed on the C++ side, the perl object hashes are |
77 | emptied, so its best to store related objects such as time watchers and |
141 | emptied, so its best to store related objects such as time watchers and |
78 | the like inside the terminal object so they get destroyed as soon as the |
142 | the like inside the terminal object so they get destroyed as soon as the |
79 | terminal is destroyed.</p> |
143 | terminal is destroyed.</p> |
|
|
144 | <p>Argument names also often indicate the type of a parameter. Here are some |
|
|
145 | hints on what they mean:</p> |
|
|
146 | <dl> |
|
|
147 | <dt><strong><a name="item__24text">$text</a></strong><br /> |
|
|
148 | </dt> |
|
|
149 | <dd> |
|
|
150 | Rxvt-unicodes special way of encoding text, where one ``unicode'' character |
|
|
151 | always represents one screen cell. See <em>row_t</em> for a discussion of this format. |
|
|
152 | </dd> |
|
|
153 | <p></p> |
|
|
154 | <dt><strong><a name="item__24string">$string</a></strong><br /> |
|
|
155 | </dt> |
|
|
156 | <dd> |
|
|
157 | A perl text string, with an emphasis on <em>text</em>. It can store all unicode |
|
|
158 | characters and is to be distinguished with text encoded in a specific |
|
|
159 | encoding (often locale-specific) and binary data. |
|
|
160 | </dd> |
|
|
161 | <p></p> |
|
|
162 | <dt><strong><a name="item__24octets">$octets</a></strong><br /> |
|
|
163 | </dt> |
|
|
164 | <dd> |
|
|
165 | Either binary data or - more common - a text string encoded in a |
|
|
166 | locale-specific way. |
|
|
167 | </dd> |
|
|
168 | <p></p></dl> |
80 | <p> |
169 | <p> |
81 | </p> |
170 | </p> |
82 | <h2><a name="hooks">Hooks</a></h2> |
171 | <h2><a name="hooks">Hooks</a></h2> |
83 | <p>The following subroutines can be declared in loaded scripts, and will be called |
172 | <p>The following subroutines can be declared in extension files, and will be |
84 | whenever the relevant event happens.</p> |
173 | called whenever the relevant event happens.</p> |
|
|
174 | <p>The first argument passed to them is an object private to each terminal |
|
|
175 | and extension package. You can call all <code>urxvt::term</code> methods on it, but |
|
|
176 | its not a real <code>urxvt::term</code> object. Instead, the real <code>urxvt::term</code> |
|
|
177 | object that is shared between all packages is stored in the <code>term</code> |
|
|
178 | member. It is, however, blessed intot he package of the extension script, |
|
|
179 | so for all practical purposes you can treat an extension script as a class.</p> |
85 | <p>All of them must return a boolean value. If it is true, then the event |
180 | <p>All of them must return a boolean value. If it is true, then the event |
86 | counts as being <em>consumed</em>, and the invocation of other hooks is skipped, |
181 | counts as being <em>consumed</em>, and the invocation of other hooks is skipped, |
87 | and the relevant action might not be carried out by the C++ code.</p> |
182 | and the relevant action might not be carried out by the C++ code.</p> |
88 | <p>When in doubt, return a false value (preferably <code>()</code>).</p> |
183 | <p>When in doubt, return a false value (preferably <code>()</code>).</p> |
89 | <dl> |
184 | <dl> |
90 | <dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> |
185 | <dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> |
91 | </dt> |
186 | </dt> |
92 | <dd> |
187 | <dd> |
93 | Called after a new terminal object has been initialized, but before |
188 | Called after a new terminal object has been initialized, but before |
94 | windows are created or the command gets run. |
189 | windows are created or the command gets run. Most methods are unsafe to |
|
|
190 | call or deliver senseless data, as terminal size and other characteristics |
|
|
191 | have not yet been determined. You can safely query and change resources, |
|
|
192 | though. |
95 | </dd> |
193 | </dd> |
96 | <p></p> |
194 | <p></p> |
97 | <dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> |
195 | <dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> |
98 | </dt> |
196 | </dt> |
99 | <dd> |
197 | <dd> |
… | |
… | |
130 | </dd> |
228 | </dd> |
131 | <dd> |
229 | <dd> |
132 | <p>Returning a true value aborts selection grabbing. It will still be hilighted.</p> |
230 | <p>Returning a true value aborts selection grabbing. It will still be hilighted.</p> |
133 | </dd> |
231 | </dd> |
134 | <p></p> |
232 | <p></p> |
135 | <dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> |
233 | <dt><strong><a name="item_on_sel_extend__24term">on_sel_extend $term</a></strong><br /> |
136 | </dt> |
234 | </dt> |
137 | <dd> |
|
|
138 | Called whenever the window gets the keyboard focus, before urxvt does |
|
|
139 | focus in processing. |
|
|
140 | </dd> |
235 | <dd> |
141 | <p></p> |
236 | Called whenever the user tries to extend the selection (e.g. with a double |
142 | <dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong><br /> |
237 | click) and is either supposed to return false (normal operation), or |
143 | </dt> |
238 | should extend the selection itelf and return true to suppress the built-in |
|
|
239 | processing. |
144 | <dd> |
240 | </dd> |
145 | Called wheneever the window loses keyboard focus, before urxvt does focus |
241 | <dd> |
146 | out processing. |
242 | <p>See the <em>selection</em> example extension.</p> |
147 | </dd> |
243 | </dd> |
148 | <p></p> |
244 | <p></p> |
149 | <dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong><br /> |
245 | <dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong><br /> |
150 | </dt> |
246 | </dt> |
151 | <dd> |
247 | <dd> |
… | |
… | |
169 | <p></p> |
265 | <p></p> |
170 | <dt><strong><a name="item_on_tty_activity__24term__2anyi_2a">on_tty_activity $term *NYI*</a></strong><br /> |
266 | <dt><strong><a name="item_on_tty_activity__24term__2anyi_2a">on_tty_activity $term *NYI*</a></strong><br /> |
171 | </dt> |
267 | </dt> |
172 | <dd> |
268 | <dd> |
173 | Called whenever the <code>program(s)</code> running in the urxvt window send output. |
269 | Called whenever the <code>program(s)</code> running in the urxvt window send output. |
|
|
270 | </dd> |
|
|
271 | <p></p> |
|
|
272 | <dt><strong><a name="item_on_osc_seq__24term_2c__24string">on_osc_seq $term, $string</a></strong><br /> |
|
|
273 | </dt> |
|
|
274 | <dd> |
|
|
275 | Called whenever the <strong>ESC ] 777 ; string ST</strong> command sequence (OSC = |
|
|
276 | operating system command) is processed. Cursor position and other state |
|
|
277 | information is up-to-date when this happens. For interoperability, the |
|
|
278 | string should start with the extension name and a colon, to distinguish |
|
|
279 | it from commands for other extensions, and this might be enforced in the |
|
|
280 | future. |
|
|
281 | </dd> |
|
|
282 | <dd> |
|
|
283 | <p>Be careful not ever to trust (in a security sense) the data you receive, |
|
|
284 | as its source can not easily be controleld (e-mail content, messages from |
|
|
285 | other users on the same system etc.).</p> |
|
|
286 | </dd> |
|
|
287 | <p></p> |
|
|
288 | <dt><strong><a name="item_on_add_lines__24term_2c__24string">on_add_lines $term, $string</a></strong><br /> |
|
|
289 | </dt> |
|
|
290 | <dd> |
|
|
291 | Called whenever text is about to be output, with the text as argument. You |
|
|
292 | can filter/change and output the text yourself by returning a true value |
|
|
293 | and calling <a href="#item_scr_add_lines"><code>$term->scr_add_lines</code></a> yourself. Please note that this |
|
|
294 | might be very slow, however, as your hook is called for <strong>all</strong> text being |
|
|
295 | output. |
|
|
296 | </dd> |
|
|
297 | <p></p> |
|
|
298 | <dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong><br /> |
|
|
299 | </dt> |
|
|
300 | <dd> |
|
|
301 | Called whenever a line was updated or changed. Can be used to filter |
|
|
302 | screen output (e.g. underline urls or other useless stuff). Only lines |
|
|
303 | that are being shown will be filtered, and, due to performance reasons, |
|
|
304 | not always immediately. |
|
|
305 | </dd> |
|
|
306 | <dd> |
|
|
307 | <p>The row number is always the topmost row of the line if the line spans |
|
|
308 | multiple rows.</p> |
|
|
309 | </dd> |
|
|
310 | <dd> |
|
|
311 | <p>Please note that, if you change the line, then the hook might get called |
|
|
312 | later with the already-modified line (e.g. if unrelated parts change), so |
|
|
313 | you cannot just toggle rendition bits, but only set them.</p> |
174 | </dd> |
314 | </dd> |
175 | <p></p> |
315 | <p></p> |
176 | <dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong><br /> |
316 | <dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong><br /> |
177 | </dt> |
317 | </dt> |
178 | <dd> |
318 | <dd> |
… | |
… | |
193 | <dd> |
333 | <dd> |
194 | Called whenever the user presses a key combination that has a |
334 | Called whenever the user presses a key combination that has a |
195 | <code>perl:string</code> action bound to it (see description of the <strong>keysym</strong> |
335 | <code>perl:string</code> action bound to it (see description of the <strong>keysym</strong> |
196 | resource in the <code>rxvt(1)</code> manpage). |
336 | resource in the <code>rxvt(1)</code> manpage). |
197 | </dd> |
337 | </dd> |
|
|
338 | <p></p> |
|
|
339 | <dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> |
|
|
340 | </dt> |
|
|
341 | <dd> |
|
|
342 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
|
|
343 | does focus in processing. |
|
|
344 | </dd> |
|
|
345 | <p></p> |
|
|
346 | <dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong><br /> |
|
|
347 | </dt> |
|
|
348 | <dd> |
|
|
349 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
|
|
350 | focus out processing. |
|
|
351 | </dd> |
|
|
352 | <p></p> |
|
|
353 | <dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24octets">on_key_press $term, $event, $octets</a></strong><br /> |
|
|
354 | </dt> |
|
|
355 | <dt><strong><a name="item_on_key_release__24term_2c__24event">on_key_release $term, $event</a></strong><br /> |
|
|
356 | </dt> |
|
|
357 | <dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br /> |
|
|
358 | </dt> |
|
|
359 | <dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br /> |
|
|
360 | </dt> |
|
|
361 | <dt><strong><a name="item_on_motion_notify__24term_2c__24event">on_motion_notify $term, $event</a></strong><br /> |
|
|
362 | </dt> |
|
|
363 | <dt><strong><a name="item_on_map_notify__24term_2c__24event">on_map_notify $term, $event</a></strong><br /> |
|
|
364 | </dt> |
|
|
365 | <dt><strong><a name="item_on_unmap_notify__24term_2c__24event">on_unmap_notify $term, $event</a></strong><br /> |
|
|
366 | </dt> |
|
|
367 | <dd> |
|
|
368 | Called whenever the corresponding X event is received for the terminal If |
|
|
369 | the hook returns true, then the even will be ignored by rxvt-unicode. |
|
|
370 | </dd> |
|
|
371 | <dd> |
|
|
372 | <p>The event is a hash with most values as named by Xlib (see the XEvent |
|
|
373 | manpage), with the additional members <code>row</code> and <code>col</code>, which are the row |
|
|
374 | and column under the mouse cursor.</p> |
|
|
375 | </dd> |
|
|
376 | <dd> |
|
|
377 | <p><code>on_key_press</code> additionally receives the string rxvt-unicode would |
|
|
378 | output, if any, in locale-specific encoding.</p> |
|
|
379 | </dd> |
|
|
380 | <dd> |
|
|
381 | <p>subwindow.</p> |
|
|
382 | </dd> |
|
|
383 | <p></p></dl> |
|
|
384 | <p> |
|
|
385 | </p> |
|
|
386 | <h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> |
|
|
387 | <dl> |
|
|
388 | <dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br /> |
|
|
389 | </dt> |
|
|
390 | <dd> |
|
|
391 | The current terminal. This variable stores the current <code>urxvt::term</code> |
|
|
392 | object, whenever a callback/hook is executing. |
|
|
393 | </dd> |
198 | <p></p></dl> |
394 | <p></p></dl> |
199 | <p> |
395 | <p> |
200 | </p> |
396 | </p> |
201 | <h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> |
397 | <h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> |
202 | <dl> |
398 | <dl> |
|
|
399 | <dt><strong><a name="item__24term__3d_new_urxvt__5barg_2e_2e_2e_5d">$term = new urxvt [arg...]</a></strong><br /> |
|
|
400 | </dt> |
|
|
401 | <dd> |
|
|
402 | Creates a new terminal, very similar as if you had started it with |
|
|
403 | <code>system $binfile, arg...</code>. Croaks (and probably outputs an error message) |
|
|
404 | if the new instance couldn't be created. Returns <code>undef</code> if the new |
|
|
405 | instance didn't initialise perl, and the terminal object otherwise. The |
|
|
406 | <code>init</code> and <a href="#item_start"><code>start</code></a> hooks will be called during the call. |
|
|
407 | </dd> |
|
|
408 | <p></p> |
203 | <dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br /> |
409 | <dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br /> |
204 | </dt> |
410 | </dt> |
205 | <dd> |
411 | <dd> |
206 | Fatally aborts execution with the given error message. Avoid at all |
412 | Fatally aborts execution with the given error message. Avoid at all |
207 | costs! The only time this is acceptable is when the terminal process |
413 | costs! The only time this is acceptable is when the terminal process |
… | |
… | |
223 | <dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> |
429 | <dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> |
224 | </dt> |
430 | </dt> |
225 | <dd> |
431 | <dd> |
226 | Returns the ``current time'' (as per the event loop). |
432 | Returns the ``current time'' (as per the event loop). |
227 | </dd> |
433 | </dd> |
|
|
434 | <p></p> |
|
|
435 | <dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br /> |
|
|
436 | </dt> |
|
|
437 | <dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
|
|
438 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
|
|
439 | Button4Mask, Button5Mask, AnyModifier</a></strong><br /> |
|
|
440 | </dt> |
|
|
441 | <dd> |
|
|
442 | Various constants for use in X events. |
|
|
443 | </dd> |
|
|
444 | <p></p></dl> |
|
|
445 | <p> |
|
|
446 | </p> |
|
|
447 | <h2><a name="rendition">RENDITION</a></h2> |
|
|
448 | <p>Rendition bitsets contain information about colour, font, font styles and |
|
|
449 | similar information for each screen cell.</p> |
|
|
450 | <p>The following ``macros'' deal with changes in rendition sets. You should |
|
|
451 | never just create a bitset, you should always modify an existing one, |
|
|
452 | as they contain important information required for correct operation of |
|
|
453 | rxvt-unicode.</p> |
|
|
454 | <dl> |
|
|
455 | <dt><strong><a name="item__24rend__3d_urxvt_3a_3adefault_rstyle">$rend = urxvt::DEFAULT_RSTYLE</a></strong><br /> |
|
|
456 | </dt> |
|
|
457 | <dd> |
|
|
458 | Returns the default rendition, as used when the terminal is starting up or |
|
|
459 | being reset. Useful as a base to start when creating renditions. |
|
|
460 | </dd> |
|
|
461 | <p></p> |
|
|
462 | <dt><strong><a name="item__24rend__3d_urxvt_3a_3aoverlay_rstyle">$rend = urxvt::OVERLAY_RSTYLE</a></strong><br /> |
|
|
463 | </dt> |
|
|
464 | <dd> |
|
|
465 | Return the rendition mask used for overlays by default. |
|
|
466 | </dd> |
|
|
467 | <p></p> |
|
|
468 | <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 /> |
|
|
469 | </dt> |
|
|
470 | <dd> |
|
|
471 | Return the bit that enabled bold, italic, blink, reverse-video and |
|
|
472 | underline, respectively. To enable such a style, just logically OR it into |
|
|
473 | the bitset. |
|
|
474 | </dd> |
|
|
475 | <p></p> |
|
|
476 | <dt><strong><a name="item__24foreground__3d_urxvt_3a_3aget_basefg__24rend">$foreground = urxvt::GET_BASEFG $rend</a></strong><br /> |
|
|
477 | </dt> |
|
|
478 | <dt><strong><a name="item__24background__3d_urxvt_3a_3aget_basebg__24rend">$background = urxvt::GET_BASEBG $rend</a></strong><br /> |
|
|
479 | </dt> |
|
|
480 | <dd> |
|
|
481 | Return the foreground/background colour index, respectively. |
|
|
482 | </dd> |
|
|
483 | <p></p> |
|
|
484 | <dt><strong><a name="item_set_fgcolor">$rend = urxvt::SET_FGCOLOR ($rend, $new_colour)</a></strong><br /> |
|
|
485 | </dt> |
|
|
486 | <dt><strong><a name="item_set_bgcolor">$rend = urxvt::SET_BGCOLOR ($rend, $new_colour)</a></strong><br /> |
|
|
487 | </dt> |
|
|
488 | <dd> |
|
|
489 | Replace the foreground/background colour in the rendition mask with the |
|
|
490 | specified one. |
|
|
491 | </dd> |
|
|
492 | <p></p> |
|
|
493 | <dt><strong><a name="item_get_custom">$value = urxvt::GET_CUSTOM ($rend)</a></strong><br /> |
|
|
494 | </dt> |
|
|
495 | <dd> |
|
|
496 | Return the ``custom'' value: Every rendition has 5 bits for use by |
|
|
497 | extensions. They can be set and changed as you like and are initially |
|
|
498 | zero. |
|
|
499 | </dd> |
|
|
500 | <p></p> |
|
|
501 | <dt><strong><a name="item_set_custom">$rend = urxvt::SET_CUSTOM ($rend, $new_value)</a></strong><br /> |
|
|
502 | </dt> |
|
|
503 | <dd> |
|
|
504 | Change the custom value. |
|
|
505 | </dd> |
228 | <p></p></dl> |
506 | <p></p></dl> |
229 | <p> |
507 | <p> |
230 | </p> |
508 | </p> |
231 | <h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> |
509 | <h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> |
232 | <dl> |
510 | <dl> |
|
|
511 | <dt><strong><a name="item_destroy">$term->destroy</a></strong><br /> |
|
|
512 | </dt> |
|
|
513 | <dd> |
|
|
514 | Destroy the terminal object (close the window, free resources etc.). |
|
|
515 | </dd> |
|
|
516 | <p></p> |
|
|
517 | <dt><strong><a name="item_option">$isset = $term->option ($optval[, $set])</a></strong><br /> |
|
|
518 | </dt> |
|
|
519 | <dd> |
|
|
520 | Returns true if the option specified by <code>$optval</code> is enabled, and |
|
|
521 | optionally change it. All option values are stored by name in the hash |
|
|
522 | <code>%urxvt::OPTION</code>. Options not enabled in this binary are not in the hash. |
|
|
523 | </dd> |
|
|
524 | <dd> |
|
|
525 | <p>Here is a a likely non-exhaustive list of option names, please see the |
|
|
526 | source file <em>/src/optinc.h</em> to see the actual list:</p> |
|
|
527 | </dd> |
|
|
528 | <dd> |
|
|
529 | <pre> |
|
|
530 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
|
|
531 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
|
|
532 | pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating |
|
|
533 | scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer |
|
|
534 | secondaryScreen secondaryScroll skipBuiltinGlyphs transparent |
|
|
535 | tripleclickwords utmpInhibit visualBell</pre> |
|
|
536 | </dd> |
|
|
537 | <p></p> |
233 | <dt><strong><a name="item_resource">$value = $term->resource ($name[, $newval])</a></strong><br /> |
538 | <dt><strong><a name="item_resource">$value = $term->resource ($name[, $newval])</a></strong><br /> |
234 | </dt> |
539 | </dt> |
235 | <dd> |
540 | <dd> |
236 | Returns the current resource value associated with a given name and |
541 | Returns the current resource value associated with a given name and |
237 | optionally sets a new value. Setting values is most useful in the <code>init</code> |
542 | optionally sets a new value. Setting values is most useful in the <code>init</code> |
… | |
… | |
251 | <p>Please note that resource strings will currently only be freed when the |
556 | <p>Please note that resource strings will currently only be freed when the |
252 | terminal is destroyed, so changing options frequently will eat memory.</p> |
557 | terminal is destroyed, so changing options frequently will eat memory.</p> |
253 | </dd> |
558 | </dd> |
254 | <dd> |
559 | <dd> |
255 | <p>Here is a a likely non-exhaustive list of resource names, not all of which |
560 | <p>Here is a a likely non-exhaustive list of resource names, not all of which |
256 | are supported in every build, please see the source to see the actual |
561 | are supported in every build, please see the source file <em>/src/rsinc.h</em> |
257 | list:</p> |
562 | to see the actual list:</p> |
258 | </dd> |
563 | </dd> |
259 | <dd> |
564 | <dd> |
260 | <pre> |
565 | <pre> |
261 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
566 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
262 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
567 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
263 | display_name embed ext_bwidth fade font geometry hold iconName |
568 | display_name embed ext_bwidth fade font geometry hold iconName |
264 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
569 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
265 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
570 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
266 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext |
571 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 |
267 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
572 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
268 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
573 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
269 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
574 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
270 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
575 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
271 | shade term_name title transparent transparent_all tripleclickwords |
576 | shade term_name title transparent transparent_all tripleclickwords |
272 | utmpInhibit visualBell</pre> |
577 | utmpInhibit visualBell</pre> |
273 | </dd> |
578 | </dd> |
274 | <p></p> |
579 | <p></p> |
|
|
580 | <dt><strong><a name="item_rstyle">$rend = $term->rstyle ([$new_rstyle])</a></strong><br /> |
|
|
581 | </dt> |
|
|
582 | <dd> |
|
|
583 | Return and optionally change the current rendition. Text that is output by |
|
|
584 | the terminal application will use this style. |
|
|
585 | </dd> |
|
|
586 | <p></p> |
|
|
587 | <dt><strong><a name="item_screen_cur">($row, $col) = $term->screen_cur ([$row, $col])</a></strong><br /> |
|
|
588 | </dt> |
|
|
589 | <dd> |
|
|
590 | Return the current coordinates of the text cursor position and optionally |
|
|
591 | set it (which is usually bad as applications don't expect that). |
|
|
592 | </dd> |
|
|
593 | <p></p> |
275 | <dt><strong><a name="item_selection_mark">($row, $col) = $term->selection_mark ([$row, $col])</a></strong><br /> |
594 | <dt><strong><a name="item_selection_mark">($row, $col) = $term->selection_mark ([$row, $col])</a></strong><br /> |
276 | </dt> |
595 | </dt> |
277 | <dt><strong><a name="item_selection_beg">($row, $col) = $term->selection_beg ([$row, $col])</a></strong><br /> |
596 | <dt><strong><a name="item_selection_beg">($row, $col) = $term->selection_beg ([$row, $col])</a></strong><br /> |
278 | </dt> |
597 | </dt> |
279 | <dt><strong><a name="item_selection_end">($row, $col) = $term->selection_end ([$row, $col])</a></strong><br /> |
598 | <dt><strong><a name="item_selection_end">($row, $col) = $term->selection_end ([$row, $col])</a></strong><br /> |
… | |
… | |
288 | <dd> |
607 | <dd> |
289 | Try to request the primary selection from the server (for example, as set |
608 | Try to request the primary selection from the server (for example, as set |
290 | by the next method). |
609 | by the next method). |
291 | </dd> |
610 | </dd> |
292 | <p></p> |
611 | <p></p> |
293 | <dt><strong><a name="item_selection">$oldtext = $term->selection ([$newtext])</a></strong><br /> |
612 | <dt><strong>$oldtext = $term->selection ([$newtext])</strong><br /> |
294 | </dt> |
613 | </dt> |
295 | <dd> |
614 | <dd> |
296 | Return the current selection text and optionally replace it by <code>$newtext</code>. |
615 | Return the current selection text and optionally replace it by <code>$newtext</code>. |
297 | </dd> |
616 | </dd> |
298 | <p></p> |
|
|
299 | <dt><strong><a name="item_scr_overlay">$term->scr_overlay ($x, $y, $text)</a></strong><br /> |
|
|
300 | </dt> |
|
|
301 | <dd> |
617 | <dd> |
|
|
618 | <p>#=item $term->overlay ($x, $y, $text) |
|
|
619 | # |
302 | Create a simple multi-line overlay box. See the next method for details. |
620 | #Create a simple multi-line overlay box. See the next method for details. |
|
|
621 | # |
|
|
622 | #=cut |
|
|
623 | # |
|
|
624 | #sub urxvt::term::scr_overlay { |
|
|
625 | # my ($self, $x, $y, $text) = @_; |
|
|
626 | # |
|
|
627 | # my @lines = split /\n/, $text; |
|
|
628 | # |
|
|
629 | # my $w = 0; |
|
|
630 | # for (map $self->strwidth ($_), @lines) { |
|
|
631 | # $w = $_ if $w < $_; |
|
|
632 | # } |
|
|
633 | # |
|
|
634 | # $self->scr_overlay_new ($x, $y, $w, scalar @lines); |
|
|
635 | # $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; |
|
|
636 | #}</p> |
303 | </dd> |
637 | </dd> |
304 | <p></p> |
638 | <p></p> |
305 | <dt><strong><a name="item_scr_overlay_new">$term->scr_overlay_new ($x, $y, $width, $height)</a></strong><br /> |
639 | <dt><strong><a name="item_overlay">$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br /> |
306 | </dt> |
640 | </dt> |
307 | <dd> |
641 | <dd> |
308 | Create a new (empty) overlay at the given position with the given |
642 | Create a new (empty) overlay at the given position with the given |
309 | width/height. A border will be put around the box. If either <code>$x</code> or |
643 | width/height. <code>$rstyle</code> defines the initial rendition style |
310 | <code>$y</code> is negative, then this is counted from the right/bottom side, |
644 | (default: <code>OVERLAY_RSTYLE</code>). |
311 | respectively. |
|
|
312 | </dd> |
|
|
313 | <p></p> |
|
|
314 | <dt><strong><a name="item_scr_overlay_off">$term->scr_overlay_off</a></strong><br /> |
|
|
315 | </dt> |
|
|
316 | <dd> |
645 | </dd> |
317 | Switch the overlay off again. |
|
|
318 | </dd> |
646 | <dd> |
319 | <p></p> |
647 | <p>If <code>$border</code> is <code>2</code> (default), then a decorative border will be put |
320 | <dt><strong><a name="item_scr_overlay_set_char">$term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE)</a></strong><br /> |
648 | around the box.</p> |
321 | </dt> |
|
|
322 | <dd> |
649 | </dd> |
323 | Put a single character (specified numerically) at the given overlay |
|
|
324 | position. |
|
|
325 | </dd> |
650 | <dd> |
326 | <p></p> |
651 | <p>If either <code>$x</code> or <code>$y</code> is negative, then this is counted from the |
327 | <dt><strong><a name="item_scr_overlay_set">$term->scr_overlay_set ($x, $y, $text)</a></strong><br /> |
652 | right/bottom side, respectively.</p> |
328 | </dt> |
|
|
329 | <dd> |
653 | </dd> |
330 | Write a string at the given position into the overlay. |
|
|
331 | </dd> |
654 | <dd> |
|
|
655 | <p>This method returns an urxvt::overlay object. The overlay will be visible |
|
|
656 | as long as the perl object is referenced.</p> |
|
|
657 | </dd> |
|
|
658 | <dd> |
|
|
659 | <p>The methods currently supported on <code>urxvt::overlay</code> objects are:</p> |
|
|
660 | </dd> |
|
|
661 | <dl> |
|
|
662 | <dt><strong><a name="item_set">$overlay->set ($x, $y, $text, $rend)</a></strong><br /> |
|
|
663 | </dt> |
|
|
664 | <dd> |
|
|
665 | 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 |
|
|
666 | text in rxvt-unicode's special encoding and an array of rendition values |
|
|
667 | at a specific position inside the overlay. |
|
|
668 | </dd> |
332 | <p></p> |
669 | <p></p> |
|
|
670 | <dt><strong><a name="item_hide">$overlay->hide</a></strong><br /> |
|
|
671 | </dt> |
|
|
672 | <dd> |
|
|
673 | If visible, hide the overlay, but do not destroy it. |
|
|
674 | </dd> |
|
|
675 | <p></p> |
|
|
676 | <dt><strong><a name="item_show">$overlay->show</a></strong><br /> |
|
|
677 | </dt> |
|
|
678 | <dd> |
|
|
679 | If hidden, display the overlay again. |
|
|
680 | </dd> |
|
|
681 | <p></p></dl> |
|
|
682 | <dt><strong><a name="item_popup">$popup = $term->popup ($event)</a></strong><br /> |
|
|
683 | </dt> |
|
|
684 | <dd> |
|
|
685 | Creates a new <code>urxvt::popup</code> object that implements a popup menu. The |
|
|
686 | <code>$event</code> <em>must</em> be the event causing the menu to pop up (a button event, |
|
|
687 | currently). |
|
|
688 | </dd> |
|
|
689 | <p></p> |
333 | <dt><strong><a name="item_strwidth">$cellwidth = $term->strwidth $string</a></strong><br /> |
690 | <dt><strong><a name="item_strwidth">$cellwidth = $term->strwidth ($string)</a></strong><br /> |
334 | </dt> |
691 | </dt> |
335 | <dd> |
692 | <dd> |
336 | Returns the number of screen-cells this string would need. Correctly |
693 | Returns the number of screen-cells this string would need. Correctly |
337 | accounts for wide and combining characters. |
694 | accounts for wide and combining characters. |
338 | </dd> |
695 | </dd> |
339 | <p></p> |
696 | <p></p> |
340 | <dt><strong><a name="item_locale_encode">$octets = $term->locale_encode $string</a></strong><br /> |
697 | <dt><strong><a name="item_locale_encode">$octets = $term->locale_encode ($string)</a></strong><br /> |
341 | </dt> |
698 | </dt> |
342 | <dd> |
699 | <dd> |
343 | Convert the given text string into the corresponding locale encoding. |
700 | Convert the given text string into the corresponding locale encoding. |
344 | </dd> |
701 | </dd> |
345 | <p></p> |
702 | <p></p> |
346 | <dt><strong><a name="item_locale_decode">$string = $term->locale_decode $octets</a></strong><br /> |
703 | <dt><strong><a name="item_locale_decode">$string = $term->locale_decode ($octets)</a></strong><br /> |
347 | </dt> |
704 | </dt> |
348 | <dd> |
705 | <dd> |
349 | Convert the given locale-encoded octets into a perl string. |
706 | Convert the given locale-encoded octets into a perl string. |
350 | </dd> |
707 | </dd> |
351 | <p></p> |
708 | <p></p> |
|
|
709 | <dt><strong><a name="item_scr_add_lines">$term->scr_add_lines ($string)</a></strong><br /> |
|
|
710 | </dt> |
|
|
711 | <dd> |
|
|
712 | Write the given text string to the screen, as if output by the application |
|
|
713 | running inside the terminal. It may not contain command sequences (escape |
|
|
714 | codes), but is free to use line feeds, carriage returns and tabs. The |
|
|
715 | string is a normal text string, not in locale-dependent encoding. |
|
|
716 | </dd> |
|
|
717 | <dd> |
|
|
718 | <p>Normally its not a good idea to use this function, as programs might be |
|
|
719 | confused by changes in cursor position or scrolling. Its useful inside a |
|
|
720 | <code>on_add_lines</code> hook, though.</p> |
|
|
721 | </dd> |
|
|
722 | <p></p> |
|
|
723 | <dt><strong><a name="item_cmd_parse">$term->cmd_parse ($octets)</a></strong><br /> |
|
|
724 | </dt> |
|
|
725 | <dd> |
|
|
726 | Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the |
|
|
727 | locale-specific encoding of the terminal and can contain command sequences |
|
|
728 | (escape codes) that will be interpreted. |
|
|
729 | </dd> |
|
|
730 | <p></p> |
352 | <dt><strong><a name="item_tt_write">$term->tt_write ($octets)</a></strong><br /> |
731 | <dt><strong><a name="item_tt_write">$term->tt_write ($octets)</a></strong><br /> |
353 | </dt> |
732 | </dt> |
354 | <dd> |
733 | <dd> |
355 | Write the octets given in <code>$data</code> to the tty (i.e. as program input). To |
734 | Write the octets given in <code>$data</code> to the tty (i.e. as program input). To |
356 | pass characters instead of octets, you should convetr you strings first to |
735 | pass characters instead of octets, you should convert your strings first |
357 | the locale-specific encoding using <a href="#item_locale_encode"><code>$term->locale_encode</code></a>. |
736 | to the locale-specific encoding using <a href="#item_locale_encode"><code>$term->locale_encode</code></a>. |
|
|
737 | </dd> |
|
|
738 | <p></p> |
|
|
739 | <dt><strong><a name="item_parent">$windowid = $term->parent</a></strong><br /> |
|
|
740 | </dt> |
358 | </dd> |
741 | <dd> |
|
|
742 | Return the window id of the toplevel window. |
|
|
743 | </dd> |
|
|
744 | <p></p> |
|
|
745 | <dt><strong><a name="item_vt">$windowid = $term->vt</a></strong><br /> |
|
|
746 | </dt> |
|
|
747 | <dd> |
|
|
748 | Return the window id of the terminal window. |
|
|
749 | </dd> |
|
|
750 | <p></p> |
|
|
751 | <dt><strong><a name="item_width">$window_width = $term->width</a></strong><br /> |
|
|
752 | </dt> |
|
|
753 | <dt><strong><a name="item_height">$window_height = $term->height</a></strong><br /> |
|
|
754 | </dt> |
|
|
755 | <dt><strong><a name="item_fwidth">$font_width = $term->fwidth</a></strong><br /> |
|
|
756 | </dt> |
|
|
757 | <dt><strong><a name="item_fheight">$font_height = $term->fheight</a></strong><br /> |
|
|
758 | </dt> |
|
|
759 | <dt><strong><a name="item_fbase">$font_ascent = $term->fbase</a></strong><br /> |
|
|
760 | </dt> |
|
|
761 | <dt><strong><a name="item_nrow">$terminal_rows = $term->nrow</a></strong><br /> |
|
|
762 | </dt> |
|
|
763 | <dt><strong><a name="item_ncol">$terminal_columns = $term->ncol</a></strong><br /> |
|
|
764 | </dt> |
|
|
765 | <dt><strong><a name="item_focus">$has_focus = $term->focus</a></strong><br /> |
|
|
766 | </dt> |
|
|
767 | <dt><strong><a name="item_mapped">$is_mapped = $term->mapped</a></strong><br /> |
|
|
768 | </dt> |
|
|
769 | <dt><strong><a name="item_savelines">$max_scrollback = $term->saveLines</a></strong><br /> |
|
|
770 | </dt> |
|
|
771 | <dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term->total_rows</a></strong><br /> |
|
|
772 | </dt> |
|
|
773 | <dt><strong><a name="item_nsaved">$lines_in_scrollback = $term->nsaved</a></strong><br /> |
|
|
774 | </dt> |
|
|
775 | <dd> |
|
|
776 | Return various integers describing terminal characteristics. |
|
|
777 | </dd> |
|
|
778 | <p></p> |
|
|
779 | <dt><strong><a name="item_modlevel3mask">$modifiermask = $term->ModLevel3Mask</a></strong><br /> |
|
|
780 | </dt> |
|
|
781 | <dt><strong><a name="item_modmetamask">$modifiermask = $term->ModMetaMask</a></strong><br /> |
|
|
782 | </dt> |
|
|
783 | <dt><strong><a name="item_modnumlockmask">$modifiermask = $term->ModNumLockMask</a></strong><br /> |
|
|
784 | </dt> |
|
|
785 | <dd> |
|
|
786 | Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often |
|
|
787 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
|
|
788 | </dd> |
|
|
789 | <p></p> |
|
|
790 | <dt><strong><a name="item_view_start">$view_start = $term->view_start ([$newvalue])</a></strong><br /> |
|
|
791 | </dt> |
|
|
792 | <dd> |
|
|
793 | Returns the negative row number of the topmost line. Minimum value is |
|
|
794 | <code>0</code>, which displays the normal terminal contents. Larger values scroll |
|
|
795 | this many lines into the scrollback buffer. |
|
|
796 | </dd> |
|
|
797 | <p></p> |
|
|
798 | <dt><strong><a name="item_want_refresh">$term->want_refresh</a></strong><br /> |
|
|
799 | </dt> |
|
|
800 | <dd> |
|
|
801 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
|
|
802 | compare the on-screen display with its stored representation. If they |
|
|
803 | differ, it redraws the differences. |
|
|
804 | </dd> |
|
|
805 | <dd> |
|
|
806 | <p>Used after changing terminal contents to display them.</p> |
|
|
807 | </dd> |
|
|
808 | <p></p> |
|
|
809 | <dt><strong><a name="item_row_t">$text = $term->ROW_t ($row_number[, $new_text[, $start_col]])</a></strong><br /> |
|
|
810 | </dt> |
|
|
811 | <dd> |
|
|
812 | Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code> |
|
|
813 | is the topmost terminal line, row <code>$term->$ncol-1</code> is the bottommost |
|
|
814 | terminal line. The scrollback buffer starts at line <code>-1</code> and extends to |
|
|
815 | line <a href="#item_nsaved"><code>-$term->nsaved</code></a>. Nothing will be returned if a nonexistent line |
|
|
816 | is requested. |
|
|
817 | </dd> |
|
|
818 | <dd> |
|
|
819 | <p>If <code>$new_text</code> is specified, it will replace characters in the current |
|
|
820 | line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful |
|
|
821 | to replace only parts of a line. The font index in the rendition will |
|
|
822 | automatically be updated.</p> |
|
|
823 | </dd> |
|
|
824 | <dd> |
|
|
825 | <p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more |
|
|
826 | than one cell when displayed are padded with urxvt::NOCHAR characters |
|
|
827 | (<code>chr 65535</code>). Characters with combining characters and other characters |
|
|
828 | that do not fit into the normal tetx encoding will be replaced with |
|
|
829 | characters in the private use area.</p> |
|
|
830 | </dd> |
|
|
831 | <dd> |
|
|
832 | <p>You have to obey this encoding when changing text. The advantage is |
|
|
833 | that <code>substr</code> and similar functions work on screen cells and not on |
|
|
834 | characters.</p> |
|
|
835 | </dd> |
|
|
836 | <dd> |
|
|
837 | <p>The methods <code>$term->special_encode</code> and <a href="#item_special_decode"><code>$term->special_decode</code></a> |
|
|
838 | can be used to convert normal strings into this encoding and vice versa.</p> |
|
|
839 | </dd> |
|
|
840 | <p></p> |
|
|
841 | <dt><strong><a name="item_row_r">$rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br /> |
|
|
842 | </dt> |
|
|
843 | <dd> |
|
|
844 | Like <a href="#item_row_t"><code>$term->ROW_t</code></a>, but returns an arrayref with rendition |
|
|
845 | bitsets. Rendition bitsets contain information about colour, font, font |
|
|
846 | styles and similar information. See also <a href="#item_row_t"><code>$term->ROW_t</code></a>. |
|
|
847 | </dd> |
|
|
848 | <dd> |
|
|
849 | <p>When setting rendition, the font mask will be ignored.</p> |
|
|
850 | </dd> |
|
|
851 | <dd> |
|
|
852 | <p>See the section on RENDITION, above.</p> |
|
|
853 | </dd> |
|
|
854 | <p></p> |
|
|
855 | <dt><strong><a name="item_row_l">$length = $term->ROW_l ($row_number[, $new_length])</a></strong><br /> |
|
|
856 | </dt> |
|
|
857 | <dd> |
|
|
858 | Returns the number of screen cells that are in use (``the line |
|
|
859 | length''). Unlike the urxvt core, this returns <a href="#item_ncol"><code>$term->ncol</code></a> if the |
|
|
860 | line is joined with the following one. |
|
|
861 | </dd> |
|
|
862 | <p></p> |
|
|
863 | <dt><strong><a name="item_is_longer">$bool = $term->is_longer ($row_number)</a></strong><br /> |
|
|
864 | </dt> |
|
|
865 | <dd> |
|
|
866 | Returns true if the row is part of a multiple-row logical ``line'' (i.e. |
|
|
867 | joined with the following row), which means all characters are in use |
|
|
868 | and it is continued on the next row (and possibly a continuation of the |
|
|
869 | previous row(s)). |
|
|
870 | </dd> |
|
|
871 | <p></p> |
|
|
872 | <dt><strong><a name="item_line">$line = $term->line ($row_number)</a></strong><br /> |
|
|
873 | </dt> |
|
|
874 | <dd> |
|
|
875 | Create and return a new <code>urxvt::line</code> object that stores information |
|
|
876 | about the logical line that row <code>$row_number</code> is part of. It supports the |
|
|
877 | following methods: |
|
|
878 | </dd> |
|
|
879 | <dl> |
|
|
880 | <dt><strong><a name="item_t">$text = $line->t ([$new_text])</a></strong><br /> |
|
|
881 | </dt> |
|
|
882 | <dd> |
|
|
883 | Returns or replaces the full text of the line, similar to <a href="#item_row_t"><code>ROW_t</code></a> |
|
|
884 | </dd> |
|
|
885 | <p></p> |
|
|
886 | <dt><strong><a name="item_r">$rend = $line->r ([$new_rend])</a></strong><br /> |
|
|
887 | </dt> |
|
|
888 | <dd> |
|
|
889 | Returns or replaces the full rendition array of the line, similar to <a href="#item_row_r"><code>ROW_r</code></a> |
|
|
890 | </dd> |
|
|
891 | <p></p> |
|
|
892 | <dt><strong><a name="item_l">$length = $line->l</a></strong><br /> |
|
|
893 | </dt> |
|
|
894 | <dd> |
|
|
895 | Returns the length of the line in cells, similar to <a href="#item_row_l"><code>ROW_l</code></a>. |
|
|
896 | </dd> |
|
|
897 | <p></p> |
|
|
898 | <dt><strong><a name="item_beg">$rownum = $line->beg</a></strong><br /> |
|
|
899 | </dt> |
|
|
900 | <dt><strong><a name="item_end">$rownum = $line->end</a></strong><br /> |
|
|
901 | </dt> |
|
|
902 | <dd> |
|
|
903 | Return the row number of the first/last row of the line, respectively. |
|
|
904 | </dd> |
|
|
905 | <p></p> |
|
|
906 | <dt><strong><a name="item_offset_of">$offset = $line->offset_of ($row, $col)</a></strong><br /> |
|
|
907 | </dt> |
|
|
908 | <dd> |
|
|
909 | Returns the character offset of the given row|col pair within the logical |
|
|
910 | line. |
|
|
911 | </dd> |
|
|
912 | <p></p> |
|
|
913 | <dt><strong><a name="item_coord_of">($row, $col) = $line->coord_of ($offset)</a></strong><br /> |
|
|
914 | </dt> |
|
|
915 | <dd> |
|
|
916 | Translates a string offset into terminal coordinates again. |
|
|
917 | </dd> |
359 | <p></p></dl> |
918 | <p></p></dl> |
|
|
919 | <dt><strong>($row, $col) = $line->coord_of ($offset) |
|
|
920 | =item $text = $term->special_encode $string</strong><br /> |
|
|
921 | </dt> |
|
|
922 | <dd> |
|
|
923 | Converts a perl string into the special encoding used by rxvt-unicode, |
|
|
924 | where one character corresponds to one screen cell. See |
|
|
925 | <a href="#item_row_t"><code>$term->ROW_t</code></a> for details. |
|
|
926 | </dd> |
|
|
927 | <p></p> |
|
|
928 | <dt><strong><a name="item_special_decode">$string = $term->special_decode $text</a></strong><br /> |
|
|
929 | </dt> |
|
|
930 | <dd> |
|
|
931 | Converts rxvt-unicodes text reprsentation into a perl string. See |
|
|
932 | <a href="#item_row_t"><code>$term->ROW_t</code></a> for details. |
|
|
933 | </dd> |
|
|
934 | <p></p></dl> |
|
|
935 | <p> |
|
|
936 | </p> |
|
|
937 | <h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> |
360 | <p> |
938 | <p> |
361 | </p> |
939 | </p> |
362 | <h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> |
940 | <h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> |
363 | <p>This class implements timer watchers/events. Time is represented as a |
941 | <p>This class implements timer watchers/events. Time is represented as a |
364 | fractional number of seconds since the epoch. Example:</p> |
942 | fractional number of seconds since the epoch. Example:</p> |
365 | <pre> |
943 | <pre> |
366 | # create a digital clock display in upper right corner |
944 | $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0); |
367 | $term->{timer} = urxvt::timer |
945 | $term->{timer} = urxvt::timer |
368 | ->new |
946 | ->new |
369 | ->start (urxvt::NOW) |
947 | ->interval (1) |
370 | ->cb (sub { |
948 | ->cb (sub { |
371 | my ($timer) = @_; |
|
|
372 | my $time = $timer->at; |
|
|
373 | $timer->start ($time + 1); |
|
|
374 | $self->scr_overlay (-1, 0, |
949 | $term->{overlay}->set (0, 0, |
375 | POSIX::strftime "%H:%M:%S", localtime $time); |
950 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
376 | });</pre> |
951 | });</pre> |
377 | <dl> |
952 | <dl> |
378 | <dt><strong><a name="item__24timer__3d_new_urxvt_3a_3atimer">$timer = new urxvt::timer</a></strong><br /> |
953 | <dt><strong><a name="item__24timer__3d_new_urxvt_3a_3atimer">$timer = new urxvt::timer</a></strong><br /> |
379 | </dt> |
954 | </dt> |
380 | <dd> |
955 | <dd> |
381 | Create a new timer object in stopped state. |
956 | Create a new timer object in started state. It is scheduled to fire |
|
|
957 | immediately. |
382 | </dd> |
958 | </dd> |
383 | <p></p> |
959 | <p></p> |
384 | <dt><strong><a name="item_cb">$timer = $timer->cb (sub { my ($timer) = @_; ... })</a></strong><br /> |
960 | <dt><strong><a name="item_cb">$timer = $timer->cb (sub { my ($timer) = @_; ... })</a></strong><br /> |
385 | </dt> |
961 | </dt> |
386 | <dd> |
962 | <dd> |
… | |
… | |
391 | </dt> |
967 | </dt> |
392 | <dd> |
968 | <dd> |
393 | Return the time this watcher will fire next. |
969 | Return the time this watcher will fire next. |
394 | </dd> |
970 | </dd> |
395 | <p></p> |
971 | <p></p> |
396 | <dt><strong><a name="item_set">$timer = $timer->set ($tstamp)</a></strong><br /> |
972 | <dt><strong>$timer = $timer->set ($tstamp)</strong><br /> |
397 | </dt> |
973 | </dt> |
398 | <dd> |
974 | <dd> |
399 | Set the time the event is generated to $tstamp. |
975 | Set the time the event is generated to $tstamp. |
|
|
976 | </dd> |
|
|
977 | <p></p> |
|
|
978 | <dt><strong><a name="item_interval">$timer = $timer->interval ($interval)</a></strong><br /> |
|
|
979 | </dt> |
|
|
980 | <dd> |
|
|
981 | Normally (and when <code>$interval</code> is <code>0</code>), the timer will automatically |
|
|
982 | stop after it has fired once. If <code>$interval</code> is non-zero, then the timer |
|
|
983 | is automatically rescheduled at the given intervals. |
400 | </dd> |
984 | </dd> |
401 | <p></p> |
985 | <p></p> |
402 | <dt><strong><a name="item_start">$timer = $timer->start</a></strong><br /> |
986 | <dt><strong><a name="item_start">$timer = $timer->start</a></strong><br /> |
403 | </dt> |
987 | </dt> |
404 | <dd> |
988 | <dd> |
… | |
… | |
480 | <p> |
1064 | <p> |
481 | </p> |
1065 | </p> |
482 | <h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> |
1066 | <h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> |
483 | <p>This variable controls the verbosity level of the perl extension. Higher |
1067 | <p>This variable controls the verbosity level of the perl extension. Higher |
484 | numbers indicate more verbose output.</p> |
1068 | numbers indicate more verbose output.</p> |
485 | <ol> |
1069 | <dl> |
486 | <li><strong><a name="item__2d_only_fatal_messages">- only fatal messages</a></strong><br /> |
1070 | <dt><strong><a name="item__3d0__2d_only_fatal_messages">=0 - only fatal messages</a></strong><br /> |
487 | </li> |
1071 | </dt> |
488 | <li><strong><a name="item__2d_script_loading_and_management">- script loading and management</a></strong><br /> |
1072 | <dt><strong><a name="item__3d3__2d_script_loading_and_management">=3 - script loading and management</a></strong><br /> |
489 | </li> |
1073 | </dt> |
490 | <li><strong><a name="item__2d_all_events_received">- all events received</a></strong><br /> |
1074 | <dt><strong><a name="item__3d10__2d_all_events_received">=10 - all events received</a></strong><br /> |
|
|
1075 | </dt> |
491 | </li> |
1076 | </dl> |
492 | </ol> |
|
|
493 | <p> |
1077 | <p> |
494 | </p> |
1078 | </p> |
495 | <hr /> |
1079 | <hr /> |
496 | <h1><a name="author">AUTHOR</a></h1> |
1080 | <h1><a name="author">AUTHOR</a></h1> |
497 | <pre> |
1081 | <pre> |