… | |
… | |
13 | <ul> |
13 | <ul> |
14 | |
14 | |
15 | <li><a href="#name">NAME</a></li> |
15 | <li><a href="#name">NAME</a></li> |
16 | <li><a href="#synopsis">SYNOPSIS</a></li> |
16 | <li><a href="#synopsis">SYNOPSIS</a></li> |
17 | <li><a href="#description">DESCRIPTION</a></li> |
17 | <li><a href="#description">DESCRIPTION</a></li> |
|
|
18 | <li><a href="#prepackaged_extensions">PREPACKAGED EXTENSIONS</a></li> |
|
|
19 | <li><a href="#api_documentation">API DOCUMENTATION</a></li> |
18 | <ul> |
20 | <ul> |
19 | |
21 | |
20 | <li><a href="#prepackaged_extensions">Prepackaged Extensions</a></li> |
|
|
21 | <li><a href="#general_api_considerations">General API Considerations</a></li> |
22 | <li><a href="#general_api_considerations">General API Considerations</a></li> |
|
|
23 | <li><a href="#extension_objects">Extension Objects</a></li> |
22 | <li><a href="#hooks">Hooks</a></li> |
24 | <li><a href="#hooks">Hooks</a></li> |
23 | <li><a href="#variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></li> |
25 | <li><a href="#variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></li> |
24 | <li><a href="#functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></li> |
26 | <li><a href="#functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></li> |
25 | <li><a href="#rendition">RENDITION</a></li> |
27 | <li><a href="#rendition">RENDITION</a></li> |
|
|
28 | <li><a href="#the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></li> |
26 | <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> |
27 | <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> |
28 | <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> |
29 | </ul> |
33 | </ul> |
30 | |
34 | |
31 | <li><a href="#environment">ENVIRONMENT</a></li> |
35 | <li><a href="#environment">ENVIRONMENT</a></li> |
… | |
… | |
61 | rxvt --perl-lib $HOME -pe grab_test</pre> |
65 | rxvt --perl-lib $HOME -pe grab_test</pre> |
62 | <p> |
66 | <p> |
63 | </p> |
67 | </p> |
64 | <hr /> |
68 | <hr /> |
65 | <h1><a name="description">DESCRIPTION</a></h1> |
69 | <h1><a name="description">DESCRIPTION</a></h1> |
66 | <p>Everytime a terminal object gets created, scripts specified via the |
70 | <p>Everytime a terminal object gets created, extension scripts specified via |
67 | <code>perl</code> resource are loaded and associated with it.</p> |
71 | the <code>perl</code> resource are loaded and associated with it.</p> |
68 | <p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and |
72 | <p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and |
69 | thus must be encoded as UTF-8.</p> |
73 | thus must be encoded as UTF-8.</p> |
70 | <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 |
71 | scripts will be shared (but not enabled) for all terminals.</p> |
75 | scripts will be shared (but not enabled) for all terminals.</p> |
72 | <p> |
76 | <p> |
73 | </p> |
77 | </p> |
74 | <h2><a name="prepackaged_extensions">Prepackaged Extensions</a></h2> |
78 | <hr /> |
|
|
79 | <h1><a name="prepackaged_extensions">PREPACKAGED EXTENSIONS</a></h1> |
75 | <p>This section describes the extensiosn delivered with this version. You can |
80 | <p>This section describes the extensions delivered with this release. You can |
76 | find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> |
81 | find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> |
77 | <p>You can activate them like this:</p> |
82 | <p>You can activate them like this:</p> |
78 | <pre> |
83 | <pre> |
79 | rxvt -pe <extensionname></pre> |
84 | rxvt -pe <extensionname></pre> |
80 | <dl> |
85 | <dl> |
81 | <dt><strong><a name="item_selection">selection</a></strong><br /> |
86 | <dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br /> |
82 | </dt> |
87 | </dt> |
83 | <dd> |
88 | <dd> |
84 | Intelligent selection. This extension tries to be more intelligent when |
89 | (More) intelligent selection. This extension tries to be more intelligent |
85 | the user extends selections (double-click). Right now, it tries to select |
90 | when the user extends selections (double-click). Right now, it tries to |
86 | urls and complete shell-quoted arguments, which is very convenient, too, |
91 | select urls and complete shell-quoted arguments, which is very convenient, |
87 | if your <em>ls</em> supports <code>--quoting-style=shell</code>. |
92 | too, if your <em>ls</em> supports <code>--quoting-style=shell</code>. |
88 | </dd> |
|
|
89 | <dd> |
93 | </dd> |
|
|
94 | <dd> |
90 | <p>It also offers the following bindable event:</p> |
95 | <p>It also offers the following bindable keyboard command:</p> |
91 | </dd> |
96 | </dd> |
92 | <dl> |
97 | <dl> |
93 | <dt><strong><a name="item_rot13">rot13</a></strong><br /> |
98 | <dt><strong><a name="item_rot13">rot13</a></strong><br /> |
94 | </dt> |
99 | </dt> |
95 | <dd> |
100 | <dd> |
… | |
… | |
98 | <dd> |
103 | <dd> |
99 | <pre> |
104 | <pre> |
100 | URxvt.keysym.C-M-r: perl:selection:rot13</pre> |
105 | URxvt.keysym.C-M-r: perl:selection:rot13</pre> |
101 | </dd> |
106 | </dd> |
102 | <p></p></dl> |
107 | <p></p></dl> |
|
|
108 | <dt><strong><a name="item_popup">option-popup (enabled by default)</a></strong><br /> |
|
|
109 | </dt> |
|
|
110 | <dd> |
|
|
111 | Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at |
|
|
112 | runtime. |
|
|
113 | </dd> |
|
|
114 | <p></p> |
|
|
115 | <dt><strong>selection-popup (enabled by default)</strong><br /> |
|
|
116 | </dt> |
|
|
117 | <dd> |
|
|
118 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
|
|
119 | text into various other formats/action (such as uri unescaping, perl |
|
|
120 | evalution, web-browser starting etc.), depending on content. |
|
|
121 | </dd> |
|
|
122 | <p></p> |
|
|
123 | <dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback<hotkey> (enabled by default)</a></strong><br /> |
|
|
124 | </dt> |
|
|
125 | <dd> |
|
|
126 | Adds regex search functionality to the scrollback buffer, triggered |
|
|
127 | by a hotkey (default: <code>M-s</code>). When in search mode, normal terminal |
|
|
128 | input/output is suspended. |
|
|
129 | </dd> |
|
|
130 | <dd> |
|
|
131 | <p><code>/</code> starts an incremental regex search, <code>n</code> searches further, <code>p</code> or |
|
|
132 | <code>N</code> jump to the previous match, <code>G</code> jumps to the bottom and clears the |
|
|
133 | history, <code>enter</code> leaves search mode at the current position and <code>escape</code> |
|
|
134 | returns to the original position.</p> |
|
|
135 | </dd> |
|
|
136 | <p></p> |
103 | <dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> |
137 | <dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> |
104 | </dt> |
138 | </dt> |
105 | <dd> |
139 | <dd> |
106 | Displays a digital clock using the built-in overlay. |
140 | Displays a digital clock using the built-in overlay. |
|
|
141 | </dd> |
|
|
142 | <p></p> |
|
|
143 | <dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> |
|
|
144 | </dt> |
|
|
145 | <dd> |
|
|
146 | Uses per-line display filtering (<code>on_line_update</code>) to underline urls. |
|
|
147 | </dd> |
|
|
148 | <p></p> |
|
|
149 | <dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br /> |
|
|
150 | </dt> |
|
|
151 | <dd> |
|
|
152 | A not very useful example of filtering all text output to the terminal, |
|
|
153 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
|
|
154 | similar-looking ascii character. |
107 | </dd> |
155 | </dd> |
108 | <p></p> |
156 | <p></p> |
109 | <dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> |
157 | <dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> |
110 | </dt> |
158 | </dt> |
111 | <dd> |
159 | <dd> |
112 | Displays a very simple digital clock in the upper right corner of the |
160 | Displays a very simple digital clock in the upper right corner of the |
113 | window. Illustrates overwriting the refresh callbacks to create your own |
161 | window. Illustrates overwriting the refresh callbacks to create your own |
114 | overlays or changes. |
162 | overlays or changes. |
115 | </dd> |
163 | </dd> |
116 | <p></p></dl> |
164 | <p></p></dl> |
|
|
165 | <p> |
|
|
166 | </p> |
|
|
167 | <hr /> |
|
|
168 | <h1><a name="api_documentation">API DOCUMENTATION</a></h1> |
117 | <p> |
169 | <p> |
118 | </p> |
170 | </p> |
119 | <h2><a name="general_api_considerations">General API Considerations</a></h2> |
171 | <h2><a name="general_api_considerations">General API Considerations</a></h2> |
120 | <p>All objects (such as terminals, time watchers etc.) are typical |
172 | <p>All objects (such as terminals, time watchers etc.) are typical |
121 | reference-to-hash objects. The hash can be used to store anything you |
173 | reference-to-hash objects. The hash can be used to store anything you |
… | |
… | |
124 | modified).</p> |
176 | modified).</p> |
125 | <p>When objects are destroyed on the C++ side, the perl object hashes are |
177 | <p>When objects are destroyed on the C++ side, the perl object hashes are |
126 | emptied, so its best to store related objects such as time watchers and |
178 | emptied, so its best to store related objects such as time watchers and |
127 | the like inside the terminal object so they get destroyed as soon as the |
179 | the like inside the terminal object so they get destroyed as soon as the |
128 | terminal is destroyed.</p> |
180 | terminal is destroyed.</p> |
|
|
181 | <p>Argument names also often indicate the type of a parameter. Here are some |
|
|
182 | hints on what they mean:</p> |
|
|
183 | <dl> |
|
|
184 | <dt><strong><a name="item__24text">$text</a></strong><br /> |
|
|
185 | </dt> |
|
|
186 | <dd> |
|
|
187 | Rxvt-unicodes special way of encoding text, where one ``unicode'' character |
|
|
188 | always represents one screen cell. See <em>row_t</em> for a discussion of this format. |
|
|
189 | </dd> |
|
|
190 | <p></p> |
|
|
191 | <dt><strong><a name="item__24string">$string</a></strong><br /> |
|
|
192 | </dt> |
|
|
193 | <dd> |
|
|
194 | A perl text string, with an emphasis on <em>text</em>. It can store all unicode |
|
|
195 | characters and is to be distinguished with text encoded in a specific |
|
|
196 | encoding (often locale-specific) and binary data. |
|
|
197 | </dd> |
|
|
198 | <p></p> |
|
|
199 | <dt><strong><a name="item__24octets">$octets</a></strong><br /> |
|
|
200 | </dt> |
|
|
201 | <dd> |
|
|
202 | Either binary data or - more common - a text string encoded in a |
|
|
203 | locale-specific way. |
|
|
204 | </dd> |
|
|
205 | <p></p></dl> |
|
|
206 | <p> |
|
|
207 | </p> |
|
|
208 | <h2><a name="extension_objects">Extension Objects</a></h2> |
|
|
209 | <p>Very perl extension is a perl class. A separate perl object is created |
|
|
210 | for each terminal and each extension and passed as the first parameter to |
|
|
211 | hooks. So extensions can use their <code>$self</code> object without having to think |
|
|
212 | about other extensions, with the exception of methods and members that |
|
|
213 | begin with an underscore character <code>_</code>: these are reserved for internal |
|
|
214 | use.</p> |
|
|
215 | <p>Although it isn't a <code>urxvt::term</code> object, you can call all methods of the |
|
|
216 | <code>urxvt::term</code> class on this object.</p> |
|
|
217 | <p>It has the following methods and data members:</p> |
|
|
218 | <dl> |
|
|
219 | <dt><strong><a name="item__24urxvt_term__3d__24self_2d_3e_7bterm_7d">$urxvt_term = $self->{term}</a></strong><br /> |
|
|
220 | </dt> |
|
|
221 | <dd> |
|
|
222 | Returns the <code>urxvt::term</code> object associated with this instance of the |
|
|
223 | extension. This member <em>must not</em> be changed in any way. |
|
|
224 | </dd> |
|
|
225 | <p></p> |
|
|
226 | <dt><strong><a name="item_enable">$self->enable ($hook_name => $cb, [$hook_name => $cb..])</a></strong><br /> |
|
|
227 | </dt> |
|
|
228 | <dd> |
|
|
229 | Dynamically enable the given hooks (named without the <code>on_</code> prefix) for |
|
|
230 | this extension, replacing any previous hook. This is useful when you want |
|
|
231 | to overwrite time-critical hooks only temporarily. |
|
|
232 | </dd> |
|
|
233 | <p></p> |
|
|
234 | <dt><strong><a name="item_disable">$self->disable ($hook_name[, $hook_name..])</a></strong><br /> |
|
|
235 | </dt> |
|
|
236 | <dd> |
|
|
237 | Dynamically disable the given hooks. |
|
|
238 | </dd> |
|
|
239 | <p></p></dl> |
129 | <p> |
240 | <p> |
130 | </p> |
241 | </p> |
131 | <h2><a name="hooks">Hooks</a></h2> |
242 | <h2><a name="hooks">Hooks</a></h2> |
132 | <p>The following subroutines can be declared in loaded scripts, and will be |
243 | <p>The following subroutines can be declared in extension files, and will be |
133 | called whenever the relevant event happens.</p> |
244 | called whenever the relevant event happens.</p> |
134 | <p>The first argument passed to them is an object private to each terminal |
245 | <p>The first argument passed to them is an extension oject as described in |
135 | and extension package. You can call all <code>urxvt::term</code> methods on it, but |
246 | the in the <code>Extension Objects</code> section.</p> |
136 | its not a real <code>urxvt::term</code> object. Instead, the real <code>urxvt::term</code> |
|
|
137 | object that is shared between all packages is stored in the <code>term</code> |
|
|
138 | member.</p> |
|
|
139 | <p>All of them must return a boolean value. If it is true, then the event |
247 | <p><strong>All</strong> of these hooks must return a boolean value. If it is true, then the |
140 | counts as being <em>consumed</em>, and the invocation of other hooks is skipped, |
248 | event counts as being <em>consumed</em>, and the invocation of other hooks is |
141 | and the relevant action might not be carried out by the C++ code.</p> |
249 | skipped, and the relevant action might not be carried out by the C++ code.</p> |
142 | <p>When in doubt, return a false value (preferably <code>()</code>).</p> |
250 | <p><em>When in doubt, return a false value (preferably <code>()</code>). </em>></p> |
143 | <dl> |
251 | <dl> |
144 | <dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> |
252 | <dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> |
145 | </dt> |
253 | </dt> |
146 | <dd> |
254 | <dd> |
147 | Called after a new terminal object has been initialized, but before |
255 | Called after a new terminal object has been initialized, but before |
148 | windows are created or the command gets run. |
256 | windows are created or the command gets run. Most methods are unsafe to |
|
|
257 | call or deliver senseless data, as terminal size and other characteristics |
|
|
258 | have not yet been determined. You can safely query and change resources, |
|
|
259 | though. |
149 | </dd> |
260 | </dd> |
150 | <p></p> |
261 | <p></p> |
151 | <dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> |
262 | <dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> |
152 | </dt> |
263 | </dt> |
153 | <dd> |
264 | <dd> |
… | |
… | |
196 | </dd> |
307 | </dd> |
197 | <dd> |
308 | <dd> |
198 | <p>See the <em>selection</em> example extension.</p> |
309 | <p>See the <em>selection</em> example extension.</p> |
199 | </dd> |
310 | </dd> |
200 | <p></p> |
311 | <p></p> |
201 | <dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> |
|
|
202 | </dt> |
|
|
203 | <dd> |
|
|
204 | Called whenever the window gets the keyboard focus, before urxvt does |
|
|
205 | focus in processing. |
|
|
206 | </dd> |
|
|
207 | <p></p> |
|
|
208 | <dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong><br /> |
|
|
209 | </dt> |
|
|
210 | <dd> |
|
|
211 | Called wheneever the window loses keyboard focus, before urxvt does focus |
|
|
212 | out processing. |
|
|
213 | </dd> |
|
|
214 | <p></p> |
|
|
215 | <dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong><br /> |
312 | <dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong><br /> |
216 | </dt> |
313 | </dt> |
217 | <dd> |
314 | <dd> |
218 | Called whenever the view offset changes, i..e the user or program |
315 | Called whenever the view offset changes, i..e the user or program |
219 | scrolls. Offset <code>0</code> means display the normal terminal, positive values |
316 | scrolls. Offset <code>0</code> means display the normal terminal, positive values |
… | |
… | |
229 | </dd> |
326 | </dd> |
230 | <dd> |
327 | <dd> |
231 | <p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
328 | <p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
232 | $nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total |
329 | $nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total |
233 | number of lines that will be in the scrollback buffer.</p> |
330 | number of lines that will be in the scrollback buffer.</p> |
234 | </dd> |
|
|
235 | <p></p> |
|
|
236 | <dt><strong><a name="item_on_tty_activity__24term__2anyi_2a">on_tty_activity $term *NYI*</a></strong><br /> |
|
|
237 | </dt> |
|
|
238 | <dd> |
|
|
239 | Called whenever the <code>program(s)</code> running in the urxvt window send output. |
|
|
240 | </dd> |
331 | </dd> |
241 | <p></p> |
332 | <p></p> |
242 | <dt><strong><a name="item_on_osc_seq__24term_2c__24string">on_osc_seq $term, $string</a></strong><br /> |
333 | <dt><strong><a name="item_on_osc_seq__24term_2c__24string">on_osc_seq $term, $string</a></strong><br /> |
243 | </dt> |
334 | </dt> |
244 | <dd> |
335 | <dd> |
… | |
… | |
253 | <p>Be careful not ever to trust (in a security sense) the data you receive, |
344 | <p>Be careful not ever to trust (in a security sense) the data you receive, |
254 | as its source can not easily be controleld (e-mail content, messages from |
345 | as its source can not easily be controleld (e-mail content, messages from |
255 | other users on the same system etc.).</p> |
346 | other users on the same system etc.).</p> |
256 | </dd> |
347 | </dd> |
257 | <p></p> |
348 | <p></p> |
|
|
349 | <dt><strong><a name="item_on_add_lines__24term_2c__24string">on_add_lines $term, $string</a></strong><br /> |
|
|
350 | </dt> |
|
|
351 | <dd> |
|
|
352 | Called whenever text is about to be output, with the text as argument. You |
|
|
353 | can filter/change and output the text yourself by returning a true value |
|
|
354 | and calling <a href="#item_scr_add_lines"><code>$term->scr_add_lines</code></a> yourself. Please note that this |
|
|
355 | might be very slow, however, as your hook is called for <strong>all</strong> text being |
|
|
356 | output. |
|
|
357 | </dd> |
|
|
358 | <p></p> |
|
|
359 | <dt><strong><a name="item_on_tt_write__24term_2c__24octets">on_tt_write $term, $octets</a></strong><br /> |
|
|
360 | </dt> |
|
|
361 | <dd> |
|
|
362 | Called whenever some data is written to the tty/pty and can be used to |
|
|
363 | suppress or filter tty input. |
|
|
364 | </dd> |
|
|
365 | <p></p> |
|
|
366 | <dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong><br /> |
|
|
367 | </dt> |
|
|
368 | <dd> |
|
|
369 | Called whenever a line was updated or changed. Can be used to filter |
|
|
370 | screen output (e.g. underline urls or other useless stuff). Only lines |
|
|
371 | that are being shown will be filtered, and, due to performance reasons, |
|
|
372 | not always immediately. |
|
|
373 | </dd> |
|
|
374 | <dd> |
|
|
375 | <p>The row number is always the topmost row of the line if the line spans |
|
|
376 | multiple rows.</p> |
|
|
377 | </dd> |
|
|
378 | <dd> |
|
|
379 | <p>Please note that, if you change the line, then the hook might get called |
|
|
380 | later with the already-modified line (e.g. if unrelated parts change), so |
|
|
381 | you cannot just toggle rendition bits, but only set them.</p> |
|
|
382 | </dd> |
|
|
383 | <p></p> |
258 | <dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong><br /> |
384 | <dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong><br /> |
259 | </dt> |
385 | </dt> |
260 | <dd> |
386 | <dd> |
261 | Called just before the screen gets redrawn. Can be used for overlay |
387 | Called just before the screen gets redrawn. Can be used for overlay |
262 | or similar effects by modify terminal contents in refresh_begin, and |
388 | or similar effects by modify terminal contents in refresh_begin, and |
… | |
… | |
275 | <dd> |
401 | <dd> |
276 | Called whenever the user presses a key combination that has a |
402 | Called whenever the user presses a key combination that has a |
277 | <code>perl:string</code> action bound to it (see description of the <strong>keysym</strong> |
403 | <code>perl:string</code> action bound to it (see description of the <strong>keysym</strong> |
278 | resource in the <code>rxvt(1)</code> manpage). |
404 | resource in the <code>rxvt(1)</code> manpage). |
279 | </dd> |
405 | </dd> |
|
|
406 | <p></p> |
|
|
407 | <dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> |
|
|
408 | </dt> |
|
|
409 | <dd> |
|
|
410 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
|
|
411 | does focus in processing. |
|
|
412 | </dd> |
|
|
413 | <p></p> |
|
|
414 | <dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong><br /> |
|
|
415 | </dt> |
|
|
416 | <dd> |
|
|
417 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
|
|
418 | focus out processing. |
|
|
419 | </dd> |
|
|
420 | <p></p> |
|
|
421 | <dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a></strong><br /> |
|
|
422 | </dt> |
|
|
423 | <dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br /> |
|
|
424 | </dt> |
|
|
425 | <dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br /> |
|
|
426 | </dt> |
|
|
427 | <dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br /> |
|
|
428 | </dt> |
|
|
429 | <dt><strong><a name="item_on_motion_notify__24term_2c__24event">on_motion_notify $term, $event</a></strong><br /> |
|
|
430 | </dt> |
|
|
431 | <dt><strong><a name="item_on_map_notify__24term_2c__24event">on_map_notify $term, $event</a></strong><br /> |
|
|
432 | </dt> |
|
|
433 | <dt><strong><a name="item_on_unmap_notify__24term_2c__24event">on_unmap_notify $term, $event</a></strong><br /> |
|
|
434 | </dt> |
|
|
435 | <dd> |
|
|
436 | Called whenever the corresponding X event is received for the terminal If |
|
|
437 | the hook returns true, then the even will be ignored by rxvt-unicode. |
|
|
438 | </dd> |
|
|
439 | <dd> |
|
|
440 | <p>The event is a hash with most values as named by Xlib (see the XEvent |
|
|
441 | manpage), with the additional members <code>row</code> and <code>col</code>, which are the row |
|
|
442 | and column under the mouse cursor.</p> |
|
|
443 | </dd> |
|
|
444 | <dd> |
|
|
445 | <p><code>on_key_press</code> additionally receives the string rxvt-unicode would |
|
|
446 | output, if any, in locale-specific encoding.</p> |
|
|
447 | </dd> |
|
|
448 | <dd> |
|
|
449 | <p>subwindow.</p> |
|
|
450 | </dd> |
280 | <p></p></dl> |
451 | <p></p></dl> |
281 | <p> |
452 | <p> |
282 | </p> |
453 | </p> |
283 | <h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> |
454 | <h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> |
284 | <dl> |
455 | <dl> |
|
|
456 | <dt><strong><a name="item__24urxvt_3a_3alibdir">$urxvt::LIBDIR</a></strong><br /> |
|
|
457 | </dt> |
|
|
458 | <dd> |
|
|
459 | The rxvt-unicode library directory, where, among other things, the perl |
|
|
460 | modules and scripts are stored. |
|
|
461 | </dd> |
|
|
462 | <p></p> |
|
|
463 | <dt><strong><a name="item__24urxvt_3a_3aresclass_2c__24urxvt_3a_3aresclass">$urxvt::RESCLASS, $urxvt::RESCLASS</a></strong><br /> |
|
|
464 | </dt> |
|
|
465 | <dd> |
|
|
466 | The resource class and name rxvt-unicode uses to look up X resources. |
|
|
467 | </dd> |
|
|
468 | <p></p> |
|
|
469 | <dt><strong><a name="item__24urxvt_3a_3arxvtname">$urxvt::RXVTNAME</a></strong><br /> |
|
|
470 | </dt> |
|
|
471 | <dd> |
|
|
472 | The basename of the installed binaries, usually <code>urxvt</code>. |
|
|
473 | </dd> |
|
|
474 | <p></p> |
285 | <dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br /> |
475 | <dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br /> |
286 | </dt> |
476 | </dt> |
287 | <dd> |
477 | <dd> |
288 | The current terminal. Whenever a callback/Hook is bein executed, this |
478 | The current terminal. This variable stores the current <code>urxvt::term</code> |
289 | variable stores the current <code>urxvt::term</code> object. |
479 | object, whenever a callback/hook is executing. |
|
|
480 | </dd> |
|
|
481 | <p></p> |
|
|
482 | <dt></dt> |
290 | </dd> |
483 | </dl> |
291 | <p></p></dl> |
|
|
292 | <p> |
484 | <p> |
293 | </p> |
485 | </p> |
294 | <h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> |
486 | <h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> |
295 | <dl> |
487 | <dl> |
|
|
488 | <dt><strong><a name="item__24term__3d_new_urxvt__5barg_2e_2e_2e_5d">$term = new urxvt [arg...]</a></strong><br /> |
|
|
489 | </dt> |
|
|
490 | <dd> |
|
|
491 | Creates a new terminal, very similar as if you had started it with |
|
|
492 | <code>system $binfile, arg...</code>. Croaks (and probably outputs an error message) |
|
|
493 | if the new instance couldn't be created. Returns <code>undef</code> if the new |
|
|
494 | instance didn't initialise perl, and the terminal object otherwise. The |
|
|
495 | <code>init</code> and <a href="#item_start"><code>start</code></a> hooks will be called during the call. |
|
|
496 | </dd> |
|
|
497 | <p></p> |
296 | <dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br /> |
498 | <dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br /> |
297 | </dt> |
499 | </dt> |
298 | <dd> |
500 | <dd> |
299 | Fatally aborts execution with the given error message. Avoid at all |
501 | Fatally aborts execution with the given error message. Avoid at all |
300 | costs! The only time this is acceptable is when the terminal process |
502 | costs! The only time this is acceptable is when the terminal process |
… | |
… | |
311 | <dd> |
513 | <dd> |
312 | <p>Using this function has the advantage that its output ends up in the |
514 | <p>Using this function has the advantage that its output ends up in the |
313 | correct place, e.g. on stderr of the connecting urxvtc client.</p> |
515 | correct place, e.g. on stderr of the connecting urxvtc client.</p> |
314 | </dd> |
516 | </dd> |
315 | <p></p> |
517 | <p></p> |
|
|
518 | <dt><strong><a name="item__24is_safe__3d_urxvt_3a_3asafe">$is_safe = urxvt::safe</a></strong><br /> |
|
|
519 | </dt> |
|
|
520 | <dd> |
|
|
521 | Returns true when it is safe to do potentially unsafe things, such as |
|
|
522 | evaluating perl code specified by the user. This is true when urxvt was |
|
|
523 | started setuid or setgid. |
|
|
524 | </dd> |
|
|
525 | <p></p> |
316 | <dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> |
526 | <dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> |
317 | </dt> |
527 | </dt> |
318 | <dd> |
528 | <dd> |
319 | Returns the ``current time'' (as per the event loop). |
529 | Returns the ``current time'' (as per the event loop). |
|
|
530 | </dd> |
|
|
531 | <p></p> |
|
|
532 | <dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br /> |
|
|
533 | </dt> |
|
|
534 | <dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
|
|
535 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
|
|
536 | Button4Mask, Button5Mask, AnyModifier</a></strong><br /> |
|
|
537 | </dt> |
|
|
538 | <dd> |
|
|
539 | Various constants for use in X calls and event processing. |
320 | </dd> |
540 | </dd> |
321 | <p></p></dl> |
541 | <p></p></dl> |
322 | <p> |
542 | <p> |
323 | </p> |
543 | </p> |
324 | <h2><a name="rendition">RENDITION</a></h2> |
544 | <h2><a name="rendition">RENDITION</a></h2> |
… | |
… | |
356 | </dt> |
576 | </dt> |
357 | <dd> |
577 | <dd> |
358 | Return the foreground/background colour index, respectively. |
578 | Return the foreground/background colour index, respectively. |
359 | </dd> |
579 | </dd> |
360 | <p></p> |
580 | <p></p> |
361 | <dt><strong><a name="item_set_fgcolor">$rend = urxvt::SET_FGCOLOR ($rend, $new_colour)</a></strong><br /> |
581 | <dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_fgcolor__24rend_2c__24n">$rend = urxvt::SET_FGCOLOR $rend, $new_colour</a></strong><br /> |
362 | </dt> |
582 | </dt> |
363 | <dt><strong><a name="item_set_bgcolor">$rend = urxvt::SET_BGCOLOR ($rend, $new_colour)</a></strong><br /> |
583 | <dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_bgcolor__24rend_2c__24n">$rend = urxvt::SET_BGCOLOR $rend, $new_colour</a></strong><br /> |
364 | </dt> |
584 | </dt> |
365 | <dd> |
585 | <dd> |
366 | Replace the foreground/background colour in the rendition mask with the |
586 | Replace the foreground/background colour in the rendition mask with the |
367 | specified one. |
587 | specified one. |
368 | </dd> |
588 | </dd> |
369 | <p></p> |
589 | <p></p> |
370 | <dt><strong><a name="item_get_custom">$value = urxvt::GET_CUSTOM ($rend)</a></strong><br /> |
590 | <dt><strong><a name="item__24value__3d_urxvt_3a_3aget_custom__24rend">$value = urxvt::GET_CUSTOM $rend</a></strong><br /> |
371 | </dt> |
591 | </dt> |
372 | <dd> |
592 | <dd> |
373 | Return the ``custom'' value: Every rendition has 5 bits for use by |
593 | Return the ``custom'' value: Every rendition has 5 bits for use by |
374 | extensions. They can be set and changed as you like and are initially |
594 | extensions. They can be set and changed as you like and are initially |
375 | zero. |
595 | zero. |
376 | </dd> |
596 | </dd> |
377 | <p></p> |
597 | <p></p> |
378 | <dt><strong><a name="item_set_custom">$rend = urxvt::SET_CUSTOM ($rend, $new_value)</a></strong><br /> |
598 | <dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_custom__24rend_2c__24ne">$rend = urxvt::SET_CUSTOM $rend, $new_value</a></strong><br /> |
379 | </dt> |
599 | </dt> |
380 | <dd> |
600 | <dd> |
381 | Change the custom value. |
601 | Change the custom value. |
382 | </dd> |
602 | </dd> |
383 | <p></p></dl> |
603 | <p></p></dl> |
384 | <p> |
604 | <p> |
385 | </p> |
605 | </p> |
|
|
606 | <h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2> |
|
|
607 | <p>The sole purpose of this class is to deliver an interface to the |
|
|
608 | <code>AnyEvent</code> module - any module using it will work inside urxvt without |
|
|
609 | further programming. The only exception is that you cannot wait on |
|
|
610 | condition variables, but non-blocking condvar use is ok. What this means |
|
|
611 | is that you cannot use blocking APIs, but the non-blocking variant should |
|
|
612 | work.</p> |
|
|
613 | <p> |
|
|
614 | </p> |
386 | <h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> |
615 | <h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> |
387 | <dl> |
616 | <dl> |
|
|
617 | <dt><strong><a name="item_destroy">$term->destroy</a></strong><br /> |
|
|
618 | </dt> |
|
|
619 | <dd> |
|
|
620 | Destroy the terminal object (close the window, free resources |
|
|
621 | etc.). Please note that rxvt will not exit as long as any event |
|
|
622 | watchers (timers, io watchers) are still active. |
|
|
623 | </dd> |
|
|
624 | <p></p> |
|
|
625 | <dt><strong><a name="item_option">$isset = $term->option ($optval[, $set])</a></strong><br /> |
|
|
626 | </dt> |
|
|
627 | <dd> |
|
|
628 | Returns true if the option specified by <code>$optval</code> is enabled, and |
|
|
629 | optionally change it. All option values are stored by name in the hash |
|
|
630 | <code>%urxvt::OPTION</code>. Options not enabled in this binary are not in the hash. |
|
|
631 | </dd> |
|
|
632 | <dd> |
|
|
633 | <p>Here is a a likely non-exhaustive list of option names, please see the |
|
|
634 | source file <em>/src/optinc.h</em> to see the actual list:</p> |
|
|
635 | </dd> |
|
|
636 | <dd> |
|
|
637 | <pre> |
|
|
638 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
|
|
639 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
|
|
640 | pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating |
|
|
641 | scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer |
|
|
642 | secondaryScreen secondaryScroll skipBuiltinGlyphs transparent |
|
|
643 | tripleclickwords utmpInhibit visualBell</pre> |
|
|
644 | </dd> |
|
|
645 | <p></p> |
388 | <dt><strong><a name="item_resource">$value = $term->resource ($name[, $newval])</a></strong><br /> |
646 | <dt><strong><a name="item_resource">$value = $term->resource ($name[, $newval])</a></strong><br /> |
389 | </dt> |
647 | </dt> |
390 | <dd> |
648 | <dd> |
391 | Returns the current resource value associated with a given name and |
649 | Returns the current resource value associated with a given name and |
392 | optionally sets a new value. Setting values is most useful in the <code>init</code> |
650 | optionally sets a new value. Setting values is most useful in the <code>init</code> |
… | |
… | |
406 | <p>Please note that resource strings will currently only be freed when the |
664 | <p>Please note that resource strings will currently only be freed when the |
407 | terminal is destroyed, so changing options frequently will eat memory.</p> |
665 | terminal is destroyed, so changing options frequently will eat memory.</p> |
408 | </dd> |
666 | </dd> |
409 | <dd> |
667 | <dd> |
410 | <p>Here is a a likely non-exhaustive list of resource names, not all of which |
668 | <p>Here is a a likely non-exhaustive list of resource names, not all of which |
411 | are supported in every build, please see the source to see the actual |
669 | are supported in every build, please see the source file <em>/src/rsinc.h</em> |
412 | list:</p> |
670 | to see the actual list:</p> |
413 | </dd> |
671 | </dd> |
414 | <dd> |
672 | <dd> |
415 | <pre> |
673 | <pre> |
416 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
674 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
417 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
675 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
… | |
… | |
425 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
683 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
426 | shade term_name title transparent transparent_all tripleclickwords |
684 | shade term_name title transparent transparent_all tripleclickwords |
427 | utmpInhibit visualBell</pre> |
685 | utmpInhibit visualBell</pre> |
428 | </dd> |
686 | </dd> |
429 | <p></p> |
687 | <p></p> |
|
|
688 | <dt><strong><a name="item_parse_keysym">$success = $term->parse_keysym ($keysym_spec, $command_string)</a></strong><br /> |
|
|
689 | </dt> |
|
|
690 | <dd> |
|
|
691 | Adds a keymap translation exactly as specified via a resource. See the |
|
|
692 | <code>keysym</code> resource in the <code>rxvt(1)</code> manpage. |
|
|
693 | </dd> |
|
|
694 | <p></p> |
430 | <dt><strong><a name="item_screen_rstyle">$rend = $term->screen_rstyle ([$new_rstyle])</a></strong><br /> |
695 | <dt><strong><a name="item_rstyle">$rend = $term->rstyle ([$new_rstyle])</a></strong><br /> |
431 | </dt> |
696 | </dt> |
432 | <dd> |
697 | <dd> |
433 | Return and optionally change the current rendition. Text thta is output by |
698 | Return and optionally change the current rendition. Text that is output by |
434 | the temrianl application will use this style. |
699 | the terminal application will use this style. |
435 | </dd> |
700 | </dd> |
436 | <p></p> |
701 | <p></p> |
437 | <dt><strong><a name="item_screen_cur">($row, $col) = $term->screen_cur ([$row, $col])</a></strong><br /> |
702 | <dt><strong><a name="item_screen_cur">($row, $col) = $term->screen_cur ([$row, $col])</a></strong><br /> |
438 | </dt> |
703 | </dt> |
439 | <dd> |
704 | <dd> |
… | |
… | |
462 | <dt><strong>$oldtext = $term->selection ([$newtext])</strong><br /> |
727 | <dt><strong>$oldtext = $term->selection ([$newtext])</strong><br /> |
463 | </dt> |
728 | </dt> |
464 | <dd> |
729 | <dd> |
465 | Return the current selection text and optionally replace it by <code>$newtext</code>. |
730 | Return the current selection text and optionally replace it by <code>$newtext</code>. |
466 | </dd> |
731 | </dd> |
|
|
732 | <p></p> |
|
|
733 | <dt><strong><a name="item_overlay_simple">$term->overlay_simple ($x, $y, $text)</a></strong><br /> |
|
|
734 | </dt> |
467 | <dd> |
735 | <dd> |
468 | <p>#=item $term->overlay ($x, $y, $text) |
|
|
469 | # |
|
|
470 | #Create a simple multi-line overlay box. See the next method for details. |
736 | Create a simple multi-line overlay box. See the next method for details. |
471 | # |
|
|
472 | #=cut</p> |
|
|
473 | </dd> |
|
|
474 | <dd> |
|
|
475 | <p>sub urxvt::term::scr_overlay { |
|
|
476 | die; |
|
|
477 | my ($self, $x, $y, $text) = @_;</p> |
|
|
478 | </dd> |
|
|
479 | <dd> |
|
|
480 | <pre> |
|
|
481 | my @lines = split /\n/, $text;</pre> |
|
|
482 | </dd> |
|
|
483 | <dd> |
|
|
484 | <pre> |
|
|
485 | my $w = 0; |
|
|
486 | for (map $self->strwidth ($_), @lines) { |
|
|
487 | $w = $_ if $w < $_; |
|
|
488 | }</pre> |
|
|
489 | </dd> |
|
|
490 | <dd> |
|
|
491 | <pre> |
|
|
492 | $self->scr_overlay_new ($x, $y, $w, scalar @lines); |
|
|
493 | $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; |
|
|
494 | }</pre> |
|
|
495 | </dd> |
737 | </dd> |
496 | <p></p> |
738 | <p></p> |
497 | <dt><strong><a name="item_overlay">$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br /> |
739 | <dt><strong><a name="item_overlay">$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br /> |
498 | </dt> |
740 | </dt> |
499 | <dd> |
741 | <dd> |
… | |
… | |
535 | </dt> |
777 | </dt> |
536 | <dd> |
778 | <dd> |
537 | If hidden, display the overlay again. |
779 | If hidden, display the overlay again. |
538 | </dd> |
780 | </dd> |
539 | <p></p></dl> |
781 | <p></p></dl> |
|
|
782 | <dt><strong>$popup = $term->popup ($event)</strong><br /> |
|
|
783 | </dt> |
|
|
784 | <dd> |
|
|
785 | Creates a new <code>urxvt::popup</code> object that implements a popup menu. The |
|
|
786 | <code>$event</code> <em>must</em> be the event causing the menu to pop up (a button event, |
|
|
787 | currently). |
|
|
788 | </dd> |
|
|
789 | <p></p> |
540 | <dt><strong><a name="item_strwidth">$cellwidth = $term->strwidth $string</a></strong><br /> |
790 | <dt><strong><a name="item_strwidth">$cellwidth = $term->strwidth ($string)</a></strong><br /> |
541 | </dt> |
791 | </dt> |
542 | <dd> |
792 | <dd> |
543 | Returns the number of screen-cells this string would need. Correctly |
793 | Returns the number of screen-cells this string would need. Correctly |
544 | accounts for wide and combining characters. |
794 | accounts for wide and combining characters. |
545 | </dd> |
795 | </dd> |
546 | <p></p> |
796 | <p></p> |
547 | <dt><strong><a name="item_locale_encode">$octets = $term->locale_encode $string</a></strong><br /> |
797 | <dt><strong><a name="item_locale_encode">$octets = $term->locale_encode ($string)</a></strong><br /> |
548 | </dt> |
798 | </dt> |
549 | <dd> |
799 | <dd> |
550 | Convert the given text string into the corresponding locale encoding. |
800 | Convert the given text string into the corresponding locale encoding. |
551 | </dd> |
801 | </dd> |
552 | <p></p> |
802 | <p></p> |
553 | <dt><strong><a name="item_locale_decode">$string = $term->locale_decode $octets</a></strong><br /> |
803 | <dt><strong><a name="item_locale_decode">$string = $term->locale_decode ($octets)</a></strong><br /> |
554 | </dt> |
804 | </dt> |
555 | <dd> |
805 | <dd> |
556 | Convert the given locale-encoded octets into a perl string. |
806 | Convert the given locale-encoded octets into a perl string. |
|
|
807 | </dd> |
|
|
808 | <p></p> |
|
|
809 | <dt><strong><a name="item_scr_xor_span">$term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])</a></strong><br /> |
|
|
810 | </dt> |
|
|
811 | <dd> |
|
|
812 | XORs the rendition values in the given span with the provided value |
|
|
813 | (default: <code>RS_RVid</code>). Useful in refresh hooks to provide effects similar |
|
|
814 | to the selection. |
|
|
815 | </dd> |
|
|
816 | <p></p> |
|
|
817 | <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 /> |
|
|
818 | </dt> |
|
|
819 | <dd> |
|
|
820 | Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing |
|
|
821 | whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults |
|
|
822 | to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines |
|
|
823 | it instead. |
|
|
824 | </dd> |
|
|
825 | <p></p> |
|
|
826 | <dt><strong><a name="item_scr_bell">$term->scr_bell</a></strong><br /> |
|
|
827 | </dt> |
|
|
828 | <dd> |
|
|
829 | Ring the bell! |
|
|
830 | </dd> |
|
|
831 | <p></p> |
|
|
832 | <dt><strong><a name="item_scr_add_lines">$term->scr_add_lines ($string)</a></strong><br /> |
|
|
833 | </dt> |
|
|
834 | <dd> |
|
|
835 | Write the given text string to the screen, as if output by the application |
|
|
836 | running inside the terminal. It may not contain command sequences (escape |
|
|
837 | codes), but is free to use line feeds, carriage returns and tabs. The |
|
|
838 | string is a normal text string, not in locale-dependent encoding. |
|
|
839 | </dd> |
|
|
840 | <dd> |
|
|
841 | <p>Normally its not a good idea to use this function, as programs might be |
|
|
842 | confused by changes in cursor position or scrolling. Its useful inside a |
|
|
843 | <code>on_add_lines</code> hook, though.</p> |
|
|
844 | </dd> |
|
|
845 | <p></p> |
|
|
846 | <dt><strong><a name="item_cmd_parse">$term->cmd_parse ($octets)</a></strong><br /> |
|
|
847 | </dt> |
|
|
848 | <dd> |
|
|
849 | Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the |
|
|
850 | locale-specific encoding of the terminal and can contain command sequences |
|
|
851 | (escape codes) that will be interpreted. |
557 | </dd> |
852 | </dd> |
558 | <p></p> |
853 | <p></p> |
559 | <dt><strong><a name="item_tt_write">$term->tt_write ($octets)</a></strong><br /> |
854 | <dt><strong><a name="item_tt_write">$term->tt_write ($octets)</a></strong><br /> |
560 | </dt> |
855 | </dt> |
561 | <dd> |
856 | <dd> |
562 | Write the octets given in <code>$data</code> to the tty (i.e. as program input). To |
857 | Write the octets given in <code>$data</code> to the tty (i.e. as program input). To |
563 | pass characters instead of octets, you should convert your strings first |
858 | pass characters instead of octets, you should convert your strings first |
564 | to the locale-specific encoding using <a href="#item_locale_encode"><code>$term->locale_encode</code></a>. |
859 | to the locale-specific encoding using <a href="#item_locale_encode"><code>$term->locale_encode</code></a>. |
565 | </dd> |
860 | </dd> |
566 | <p></p> |
861 | <p></p> |
|
|
862 | <dt><strong><a name="item_pty_ev_events">$old_events = $term->pty_ev_events ([$new_events])</a></strong><br /> |
|
|
863 | </dt> |
|
|
864 | <dd> |
|
|
865 | Replaces the event mask of the pty watcher by the given event mask. Can |
|
|
866 | be used to suppress input and output handling to the pty/tty. See the |
|
|
867 | description of <a href="#item_events"><code>urxvt::timer->events</code></a>. Make sure to always restore |
|
|
868 | the previous value. |
|
|
869 | </dd> |
|
|
870 | <p></p> |
|
|
871 | <dt><strong><a name="item_parent">$windowid = $term->parent</a></strong><br /> |
|
|
872 | </dt> |
|
|
873 | <dd> |
|
|
874 | Return the window id of the toplevel window. |
|
|
875 | </dd> |
|
|
876 | <p></p> |
|
|
877 | <dt><strong><a name="item_vt">$windowid = $term->vt</a></strong><br /> |
|
|
878 | </dt> |
|
|
879 | <dd> |
|
|
880 | Return the window id of the terminal window. |
|
|
881 | </dd> |
|
|
882 | <p></p> |
567 | <dt><strong><a name="item_width">$window_width = $term->width</a></strong><br /> |
883 | <dt><strong><a name="item_width">$window_width = $term->width</a></strong><br /> |
568 | </dt> |
884 | </dt> |
569 | <dt><strong><a name="item_height">$window_height = $term->height</a></strong><br /> |
885 | <dt><strong><a name="item_height">$window_height = $term->height</a></strong><br /> |
570 | </dt> |
886 | </dt> |
571 | <dt><strong><a name="item_fwidth">$font_width = $term->fwidth</a></strong><br /> |
887 | <dt><strong><a name="item_fwidth">$font_width = $term->fwidth</a></strong><br /> |
… | |
… | |
588 | </dt> |
904 | </dt> |
589 | <dt><strong><a name="item_nsaved">$lines_in_scrollback = $term->nsaved</a></strong><br /> |
905 | <dt><strong><a name="item_nsaved">$lines_in_scrollback = $term->nsaved</a></strong><br /> |
590 | </dt> |
906 | </dt> |
591 | <dd> |
907 | <dd> |
592 | Return various integers describing terminal characteristics. |
908 | Return various integers describing terminal characteristics. |
|
|
909 | </dd> |
|
|
910 | <p></p> |
|
|
911 | <dt><strong><a name="item_locale">$lc_ctype = $term->locale</a></strong><br /> |
|
|
912 | </dt> |
|
|
913 | <dd> |
|
|
914 | Returns the LC_CTYPE category string used by this rxvt-unicode. |
|
|
915 | </dd> |
|
|
916 | <p></p> |
|
|
917 | <dt><strong><a name="item_display_id">$x_display = $term->display_id</a></strong><br /> |
|
|
918 | </dt> |
|
|
919 | <dd> |
|
|
920 | Return the DISPLAY used by rxvt-unicode. |
|
|
921 | </dd> |
|
|
922 | <p></p> |
|
|
923 | <dt><strong><a name="item_modlevel3mask">$modifiermask = $term->ModLevel3Mask</a></strong><br /> |
|
|
924 | </dt> |
|
|
925 | <dt><strong><a name="item_modmetamask">$modifiermask = $term->ModMetaMask</a></strong><br /> |
|
|
926 | </dt> |
|
|
927 | <dt><strong><a name="item_modnumlockmask">$modifiermask = $term->ModNumLockMask</a></strong><br /> |
|
|
928 | </dt> |
|
|
929 | <dd> |
|
|
930 | Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often |
|
|
931 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
593 | </dd> |
932 | </dd> |
594 | <p></p> |
933 | <p></p> |
595 | <dt><strong><a name="item_view_start">$view_start = $term->view_start ([$newvalue])</a></strong><br /> |
934 | <dt><strong><a name="item_view_start">$view_start = $term->view_start ([$newvalue])</a></strong><br /> |
596 | </dt> |
935 | </dt> |
597 | <dd> |
936 | <dd> |
… | |
… | |
625 | line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful |
964 | line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful |
626 | to replace only parts of a line. The font index in the rendition will |
965 | to replace only parts of a line. The font index in the rendition will |
627 | automatically be updated.</p> |
966 | automatically be updated.</p> |
628 | </dd> |
967 | </dd> |
629 | <dd> |
968 | <dd> |
630 | <p><code>$text</code> is in a special encoding: tabs and wide characters that use more |
969 | <p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more |
631 | than one cell when displayed are padded with urxvt::NOCHAR characters |
970 | than one cell when displayed are padded with urxvt::NOCHAR characters |
632 | (<code>chr 65535</code>). Characters with combining characters and other characters |
971 | (<code>chr 65535</code>). Characters with combining characters and other characters |
633 | that do not fit into the normal tetx encoding will be replaced with |
972 | that do not fit into the normal tetx encoding will be replaced with |
634 | characters in the private use area.</p> |
973 | characters in the private use area.</p> |
635 | </dd> |
974 | </dd> |
… | |
… | |
637 | <p>You have to obey this encoding when changing text. The advantage is |
976 | <p>You have to obey this encoding when changing text. The advantage is |
638 | that <code>substr</code> and similar functions work on screen cells and not on |
977 | that <code>substr</code> and similar functions work on screen cells and not on |
639 | characters.</p> |
978 | characters.</p> |
640 | </dd> |
979 | </dd> |
641 | <dd> |
980 | <dd> |
642 | <p>The methods <code>$term->special_encode</code> and <a href="#item_special_decode"><code>$term->special_decode</code></a> |
981 | <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> |
643 | can be used to convert normal strings into this encoding and vice versa.</p> |
982 | can be used to convert normal strings into this encoding and vice versa.</p> |
644 | </dd> |
983 | </dd> |
645 | <p></p> |
984 | <p></p> |
646 | <dt><strong><a name="item_row_r">$rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br /> |
985 | <dt><strong><a name="item_row_r">$rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br /> |
647 | </dt> |
986 | </dt> |
… | |
… | |
680 | Create and return a new <code>urxvt::line</code> object that stores information |
1019 | Create and return a new <code>urxvt::line</code> object that stores information |
681 | about the logical line that row <code>$row_number</code> is part of. It supports the |
1020 | about the logical line that row <code>$row_number</code> is part of. It supports the |
682 | following methods: |
1021 | following methods: |
683 | </dd> |
1022 | </dd> |
684 | <dl> |
1023 | <dl> |
685 | <dt><strong><a name="item_t">$text = $line->t</a></strong><br /> |
1024 | <dt><strong><a name="item_t">$text = $line->t ([$new_text])</a></strong><br /> |
686 | </dt> |
1025 | </dt> |
687 | <dd> |
1026 | <dd> |
688 | Returns the full text of the line, similar to <a href="#item_row_t"><code>ROW_t</code></a> |
1027 | Returns or replaces the full text of the line, similar to <a href="#item_row_t"><code>ROW_t</code></a> |
689 | </dd> |
1028 | </dd> |
690 | <p></p> |
1029 | <p></p> |
691 | <dt><strong><a name="item_r">$rend = $line->r</a></strong><br /> |
1030 | <dt><strong><a name="item_r">$rend = $line->r ([$new_rend])</a></strong><br /> |
692 | </dt> |
1031 | </dt> |
693 | <dd> |
1032 | <dd> |
694 | Returns the full rendition array of the line, similar to <a href="#item_row_r"><code>ROW_r</code></a> |
1033 | Returns or replaces the full rendition array of the line, similar to <a href="#item_row_r"><code>ROW_r</code></a> |
695 | </dd> |
1034 | </dd> |
696 | <p></p> |
1035 | <p></p> |
697 | <dt><strong><a name="item_l">$length = $line->l</a></strong><br /> |
1036 | <dt><strong><a name="item_l">$length = $line->l</a></strong><br /> |
698 | </dt> |
1037 | </dt> |
699 | <dd> |
1038 | <dd> |
… | |
… | |
719 | </dt> |
1058 | </dt> |
720 | <dd> |
1059 | <dd> |
721 | Translates a string offset into terminal coordinates again. |
1060 | Translates a string offset into terminal coordinates again. |
722 | </dd> |
1061 | </dd> |
723 | <p></p></dl> |
1062 | <p></p></dl> |
724 | <dt><strong>($row, $col) = $line->coord_of ($offset) |
1063 | <dt><strong><a name="item_special_encode">$text = $term->special_encode $string</a></strong><br /> |
725 | =item $text = $term->special_encode $string</strong><br /> |
|
|
726 | </dt> |
1064 | </dt> |
727 | <dd> |
1065 | <dd> |
728 | Converts a perl string into the special encoding used by rxvt-unicode, |
1066 | Converts a perl string into the special encoding used by rxvt-unicode, |
729 | where one character corresponds to one screen cell. See |
1067 | where one character corresponds to one screen cell. See |
730 | <a href="#item_row_t"><code>$term->ROW_t</code></a> for details. |
1068 | <a href="#item_row_t"><code>$term->ROW_t</code></a> for details. |
… | |
… | |
733 | <dt><strong><a name="item_special_decode">$string = $term->special_decode $text</a></strong><br /> |
1071 | <dt><strong><a name="item_special_decode">$string = $term->special_decode $text</a></strong><br /> |
734 | </dt> |
1072 | </dt> |
735 | <dd> |
1073 | <dd> |
736 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1074 | Converts rxvt-unicodes text reprsentation into a perl string. See |
737 | <a href="#item_row_t"><code>$term->ROW_t</code></a> for details. |
1075 | <a href="#item_row_t"><code>$term->ROW_t</code></a> for details. |
|
|
1076 | </dd> |
|
|
1077 | <p></p> |
|
|
1078 | <dt><strong><a name="item_grab_button">$success = $term->grab_button ($button, $modifiermask)</a></strong><br /> |
|
|
1079 | </dt> |
|
|
1080 | <dd> |
|
|
1081 | Registers a synchronous button grab. See the XGrabButton manpage. |
|
|
1082 | </dd> |
|
|
1083 | <p></p> |
|
|
1084 | <dt><strong><a name="item_grab">$success = $term->grab ($eventtime[, $sync])</a></strong><br /> |
|
|
1085 | </dt> |
|
|
1086 | <dd> |
|
|
1087 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
|
|
1088 | synchronous (<code>$sync</code> is true). Also remembers the grab timestampe. |
|
|
1089 | </dd> |
|
|
1090 | <p></p> |
|
|
1091 | <dt><strong><a name="item_allow_events_async">$term->allow_events_async</a></strong><br /> |
|
|
1092 | </dt> |
|
|
1093 | <dd> |
|
|
1094 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
|
|
1095 | </dd> |
|
|
1096 | <p></p> |
|
|
1097 | <dt><strong><a name="item_allow_events_sync">$term->allow_events_sync</a></strong><br /> |
|
|
1098 | </dt> |
|
|
1099 | <dd> |
|
|
1100 | Calls XAllowEvents with SyncBoth for the most recent grab. |
|
|
1101 | </dd> |
|
|
1102 | <p></p> |
|
|
1103 | <dt><strong><a name="item_allow_events_replay">$term->allow_events_replay</a></strong><br /> |
|
|
1104 | </dt> |
|
|
1105 | <dd> |
|
|
1106 | Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most |
|
|
1107 | recent grab. |
|
|
1108 | </dd> |
|
|
1109 | <p></p> |
|
|
1110 | <dt><strong><a name="item_ungrab">$term->ungrab</a></strong><br /> |
|
|
1111 | </dt> |
|
|
1112 | <dd> |
|
|
1113 | Calls XUngrab for the most recent grab. Is called automatically on |
|
|
1114 | evaluation errors, as it is better to lose the grab in the error case as |
|
|
1115 | the session. |
|
|
1116 | </dd> |
|
|
1117 | <p></p></dl> |
|
|
1118 | <p> |
|
|
1119 | </p> |
|
|
1120 | <h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> |
|
|
1121 | <dl> |
|
|
1122 | <dt><strong><a name="item_add_title">$popup->add_title ($title)</a></strong><br /> |
|
|
1123 | </dt> |
|
|
1124 | <dd> |
|
|
1125 | Adds a non-clickable title to the popup. |
|
|
1126 | </dd> |
|
|
1127 | <p></p> |
|
|
1128 | <dt><strong><a name="item_add_separator">$popup->add_separator ([$sepchr])</a></strong><br /> |
|
|
1129 | </dt> |
|
|
1130 | <dd> |
|
|
1131 | Creates a separator, optionally using the character given as <code>$sepchr</code>. |
|
|
1132 | </dd> |
|
|
1133 | <p></p> |
|
|
1134 | <dt><strong><a name="item_add_button">$popup->add_button ($text, $cb)</a></strong><br /> |
|
|
1135 | </dt> |
|
|
1136 | <dd> |
|
|
1137 | Adds a clickable button to the popup. <code>$cb</code> is called whenever it is |
|
|
1138 | selected. |
|
|
1139 | </dd> |
|
|
1140 | <p></p> |
|
|
1141 | <dt><strong><a name="item_add_toggle">$popup->add_toggle ($text, $cb, $initial_value)</a></strong><br /> |
|
|
1142 | </dt> |
|
|
1143 | <dd> |
|
|
1144 | Adds a toggle/checkbox item to the popup. Teh callback gets called |
|
|
1145 | whenever it gets toggled, with a boolean indicating its value as its first |
|
|
1146 | argument. |
|
|
1147 | </dd> |
|
|
1148 | <p></p> |
|
|
1149 | <dt><strong>$popup->show</strong><br /> |
|
|
1150 | </dt> |
|
|
1151 | <dd> |
|
|
1152 | Displays the popup (which is initially hidden). |
738 | </dd> |
1153 | </dd> |
739 | <p></p></dl> |
1154 | <p></p></dl> |
740 | <p> |
1155 | <p> |
741 | </p> |
1156 | </p> |
742 | <h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> |
1157 | <h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> |
… | |
… | |
810 | <pre> |
1225 | <pre> |
811 | $term->{socket} = ... |
1226 | $term->{socket} = ... |
812 | $term->{iow} = urxvt::iow |
1227 | $term->{iow} = urxvt::iow |
813 | ->new |
1228 | ->new |
814 | ->fd (fileno $term->{socket}) |
1229 | ->fd (fileno $term->{socket}) |
815 | ->events (1) # wait for read data |
1230 | ->events (urxvt::EVENT_READ) |
816 | ->start |
1231 | ->start |
817 | ->cb (sub { |
1232 | ->cb (sub { |
818 | my ($iow, $revents) = @_; |
1233 | my ($iow, $revents) = @_; |
819 | # $revents must be 1 here, no need to check |
1234 | # $revents must be 1 here, no need to check |
820 | sysread $term->{socket}, my $buf, 8192 |
1235 | sysread $term->{socket}, my $buf, 8192 |
… | |
… | |
841 | </dd> |
1256 | </dd> |
842 | <p></p> |
1257 | <p></p> |
843 | <dt><strong><a name="item_events">$iow = $iow->events ($eventmask)</a></strong><br /> |
1258 | <dt><strong><a name="item_events">$iow = $iow->events ($eventmask)</a></strong><br /> |
844 | </dt> |
1259 | </dt> |
845 | <dd> |
1260 | <dd> |
846 | Set the event mask to watch. Bit #0 (value <code>1</code>) enables watching for read |
1261 | Set the event mask to watch. The only allowed values are |
847 | data, Bit #1 (value <code>2</code>) enables watching for write data. |
1262 | <code>urxvt::EVENT_READ</code> and <code>urxvt::EVENT_WRITE</code>, which might be ORed |
|
|
1263 | together, or <code>urxvt::EVENT_NONE</code>. |
848 | </dd> |
1264 | </dd> |
849 | <p></p> |
1265 | <p></p> |
850 | <dt><strong>$iow = $iow->start</strong><br /> |
1266 | <dt><strong>$iow = $iow->start</strong><br /> |
851 | </dt> |
1267 | </dt> |
852 | <dd> |
1268 | <dd> |
… | |
… | |
867 | </p> |
1283 | </p> |
868 | <h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> |
1284 | <h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> |
869 | <p>This variable controls the verbosity level of the perl extension. Higher |
1285 | <p>This variable controls the verbosity level of the perl extension. Higher |
870 | numbers indicate more verbose output.</p> |
1286 | numbers indicate more verbose output.</p> |
871 | <dl> |
1287 | <dl> |
872 | <dt><strong><a name="item__3d0__2d_only_fatal_messages">=0 - only fatal messages</a></strong><br /> |
1288 | <dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br /> |
873 | </dt> |
1289 | </dt> |
874 | <dt><strong><a name="item__3d3__2d_script_loading_and_management">=3 - script loading and management</a></strong><br /> |
1290 | <dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">>= 3 - script loading and management</a></strong><br /> |
875 | </dt> |
1291 | </dt> |
876 | <dt><strong><a name="item__3d10__2d_all_events_received">=10 - all events received</a></strong><br /> |
1292 | <dt><strong><a name="item__3e_3d10__2d_all_events_received">>=10 - all events received</a></strong><br /> |
877 | </dt> |
1293 | </dt> |
878 | </dl> |
1294 | </dl> |
879 | <p> |
1295 | <p> |
880 | </p> |
1296 | </p> |
881 | <hr /> |
1297 | <hr /> |