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