|
|
1 | <?xml version="1.0" ?> |
1 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> |
2 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> |
2 | <html xmlns="http://www.w3.org/1999/xhtml"> |
3 | <html xmlns="http://www.w3.org/1999/xhtml"> |
3 | <head> |
4 | <head> |
4 | <title>rxvtperl - rxvt-unicode's embedded perl interpreter</title> |
5 | <title>rxvtperl - rxvt-unicode's embedded perl interpreter</title> |
|
|
6 | <meta http-equiv="content-type" content="text/html; charset=utf-8" /> |
5 | <link rev="made" href="mailto:perl-binary@plan9.de" /> |
7 | <link rev="made" href="mailto:perl-binary@plan9.de" /> |
6 | </head> |
8 | </head> |
7 | |
9 | |
8 | <body style="background-color: white"> |
10 | <body style="background-color: white"> |
9 | |
11 | |
… | |
… | |
28 | <li><a href="#the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></li> |
30 | <li><a href="#the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></li> |
29 | <li><a href="#the_urxvt__term_class">The <code>urxvt::term</code> Class</a></li> |
31 | <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> |
32 | <li><a href="#the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></li> |
31 | <li><a href="#the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></li> |
33 | <li><a href="#the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></li> |
32 | <li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li> |
34 | <li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li> |
|
|
35 | <li><a href="#the_urxvt__iw_class">The <code>urxvt::iw</code> Class</a></li> |
|
|
36 | <li><a href="#the_urxvt__pw_class">The <code>urxvt::pw</code> Class</a></li> |
33 | </ul> |
37 | </ul> |
34 | |
38 | |
35 | <li><a href="#environment">ENVIRONMENT</a></li> |
39 | <li><a href="#environment">ENVIRONMENT</a></li> |
36 | <ul> |
40 | <ul> |
37 | |
41 | |
… | |
… | |
80 | <p>This section describes the extensions delivered with this release. You can |
84 | <p>This section describes the extensions delivered with this release. You can |
81 | find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> |
85 | find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> |
82 | <p>You can activate them like this:</p> |
86 | <p>You can activate them like this:</p> |
83 | <pre> |
87 | <pre> |
84 | rxvt -pe <extensionname></pre> |
88 | rxvt -pe <extensionname></pre> |
|
|
89 | <p>Or by adding them to the resource for extensions loaded by default:</p> |
|
|
90 | <pre> |
|
|
91 | URxvt.perl-ext-common: default,automove-background,selection-autotransform</pre> |
85 | <dl> |
92 | <dl> |
86 | <dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br /> |
93 | <dt><strong><a name="item_selection">selection (enabled by default)</a></strong> |
87 | </dt> |
94 | |
88 | <dd> |
95 | <dd> |
89 | (More) intelligent selection. This extension tries to be more intelligent |
96 | <p>(More) intelligent selection. This extension tries to be more intelligent |
90 | when the user extends selections (double-click and further clicks). Right |
97 | when the user extends selections (double-click and further clicks). Right |
91 | now, it tries to select words, urls and complete shell-quoted |
98 | now, it tries to select words, urls and complete shell-quoted |
92 | arguments, which is very convenient, too, if your <em>ls</em> supports |
99 | arguments, which is very convenient, too, if your <em>ls</em> supports |
93 | <code>--quoting-style=shell</code>. |
100 | <code>--quoting-style=shell</code>.</p> |
94 | </dd> |
101 | </dd> |
95 | <dd> |
102 | <dd> |
96 | <p>A double-click usually selects the word under the cursor, further clicks |
103 | <p>A double-click usually selects the word under the cursor, further clicks |
97 | will enlarge the selection.</p> |
104 | will enlarge the selection.</p> |
98 | </dd> |
105 | </dd> |
… | |
… | |
116 | <dd> |
123 | <dd> |
117 | <pre> |
124 | <pre> |
118 | URxvt.selection.pattern-0: \\|([^|]+)\\|</pre> |
125 | URxvt.selection.pattern-0: \\|([^|]+)\\|</pre> |
119 | </dd> |
126 | </dd> |
120 | <dd> |
127 | <dd> |
|
|
128 | <p>Another example: Programs I use often output ``absolute path: '' at the |
|
|
129 | beginning of a line when they process multiple files. The following |
|
|
130 | pattern matches the filename (note, there is a single space at the very |
|
|
131 | end):</p> |
|
|
132 | </dd> |
|
|
133 | <dd> |
|
|
134 | <pre> |
|
|
135 | URxvt.selection.pattern-0: ^(/[^:]+):\</pre> |
|
|
136 | </dd> |
|
|
137 | <dd> |
121 | <p>You can look at the source of the selection extension to see more |
138 | <p>You can look at the source of the selection extension to see more |
122 | interesting uses, such as parsing a line from beginning to end.</p> |
139 | interesting uses, such as parsing a line from beginning to end.</p> |
123 | </dd> |
140 | </dd> |
124 | <dd> |
141 | <dd> |
125 | <p>This extension also offers following bindable keyboard commands:</p> |
142 | <p>This extension also offers following bindable keyboard commands:</p> |
126 | </dd> |
143 | </dd> |
127 | <dl> |
144 | <dl> |
128 | <dt><strong><a name="item_rot13">rot13</a></strong><br /> |
145 | <dt><strong><a name="item_rot13">rot13</a></strong> |
129 | </dt> |
146 | |
130 | <dd> |
147 | <dd> |
131 | Rot-13 the selection when activated. Used via keyboard trigger: |
148 | <p>Rot-13 the selection when activated. Used via keyboard trigger:</p> |
132 | </dd> |
149 | </dd> |
133 | <dd> |
150 | <dd> |
134 | <pre> |
151 | <pre> |
135 | URxvt.keysym.C-M-r: perl:selection:rot13</pre> |
152 | URxvt.keysym.C-M-r: perl:selection:rot13</pre> |
136 | </dd> |
153 | </dd> |
137 | <p></p></dl> |
154 | </li> |
|
|
155 | </dl> |
138 | <dt><strong><a name="item_popup">option-popup (enabled by default)</a></strong><br /> |
156 | <dt><strong><a name="item_popup">option-popup (enabled by default)</a></strong> |
139 | </dt> |
157 | |
140 | <dd> |
158 | <dd> |
141 | Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at |
159 | <p>Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at |
142 | runtime. |
160 | runtime.</p> |
|
|
161 | </dd> |
143 | </dd> |
162 | <dd> |
144 | <p></p> |
163 | <p>Other extensions can extend this popup menu by pushing a code reference |
|
|
164 | onto <code>@{ $term-</code>{option_popup_hook} }>, which gets called whenever the |
|
|
165 | popup is being displayed.</p> |
|
|
166 | </dd> |
|
|
167 | <dd> |
|
|
168 | <p>It's sole argument is the popup menu, which can be modified. It should |
|
|
169 | either return nothing or a string, the initial boolean value and a code |
|
|
170 | reference. The string will be used as button text and the code reference |
|
|
171 | will be called when the toggle changes, with the new boolean value as |
|
|
172 | first argument.</p> |
|
|
173 | </dd> |
|
|
174 | <dd> |
|
|
175 | <p>The following will add an entry <code>myoption</code> that changes |
|
|
176 | <code>$self-</code>{myoption}>:</p> |
|
|
177 | </dd> |
|
|
178 | <dd> |
|
|
179 | <pre> |
|
|
180 | push @{ $self->{term}{option_popup_hook} }, sub { |
|
|
181 | ("my option" => $myoption, sub { $self->{myoption} = $_[0] }) |
|
|
182 | };</pre> |
|
|
183 | </dd> |
|
|
184 | </li> |
145 | <dt><strong>selection-popup (enabled by default)</strong><br /> |
185 | <dt><strong>selection-popup (enabled by default)</strong> |
146 | </dt> |
186 | |
147 | <dd> |
187 | <dd> |
148 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
188 | <p>Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
149 | text into various other formats/action (such as uri unescaping, perl |
189 | text into various other formats/action (such as uri unescaping, perl |
150 | evalution, web-browser starting etc.), depending on content. |
190 | evaluation, web-browser starting etc.), depending on content.</p> |
|
|
191 | </dd> |
151 | </dd> |
192 | <dd> |
152 | <p></p> |
193 | <p>Other extensions can extend this popup menu by pushing a code reference |
|
|
194 | onto <code>@{ $term-</code>{selection_popup_hook} }>, which gets called whenever the |
|
|
195 | popup is being displayed.</p> |
|
|
196 | </dd> |
|
|
197 | <dd> |
|
|
198 | <p>It's sole argument is the popup menu, which can be modified. The selection |
|
|
199 | is in <code>$_</code>, which can be used to decide wether to add something or not. |
|
|
200 | It should either return nothing or a string and a code reference. The |
|
|
201 | string will be used as button text and the code reference will be called |
|
|
202 | when the button gets activated and should transform <code>$_</code>.</p> |
|
|
203 | </dd> |
|
|
204 | <dd> |
|
|
205 | <p>The following will add an entry <code>a to b</code> that transforms all <code>a</code>s in |
|
|
206 | the selection to <code>b</code>s, but only if the selection currently contains any |
|
|
207 | <code>a</code>s:</p> |
|
|
208 | </dd> |
|
|
209 | <dd> |
|
|
210 | <pre> |
|
|
211 | push @{ $self->{term}{selection_popup_hook} }, sub { |
|
|
212 | /a/ ? ("a to be" => sub { s/a/b/g } |
|
|
213 | : () |
|
|
214 | };</pre> |
|
|
215 | </dd> |
|
|
216 | </li> |
153 | <dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback<hotkey> (enabled by default)</a></strong><br /> |
217 | <dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback<hotkey> (enabled by default)</a></strong> |
154 | </dt> |
218 | |
155 | <dd> |
219 | <dd> |
156 | Adds regex search functionality to the scrollback buffer, triggered |
220 | <p>Adds regex search functionality to the scrollback buffer, triggered |
157 | by a hotkey (default: <code>M-s</code>). While in search mode, normal terminal |
221 | by a hotkey (default: <code>M-s</code>). While in search mode, normal terminal |
158 | input/output is suspended and a regex is displayed at the bottom of the |
222 | input/output is suspended and a regex is displayed at the bottom of the |
159 | screen. |
223 | screen.</p> |
160 | </dd> |
224 | </dd> |
161 | <dd> |
225 | <dd> |
162 | <p>Inputting characters appends them to the regex and continues incremental |
226 | <p>Inputting characters appends them to the regex and continues incremental |
163 | search. <code>BackSpace</code> removes a character from the regex, <code>Up</code> and <code>Down</code> |
227 | search. <code>BackSpace</code> removes a character from the regex, <code>Up</code> and <code>Down</code> |
164 | search upwards/downwards in the scrollback buffer, <code>End</code> jumps to the |
228 | search upwards/downwards in the scrollback buffer, <code>End</code> jumps to the |
165 | bottom. <code>Escape</code> leaves search mode and returns to the point where search |
229 | bottom. <code>Escape</code> leaves search mode and returns to the point where search |
166 | was started, while <code>Enter</code> or <code>Return</code> stay at the current position and |
230 | was started, while <code>Enter</code> or <code>Return</code> stay at the current position and |
167 | additionally stores the first match in the current line into the primary |
231 | additionally stores the first match in the current line into the primary |
168 | selection.</p> |
232 | selection.</p> |
169 | </dd> |
233 | </dd> |
170 | <p></p> |
234 | <dd> |
|
|
235 | <p>The regex defaults to ``(?i)'', resulting in a case-insensitive search. To |
|
|
236 | get a case-sensitive search you can delete this prefix using <code>BackSpace</code> |
|
|
237 | or simply use an uppercase character which removes the ``(?i)'' prefix.</p> |
|
|
238 | </dd> |
|
|
239 | <dd> |
|
|
240 | <p>See <em>perlre</em> for more info about perl regular expression syntax.</p> |
|
|
241 | </dd> |
|
|
242 | </li> |
|
|
243 | <dt><strong><a name="item_readline">readline (enabled by default)</a></strong> |
|
|
244 | |
|
|
245 | <dd> |
|
|
246 | <p>A support package that tries to make editing with readline easier. At |
|
|
247 | the moment, it reacts to clicking shift-left mouse button by trying to |
|
|
248 | move the text cursor to this position. It does so by generating as many |
|
|
249 | cursor-left or cursor-right keypresses as required (the this only works |
|
|
250 | for programs that correctly support wide characters).</p> |
|
|
251 | </dd> |
|
|
252 | <dd> |
|
|
253 | <p>To avoid too many false positives, this is only done when:</p> |
|
|
254 | </dd> |
|
|
255 | <dl> |
|
|
256 | <dt><strong><a name="item__2d_the_tty_is_in_icanon_state_2e">- the tty is in ICANON state.</a></strong> |
|
|
257 | |
|
|
258 | <dt><strong><a name="item__2d_the_text_cursor_is_visible_2e">- the text cursor is visible.</a></strong> |
|
|
259 | |
|
|
260 | <dt><strong><a name="item__2d_the_primary_screen_is_currently_being_displaye">- the primary screen is currently being displayed.</a></strong> |
|
|
261 | |
|
|
262 | <dt><strong><a name="item_same">- the mouse is on the same (multi-row-) line as the text cursor.</a></strong> |
|
|
263 | |
|
|
264 | </dl> |
|
|
265 | <p>The normal selection mechanism isn't disabled, so quick successive clicks |
|
|
266 | might interfere with selection creation in harmless ways.</p> |
171 | <dt><strong><a name="item_selection_2dautotransform">selection-autotransform</a></strong><br /> |
267 | <dt><strong><a name="item_selection_2dautotransform">selection-autotransform</a></strong> |
172 | </dt> |
268 | |
173 | <dd> |
269 | <dd> |
174 | This selection allows you to do automatic transforms on a selection |
270 | <p>This selection allows you to do automatic transforms on a selection |
175 | whenever a selection is made. |
271 | whenever a selection is made.</p> |
176 | </dd> |
272 | </dd> |
177 | <dd> |
273 | <dd> |
178 | <p>It works by specifying perl snippets (most useful is a single <code>s///</code> |
274 | <p>It works by specifying perl snippets (most useful is a single <code>s///</code> |
179 | operator) that modify <code>$_</code> as resources:</p> |
275 | operator) that modify <code>$_</code> as resources:</p> |
180 | </dd> |
276 | </dd> |
… | |
… | |
197 | <p>And this example matches the same,but replaces it with vi-commands you can |
293 | <p>And this example matches the same,but replaces it with vi-commands you can |
198 | paste directly into your (vi :) editor:</p> |
294 | paste directly into your (vi :) editor:</p> |
199 | </dd> |
295 | </dd> |
200 | <dd> |
296 | <dd> |
201 | <pre> |
297 | <pre> |
202 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/</pre> |
298 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/</pre> |
203 | </dd> |
299 | </dd> |
204 | <dd> |
300 | <dd> |
205 | <p>Of course, this can be modified to suit your needs and your editor :)</p> |
301 | <p>Of course, this can be modified to suit your needs and your editor :)</p> |
206 | </dd> |
302 | </dd> |
207 | <dd> |
303 | <dd> |
208 | <p>To expand the example above to typical perl error messages (``XXX at |
304 | <p>To expand the example above to typical perl error messages (``XXX at |
209 | FILENAME line YYY.''), you need a slightly more elaborate solution:</p> |
305 | FILENAME line YYY.''), you need a slightly more elaborate solution:</p> |
210 | </dd> |
306 | </dd> |
211 | <dd> |
307 | <dd> |
212 | <pre> |
308 | <pre> |
213 | URxvt.selection.pattern-0: ( at .*? line \\d+\\.) |
309 | URxvt.selection.pattern-0: ( at .*? line \\d+[,.]) |
214 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/</pre> |
310 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/</pre> |
215 | </dd> |
311 | </dd> |
216 | <dd> |
312 | <dd> |
217 | <p>The first line tells the selection code to treat the unchanging part of |
313 | <p>The first line tells the selection code to treat the unchanging part of |
218 | every error message as a selection pattern, and the second line transforms |
314 | every error message as a selection pattern, and the second line transforms |
219 | the message into vi commands to load the file.</p> |
315 | the message into vi commands to load the file.</p> |
220 | </dd> |
316 | </dd> |
221 | <p></p> |
317 | </li> |
|
|
318 | <dt><strong><a name="item_tabbed">tabbed</a></strong> |
|
|
319 | |
|
|
320 | <dd> |
|
|
321 | <p>This transforms the terminal into a tabbar with additional terminals, that |
|
|
322 | is, it implements what is commonly refered to as ``tabbed terminal''. The topmost line |
|
|
323 | displays a ``[NEW]'' button, which, when clicked, will add a new tab, followed by one |
|
|
324 | button per tab.</p> |
|
|
325 | </dd> |
|
|
326 | <dd> |
|
|
327 | <p>Clicking a button will activate that tab. Pressing <strong>Shift-Left</strong> and |
|
|
328 | <strong>Shift-Right</strong> will switch to the tab left or right of the current one, |
|
|
329 | while <strong>Shift-Down</strong> creates a new tab.</p> |
|
|
330 | </dd> |
|
|
331 | <dd> |
|
|
332 | <p>The tabbar itself can be configured similarly to a normal terminal, but |
|
|
333 | with a resource class of <code>URxvt.tabbed</code>. In addition, it supports the |
|
|
334 | following four resources (shown with defaults):</p> |
|
|
335 | </dd> |
|
|
336 | <dd> |
|
|
337 | <pre> |
|
|
338 | URxvt.tabbed.tabbar-fg: <colour-index, default 3> |
|
|
339 | URxvt.tabbed.tabbar-bg: <colour-index, default 0> |
|
|
340 | URxvt.tabbed.tab-fg: <colour-index, default 0> |
|
|
341 | URxvt.tabbed.tab-bg: <colour-index, default 1></pre> |
|
|
342 | </dd> |
|
|
343 | <dd> |
|
|
344 | <p>See <em>COLOR AND GRAPHICS</em> in the <code>rxvt(1)</code> manpage for valid |
|
|
345 | indices.</p> |
|
|
346 | </dd> |
|
|
347 | </li> |
222 | <dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> |
348 | <dt><strong><a name="item_mark_2durls">mark-urls</a></strong> |
223 | </dt> |
349 | |
224 | <dd> |
350 | <dd> |
225 | Uses per-line display filtering (<code>on_line_update</code>) to underline urls and |
351 | <p>Uses per-line display filtering (<code>on_line_update</code>) to underline urls and |
226 | make them clickable. When middle-clicked, the program specified in the |
352 | make them clickable. When middle-clicked, the program specified in the |
227 | resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with |
353 | resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with |
228 | the URL as first argument. |
354 | the URL as first argument.</p> |
|
|
355 | </dd> |
|
|
356 | </li> |
|
|
357 | <dt><strong><a name="item_xim_2donthespot">xim-onthespot</a></strong> |
|
|
358 | |
229 | </dd> |
359 | <dd> |
230 | <p></p> |
360 | <p>This (experimental) perl extension implements OnTheSpot editing. It does |
|
|
361 | not work perfectly, and some input methods don't seem to work well with |
|
|
362 | OnTheSpot editing in general, but it seems to work at leats for SCIM and |
|
|
363 | kinput2.</p> |
|
|
364 | </dd> |
|
|
365 | <dd> |
|
|
366 | <p>You enable it by specifying this extension and a preedit style of |
|
|
367 | <code>OnTheSpot</code>, i.e.:</p> |
|
|
368 | </dd> |
|
|
369 | <dd> |
|
|
370 | <pre> |
|
|
371 | rxvt -pt OnTheSpot -pe xim-onthespot</pre> |
|
|
372 | </dd> |
|
|
373 | </li> |
|
|
374 | <dt><strong><a name="item_automove_2dbackground">automove-background</a></strong> |
|
|
375 | |
|
|
376 | <dd> |
|
|
377 | <p>This is basically a very small extension that dynamically changes the |
|
|
378 | background pixmap offset to the window position, in effect creating the |
|
|
379 | same effect as pseudo transparency with a custom pixmap. No scaling is |
|
|
380 | supported in this mode. Exmaple:</p> |
|
|
381 | </dd> |
|
|
382 | <dd> |
|
|
383 | <pre> |
|
|
384 | rxvt -pixmap background.xpm -pe automove-background</pre> |
|
|
385 | </dd> |
|
|
386 | </li> |
231 | <dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br /> |
387 | <dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong> |
232 | </dt> |
388 | |
233 | <dd> |
389 | <dd> |
234 | A not very useful example of filtering all text output to the terminal, |
390 | <p>A not very useful example of filtering all text output to the terminal |
235 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
391 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
236 | similar-looking ascii character. |
392 | similar-looking ascii character.</p> |
237 | </dd> |
393 | </dd> |
238 | <p></p> |
394 | </li> |
239 | <dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> |
395 | <dt><strong><a name="item_digital_2dclock">digital-clock</a></strong> |
240 | </dt> |
396 | |
241 | <dd> |
397 | <dd> |
242 | Displays a digital clock using the built-in overlay. |
398 | <p>Displays a digital clock using the built-in overlay.</p> |
243 | </dd> |
|
|
244 | <p></p> |
|
|
245 | <dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> |
|
|
246 | </dt> |
|
|
247 | <dd> |
399 | </dd> |
248 | Displays a very simple digital clock in the upper right corner of the |
400 | </li> |
249 | window. Illustrates overwriting the refresh callbacks to create your own |
401 | <dt><strong><a name="item_remote_2dclipboard">remote-clipboard</a></strong> |
250 | overlays or changes. |
402 | |
251 | </dd> |
403 | <dd> |
252 | <p></p> |
404 | <p>Somewhat of a misnomer, this extension adds two menu entries to the |
|
|
405 | selection popup that allows one ti run external commands to store the |
|
|
406 | selection somewhere and fetch it again.</p> |
|
|
407 | </dd> |
|
|
408 | <dd> |
|
|
409 | <p>We use it to implement a ``distributed selection mechanism'', which just |
|
|
410 | means that one command uploads the file to a remote server, and another |
|
|
411 | reads it.</p> |
|
|
412 | </dd> |
|
|
413 | <dd> |
|
|
414 | <p>The commands can be set using the <code>URxvt.remote-selection.store</code> and |
|
|
415 | <code>URxvt.remote-selection.fetch</code> resources. The first should read the |
|
|
416 | selection to store from STDIN (always in UTF-8), the second should provide |
|
|
417 | the selection data on STDOUT (also in UTF-8).</p> |
|
|
418 | </dd> |
|
|
419 | <dd> |
|
|
420 | <p>The defaults (which are likely useless to you) use rsh and cat:</p> |
|
|
421 | </dd> |
|
|
422 | <dd> |
|
|
423 | <pre> |
|
|
424 | URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' |
|
|
425 | URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'</pre> |
|
|
426 | </dd> |
|
|
427 | </li> |
253 | <dt><strong><a name="item_selection_2dpastebin">selection-pastebin</a></strong><br /> |
428 | <dt><strong><a name="item_selection_2dpastebin">selection-pastebin</a></strong> |
254 | </dt> |
429 | |
255 | <dd> |
430 | <dd> |
256 | This is a little rarely useful extension that Uploads the selection as |
431 | <p>This is a little rarely useful extension that Uploads the selection as |
257 | textfile to a remote site (or does other things). (The implementation is |
432 | textfile to a remote site (or does other things). (The implementation is |
258 | not currently secure for use in a multiuser environment as it writes to |
433 | not currently secure for use in a multiuser environment as it writes to |
259 | <em>/tmp</em> directly.). |
434 | <em>/tmp</em> directly.).</p> |
260 | </dd> |
435 | </dd> |
261 | <dd> |
436 | <dd> |
262 | <p>It listens to the <code>selection-pastebin:remote-pastebin</code> keyboard command, |
437 | <p>It listens to the <code>selection-pastebin:remote-pastebin</code> keyboard command, |
263 | i.e.</p> |
438 | i.e.</p> |
264 | </dd> |
439 | </dd> |
… | |
… | |
289 | </dd> |
464 | </dd> |
290 | <dd> |
465 | <dd> |
291 | <pre> |
466 | <pre> |
292 | URxvt.selection-pastebin.url: <a href="http://www.ta-sa.org/files/txt/%">http://www.ta-sa.org/files/txt/%</a></pre> |
467 | URxvt.selection-pastebin.url: <a href="http://www.ta-sa.org/files/txt/%">http://www.ta-sa.org/files/txt/%</a></pre> |
293 | </dd> |
468 | </dd> |
294 | <p></p></dl> |
469 | </li> |
|
|
470 | <dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong> |
|
|
471 | |
|
|
472 | <dd> |
|
|
473 | <p>Displays a very simple digital clock in the upper right corner of the |
|
|
474 | window. Illustrates overwriting the refresh callbacks to create your own |
|
|
475 | overlays or changes.</p> |
|
|
476 | </dd> |
|
|
477 | </li> |
|
|
478 | </dl> |
295 | <p> |
479 | <p> |
296 | </p> |
480 | </p> |
297 | <hr /> |
481 | <hr /> |
298 | <h1><a name="api_documentation">API DOCUMENTATION</a></h1> |
482 | <h1><a name="api_documentation">API DOCUMENTATION</a></h1> |
299 | <p> |
483 | <p> |
… | |
… | |
309 | the like inside the terminal object so they get destroyed as soon as the |
493 | the like inside the terminal object so they get destroyed as soon as the |
310 | terminal is destroyed.</p> |
494 | terminal is destroyed.</p> |
311 | <p>Argument names also often indicate the type of a parameter. Here are some |
495 | <p>Argument names also often indicate the type of a parameter. Here are some |
312 | hints on what they mean:</p> |
496 | hints on what they mean:</p> |
313 | <dl> |
497 | <dl> |
314 | <dt><strong><a name="item__24text">$text</a></strong><br /> |
498 | <dt><strong><a name="item__text">$text</a></strong> |
315 | </dt> |
499 | |
316 | <dd> |
500 | <dd> |
317 | Rxvt-unicodes special way of encoding text, where one ``unicode'' character |
501 | <p>Rxvt-unicodes special way of encoding text, where one ``unicode'' character |
318 | always represents one screen cell. See <a href="#item_row_t">ROW_t</a> for a discussion of this format. |
502 | always represents one screen cell. See <a href="#item_row_t">ROW_t</a> for a discussion of this format.</p> |
319 | </dd> |
503 | </dd> |
320 | <p></p> |
504 | </li> |
321 | <dt><strong><a name="item__24string">$string</a></strong><br /> |
505 | <dt><strong><a name="item__string">$string</a></strong> |
322 | </dt> |
506 | |
323 | <dd> |
507 | <dd> |
324 | A perl text string, with an emphasis on <em>text</em>. It can store all unicode |
508 | <p>A perl text string, with an emphasis on <em>text</em>. It can store all unicode |
325 | characters and is to be distinguished with text encoded in a specific |
509 | characters and is to be distinguished with text encoded in a specific |
326 | encoding (often locale-specific) and binary data. |
510 | encoding (often locale-specific) and binary data.</p> |
327 | </dd> |
511 | </dd> |
328 | <p></p> |
512 | </li> |
329 | <dt><strong><a name="item__24octets">$octets</a></strong><br /> |
513 | <dt><strong><a name="item__octets">$octets</a></strong> |
330 | </dt> |
514 | |
331 | <dd> |
515 | <dd> |
332 | Either binary data or - more common - a text string encoded in a |
516 | <p>Either binary data or - more common - a text string encoded in a |
333 | locale-specific way. |
517 | locale-specific way.</p> |
|
|
518 | </dd> |
|
|
519 | </li> |
334 | </dd> |
520 | </dl> |
335 | <p></p></dl> |
|
|
336 | <p> |
521 | <p> |
337 | </p> |
522 | </p> |
338 | <h2><a name="extension_objects">Extension Objects</a></h2> |
523 | <h2><a name="extension_objects">Extension Objects</a></h2> |
339 | <p>Very perl extension is a perl class. A separate perl object is created |
524 | <p>Every perl extension is a perl class. A separate perl object is created |
340 | for each terminal and each extension and passed as the first parameter to |
525 | for each terminal and each extension and passed as the first parameter to |
341 | hooks. So extensions can use their <code>$self</code> object without having to think |
526 | hooks. So extensions can use their <code>$self</code> object without having to think |
342 | about other extensions, with the exception of methods and members that |
527 | about other extensions, with the exception of methods and members that |
343 | begin with an underscore character <code>_</code>: these are reserved for internal |
528 | begin with an underscore character <code>_</code>: these are reserved for internal |
344 | use.</p> |
529 | use.</p> |
345 | <p>Although it isn't a <code>urxvt::term</code> object, you can call all methods of the |
530 | <p>Although it isn't a <code>urxvt::term</code> object, you can call all methods of the |
346 | <code>urxvt::term</code> class on this object.</p> |
531 | <code>urxvt::term</code> class on this object.</p> |
347 | <p>It has the following methods and data members:</p> |
532 | <p>It has the following methods and data members:</p> |
348 | <dl> |
533 | <dl> |
349 | <dt><strong><a name="item__24urxvt_term__3d__24self_2d_3e_7bterm_7d">$urxvt_term = $self->{term}</a></strong><br /> |
534 | <dt><strong><a name="item__urxvt_term">$urxvt_term = $self->{term}</a></strong> |
350 | </dt> |
535 | |
351 | <dd> |
536 | <dd> |
352 | Returns the <code>urxvt::term</code> object associated with this instance of the |
537 | <p>Returns the <code>urxvt::term</code> object associated with this instance of the |
353 | extension. This member <em>must not</em> be changed in any way. |
538 | extension. This member <em>must not</em> be changed in any way.</p> |
354 | </dd> |
539 | </dd> |
355 | <p></p> |
540 | </li> |
356 | <dt><strong><a name="item_enable">$self->enable ($hook_name => $cb, [$hook_name => $cb..])</a></strong><br /> |
541 | <dt><strong><a name="item_enable">$self->enable ($hook_name => $cb, [$hook_name => $cb..])</a></strong> |
357 | </dt> |
542 | |
358 | <dd> |
543 | <dd> |
359 | Dynamically enable the given hooks (named without the <code>on_</code> prefix) for |
544 | <p>Dynamically enable the given hooks (named without the <code>on_</code> prefix) for |
360 | this extension, replacing any previous hook. This is useful when you want |
545 | this extension, replacing any previous hook. This is useful when you want |
361 | to overwrite time-critical hooks only temporarily. |
546 | to overwrite time-critical hooks only temporarily.</p> |
362 | </dd> |
547 | </dd> |
363 | <p></p> |
548 | </li> |
364 | <dt><strong><a name="item_disable">$self->disable ($hook_name[, $hook_name..])</a></strong><br /> |
549 | <dt><strong><a name="item_disable">$self->disable ($hook_name[, $hook_name..])</a></strong> |
365 | </dt> |
550 | |
366 | <dd> |
551 | <dd> |
367 | Dynamically disable the given hooks. |
552 | <p>Dynamically disable the given hooks.</p> |
|
|
553 | </dd> |
|
|
554 | </li> |
368 | </dd> |
555 | </dl> |
369 | <p></p></dl> |
|
|
370 | <p> |
556 | <p> |
371 | </p> |
557 | </p> |
372 | <h2><a name="hooks">Hooks</a></h2> |
558 | <h2><a name="hooks">Hooks</a></h2> |
373 | <p>The following subroutines can be declared in extension files, and will be |
559 | <p>The following subroutines can be declared in extension files, and will be |
374 | called whenever the relevant event happens.</p> |
560 | called whenever the relevant event happens.</p> |
375 | <p>The first argument passed to them is an extension oject as described in |
561 | <p>The first argument passed to them is an extension oject as described in |
376 | the in the <code>Extension Objects</code> section.</p> |
562 | the in the <code>Extension Objects</code> section.</p> |
377 | <p><strong>All</strong> of these hooks must return a boolean value. If it is true, then the |
563 | <p><strong>All</strong> of these hooks must return a boolean value. If any of the called |
378 | event counts as being <em>consumed</em>, and the invocation of other hooks is |
564 | hooks returns true, then the event counts as being <em>consumed</em>, and the |
379 | skipped, and the relevant action might not be carried out by the C++ code.</p> |
565 | relevant action might not be carried out by the C++ code.</p> |
380 | <p><em>When in doubt, return a false value (preferably <code>()</code>). </em>></p> |
566 | <p><em>When in doubt, return a false value (preferably <code>()</code>). </em>></p> |
381 | <dl> |
567 | <dl> |
382 | <dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> |
568 | <dt><strong><a name="item_on_init__24term">on_init $term</a></strong> |
383 | </dt> |
569 | |
384 | <dd> |
570 | <dd> |
385 | Called after a new terminal object has been initialized, but before |
571 | <p>Called after a new terminal object has been initialized, but before |
386 | windows are created or the command gets run. Most methods are unsafe to |
572 | windows are created or the command gets run. Most methods are unsafe to |
387 | call or deliver senseless data, as terminal size and other characteristics |
573 | call or deliver senseless data, as terminal size and other characteristics |
388 | have not yet been determined. You can safely query and change resources, |
574 | have not yet been determined. You can safely query and change resources |
389 | though. |
575 | and options, though. For many purposes the <code>on_start</code> hook is a better |
|
|
576 | place.</p> |
|
|
577 | </dd> |
|
|
578 | </li> |
|
|
579 | <dt><strong><a name="item_on_start__24term">on_start $term</a></strong> |
|
|
580 | |
390 | </dd> |
581 | <dd> |
391 | <p></p> |
582 | <p>Called at the very end of initialisation of a new terminal, just before |
|
|
583 | trying to map (display) the toplevel and returning to the mainloop.</p> |
|
|
584 | </dd> |
|
|
585 | </li> |
|
|
586 | <dt><strong><a name="item_on_destroy__24term">on_destroy $term</a></strong> |
|
|
587 | |
|
|
588 | <dd> |
|
|
589 | <p>Called whenever something tries to destroy terminal, when the terminal is |
|
|
590 | still fully functional (not for long, though).</p> |
|
|
591 | </dd> |
|
|
592 | </li> |
392 | <dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> |
593 | <dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong> |
393 | </dt> |
594 | |
394 | <dd> |
595 | <dd> |
395 | Called after the screen is ``reset'' for any reason, such as resizing or |
596 | <p>Called after the screen is ``reset'' for any reason, such as resizing or |
396 | control sequences. Here is where you can react on changes to size-related |
597 | control sequences. Here is where you can react on changes to size-related |
397 | variables. |
598 | variables.</p> |
398 | </dd> |
|
|
399 | <p></p> |
|
|
400 | <dt><strong><a name="item_on_start__24term">on_start $term</a></strong><br /> |
|
|
401 | </dt> |
|
|
402 | <dd> |
599 | </dd> |
403 | Called at the very end of initialisation of a new terminal, just before |
600 | </li> |
404 | returning to the mainloop. |
601 | <dt><strong><a name="item_on_child_start__24term_2c__24pid">on_child_start $term, $pid</a></strong> |
|
|
602 | |
405 | </dd> |
603 | <dd> |
406 | <p></p> |
604 | <p>Called just after the child process has been <code>fork</code>ed.</p> |
|
|
605 | </dd> |
|
|
606 | </li> |
|
|
607 | <dt><strong><a name="item_on_child_exit__24term_2c__24status">on_child_exit $term, $status</a></strong> |
|
|
608 | |
|
|
609 | <dd> |
|
|
610 | <p>Called just after the child process has exited. <code>$status</code> is the status |
|
|
611 | from <code>waitpid</code>.</p> |
|
|
612 | </dd> |
|
|
613 | </li> |
407 | <dt><strong><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a></strong><br /> |
614 | <dt><strong><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a></strong> |
408 | </dt> |
615 | |
409 | <dd> |
616 | <dd> |
410 | Called whenever a selection has been made by the user, but before the |
617 | <p>Called whenever a selection has been made by the user, but before the |
411 | selection text is copied, so changes to the beginning, end or type of the |
618 | selection text is copied, so changes to the beginning, end or type of the |
412 | selection will be honored. |
619 | selection will be honored.</p> |
413 | </dd> |
620 | </dd> |
414 | <dd> |
621 | <dd> |
415 | <p>Returning a true value aborts selection making by urxvt, in which case you |
622 | <p>Returning a true value aborts selection making by urxvt, in which case you |
416 | have to make a selection yourself by calling <a href="#item_selection_grab"><code>$term->selection_grab</code></a>.</p> |
623 | have to make a selection yourself by calling <a href="#item_selection_grab"><code>$term->selection_grab</code></a>.</p> |
417 | </dd> |
624 | </dd> |
418 | <p></p> |
625 | </li> |
419 | <dt><strong><a name="item_on_sel_grab__24term_2c__24eventtime">on_sel_grab $term, $eventtime</a></strong><br /> |
626 | <dt><strong><a name="item_on_sel_grab__24term_2c__24eventtime">on_sel_grab $term, $eventtime</a></strong> |
420 | </dt> |
627 | |
421 | <dd> |
628 | <dd> |
422 | Called whenever a selection has been copied, but before the selection is |
629 | <p>Called whenever a selection has been copied, but before the selection is |
423 | requested from the server. The selection text can be queried and changed |
630 | requested from the server. The selection text can be queried and changed |
424 | by calling <a href="#item_selection"><code>$term->selection</code></a>. |
631 | by calling <a href="#item_selection"><code>$term->selection</code></a>.</p> |
425 | </dd> |
632 | </dd> |
426 | <dd> |
633 | <dd> |
427 | <p>Returning a true value aborts selection grabbing. It will still be hilighted.</p> |
634 | <p>Returning a true value aborts selection grabbing. It will still be hilighted.</p> |
428 | </dd> |
635 | </dd> |
429 | <p></p> |
636 | </li> |
430 | <dt><strong><a name="item_on_sel_extend__24term">on_sel_extend $term</a></strong><br /> |
637 | <dt><strong><a name="item_on_sel_extend__24term">on_sel_extend $term</a></strong> |
431 | </dt> |
638 | |
432 | <dd> |
639 | <dd> |
433 | Called whenever the user tries to extend the selection (e.g. with a double |
640 | <p>Called whenever the user tries to extend the selection (e.g. with a double |
434 | click) and is either supposed to return false (normal operation), or |
641 | click) and is either supposed to return false (normal operation), or |
435 | should extend the selection itelf and return true to suppress the built-in |
642 | should extend the selection itelf and return true to suppress the built-in |
436 | processing. This can happen multiple times, as long as the callback |
643 | processing. This can happen multiple times, as long as the callback |
437 | returns true, it will be called on every further click by the user and is |
644 | returns true, it will be called on every further click by the user and is |
438 | supposed to enlarge the selection more and more, if possible. |
645 | supposed to enlarge the selection more and more, if possible.</p> |
439 | </dd> |
646 | </dd> |
440 | <dd> |
647 | <dd> |
441 | <p>See the <em>selection</em> example extension.</p> |
648 | <p>See the <em>selection</em> example extension.</p> |
442 | </dd> |
649 | </dd> |
443 | <p></p> |
650 | </li> |
444 | <dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong><br /> |
651 | <dt><strong><a name="item_on_view_change__24term_2c__24offset">on_view_change $term, $offset</a></strong> |
445 | </dt> |
652 | |
446 | <dd> |
653 | <dd> |
447 | Called whenever the view offset changes, i..e the user or program |
654 | <p>Called whenever the view offset changes, i..e the user or program |
448 | scrolls. Offset <code>0</code> means display the normal terminal, positive values |
655 | scrolls. Offset <code>0</code> means display the normal terminal, positive values |
449 | show this many lines of scrollback. |
656 | show this many lines of scrollback.</p> |
450 | </dd> |
657 | </dd> |
451 | <p></p> |
658 | </li> |
452 | <dt><strong><a name="item_on_scroll_back__24term_2c__24lines_2c__24saved">on_scroll_back $term, $lines, $saved</a></strong><br /> |
659 | <dt><strong><a name="item_on_scroll_back__24term_2c__24lines_2c__24saved">on_scroll_back $term, $lines, $saved</a></strong> |
453 | </dt> |
660 | |
454 | <dd> |
661 | <dd> |
455 | Called whenever lines scroll out of the terminal area into the scrollback |
662 | <p>Called whenever lines scroll out of the terminal area into the scrollback |
456 | buffer. <code>$lines</code> is the number of lines scrolled out and may be larger |
663 | buffer. <code>$lines</code> is the number of lines scrolled out and may be larger |
457 | than the scroll back buffer or the terminal. |
664 | than the scroll back buffer or the terminal.</p> |
458 | </dd> |
665 | </dd> |
459 | <dd> |
666 | <dd> |
460 | <p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
667 | <p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
461 | $nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total |
668 | $nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total |
462 | number of lines that will be in the scrollback buffer.</p> |
669 | number of lines that will be in the scrollback buffer.</p> |
463 | </dd> |
670 | </dd> |
464 | <p></p> |
671 | </li> |
|
|
672 | <dt><strong><a name="item_on_osc_seq__24term_2c__24op_2c__24args">on_osc_seq $term, $op, $args</a></strong> |
|
|
673 | |
|
|
674 | <dd> |
|
|
675 | <p>Called on every OSC sequence and can be used to suppress it or modify its |
|
|
676 | behaviour. The default should be to return an empty list. A true value |
|
|
677 | suppresses execution of the request completely. Make sure you don't get |
|
|
678 | confused by recursive invocations when you output an osc sequence within |
|
|
679 | this callback.</p> |
|
|
680 | </dd> |
|
|
681 | <dd> |
|
|
682 | <p><code>on_osc_seq_perl</code> should be used for new behaviour.</p> |
|
|
683 | </dd> |
|
|
684 | </li> |
465 | <dt><strong><a name="item_on_osc_seq__24term_2c__24string">on_osc_seq $term, $string</a></strong><br /> |
685 | <dt><strong><a name="item_on_osc_seq_perl__24term_2c__24string">on_osc_seq_perl $term, $string</a></strong> |
466 | </dt> |
686 | |
467 | <dd> |
687 | <dd> |
468 | Called whenever the <strong>ESC ] 777 ; string ST</strong> command sequence (OSC = |
688 | <p>Called whenever the <strong>ESC ] 777 ; string ST</strong> command sequence (OSC = |
469 | operating system command) is processed. Cursor position and other state |
689 | operating system command) is processed. Cursor position and other state |
470 | information is up-to-date when this happens. For interoperability, the |
690 | information is up-to-date when this happens. For interoperability, the |
471 | string should start with the extension name and a colon, to distinguish |
691 | string should start with the extension name and a colon, to distinguish |
472 | it from commands for other extensions, and this might be enforced in the |
692 | it from commands for other extensions, and this might be enforced in the |
473 | future. |
693 | future.</p> |
474 | </dd> |
694 | </dd> |
475 | <dd> |
695 | <dd> |
476 | <p>Be careful not ever to trust (in a security sense) the data you receive, |
696 | <p>Be careful not ever to trust (in a security sense) the data you receive, |
477 | as its source can not easily be controleld (e-mail content, messages from |
697 | as its source can not easily be controleld (e-mail content, messages from |
478 | other users on the same system etc.).</p> |
698 | other users on the same system etc.).</p> |
479 | </dd> |
699 | </dd> |
480 | <p></p> |
700 | </li> |
481 | <dt><strong><a name="item_on_add_lines__24term_2c__24string">on_add_lines $term, $string</a></strong><br /> |
701 | <dt><strong><a name="item_on_add_lines__24term_2c__24string">on_add_lines $term, $string</a></strong> |
482 | </dt> |
702 | |
483 | <dd> |
703 | <dd> |
484 | Called whenever text is about to be output, with the text as argument. You |
704 | <p>Called whenever text is about to be output, with the text as argument. You |
485 | can filter/change and output the text yourself by returning a true value |
705 | can filter/change and output the text yourself by returning a true value |
486 | and calling <a href="#item_scr_add_lines"><code>$term->scr_add_lines</code></a> yourself. Please note that this |
706 | and calling <a href="#item_scr_add_lines"><code>$term->scr_add_lines</code></a> yourself. Please note that this |
487 | might be very slow, however, as your hook is called for <strong>all</strong> text being |
707 | might be very slow, however, as your hook is called for <strong>all</strong> text being |
488 | output. |
708 | output.</p> |
489 | </dd> |
709 | </dd> |
490 | <p></p> |
710 | </li> |
491 | <dt><strong><a name="item_on_tt_write__24term_2c__24octets">on_tt_write $term, $octets</a></strong><br /> |
711 | <dt><strong><a name="item_on_tt_write__24term_2c__24octets">on_tt_write $term, $octets</a></strong> |
492 | </dt> |
712 | |
493 | <dd> |
713 | <dd> |
494 | Called whenever some data is written to the tty/pty and can be used to |
714 | <p>Called whenever some data is written to the tty/pty and can be used to |
495 | suppress or filter tty input. |
715 | suppress or filter tty input.</p> |
496 | </dd> |
716 | </dd> |
497 | <p></p> |
717 | </li> |
498 | <dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong><br /> |
718 | <dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong> |
499 | </dt> |
719 | |
500 | <dd> |
720 | <dd> |
501 | Called whenever a line was updated or changed. Can be used to filter |
721 | <p>Called whenever a line was updated or changed. Can be used to filter |
502 | screen output (e.g. underline urls or other useless stuff). Only lines |
722 | screen output (e.g. underline urls or other useless stuff). Only lines |
503 | that are being shown will be filtered, and, due to performance reasons, |
723 | that are being shown will be filtered, and, due to performance reasons, |
504 | not always immediately. |
724 | not always immediately.</p> |
505 | </dd> |
725 | </dd> |
506 | <dd> |
726 | <dd> |
507 | <p>The row number is always the topmost row of the line if the line spans |
727 | <p>The row number is always the topmost row of the line if the line spans |
508 | multiple rows.</p> |
728 | multiple rows.</p> |
509 | </dd> |
729 | </dd> |
510 | <dd> |
730 | <dd> |
511 | <p>Please note that, if you change the line, then the hook might get called |
731 | <p>Please note that, if you change the line, then the hook might get called |
512 | later with the already-modified line (e.g. if unrelated parts change), so |
732 | later with the already-modified line (e.g. if unrelated parts change), so |
513 | you cannot just toggle rendition bits, but only set them.</p> |
733 | you cannot just toggle rendition bits, but only set them.</p> |
514 | </dd> |
734 | </dd> |
515 | <p></p> |
735 | </li> |
516 | <dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong><br /> |
736 | <dt><strong><a name="item_on_refresh_begin__24term">on_refresh_begin $term</a></strong> |
517 | </dt> |
737 | |
518 | <dd> |
738 | <dd> |
519 | Called just before the screen gets redrawn. Can be used for overlay |
739 | <p>Called just before the screen gets redrawn. Can be used for overlay |
520 | or similar effects by modify terminal contents in refresh_begin, and |
740 | or similar effects by modify terminal contents in refresh_begin, and |
521 | restoring them in refresh_end. The built-in overlay and selection display |
741 | restoring them in refresh_end. The built-in overlay and selection display |
522 | code is run after this hook, and takes precedence. |
742 | code is run after this hook, and takes precedence.</p> |
523 | </dd> |
743 | </dd> |
524 | <p></p> |
744 | </li> |
525 | <dt><strong><a name="item_on_refresh_end__24term">on_refresh_end $term</a></strong><br /> |
745 | <dt><strong><a name="item_on_refresh_end__24term">on_refresh_end $term</a></strong> |
526 | </dt> |
746 | |
527 | <dd> |
747 | <dd> |
528 | Called just after the screen gets redrawn. See <code>on_refresh_begin</code>. |
748 | <p>Called just after the screen gets redrawn. See <code>on_refresh_begin</code>.</p> |
529 | </dd> |
749 | </dd> |
530 | <p></p> |
750 | </li> |
531 | <dt><strong><a name="item_on_keyboard_command__24term_2c__24string">on_keyboard_command $term, $string</a></strong><br /> |
751 | <dt><strong><a name="item_on_user_command__24term_2c__24string">on_user_command $term, $string</a></strong> |
532 | </dt> |
752 | |
533 | <dd> |
753 | <dd> |
534 | Called whenever the user presses a key combination that has a |
754 | <p>Called whenever the a user-configured event is being activated (e.g. via |
535 | <code>perl:string</code> action bound to it (see description of the <strong>keysym</strong> |
755 | a <code>perl:string</code> action bound to a key, see description of the <strong>keysym</strong> |
536 | resource in the <code>rxvt(1)</code> manpage). |
756 | resource in the <code>rxvt(1)</code> manpage).</p> |
|
|
757 | </dd> |
537 | </dd> |
758 | <dd> |
538 | <p></p> |
759 | <p>The event is simply the action string. This interface is assumed to change |
|
|
760 | slightly in the future.</p> |
|
|
761 | </dd> |
|
|
762 | </li> |
|
|
763 | <dt><strong><a name="item_on_resize_all_windows__24tern_2c__24new_width_2c__">on_resize_all_windows $tern, $new_width, $new_height</a></strong> |
|
|
764 | |
|
|
765 | <dd> |
|
|
766 | <p>Called just after the new window size has been calculcated, but before |
|
|
767 | windows are actually being resized or hints are being set. If this hook |
|
|
768 | returns TRUE, setting of the window hints is being skipped.</p> |
|
|
769 | </dd> |
|
|
770 | </li> |
539 | <dt><strong><a name="item_on_x_event__24term_2c__24event">on_x_event $term, $event</a></strong><br /> |
771 | <dt><strong><a name="item_on_x_event__24term_2c__24event">on_x_event $term, $event</a></strong> |
540 | </dt> |
772 | |
541 | <dd> |
773 | <dd> |
542 | Called on every X event received on the vt window (and possibly other |
774 | <p>Called on every X event received on the vt window (and possibly other |
543 | windows). Should only be used as a last resort. Most event structure |
775 | windows). Should only be used as a last resort. Most event structure |
544 | members are not passed. |
776 | members are not passed.</p> |
545 | </dd> |
777 | </dd> |
546 | <p></p> |
778 | </li> |
547 | <dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> |
779 | <dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong> |
548 | </dt> |
780 | |
549 | <dd> |
781 | <dd> |
550 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
782 | <p>Called whenever the window gets the keyboard focus, before rxvt-unicode |
551 | does focus in processing. |
783 | does focus in processing.</p> |
552 | </dd> |
784 | </dd> |
553 | <p></p> |
785 | </li> |
554 | <dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong><br /> |
786 | <dt><strong><a name="item_on_focus_out__24term">on_focus_out $term</a></strong> |
555 | </dt> |
787 | |
556 | <dd> |
788 | <dd> |
557 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
789 | <p>Called wheneever the window loses keyboard focus, before rxvt-unicode does |
558 | focus out processing. |
790 | focus out processing.</p> |
559 | </dd> |
791 | </dd> |
560 | <p></p> |
792 | </li> |
|
|
793 | <dt><strong><a name="item_on_configure_notify__24term_2c__24event">on_configure_notify $term, $event</a></strong> |
|
|
794 | |
|
|
795 | <dt><strong><a name="item_on_property_notify__24term_2c__24event">on_property_notify $term, $event</a></strong> |
|
|
796 | |
561 | <dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a></strong><br /> |
797 | <dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a></strong> |
562 | </dt> |
798 | |
563 | <dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br /> |
799 | <dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong> |
564 | </dt> |
800 | |
565 | <dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br /> |
801 | <dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong> |
566 | </dt> |
802 | |
567 | <dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br /> |
803 | <dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong> |
568 | </dt> |
804 | |
569 | <dt><strong><a name="item_on_motion_notify__24term_2c__24event">on_motion_notify $term, $event</a></strong><br /> |
805 | <dt><strong><a name="item_on_motion_notify__24term_2c__24event">on_motion_notify $term, $event</a></strong> |
570 | </dt> |
806 | |
571 | <dt><strong><a name="item_on_map_notify__24term_2c__24event">on_map_notify $term, $event</a></strong><br /> |
807 | <dt><strong><a name="item_on_map_notify__24term_2c__24event">on_map_notify $term, $event</a></strong> |
572 | </dt> |
808 | |
573 | <dt><strong><a name="item_on_unmap_notify__24term_2c__24event">on_unmap_notify $term, $event</a></strong><br /> |
809 | <dt><strong><a name="item_on_unmap_notify__24term_2c__24event">on_unmap_notify $term, $event</a></strong> |
574 | </dt> |
810 | |
575 | <dd> |
811 | <dd> |
576 | Called whenever the corresponding X event is received for the terminal If |
812 | <p>Called whenever the corresponding X event is received for the terminal If |
577 | the hook returns true, then the even will be ignored by rxvt-unicode. |
813 | the hook returns true, then the even will be ignored by rxvt-unicode.</p> |
578 | </dd> |
814 | </dd> |
579 | <dd> |
815 | <dd> |
580 | <p>The event is a hash with most values as named by Xlib (see the XEvent |
816 | <p>The event is a hash with most values as named by Xlib (see the XEvent |
581 | manpage), with the additional members <code>row</code> and <code>col</code>, which are the row |
817 | manpage), with the additional members <code>row</code> and <code>col</code>, which are the |
582 | and column under the mouse cursor.</p> |
818 | (real, not screen-based) row and column under the mouse cursor.</p> |
583 | </dd> |
819 | </dd> |
584 | <dd> |
820 | <dd> |
585 | <p><code>on_key_press</code> additionally receives the string rxvt-unicode would |
821 | <p><code>on_key_press</code> additionally receives the string rxvt-unicode would |
586 | output, if any, in locale-specific encoding.</p> |
822 | output, if any, in locale-specific encoding.</p> |
587 | </dd> |
823 | </dd> |
588 | <dd> |
824 | <dd> |
589 | <p>subwindow.</p> |
825 | <p>subwindow.</p> |
590 | </dd> |
826 | </dd> |
591 | <p></p></dl> |
827 | </li> |
|
|
828 | <dt><strong><a name="item_on_client_message__24term_2c__24event">on_client_message $term, $event</a></strong> |
|
|
829 | |
|
|
830 | <dt><strong><a name="item_on_wm_protocols__24term_2c__24event">on_wm_protocols $term, $event</a></strong> |
|
|
831 | |
|
|
832 | <dt><strong><a name="item_on_wm_delete_window__24term_2c__24event">on_wm_delete_window $term, $event</a></strong> |
|
|
833 | |
|
|
834 | <dd> |
|
|
835 | <p>Called when various types of ClientMessage events are received (all with |
|
|
836 | format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).</p> |
|
|
837 | </dd> |
|
|
838 | </li> |
|
|
839 | </dl> |
592 | <p> |
840 | <p> |
593 | </p> |
841 | </p> |
594 | <h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> |
842 | <h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> |
595 | <dl> |
843 | <dl> |
596 | <dt><strong><a name="item__24urxvt_3a_3alibdir">$urxvt::LIBDIR</a></strong><br /> |
844 | <dt><strong><a name="item__urxvt__libdir">$urxvt::LIBDIR</a></strong> |
597 | </dt> |
845 | |
598 | <dd> |
846 | <dd> |
599 | The rxvt-unicode library directory, where, among other things, the perl |
847 | <p>The rxvt-unicode library directory, where, among other things, the perl |
600 | modules and scripts are stored. |
848 | modules and scripts are stored.</p> |
601 | </dd> |
|
|
602 | <p></p> |
|
|
603 | <dt><strong><a name="item__24urxvt_3a_3aresclass_2c__24urxvt_3a_3aresclass">$urxvt::RESCLASS, $urxvt::RESCLASS</a></strong><br /> |
|
|
604 | </dt> |
|
|
605 | <dd> |
849 | </dd> |
|
|
850 | </li> |
|
|
851 | <dt><strong><a name="item__urxvt__resclass_">$urxvt::RESCLASS, $urxvt::RESCLASS</a></strong> |
|
|
852 | |
|
|
853 | <dd> |
606 | The resource class and name rxvt-unicode uses to look up X resources. |
854 | <p>The resource class and name rxvt-unicode uses to look up X resources.</p> |
607 | </dd> |
855 | </dd> |
608 | <p></p> |
856 | </li> |
609 | <dt><strong><a name="item__24urxvt_3a_3arxvtname">$urxvt::RXVTNAME</a></strong><br /> |
857 | <dt><strong><a name="item__urxvt__rxvtname">$urxvt::RXVTNAME</a></strong> |
610 | </dt> |
858 | |
611 | <dd> |
859 | <dd> |
612 | The basename of the installed binaries, usually <code>urxvt</code>. |
860 | <p>The basename of the installed binaries, usually <code>urxvt</code>.</p> |
613 | </dd> |
861 | </dd> |
614 | <p></p> |
862 | </li> |
615 | <dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br /> |
863 | <dt><strong><a name="item__urxvt__term">$urxvt::TERM</a></strong> |
616 | </dt> |
864 | |
617 | <dd> |
865 | <dd> |
618 | The current terminal. This variable stores the current <code>urxvt::term</code> |
866 | <p>The current terminal. This variable stores the current <code>urxvt::term</code> |
619 | object, whenever a callback/hook is executing. |
867 | object, whenever a callback/hook is executing.</p> |
|
|
868 | </dd> |
|
|
869 | </li> |
|
|
870 | <dt><strong><a name="item__urxvt__term_init">@urxvt::TERM_INIT</a></strong> |
|
|
871 | |
620 | </dd> |
872 | <dd> |
621 | <p></p></dl> |
873 | <p>All coderefs in this array will be called as methods of the next newly |
|
|
874 | created <code>urxvt::term</code> object (during the <code>on_init</code> phase). The array |
|
|
875 | gets cleared before the codereferences that were in it are being executed, |
|
|
876 | so coderefs can push themselves onto it again if they so desire.</p> |
|
|
877 | </dd> |
|
|
878 | <dd> |
|
|
879 | <p>This complements to the perl-eval commandline option, but gets executed |
|
|
880 | first.</p> |
|
|
881 | </dd> |
|
|
882 | </li> |
|
|
883 | <dt><strong><a name="item__urxvt__term_ext">@urxvt::TERM_EXT</a></strong> |
|
|
884 | |
|
|
885 | <dd> |
|
|
886 | <p>Works similar to <code>@TERM_INIT</code>, but contains perl package/class names, which |
|
|
887 | get registered as normal extensions after calling the hooks in <code>@TERM_INIT</code> |
|
|
888 | but before other extensions. Gets cleared just like <code>@TERM_INIT</code>.</p> |
|
|
889 | </dd> |
|
|
890 | </li> |
|
|
891 | </dl> |
622 | <p> |
892 | <p> |
623 | </p> |
893 | </p> |
624 | <h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> |
894 | <h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> |
625 | <dl> |
895 | <dl> |
626 | <dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br /> |
896 | <dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong> |
627 | </dt> |
897 | |
628 | <dd> |
898 | <dd> |
629 | Fatally aborts execution with the given error message. Avoid at all |
899 | <p>Fatally aborts execution with the given error message. Avoid at all |
630 | costs! The only time this is acceptable is when the terminal process |
900 | costs! The only time this is acceptable is when the terminal process |
631 | starts up. |
901 | starts up.</p> |
632 | </dd> |
902 | </dd> |
633 | <p></p> |
903 | </li> |
634 | <dt><strong><a name="item_urxvt_3a_3awarn__24string">urxvt::warn $string</a></strong><br /> |
904 | <dt><strong><a name="item_urxvt_3a_3awarn__24string">urxvt::warn $string</a></strong> |
635 | </dt> |
905 | |
636 | <dd> |
906 | <dd> |
637 | Calls <code>rxvt_warn</code> with the given string which should not include a |
907 | <p>Calls <code>rxvt_warn</code> with the given string which should not include a |
638 | newline. The module also overwrites the <code>warn</code> builtin with a function |
908 | newline. The module also overwrites the <code>warn</code> builtin with a function |
639 | that calls this function. |
909 | that calls this function.</p> |
640 | </dd> |
910 | </dd> |
641 | <dd> |
911 | <dd> |
642 | <p>Using this function has the advantage that its output ends up in the |
912 | <p>Using this function has the advantage that its output ends up in the |
643 | correct place, e.g. on stderr of the connecting urxvtc client.</p> |
913 | correct place, e.g. on stderr of the connecting urxvtc client.</p> |
644 | </dd> |
914 | </dd> |
645 | <dd> |
915 | <dd> |
646 | <p>Messages have a size limit of 1023 bytes currently.</p> |
916 | <p>Messages have a size limit of 1023 bytes currently.</p> |
647 | </dd> |
917 | </dd> |
648 | <p></p> |
918 | </li> |
649 | <dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> |
919 | <dt><strong><a name="item__terms">@terms = urxvt::termlist</a></strong> |
650 | </dt> |
920 | |
|
|
921 | <dd> |
|
|
922 | <p>Returns all urxvt::term objects that exist in this process, regardless of |
|
|
923 | wether they are started, being destroyed etc., so be careful. Only term |
|
|
924 | objects that have perl extensions attached will be returned (because there |
|
|
925 | is no urxvt::term objet associated with others).</p> |
651 | <dd> |
926 | </dd> |
|
|
927 | </li> |
|
|
928 | <dt><strong><a name="item__time">$time = urxvt::NOW</a></strong> |
|
|
929 | |
|
|
930 | <dd> |
652 | Returns the ``current time'' (as per the event loop). |
931 | <p>Returns the ``current time'' (as per the event loop).</p> |
653 | </dd> |
932 | </dd> |
654 | <p></p> |
933 | </li> |
655 | <dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br /> |
934 | <dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong> |
656 | </dt> |
935 | |
657 | <dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
936 | <dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
658 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
937 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
659 | Button4Mask, Button5Mask, AnyModifier</a></strong><br /> |
938 | Button4Mask, Button5Mask, AnyModifier</a></strong> |
660 | </dt> |
939 | |
661 | <dt><strong><a name="item_urxvt_3a_3anoeventmask_2c_keypressmask_2c_keyrelea">urxvt::NoEventMask, KeyPressMask, KeyReleaseMask, |
940 | <dt><strong><a name="item_urxvt_3a_3anoeventmask_2c_keypressmask_2c_keyrelea">urxvt::NoEventMask, KeyPressMask, KeyReleaseMask, |
662 | ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, |
941 | ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, |
663 | PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask, |
942 | PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask, |
664 | Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask, |
943 | Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask, |
665 | KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask, |
944 | KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask, |
666 | ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask, |
945 | ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask, |
667 | FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask</a></strong><br /> |
946 | FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask</a></strong> |
668 | </dt> |
947 | |
669 | <dt><strong><a name="item_urxvt_3a_3akeypress_2c_keyrelease_2c_buttonpress_2">urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify, |
948 | <dt><strong><a name="item_urxvt_3a_3akeypress_2c_keyrelease_2c_buttonpress_2">urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify, |
670 | EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose, |
949 | EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose, |
671 | GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify, |
950 | GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify, |
672 | UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify, |
951 | UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify, |
673 | ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify, |
952 | ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify, |
674 | CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, |
953 | CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, |
675 | SelectionNotify, ColormapNotify, ClientMessage, MappingNotify</a></strong><br /> |
954 | SelectionNotify, ColormapNotify, ClientMessage, MappingNotify</a></strong> |
676 | </dt> |
955 | |
677 | <dd> |
956 | <dd> |
678 | Various constants for use in X calls and event processing. |
957 | <p>Various constants for use in X calls and event processing.</p> |
|
|
958 | </dd> |
|
|
959 | </li> |
679 | </dd> |
960 | </dl> |
680 | <p></p></dl> |
|
|
681 | <p> |
961 | <p> |
682 | </p> |
962 | </p> |
683 | <h2><a name="rendition">RENDITION</a></h2> |
963 | <h2><a name="rendition">RENDITION</a></h2> |
684 | <p>Rendition bitsets contain information about colour, font, font styles and |
964 | <p>Rendition bitsets contain information about colour, font, font styles and |
685 | similar information for each screen cell.</p> |
965 | similar information for each screen cell.</p> |
686 | <p>The following ``macros'' deal with changes in rendition sets. You should |
966 | <p>The following ``macros'' deal with changes in rendition sets. You should |
687 | never just create a bitset, you should always modify an existing one, |
967 | never just create a bitset, you should always modify an existing one, |
688 | as they contain important information required for correct operation of |
968 | as they contain important information required for correct operation of |
689 | rxvt-unicode.</p> |
969 | rxvt-unicode.</p> |
690 | <dl> |
970 | <dl> |
691 | <dt><strong><a name="item__24rend__3d_urxvt_3a_3adefault_rstyle">$rend = urxvt::DEFAULT_RSTYLE</a></strong><br /> |
971 | <dt><strong><a name="item__rend">$rend = urxvt::DEFAULT_RSTYLE</a></strong> |
692 | </dt> |
972 | |
693 | <dd> |
973 | <dd> |
694 | Returns the default rendition, as used when the terminal is starting up or |
974 | <p>Returns the default rendition, as used when the terminal is starting up or |
695 | being reset. Useful as a base to start when creating renditions. |
975 | being reset. Useful as a base to start when creating renditions.</p> |
696 | </dd> |
|
|
697 | <p></p> |
|
|
698 | <dt><strong><a name="item__24rend__3d_urxvt_3a_3aoverlay_rstyle">$rend = urxvt::OVERLAY_RSTYLE</a></strong><br /> |
|
|
699 | </dt> |
|
|
700 | <dd> |
976 | </dd> |
|
|
977 | </li> |
|
|
978 | <dt><strong>$rend = urxvt::OVERLAY_RSTYLE</strong> |
|
|
979 | |
|
|
980 | <dd> |
701 | Return the rendition mask used for overlays by default. |
981 | <p>Return the rendition mask used for overlays by default.</p> |
702 | </dd> |
|
|
703 | <p></p> |
|
|
704 | <dt><strong><a name="item__24rendbit__3d_urxvt_3a_3ars_bold_2c_rs_italic_2c_">$rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline</a></strong><br /> |
|
|
705 | </dt> |
|
|
706 | <dd> |
982 | </dd> |
|
|
983 | </li> |
|
|
984 | <dt><strong><a name="item__rendbit">$rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline</a></strong> |
|
|
985 | |
|
|
986 | <dd> |
707 | Return the bit that enabled bold, italic, blink, reverse-video and |
987 | <p>Return the bit that enabled bold, italic, blink, reverse-video and |
708 | underline, respectively. To enable such a style, just logically OR it into |
988 | underline, respectively. To enable such a style, just logically OR it into |
709 | the bitset. |
989 | the bitset.</p> |
710 | </dd> |
|
|
711 | <p></p> |
|
|
712 | <dt><strong><a name="item__24foreground__3d_urxvt_3a_3aget_basefg__24rend">$foreground = urxvt::GET_BASEFG $rend</a></strong><br /> |
|
|
713 | </dt> |
|
|
714 | <dt><strong><a name="item__24background__3d_urxvt_3a_3aget_basebg__24rend">$background = urxvt::GET_BASEBG $rend</a></strong><br /> |
|
|
715 | </dt> |
|
|
716 | <dd> |
990 | </dd> |
|
|
991 | </li> |
|
|
992 | <dt><strong><a name="item__foreground">$foreground = urxvt::GET_BASEFG $rend</a></strong> |
|
|
993 | |
|
|
994 | <dt><strong><a name="item__background">$background = urxvt::GET_BASEBG $rend</a></strong> |
|
|
995 | |
|
|
996 | <dd> |
717 | Return the foreground/background colour index, respectively. |
997 | <p>Return the foreground/background colour index, respectively.</p> |
718 | </dd> |
|
|
719 | <p></p> |
|
|
720 | <dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_fgcolor__24rend_2c__24n">$rend = urxvt::SET_FGCOLOR $rend, $new_colour</a></strong><br /> |
|
|
721 | </dt> |
|
|
722 | <dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_bgcolor__24rend_2c__24n">$rend = urxvt::SET_BGCOLOR $rend, $new_colour</a></strong><br /> |
|
|
723 | </dt> |
|
|
724 | <dd> |
998 | </dd> |
|
|
999 | </li> |
|
|
1000 | <dt><strong>$rend = urxvt::SET_FGCOLOR $rend, $new_colour</strong> |
|
|
1001 | |
|
|
1002 | <dt><strong>$rend = urxvt::SET_BGCOLOR $rend, $new_colour</strong> |
|
|
1003 | |
|
|
1004 | <dt><strong>$rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg</strong> |
|
|
1005 | |
|
|
1006 | <dd> |
725 | Replace the foreground/background colour in the rendition mask with the |
1007 | <p>Replace the foreground/background colour in the rendition mask with the |
726 | specified one. |
1008 | specified one.</p> |
727 | </dd> |
|
|
728 | <p></p> |
|
|
729 | <dt><strong><a name="item__24value__3d_urxvt_3a_3aget_custom__24rend">$value = urxvt::GET_CUSTOM $rend</a></strong><br /> |
|
|
730 | </dt> |
|
|
731 | <dd> |
1009 | </dd> |
|
|
1010 | </li> |
|
|
1011 | <dt><strong><a name="item__value">$value = urxvt::GET_CUSTOM $rend</a></strong> |
|
|
1012 | |
|
|
1013 | <dd> |
732 | Return the ``custom'' value: Every rendition has 5 bits for use by |
1014 | <p>Return the ``custom'' value: Every rendition has 5 bits for use by |
733 | extensions. They can be set and changed as you like and are initially |
1015 | extensions. They can be set and changed as you like and are initially |
734 | zero. |
1016 | zero.</p> |
735 | </dd> |
|
|
736 | <p></p> |
|
|
737 | <dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_custom__24rend_2c__24ne">$rend = urxvt::SET_CUSTOM $rend, $new_value</a></strong><br /> |
|
|
738 | </dt> |
|
|
739 | <dd> |
1017 | </dd> |
740 | Change the custom value. |
1018 | </li> |
|
|
1019 | <dt><strong>$rend = urxvt::SET_CUSTOM $rend, $new_value</strong> |
|
|
1020 | |
741 | </dd> |
1021 | <dd> |
742 | <p></p></dl> |
1022 | <p>Change the custom value.</p> |
|
|
1023 | </dd> |
|
|
1024 | </li> |
|
|
1025 | </dl> |
743 | <p> |
1026 | <p> |
744 | </p> |
1027 | </p> |
745 | <h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2> |
1028 | <h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2> |
746 | <p>The sole purpose of this class is to deliver an interface to the |
1029 | <p>The sole purpose of this class is to deliver an interface to the |
747 | <code>AnyEvent</code> module - any module using it will work inside urxvt without |
1030 | <code>AnyEvent</code> module - any module using it will work inside urxvt without |
… | |
… | |
751 | work.</p> |
1034 | work.</p> |
752 | <p> |
1035 | <p> |
753 | </p> |
1036 | </p> |
754 | <h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> |
1037 | <h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> |
755 | <dl> |
1038 | <dl> |
756 | <dt><strong><a name="item__24term__3d_new_urxvt_3a_3aterm__24envhashref_2c__">$term = new urxvt::term $envhashref, $rxvtname, [arg...]</a></strong><br /> |
1039 | <dt><strong><a name="item__term">$term = new urxvt::term $envhashref, $rxvtname, [arg...]</a></strong> |
757 | </dt> |
1040 | |
758 | <dd> |
1041 | <dd> |
759 | Creates a new terminal, very similar as if you had started it with system |
1042 | <p>Creates a new terminal, very similar as if you had started it with system |
760 | <code>$rxvtname, arg...</code>. <code>$envhashref</code> must be a reference to a <code>%ENV</code>-like |
1043 | <code>$rxvtname, arg...</code>. <code>$envhashref</code> must be a reference to a <code>%ENV</code>-like |
761 | hash which defines the environment of the new terminal. |
1044 | hash which defines the environment of the new terminal.</p> |
762 | </dd> |
1045 | </dd> |
763 | <dd> |
1046 | <dd> |
764 | <p>Croaks (and probably outputs an error message) if the new instance |
1047 | <p>Croaks (and probably outputs an error message) if the new instance |
765 | couldn't be created. Returns <code>undef</code> if the new instance didn't |
1048 | couldn't be created. Returns <code>undef</code> if the new instance didn't |
766 | initialise perl, and the terminal object otherwise. The <code>init</code> and |
1049 | initialise perl, and the terminal object otherwise. The <code>init</code> and |
767 | <a href="#item_start"><code>start</code></a> hooks will be called during this call.</p> |
1050 | <a href="#item_start"><code>start</code></a> hooks will be called before this call returns, and are free to |
|
|
1051 | refer to global data (which is race free).</p> |
768 | </dd> |
1052 | </dd> |
769 | <p></p> |
1053 | </li> |
770 | <dt><strong><a name="item_destroy">$term->destroy</a></strong><br /> |
1054 | <dt><strong><a name="item_destroy">$term->destroy</a></strong> |
771 | </dt> |
1055 | |
772 | <dd> |
1056 | <dd> |
773 | Destroy the terminal object (close the window, free resources |
1057 | <p>Destroy the terminal object (close the window, free resources |
774 | etc.). Please note that rxvt will not exit as long as any event |
1058 | etc.). Please note that rxvt will not exit as long as any event |
775 | watchers (timers, io watchers) are still active. |
1059 | watchers (timers, io watchers) are still active.</p> |
|
|
1060 | </dd> |
|
|
1061 | </li> |
|
|
1062 | <dt><strong><a name="item_exec_async">$term->exec_async ($cmd[, @args])</a></strong> |
|
|
1063 | |
776 | </dd> |
1064 | <dd> |
777 | <p></p> |
1065 | <p>Works like the combination of the <code>fork</code>/<code>exec</code> builtins, which executes |
|
|
1066 | (``starts'') programs in the background. This function takes care of setting |
|
|
1067 | the user environment before exec'ing the command (e.g. <code>PATH</code>) and should |
|
|
1068 | be preferred over explicit calls to <code>exec</code> or <code>system</code>.</p> |
|
|
1069 | </dd> |
|
|
1070 | <dd> |
|
|
1071 | <p>Returns the pid of the subprocess or <code>undef</code> on error.</p> |
|
|
1072 | </dd> |
|
|
1073 | </li> |
778 | <dt><strong><a name="item_option">$isset = $term->option ($optval[, $set])</a></strong><br /> |
1074 | <dt><strong><a name="item_option">$isset = $term->option ($optval[, $set])</a></strong> |
779 | </dt> |
1075 | |
780 | <dd> |
1076 | <dd> |
781 | Returns true if the option specified by <code>$optval</code> is enabled, and |
1077 | <p>Returns true if the option specified by <code>$optval</code> is enabled, and |
782 | optionally change it. All option values are stored by name in the hash |
1078 | optionally change it. All option values are stored by name in the hash |
783 | <code>%urxvt::OPTION</code>. Options not enabled in this binary are not in the hash. |
1079 | <code>%urxvt::OPTION</code>. Options not enabled in this binary are not in the hash.</p> |
784 | </dd> |
1080 | </dd> |
785 | <dd> |
1081 | <dd> |
786 | <p>Here is a a likely non-exhaustive list of option names, please see the |
1082 | <p>Here is a a likely non-exhaustive list of option names, please see the |
787 | source file <em>/src/optinc.h</em> to see the actual list:</p> |
1083 | source file <em>/src/optinc.h</em> to see the actual list:</p> |
788 | </dd> |
1084 | </dd> |
789 | <dd> |
1085 | <dd> |
790 | <pre> |
1086 | <pre> |
791 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1087 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
792 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1088 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
793 | pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating |
1089 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
794 | scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer |
1090 | scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput |
795 | secondaryScreen secondaryScroll skipBuiltinGlyphs transparent |
1091 | scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs |
796 | tripleclickwords utmpInhibit visualBell</pre> |
1092 | transparent tripleclickwords utmpInhibit visualBell</pre> |
797 | </dd> |
1093 | </dd> |
798 | <p></p> |
1094 | </li> |
799 | <dt><strong><a name="item_resource">$value = $term->resource ($name[, $newval])</a></strong><br /> |
1095 | <dt><strong><a name="item_resource">$value = $term->resource ($name[, $newval])</a></strong> |
800 | </dt> |
1096 | |
801 | <dd> |
1097 | <dd> |
802 | Returns the current resource value associated with a given name and |
1098 | <p>Returns the current resource value associated with a given name and |
803 | optionally sets a new value. Setting values is most useful in the <code>init</code> |
1099 | optionally sets a new value. Setting values is most useful in the <code>init</code> |
804 | hook. Unset resources are returned and accepted as <code>undef</code>. |
1100 | hook. Unset resources are returned and accepted as <code>undef</code>.</p> |
805 | </dd> |
1101 | </dd> |
806 | <dd> |
1102 | <dd> |
807 | <p>The new value must be properly encoded to a suitable character encoding |
1103 | <p>The new value must be properly encoded to a suitable character encoding |
808 | before passing it to this method. Similarly, the returned value may need |
1104 | before passing it to this method. Similarly, the returned value may need |
809 | to be converted from the used encoding to text.</p> |
1105 | to be converted from the used encoding to text.</p> |
… | |
… | |
826 | <pre> |
1122 | <pre> |
827 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1123 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
828 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
1124 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
829 | display_name embed ext_bwidth fade font geometry hold iconName |
1125 | display_name embed ext_bwidth fade font geometry hold iconName |
830 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
1126 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
831 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
1127 | italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier |
832 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 |
1128 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
833 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
1129 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
834 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
1130 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
835 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
1131 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
836 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
1132 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
837 | shade term_name title transparent transparent_all tripleclickwords |
1133 | secondaryScreen secondaryScroll selectstyle shade term_name title |
|
|
1134 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
838 | utmpInhibit visualBell</pre> |
1135 | visualBell</pre> |
839 | </dd> |
1136 | </dd> |
840 | <p></p> |
1137 | </li> |
841 | <dt><strong><a name="item_x_resource">$value = $term->x_resource ($pattern)</a></strong><br /> |
1138 | <dt><strong><a name="item_x_resource">$value = $term->x_resource ($pattern)</a></strong> |
842 | </dt> |
1139 | |
843 | <dd> |
1140 | <dd> |
844 | Returns the X-Resource for the given pattern, excluding the program or |
1141 | <p>Returns the X-Resource for the given pattern, excluding the program or |
845 | class name, i.e. <a href="#item_x_resource"><code>$term->x_resource ("boldFont")</code></a> should return the |
1142 | class name, i.e. <a href="#item_x_resource"><code>$term->x_resource ("boldFont")</code></a> should return the |
846 | same value as used by this instance of rxvt-unicode. Returns <code>undef</code> if no |
1143 | same value as used by this instance of rxvt-unicode. Returns <code>undef</code> if no |
847 | resource with that pattern exists. |
1144 | resource with that pattern exists.</p> |
848 | </dd> |
1145 | </dd> |
849 | <dd> |
1146 | <dd> |
850 | <p>This method should only be called during the <code>on_start</code> hook, as there is |
1147 | <p>This method should only be called during the <code>on_start</code> hook, as there is |
851 | only one resource database per display, and later invocations might return |
1148 | only one resource database per display, and later invocations might return |
852 | the wrong resources.</p> |
1149 | the wrong resources.</p> |
853 | </dd> |
1150 | </dd> |
854 | <p></p> |
1151 | </li> |
855 | <dt><strong><a name="item_parse_keysym">$success = $term->parse_keysym ($keysym_spec, $command_string)</a></strong><br /> |
1152 | <dt><strong><a name="item_parse_keysym">$success = $term->parse_keysym ($keysym_spec, $command_string)</a></strong> |
856 | </dt> |
1153 | |
857 | <dd> |
1154 | <dd> |
858 | Adds a keymap translation exactly as specified via a resource. See the |
1155 | <p>Adds a keymap translation exactly as specified via a resource. See the |
859 | <code>keysym</code> resource in the <code>rxvt(1)</code> manpage. |
1156 | <code>keysym</code> resource in the <code>rxvt(1)</code> manpage.</p> |
860 | </dd> |
1157 | </dd> |
861 | <p></p> |
1158 | </li> |
862 | <dt><strong><a name="item_rstyle">$rend = $term->rstyle ([$new_rstyle])</a></strong><br /> |
1159 | <dt><strong><a name="item_rstyle">$rend = $term->rstyle ([$new_rstyle])</a></strong> |
863 | </dt> |
1160 | |
864 | <dd> |
1161 | <dd> |
865 | Return and optionally change the current rendition. Text that is output by |
1162 | <p>Return and optionally change the current rendition. Text that is output by |
866 | the terminal application will use this style. |
1163 | the terminal application will use this style.</p> |
867 | </dd> |
1164 | </dd> |
868 | <p></p> |
1165 | </li> |
869 | <dt><strong><a name="item_screen_cur">($row, $col) = $term->screen_cur ([$row, $col])</a></strong><br /> |
1166 | <dt><strong><a name="item_screen_cur">($row, $col) = $term->screen_cur ([$row, $col])</a></strong> |
870 | </dt> |
1167 | |
871 | <dd> |
1168 | <dd> |
872 | Return the current coordinates of the text cursor position and optionally |
1169 | <p>Return the current coordinates of the text cursor position and optionally |
873 | set it (which is usually bad as applications don't expect that). |
1170 | set it (which is usually bad as applications don't expect that).</p> |
874 | </dd> |
1171 | </dd> |
875 | <p></p> |
1172 | </li> |
876 | <dt><strong><a name="item_selection_mark">($row, $col) = $term->selection_mark ([$row, $col])</a></strong><br /> |
1173 | <dt><strong><a name="item_selection_mark">($row, $col) = $term->selection_mark ([$row, $col])</a></strong> |
877 | </dt> |
1174 | |
878 | <dt><strong><a name="item_selection_beg">($row, $col) = $term->selection_beg ([$row, $col])</a></strong><br /> |
1175 | <dt><strong><a name="item_selection_beg">($row, $col) = $term->selection_beg ([$row, $col])</a></strong> |
879 | </dt> |
1176 | |
880 | <dt><strong><a name="item_selection_end">($row, $col) = $term->selection_end ([$row, $col])</a></strong><br /> |
1177 | <dt><strong><a name="item_selection_end">($row, $col) = $term->selection_end ([$row, $col])</a></strong> |
881 | </dt> |
1178 | |
882 | <dd> |
1179 | <dd> |
883 | Return the current values of the selection mark, begin or end positions, |
1180 | <p>Return the current values of the selection mark, begin or end positions, |
884 | and optionally set them to new values. |
1181 | and optionally set them to new values.</p> |
885 | </dd> |
1182 | </dd> |
886 | <p></p> |
1183 | </li> |
887 | <dt><strong><a name="item_selection_make">$term->selection_make ($eventtime[, $rectangular])</a></strong><br /> |
1184 | <dt><strong><a name="item_selection_make">$term->selection_make ($eventtime[, $rectangular])</a></strong> |
888 | </dt> |
1185 | |
889 | <dd> |
1186 | <dd> |
890 | Tries to make a selection as set by <a href="#item_selection_beg"><code>selection_beg</code></a> and |
1187 | <p>Tries to make a selection as set by <a href="#item_selection_beg"><code>selection_beg</code></a> and |
891 | <a href="#item_selection_end"><code>selection_end</code></a>. If <code>$rectangular</code> is true (default: false), a |
1188 | <a href="#item_selection_end"><code>selection_end</code></a>. If <code>$rectangular</code> is true (default: false), a |
892 | rectangular selection will be made. This is the prefered function to make |
1189 | rectangular selection will be made. This is the prefered function to make |
893 | a selection. |
1190 | a selection.</p> |
894 | </dd> |
1191 | </dd> |
895 | <p></p> |
1192 | </li> |
896 | <dt><strong><a name="item_selection_grab">$success = $term->selection_grab ($eventtime)</a></strong><br /> |
1193 | <dt><strong><a name="item_selection_grab">$success = $term->selection_grab ($eventtime)</a></strong> |
897 | </dt> |
1194 | |
898 | <dd> |
1195 | <dd> |
899 | Try to request the primary selection text from the server (for example, as |
1196 | <p>Try to request the primary selection text from the server (for example, as |
900 | set by the next method). No visual feedback will be given. This function |
1197 | set by the next method). No visual feedback will be given. This function |
901 | is mostly useful from within <code>on_sel_grab</code> hooks. |
1198 | is mostly useful from within <code>on_sel_grab</code> hooks.</p> |
902 | </dd> |
1199 | </dd> |
903 | <p></p> |
1200 | </li> |
904 | <dt><strong>$oldtext = $term->selection ([$newtext])</strong><br /> |
1201 | <dt><strong>$oldtext = $term->selection ([$newtext])</strong> |
905 | </dt> |
1202 | |
906 | <dd> |
1203 | <dd> |
907 | Return the current selection text and optionally replace it by <code>$newtext</code>. |
1204 | <p>Return the current selection text and optionally replace it by <code>$newtext</code>.</p> |
908 | </dd> |
1205 | </dd> |
909 | <p></p> |
1206 | </li> |
910 | <dt><strong><a name="item_overlay_simple">$term->overlay_simple ($x, $y, $text)</a></strong><br /> |
1207 | <dt><strong><a name="item_overlay_simple">$term->overlay_simple ($x, $y, $text)</a></strong> |
911 | </dt> |
1208 | |
912 | <dd> |
1209 | <dd> |
913 | Create a simple multi-line overlay box. See the next method for details. |
1210 | <p>Create a simple multi-line overlay box. See the next method for details.</p> |
914 | </dd> |
1211 | </dd> |
915 | <p></p> |
1212 | </li> |
916 | <dt><strong><a name="item_overlay">$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br /> |
1213 | <dt><strong><a name="item_overlay">$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong> |
917 | </dt> |
1214 | |
918 | <dd> |
1215 | <dd> |
919 | Create a new (empty) overlay at the given position with the given |
1216 | <p>Create a new (empty) overlay at the given position with the given |
920 | width/height. <code>$rstyle</code> defines the initial rendition style |
1217 | width/height. <code>$rstyle</code> defines the initial rendition style |
921 | (default: <code>OVERLAY_RSTYLE</code>). |
1218 | (default: <code>OVERLAY_RSTYLE</code>).</p> |
922 | </dd> |
1219 | </dd> |
923 | <dd> |
1220 | <dd> |
924 | <p>If <code>$border</code> is <code>2</code> (default), then a decorative border will be put |
1221 | <p>If <code>$border</code> is <code>2</code> (default), then a decorative border will be put |
925 | around the box.</p> |
1222 | around the box.</p> |
926 | </dd> |
1223 | </dd> |
… | |
… | |
934 | </dd> |
1231 | </dd> |
935 | <dd> |
1232 | <dd> |
936 | <p>The methods currently supported on <code>urxvt::overlay</code> objects are:</p> |
1233 | <p>The methods currently supported on <code>urxvt::overlay</code> objects are:</p> |
937 | </dd> |
1234 | </dd> |
938 | <dl> |
1235 | <dl> |
939 | <dt><strong><a name="item_set">$overlay->set ($x, $y, $text, $rend)</a></strong><br /> |
1236 | <dt><strong><a name="item_set">$overlay->set ($x, $y, $text, $rend)</a></strong> |
940 | </dt> |
1237 | |
941 | <dd> |
1238 | <dd> |
942 | Similar to <a href="#item_row_t"><code>$term->ROW_t</code></a> and <a href="#item_row_r"><code>$term->ROW_r</code></a> in that it puts |
1239 | <p>Similar to <a href="#item_row_t"><code>$term->ROW_t</code></a> and <a href="#item_row_r"><code>$term->ROW_r</code></a> in that it puts |
943 | text in rxvt-unicode's special encoding and an array of rendition values |
1240 | text in rxvt-unicode's special encoding and an array of rendition values |
944 | at a specific position inside the overlay. |
1241 | at a specific position inside the overlay.</p> |
945 | </dd> |
1242 | </dd> |
946 | <p></p> |
1243 | </li> |
947 | <dt><strong><a name="item_hide">$overlay->hide</a></strong><br /> |
1244 | <dt><strong><a name="item_hide">$overlay->hide</a></strong> |
948 | </dt> |
1245 | |
949 | <dd> |
1246 | <dd> |
950 | If visible, hide the overlay, but do not destroy it. |
1247 | <p>If visible, hide the overlay, but do not destroy it.</p> |
951 | </dd> |
1248 | </dd> |
952 | <p></p> |
1249 | </li> |
953 | <dt><strong><a name="item_show">$overlay->show</a></strong><br /> |
1250 | <dt><strong><a name="item_show">$overlay->show</a></strong> |
954 | </dt> |
1251 | |
955 | <dd> |
1252 | <dd> |
956 | If hidden, display the overlay again. |
1253 | <p>If hidden, display the overlay again.</p> |
|
|
1254 | </dd> |
|
|
1255 | </li> |
957 | </dd> |
1256 | </dl> |
958 | <p></p></dl> |
|
|
959 | <dt><strong>$popup = $term->popup ($event)</strong><br /> |
1257 | <dt><strong>$popup = $term->popup ($event)</strong> |
960 | </dt> |
1258 | |
961 | <dd> |
1259 | <dd> |
962 | Creates a new <code>urxvt::popup</code> object that implements a popup menu. The |
1260 | <p>Creates a new <code>urxvt::popup</code> object that implements a popup menu. The |
963 | <code>$event</code> <em>must</em> be the event causing the menu to pop up (a button event, |
1261 | <code>$event</code> <em>must</em> be the event causing the menu to pop up (a button event, |
964 | currently). |
1262 | currently).</p> |
965 | </dd> |
1263 | </dd> |
966 | <p></p> |
1264 | </li> |
967 | <dt><strong><a name="item_strwidth">$cellwidth = $term->strwidth ($string)</a></strong><br /> |
1265 | <dt><strong><a name="item_strwidth">$cellwidth = $term->strwidth ($string)</a></strong> |
968 | </dt> |
1266 | |
969 | <dd> |
1267 | <dd> |
970 | Returns the number of screen-cells this string would need. Correctly |
1268 | <p>Returns the number of screen-cells this string would need. Correctly |
971 | accounts for wide and combining characters. |
1269 | accounts for wide and combining characters.</p> |
972 | </dd> |
1270 | </dd> |
973 | <p></p> |
1271 | </li> |
974 | <dt><strong><a name="item_locale_encode">$octets = $term->locale_encode ($string)</a></strong><br /> |
1272 | <dt><strong><a name="item_locale_encode">$octets = $term->locale_encode ($string)</a></strong> |
975 | </dt> |
1273 | |
976 | <dd> |
1274 | <dd> |
977 | Convert the given text string into the corresponding locale encoding. |
1275 | <p>Convert the given text string into the corresponding locale encoding.</p> |
978 | </dd> |
1276 | </dd> |
979 | <p></p> |
1277 | </li> |
980 | <dt><strong><a name="item_locale_decode">$string = $term->locale_decode ($octets)</a></strong><br /> |
1278 | <dt><strong><a name="item_locale_decode">$string = $term->locale_decode ($octets)</a></strong> |
981 | </dt> |
1279 | |
982 | <dd> |
1280 | <dd> |
983 | Convert the given locale-encoded octets into a perl string. |
1281 | <p>Convert the given locale-encoded octets into a perl string.</p> |
984 | </dd> |
1282 | </dd> |
985 | <p></p> |
1283 | </li> |
986 | <dt><strong><a name="item_scr_xor_span">$term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])</a></strong><br /> |
1284 | <dt><strong><a name="item_scr_xor_span">$term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])</a></strong> |
987 | </dt> |
1285 | |
988 | <dd> |
1286 | <dd> |
989 | XORs the rendition values in the given span with the provided value |
1287 | <p>XORs the rendition values in the given span with the provided value |
990 | (default: <code>RS_RVid</code>), which <em>MUST NOT</em> contain font styles. Useful in |
1288 | (default: <code>RS_RVid</code>), which <em>MUST NOT</em> contain font styles. Useful in |
991 | refresh hooks to provide effects similar to the selection. |
1289 | refresh hooks to provide effects similar to the selection.</p> |
992 | </dd> |
1290 | </dd> |
993 | <p></p> |
1291 | </li> |
994 | <dt><strong><a name="item_scr_xor_rect">$term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])</a></strong><br /> |
1292 | <dt><strong><a name="item_scr_xor_rect">$term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])</a></strong> |
995 | </dt> |
1293 | |
996 | <dd> |
1294 | <dd> |
997 | Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing |
1295 | <p>Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing |
998 | whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults |
1296 | whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults |
999 | to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines |
1297 | to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines |
1000 | it instead. Both styles <em>MUST NOT</em> contain font styles. |
1298 | it instead. Both styles <em>MUST NOT</em> contain font styles.</p> |
1001 | </dd> |
1299 | </dd> |
1002 | <p></p> |
1300 | </li> |
1003 | <dt><strong><a name="item_scr_bell">$term->scr_bell</a></strong><br /> |
1301 | <dt><strong><a name="item_scr_bell">$term->scr_bell</a></strong> |
1004 | </dt> |
1302 | |
1005 | <dd> |
|
|
1006 | Ring the bell! |
|
|
1007 | </dd> |
1303 | <dd> |
1008 | <p></p> |
1304 | <p>Ring the bell!</p> |
|
|
1305 | </dd> |
|
|
1306 | </li> |
1009 | <dt><strong><a name="item_scr_add_lines">$term->scr_add_lines ($string)</a></strong><br /> |
1307 | <dt><strong><a name="item_scr_add_lines">$term->scr_add_lines ($string)</a></strong> |
1010 | </dt> |
1308 | |
1011 | <dd> |
1309 | <dd> |
1012 | Write the given text string to the screen, as if output by the application |
1310 | <p>Write the given text string to the screen, as if output by the application |
1013 | running inside the terminal. It may not contain command sequences (escape |
1311 | running inside the terminal. It may not contain command sequences (escape |
1014 | codes), but is free to use line feeds, carriage returns and tabs. The |
1312 | codes), but is free to use line feeds, carriage returns and tabs. The |
1015 | string is a normal text string, not in locale-dependent encoding. |
1313 | string is a normal text string, not in locale-dependent encoding.</p> |
1016 | </dd> |
1314 | </dd> |
1017 | <dd> |
1315 | <dd> |
1018 | <p>Normally its not a good idea to use this function, as programs might be |
1316 | <p>Normally its not a good idea to use this function, as programs might be |
1019 | confused by changes in cursor position or scrolling. Its useful inside a |
1317 | confused by changes in cursor position or scrolling. Its useful inside a |
1020 | <code>on_add_lines</code> hook, though.</p> |
1318 | <code>on_add_lines</code> hook, though.</p> |
1021 | </dd> |
1319 | </dd> |
1022 | <p></p> |
1320 | </li> |
|
|
1321 | <dt><strong><a name="item_scr_change_screen">$term->scr_change_screen ($screen)</a></strong> |
|
|
1322 | |
|
|
1323 | <dd> |
|
|
1324 | <p>Switch to given screen - 0 primary, 1 secondary.</p> |
|
|
1325 | </dd> |
|
|
1326 | </li> |
1023 | <dt><strong><a name="item_cmd_parse">$term->cmd_parse ($octets)</a></strong><br /> |
1327 | <dt><strong><a name="item_cmd_parse">$term->cmd_parse ($octets)</a></strong> |
1024 | </dt> |
1328 | |
1025 | <dd> |
1329 | <dd> |
1026 | Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the |
1330 | <p>Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the |
1027 | locale-specific encoding of the terminal and can contain command sequences |
1331 | locale-specific encoding of the terminal and can contain command sequences |
1028 | (escape codes) that will be interpreted. |
1332 | (escape codes) that will be interpreted.</p> |
1029 | </dd> |
1333 | </dd> |
1030 | <p></p> |
1334 | </li> |
1031 | <dt><strong><a name="item_tt_write">$term->tt_write ($octets)</a></strong><br /> |
1335 | <dt><strong><a name="item_tt_write">$term->tt_write ($octets)</a></strong> |
1032 | </dt> |
1336 | |
1033 | <dd> |
1337 | <dd> |
1034 | Write the octets given in <code>$data</code> to the tty (i.e. as program input). To |
1338 | <p>Write the octets given in <code>$data</code> to the tty (i.e. as program input). To |
1035 | pass characters instead of octets, you should convert your strings first |
1339 | pass characters instead of octets, you should convert your strings first |
1036 | to the locale-specific encoding using <a href="#item_locale_encode"><code>$term->locale_encode</code></a>. |
1340 | to the locale-specific encoding using <a href="#item_locale_encode"><code>$term->locale_encode</code></a>.</p> |
1037 | </dd> |
1341 | </dd> |
1038 | <p></p> |
1342 | </li> |
1039 | <dt><strong><a name="item_pty_ev_events">$old_events = $term->pty_ev_events ([$new_events])</a></strong><br /> |
1343 | <dt><strong><a name="item_pty_ev_events">$old_events = $term->pty_ev_events ([$new_events])</a></strong> |
1040 | </dt> |
1344 | |
1041 | <dd> |
1345 | <dd> |
1042 | Replaces the event mask of the pty watcher by the given event mask. Can |
1346 | <p>Replaces the event mask of the pty watcher by the given event mask. Can |
1043 | be used to suppress input and output handling to the pty/tty. See the |
1347 | be used to suppress input and output handling to the pty/tty. See the |
1044 | description of <a href="#item_events"><code>urxvt::timer->events</code></a>. Make sure to always restore |
1348 | description of <a href="#item_events"><code>urxvt::timer->events</code></a>. Make sure to always restore |
1045 | the previous value. |
1349 | the previous value.</p> |
|
|
1350 | </dd> |
|
|
1351 | </li> |
|
|
1352 | <dt><strong><a name="item_pty_fd">$fd = $term->pty_fd</a></strong> |
|
|
1353 | |
1046 | </dd> |
1354 | <dd> |
1047 | <p></p> |
1355 | <p>Returns the master file descriptor for the pty in use, or <code>-1</code> if no pty |
|
|
1356 | is used.</p> |
|
|
1357 | </dd> |
|
|
1358 | </li> |
1048 | <dt><strong><a name="item_parent">$windowid = $term->parent</a></strong><br /> |
1359 | <dt><strong><a name="item_parent">$windowid = $term->parent</a></strong> |
1049 | </dt> |
1360 | |
1050 | <dd> |
1361 | <dd> |
1051 | Return the window id of the toplevel window. |
1362 | <p>Return the window id of the toplevel window.</p> |
1052 | </dd> |
1363 | </dd> |
1053 | <p></p> |
1364 | </li> |
1054 | <dt><strong><a name="item_vt">$windowid = $term->vt</a></strong><br /> |
1365 | <dt><strong><a name="item_vt">$windowid = $term->vt</a></strong> |
1055 | </dt> |
1366 | |
1056 | <dd> |
1367 | <dd> |
1057 | Return the window id of the terminal window. |
1368 | <p>Return the window id of the terminal window.</p> |
1058 | </dd> |
1369 | </dd> |
1059 | <p></p> |
1370 | </li> |
1060 | <dt><strong><a name="item_vt_emask_add">$term->vt_emask_add ($x_event_mask)</a></strong><br /> |
1371 | <dt><strong><a name="item_vt_emask_add">$term->vt_emask_add ($x_event_mask)</a></strong> |
1061 | </dt> |
1372 | |
1062 | <dd> |
1373 | <dd> |
1063 | Adds the specified events to the vt event mask. Useful e.g. when you want |
1374 | <p>Adds the specified events to the vt event mask. Useful e.g. when you want |
1064 | to receive pointer events all the times: |
1375 | to receive pointer events all the times:</p> |
1065 | </dd> |
1376 | </dd> |
1066 | <dd> |
1377 | <dd> |
1067 | <pre> |
1378 | <pre> |
1068 | $term->vt_emask_add (urxvt::PointerMotionMask);</pre> |
1379 | $term->vt_emask_add (urxvt::PointerMotionMask);</pre> |
1069 | </dd> |
1380 | </dd> |
1070 | <p></p> |
1381 | </li> |
|
|
1382 | <dt><strong><a name="item_focus_in">$term->focus_in</a></strong> |
|
|
1383 | |
|
|
1384 | <dt><strong><a name="item_focus_out">$term->focus_out</a></strong> |
|
|
1385 | |
|
|
1386 | <dt><strong><a name="item_key_press">$term->key_press ($state, $keycode[, $time])</a></strong> |
|
|
1387 | |
|
|
1388 | <dt><strong><a name="item_key_release">$term->key_release ($state, $keycode[, $time])</a></strong> |
|
|
1389 | |
|
|
1390 | <dd> |
|
|
1391 | <p>Deliver various fake events to to terminal.</p> |
|
|
1392 | </dd> |
|
|
1393 | </li> |
1071 | <dt><strong><a name="item_width">$window_width = $term->width</a></strong><br /> |
1394 | <dt><strong><a name="item_width">$window_width = $term->width</a></strong> |
1072 | </dt> |
1395 | |
1073 | <dt><strong><a name="item_height">$window_height = $term->height</a></strong><br /> |
1396 | <dt><strong><a name="item_height">$window_height = $term->height</a></strong> |
1074 | </dt> |
1397 | |
1075 | <dt><strong><a name="item_fwidth">$font_width = $term->fwidth</a></strong><br /> |
1398 | <dt><strong><a name="item_fwidth">$font_width = $term->fwidth</a></strong> |
1076 | </dt> |
1399 | |
1077 | <dt><strong><a name="item_fheight">$font_height = $term->fheight</a></strong><br /> |
1400 | <dt><strong><a name="item_fheight">$font_height = $term->fheight</a></strong> |
1078 | </dt> |
1401 | |
1079 | <dt><strong><a name="item_fbase">$font_ascent = $term->fbase</a></strong><br /> |
1402 | <dt><strong><a name="item_fbase">$font_ascent = $term->fbase</a></strong> |
1080 | </dt> |
1403 | |
1081 | <dt><strong><a name="item_nrow">$terminal_rows = $term->nrow</a></strong><br /> |
1404 | <dt><strong><a name="item_nrow">$terminal_rows = $term->nrow</a></strong> |
1082 | </dt> |
1405 | |
1083 | <dt><strong><a name="item_ncol">$terminal_columns = $term->ncol</a></strong><br /> |
1406 | <dt><strong><a name="item_ncol">$terminal_columns = $term->ncol</a></strong> |
1084 | </dt> |
1407 | |
1085 | <dt><strong><a name="item_focus">$has_focus = $term->focus</a></strong><br /> |
1408 | <dt><strong><a name="item_focus">$has_focus = $term->focus</a></strong> |
1086 | </dt> |
1409 | |
1087 | <dt><strong><a name="item_mapped">$is_mapped = $term->mapped</a></strong><br /> |
1410 | <dt><strong><a name="item_mapped">$is_mapped = $term->mapped</a></strong> |
1088 | </dt> |
1411 | |
1089 | <dt><strong><a name="item_savelines">$max_scrollback = $term->saveLines</a></strong><br /> |
1412 | <dt><strong><a name="item_savelines">$max_scrollback = $term->saveLines</a></strong> |
1090 | </dt> |
1413 | |
1091 | <dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term->total_rows</a></strong><br /> |
1414 | <dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term->total_rows</a></strong> |
1092 | </dt> |
1415 | |
1093 | <dt><strong><a name="item_top_row">$topmost_scrollback_row = $term->top_row</a></strong><br /> |
1416 | <dt><strong><a name="item_top_row">$topmost_scrollback_row = $term->top_row</a></strong> |
1094 | </dt> |
1417 | |
1095 | <dd> |
1418 | <dd> |
1096 | Return various integers describing terminal characteristics. |
1419 | <p>Return various integers describing terminal characteristics.</p> |
1097 | </dd> |
1420 | </dd> |
1098 | <p></p> |
1421 | </li> |
1099 | <dt><strong><a name="item_display_id">$x_display = $term->display_id</a></strong><br /> |
1422 | <dt><strong><a name="item_display_id">$x_display = $term->display_id</a></strong> |
1100 | </dt> |
1423 | |
1101 | <dd> |
1424 | <dd> |
1102 | Return the DISPLAY used by rxvt-unicode. |
1425 | <p>Return the DISPLAY used by rxvt-unicode.</p> |
1103 | </dd> |
1426 | </dd> |
1104 | <p></p> |
1427 | </li> |
1105 | <dt><strong><a name="item_locale">$lc_ctype = $term->locale</a></strong><br /> |
1428 | <dt><strong><a name="item_locale">$lc_ctype = $term->locale</a></strong> |
1106 | </dt> |
1429 | |
1107 | <dd> |
1430 | <dd> |
1108 | Returns the LC_CTYPE category string used by this rxvt-unicode. |
1431 | <p>Returns the LC_CTYPE category string used by this rxvt-unicode.</p> |
1109 | </dd> |
1432 | </dd> |
1110 | <p></p> |
1433 | </li> |
1111 | <dt><strong><a name="item_env">$env = $term->env</a></strong><br /> |
1434 | <dt><strong><a name="item_env">$env = $term->env</a></strong> |
1112 | </dt> |
1435 | |
1113 | <dd> |
1436 | <dd> |
1114 | Returns a copy of the environment in effect for the terminal as a hashref |
1437 | <p>Returns a copy of the environment in effect for the terminal as a hashref |
1115 | similar to <code>\%ENV</code>. |
1438 | similar to <code>\%ENV</code>.</p> |
|
|
1439 | </dd> |
|
|
1440 | </li> |
|
|
1441 | <dt><strong><a name="item_envv">@envv = $term->envv</a></strong> |
|
|
1442 | |
1116 | </dd> |
1443 | <dd> |
1117 | <p></p> |
1444 | <p>Returns the environment as array of strings of the form <code>VAR=VALUE</code>.</p> |
|
|
1445 | </dd> |
|
|
1446 | </li> |
|
|
1447 | <dt><strong><a name="item_argv">@argv = $term->argv</a></strong> |
|
|
1448 | |
|
|
1449 | <dd> |
|
|
1450 | <p>Return the argument vector as this terminal, similar to @ARGV, but |
|
|
1451 | includes the program name as first element.</p> |
|
|
1452 | </dd> |
|
|
1453 | </li> |
1118 | <dt><strong><a name="item_modlevel3mask">$modifiermask = $term->ModLevel3Mask</a></strong><br /> |
1454 | <dt><strong><a name="item_modlevel3mask">$modifiermask = $term->ModLevel3Mask</a></strong> |
1119 | </dt> |
1455 | |
1120 | <dt><strong><a name="item_modmetamask">$modifiermask = $term->ModMetaMask</a></strong><br /> |
1456 | <dt><strong><a name="item_modmetamask">$modifiermask = $term->ModMetaMask</a></strong> |
1121 | </dt> |
1457 | |
1122 | <dt><strong><a name="item_modnumlockmask">$modifiermask = $term->ModNumLockMask</a></strong><br /> |
1458 | <dt><strong><a name="item_modnumlockmask">$modifiermask = $term->ModNumLockMask</a></strong> |
1123 | </dt> |
1459 | |
1124 | <dd> |
1460 | <dd> |
1125 | Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often |
1461 | <p>Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often |
1126 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1462 | AltGr), the meta key (often Alt) and the num lock key, if applicable.</p> |
|
|
1463 | </dd> |
|
|
1464 | </li> |
|
|
1465 | <dt><strong><a name="item_current_screen">$screen = $term->current_screen</a></strong> |
|
|
1466 | |
1127 | </dd> |
1467 | <dd> |
1128 | <p></p> |
1468 | <p>Returns the currently displayed screen (0 primary, 1 secondary).</p> |
|
|
1469 | </dd> |
|
|
1470 | </li> |
|
|
1471 | <dt><strong><a name="item_hidden_cursor">$cursor_is_hidden = $term->hidden_cursor</a></strong> |
|
|
1472 | |
|
|
1473 | <dd> |
|
|
1474 | <p>Returns wether the cursor is currently hidden or not.</p> |
|
|
1475 | </dd> |
|
|
1476 | </li> |
1129 | <dt><strong><a name="item_view_start">$view_start = $term->view_start ([$newvalue])</a></strong><br /> |
1477 | <dt><strong><a name="item_view_start">$view_start = $term->view_start ([$newvalue])</a></strong> |
1130 | </dt> |
1478 | |
1131 | <dd> |
1479 | <dd> |
1132 | Returns the row number of the topmost displayed line. Maximum value is |
1480 | <p>Returns the row number of the topmost displayed line. Maximum value is |
1133 | <code>0</code>, which displays the normal terminal contents. Lower values scroll |
1481 | <code>0</code>, which displays the normal terminal contents. Lower values scroll |
1134 | this many lines into the scrollback buffer. |
1482 | this many lines into the scrollback buffer.</p> |
1135 | </dd> |
1483 | </dd> |
1136 | <p></p> |
1484 | </li> |
1137 | <dt><strong><a name="item_want_refresh">$term->want_refresh</a></strong><br /> |
1485 | <dt><strong><a name="item_want_refresh">$term->want_refresh</a></strong> |
1138 | </dt> |
1486 | |
1139 | <dd> |
1487 | <dd> |
1140 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
1488 | <p>Requests a screen refresh. At the next opportunity, rxvt-unicode will |
1141 | compare the on-screen display with its stored representation. If they |
1489 | compare the on-screen display with its stored representation. If they |
1142 | differ, it redraws the differences. |
1490 | differ, it redraws the differences.</p> |
1143 | </dd> |
1491 | </dd> |
1144 | <dd> |
1492 | <dd> |
1145 | <p>Used after changing terminal contents to display them.</p> |
1493 | <p>Used after changing terminal contents to display them.</p> |
1146 | </dd> |
1494 | </dd> |
1147 | <p></p> |
1495 | </li> |
1148 | <dt><strong><a name="item_row_t">$text = $term->ROW_t ($row_number[, $new_text[, $start_col]])</a></strong><br /> |
1496 | <dt><strong><a name="item_row_t">$text = $term->ROW_t ($row_number[, $new_text[, $start_col]])</a></strong> |
1149 | </dt> |
1497 | |
1150 | <dd> |
1498 | <dd> |
1151 | Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code> |
1499 | <p>Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code> |
1152 | is the topmost terminal line, row <code>$term->$ncol-1</code> is the bottommost |
1500 | is the topmost terminal line, row <code>$term->$ncol-1</code> is the bottommost |
1153 | terminal line. The scrollback buffer starts at line <code>-1</code> and extends to |
1501 | terminal line. The scrollback buffer starts at line <code>-1</code> and extends to |
1154 | line <code>-$term->nsaved</code>. Nothing will be returned if a nonexistent line |
1502 | line <code>-$term->nsaved</code>. Nothing will be returned if a nonexistent line |
1155 | is requested. |
1503 | is requested.</p> |
1156 | </dd> |
1504 | </dd> |
1157 | <dd> |
1505 | <dd> |
1158 | <p>If <code>$new_text</code> is specified, it will replace characters in the current |
1506 | <p>If <code>$new_text</code> is specified, it will replace characters in the current |
1159 | line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful |
1507 | line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful |
1160 | to replace only parts of a line. The font index in the rendition will |
1508 | to replace only parts of a line. The font index in the rendition will |
1161 | automatically be updated.</p> |
1509 | automatically be updated.</p> |
1162 | </dd> |
1510 | </dd> |
1163 | <dd> |
1511 | <dd> |
1164 | <p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more |
1512 | <p><a href="#item__text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more |
1165 | than one cell when displayed are padded with urxvt::NOCHAR characters |
1513 | than one cell when displayed are padded with <code>$urxvt::NOCHAR</code> (chr 65535) |
1166 | (<code>chr 65535</code>). Characters with combining characters and other characters |
1514 | characters. Characters with combining characters and other characters that |
1167 | that do not fit into the normal tetx encoding will be replaced with |
1515 | do not fit into the normal tetx encoding will be replaced with characters |
1168 | characters in the private use area.</p> |
1516 | in the private use area.</p> |
1169 | </dd> |
1517 | </dd> |
1170 | <dd> |
1518 | <dd> |
1171 | <p>You have to obey this encoding when changing text. The advantage is |
1519 | <p>You have to obey this encoding when changing text. The advantage is |
1172 | that <code>substr</code> and similar functions work on screen cells and not on |
1520 | that <code>substr</code> and similar functions work on screen cells and not on |
1173 | characters.</p> |
1521 | characters.</p> |
1174 | </dd> |
1522 | </dd> |
1175 | <dd> |
1523 | <dd> |
1176 | <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> |
1524 | <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> |
1177 | can be used to convert normal strings into this encoding and vice versa.</p> |
1525 | can be used to convert normal strings into this encoding and vice versa.</p> |
1178 | </dd> |
1526 | </dd> |
1179 | <p></p> |
1527 | </li> |
1180 | <dt><strong><a name="item_row_r">$rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br /> |
1528 | <dt><strong><a name="item_row_r">$rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong> |
1181 | </dt> |
1529 | |
1182 | <dd> |
1530 | <dd> |
1183 | Like <a href="#item_row_t"><code>$term->ROW_t</code></a>, but returns an arrayref with rendition |
1531 | <p>Like <a href="#item_row_t"><code>$term->ROW_t</code></a>, but returns an arrayref with rendition |
1184 | bitsets. Rendition bitsets contain information about colour, font, font |
1532 | bitsets. Rendition bitsets contain information about colour, font, font |
1185 | styles and similar information. See also <a href="#item_row_t"><code>$term->ROW_t</code></a>. |
1533 | styles and similar information. See also <a href="#item_row_t"><code>$term->ROW_t</code></a>.</p> |
1186 | </dd> |
1534 | </dd> |
1187 | <dd> |
1535 | <dd> |
1188 | <p>When setting rendition, the font mask will be ignored.</p> |
1536 | <p>When setting rendition, the font mask will be ignored.</p> |
1189 | </dd> |
1537 | </dd> |
1190 | <dd> |
1538 | <dd> |
1191 | <p>See the section on RENDITION, above.</p> |
1539 | <p>See the section on RENDITION, above.</p> |
1192 | </dd> |
1540 | </dd> |
1193 | <p></p> |
1541 | </li> |
1194 | <dt><strong><a name="item_row_l">$length = $term->ROW_l ($row_number[, $new_length])</a></strong><br /> |
1542 | <dt><strong><a name="item_row_l">$length = $term->ROW_l ($row_number[, $new_length])</a></strong> |
1195 | </dt> |
1543 | |
1196 | <dd> |
1544 | <dd> |
1197 | Returns the number of screen cells that are in use (``the line |
1545 | <p>Returns the number of screen cells that are in use (``the line |
1198 | length''). Unlike the urxvt core, this returns <a href="#item_ncol"><code>$term->ncol</code></a> if the |
1546 | length''). Unlike the urxvt core, this returns <a href="#item_ncol"><code>$term->ncol</code></a> if the |
1199 | line is joined with the following one. |
1547 | line is joined with the following one.</p> |
1200 | </dd> |
1548 | </dd> |
1201 | <p></p> |
1549 | </li> |
1202 | <dt><strong><a name="item_is_longer">$bool = $term->is_longer ($row_number)</a></strong><br /> |
1550 | <dt><strong><a name="item_is_longer">$bool = $term->is_longer ($row_number)</a></strong> |
1203 | </dt> |
1551 | |
1204 | <dd> |
1552 | <dd> |
1205 | Returns true if the row is part of a multiple-row logical ``line'' (i.e. |
1553 | <p>Returns true if the row is part of a multiple-row logical ``line'' (i.e. |
1206 | joined with the following row), which means all characters are in use |
1554 | joined with the following row), which means all characters are in use |
1207 | and it is continued on the next row (and possibly a continuation of the |
1555 | and it is continued on the next row (and possibly a continuation of the |
1208 | previous row(s)). |
1556 | previous row(s)).</p> |
1209 | </dd> |
1557 | </dd> |
1210 | <p></p> |
1558 | </li> |
1211 | <dt><strong><a name="item_line">$line = $term->line ($row_number)</a></strong><br /> |
1559 | <dt><strong><a name="item_line">$line = $term->line ($row_number)</a></strong> |
1212 | </dt> |
1560 | |
1213 | <dd> |
1561 | <dd> |
1214 | Create and return a new <code>urxvt::line</code> object that stores information |
1562 | <p>Create and return a new <code>urxvt::line</code> object that stores information |
1215 | about the logical line that row <code>$row_number</code> is part of. It supports the |
1563 | about the logical line that row <code>$row_number</code> is part of. It supports the |
1216 | following methods: |
1564 | following methods:</p> |
1217 | </dd> |
1565 | </dd> |
1218 | <dl> |
1566 | <dl> |
1219 | <dt><strong><a name="item_t">$text = $line->t ([$new_text])</a></strong><br /> |
1567 | <dt><strong><a name="item_t">$text = $line->t ([$new_text])</a></strong> |
1220 | </dt> |
1568 | |
1221 | <dd> |
1569 | <dd> |
1222 | Returns or replaces the full text of the line, similar to <a href="#item_row_t"><code>ROW_t</code></a> |
1570 | <p>Returns or replaces the full text of the line, similar to <a href="#item_row_t"><code>ROW_t</code></a></p> |
1223 | </dd> |
1571 | </dd> |
1224 | <p></p> |
1572 | </li> |
1225 | <dt><strong><a name="item_r">$rend = $line->r ([$new_rend])</a></strong><br /> |
1573 | <dt><strong><a name="item_r">$rend = $line->r ([$new_rend])</a></strong> |
1226 | </dt> |
1574 | |
1227 | <dd> |
1575 | <dd> |
1228 | Returns or replaces the full rendition array of the line, similar to <a href="#item_row_r"><code>ROW_r</code></a> |
1576 | <p>Returns or replaces the full rendition array of the line, similar to <a href="#item_row_r"><code>ROW_r</code></a></p> |
1229 | </dd> |
1577 | </dd> |
1230 | <p></p> |
1578 | </li> |
1231 | <dt><strong><a name="item_l">$length = $line->l</a></strong><br /> |
1579 | <dt><strong><a name="item_l">$length = $line->l</a></strong> |
1232 | </dt> |
1580 | |
1233 | <dd> |
1581 | <dd> |
1234 | Returns the length of the line in cells, similar to <a href="#item_row_l"><code>ROW_l</code></a>. |
1582 | <p>Returns the length of the line in cells, similar to <a href="#item_row_l"><code>ROW_l</code></a>.</p> |
1235 | </dd> |
1583 | </dd> |
1236 | <p></p> |
1584 | </li> |
1237 | <dt><strong><a name="item_beg">$rownum = $line->beg</a></strong><br /> |
1585 | <dt><strong><a name="item_beg">$rownum = $line->beg</a></strong> |
1238 | </dt> |
1586 | |
1239 | <dt><strong><a name="item_end">$rownum = $line->end</a></strong><br /> |
1587 | <dt><strong><a name="item_end">$rownum = $line->end</a></strong> |
1240 | </dt> |
1588 | |
1241 | <dd> |
1589 | <dd> |
1242 | Return the row number of the first/last row of the line, respectively. |
1590 | <p>Return the row number of the first/last row of the line, respectively.</p> |
1243 | </dd> |
1591 | </dd> |
1244 | <p></p> |
1592 | </li> |
1245 | <dt><strong><a name="item_offset_of">$offset = $line->offset_of ($row, $col)</a></strong><br /> |
1593 | <dt><strong><a name="item_offset_of">$offset = $line->offset_of ($row, $col)</a></strong> |
1246 | </dt> |
1594 | |
1247 | <dd> |
1595 | <dd> |
1248 | Returns the character offset of the given row|col pair within the logical |
1596 | <p>Returns the character offset of the given row|col pair within the logical |
1249 | line. Works for rows outside the line, too, and returns corresponding |
1597 | line. Works for rows outside the line, too, and returns corresponding |
1250 | offsets outside the string. |
1598 | offsets outside the string.</p> |
1251 | </dd> |
1599 | </dd> |
1252 | <p></p> |
1600 | </li> |
1253 | <dt><strong><a name="item_coord_of">($row, $col) = $line->coord_of ($offset)</a></strong><br /> |
1601 | <dt><strong><a name="item_coord_of">($row, $col) = $line->coord_of ($offset)</a></strong> |
1254 | </dt> |
1602 | |
1255 | <dd> |
1603 | <dd> |
1256 | Translates a string offset into terminal coordinates again. |
1604 | <p>Translates a string offset into terminal coordinates again.</p> |
|
|
1605 | </dd> |
|
|
1606 | </li> |
1257 | </dd> |
1607 | </dl> |
1258 | <p></p></dl> |
|
|
1259 | <dt><strong><a name="item_special_encode">$text = $term->special_encode $string</a></strong><br /> |
1608 | <dt><strong><a name="item_special_encode">$text = $term->special_encode $string</a></strong> |
1260 | </dt> |
1609 | |
1261 | <dd> |
1610 | <dd> |
1262 | Converts a perl string into the special encoding used by rxvt-unicode, |
1611 | <p>Converts a perl string into the special encoding used by rxvt-unicode, |
1263 | where one character corresponds to one screen cell. See |
1612 | where one character corresponds to one screen cell. See |
1264 | <a href="#item_row_t"><code>$term->ROW_t</code></a> for details. |
1613 | <a href="#item_row_t"><code>$term->ROW_t</code></a> for details.</p> |
1265 | </dd> |
1614 | </dd> |
1266 | <p></p> |
1615 | </li> |
1267 | <dt><strong><a name="item_special_decode">$string = $term->special_decode $text</a></strong><br /> |
1616 | <dt><strong><a name="item_special_decode">$string = $term->special_decode $text</a></strong> |
1268 | </dt> |
1617 | |
1269 | <dd> |
1618 | <dd> |
1270 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1619 | <p>Converts rxvt-unicodes text reprsentation into a perl string. See |
1271 | <a href="#item_row_t"><code>$term->ROW_t</code></a> for details. |
1620 | <a href="#item_row_t"><code>$term->ROW_t</code></a> for details.</p> |
1272 | </dd> |
|
|
1273 | <p></p> |
|
|
1274 | <dt><strong><a name="item_grab_button">$success = $term->grab_button ($button, $modifiermask)</a></strong><br /> |
|
|
1275 | </dt> |
|
|
1276 | <dd> |
1621 | </dd> |
1277 | Registers a synchronous button grab. See the XGrabButton manpage. |
1622 | </li> |
|
|
1623 | <dt><strong><a name="item_grab_button">$success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])</a></strong> |
|
|
1624 | |
|
|
1625 | <dt><strong><a name="item_ungrab_button">$term->ungrab_button ($button, $modifiermask[, $window = $term->vt])</a></strong> |
|
|
1626 | |
1278 | </dd> |
1627 | <dd> |
1279 | <p></p> |
1628 | <p>Register/unregister a synchronous button grab. See the XGrabButton |
|
|
1629 | manpage.</p> |
|
|
1630 | </dd> |
|
|
1631 | </li> |
1280 | <dt><strong><a name="item_grab">$success = $term->grab ($eventtime[, $sync])</a></strong><br /> |
1632 | <dt><strong><a name="item_grab">$success = $term->grab ($eventtime[, $sync])</a></strong> |
1281 | </dt> |
1633 | |
1282 | <dd> |
1634 | <dd> |
1283 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1635 | <p>Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
1284 | synchronous (<code>$sync</code> is true). Also remembers the grab timestampe. |
1636 | synchronous (<code>$sync</code> is true). Also remembers the grab timestampe.</p> |
1285 | </dd> |
1637 | </dd> |
1286 | <p></p> |
1638 | </li> |
1287 | <dt><strong><a name="item_allow_events_async">$term->allow_events_async</a></strong><br /> |
1639 | <dt><strong><a name="item_allow_events_async">$term->allow_events_async</a></strong> |
1288 | </dt> |
1640 | |
1289 | <dd> |
1641 | <dd> |
1290 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
1642 | <p>Calls XAllowEvents with AsyncBoth for the most recent grab.</p> |
1291 | </dd> |
1643 | </dd> |
1292 | <p></p> |
1644 | </li> |
1293 | <dt><strong><a name="item_allow_events_sync">$term->allow_events_sync</a></strong><br /> |
1645 | <dt><strong><a name="item_allow_events_sync">$term->allow_events_sync</a></strong> |
1294 | </dt> |
1646 | |
1295 | <dd> |
1647 | <dd> |
1296 | Calls XAllowEvents with SyncBoth for the most recent grab. |
1648 | <p>Calls XAllowEvents with SyncBoth for the most recent grab.</p> |
1297 | </dd> |
1649 | </dd> |
1298 | <p></p> |
1650 | </li> |
1299 | <dt><strong><a name="item_allow_events_replay">$term->allow_events_replay</a></strong><br /> |
1651 | <dt><strong><a name="item_allow_events_replay">$term->allow_events_replay</a></strong> |
1300 | </dt> |
1652 | |
1301 | <dd> |
1653 | <dd> |
1302 | Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most |
1654 | <p>Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most |
1303 | recent grab. |
1655 | recent grab.</p> |
1304 | </dd> |
1656 | </dd> |
1305 | <p></p> |
1657 | </li> |
1306 | <dt><strong><a name="item_ungrab">$term->ungrab</a></strong><br /> |
1658 | <dt><strong><a name="item_ungrab">$term->ungrab</a></strong> |
1307 | </dt> |
1659 | |
1308 | <dd> |
1660 | <dd> |
1309 | Calls XUngrab for the most recent grab. Is called automatically on |
1661 | <p>Calls XUngrab for the most recent grab. Is called automatically on |
1310 | evaluation errors, as it is better to lose the grab in the error case as |
1662 | evaluation errors, as it is better to lose the grab in the error case as |
1311 | the session. |
1663 | the session.</p> |
|
|
1664 | </dd> |
|
|
1665 | </li> |
|
|
1666 | <dt><strong><a name="item_xinternatom">$atom = $term->XInternAtom ($atom_name[, $only_if_exists])</a></strong> |
|
|
1667 | |
|
|
1668 | <dt><strong><a name="item_xgetatomname">$atom_name = $term->XGetAtomName ($atom)</a></strong> |
|
|
1669 | |
|
|
1670 | <dt><strong><a name="item_xlistproperties">@atoms = $term->XListProperties ($window)</a></strong> |
|
|
1671 | |
|
|
1672 | <dt><strong><a name="item_xgetwindowproperty">($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)</a></strong> |
|
|
1673 | |
|
|
1674 | <dt><strong><a name="item_xchangewindowproperty">$term->XChangeWindowProperty ($window, $property, $type, $format, $octets)</a></strong> |
|
|
1675 | |
|
|
1676 | <dt><strong><a name="item_xdeleteproperty">$term->XDeleteProperty ($window, $property)</a></strong> |
|
|
1677 | |
|
|
1678 | <dt><strong><a name="item_defaultrootwindow">$window = $term->DefaultRootWindow</a></strong> |
|
|
1679 | |
|
|
1680 | <dt><strong><a name="item_xreparentwindow">$term->XReparentWindow ($window, $parent, [$x, $y])</a></strong> |
|
|
1681 | |
|
|
1682 | <dt><strong><a name="item_xmapwindow">$term->XMapWindow ($window)</a></strong> |
|
|
1683 | |
|
|
1684 | <dt><strong><a name="item_xunmapwindow">$term->XUnmapWindow ($window)</a></strong> |
|
|
1685 | |
|
|
1686 | <dt><strong><a name="item_xmoveresizewindow">$term->XMoveResizeWindow ($window, $x, $y, $width, $height)</a></strong> |
|
|
1687 | |
|
|
1688 | <dt><strong><a name="item_xtranslatecoordinates">($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)</a></strong> |
|
|
1689 | |
|
|
1690 | <dt><strong><a name="item_xchangeinput">$term->XChangeInput ($window, $add_events[, $del_events])</a></strong> |
|
|
1691 | |
1312 | </dd> |
1692 | <dd> |
1313 | <p></p></dl> |
1693 | <p>Various X or X-related functions. The <a href="#item__term"><code>$term</code></a> object only serves as |
|
|
1694 | the source of the display, otherwise those functions map more-or-less |
|
|
1695 | directory onto the X functions of the same name.</p> |
|
|
1696 | </dd> |
|
|
1697 | </li> |
|
|
1698 | </dl> |
1314 | <p> |
1699 | <p> |
1315 | </p> |
1700 | </p> |
1316 | <h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> |
1701 | <h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> |
1317 | <dl> |
1702 | <dl> |
1318 | <dt><strong><a name="item_add_title">$popup->add_title ($title)</a></strong><br /> |
1703 | <dt><strong><a name="item_add_title">$popup->add_title ($title)</a></strong> |
1319 | </dt> |
1704 | |
1320 | <dd> |
1705 | <dd> |
1321 | Adds a non-clickable title to the popup. |
1706 | <p>Adds a non-clickable title to the popup.</p> |
1322 | </dd> |
1707 | </dd> |
1323 | <p></p> |
1708 | </li> |
1324 | <dt><strong><a name="item_add_separator">$popup->add_separator ([$sepchr])</a></strong><br /> |
1709 | <dt><strong><a name="item_add_separator">$popup->add_separator ([$sepchr])</a></strong> |
1325 | </dt> |
1710 | |
1326 | <dd> |
1711 | <dd> |
1327 | Creates a separator, optionally using the character given as <code>$sepchr</code>. |
1712 | <p>Creates a separator, optionally using the character given as <code>$sepchr</code>.</p> |
1328 | </dd> |
1713 | </dd> |
1329 | <p></p> |
1714 | </li> |
1330 | <dt><strong><a name="item_add_button">$popup->add_button ($text, $cb)</a></strong><br /> |
1715 | <dt><strong><a name="item_add_button">$popup->add_button ($text, $cb)</a></strong> |
1331 | </dt> |
1716 | |
1332 | <dd> |
1717 | <dd> |
1333 | Adds a clickable button to the popup. <code>$cb</code> is called whenever it is |
1718 | <p>Adds a clickable button to the popup. <code>$cb</code> is called whenever it is |
1334 | selected. |
1719 | selected.</p> |
1335 | </dd> |
1720 | </dd> |
1336 | <p></p> |
1721 | </li> |
1337 | <dt><strong><a name="item_add_toggle">$popup->add_toggle ($text, $cb, $initial_value)</a></strong><br /> |
1722 | <dt><strong><a name="item_add_toggle">$popup->add_toggle ($text, $initial_value, $cb)</a></strong> |
1338 | </dt> |
1723 | |
1339 | <dd> |
1724 | <dd> |
1340 | Adds a toggle/checkbox item to the popup. Teh callback gets called |
1725 | <p>Adds a toggle/checkbox item to the popup. The callback gets called |
1341 | whenever it gets toggled, with a boolean indicating its value as its first |
1726 | whenever it gets toggled, with a boolean indicating its new value as its |
1342 | argument. |
1727 | first argument.</p> |
1343 | </dd> |
1728 | </dd> |
1344 | <p></p> |
1729 | </li> |
1345 | <dt><strong>$popup->show</strong><br /> |
1730 | <dt><strong>$popup->show</strong> |
1346 | </dt> |
1731 | |
1347 | <dd> |
1732 | <dd> |
1348 | Displays the popup (which is initially hidden). |
1733 | <p>Displays the popup (which is initially hidden).</p> |
|
|
1734 | </dd> |
|
|
1735 | </li> |
1349 | </dd> |
1736 | </dl> |
1350 | <p></p></dl> |
|
|
1351 | <p> |
1737 | <p> |
1352 | </p> |
1738 | </p> |
1353 | <h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> |
1739 | <h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> |
1354 | <p>This class implements timer watchers/events. Time is represented as a |
1740 | <p>This class implements timer watchers/events. Time is represented as a |
1355 | fractional number of seconds since the epoch. Example:</p> |
1741 | fractional number of seconds since the epoch. Example:</p> |
… | |
… | |
1361 | ->cb (sub { |
1747 | ->cb (sub { |
1362 | $term->{overlay}->set (0, 0, |
1748 | $term->{overlay}->set (0, 0, |
1363 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
1749 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
1364 | });</pre> |
1750 | });</pre> |
1365 | <dl> |
1751 | <dl> |
1366 | <dt><strong><a name="item__24timer__3d_new_urxvt_3a_3atimer">$timer = new urxvt::timer</a></strong><br /> |
1752 | <dt><strong><a name="item__timer">$timer = new urxvt::timer</a></strong> |
1367 | </dt> |
1753 | |
1368 | <dd> |
1754 | <dd> |
1369 | Create a new timer object in started state. It is scheduled to fire |
1755 | <p>Create a new timer object in started state. It is scheduled to fire |
1370 | immediately. |
1756 | immediately.</p> |
1371 | </dd> |
1757 | </dd> |
1372 | <p></p> |
1758 | </li> |
1373 | <dt><strong><a name="item_cb">$timer = $timer->cb (sub { my ($timer) = @_; ... })</a></strong><br /> |
1759 | <dt><strong><a name="item_cb">$timer = $timer->cb (sub { my ($timer) = @_; ... })</a></strong> |
1374 | </dt> |
1760 | |
1375 | <dd> |
1761 | <dd> |
1376 | Set the callback to be called when the timer triggers. |
1762 | <p>Set the callback to be called when the timer triggers.</p> |
1377 | </dd> |
1763 | </dd> |
1378 | <p></p> |
1764 | </li> |
1379 | <dt><strong><a name="item_at">$tstamp = $timer->at</a></strong><br /> |
1765 | <dt><strong><a name="item_at">$tstamp = $timer->at</a></strong> |
1380 | </dt> |
1766 | |
1381 | <dd> |
1767 | <dd> |
1382 | Return the time this watcher will fire next. |
1768 | <p>Return the time this watcher will fire next.</p> |
1383 | </dd> |
1769 | </dd> |
1384 | <p></p> |
1770 | </li> |
1385 | <dt><strong>$timer = $timer->set ($tstamp)</strong><br /> |
1771 | <dt><strong>$timer = $timer->set ($tstamp)</strong> |
1386 | </dt> |
1772 | |
1387 | <dd> |
1773 | <dd> |
1388 | Set the time the event is generated to $tstamp. |
1774 | <p>Set the time the event is generated to $tstamp.</p> |
1389 | </dd> |
1775 | </dd> |
1390 | <p></p> |
1776 | </li> |
1391 | <dt><strong><a name="item_interval">$timer = $timer->interval ($interval)</a></strong><br /> |
1777 | <dt><strong><a name="item_interval">$timer = $timer->interval ($interval)</a></strong> |
1392 | </dt> |
1778 | |
1393 | <dd> |
1779 | <dd> |
1394 | Normally (and when <code>$interval</code> is <code>0</code>), the timer will automatically |
1780 | <p>Normally (and when <code>$interval</code> is <code>0</code>), the timer will automatically |
1395 | stop after it has fired once. If <code>$interval</code> is non-zero, then the timer |
1781 | stop after it has fired once. If <code>$interval</code> is non-zero, then the timer |
1396 | is automatically rescheduled at the given intervals. |
1782 | is automatically rescheduled at the given intervals.</p> |
1397 | </dd> |
1783 | </dd> |
1398 | <p></p> |
1784 | </li> |
1399 | <dt><strong><a name="item_start">$timer = $timer->start</a></strong><br /> |
1785 | <dt><strong><a name="item_start">$timer = $timer->start</a></strong> |
1400 | </dt> |
1786 | |
1401 | <dd> |
|
|
1402 | Start the timer. |
|
|
1403 | </dd> |
1787 | <dd> |
1404 | <p></p> |
1788 | <p>Start the timer.</p> |
|
|
1789 | </dd> |
|
|
1790 | </li> |
1405 | <dt><strong>$timer = $timer->start ($tstamp)</strong><br /> |
1791 | <dt><strong>$timer = $timer->start ($tstamp)</strong> |
1406 | </dt> |
1792 | |
1407 | <dd> |
1793 | <dd> |
1408 | Set the event trigger time to <code>$tstamp</code> and start the timer. |
1794 | <p>Set the event trigger time to <code>$tstamp</code> and start the timer.</p> |
|
|
1795 | </dd> |
|
|
1796 | </li> |
|
|
1797 | <dt><strong><a name="item_after">$timer = $timer->after ($delay)</a></strong> |
|
|
1798 | |
1409 | </dd> |
1799 | <dd> |
1410 | <p></p> |
1800 | <p>Like <a href="#item_start"><code>start</code></a>, but sets the expiry timer to c<urxvt::NOW + $delay>.</p> |
|
|
1801 | </dd> |
|
|
1802 | </li> |
1411 | <dt><strong><a name="item_stop">$timer = $timer->stop</a></strong><br /> |
1803 | <dt><strong><a name="item_stop">$timer = $timer->stop</a></strong> |
1412 | </dt> |
1804 | |
1413 | <dd> |
|
|
1414 | Stop the timer. |
|
|
1415 | </dd> |
1805 | <dd> |
1416 | <p></p></dl> |
1806 | <p>Stop the timer.</p> |
|
|
1807 | </dd> |
|
|
1808 | </li> |
|
|
1809 | </dl> |
1417 | <p> |
1810 | <p> |
1418 | </p> |
1811 | </p> |
1419 | <h2><a name="the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></h2> |
1812 | <h2><a name="the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></h2> |
1420 | <p>This class implements io watchers/events. Example:</p> |
1813 | <p>This class implements io watchers/events. Example:</p> |
1421 | <pre> |
1814 | <pre> |
… | |
… | |
1430 | # $revents must be 1 here, no need to check |
1823 | # $revents must be 1 here, no need to check |
1431 | sysread $term->{socket}, my $buf, 8192 |
1824 | sysread $term->{socket}, my $buf, 8192 |
1432 | or end-of-file; |
1825 | or end-of-file; |
1433 | });</pre> |
1826 | });</pre> |
1434 | <dl> |
1827 | <dl> |
1435 | <dt><strong><a name="item__24iow__3d_new_urxvt_3a_3aiow">$iow = new urxvt::iow</a></strong><br /> |
1828 | <dt><strong><a name="item__iow">$iow = new urxvt::iow</a></strong> |
1436 | </dt> |
1829 | |
1437 | <dd> |
1830 | <dd> |
1438 | Create a new io watcher object in stopped state. |
1831 | <p>Create a new io watcher object in stopped state.</p> |
1439 | </dd> |
1832 | </dd> |
1440 | <p></p> |
1833 | </li> |
1441 | <dt><strong>$iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... })</strong><br /> |
1834 | <dt><strong>$iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... })</strong> |
1442 | </dt> |
1835 | |
1443 | <dd> |
1836 | <dd> |
1444 | Set the callback to be called when io events are triggered. <code>$reventmask</code> |
1837 | <p>Set the callback to be called when io events are triggered. <code>$reventmask</code> |
1445 | is a bitset as described in the <a href="#item_events"><code>events</code></a> method. |
1838 | is a bitset as described in the <a href="#item_events"><code>events</code></a> method.</p> |
1446 | </dd> |
1839 | </dd> |
1447 | <p></p> |
1840 | </li> |
1448 | <dt><strong><a name="item_fd">$iow = $iow->fd ($fd)</a></strong><br /> |
1841 | <dt><strong><a name="item_fd">$iow = $iow->fd ($fd)</a></strong> |
1449 | </dt> |
1842 | |
1450 | <dd> |
1843 | <dd> |
1451 | Set the filedescriptor (not handle) to watch. |
1844 | <p>Set the filedescriptor (not handle) to watch.</p> |
1452 | </dd> |
1845 | </dd> |
1453 | <p></p> |
1846 | </li> |
1454 | <dt><strong><a name="item_events">$iow = $iow->events ($eventmask)</a></strong><br /> |
1847 | <dt><strong><a name="item_events">$iow = $iow->events ($eventmask)</a></strong> |
1455 | </dt> |
1848 | |
1456 | <dd> |
1849 | <dd> |
1457 | Set the event mask to watch. The only allowed values are |
1850 | <p>Set the event mask to watch. The only allowed values are |
1458 | <code>urxvt::EVENT_READ</code> and <code>urxvt::EVENT_WRITE</code>, which might be ORed |
1851 | <code>urxvt::EVENT_READ</code> and <code>urxvt::EVENT_WRITE</code>, which might be ORed |
1459 | together, or <code>urxvt::EVENT_NONE</code>. |
1852 | together, or <code>urxvt::EVENT_NONE</code>.</p> |
1460 | </dd> |
1853 | </dd> |
1461 | <p></p> |
1854 | </li> |
1462 | <dt><strong>$iow = $iow->start</strong><br /> |
1855 | <dt><strong>$iow = $iow->start</strong> |
1463 | </dt> |
1856 | |
1464 | <dd> |
1857 | <dd> |
1465 | Start watching for requested events on the given handle. |
1858 | <p>Start watching for requested events on the given handle.</p> |
1466 | </dd> |
1859 | </dd> |
1467 | <p></p> |
1860 | </li> |
1468 | <dt><strong>$iow = $iow->stop</strong><br /> |
1861 | <dt><strong>$iow = $iow->stop</strong> |
1469 | </dt> |
1862 | |
1470 | <dd> |
1863 | <dd> |
1471 | Stop watching for events on the given filehandle. |
1864 | <p>Stop watching for events on the given filehandle.</p> |
|
|
1865 | </dd> |
|
|
1866 | </li> |
|
|
1867 | </dl> |
|
|
1868 | <p> |
|
|
1869 | </p> |
|
|
1870 | <h2><a name="the_urxvt__iw_class">The <code>urxvt::iw</code> Class</a></h2> |
|
|
1871 | <p>This class implements idle watchers, that get called automatically when |
|
|
1872 | the process is idle. They should return as fast as possible, after doing |
|
|
1873 | some useful work.</p> |
|
|
1874 | <dl> |
|
|
1875 | <dt><strong><a name="item__iw">$iw = new urxvt::iw</a></strong> |
|
|
1876 | |
1472 | </dd> |
1877 | <dd> |
1473 | <p></p></dl> |
1878 | <p>Create a new idle watcher object in stopped state.</p> |
|
|
1879 | </dd> |
|
|
1880 | </li> |
|
|
1881 | <dt><strong>$iw = $iw->cb (sub { my ($iw) = @_; ... })</strong> |
|
|
1882 | |
|
|
1883 | <dd> |
|
|
1884 | <p>Set the callback to be called when the watcher triggers.</p> |
|
|
1885 | </dd> |
|
|
1886 | </li> |
|
|
1887 | <dt><strong>$timer = $timer->start</strong> |
|
|
1888 | |
|
|
1889 | <dd> |
|
|
1890 | <p>Start the watcher.</p> |
|
|
1891 | </dd> |
|
|
1892 | </li> |
|
|
1893 | <dt><strong>$timer = $timer->stop</strong> |
|
|
1894 | |
|
|
1895 | <dd> |
|
|
1896 | <p>Stop the watcher.</p> |
|
|
1897 | </dd> |
|
|
1898 | </li> |
|
|
1899 | </dl> |
|
|
1900 | <p> |
|
|
1901 | </p> |
|
|
1902 | <h2><a name="the_urxvt__pw_class">The <code>urxvt::pw</code> Class</a></h2> |
|
|
1903 | <p>This class implements process watchers. They create an event whenever a |
|
|
1904 | process exits, after which they stop automatically.</p> |
|
|
1905 | <pre> |
|
|
1906 | my $pid = fork; |
|
|
1907 | ... |
|
|
1908 | $term->{pw} = urxvt::pw |
|
|
1909 | ->new |
|
|
1910 | ->start ($pid) |
|
|
1911 | ->cb (sub { |
|
|
1912 | my ($pw, $exit_status) = @_; |
|
|
1913 | ... |
|
|
1914 | });</pre> |
|
|
1915 | <dl> |
|
|
1916 | <dt><strong><a name="item__pw">$pw = new urxvt::pw</a></strong> |
|
|
1917 | |
|
|
1918 | <dd> |
|
|
1919 | <p>Create a new process watcher in stopped state.</p> |
|
|
1920 | </dd> |
|
|
1921 | </li> |
|
|
1922 | <dt><strong>$pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })</strong> |
|
|
1923 | |
|
|
1924 | <dd> |
|
|
1925 | <p>Set the callback to be called when the timer triggers.</p> |
|
|
1926 | </dd> |
|
|
1927 | </li> |
|
|
1928 | <dt><strong>$pw = $timer->start ($pid)</strong> |
|
|
1929 | |
|
|
1930 | <dd> |
|
|
1931 | <p>Tells the wqtcher to start watching for process <code>$pid</code>.</p> |
|
|
1932 | </dd> |
|
|
1933 | </li> |
|
|
1934 | <dt><strong>$pw = $pw->stop</strong> |
|
|
1935 | |
|
|
1936 | <dd> |
|
|
1937 | <p>Stop the watcher.</p> |
|
|
1938 | </dd> |
|
|
1939 | </li> |
|
|
1940 | </dl> |
1474 | <p> |
1941 | <p> |
1475 | </p> |
1942 | </p> |
1476 | <hr /> |
1943 | <hr /> |
1477 | <h1><a name="environment">ENVIRONMENT</a></h1> |
1944 | <h1><a name="environment">ENVIRONMENT</a></h1> |
1478 | <p> |
1945 | <p> |
1479 | </p> |
1946 | </p> |
1480 | <h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> |
1947 | <h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> |
1481 | <p>This variable controls the verbosity level of the perl extension. Higher |
1948 | <p>This variable controls the verbosity level of the perl extension. Higher |
1482 | numbers indicate more verbose output.</p> |
1949 | numbers indicate more verbose output.</p> |
1483 | <dl> |
1950 | <dl> |
1484 | <dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br /> |
1951 | <dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong> |
1485 | </dt> |
1952 | |
1486 | <dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">>= 3 - script loading and management</a></strong><br /> |
1953 | <dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">>= 3 - script loading and management</a></strong> |
1487 | </dt> |
1954 | |
1488 | <dt><strong><a name="item__3e_3d10__2d_all_called_hooks">>=10 - all called hooks</a></strong><br /> |
1955 | <dt><strong><a name="item__3e_3d10__2d_all_called_hooks">>=10 - all called hooks</a></strong> |
1489 | </dt> |
1956 | |
1490 | <dt><strong><a name="item__3e_3d11__2d_hook_reutrn_values">>=11 - hook reutrn values</a></strong><br /> |
1957 | <dt><strong><a name="item__3e_3d11__2d_hook_reutrn_values">>=11 - hook reutrn values</a></strong> |
1491 | </dt> |
1958 | |
1492 | </dl> |
1959 | </dl> |
1493 | <p> |
1960 | <p> |
1494 | </p> |
1961 | </p> |
1495 | <hr /> |
1962 | <hr /> |
1496 | <h1><a name="author">AUTHOR</a></h1> |
1963 | <h1><a name="author">AUTHOR</a></h1> |