… | |
… | |
13 | <ul> |
13 | <ul> |
14 | |
14 | |
15 | <li><a href="#name">NAME</a></li> |
15 | <li><a href="#name">NAME</a></li> |
16 | <li><a href="#synopsis">SYNOPSIS</a></li> |
16 | <li><a href="#synopsis">SYNOPSIS</a></li> |
17 | <li><a href="#description">DESCRIPTION</a></li> |
17 | <li><a href="#description">DESCRIPTION</a></li> |
|
|
18 | <li><a href="#prepackaged_extensions">PREPACKAGED EXTENSIONS</a></li> |
|
|
19 | <li><a href="#api_documentation">API DOCUMENTATION</a></li> |
18 | <ul> |
20 | <ul> |
19 | |
21 | |
20 | <li><a href="#prepackaged_extensions">Prepackaged Extensions</a></li> |
|
|
21 | <li><a href="#general_api_considerations">General API Considerations</a></li> |
22 | <li><a href="#general_api_considerations">General API Considerations</a></li> |
|
|
23 | <li><a href="#extension_objects">Extension Objects</a></li> |
22 | <li><a href="#hooks">Hooks</a></li> |
24 | <li><a href="#hooks">Hooks</a></li> |
23 | <li><a href="#variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></li> |
25 | <li><a href="#variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></li> |
24 | <li><a href="#functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></li> |
26 | <li><a href="#functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></li> |
25 | <li><a href="#rendition">RENDITION</a></li> |
27 | <li><a href="#rendition">RENDITION</a></li> |
26 | <li><a href="#the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></li> |
28 | <li><a href="#the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></li> |
27 | <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> |
28 | <li><a href="#the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></li> |
30 | <li><a href="#the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></li> |
29 | <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> |
30 | <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> |
|
|
33 | <li><a href="#the_urxvt__iw_class">The <code>urxvt::iw</code> Class</a></li> |
|
|
34 | <li><a href="#the_urxvt__pw_class">The <code>urxvt::pw</code> Class</a></li> |
31 | </ul> |
35 | </ul> |
32 | |
36 | |
33 | <li><a href="#environment">ENVIRONMENT</a></li> |
37 | <li><a href="#environment">ENVIRONMENT</a></li> |
34 | <ul> |
38 | <ul> |
35 | |
39 | |
… | |
… | |
71 | thus must be encoded as UTF-8.</p> |
75 | thus must be encoded as UTF-8.</p> |
72 | <p>Each script will only ever be loaded once, even in rxvtd, where |
76 | <p>Each script will only ever be loaded once, even in rxvtd, where |
73 | scripts will be shared (but not enabled) for all terminals.</p> |
77 | scripts will be shared (but not enabled) for all terminals.</p> |
74 | <p> |
78 | <p> |
75 | </p> |
79 | </p> |
76 | <h2><a name="prepackaged_extensions">Prepackaged Extensions</a></h2> |
80 | <hr /> |
|
|
81 | <h1><a name="prepackaged_extensions">PREPACKAGED EXTENSIONS</a></h1> |
77 | <p>This section describes the extensiosn delivered with this version. You can |
82 | <p>This section describes the extensions delivered with this release. You can |
78 | find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> |
83 | find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> |
79 | <p>You can activate them like this:</p> |
84 | <p>You can activate them like this:</p> |
80 | <pre> |
85 | <pre> |
81 | rxvt -pe <extensionname></pre> |
86 | rxvt -pe <extensionname></pre> |
|
|
87 | <p>Or by adding them to the resource for extensions loaded by default:</p> |
|
|
88 | <pre> |
|
|
89 | URxvt.perl-ext-common: default,automove-background,selection-autotransform</pre> |
82 | <dl> |
90 | <dl> |
83 | <dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br /> |
91 | <dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br /> |
84 | </dt> |
92 | </dt> |
85 | <dd> |
93 | <dd> |
86 | Intelligent selection. This extension tries to be more intelligent when |
94 | (More) intelligent selection. This extension tries to be more intelligent |
87 | the user extends selections (double-click). Right now, it tries to select |
95 | when the user extends selections (double-click and further clicks). Right |
88 | urls and complete shell-quoted arguments, which is very convenient, too, |
96 | now, it tries to select words, urls and complete shell-quoted |
89 | if your <em>ls</em> supports <code>--quoting-style=shell</code>. |
97 | arguments, which is very convenient, too, if your <em>ls</em> supports |
90 | </dd> |
98 | <code>--quoting-style=shell</code>. |
91 | <dd> |
99 | </dd> |
92 | <p>It also offers the following bindable event:</p> |
100 | <dd> |
|
|
101 | <p>A double-click usually selects the word under the cursor, further clicks |
|
|
102 | will enlarge the selection.</p> |
|
|
103 | </dd> |
|
|
104 | <dd> |
|
|
105 | <p>The selection works by trying to match a number of regexes and displaying |
|
|
106 | them in increasing order of length. You can add your own regexes by |
|
|
107 | specifying resources of the form:</p> |
|
|
108 | </dd> |
|
|
109 | <dd> |
|
|
110 | <pre> |
|
|
111 | URxvt.selection.pattern-0: perl-regex |
|
|
112 | URxvt.selection.pattern-1: perl-regex |
|
|
113 | ...</pre> |
|
|
114 | </dd> |
|
|
115 | <dd> |
|
|
116 | <p>The index number (0, 1...) must not have any holes, and each regex must |
|
|
117 | contain at least one pair of capturing parentheses, which will be used for |
|
|
118 | the match. For example, the followign adds a regex that matches everything |
|
|
119 | between two vertical bars:</p> |
|
|
120 | </dd> |
|
|
121 | <dd> |
|
|
122 | <pre> |
|
|
123 | URxvt.selection.pattern-0: \\|([^|]+)\\|</pre> |
|
|
124 | </dd> |
|
|
125 | <dd> |
|
|
126 | <p>You can look at the source of the selection extension to see more |
|
|
127 | interesting uses, such as parsing a line from beginning to end.</p> |
|
|
128 | </dd> |
|
|
129 | <dd> |
|
|
130 | <p>This extension also offers following bindable keyboard commands:</p> |
93 | </dd> |
131 | </dd> |
94 | <dl> |
132 | <dl> |
95 | <dt><strong><a name="item_rot13">rot13</a></strong><br /> |
133 | <dt><strong><a name="item_rot13">rot13</a></strong><br /> |
96 | </dt> |
134 | </dt> |
97 | <dd> |
135 | <dd> |
… | |
… | |
111 | <p></p> |
149 | <p></p> |
112 | <dt><strong>selection-popup (enabled by default)</strong><br /> |
150 | <dt><strong>selection-popup (enabled by default)</strong><br /> |
113 | </dt> |
151 | </dt> |
114 | <dd> |
152 | <dd> |
115 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
153 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
116 | text into various other formats/action. |
154 | text into various other formats/action (such as uri unescaping, perl |
117 | </dd> |
155 | evaluation, web-browser starting etc.), depending on content. |
118 | <p></p> |
|
|
119 | <dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> |
|
|
120 | </dt> |
|
|
121 | <dd> |
156 | </dd> |
122 | Displays a digital clock using the built-in overlay. |
157 | <dd> |
|
|
158 | <p>Other extensions can extend this popup menu by pushing a code reference |
|
|
159 | onto <code>@{ $term-</code>{selection_popup_hook} }>, that is called whenever the |
|
|
160 | popup is displayed.</p> |
|
|
161 | </dd> |
|
|
162 | <dd> |
|
|
163 | <p>It's sole argument is the popup menu, which can be modified. The selection |
|
|
164 | is in <code>$_</code>, which can be used to decide wether to add something or not. |
|
|
165 | It should either return nothing or a string and a code reference. The |
|
|
166 | string will be used as button text and the code reference will be called |
|
|
167 | when the button gets activated and should transform <code>$_</code>.</p> |
|
|
168 | </dd> |
|
|
169 | <dd> |
|
|
170 | <p>The following will add an entry <code>a to b</code> that transforms all <code>a</code>s in |
|
|
171 | the selection to <code>b</code>s, but only if the selection currently contains any |
|
|
172 | <code>a</code>s:</p> |
|
|
173 | </dd> |
|
|
174 | <dd> |
|
|
175 | <pre> |
|
|
176 | push @{ $self->{term}{selection_popup_hook} }, sub { |
|
|
177 | /a/ ? ("a to be" => sub { s/a/b/g } |
|
|
178 | : () |
|
|
179 | };</pre> |
|
|
180 | </dd> |
|
|
181 | <p></p> |
|
|
182 | <dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback<hotkey> (enabled by default)</a></strong><br /> |
|
|
183 | </dt> |
|
|
184 | <dd> |
|
|
185 | Adds regex search functionality to the scrollback buffer, triggered |
|
|
186 | by a hotkey (default: <code>M-s</code>). While in search mode, normal terminal |
|
|
187 | input/output is suspended and a regex is displayed at the bottom of the |
|
|
188 | screen. |
|
|
189 | </dd> |
|
|
190 | <dd> |
|
|
191 | <p>Inputting characters appends them to the regex and continues incremental |
|
|
192 | search. <code>BackSpace</code> removes a character from the regex, <code>Up</code> and <code>Down</code> |
|
|
193 | search upwards/downwards in the scrollback buffer, <code>End</code> jumps to the |
|
|
194 | bottom. <code>Escape</code> leaves search mode and returns to the point where search |
|
|
195 | was started, while <code>Enter</code> or <code>Return</code> stay at the current position and |
|
|
196 | additionally stores the first match in the current line into the primary |
|
|
197 | selection.</p> |
|
|
198 | </dd> |
|
|
199 | <p></p> |
|
|
200 | <dt><strong><a name="item_selection_2dautotransform">selection-autotransform</a></strong><br /> |
|
|
201 | </dt> |
|
|
202 | <dd> |
|
|
203 | This selection allows you to do automatic transforms on a selection |
|
|
204 | whenever a selection is made. |
|
|
205 | </dd> |
|
|
206 | <dd> |
|
|
207 | <p>It works by specifying perl snippets (most useful is a single <code>s///</code> |
|
|
208 | operator) that modify <code>$_</code> as resources:</p> |
|
|
209 | </dd> |
|
|
210 | <dd> |
|
|
211 | <pre> |
|
|
212 | URxvt.selection-autotransform.0: transform |
|
|
213 | URxvt.selection-autotransform.1: transform |
|
|
214 | ...</pre> |
|
|
215 | </dd> |
|
|
216 | <dd> |
|
|
217 | <p>For example, the following will transform selections of the form |
|
|
218 | <code>filename:number</code>, often seen in compiler messages, into <code>vi +$filename |
|
|
219 | $word</code>:</p> |
|
|
220 | </dd> |
|
|
221 | <dd> |
|
|
222 | <pre> |
|
|
223 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/</pre> |
|
|
224 | </dd> |
|
|
225 | <dd> |
|
|
226 | <p>And this example matches the same,but replaces it with vi-commands you can |
|
|
227 | paste directly into your (vi :) editor:</p> |
|
|
228 | </dd> |
|
|
229 | <dd> |
|
|
230 | <pre> |
|
|
231 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/</pre> |
|
|
232 | </dd> |
|
|
233 | <dd> |
|
|
234 | <p>Of course, this can be modified to suit your needs and your editor :)</p> |
|
|
235 | </dd> |
|
|
236 | <dd> |
|
|
237 | <p>To expand the example above to typical perl error messages (``XXX at |
|
|
238 | FILENAME line YYY.''), you need a slightly more elaborate solution:</p> |
|
|
239 | </dd> |
|
|
240 | <dd> |
|
|
241 | <pre> |
|
|
242 | URxvt.selection.pattern-0: ( at .*? line \\d+[,.]) |
|
|
243 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/</pre> |
|
|
244 | </dd> |
|
|
245 | <dd> |
|
|
246 | <p>The first line tells the selection code to treat the unchanging part of |
|
|
247 | every error message as a selection pattern, and the second line transforms |
|
|
248 | the message into vi commands to load the file.</p> |
|
|
249 | </dd> |
|
|
250 | <p></p> |
|
|
251 | <dt><strong><a name="item_readline">readline</a></strong><br /> |
|
|
252 | </dt> |
|
|
253 | <dd> |
|
|
254 | A support package that tries to make editing with readline easier. At the |
|
|
255 | moment, it reacts to clicking with the left mouse button by trying to |
|
|
256 | move the text cursor to this position. It does so by generating as many |
|
|
257 | cursor-left or cursor-right keypresses as required (the this only works |
|
|
258 | for programs that correctly support wide characters). |
|
|
259 | </dd> |
|
|
260 | <dd> |
|
|
261 | <p>It only works when clicking into the same line (possibly extended over |
|
|
262 | multiple rows) as the text cursor and on the primary screen, to reduce the |
|
|
263 | risk of misinterpreting. The normal selection isn't disabled, so quick |
|
|
264 | successive clicks might interfere with selection creation in harmless |
|
|
265 | ways.</p> |
|
|
266 | </dd> |
|
|
267 | <p></p> |
|
|
268 | <dt><strong><a name="item_tabbed">tabbed</a></strong><br /> |
|
|
269 | </dt> |
|
|
270 | <dd> |
|
|
271 | This transforms the terminal into a tabbar with additional terminals, that |
|
|
272 | is, it implements what is commonly refered to as ``tabbed terminal''. The topmost line |
|
|
273 | displays a ``[NEW]'' button, which, when clicked, will add a new tab, followed by one |
|
|
274 | button per tab. |
|
|
275 | </dd> |
|
|
276 | <dd> |
|
|
277 | <p>Clicking a button will activate that tab. Pressing <strong>Shift-Left</strong> and |
|
|
278 | <strong>Shift-Right</strong> will switch to the tab left or right of the current one, |
|
|
279 | while <strong>Shift-Down</strong> creates a new tab.</p> |
123 | </dd> |
280 | </dd> |
124 | <p></p> |
281 | <p></p> |
125 | <dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> |
282 | <dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> |
126 | </dt> |
283 | </dt> |
127 | <dd> |
284 | <dd> |
128 | Uses per-line display filtering (<code>on_line_update</code>) to underline urls. |
285 | Uses per-line display filtering (<code>on_line_update</code>) to underline urls and |
|
|
286 | make them clickable. When middle-clicked, the program specified in the |
|
|
287 | resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with |
|
|
288 | the URL as first argument. |
|
|
289 | </dd> |
|
|
290 | <p></p> |
|
|
291 | <dt><strong><a name="item_automove_2dbackground">automove-background</a></strong><br /> |
|
|
292 | </dt> |
|
|
293 | <dd> |
|
|
294 | This is basically a one-line extension that dynamically changes the background pixmap offset |
|
|
295 | to the window position, in effect creating the same effect as pseudo transparency with |
|
|
296 | a custom pixmap. No scaling is supported in this mode. Exmaple: |
|
|
297 | </dd> |
|
|
298 | <dd> |
|
|
299 | <pre> |
|
|
300 | rxvt -pixmap background.xpm -pe automove-background</pre> |
129 | </dd> |
301 | </dd> |
130 | <p></p> |
302 | <p></p> |
131 | <dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br /> |
303 | <dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br /> |
132 | </dt> |
304 | </dt> |
133 | <dd> |
305 | <dd> |
134 | A not very useful example of filtering all text output to the terminal, |
306 | A not very useful example of filtering all text output to the terminal, |
135 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
307 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
136 | similar-looking ascii character. |
308 | similar-looking ascii character. |
137 | </dd> |
309 | </dd> |
138 | <p></p> |
310 | <p></p> |
|
|
311 | <dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> |
|
|
312 | </dt> |
|
|
313 | <dd> |
|
|
314 | Displays a digital clock using the built-in overlay. |
|
|
315 | </dd> |
|
|
316 | <p></p> |
139 | <dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> |
317 | <dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> |
140 | </dt> |
318 | </dt> |
141 | <dd> |
319 | <dd> |
142 | Displays a very simple digital clock in the upper right corner of the |
320 | Displays a very simple digital clock in the upper right corner of the |
143 | window. Illustrates overwriting the refresh callbacks to create your own |
321 | window. Illustrates overwriting the refresh callbacks to create your own |
144 | overlays or changes. |
322 | overlays or changes. |
145 | </dd> |
323 | </dd> |
|
|
324 | <p></p> |
|
|
325 | <dt><strong><a name="item_selection_2dpastebin">selection-pastebin</a></strong><br /> |
|
|
326 | </dt> |
|
|
327 | <dd> |
|
|
328 | This is a little rarely useful extension that Uploads the selection as |
|
|
329 | textfile to a remote site (or does other things). (The implementation is |
|
|
330 | not currently secure for use in a multiuser environment as it writes to |
|
|
331 | <em>/tmp</em> directly.). |
|
|
332 | </dd> |
|
|
333 | <dd> |
|
|
334 | <p>It listens to the <code>selection-pastebin:remote-pastebin</code> keyboard command, |
|
|
335 | i.e.</p> |
|
|
336 | </dd> |
|
|
337 | <dd> |
|
|
338 | <pre> |
|
|
339 | URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin</pre> |
|
|
340 | </dd> |
|
|
341 | <dd> |
|
|
342 | <p>Pressing this combination runs a command with <code>%</code> replaced by the name of |
|
|
343 | the textfile. This command can be set via a resource:</p> |
|
|
344 | </dd> |
|
|
345 | <dd> |
|
|
346 | <pre> |
|
|
347 | URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.</pre> |
|
|
348 | </dd> |
|
|
349 | <dd> |
|
|
350 | <p>And the default is likely not useful to anybody but the few people around |
|
|
351 | here :)</p> |
|
|
352 | </dd> |
|
|
353 | <dd> |
|
|
354 | <p>The name of the textfile is the hex encoded md5 sum of the selection, so |
|
|
355 | the same content should lead to the same filename.</p> |
|
|
356 | </dd> |
|
|
357 | <dd> |
|
|
358 | <p>After a successful upload the selection will be replaced by the text given |
|
|
359 | in the <code>selection-pastebin-url</code> resource (again, the % is the placeholder |
|
|
360 | for the filename):</p> |
|
|
361 | </dd> |
|
|
362 | <dd> |
|
|
363 | <pre> |
|
|
364 | URxvt.selection-pastebin.url: <a href="http://www.ta-sa.org/files/txt/%">http://www.ta-sa.org/files/txt/%</a></pre> |
|
|
365 | </dd> |
146 | <p></p></dl> |
366 | <p></p></dl> |
|
|
367 | <p> |
|
|
368 | </p> |
|
|
369 | <hr /> |
|
|
370 | <h1><a name="api_documentation">API DOCUMENTATION</a></h1> |
147 | <p> |
371 | <p> |
148 | </p> |
372 | </p> |
149 | <h2><a name="general_api_considerations">General API Considerations</a></h2> |
373 | <h2><a name="general_api_considerations">General API Considerations</a></h2> |
150 | <p>All objects (such as terminals, time watchers etc.) are typical |
374 | <p>All objects (such as terminals, time watchers etc.) are typical |
151 | reference-to-hash objects. The hash can be used to store anything you |
375 | reference-to-hash objects. The hash can be used to store anything you |
… | |
… | |
161 | <dl> |
385 | <dl> |
162 | <dt><strong><a name="item__24text">$text</a></strong><br /> |
386 | <dt><strong><a name="item__24text">$text</a></strong><br /> |
163 | </dt> |
387 | </dt> |
164 | <dd> |
388 | <dd> |
165 | Rxvt-unicodes special way of encoding text, where one ``unicode'' character |
389 | Rxvt-unicodes special way of encoding text, where one ``unicode'' character |
166 | always represents one screen cell. See <em>row_t</em> for a discussion of this format. |
390 | always represents one screen cell. See <a href="#item_row_t">ROW_t</a> for a discussion of this format. |
167 | </dd> |
391 | </dd> |
168 | <p></p> |
392 | <p></p> |
169 | <dt><strong><a name="item__24string">$string</a></strong><br /> |
393 | <dt><strong><a name="item__24string">$string</a></strong><br /> |
170 | </dt> |
394 | </dt> |
171 | <dd> |
395 | <dd> |
… | |
… | |
181 | locale-specific way. |
405 | locale-specific way. |
182 | </dd> |
406 | </dd> |
183 | <p></p></dl> |
407 | <p></p></dl> |
184 | <p> |
408 | <p> |
185 | </p> |
409 | </p> |
|
|
410 | <h2><a name="extension_objects">Extension Objects</a></h2> |
|
|
411 | <p>Very perl extension is a perl class. A separate perl object is created |
|
|
412 | for each terminal and each extension and passed as the first parameter to |
|
|
413 | hooks. So extensions can use their <code>$self</code> object without having to think |
|
|
414 | about other extensions, with the exception of methods and members that |
|
|
415 | begin with an underscore character <code>_</code>: these are reserved for internal |
|
|
416 | use.</p> |
|
|
417 | <p>Although it isn't a <code>urxvt::term</code> object, you can call all methods of the |
|
|
418 | <code>urxvt::term</code> class on this object.</p> |
|
|
419 | <p>It has the following methods and data members:</p> |
|
|
420 | <dl> |
|
|
421 | <dt><strong><a name="item__24urxvt_term__3d__24self_2d_3e_7bterm_7d">$urxvt_term = $self->{term}</a></strong><br /> |
|
|
422 | </dt> |
|
|
423 | <dd> |
|
|
424 | Returns the <code>urxvt::term</code> object associated with this instance of the |
|
|
425 | extension. This member <em>must not</em> be changed in any way. |
|
|
426 | </dd> |
|
|
427 | <p></p> |
|
|
428 | <dt><strong><a name="item_enable">$self->enable ($hook_name => $cb, [$hook_name => $cb..])</a></strong><br /> |
|
|
429 | </dt> |
|
|
430 | <dd> |
|
|
431 | Dynamically enable the given hooks (named without the <code>on_</code> prefix) for |
|
|
432 | this extension, replacing any previous hook. This is useful when you want |
|
|
433 | to overwrite time-critical hooks only temporarily. |
|
|
434 | </dd> |
|
|
435 | <p></p> |
|
|
436 | <dt><strong><a name="item_disable">$self->disable ($hook_name[, $hook_name..])</a></strong><br /> |
|
|
437 | </dt> |
|
|
438 | <dd> |
|
|
439 | Dynamically disable the given hooks. |
|
|
440 | </dd> |
|
|
441 | <p></p></dl> |
|
|
442 | <p> |
|
|
443 | </p> |
186 | <h2><a name="hooks">Hooks</a></h2> |
444 | <h2><a name="hooks">Hooks</a></h2> |
187 | <p>The following subroutines can be declared in extension files, and will be |
445 | <p>The following subroutines can be declared in extension files, and will be |
188 | called whenever the relevant event happens.</p> |
446 | called whenever the relevant event happens.</p> |
189 | <p>The first argument passed to them is an object private to each terminal |
447 | <p>The first argument passed to them is an extension oject as described in |
190 | and extension package. You can call all <code>urxvt::term</code> methods on it, but |
448 | the in the <code>Extension Objects</code> section.</p> |
191 | its not a real <code>urxvt::term</code> object. Instead, the real <code>urxvt::term</code> |
449 | <p><strong>All</strong> of these hooks must return a boolean value. If any of the called |
192 | object that is shared between all packages is stored in the <code>term</code> |
450 | hooks returns true, then the event counts as being <em>consumed</em>, and the |
193 | member. It is, however, blessed intot he package of the extension script, |
|
|
194 | so for all practical purposes you can treat an extension script as a class.</p> |
|
|
195 | <p>All of them must return a boolean value. If it is true, then the event |
|
|
196 | counts as being <em>consumed</em>, and the invocation of other hooks is skipped, |
|
|
197 | and the relevant action might not be carried out by the C++ code.</p> |
451 | relevant action might not be carried out by the C++ code.</p> |
198 | <p>When in doubt, return a false value (preferably <code>()</code>).</p> |
452 | <p><em>When in doubt, return a false value (preferably <code>()</code>). </em>></p> |
199 | <dl> |
453 | <dl> |
200 | <dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> |
454 | <dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> |
201 | </dt> |
455 | </dt> |
202 | <dd> |
456 | <dd> |
203 | Called after a new terminal object has been initialized, but before |
457 | Called after a new terminal object has been initialized, but before |
204 | windows are created or the command gets run. Most methods are unsafe to |
458 | windows are created or the command gets run. Most methods are unsafe to |
205 | call or deliver senseless data, as terminal size and other characteristics |
459 | call or deliver senseless data, as terminal size and other characteristics |
206 | have not yet been determined. You can safely query and change resources, |
460 | have not yet been determined. You can safely query and change resources |
207 | though. |
461 | and options, though. For many purposes the <code>on_start</code> hook is a better |
|
|
462 | place. |
|
|
463 | </dd> |
|
|
464 | <p></p> |
|
|
465 | <dt><strong><a name="item_on_start__24term">on_start $term</a></strong><br /> |
|
|
466 | </dt> |
|
|
467 | <dd> |
|
|
468 | Called at the very end of initialisation of a new terminal, just before |
|
|
469 | trying to map (display) the toplevel and returning to the mainloop. |
|
|
470 | </dd> |
|
|
471 | <p></p> |
|
|
472 | <dt><strong><a name="item_on_destroy__24term">on_destroy $term</a></strong><br /> |
|
|
473 | </dt> |
|
|
474 | <dd> |
|
|
475 | Called whenever something tries to destroy terminal, before doing anything |
|
|
476 | yet. If this hook returns true, then destruction is skipped, but this is |
|
|
477 | rarely a good idea. |
208 | </dd> |
478 | </dd> |
209 | <p></p> |
479 | <p></p> |
210 | <dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> |
480 | <dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> |
211 | </dt> |
481 | </dt> |
212 | <dd> |
482 | <dd> |
213 | Called after the screen is ``reset'' for any reason, such as resizing or |
483 | Called after the screen is ``reset'' for any reason, such as resizing or |
214 | control sequences. Here is where you can react on changes to size-related |
484 | control sequences. Here is where you can react on changes to size-related |
215 | variables. |
485 | variables. |
216 | </dd> |
486 | </dd> |
217 | <p></p> |
487 | <p></p> |
218 | <dt><strong><a name="item_on_start__24term">on_start $term</a></strong><br /> |
488 | <dt><strong><a name="item_on_child_start__24term_2c__24pid">on_child_start $term, $pid</a></strong><br /> |
219 | </dt> |
489 | </dt> |
|
|
490 | <dd> |
|
|
491 | Called just after the child process has been <code>fork</code>ed. |
220 | <dd> |
492 | </dd> |
221 | Called at the very end of initialisation of a new terminal, just before |
493 | <p></p> |
222 | returning to the mainloop. |
494 | <dt><strong><a name="item_on_child_exit__24term_2c__24status">on_child_exit $term, $status</a></strong><br /> |
|
|
495 | </dt> |
|
|
496 | <dd> |
|
|
497 | Called just after the child process has exited. <code>$status</code> is the status |
|
|
498 | from <code>waitpid</code>. |
223 | </dd> |
499 | </dd> |
224 | <p></p> |
500 | <p></p> |
225 | <dt><strong><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a></strong><br /> |
501 | <dt><strong><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a></strong><br /> |
226 | </dt> |
502 | </dt> |
227 | <dd> |
503 | <dd> |
… | |
… | |
249 | </dt> |
525 | </dt> |
250 | <dd> |
526 | <dd> |
251 | Called whenever the user tries to extend the selection (e.g. with a double |
527 | Called whenever the user tries to extend the selection (e.g. with a double |
252 | click) and is either supposed to return false (normal operation), or |
528 | click) and is either supposed to return false (normal operation), or |
253 | should extend the selection itelf and return true to suppress the built-in |
529 | should extend the selection itelf and return true to suppress the built-in |
254 | processing. |
530 | processing. This can happen multiple times, as long as the callback |
|
|
531 | returns true, it will be called on every further click by the user and is |
|
|
532 | supposed to enlarge the selection more and more, if possible. |
255 | </dd> |
533 | </dd> |
256 | <dd> |
534 | <dd> |
257 | <p>See the <em>selection</em> example extension.</p> |
535 | <p>See the <em>selection</em> example extension.</p> |
258 | </dd> |
536 | </dd> |
259 | <p></p> |
537 | <p></p> |
… | |
… | |
302 | and calling <a href="#item_scr_add_lines"><code>$term->scr_add_lines</code></a> yourself. Please note that this |
580 | and calling <a href="#item_scr_add_lines"><code>$term->scr_add_lines</code></a> yourself. Please note that this |
303 | might be very slow, however, as your hook is called for <strong>all</strong> text being |
581 | might be very slow, however, as your hook is called for <strong>all</strong> text being |
304 | output. |
582 | output. |
305 | </dd> |
583 | </dd> |
306 | <p></p> |
584 | <p></p> |
|
|
585 | <dt><strong><a name="item_on_tt_write__24term_2c__24octets">on_tt_write $term, $octets</a></strong><br /> |
|
|
586 | </dt> |
|
|
587 | <dd> |
|
|
588 | Called whenever some data is written to the tty/pty and can be used to |
|
|
589 | suppress or filter tty input. |
|
|
590 | </dd> |
|
|
591 | <p></p> |
307 | <dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong><br /> |
592 | <dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong><br /> |
308 | </dt> |
593 | </dt> |
309 | <dd> |
594 | <dd> |
310 | Called whenever a line was updated or changed. Can be used to filter |
595 | Called whenever a line was updated or changed. Can be used to filter |
311 | screen output (e.g. underline urls or other useless stuff). Only lines |
596 | screen output (e.g. underline urls or other useless stuff). Only lines |
… | |
… | |
343 | Called whenever the user presses a key combination that has a |
628 | Called whenever the user presses a key combination that has a |
344 | <code>perl:string</code> action bound to it (see description of the <strong>keysym</strong> |
629 | <code>perl:string</code> action bound to it (see description of the <strong>keysym</strong> |
345 | resource in the <code>rxvt(1)</code> manpage). |
630 | resource in the <code>rxvt(1)</code> manpage). |
346 | </dd> |
631 | </dd> |
347 | <p></p> |
632 | <p></p> |
|
|
633 | <dt><strong><a name="item_on_x_event__24term_2c__24event">on_x_event $term, $event</a></strong><br /> |
|
|
634 | </dt> |
|
|
635 | <dd> |
|
|
636 | Called on every X event received on the vt window (and possibly other |
|
|
637 | windows). Should only be used as a last resort. Most event structure |
|
|
638 | members are not passed. |
|
|
639 | </dd> |
|
|
640 | <p></p> |
348 | <dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> |
641 | <dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> |
349 | </dt> |
642 | </dt> |
350 | <dd> |
643 | <dd> |
351 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
644 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
352 | does focus in processing. |
645 | does focus in processing. |
… | |
… | |
357 | <dd> |
650 | <dd> |
358 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
651 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
359 | focus out processing. |
652 | focus out processing. |
360 | </dd> |
653 | </dd> |
361 | <p></p> |
654 | <p></p> |
|
|
655 | <dt><strong><a name="item_on_configure_notify__24term_2c__24event">on_configure_notify $term, $event</a></strong><br /> |
|
|
656 | </dt> |
|
|
657 | <dt><strong><a name="item_on_property_notify__24term_2c__24event">on_property_notify $term, $event</a></strong><br /> |
|
|
658 | </dt> |
362 | <dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24octets">on_key_press $term, $event, $octets</a></strong><br /> |
659 | <dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a></strong><br /> |
363 | </dt> |
660 | </dt> |
364 | <dt><strong><a name="item_on_key_release__24term_2c__24event">on_key_release $term, $event</a></strong><br /> |
661 | <dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br /> |
365 | </dt> |
662 | </dt> |
366 | <dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br /> |
663 | <dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br /> |
367 | </dt> |
664 | </dt> |
368 | <dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br /> |
665 | <dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br /> |
369 | </dt> |
666 | </dt> |
… | |
… | |
377 | Called whenever the corresponding X event is received for the terminal If |
674 | Called whenever the corresponding X event is received for the terminal If |
378 | the hook returns true, then the even will be ignored by rxvt-unicode. |
675 | the hook returns true, then the even will be ignored by rxvt-unicode. |
379 | </dd> |
676 | </dd> |
380 | <dd> |
677 | <dd> |
381 | <p>The event is a hash with most values as named by Xlib (see the XEvent |
678 | <p>The event is a hash with most values as named by Xlib (see the XEvent |
382 | manpage), with the additional members <code>row</code> and <code>col</code>, which are the row |
679 | manpage), with the additional members <code>row</code> and <code>col</code>, which are the |
383 | and column under the mouse cursor.</p> |
680 | (real, not screen-based) row and column under the mouse cursor.</p> |
384 | </dd> |
681 | </dd> |
385 | <dd> |
682 | <dd> |
386 | <p><code>on_key_press</code> additionally receives the string rxvt-unicode would |
683 | <p><code>on_key_press</code> additionally receives the string rxvt-unicode would |
387 | output, if any, in locale-specific encoding.</p> |
684 | output, if any, in locale-specific encoding.</p> |
388 | </dd> |
685 | </dd> |
389 | <dd> |
686 | <dd> |
390 | <p>subwindow.</p> |
687 | <p>subwindow.</p> |
391 | </dd> |
688 | </dd> |
|
|
689 | <p></p> |
|
|
690 | <dt><strong><a name="item_on_client_message__24term_2c__24event">on_client_message $term, $event</a></strong><br /> |
|
|
691 | </dt> |
|
|
692 | <dt><strong><a name="item_on_wm_protocols__24term_2c__24event">on_wm_protocols $term, $event</a></strong><br /> |
|
|
693 | </dt> |
|
|
694 | <dt><strong><a name="item_on_wm_delete_window__24term_2c__24event">on_wm_delete_window $term, $event</a></strong><br /> |
|
|
695 | </dt> |
|
|
696 | <dd> |
|
|
697 | Called when various types of ClientMessage events are received (all with |
|
|
698 | format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
|
|
699 | </dd> |
392 | <p></p></dl> |
700 | <p></p></dl> |
393 | <p> |
701 | <p> |
394 | </p> |
702 | </p> |
395 | <h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> |
703 | <h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> |
396 | <dl> |
704 | <dl> |
|
|
705 | <dt><strong><a name="item__24urxvt_3a_3alibdir">$urxvt::LIBDIR</a></strong><br /> |
|
|
706 | </dt> |
|
|
707 | <dd> |
|
|
708 | The rxvt-unicode library directory, where, among other things, the perl |
|
|
709 | modules and scripts are stored. |
|
|
710 | </dd> |
|
|
711 | <p></p> |
|
|
712 | <dt><strong><a name="item__24urxvt_3a_3aresclass_2c__24urxvt_3a_3aresclass">$urxvt::RESCLASS, $urxvt::RESCLASS</a></strong><br /> |
|
|
713 | </dt> |
|
|
714 | <dd> |
|
|
715 | The resource class and name rxvt-unicode uses to look up X resources. |
|
|
716 | </dd> |
|
|
717 | <p></p> |
|
|
718 | <dt><strong><a name="item__24urxvt_3a_3arxvtname">$urxvt::RXVTNAME</a></strong><br /> |
|
|
719 | </dt> |
|
|
720 | <dd> |
|
|
721 | The basename of the installed binaries, usually <code>urxvt</code>. |
|
|
722 | </dd> |
|
|
723 | <p></p> |
397 | <dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br /> |
724 | <dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br /> |
398 | </dt> |
725 | </dt> |
399 | <dd> |
726 | <dd> |
400 | The current terminal. This variable stores the current <code>urxvt::term</code> |
727 | The current terminal. This variable stores the current <code>urxvt::term</code> |
401 | object, whenever a callback/hook is executing. |
728 | object, whenever a callback/hook is executing. |
402 | </dd> |
729 | </dd> |
|
|
730 | <p></p> |
|
|
731 | <dt><strong><a name="item__40urxvt_3a_3aterm_init">@urxvt::TERM_INIT</a></strong><br /> |
|
|
732 | </dt> |
|
|
733 | <dd> |
|
|
734 | All coderefs in this array will be called as methods of the next newly |
|
|
735 | created <code>urxvt::term</code> object (during the <code>on_init</code> phase). The array |
|
|
736 | gets cleared before the codereferences that were in it are being executed, |
|
|
737 | so coderefs can push themselves onto it again if they so desire. |
|
|
738 | </dd> |
|
|
739 | <dd> |
|
|
740 | <p>This complements to the perl-eval commandline option, but gets executed |
|
|
741 | first.</p> |
|
|
742 | </dd> |
|
|
743 | <p></p> |
|
|
744 | <dt><strong><a name="item__40urxvt_3a_3aterm_ext">@urxvt::TERM_EXT</a></strong><br /> |
|
|
745 | </dt> |
|
|
746 | <dd> |
|
|
747 | Works similar to <code>@TERM_INIT</code>, but contains perl package/class names, which |
|
|
748 | get registered as normal extensions after calling the hooks in <code>@TERM_INIT</code> |
|
|
749 | but before other extensions. Gets cleared just like <code>@TERM_INIT</code>. |
|
|
750 | </dd> |
403 | <p></p></dl> |
751 | <p></p></dl> |
404 | <p> |
752 | <p> |
405 | </p> |
753 | </p> |
406 | <h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> |
754 | <h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> |
407 | <dl> |
755 | <dl> |
408 | <dt><strong><a name="item__24term__3d_new_urxvt__5barg_2e_2e_2e_5d">$term = new urxvt [arg...]</a></strong><br /> |
|
|
409 | </dt> |
|
|
410 | <dd> |
|
|
411 | Creates a new terminal, very similar as if you had started it with |
|
|
412 | <code>system $binfile, arg...</code>. Croaks (and probably outputs an error message) |
|
|
413 | if the new instance couldn't be created. Returns <code>undef</code> if the new |
|
|
414 | instance didn't initialise perl, and the terminal object otherwise. The |
|
|
415 | <code>init</code> and <a href="#item_start"><code>start</code></a> hooks will be called during the call. |
|
|
416 | </dd> |
|
|
417 | <p></p> |
|
|
418 | <dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br /> |
756 | <dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br /> |
419 | </dt> |
757 | </dt> |
420 | <dd> |
758 | <dd> |
421 | Fatally aborts execution with the given error message. Avoid at all |
759 | Fatally aborts execution with the given error message. Avoid at all |
422 | costs! The only time this is acceptable is when the terminal process |
760 | costs! The only time this is acceptable is when the terminal process |
… | |
… | |
432 | </dd> |
770 | </dd> |
433 | <dd> |
771 | <dd> |
434 | <p>Using this function has the advantage that its output ends up in the |
772 | <p>Using this function has the advantage that its output ends up in the |
435 | correct place, e.g. on stderr of the connecting urxvtc client.</p> |
773 | correct place, e.g. on stderr of the connecting urxvtc client.</p> |
436 | </dd> |
774 | </dd> |
437 | <p></p> |
|
|
438 | <dt><strong><a name="item__24is_safe__3d_urxvt_3a_3asafe">$is_safe = urxvt::safe</a></strong><br /> |
|
|
439 | </dt> |
|
|
440 | <dd> |
775 | <dd> |
441 | Returns true when it is safe to do potentially unsafe things, such as |
776 | <p>Messages have a size limit of 1023 bytes currently.</p> |
442 | evaluating perl code specified by the user. This is true when urxvt was |
|
|
443 | started setuid or setgid. |
|
|
444 | </dd> |
777 | </dd> |
445 | <p></p> |
778 | <p></p> |
446 | <dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> |
779 | <dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> |
447 | </dt> |
780 | </dt> |
448 | <dd> |
781 | <dd> |
… | |
… | |
452 | <dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br /> |
785 | <dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br /> |
453 | </dt> |
786 | </dt> |
454 | <dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
787 | <dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
455 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
788 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
456 | Button4Mask, Button5Mask, AnyModifier</a></strong><br /> |
789 | Button4Mask, Button5Mask, AnyModifier</a></strong><br /> |
|
|
790 | </dt> |
|
|
791 | <dt><strong><a name="item_urxvt_3a_3anoeventmask_2c_keypressmask_2c_keyrelea">urxvt::NoEventMask, KeyPressMask, KeyReleaseMask, |
|
|
792 | ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, |
|
|
793 | PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask, |
|
|
794 | Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask, |
|
|
795 | KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask, |
|
|
796 | ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask, |
|
|
797 | FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask</a></strong><br /> |
|
|
798 | </dt> |
|
|
799 | <dt><strong><a name="item_urxvt_3a_3akeypress_2c_keyrelease_2c_buttonpress_2">urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify, |
|
|
800 | EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose, |
|
|
801 | GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify, |
|
|
802 | UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify, |
|
|
803 | ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify, |
|
|
804 | CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, |
|
|
805 | SelectionNotify, ColormapNotify, ClientMessage, MappingNotify</a></strong><br /> |
457 | </dt> |
806 | </dt> |
458 | <dd> |
807 | <dd> |
459 | Various constants for use in X calls and event processing. |
808 | Various constants for use in X calls and event processing. |
460 | </dd> |
809 | </dd> |
461 | <p></p></dl> |
810 | <p></p></dl> |
… | |
… | |
496 | </dt> |
845 | </dt> |
497 | <dd> |
846 | <dd> |
498 | Return the foreground/background colour index, respectively. |
847 | Return the foreground/background colour index, respectively. |
499 | </dd> |
848 | </dd> |
500 | <p></p> |
849 | <p></p> |
501 | <dt><strong><a name="item_set_fgcolor">$rend = urxvt::SET_FGCOLOR ($rend, $new_colour)</a></strong><br /> |
850 | <dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_fgcolor__24rend_2c__24n">$rend = urxvt::SET_FGCOLOR $rend, $new_colour</a></strong><br /> |
502 | </dt> |
851 | </dt> |
503 | <dt><strong><a name="item_set_bgcolor">$rend = urxvt::SET_BGCOLOR ($rend, $new_colour)</a></strong><br /> |
852 | <dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_bgcolor__24rend_2c__24n">$rend = urxvt::SET_BGCOLOR $rend, $new_colour</a></strong><br /> |
504 | </dt> |
853 | </dt> |
505 | <dd> |
854 | <dd> |
506 | Replace the foreground/background colour in the rendition mask with the |
855 | Replace the foreground/background colour in the rendition mask with the |
507 | specified one. |
856 | specified one. |
508 | </dd> |
857 | </dd> |
509 | <p></p> |
858 | <p></p> |
510 | <dt><strong><a name="item_get_custom">$value = urxvt::GET_CUSTOM ($rend)</a></strong><br /> |
859 | <dt><strong><a name="item__24value__3d_urxvt_3a_3aget_custom__24rend">$value = urxvt::GET_CUSTOM $rend</a></strong><br /> |
511 | </dt> |
860 | </dt> |
512 | <dd> |
861 | <dd> |
513 | Return the ``custom'' value: Every rendition has 5 bits for use by |
862 | Return the ``custom'' value: Every rendition has 5 bits for use by |
514 | extensions. They can be set and changed as you like and are initially |
863 | extensions. They can be set and changed as you like and are initially |
515 | zero. |
864 | zero. |
516 | </dd> |
865 | </dd> |
517 | <p></p> |
866 | <p></p> |
518 | <dt><strong><a name="item_set_custom">$rend = urxvt::SET_CUSTOM ($rend, $new_value)</a></strong><br /> |
867 | <dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_custom__24rend_2c__24ne">$rend = urxvt::SET_CUSTOM $rend, $new_value</a></strong><br /> |
519 | </dt> |
868 | </dt> |
520 | <dd> |
869 | <dd> |
521 | Change the custom value. |
870 | Change the custom value. |
522 | </dd> |
871 | </dd> |
523 | <p></p></dl> |
872 | <p></p></dl> |
524 | <p> |
873 | <p> |
525 | </p> |
874 | </p> |
526 | <h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2> |
875 | <h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2> |
527 | <p>The sole purpose of this class is to deliver an interface to the |
876 | <p>The sole purpose of this class is to deliver an interface to the |
528 | <code>AnyEvent</code> module - any module using it will work inside urxvt without |
877 | <code>AnyEvent</code> module - any module using it will work inside urxvt without |
529 | further work. The only exception is that you cannot wait on condition |
878 | further programming. The only exception is that you cannot wait on |
530 | variables, but non-blocking condvar use is ok. What this means is that you |
879 | condition variables, but non-blocking condvar use is ok. What this means |
531 | cannot use blocking APIs, but the non-blocking variant should work.</p> |
880 | is that you cannot use blocking APIs, but the non-blocking variant should |
|
|
881 | work.</p> |
532 | <p> |
882 | <p> |
533 | </p> |
883 | </p> |
534 | <h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> |
884 | <h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> |
535 | <dl> |
885 | <dl> |
|
|
886 | <dt><strong><a name="item__24term__3d_new_urxvt_3a_3aterm__24envhashref_2c__">$term = new urxvt::term $envhashref, $rxvtname, [arg...]</a></strong><br /> |
|
|
887 | </dt> |
|
|
888 | <dd> |
|
|
889 | Creates a new terminal, very similar as if you had started it with system |
|
|
890 | <code>$rxvtname, arg...</code>. <code>$envhashref</code> must be a reference to a <code>%ENV</code>-like |
|
|
891 | hash which defines the environment of the new terminal. |
|
|
892 | </dd> |
|
|
893 | <dd> |
|
|
894 | <p>Croaks (and probably outputs an error message) if the new instance |
|
|
895 | couldn't be created. Returns <code>undef</code> if the new instance didn't |
|
|
896 | initialise perl, and the terminal object otherwise. The <code>init</code> and |
|
|
897 | <a href="#item_start"><code>start</code></a> hooks will be called during this call.</p> |
|
|
898 | </dd> |
|
|
899 | <p></p> |
536 | <dt><strong><a name="item_destroy">$term->destroy</a></strong><br /> |
900 | <dt><strong><a name="item_destroy">$term->destroy</a></strong><br /> |
537 | </dt> |
901 | </dt> |
538 | <dd> |
902 | <dd> |
539 | Destroy the terminal object (close the window, free resources etc.). |
903 | Destroy the terminal object (close the window, free resources |
|
|
904 | etc.). Please note that rxvt will not exit as long as any event |
|
|
905 | watchers (timers, io watchers) are still active. |
|
|
906 | </dd> |
|
|
907 | <p></p> |
|
|
908 | <dt><strong><a name="item_exec_async">$term->exec_async ($cmd[, @args])</a></strong><br /> |
|
|
909 | </dt> |
|
|
910 | <dd> |
|
|
911 | Works like the combination of the <code>fork</code>/<code>exec</code> builtins, which executes |
|
|
912 | (``starts'') programs in the background. This function takes care of setting |
|
|
913 | the user environment before exec'ing the command (e.g. <code>PATH</code>) and should |
|
|
914 | be preferred over explicit calls to <code>exec</code> or <code>system</code>. |
|
|
915 | </dd> |
|
|
916 | <dd> |
|
|
917 | <p>Returns the pid of the subprocess or <code>undef</code> on error.</p> |
540 | </dd> |
918 | </dd> |
541 | <p></p> |
919 | <p></p> |
542 | <dt><strong><a name="item_option">$isset = $term->option ($optval[, $set])</a></strong><br /> |
920 | <dt><strong><a name="item_option">$isset = $term->option ($optval[, $set])</a></strong><br /> |
543 | </dt> |
921 | </dt> |
544 | <dd> |
922 | <dd> |
… | |
… | |
552 | </dd> |
930 | </dd> |
553 | <dd> |
931 | <dd> |
554 | <pre> |
932 | <pre> |
555 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
933 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
556 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
934 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
557 | pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating |
935 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
558 | scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer |
936 | scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput |
559 | secondaryScreen secondaryScroll skipBuiltinGlyphs transparent |
937 | scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs |
560 | tripleclickwords utmpInhibit visualBell</pre> |
938 | transparent tripleclickwords utmpInhibit visualBell</pre> |
561 | </dd> |
939 | </dd> |
562 | <p></p> |
940 | <p></p> |
563 | <dt><strong><a name="item_resource">$value = $term->resource ($name[, $newval])</a></strong><br /> |
941 | <dt><strong><a name="item_resource">$value = $term->resource ($name[, $newval])</a></strong><br /> |
564 | </dt> |
942 | </dt> |
565 | <dd> |
943 | <dd> |
… | |
… | |
590 | <pre> |
968 | <pre> |
591 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
969 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
592 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
970 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
593 | display_name embed ext_bwidth fade font geometry hold iconName |
971 | display_name embed ext_bwidth fade font geometry hold iconName |
594 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
972 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
595 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
973 | italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier |
596 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 |
974 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
597 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
975 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
598 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
976 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
599 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
977 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
600 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
978 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
601 | shade term_name title transparent transparent_all tripleclickwords |
979 | secondaryScreen secondaryScroll selectstyle shade term_name title |
|
|
980 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
602 | utmpInhibit visualBell</pre> |
981 | visualBell</pre> |
|
|
982 | </dd> |
|
|
983 | <p></p> |
|
|
984 | <dt><strong><a name="item_x_resource">$value = $term->x_resource ($pattern)</a></strong><br /> |
|
|
985 | </dt> |
|
|
986 | <dd> |
|
|
987 | Returns the X-Resource for the given pattern, excluding the program or |
|
|
988 | class name, i.e. <a href="#item_x_resource"><code>$term->x_resource ("boldFont")</code></a> should return the |
|
|
989 | same value as used by this instance of rxvt-unicode. Returns <code>undef</code> if no |
|
|
990 | resource with that pattern exists. |
|
|
991 | </dd> |
|
|
992 | <dd> |
|
|
993 | <p>This method should only be called during the <code>on_start</code> hook, as there is |
|
|
994 | only one resource database per display, and later invocations might return |
|
|
995 | the wrong resources.</p> |
|
|
996 | </dd> |
|
|
997 | <p></p> |
|
|
998 | <dt><strong><a name="item_parse_keysym">$success = $term->parse_keysym ($keysym_spec, $command_string)</a></strong><br /> |
|
|
999 | </dt> |
|
|
1000 | <dd> |
|
|
1001 | Adds a keymap translation exactly as specified via a resource. See the |
|
|
1002 | <code>keysym</code> resource in the <code>rxvt(1)</code> manpage. |
603 | </dd> |
1003 | </dd> |
604 | <p></p> |
1004 | <p></p> |
605 | <dt><strong><a name="item_rstyle">$rend = $term->rstyle ([$new_rstyle])</a></strong><br /> |
1005 | <dt><strong><a name="item_rstyle">$rend = $term->rstyle ([$new_rstyle])</a></strong><br /> |
606 | </dt> |
1006 | </dt> |
607 | <dd> |
1007 | <dd> |
… | |
… | |
625 | <dd> |
1025 | <dd> |
626 | Return the current values of the selection mark, begin or end positions, |
1026 | Return the current values of the selection mark, begin or end positions, |
627 | and optionally set them to new values. |
1027 | and optionally set them to new values. |
628 | </dd> |
1028 | </dd> |
629 | <p></p> |
1029 | <p></p> |
|
|
1030 | <dt><strong><a name="item_selection_make">$term->selection_make ($eventtime[, $rectangular])</a></strong><br /> |
|
|
1031 | </dt> |
|
|
1032 | <dd> |
|
|
1033 | Tries to make a selection as set by <a href="#item_selection_beg"><code>selection_beg</code></a> and |
|
|
1034 | <a href="#item_selection_end"><code>selection_end</code></a>. If <code>$rectangular</code> is true (default: false), a |
|
|
1035 | rectangular selection will be made. This is the prefered function to make |
|
|
1036 | a selection. |
|
|
1037 | </dd> |
|
|
1038 | <p></p> |
630 | <dt><strong><a name="item_selection_grab">$success = $term->selection_grab ($eventtime)</a></strong><br /> |
1039 | <dt><strong><a name="item_selection_grab">$success = $term->selection_grab ($eventtime)</a></strong><br /> |
631 | </dt> |
1040 | </dt> |
632 | <dd> |
1041 | <dd> |
633 | Try to request the primary selection from the server (for example, as set |
1042 | Try to request the primary selection text from the server (for example, as |
634 | by the next method). |
1043 | set by the next method). No visual feedback will be given. This function |
|
|
1044 | is mostly useful from within <code>on_sel_grab</code> hooks. |
635 | </dd> |
1045 | </dd> |
636 | <p></p> |
1046 | <p></p> |
637 | <dt><strong>$oldtext = $term->selection ([$newtext])</strong><br /> |
1047 | <dt><strong>$oldtext = $term->selection ([$newtext])</strong><br /> |
638 | </dt> |
1048 | </dt> |
639 | <dd> |
1049 | <dd> |
640 | Return the current selection text and optionally replace it by <code>$newtext</code>. |
1050 | Return the current selection text and optionally replace it by <code>$newtext</code>. |
641 | </dd> |
1051 | </dd> |
|
|
1052 | <p></p> |
|
|
1053 | <dt><strong><a name="item_overlay_simple">$term->overlay_simple ($x, $y, $text)</a></strong><br /> |
|
|
1054 | </dt> |
642 | <dd> |
1055 | <dd> |
643 | <p>#=item $term->overlay ($x, $y, $text) |
|
|
644 | # |
|
|
645 | #Create a simple multi-line overlay box. See the next method for details. |
1056 | Create a simple multi-line overlay box. See the next method for details. |
646 | # |
|
|
647 | #=cut |
|
|
648 | # |
|
|
649 | #sub urxvt::term::scr_overlay { |
|
|
650 | # my ($self, $x, $y, $text) = @_; |
|
|
651 | # |
|
|
652 | # my @lines = split /\n/, $text; |
|
|
653 | # |
|
|
654 | # my $w = 0; |
|
|
655 | # for (map $self->strwidth ($_), @lines) { |
|
|
656 | # $w = $_ if $w < $_; |
|
|
657 | # } |
|
|
658 | # |
|
|
659 | # $self->scr_overlay_new ($x, $y, $w, scalar @lines); |
|
|
660 | # $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; |
|
|
661 | #}</p> |
|
|
662 | </dd> |
1057 | </dd> |
663 | <p></p> |
1058 | <p></p> |
664 | <dt><strong><a name="item_overlay">$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br /> |
1059 | <dt><strong><a name="item_overlay">$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br /> |
665 | </dt> |
1060 | </dt> |
666 | <dd> |
1061 | <dd> |
… | |
… | |
727 | <p></p> |
1122 | <p></p> |
728 | <dt><strong><a name="item_locale_decode">$string = $term->locale_decode ($octets)</a></strong><br /> |
1123 | <dt><strong><a name="item_locale_decode">$string = $term->locale_decode ($octets)</a></strong><br /> |
729 | </dt> |
1124 | </dt> |
730 | <dd> |
1125 | <dd> |
731 | Convert the given locale-encoded octets into a perl string. |
1126 | Convert the given locale-encoded octets into a perl string. |
|
|
1127 | </dd> |
|
|
1128 | <p></p> |
|
|
1129 | <dt><strong><a name="item_scr_xor_span">$term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])</a></strong><br /> |
|
|
1130 | </dt> |
|
|
1131 | <dd> |
|
|
1132 | XORs the rendition values in the given span with the provided value |
|
|
1133 | (default: <code>RS_RVid</code>), which <em>MUST NOT</em> contain font styles. Useful in |
|
|
1134 | refresh hooks to provide effects similar to the selection. |
|
|
1135 | </dd> |
|
|
1136 | <p></p> |
|
|
1137 | <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 /> |
|
|
1138 | </dt> |
|
|
1139 | <dd> |
|
|
1140 | Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing |
|
|
1141 | whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults |
|
|
1142 | to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines |
|
|
1143 | it instead. Both styles <em>MUST NOT</em> contain font styles. |
|
|
1144 | </dd> |
|
|
1145 | <p></p> |
|
|
1146 | <dt><strong><a name="item_scr_bell">$term->scr_bell</a></strong><br /> |
|
|
1147 | </dt> |
|
|
1148 | <dd> |
|
|
1149 | Ring the bell! |
732 | </dd> |
1150 | </dd> |
733 | <p></p> |
1151 | <p></p> |
734 | <dt><strong><a name="item_scr_add_lines">$term->scr_add_lines ($string)</a></strong><br /> |
1152 | <dt><strong><a name="item_scr_add_lines">$term->scr_add_lines ($string)</a></strong><br /> |
735 | </dt> |
1153 | </dt> |
736 | <dd> |
1154 | <dd> |
… | |
… | |
743 | <p>Normally its not a good idea to use this function, as programs might be |
1161 | <p>Normally its not a good idea to use this function, as programs might be |
744 | confused by changes in cursor position or scrolling. Its useful inside a |
1162 | confused by changes in cursor position or scrolling. Its useful inside a |
745 | <code>on_add_lines</code> hook, though.</p> |
1163 | <code>on_add_lines</code> hook, though.</p> |
746 | </dd> |
1164 | </dd> |
747 | <p></p> |
1165 | <p></p> |
|
|
1166 | <dt><strong><a name="item_scr_change_screen">$term->scr_change_screen ($screen)</a></strong><br /> |
|
|
1167 | </dt> |
|
|
1168 | <dd> |
|
|
1169 | Switch to given screen - 0 primary, 1 secondary. |
|
|
1170 | </dd> |
|
|
1171 | <p></p> |
748 | <dt><strong><a name="item_cmd_parse">$term->cmd_parse ($octets)</a></strong><br /> |
1172 | <dt><strong><a name="item_cmd_parse">$term->cmd_parse ($octets)</a></strong><br /> |
749 | </dt> |
1173 | </dt> |
750 | <dd> |
1174 | <dd> |
751 | Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the |
1175 | Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the |
752 | locale-specific encoding of the terminal and can contain command sequences |
1176 | locale-specific encoding of the terminal and can contain command sequences |
… | |
… | |
759 | Write the octets given in <code>$data</code> to the tty (i.e. as program input). To |
1183 | Write the octets given in <code>$data</code> to the tty (i.e. as program input). To |
760 | pass characters instead of octets, you should convert your strings first |
1184 | pass characters instead of octets, you should convert your strings first |
761 | to the locale-specific encoding using <a href="#item_locale_encode"><code>$term->locale_encode</code></a>. |
1185 | to the locale-specific encoding using <a href="#item_locale_encode"><code>$term->locale_encode</code></a>. |
762 | </dd> |
1186 | </dd> |
763 | <p></p> |
1187 | <p></p> |
|
|
1188 | <dt><strong><a name="item_pty_ev_events">$old_events = $term->pty_ev_events ([$new_events])</a></strong><br /> |
|
|
1189 | </dt> |
|
|
1190 | <dd> |
|
|
1191 | Replaces the event mask of the pty watcher by the given event mask. Can |
|
|
1192 | be used to suppress input and output handling to the pty/tty. See the |
|
|
1193 | description of <a href="#item_events"><code>urxvt::timer->events</code></a>. Make sure to always restore |
|
|
1194 | the previous value. |
|
|
1195 | </dd> |
|
|
1196 | <p></p> |
764 | <dt><strong><a name="item_parent">$windowid = $term->parent</a></strong><br /> |
1197 | <dt><strong><a name="item_parent">$windowid = $term->parent</a></strong><br /> |
765 | </dt> |
1198 | </dt> |
766 | <dd> |
1199 | <dd> |
767 | Return the window id of the toplevel window. |
1200 | Return the window id of the toplevel window. |
768 | </dd> |
1201 | </dd> |
… | |
… | |
771 | </dt> |
1204 | </dt> |
772 | <dd> |
1205 | <dd> |
773 | Return the window id of the terminal window. |
1206 | Return the window id of the terminal window. |
774 | </dd> |
1207 | </dd> |
775 | <p></p> |
1208 | <p></p> |
|
|
1209 | <dt><strong><a name="item_vt_emask_add">$term->vt_emask_add ($x_event_mask)</a></strong><br /> |
|
|
1210 | </dt> |
|
|
1211 | <dd> |
|
|
1212 | Adds the specified events to the vt event mask. Useful e.g. when you want |
|
|
1213 | to receive pointer events all the times: |
|
|
1214 | </dd> |
|
|
1215 | <dd> |
|
|
1216 | <pre> |
|
|
1217 | $term->vt_emask_add (urxvt::PointerMotionMask);</pre> |
|
|
1218 | </dd> |
|
|
1219 | <p></p> |
776 | <dt><strong><a name="item_width">$window_width = $term->width</a></strong><br /> |
1220 | <dt><strong><a name="item_width">$window_width = $term->width</a></strong><br /> |
777 | </dt> |
1221 | </dt> |
778 | <dt><strong><a name="item_height">$window_height = $term->height</a></strong><br /> |
1222 | <dt><strong><a name="item_height">$window_height = $term->height</a></strong><br /> |
779 | </dt> |
1223 | </dt> |
780 | <dt><strong><a name="item_fwidth">$font_width = $term->fwidth</a></strong><br /> |
1224 | <dt><strong><a name="item_fwidth">$font_width = $term->fwidth</a></strong><br /> |
… | |
… | |
793 | </dt> |
1237 | </dt> |
794 | <dt><strong><a name="item_savelines">$max_scrollback = $term->saveLines</a></strong><br /> |
1238 | <dt><strong><a name="item_savelines">$max_scrollback = $term->saveLines</a></strong><br /> |
795 | </dt> |
1239 | </dt> |
796 | <dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term->total_rows</a></strong><br /> |
1240 | <dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term->total_rows</a></strong><br /> |
797 | </dt> |
1241 | </dt> |
798 | <dt><strong><a name="item_nsaved">$lines_in_scrollback = $term->nsaved</a></strong><br /> |
1242 | <dt><strong><a name="item_top_row">$topmost_scrollback_row = $term->top_row</a></strong><br /> |
799 | </dt> |
1243 | </dt> |
800 | <dd> |
1244 | <dd> |
801 | Return various integers describing terminal characteristics. |
1245 | Return various integers describing terminal characteristics. |
|
|
1246 | </dd> |
|
|
1247 | <p></p> |
|
|
1248 | <dt><strong><a name="item_display_id">$x_display = $term->display_id</a></strong><br /> |
|
|
1249 | </dt> |
|
|
1250 | <dd> |
|
|
1251 | Return the DISPLAY used by rxvt-unicode. |
|
|
1252 | </dd> |
|
|
1253 | <p></p> |
|
|
1254 | <dt><strong><a name="item_locale">$lc_ctype = $term->locale</a></strong><br /> |
|
|
1255 | </dt> |
|
|
1256 | <dd> |
|
|
1257 | Returns the LC_CTYPE category string used by this rxvt-unicode. |
|
|
1258 | </dd> |
|
|
1259 | <p></p> |
|
|
1260 | <dt><strong><a name="item_env">$env = $term->env</a></strong><br /> |
|
|
1261 | </dt> |
|
|
1262 | <dd> |
|
|
1263 | Returns a copy of the environment in effect for the terminal as a hashref |
|
|
1264 | similar to <code>\%ENV</code>. |
802 | </dd> |
1265 | </dd> |
803 | <p></p> |
1266 | <p></p> |
804 | <dt><strong><a name="item_modlevel3mask">$modifiermask = $term->ModLevel3Mask</a></strong><br /> |
1267 | <dt><strong><a name="item_modlevel3mask">$modifiermask = $term->ModLevel3Mask</a></strong><br /> |
805 | </dt> |
1268 | </dt> |
806 | <dt><strong><a name="item_modmetamask">$modifiermask = $term->ModMetaMask</a></strong><br /> |
1269 | <dt><strong><a name="item_modmetamask">$modifiermask = $term->ModMetaMask</a></strong><br /> |
… | |
… | |
810 | <dd> |
1273 | <dd> |
811 | Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often |
1274 | Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often |
812 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1275 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
813 | </dd> |
1276 | </dd> |
814 | <p></p> |
1277 | <p></p> |
|
|
1278 | <dt><strong><a name="item_current_screen">$screen = $term->current_screen</a></strong><br /> |
|
|
1279 | </dt> |
|
|
1280 | <dd> |
|
|
1281 | Returns the currently displayed screen (0 primary, 1 secondary). |
|
|
1282 | </dd> |
|
|
1283 | <p></p> |
815 | <dt><strong><a name="item_view_start">$view_start = $term->view_start ([$newvalue])</a></strong><br /> |
1284 | <dt><strong><a name="item_view_start">$view_start = $term->view_start ([$newvalue])</a></strong><br /> |
816 | </dt> |
1285 | </dt> |
817 | <dd> |
1286 | <dd> |
818 | Returns the negative row number of the topmost line. Minimum value is |
1287 | Returns the row number of the topmost displayed line. Maximum value is |
819 | <code>0</code>, which displays the normal terminal contents. Larger values scroll |
1288 | <code>0</code>, which displays the normal terminal contents. Lower values scroll |
820 | this many lines into the scrollback buffer. |
1289 | this many lines into the scrollback buffer. |
821 | </dd> |
1290 | </dd> |
822 | <p></p> |
1291 | <p></p> |
823 | <dt><strong><a name="item_want_refresh">$term->want_refresh</a></strong><br /> |
1292 | <dt><strong><a name="item_want_refresh">$term->want_refresh</a></strong><br /> |
824 | </dt> |
1293 | </dt> |
… | |
… | |
835 | </dt> |
1304 | </dt> |
836 | <dd> |
1305 | <dd> |
837 | Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code> |
1306 | Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code> |
838 | is the topmost terminal line, row <code>$term->$ncol-1</code> is the bottommost |
1307 | is the topmost terminal line, row <code>$term->$ncol-1</code> is the bottommost |
839 | terminal line. The scrollback buffer starts at line <code>-1</code> and extends to |
1308 | terminal line. The scrollback buffer starts at line <code>-1</code> and extends to |
840 | line <a href="#item_nsaved"><code>-$term->nsaved</code></a>. Nothing will be returned if a nonexistent line |
1309 | line <code>-$term->nsaved</code>. Nothing will be returned if a nonexistent line |
841 | is requested. |
1310 | is requested. |
842 | </dd> |
1311 | </dd> |
843 | <dd> |
1312 | <dd> |
844 | <p>If <code>$new_text</code> is specified, it will replace characters in the current |
1313 | <p>If <code>$new_text</code> is specified, it will replace characters in the current |
845 | line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful |
1314 | line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful |
846 | to replace only parts of a line. The font index in the rendition will |
1315 | to replace only parts of a line. The font index in the rendition will |
847 | automatically be updated.</p> |
1316 | automatically be updated.</p> |
848 | </dd> |
1317 | </dd> |
849 | <dd> |
1318 | <dd> |
850 | <p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more |
1319 | <p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use |
851 | than one cell when displayed are padded with urxvt::NOCHAR characters |
1320 | more than one cell when displayed are padded with <code>$urxvt::NOCHAR</code> |
852 | (<code>chr 65535</code>). Characters with combining characters and other characters |
1321 | characters. Characters with combining characters and other characters that |
853 | that do not fit into the normal tetx encoding will be replaced with |
1322 | do not fit into the normal tetx encoding will be replaced with characters |
854 | characters in the private use area.</p> |
1323 | in the private use area.</p> |
855 | </dd> |
1324 | </dd> |
856 | <dd> |
1325 | <dd> |
857 | <p>You have to obey this encoding when changing text. The advantage is |
1326 | <p>You have to obey this encoding when changing text. The advantage is |
858 | that <code>substr</code> and similar functions work on screen cells and not on |
1327 | that <code>substr</code> and similar functions work on screen cells and not on |
859 | characters.</p> |
1328 | characters.</p> |
… | |
… | |
930 | <p></p> |
1399 | <p></p> |
931 | <dt><strong><a name="item_offset_of">$offset = $line->offset_of ($row, $col)</a></strong><br /> |
1400 | <dt><strong><a name="item_offset_of">$offset = $line->offset_of ($row, $col)</a></strong><br /> |
932 | </dt> |
1401 | </dt> |
933 | <dd> |
1402 | <dd> |
934 | Returns the character offset of the given row|col pair within the logical |
1403 | Returns the character offset of the given row|col pair within the logical |
935 | line. |
1404 | line. Works for rows outside the line, too, and returns corresponding |
|
|
1405 | offsets outside the string. |
936 | </dd> |
1406 | </dd> |
937 | <p></p> |
1407 | <p></p> |
938 | <dt><strong><a name="item_coord_of">($row, $col) = $line->coord_of ($offset)</a></strong><br /> |
1408 | <dt><strong><a name="item_coord_of">($row, $col) = $line->coord_of ($offset)</a></strong><br /> |
939 | </dt> |
1409 | </dt> |
940 | <dd> |
1410 | <dd> |
… | |
… | |
993 | <dd> |
1463 | <dd> |
994 | Calls XUngrab for the most recent grab. Is called automatically on |
1464 | Calls XUngrab for the most recent grab. Is called automatically on |
995 | evaluation errors, as it is better to lose the grab in the error case as |
1465 | evaluation errors, as it is better to lose the grab in the error case as |
996 | the session. |
1466 | the session. |
997 | </dd> |
1467 | </dd> |
|
|
1468 | <p></p> |
|
|
1469 | <dt><strong><a name="item_xinternatom">$atom = $term->XInternAtom ($atom_name[, $only_if_exists])</a></strong><br /> |
|
|
1470 | </dt> |
|
|
1471 | <dt><strong><a name="item_xgetatomname">$atom_name = $term->XGetAtomName ($atom)</a></strong><br /> |
|
|
1472 | </dt> |
|
|
1473 | <dt><strong><a name="item_xlistproperties">@atoms = $term->XListProperties ($window)</a></strong><br /> |
|
|
1474 | </dt> |
|
|
1475 | <dt><strong><a name="item_xgetwindowproperty">($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)</a></strong><br /> |
|
|
1476 | </dt> |
|
|
1477 | <dt><strong><a name="item_xchangewindowproperty">$term->XChangeWindowProperty ($window, $property, $type, $format, $octets)</a></strong><br /> |
|
|
1478 | </dt> |
|
|
1479 | <dt><strong><a name="item_xdeleteproperty">$term->XDeleteProperty ($window, $property)</a></strong><br /> |
|
|
1480 | </dt> |
|
|
1481 | <dt><strong><a name="item_defaultrootwindow">$window = $term->DefaultRootWindow</a></strong><br /> |
|
|
1482 | </dt> |
|
|
1483 | <dt><strong><a name="item_xreparentwindow">$term->XReparentWindow ($window, $parent, [$x, $y])</a></strong><br /> |
|
|
1484 | </dt> |
|
|
1485 | <dt><strong><a name="item_xmapwindow">$term->XMapWindow ($window)</a></strong><br /> |
|
|
1486 | </dt> |
|
|
1487 | <dt><strong><a name="item_xunmapwindow">$term->XUnmapWindow ($window)</a></strong><br /> |
|
|
1488 | </dt> |
|
|
1489 | <dt><strong><a name="item_xmoveresizewindow">$term->XMoveResizeWindow ($window, $x, $y, $width, $height)</a></strong><br /> |
|
|
1490 | </dt> |
|
|
1491 | <dt><strong><a name="item_xtranslatecoordinates">($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)</a></strong><br /> |
|
|
1492 | </dt> |
|
|
1493 | <dt><strong><a name="item_xchangeinput">$term->XChangeInput ($window, $add_events[, $del_events])</a></strong><br /> |
|
|
1494 | </dt> |
|
|
1495 | <dd> |
|
|
1496 | Various X or X-related functions. The <code>$term</code> object only serves as |
|
|
1497 | the source of the display, otherwise those functions map more-or-less |
|
|
1498 | directory onto the X functions of the same name. |
|
|
1499 | </dd> |
998 | <p></p></dl> |
1500 | <p></p></dl> |
999 | <p> |
1501 | <p> |
1000 | </p> |
1502 | </p> |
1001 | <h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> |
1503 | <h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> |
|
|
1504 | <dl> |
|
|
1505 | <dt><strong><a name="item_add_title">$popup->add_title ($title)</a></strong><br /> |
|
|
1506 | </dt> |
|
|
1507 | <dd> |
|
|
1508 | Adds a non-clickable title to the popup. |
|
|
1509 | </dd> |
|
|
1510 | <p></p> |
|
|
1511 | <dt><strong><a name="item_add_separator">$popup->add_separator ([$sepchr])</a></strong><br /> |
|
|
1512 | </dt> |
|
|
1513 | <dd> |
|
|
1514 | Creates a separator, optionally using the character given as <code>$sepchr</code>. |
|
|
1515 | </dd> |
|
|
1516 | <p></p> |
|
|
1517 | <dt><strong><a name="item_add_button">$popup->add_button ($text, $cb)</a></strong><br /> |
|
|
1518 | </dt> |
|
|
1519 | <dd> |
|
|
1520 | Adds a clickable button to the popup. <code>$cb</code> is called whenever it is |
|
|
1521 | selected. |
|
|
1522 | </dd> |
|
|
1523 | <p></p> |
|
|
1524 | <dt><strong><a name="item_add_toggle">$popup->add_toggle ($text, $cb, $initial_value)</a></strong><br /> |
|
|
1525 | </dt> |
|
|
1526 | <dd> |
|
|
1527 | Adds a toggle/checkbox item to the popup. Teh callback gets called |
|
|
1528 | whenever it gets toggled, with a boolean indicating its value as its first |
|
|
1529 | argument. |
|
|
1530 | </dd> |
|
|
1531 | <p></p> |
|
|
1532 | <dt><strong>$popup->show</strong><br /> |
|
|
1533 | </dt> |
|
|
1534 | <dd> |
|
|
1535 | Displays the popup (which is initially hidden). |
|
|
1536 | </dd> |
|
|
1537 | <p></p></dl> |
1002 | <p> |
1538 | <p> |
1003 | </p> |
1539 | </p> |
1004 | <h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> |
1540 | <h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> |
1005 | <p>This class implements timer watchers/events. Time is represented as a |
1541 | <p>This class implements timer watchers/events. Time is represented as a |
1006 | fractional number of seconds since the epoch. Example:</p> |
1542 | fractional number of seconds since the epoch. Example:</p> |
… | |
… | |
1057 | </dt> |
1593 | </dt> |
1058 | <dd> |
1594 | <dd> |
1059 | Set the event trigger time to <code>$tstamp</code> and start the timer. |
1595 | Set the event trigger time to <code>$tstamp</code> and start the timer. |
1060 | </dd> |
1596 | </dd> |
1061 | <p></p> |
1597 | <p></p> |
|
|
1598 | <dt><strong><a name="item_after">$timer = $timer->after ($delay)</a></strong><br /> |
|
|
1599 | </dt> |
|
|
1600 | <dd> |
|
|
1601 | Like <a href="#item_start"><code>start</code></a>, but sets the expiry timer to c<urxvt::NOW + $delay>. |
|
|
1602 | </dd> |
|
|
1603 | <p></p> |
1062 | <dt><strong><a name="item_stop">$timer = $timer->stop</a></strong><br /> |
1604 | <dt><strong><a name="item_stop">$timer = $timer->stop</a></strong><br /> |
1063 | </dt> |
1605 | </dt> |
1064 | <dd> |
1606 | <dd> |
1065 | Stop the timer. |
1607 | Stop the timer. |
1066 | </dd> |
1608 | </dd> |
… | |
… | |
1072 | <pre> |
1614 | <pre> |
1073 | $term->{socket} = ... |
1615 | $term->{socket} = ... |
1074 | $term->{iow} = urxvt::iow |
1616 | $term->{iow} = urxvt::iow |
1075 | ->new |
1617 | ->new |
1076 | ->fd (fileno $term->{socket}) |
1618 | ->fd (fileno $term->{socket}) |
1077 | ->events (1) # wait for read data |
1619 | ->events (urxvt::EVENT_READ) |
1078 | ->start |
1620 | ->start |
1079 | ->cb (sub { |
1621 | ->cb (sub { |
1080 | my ($iow, $revents) = @_; |
1622 | my ($iow, $revents) = @_; |
1081 | # $revents must be 1 here, no need to check |
1623 | # $revents must be 1 here, no need to check |
1082 | sysread $term->{socket}, my $buf, 8192 |
1624 | sysread $term->{socket}, my $buf, 8192 |
… | |
… | |
1103 | </dd> |
1645 | </dd> |
1104 | <p></p> |
1646 | <p></p> |
1105 | <dt><strong><a name="item_events">$iow = $iow->events ($eventmask)</a></strong><br /> |
1647 | <dt><strong><a name="item_events">$iow = $iow->events ($eventmask)</a></strong><br /> |
1106 | </dt> |
1648 | </dt> |
1107 | <dd> |
1649 | <dd> |
1108 | Set the event mask to watch. Bit #0 (value <code>1</code>) enables watching for read |
1650 | Set the event mask to watch. The only allowed values are |
1109 | data, Bit #1 (value <code>2</code>) enables watching for write data. |
1651 | <code>urxvt::EVENT_READ</code> and <code>urxvt::EVENT_WRITE</code>, which might be ORed |
|
|
1652 | together, or <code>urxvt::EVENT_NONE</code>. |
1110 | </dd> |
1653 | </dd> |
1111 | <p></p> |
1654 | <p></p> |
1112 | <dt><strong>$iow = $iow->start</strong><br /> |
1655 | <dt><strong>$iow = $iow->start</strong><br /> |
1113 | </dt> |
1656 | </dt> |
1114 | <dd> |
1657 | <dd> |
… | |
… | |
1117 | <p></p> |
1660 | <p></p> |
1118 | <dt><strong>$iow = $iow->stop</strong><br /> |
1661 | <dt><strong>$iow = $iow->stop</strong><br /> |
1119 | </dt> |
1662 | </dt> |
1120 | <dd> |
1663 | <dd> |
1121 | Stop watching for events on the given filehandle. |
1664 | Stop watching for events on the given filehandle. |
|
|
1665 | </dd> |
|
|
1666 | <p></p></dl> |
|
|
1667 | <p> |
|
|
1668 | </p> |
|
|
1669 | <h2><a name="the_urxvt__iw_class">The <code>urxvt::iw</code> Class</a></h2> |
|
|
1670 | <p>This class implements idle watchers, that get called automatically when |
|
|
1671 | the process is idle. They should return as fast as possible, after doing |
|
|
1672 | some useful work.</p> |
|
|
1673 | <dl> |
|
|
1674 | <dt><strong><a name="item__24iw__3d_new_urxvt_3a_3aiw">$iw = new urxvt::iw</a></strong><br /> |
|
|
1675 | </dt> |
|
|
1676 | <dd> |
|
|
1677 | Create a new idle watcher object in stopped state. |
|
|
1678 | </dd> |
|
|
1679 | <p></p> |
|
|
1680 | <dt><strong>$iw = $iw->cb (sub { my ($iw) = @_; ... })</strong><br /> |
|
|
1681 | </dt> |
|
|
1682 | <dd> |
|
|
1683 | Set the callback to be called when the watcher triggers. |
|
|
1684 | </dd> |
|
|
1685 | <p></p> |
|
|
1686 | <dt><strong>$timer = $timer->start</strong><br /> |
|
|
1687 | </dt> |
|
|
1688 | <dd> |
|
|
1689 | Start the watcher. |
|
|
1690 | </dd> |
|
|
1691 | <p></p> |
|
|
1692 | <dt><strong>$timer = $timer->stop</strong><br /> |
|
|
1693 | </dt> |
|
|
1694 | <dd> |
|
|
1695 | Stop the watcher. |
|
|
1696 | </dd> |
|
|
1697 | <p></p></dl> |
|
|
1698 | <p> |
|
|
1699 | </p> |
|
|
1700 | <h2><a name="the_urxvt__pw_class">The <code>urxvt::pw</code> Class</a></h2> |
|
|
1701 | <p>This class implements process watchers. They create an event whenever a |
|
|
1702 | process exits, after which they stop automatically.</p> |
|
|
1703 | <pre> |
|
|
1704 | my $pid = fork; |
|
|
1705 | ... |
|
|
1706 | $term->{pw} = urxvt::pw |
|
|
1707 | ->new |
|
|
1708 | ->start ($pid) |
|
|
1709 | ->cb (sub { |
|
|
1710 | my ($pw, $exit_status) = @_; |
|
|
1711 | ... |
|
|
1712 | });</pre> |
|
|
1713 | <dl> |
|
|
1714 | <dt><strong><a name="item__24pw__3d_new_urxvt_3a_3apw">$pw = new urxvt::pw</a></strong><br /> |
|
|
1715 | </dt> |
|
|
1716 | <dd> |
|
|
1717 | Create a new process watcher in stopped state. |
|
|
1718 | </dd> |
|
|
1719 | <p></p> |
|
|
1720 | <dt><strong>$pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })</strong><br /> |
|
|
1721 | </dt> |
|
|
1722 | <dd> |
|
|
1723 | Set the callback to be called when the timer triggers. |
|
|
1724 | </dd> |
|
|
1725 | <p></p> |
|
|
1726 | <dt><strong>$pw = $timer->start ($pid)</strong><br /> |
|
|
1727 | </dt> |
|
|
1728 | <dd> |
|
|
1729 | Tells the wqtcher to start watching for process <code>$pid</code>. |
|
|
1730 | </dd> |
|
|
1731 | <p></p> |
|
|
1732 | <dt><strong>$pw = $pw->stop</strong><br /> |
|
|
1733 | </dt> |
|
|
1734 | <dd> |
|
|
1735 | Stop the watcher. |
1122 | </dd> |
1736 | </dd> |
1123 | <p></p></dl> |
1737 | <p></p></dl> |
1124 | <p> |
1738 | <p> |
1125 | </p> |
1739 | </p> |
1126 | <hr /> |
1740 | <hr /> |
… | |
… | |
1133 | <dl> |
1747 | <dl> |
1134 | <dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br /> |
1748 | <dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br /> |
1135 | </dt> |
1749 | </dt> |
1136 | <dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">>= 3 - script loading and management</a></strong><br /> |
1750 | <dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">>= 3 - script loading and management</a></strong><br /> |
1137 | </dt> |
1751 | </dt> |
1138 | <dt><strong><a name="item__3e_3d10__2d_all_events_received">>=10 - all events received</a></strong><br /> |
1752 | <dt><strong><a name="item__3e_3d10__2d_all_called_hooks">>=10 - all called hooks</a></strong><br /> |
|
|
1753 | </dt> |
|
|
1754 | <dt><strong><a name="item__3e_3d11__2d_hook_reutrn_values">>=11 - hook reutrn values</a></strong><br /> |
1139 | </dt> |
1755 | </dt> |
1140 | </dl> |
1756 | </dl> |
1141 | <p> |
1757 | <p> |
1142 | </p> |
1758 | </p> |
1143 | <hr /> |
1759 | <hr /> |