| … | |
… | |
| 28 | <li><a href="#the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></li> |
28 | <li><a href="#the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></li> |
| 29 | <li><a href="#the_urxvt__term_class">The <code>urxvt::term</code> Class</a></li> |
29 | <li><a href="#the_urxvt__term_class">The <code>urxvt::term</code> Class</a></li> |
| 30 | <li><a href="#the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></li> |
30 | <li><a href="#the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></li> |
| 31 | <li><a href="#the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></li> |
31 | <li><a href="#the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></li> |
| 32 | <li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li> |
32 | <li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li> |
|
|
33 | <li><a href="#the_urxvt__iw_class">The <code>urxvt::iw</code> Class</a></li> |
|
|
34 | <li><a href="#the_urxvt__pw_class">The <code>urxvt::pw</code> Class</a></li> |
| 33 | </ul> |
35 | </ul> |
| 34 | |
36 | |
| 35 | <li><a href="#environment">ENVIRONMENT</a></li> |
37 | <li><a href="#environment">ENVIRONMENT</a></li> |
| 36 | <ul> |
38 | <ul> |
| 37 | |
39 | |
| … | |
… | |
| 80 | <p>This section describes the extensions delivered with this release. You can |
82 | <p>This section describes the extensions delivered with this release. You can |
| 81 | find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> |
83 | find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> |
| 82 | <p>You can activate them like this:</p> |
84 | <p>You can activate them like this:</p> |
| 83 | <pre> |
85 | <pre> |
| 84 | rxvt -pe <extensionname></pre> |
86 | rxvt -pe <extensionname></pre> |
|
|
87 | <p>Or by adding them to the resource for extensions loaded by default:</p> |
|
|
88 | <pre> |
|
|
89 | URxvt.perl-ext-common: default,automove-background,selection-autotransform</pre> |
| 85 | <dl> |
90 | <dl> |
| 86 | <dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br /> |
91 | <dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br /> |
| 87 | </dt> |
92 | </dt> |
| 88 | <dd> |
93 | <dd> |
| 89 | (More) intelligent selection. This extension tries to be more intelligent |
94 | (More) intelligent selection. This extension tries to be more intelligent |
| 90 | when the user extends selections (double-click). Right now, it tries to |
95 | when the user extends selections (double-click and further clicks). Right |
| 91 | select urls and complete shell-quoted arguments, which is very convenient, |
96 | now, it tries to select words, urls and complete shell-quoted |
| 92 | too, if your <em>ls</em> supports <code>--quoting-style=shell</code>. |
97 | arguments, which is very convenient, too, if your <em>ls</em> supports |
| 93 | </dd> |
98 | <code>--quoting-style=shell</code>. |
| 94 | <dd> |
99 | </dd> |
|
|
100 | <dd> |
|
|
101 | <p>A double-click usually selects the word under the cursor, further clicks |
|
|
102 | will enlarge the selection.</p> |
|
|
103 | </dd> |
|
|
104 | <dd> |
|
|
105 | <p>The selection works by trying to match a number of regexes and displaying |
|
|
106 | them in increasing order of length. You can add your own regexes by |
|
|
107 | specifying resources of the form:</p> |
|
|
108 | </dd> |
|
|
109 | <dd> |
|
|
110 | <pre> |
|
|
111 | URxvt.selection.pattern-0: perl-regex |
|
|
112 | URxvt.selection.pattern-1: perl-regex |
|
|
113 | ...</pre> |
|
|
114 | </dd> |
|
|
115 | <dd> |
|
|
116 | <p>The index number (0, 1...) must not have any holes, and each regex must |
|
|
117 | contain at least one pair of capturing parentheses, which will be used for |
|
|
118 | the match. For example, the followign adds a regex that matches everything |
|
|
119 | between two vertical bars:</p> |
|
|
120 | </dd> |
|
|
121 | <dd> |
|
|
122 | <pre> |
|
|
123 | URxvt.selection.pattern-0: \\|([^|]+)\\|</pre> |
|
|
124 | </dd> |
|
|
125 | <dd> |
|
|
126 | <p>Another example: Programs I use often output ``absolute path: '' at the |
|
|
127 | beginning of a line when they process multiple files. The following |
|
|
128 | pattern matches the filename (note, there is a single space at the very |
|
|
129 | end):</p> |
|
|
130 | </dd> |
|
|
131 | <dd> |
|
|
132 | <pre> |
|
|
133 | URxvt.selection.pattern-0: ^(/[^:]+):\</pre> |
|
|
134 | </dd> |
|
|
135 | <dd> |
|
|
136 | <p>You can look at the source of the selection extension to see more |
|
|
137 | interesting uses, such as parsing a line from beginning to end.</p> |
|
|
138 | </dd> |
|
|
139 | <dd> |
| 95 | <p>It also offers the following bindable keyboard command:</p> |
140 | <p>This extension also offers following bindable keyboard commands:</p> |
| 96 | </dd> |
141 | </dd> |
| 97 | <dl> |
142 | <dl> |
| 98 | <dt><strong><a name="item_rot13">rot13</a></strong><br /> |
143 | <dt><strong><a name="item_rot13">rot13</a></strong><br /> |
| 99 | </dt> |
144 | </dt> |
| 100 | <dd> |
145 | <dd> |
| … | |
… | |
| 115 | <dt><strong>selection-popup (enabled by default)</strong><br /> |
160 | <dt><strong>selection-popup (enabled by default)</strong><br /> |
| 116 | </dt> |
161 | </dt> |
| 117 | <dd> |
162 | <dd> |
| 118 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
163 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
| 119 | text into various other formats/action (such as uri unescaping, perl |
164 | text into various other formats/action (such as uri unescaping, perl |
| 120 | evalution, web-browser starting etc.), depending on content. |
165 | evaluation, web-browser starting etc.), depending on content. |
|
|
166 | </dd> |
|
|
167 | <dd> |
|
|
168 | <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 |
|
|
170 | popup is displayed.</p> |
|
|
171 | </dd> |
|
|
172 | <dd> |
|
|
173 | <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. |
|
|
175 | 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 |
|
|
177 | when the button gets activated and should transform <code>$_</code>.</p> |
|
|
178 | </dd> |
|
|
179 | <dd> |
|
|
180 | <p>The following will add an entry <code>a to b</code> that transforms all <code>a</code>s in |
|
|
181 | the selection to <code>b</code>s, but only if the selection currently contains any |
|
|
182 | <code>a</code>s:</p> |
|
|
183 | </dd> |
|
|
184 | <dd> |
|
|
185 | <pre> |
|
|
186 | push @{ $self->{term}{selection_popup_hook} }, sub { |
|
|
187 | /a/ ? ("a to be" => sub { s/a/b/g } |
|
|
188 | : () |
|
|
189 | };</pre> |
| 121 | </dd> |
190 | </dd> |
| 122 | <p></p> |
191 | <p></p> |
| 123 | <dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback<hotkey> (enabled by default)</a></strong><br /> |
192 | <dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback<hotkey> (enabled by default)</a></strong><br /> |
| 124 | </dt> |
193 | </dt> |
| 125 | <dd> |
194 | <dd> |
| 126 | Adds regex search functionality to the scrollback buffer, triggered |
195 | Adds regex search functionality to the scrollback buffer, triggered |
| 127 | by a hotkey (default: <code>M-s</code>). When in search mode, normal terminal |
196 | by a hotkey (default: <code>M-s</code>). While in search mode, normal terminal |
| 128 | input/output is suspended. |
197 | input/output is suspended and a regex is displayed at the bottom of the |
| 129 | </dd> |
198 | screen. |
| 130 | <dd> |
199 | </dd> |
| 131 | <p><code>/</code> starts an incremental regex search, <code>n</code> searches further, <code>p</code> or |
|
|
| 132 | <code>N</code> jump to the previous match, <code>G</code> jumps to the bottom and clears the |
|
|
| 133 | history, <code>enter</code> leaves search mode at the current position and <code>escape</code> |
|
|
| 134 | returns to the original position.</p> |
|
|
| 135 | </dd> |
200 | <dd> |
| 136 | <p></p> |
201 | <p>Inputting characters appends them to the regex and continues incremental |
| 137 | <dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> |
202 | search. <code>BackSpace</code> removes a character from the regex, <code>Up</code> and <code>Down</code> |
| 138 | </dt> |
203 | 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 |
|
|
205 | 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 |
|
|
207 | selection.</p> |
| 139 | <dd> |
208 | </dd> |
| 140 | Displays a digital clock using the built-in overlay. |
209 | <p></p> |
|
|
210 | <dt><strong><a name="item_readline">readline (enabled by default)</a></strong><br /> |
|
|
211 | </dt> |
|
|
212 | <dd> |
|
|
213 | A support package that tries to make editing with readline easier. At the |
|
|
214 | moment, it reacts to clicking with the left mouse button by trying to |
|
|
215 | 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 |
|
|
217 | for programs that correctly support wide characters). |
|
|
218 | </dd> |
|
|
219 | <dd> |
|
|
220 | <p>To avoid too many false positives, this is only done when:</p> |
|
|
221 | </dd> |
|
|
222 | <dl> |
|
|
223 | <dt><strong><a name="item__2d_the_tty_is_in_icanon_state_2e">- the tty is in ICANON state.</a></strong><br /> |
|
|
224 | </dt> |
|
|
225 | <dt><strong><a name="item__2d_the_text_cursor_is_visible_2e">- the text cursor is visible.</a></strong><br /> |
|
|
226 | </dt> |
|
|
227 | <dt><strong><a name="item__2d_the_primary_screen_is_currently_being_displaye">- the primary screen is currently being displayed.</a></strong><br /> |
|
|
228 | </dt> |
|
|
229 | <dt><strong><a name="item_same">- the mouse is on the same (multi-row-) line as the text cursor.</a></strong><br /> |
|
|
230 | </dt> |
|
|
231 | </dl> |
|
|
232 | <p>The normal selection mechanism isn't disabled, so quick successive clicks |
|
|
233 | might interfere with selection creation in harmless ways.</p> |
|
|
234 | <dt><strong><a name="item_selection_2dautotransform">selection-autotransform</a></strong><br /> |
|
|
235 | </dt> |
|
|
236 | <dd> |
|
|
237 | This selection allows you to do automatic transforms on a selection |
|
|
238 | whenever a selection is made. |
|
|
239 | </dd> |
|
|
240 | <dd> |
|
|
241 | <p>It works by specifying perl snippets (most useful is a single <code>s///</code> |
|
|
242 | operator) that modify <code>$_</code> as resources:</p> |
|
|
243 | </dd> |
|
|
244 | <dd> |
|
|
245 | <pre> |
|
|
246 | URxvt.selection-autotransform.0: transform |
|
|
247 | URxvt.selection-autotransform.1: transform |
|
|
248 | ...</pre> |
|
|
249 | </dd> |
|
|
250 | <dd> |
|
|
251 | <p>For example, the following will transform selections of the form |
|
|
252 | <code>filename:number</code>, often seen in compiler messages, into <code>vi +$filename |
|
|
253 | $word</code>:</p> |
|
|
254 | </dd> |
|
|
255 | <dd> |
|
|
256 | <pre> |
|
|
257 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/</pre> |
|
|
258 | </dd> |
|
|
259 | <dd> |
|
|
260 | <p>And this example matches the same,but replaces it with vi-commands you can |
|
|
261 | paste directly into your (vi :) editor:</p> |
|
|
262 | </dd> |
|
|
263 | <dd> |
|
|
264 | <pre> |
|
|
265 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/</pre> |
|
|
266 | </dd> |
|
|
267 | <dd> |
|
|
268 | <p>Of course, this can be modified to suit your needs and your editor :)</p> |
|
|
269 | </dd> |
|
|
270 | <dd> |
|
|
271 | <p>To expand the example above to typical perl error messages (``XXX at |
|
|
272 | FILENAME line YYY.''), you need a slightly more elaborate solution:</p> |
|
|
273 | </dd> |
|
|
274 | <dd> |
|
|
275 | <pre> |
|
|
276 | URxvt.selection.pattern-0: ( at .*? line \\d+[,.]) |
|
|
277 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/</pre> |
|
|
278 | </dd> |
|
|
279 | <dd> |
|
|
280 | <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 |
|
|
282 | the message into vi commands to load the file.</p> |
|
|
283 | </dd> |
|
|
284 | <p></p> |
|
|
285 | <dt><strong><a name="item_tabbed">tabbed</a></strong><br /> |
|
|
286 | </dt> |
|
|
287 | <dd> |
|
|
288 | 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 |
|
|
290 | displays a ``[NEW]'' button, which, when clicked, will add a new tab, followed by one |
|
|
291 | button per tab. |
|
|
292 | </dd> |
|
|
293 | <dd> |
|
|
294 | <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, |
|
|
296 | while <strong>Shift-Down</strong> creates a new tab.</p> |
|
|
297 | </dd> |
|
|
298 | <dd> |
|
|
299 | <p>The tabbar itself can be configured similarly to a normal terminal, but |
|
|
300 | with a resource class of <code>URxvt.tabbed</code>. In addition, it supports the |
|
|
301 | following four resources (shown with defaults):</p> |
|
|
302 | </dd> |
|
|
303 | <dd> |
|
|
304 | <pre> |
|
|
305 | URxvt.tabbed.tabbar-fg: <colour-index, default 3> |
|
|
306 | URxvt.tabbed.tabbar-bg: <colour-index, default 0> |
|
|
307 | URxvt.tabbed.tab-fg: <colour-index, default 0> |
|
|
308 | URxvt.tabbed.tab-bg: <colour-index, default 1></pre> |
|
|
309 | </dd> |
|
|
310 | <dd> |
|
|
311 | <p>See <em>COLOR AND GRAPHICS</em> in the <code>rxvt(1)</code> manpage for valid |
|
|
312 | indices.</p> |
| 141 | </dd> |
313 | </dd> |
| 142 | <p></p> |
314 | <p></p> |
| 143 | <dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> |
315 | <dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> |
| 144 | </dt> |
316 | </dt> |
| 145 | <dd> |
317 | <dd> |
| 146 | Uses per-line display filtering (<code>on_line_update</code>) to underline urls. |
318 | 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 |
|
|
320 | resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with |
|
|
321 | the URL as first argument. |
|
|
322 | </dd> |
|
|
323 | <p></p> |
|
|
324 | <dt><strong><a name="item_xim_2donthespot">xim-onthespot</a></strong><br /> |
|
|
325 | </dt> |
|
|
326 | <dd> |
|
|
327 | This (experimental) perl extension implements OnTheSpot editing. It does |
|
|
328 | 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 |
|
|
330 | kinput2. |
|
|
331 | </dd> |
|
|
332 | <dd> |
|
|
333 | <p>You enable it by specifying this extension and a preedit style of |
|
|
334 | <code>OnTheSpot</code>, i.e.:</p> |
|
|
335 | </dd> |
|
|
336 | <dd> |
|
|
337 | <pre> |
|
|
338 | rxvt -pt OnTheSpot -pe xim-onthespot</pre> |
|
|
339 | </dd> |
|
|
340 | <p></p> |
|
|
341 | <dt><strong><a name="item_automove_2dbackground">automove-background</a></strong><br /> |
|
|
342 | </dt> |
|
|
343 | <dd> |
|
|
344 | This is basically a one-line extension that dynamically changes the background pixmap offset |
|
|
345 | to the window position, in effect creating the same effect as pseudo transparency with |
|
|
346 | a custom pixmap. No scaling is supported in this mode. Exmaple: |
|
|
347 | </dd> |
|
|
348 | <dd> |
|
|
349 | <pre> |
|
|
350 | rxvt -pixmap background.xpm -pe automove-background</pre> |
| 147 | </dd> |
351 | </dd> |
| 148 | <p></p> |
352 | <p></p> |
| 149 | <dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br /> |
353 | <dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br /> |
| 150 | </dt> |
354 | </dt> |
| 151 | <dd> |
355 | <dd> |
| 152 | A not very useful example of filtering all text output to the terminal, |
356 | A not very useful example of filtering all text output to the terminal, |
| 153 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
357 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
| 154 | similar-looking ascii character. |
358 | similar-looking ascii character. |
|
|
359 | </dd> |
|
|
360 | <p></p> |
|
|
361 | <dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> |
|
|
362 | </dt> |
|
|
363 | <dd> |
|
|
364 | Displays a digital clock using the built-in overlay. |
|
|
365 | </dd> |
|
|
366 | <p></p> |
|
|
367 | <dt><strong><a name="item_remote_2dclipboard">remote-clipboard</a></strong><br /> |
|
|
368 | </dt> |
|
|
369 | <dd> |
|
|
370 | 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 |
|
|
372 | selection somewhere and fetch it again. |
|
|
373 | </dd> |
|
|
374 | <dd> |
|
|
375 | <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 |
|
|
377 | reads it.</p> |
|
|
378 | </dd> |
|
|
379 | <dd> |
|
|
380 | <p>The commands can be set using the <code>URxvt.remote-selection.store</code> and |
|
|
381 | <code>URxvt.remote-selection.fetch</code> resources. The first should read the |
|
|
382 | selection to store from STDIN (always in UTF-8), the second should provide |
|
|
383 | the selection data on STDOUT (also in UTF-8).</p> |
|
|
384 | </dd> |
|
|
385 | <dd> |
|
|
386 | <p>The defaults (which are likely useless to you) use rsh and cat:</p> |
|
|
387 | </dd> |
|
|
388 | <dd> |
|
|
389 | <pre> |
|
|
390 | URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' |
|
|
391 | URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'</pre> |
|
|
392 | </dd> |
|
|
393 | <p></p> |
|
|
394 | <dt><strong><a name="item_selection_2dpastebin">selection-pastebin</a></strong><br /> |
|
|
395 | </dt> |
|
|
396 | <dd> |
|
|
397 | 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 |
|
|
399 | not currently secure for use in a multiuser environment as it writes to |
|
|
400 | <em>/tmp</em> directly.). |
|
|
401 | </dd> |
|
|
402 | <dd> |
|
|
403 | <p>It listens to the <code>selection-pastebin:remote-pastebin</code> keyboard command, |
|
|
404 | i.e.</p> |
|
|
405 | </dd> |
|
|
406 | <dd> |
|
|
407 | <pre> |
|
|
408 | URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin</pre> |
|
|
409 | </dd> |
|
|
410 | <dd> |
|
|
411 | <p>Pressing this combination runs a command with <code>%</code> replaced by the name of |
|
|
412 | the textfile. This command can be set via a resource:</p> |
|
|
413 | </dd> |
|
|
414 | <dd> |
|
|
415 | <pre> |
|
|
416 | URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.</pre> |
|
|
417 | </dd> |
|
|
418 | <dd> |
|
|
419 | <p>And the default is likely not useful to anybody but the few people around |
|
|
420 | here :)</p> |
|
|
421 | </dd> |
|
|
422 | <dd> |
|
|
423 | <p>The name of the textfile is the hex encoded md5 sum of the selection, so |
|
|
424 | the same content should lead to the same filename.</p> |
|
|
425 | </dd> |
|
|
426 | <dd> |
|
|
427 | <p>After a successful upload the selection will be replaced by the text given |
|
|
428 | in the <code>selection-pastebin-url</code> resource (again, the % is the placeholder |
|
|
429 | for the filename):</p> |
|
|
430 | </dd> |
|
|
431 | <dd> |
|
|
432 | <pre> |
|
|
433 | URxvt.selection-pastebin.url: <a href="http://www.ta-sa.org/files/txt/%">http://www.ta-sa.org/files/txt/%</a></pre> |
| 155 | </dd> |
434 | </dd> |
| 156 | <p></p> |
435 | <p></p> |
| 157 | <dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> |
436 | <dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> |
| 158 | </dt> |
437 | </dt> |
| 159 | <dd> |
438 | <dd> |
| … | |
… | |
| 242 | <h2><a name="hooks">Hooks</a></h2> |
521 | <h2><a name="hooks">Hooks</a></h2> |
| 243 | <p>The following subroutines can be declared in extension files, and will be |
522 | <p>The following subroutines can be declared in extension files, and will be |
| 244 | called whenever the relevant event happens.</p> |
523 | called whenever the relevant event happens.</p> |
| 245 | <p>The first argument passed to them is an extension oject as described in |
524 | <p>The first argument passed to them is an extension oject as described in |
| 246 | the in the <code>Extension Objects</code> section.</p> |
525 | the in the <code>Extension Objects</code> section.</p> |
| 247 | <p><strong>All</strong> of these hooks must return a boolean value. If it is true, then the |
526 | <p><strong>All</strong> of these hooks must return a boolean value. If any of the called |
| 248 | event counts as being <em>consumed</em>, and the invocation of other hooks is |
527 | hooks returns true, then the event counts as being <em>consumed</em>, and the |
| 249 | skipped, and the relevant action might not be carried out by the C++ code.</p> |
528 | relevant action might not be carried out by the C++ code.</p> |
| 250 | <p><em>When in doubt, return a false value (preferably <code>()</code>). </em>></p> |
529 | <p><em>When in doubt, return a false value (preferably <code>()</code>). </em>></p> |
| 251 | <dl> |
530 | <dl> |
| 252 | <dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> |
531 | <dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> |
| 253 | </dt> |
532 | </dt> |
| 254 | <dd> |
533 | <dd> |
| 255 | Called after a new terminal object has been initialized, but before |
534 | Called after a new terminal object has been initialized, but before |
| 256 | windows are created or the command gets run. Most methods are unsafe to |
535 | windows are created or the command gets run. Most methods are unsafe to |
| 257 | call or deliver senseless data, as terminal size and other characteristics |
536 | call or deliver senseless data, as terminal size and other characteristics |
| 258 | have not yet been determined. You can safely query and change resources, |
537 | have not yet been determined. You can safely query and change resources |
| 259 | though. |
538 | and options, though. For many purposes the <code>on_start</code> hook is a better |
|
|
539 | place. |
|
|
540 | </dd> |
|
|
541 | <p></p> |
|
|
542 | <dt><strong><a name="item_on_start__24term">on_start $term</a></strong><br /> |
|
|
543 | </dt> |
|
|
544 | <dd> |
|
|
545 | 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. |
|
|
547 | </dd> |
|
|
548 | <p></p> |
|
|
549 | <dt><strong><a name="item_on_destroy__24term">on_destroy $term</a></strong><br /> |
|
|
550 | </dt> |
|
|
551 | <dd> |
|
|
552 | Called whenever something tries to destroy terminal, when the terminal is |
|
|
553 | still fully functional (not for long, though). |
| 260 | </dd> |
554 | </dd> |
| 261 | <p></p> |
555 | <p></p> |
| 262 | <dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> |
556 | <dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> |
| 263 | </dt> |
557 | </dt> |
| 264 | <dd> |
558 | <dd> |
| 265 | Called after the screen is ``reset'' for any reason, such as resizing or |
559 | Called after the screen is ``reset'' for any reason, such as resizing or |
| 266 | control sequences. Here is where you can react on changes to size-related |
560 | control sequences. Here is where you can react on changes to size-related |
| 267 | variables. |
561 | variables. |
| 268 | </dd> |
562 | </dd> |
| 269 | <p></p> |
563 | <p></p> |
| 270 | <dt><strong><a name="item_on_start__24term">on_start $term</a></strong><br /> |
564 | <dt><strong><a name="item_on_child_start__24term_2c__24pid">on_child_start $term, $pid</a></strong><br /> |
| 271 | </dt> |
565 | </dt> |
|
|
566 | <dd> |
|
|
567 | Called just after the child process has been <code>fork</code>ed. |
| 272 | <dd> |
568 | </dd> |
| 273 | Called at the very end of initialisation of a new terminal, just before |
569 | <p></p> |
| 274 | returning to the mainloop. |
570 | <dt><strong><a name="item_on_child_exit__24term_2c__24status">on_child_exit $term, $status</a></strong><br /> |
|
|
571 | </dt> |
|
|
572 | <dd> |
|
|
573 | Called just after the child process has exited. <code>$status</code> is the status |
|
|
574 | from <code>waitpid</code>. |
| 275 | </dd> |
575 | </dd> |
| 276 | <p></p> |
576 | <p></p> |
| 277 | <dt><strong><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a></strong><br /> |
577 | <dt><strong><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a></strong><br /> |
| 278 | </dt> |
578 | </dt> |
| 279 | <dd> |
579 | <dd> |
| … | |
… | |
| 301 | </dt> |
601 | </dt> |
| 302 | <dd> |
602 | <dd> |
| 303 | Called whenever the user tries to extend the selection (e.g. with a double |
603 | Called whenever the user tries to extend the selection (e.g. with a double |
| 304 | click) and is either supposed to return false (normal operation), or |
604 | click) and is either supposed to return false (normal operation), or |
| 305 | should extend the selection itelf and return true to suppress the built-in |
605 | should extend the selection itelf and return true to suppress the built-in |
| 306 | processing. |
606 | 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 |
|
|
608 | supposed to enlarge the selection more and more, if possible. |
| 307 | </dd> |
609 | </dd> |
| 308 | <dd> |
610 | <dd> |
| 309 | <p>See the <em>selection</em> example extension.</p> |
611 | <p>See the <em>selection</em> example extension.</p> |
| 310 | </dd> |
612 | </dd> |
| 311 | <p></p> |
613 | <p></p> |
| … | |
… | |
| 394 | </dt> |
696 | </dt> |
| 395 | <dd> |
697 | <dd> |
| 396 | Called just after the screen gets redrawn. See <code>on_refresh_begin</code>. |
698 | Called just after the screen gets redrawn. See <code>on_refresh_begin</code>. |
| 397 | </dd> |
699 | </dd> |
| 398 | <p></p> |
700 | <p></p> |
| 399 | <dt><strong><a name="item_on_keyboard_command__24term_2c__24string">on_keyboard_command $term, $string</a></strong><br /> |
701 | <dt><strong><a name="item_on_user_command__24term_2c__24string">on_user_command $term, $string</a></strong><br /> |
| 400 | </dt> |
702 | </dt> |
| 401 | <dd> |
703 | <dd> |
| 402 | Called whenever the user presses a key combination that has a |
704 | Called whenever the a user-configured event is being activated (e.g. via |
| 403 | <code>perl:string</code> action bound to it (see description of the <strong>keysym</strong> |
705 | a <code>perl:string</code> action bound to a key, see description of the <strong>keysym</strong> |
| 404 | resource in the <code>rxvt(1)</code> manpage). |
706 | resource in the <code>rxvt(1)</code> manpage). |
|
|
707 | </dd> |
|
|
708 | <dd> |
|
|
709 | <p>The event is simply the action string. This interface is assumed to change |
|
|
710 | slightly in the future.</p> |
|
|
711 | </dd> |
|
|
712 | <p></p> |
|
|
713 | <dt><strong><a name="item_on_x_event__24term_2c__24event">on_x_event $term, $event</a></strong><br /> |
|
|
714 | </dt> |
|
|
715 | <dd> |
|
|
716 | 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 |
|
|
718 | members are not passed. |
| 405 | </dd> |
719 | </dd> |
| 406 | <p></p> |
720 | <p></p> |
| 407 | <dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> |
721 | <dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> |
| 408 | </dt> |
722 | </dt> |
| 409 | <dd> |
723 | <dd> |
| … | |
… | |
| 416 | <dd> |
730 | <dd> |
| 417 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
731 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
| 418 | focus out processing. |
732 | focus out processing. |
| 419 | </dd> |
733 | </dd> |
| 420 | <p></p> |
734 | <p></p> |
|
|
735 | <dt><strong><a name="item_on_configure_notify__24term_2c__24event">on_configure_notify $term, $event</a></strong><br /> |
|
|
736 | </dt> |
|
|
737 | <dt><strong><a name="item_on_property_notify__24term_2c__24event">on_property_notify $term, $event</a></strong><br /> |
|
|
738 | </dt> |
| 421 | <dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a></strong><br /> |
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 /> |
| 422 | </dt> |
740 | </dt> |
| 423 | <dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br /> |
741 | <dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br /> |
| 424 | </dt> |
742 | </dt> |
| 425 | <dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br /> |
743 | <dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br /> |
| … | |
… | |
| 436 | Called whenever the corresponding X event is received for the terminal If |
754 | Called whenever the corresponding X event is received for the terminal If |
| 437 | the hook returns true, then the even will be ignored by rxvt-unicode. |
755 | the hook returns true, then the even will be ignored by rxvt-unicode. |
| 438 | </dd> |
756 | </dd> |
| 439 | <dd> |
757 | <dd> |
| 440 | <p>The event is a hash with most values as named by Xlib (see the XEvent |
758 | <p>The event is a hash with most values as named by Xlib (see the XEvent |
| 441 | manpage), with the additional members <code>row</code> and <code>col</code>, which are the row |
759 | manpage), with the additional members <code>row</code> and <code>col</code>, which are the |
| 442 | and column under the mouse cursor.</p> |
760 | (real, not screen-based) row and column under the mouse cursor.</p> |
| 443 | </dd> |
761 | </dd> |
| 444 | <dd> |
762 | <dd> |
| 445 | <p><code>on_key_press</code> additionally receives the string rxvt-unicode would |
763 | <p><code>on_key_press</code> additionally receives the string rxvt-unicode would |
| 446 | output, if any, in locale-specific encoding.</p> |
764 | output, if any, in locale-specific encoding.</p> |
| 447 | </dd> |
765 | </dd> |
| 448 | <dd> |
766 | <dd> |
| 449 | <p>subwindow.</p> |
767 | <p>subwindow.</p> |
|
|
768 | </dd> |
|
|
769 | <p></p> |
|
|
770 | <dt><strong><a name="item_on_client_message__24term_2c__24event">on_client_message $term, $event</a></strong><br /> |
|
|
771 | </dt> |
|
|
772 | <dt><strong><a name="item_on_wm_protocols__24term_2c__24event">on_wm_protocols $term, $event</a></strong><br /> |
|
|
773 | </dt> |
|
|
774 | <dt><strong><a name="item_on_wm_delete_window__24term_2c__24event">on_wm_delete_window $term, $event</a></strong><br /> |
|
|
775 | </dt> |
|
|
776 | <dd> |
|
|
777 | Called when various types of ClientMessage events are received (all with |
|
|
778 | format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
| 450 | </dd> |
779 | </dd> |
| 451 | <p></p></dl> |
780 | <p></p></dl> |
| 452 | <p> |
781 | <p> |
| 453 | </p> |
782 | </p> |
| 454 | <h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> |
783 | <h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> |
| … | |
… | |
| 476 | </dt> |
805 | </dt> |
| 477 | <dd> |
806 | <dd> |
| 478 | The current terminal. This variable stores the current <code>urxvt::term</code> |
807 | The current terminal. This variable stores the current <code>urxvt::term</code> |
| 479 | object, whenever a callback/hook is executing. |
808 | object, whenever a callback/hook is executing. |
| 480 | </dd> |
809 | </dd> |
|
|
810 | <p></p> |
|
|
811 | <dt><strong><a name="item__40urxvt_3a_3aterm_init">@urxvt::TERM_INIT</a></strong><br /> |
|
|
812 | </dt> |
|
|
813 | <dd> |
|
|
814 | All coderefs 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 |
|
|
816 | gets cleared before the codereferences that were in it are being executed, |
|
|
817 | so coderefs can push themselves onto it again if they so desire. |
|
|
818 | </dd> |
|
|
819 | <dd> |
|
|
820 | <p>This complements to the perl-eval commandline option, but gets executed |
|
|
821 | first.</p> |
|
|
822 | </dd> |
|
|
823 | <p></p> |
|
|
824 | <dt><strong><a name="item__40urxvt_3a_3aterm_ext">@urxvt::TERM_EXT</a></strong><br /> |
|
|
825 | </dt> |
|
|
826 | <dd> |
|
|
827 | 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> |
|
|
829 | but before other extensions. Gets cleared just like <code>@TERM_INIT</code>. |
|
|
830 | </dd> |
| 481 | <p></p></dl> |
831 | <p></p></dl> |
| 482 | <p> |
832 | <p> |
| 483 | </p> |
833 | </p> |
| 484 | <h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> |
834 | <h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> |
| 485 | <dl> |
835 | <dl> |
| … | |
… | |
| 504 | </dd> |
854 | </dd> |
| 505 | <dd> |
855 | <dd> |
| 506 | <p>Messages have a size limit of 1023 bytes currently.</p> |
856 | <p>Messages have a size limit of 1023 bytes currently.</p> |
| 507 | </dd> |
857 | </dd> |
| 508 | <p></p> |
858 | <p></p> |
| 509 | <dt><strong><a name="item__24is_safe__3d_urxvt_3a_3asafe">$is_safe = urxvt::safe</a></strong><br /> |
859 | <dt><strong><a name="item__40terms__3d_urxvt_3a_3atermlist">@terms = urxvt::termlist</a></strong><br /> |
| 510 | </dt> |
860 | </dt> |
| 511 | <dd> |
861 | <dd> |
| 512 | Returns true when it is safe to do potentially unsafe things, such as |
862 | Returns all urxvt::term objects that exist in this process, regardless of |
| 513 | evaluating perl code specified by the user. This is true when urxvt was |
863 | wether they are started, being destroyed etc., so be careful. Only term |
| 514 | started setuid or setgid. |
864 | objects that have perl extensions attached will be returned (because there |
|
|
865 | is no urxvt::term objet associated with others). |
| 515 | </dd> |
866 | </dd> |
| 516 | <p></p> |
867 | <p></p> |
| 517 | <dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> |
868 | <dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> |
| 518 | </dt> |
869 | </dt> |
| 519 | <dd> |
870 | <dd> |
| … | |
… | |
| 523 | <dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br /> |
874 | <dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br /> |
| 524 | </dt> |
875 | </dt> |
| 525 | <dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
876 | <dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
| 526 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
877 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
| 527 | Button4Mask, Button5Mask, AnyModifier</a></strong><br /> |
878 | Button4Mask, Button5Mask, AnyModifier</a></strong><br /> |
|
|
879 | </dt> |
|
|
880 | <dt><strong><a name="item_urxvt_3a_3anoeventmask_2c_keypressmask_2c_keyrelea">urxvt::NoEventMask, KeyPressMask, KeyReleaseMask, |
|
|
881 | ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, |
|
|
882 | PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask, |
|
|
883 | Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask, |
|
|
884 | KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask, |
|
|
885 | ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask, |
|
|
886 | FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask</a></strong><br /> |
|
|
887 | </dt> |
|
|
888 | <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, |
|
|
890 | GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify, |
|
|
891 | UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify, |
|
|
892 | ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify, |
|
|
893 | CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, |
|
|
894 | SelectionNotify, ColormapNotify, ClientMessage, MappingNotify</a></strong><br /> |
| 528 | </dt> |
895 | </dt> |
| 529 | <dd> |
896 | <dd> |
| 530 | Various constants for use in X calls and event processing. |
897 | Various constants for use in X calls and event processing. |
| 531 | </dd> |
898 | </dd> |
| 532 | <p></p></dl> |
899 | <p></p></dl> |
| … | |
… | |
| 571 | <p></p> |
938 | <p></p> |
| 572 | <dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_fgcolor__24rend_2c__24n">$rend = urxvt::SET_FGCOLOR $rend, $new_colour</a></strong><br /> |
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 /> |
| 573 | </dt> |
940 | </dt> |
| 574 | <dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_bgcolor__24rend_2c__24n">$rend = urxvt::SET_BGCOLOR $rend, $new_colour</a></strong><br /> |
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 /> |
| 575 | </dt> |
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> |
| 576 | <dd> |
945 | <dd> |
| 577 | Replace the foreground/background colour in the rendition mask with the |
946 | Replace the foreground/background colour in the rendition mask with the |
| 578 | specified one. |
947 | specified one. |
| 579 | </dd> |
948 | </dd> |
| 580 | <p></p> |
949 | <p></p> |
| … | |
… | |
| 614 | </dd> |
983 | </dd> |
| 615 | <dd> |
984 | <dd> |
| 616 | <p>Croaks (and probably outputs an error message) if the new instance |
985 | <p>Croaks (and probably outputs an error message) if the new instance |
| 617 | couldn't be created. Returns <code>undef</code> if the new instance didn't |
986 | couldn't be created. Returns <code>undef</code> if the new instance didn't |
| 618 | initialise perl, and the terminal object otherwise. The <code>init</code> and |
987 | initialise perl, and the terminal object otherwise. The <code>init</code> and |
| 619 | <a href="#item_start"><code>start</code></a> hooks will be called during this call.</p> |
988 | <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> |
| 620 | </dd> |
990 | </dd> |
| 621 | <p></p> |
991 | <p></p> |
| 622 | <dt><strong><a name="item_destroy">$term->destroy</a></strong><br /> |
992 | <dt><strong><a name="item_destroy">$term->destroy</a></strong><br /> |
| 623 | </dt> |
993 | </dt> |
| 624 | <dd> |
994 | <dd> |
| 625 | Destroy the terminal object (close the window, free resources |
995 | Destroy the terminal object (close the window, free resources |
| 626 | etc.). Please note that rxvt will not exit as long as any event |
996 | etc.). Please note that rxvt will not exit as long as any event |
| 627 | watchers (timers, io watchers) are still active. |
997 | watchers (timers, io watchers) are still active. |
| 628 | </dd> |
998 | </dd> |
| 629 | <p></p> |
999 | <p></p> |
|
|
1000 | <dt><strong><a name="item_exec_async">$term->exec_async ($cmd[, @args])</a></strong><br /> |
|
|
1001 | </dt> |
|
|
1002 | <dd> |
|
|
1003 | 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 |
|
|
1005 | 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>. |
|
|
1007 | </dd> |
|
|
1008 | <dd> |
|
|
1009 | <p>Returns the pid of the subprocess or <code>undef</code> on error.</p> |
|
|
1010 | </dd> |
|
|
1011 | <p></p> |
| 630 | <dt><strong><a name="item_option">$isset = $term->option ($optval[, $set])</a></strong><br /> |
1012 | <dt><strong><a name="item_option">$isset = $term->option ($optval[, $set])</a></strong><br /> |
| 631 | </dt> |
1013 | </dt> |
| 632 | <dd> |
1014 | <dd> |
| 633 | Returns true if the option specified by <code>$optval</code> is enabled, and |
1015 | Returns true if the option specified by <code>$optval</code> is enabled, and |
| 634 | optionally change it. All option values are stored by name in the hash |
1016 | optionally change it. All option values are stored by name in the hash |
| … | |
… | |
| 640 | </dd> |
1022 | </dd> |
| 641 | <dd> |
1023 | <dd> |
| 642 | <pre> |
1024 | <pre> |
| 643 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1025 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
| 644 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1026 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
| 645 | pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating |
1027 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
| 646 | scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer |
1028 | scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput |
| 647 | secondaryScreen secondaryScroll skipBuiltinGlyphs transparent |
1029 | scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs |
| 648 | tripleclickwords utmpInhibit visualBell</pre> |
1030 | transparent tripleclickwords utmpInhibit visualBell</pre> |
| 649 | </dd> |
1031 | </dd> |
| 650 | <p></p> |
1032 | <p></p> |
| 651 | <dt><strong><a name="item_resource">$value = $term->resource ($name[, $newval])</a></strong><br /> |
1033 | <dt><strong><a name="item_resource">$value = $term->resource ($name[, $newval])</a></strong><br /> |
| 652 | </dt> |
1034 | </dt> |
| 653 | <dd> |
1035 | <dd> |
| … | |
… | |
| 678 | <pre> |
1060 | <pre> |
| 679 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1061 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
| 680 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
1062 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
| 681 | display_name embed ext_bwidth fade font geometry hold iconName |
1063 | display_name embed ext_bwidth fade font geometry hold iconName |
| 682 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
1064 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
| 683 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
1065 | italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier |
| 684 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 |
1066 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
| 685 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
1067 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
| 686 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
1068 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
| 687 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
1069 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
| 688 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
1070 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
| 689 | shade term_name title transparent transparent_all tripleclickwords |
1071 | secondaryScreen secondaryScroll selectstyle shade term_name title |
|
|
1072 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
| 690 | utmpInhibit visualBell</pre> |
1073 | visualBell</pre> |
|
|
1074 | </dd> |
|
|
1075 | <p></p> |
|
|
1076 | <dt><strong><a name="item_x_resource">$value = $term->x_resource ($pattern)</a></strong><br /> |
|
|
1077 | </dt> |
|
|
1078 | <dd> |
|
|
1079 | 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 |
|
|
1081 | same value as used by this instance of rxvt-unicode. Returns <code>undef</code> if no |
|
|
1082 | resource with that pattern exists. |
|
|
1083 | </dd> |
|
|
1084 | <dd> |
|
|
1085 | <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 |
|
|
1087 | the wrong resources.</p> |
| 691 | </dd> |
1088 | </dd> |
| 692 | <p></p> |
1089 | <p></p> |
| 693 | <dt><strong><a name="item_parse_keysym">$success = $term->parse_keysym ($keysym_spec, $command_string)</a></strong><br /> |
1090 | <dt><strong><a name="item_parse_keysym">$success = $term->parse_keysym ($keysym_spec, $command_string)</a></strong><br /> |
| 694 | </dt> |
1091 | </dt> |
| 695 | <dd> |
1092 | <dd> |
| … | |
… | |
| 720 | <dd> |
1117 | <dd> |
| 721 | Return the current values of the selection mark, begin or end positions, |
1118 | Return the current values of the selection mark, begin or end positions, |
| 722 | and optionally set them to new values. |
1119 | and optionally set them to new values. |
| 723 | </dd> |
1120 | </dd> |
| 724 | <p></p> |
1121 | <p></p> |
|
|
1122 | <dt><strong><a name="item_selection_make">$term->selection_make ($eventtime[, $rectangular])</a></strong><br /> |
|
|
1123 | </dt> |
|
|
1124 | <dd> |
|
|
1125 | 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 |
|
|
1127 | rectangular selection will be made. This is the prefered function to make |
|
|
1128 | a selection. |
|
|
1129 | </dd> |
|
|
1130 | <p></p> |
| 725 | <dt><strong><a name="item_selection_grab">$success = $term->selection_grab ($eventtime)</a></strong><br /> |
1131 | <dt><strong><a name="item_selection_grab">$success = $term->selection_grab ($eventtime)</a></strong><br /> |
| 726 | </dt> |
1132 | </dt> |
| 727 | <dd> |
1133 | <dd> |
| 728 | Try to request the primary selection from the server (for example, as set |
1134 | Try to request the primary selection text from the server (for example, as |
| 729 | by the next method). |
1135 | 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. |
| 730 | </dd> |
1137 | </dd> |
| 731 | <p></p> |
1138 | <p></p> |
| 732 | <dt><strong>$oldtext = $term->selection ([$newtext])</strong><br /> |
1139 | <dt><strong>$oldtext = $term->selection ([$newtext])</strong><br /> |
| 733 | </dt> |
1140 | </dt> |
| 734 | <dd> |
1141 | <dd> |
| … | |
… | |
| 813 | <p></p> |
1220 | <p></p> |
| 814 | <dt><strong><a name="item_scr_xor_span">$term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])</a></strong><br /> |
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 /> |
| 815 | </dt> |
1222 | </dt> |
| 816 | <dd> |
1223 | <dd> |
| 817 | XORs the rendition values in the given span with the provided value |
1224 | XORs the rendition values in the given span with the provided value |
| 818 | (default: <code>RS_RVid</code>). Useful in refresh hooks to provide effects similar |
1225 | (default: <code>RS_RVid</code>), which <em>MUST NOT</em> contain font styles. Useful in |
| 819 | to the selection. |
1226 | refresh hooks to provide effects similar to the selection. |
| 820 | </dd> |
1227 | </dd> |
| 821 | <p></p> |
1228 | <p></p> |
| 822 | <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 /> |
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 /> |
| 823 | </dt> |
1230 | </dt> |
| 824 | <dd> |
1231 | <dd> |
| 825 | Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing |
1232 | Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing |
| 826 | whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults |
1233 | whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults |
| 827 | to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines |
1234 | to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines |
| 828 | it instead. |
1235 | it instead. Both styles <em>MUST NOT</em> contain font styles. |
| 829 | </dd> |
1236 | </dd> |
| 830 | <p></p> |
1237 | <p></p> |
| 831 | <dt><strong><a name="item_scr_bell">$term->scr_bell</a></strong><br /> |
1238 | <dt><strong><a name="item_scr_bell">$term->scr_bell</a></strong><br /> |
| 832 | </dt> |
1239 | </dt> |
| 833 | <dd> |
1240 | <dd> |
| … | |
… | |
| 846 | <p>Normally its not a good idea to use this function, as programs might be |
1253 | <p>Normally its not a good idea to use this function, as programs might be |
| 847 | confused by changes in cursor position or scrolling. Its useful inside a |
1254 | confused by changes in cursor position or scrolling. Its useful inside a |
| 848 | <code>on_add_lines</code> hook, though.</p> |
1255 | <code>on_add_lines</code> hook, though.</p> |
| 849 | </dd> |
1256 | </dd> |
| 850 | <p></p> |
1257 | <p></p> |
|
|
1258 | <dt><strong><a name="item_scr_change_screen">$term->scr_change_screen ($screen)</a></strong><br /> |
|
|
1259 | </dt> |
|
|
1260 | <dd> |
|
|
1261 | Switch to given screen - 0 primary, 1 secondary. |
|
|
1262 | </dd> |
|
|
1263 | <p></p> |
| 851 | <dt><strong><a name="item_cmd_parse">$term->cmd_parse ($octets)</a></strong><br /> |
1264 | <dt><strong><a name="item_cmd_parse">$term->cmd_parse ($octets)</a></strong><br /> |
| 852 | </dt> |
1265 | </dt> |
| 853 | <dd> |
1266 | <dd> |
| 854 | Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the |
1267 | Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the |
| 855 | locale-specific encoding of the terminal and can contain command sequences |
1268 | locale-specific encoding of the terminal and can contain command sequences |
| … | |
… | |
| 871 | be used to suppress input and output handling to the pty/tty. See the |
1284 | be used to suppress input and output handling to the pty/tty. See the |
| 872 | description of <a href="#item_events"><code>urxvt::timer->events</code></a>. Make sure to always restore |
1285 | description of <a href="#item_events"><code>urxvt::timer->events</code></a>. Make sure to always restore |
| 873 | the previous value. |
1286 | the previous value. |
| 874 | </dd> |
1287 | </dd> |
| 875 | <p></p> |
1288 | <p></p> |
|
|
1289 | <dt><strong><a name="item_pty_fd">$fd = $term->pty_fd</a></strong><br /> |
|
|
1290 | </dt> |
|
|
1291 | <dd> |
|
|
1292 | Returns the master file descriptor for the pty in use, or <code>-1</code> if no pty |
|
|
1293 | is used. |
|
|
1294 | </dd> |
|
|
1295 | <p></p> |
| 876 | <dt><strong><a name="item_parent">$windowid = $term->parent</a></strong><br /> |
1296 | <dt><strong><a name="item_parent">$windowid = $term->parent</a></strong><br /> |
| 877 | </dt> |
1297 | </dt> |
| 878 | <dd> |
1298 | <dd> |
| 879 | Return the window id of the toplevel window. |
1299 | Return the window id of the toplevel window. |
| 880 | </dd> |
1300 | </dd> |
| … | |
… | |
| 883 | </dt> |
1303 | </dt> |
| 884 | <dd> |
1304 | <dd> |
| 885 | Return the window id of the terminal window. |
1305 | Return the window id of the terminal window. |
| 886 | </dd> |
1306 | </dd> |
| 887 | <p></p> |
1307 | <p></p> |
|
|
1308 | <dt><strong><a name="item_vt_emask_add">$term->vt_emask_add ($x_event_mask)</a></strong><br /> |
|
|
1309 | </dt> |
|
|
1310 | <dd> |
|
|
1311 | Adds the specified events to the vt event mask. Useful e.g. when you want |
|
|
1312 | to receive pointer events all the times: |
|
|
1313 | </dd> |
|
|
1314 | <dd> |
|
|
1315 | <pre> |
|
|
1316 | $term->vt_emask_add (urxvt::PointerMotionMask);</pre> |
|
|
1317 | </dd> |
|
|
1318 | <p></p> |
|
|
1319 | <dt><strong><a name="item_focus_in">$term->focus_in</a></strong><br /> |
|
|
1320 | </dt> |
|
|
1321 | <dt><strong><a name="item_focus_out">$term->focus_out</a></strong><br /> |
|
|
1322 | </dt> |
|
|
1323 | <dt><strong><a name="item_key_press">$term->key_press ($state, $keycode[, $time])</a></strong><br /> |
|
|
1324 | </dt> |
|
|
1325 | <dt><strong><a name="item_key_release">$term->key_release ($state, $keycode[, $time])</a></strong><br /> |
|
|
1326 | </dt> |
|
|
1327 | <dd> |
|
|
1328 | Deliver various fake events to to terminal. |
|
|
1329 | </dd> |
|
|
1330 | <p></p> |
| 888 | <dt><strong><a name="item_width">$window_width = $term->width</a></strong><br /> |
1331 | <dt><strong><a name="item_width">$window_width = $term->width</a></strong><br /> |
| 889 | </dt> |
1332 | </dt> |
| 890 | <dt><strong><a name="item_height">$window_height = $term->height</a></strong><br /> |
1333 | <dt><strong><a name="item_height">$window_height = $term->height</a></strong><br /> |
| 891 | </dt> |
1334 | </dt> |
| 892 | <dt><strong><a name="item_fwidth">$font_width = $term->fwidth</a></strong><br /> |
1335 | <dt><strong><a name="item_fwidth">$font_width = $term->fwidth</a></strong><br /> |
| … | |
… | |
| 905 | </dt> |
1348 | </dt> |
| 906 | <dt><strong><a name="item_savelines">$max_scrollback = $term->saveLines</a></strong><br /> |
1349 | <dt><strong><a name="item_savelines">$max_scrollback = $term->saveLines</a></strong><br /> |
| 907 | </dt> |
1350 | </dt> |
| 908 | <dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term->total_rows</a></strong><br /> |
1351 | <dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term->total_rows</a></strong><br /> |
| 909 | </dt> |
1352 | </dt> |
| 910 | <dt><strong><a name="item_nsaved">$lines_in_scrollback = $term->nsaved</a></strong><br /> |
1353 | <dt><strong><a name="item_top_row">$topmost_scrollback_row = $term->top_row</a></strong><br /> |
| 911 | </dt> |
1354 | </dt> |
| 912 | <dd> |
1355 | <dd> |
| 913 | Return various integers describing terminal characteristics. |
1356 | Return various integers describing terminal characteristics. |
| 914 | </dd> |
1357 | </dd> |
| 915 | <p></p> |
1358 | <p></p> |
| … | |
… | |
| 941 | <dd> |
1384 | <dd> |
| 942 | Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often |
1385 | Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often |
| 943 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1386 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
| 944 | </dd> |
1387 | </dd> |
| 945 | <p></p> |
1388 | <p></p> |
|
|
1389 | <dt><strong><a name="item_current_screen">$screen = $term->current_screen</a></strong><br /> |
|
|
1390 | </dt> |
|
|
1391 | <dd> |
|
|
1392 | Returns the currently displayed screen (0 primary, 1 secondary). |
|
|
1393 | </dd> |
|
|
1394 | <p></p> |
|
|
1395 | <dt><strong><a name="item_hidden_cursor">$cursor_is_hidden = $term->hidden_cursor</a></strong><br /> |
|
|
1396 | </dt> |
|
|
1397 | <dd> |
|
|
1398 | Returns wether the cursor is currently hidden or not. |
|
|
1399 | </dd> |
|
|
1400 | <p></p> |
| 946 | <dt><strong><a name="item_view_start">$view_start = $term->view_start ([$newvalue])</a></strong><br /> |
1401 | <dt><strong><a name="item_view_start">$view_start = $term->view_start ([$newvalue])</a></strong><br /> |
| 947 | </dt> |
1402 | </dt> |
| 948 | <dd> |
1403 | <dd> |
| 949 | Returns the negative row number of the topmost line. Minimum value is |
1404 | Returns the row number of the topmost displayed line. Maximum value is |
| 950 | <code>0</code>, which displays the normal terminal contents. Larger values scroll |
1405 | <code>0</code>, which displays the normal terminal contents. Lower values scroll |
| 951 | this many lines into the scrollback buffer. |
1406 | this many lines into the scrollback buffer. |
| 952 | </dd> |
1407 | </dd> |
| 953 | <p></p> |
1408 | <p></p> |
| 954 | <dt><strong><a name="item_want_refresh">$term->want_refresh</a></strong><br /> |
1409 | <dt><strong><a name="item_want_refresh">$term->want_refresh</a></strong><br /> |
| 955 | </dt> |
1410 | </dt> |
| … | |
… | |
| 966 | </dt> |
1421 | </dt> |
| 967 | <dd> |
1422 | <dd> |
| 968 | Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code> |
1423 | Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code> |
| 969 | is the topmost terminal line, row <code>$term->$ncol-1</code> is the bottommost |
1424 | is the topmost terminal line, row <code>$term->$ncol-1</code> is the bottommost |
| 970 | terminal line. The scrollback buffer starts at line <code>-1</code> and extends to |
1425 | terminal line. The scrollback buffer starts at line <code>-1</code> and extends to |
| 971 | line <a href="#item_nsaved"><code>-$term->nsaved</code></a>. Nothing will be returned if a nonexistent line |
1426 | line <code>-$term->nsaved</code>. Nothing will be returned if a nonexistent line |
| 972 | is requested. |
1427 | is requested. |
| 973 | </dd> |
1428 | </dd> |
| 974 | <dd> |
1429 | <dd> |
| 975 | <p>If <code>$new_text</code> is specified, it will replace characters in the current |
1430 | <p>If <code>$new_text</code> is specified, it will replace characters in the current |
| 976 | line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful |
1431 | line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful |
| 977 | to replace only parts of a line. The font index in the rendition will |
1432 | to replace only parts of a line. The font index in the rendition will |
| 978 | automatically be updated.</p> |
1433 | automatically be updated.</p> |
| 979 | </dd> |
1434 | </dd> |
| 980 | <dd> |
1435 | <dd> |
| 981 | <p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more |
1436 | <p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more |
| 982 | than one cell when displayed are padded with urxvt::NOCHAR characters |
1437 | than one cell when displayed are padded with <code>$urxvt::NOCHAR</code> (chr 65535) |
| 983 | (<code>chr 65535</code>). Characters with combining characters and other characters |
1438 | characters. Characters with combining characters and other characters that |
| 984 | that do not fit into the normal tetx encoding will be replaced with |
1439 | do not fit into the normal tetx encoding will be replaced with characters |
| 985 | characters in the private use area.</p> |
1440 | in the private use area.</p> |
| 986 | </dd> |
1441 | </dd> |
| 987 | <dd> |
1442 | <dd> |
| 988 | <p>You have to obey this encoding when changing text. The advantage is |
1443 | <p>You have to obey this encoding when changing text. The advantage is |
| 989 | that <code>substr</code> and similar functions work on screen cells and not on |
1444 | that <code>substr</code> and similar functions work on screen cells and not on |
| 990 | characters.</p> |
1445 | characters.</p> |
| … | |
… | |
| 1061 | <p></p> |
1516 | <p></p> |
| 1062 | <dt><strong><a name="item_offset_of">$offset = $line->offset_of ($row, $col)</a></strong><br /> |
1517 | <dt><strong><a name="item_offset_of">$offset = $line->offset_of ($row, $col)</a></strong><br /> |
| 1063 | </dt> |
1518 | </dt> |
| 1064 | <dd> |
1519 | <dd> |
| 1065 | Returns the character offset of the given row|col pair within the logical |
1520 | Returns the character offset of the given row|col pair within the logical |
| 1066 | line. |
1521 | line. Works for rows outside the line, too, and returns corresponding |
|
|
1522 | offsets outside the string. |
| 1067 | </dd> |
1523 | </dd> |
| 1068 | <p></p> |
1524 | <p></p> |
| 1069 | <dt><strong><a name="item_coord_of">($row, $col) = $line->coord_of ($offset)</a></strong><br /> |
1525 | <dt><strong><a name="item_coord_of">($row, $col) = $line->coord_of ($offset)</a></strong><br /> |
| 1070 | </dt> |
1526 | </dt> |
| 1071 | <dd> |
1527 | <dd> |
| … | |
… | |
| 1085 | <dd> |
1541 | <dd> |
| 1086 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1542 | Converts rxvt-unicodes text reprsentation into a perl string. See |
| 1087 | <a href="#item_row_t"><code>$term->ROW_t</code></a> for details. |
1543 | <a href="#item_row_t"><code>$term->ROW_t</code></a> for details. |
| 1088 | </dd> |
1544 | </dd> |
| 1089 | <p></p> |
1545 | <p></p> |
| 1090 | <dt><strong><a name="item_grab_button">$success = $term->grab_button ($button, $modifiermask)</a></strong><br /> |
1546 | <dt><strong><a name="item_grab_button">$success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])</a></strong><br /> |
| 1091 | </dt> |
1547 | </dt> |
|
|
1548 | <dt><strong><a name="item_ungrab_button">$term->ungrab_button ($button, $modifiermask[, $window = $term->vt])</a></strong><br /> |
|
|
1549 | </dt> |
| 1092 | <dd> |
1550 | <dd> |
| 1093 | Registers a synchronous button grab. See the XGrabButton manpage. |
1551 | Register/unregister a synchronous button grab. See the XGrabButton |
|
|
1552 | manpage. |
| 1094 | </dd> |
1553 | </dd> |
| 1095 | <p></p> |
1554 | <p></p> |
| 1096 | <dt><strong><a name="item_grab">$success = $term->grab ($eventtime[, $sync])</a></strong><br /> |
1555 | <dt><strong><a name="item_grab">$success = $term->grab ($eventtime[, $sync])</a></strong><br /> |
| 1097 | </dt> |
1556 | </dt> |
| 1098 | <dd> |
1557 | <dd> |
| … | |
… | |
| 1123 | </dt> |
1582 | </dt> |
| 1124 | <dd> |
1583 | <dd> |
| 1125 | Calls XUngrab for the most recent grab. Is called automatically on |
1584 | Calls XUngrab for the most recent grab. Is called automatically on |
| 1126 | evaluation errors, as it is better to lose the grab in the error case as |
1585 | evaluation errors, as it is better to lose the grab in the error case as |
| 1127 | the session. |
1586 | the session. |
|
|
1587 | </dd> |
|
|
1588 | <p></p> |
|
|
1589 | <dt><strong><a name="item_xinternatom">$atom = $term->XInternAtom ($atom_name[, $only_if_exists])</a></strong><br /> |
|
|
1590 | </dt> |
|
|
1591 | <dt><strong><a name="item_xgetatomname">$atom_name = $term->XGetAtomName ($atom)</a></strong><br /> |
|
|
1592 | </dt> |
|
|
1593 | <dt><strong><a name="item_xlistproperties">@atoms = $term->XListProperties ($window)</a></strong><br /> |
|
|
1594 | </dt> |
|
|
1595 | <dt><strong><a name="item_xgetwindowproperty">($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)</a></strong><br /> |
|
|
1596 | </dt> |
|
|
1597 | <dt><strong><a name="item_xchangewindowproperty">$term->XChangeWindowProperty ($window, $property, $type, $format, $octets)</a></strong><br /> |
|
|
1598 | </dt> |
|
|
1599 | <dt><strong><a name="item_xdeleteproperty">$term->XDeleteProperty ($window, $property)</a></strong><br /> |
|
|
1600 | </dt> |
|
|
1601 | <dt><strong><a name="item_defaultrootwindow">$window = $term->DefaultRootWindow</a></strong><br /> |
|
|
1602 | </dt> |
|
|
1603 | <dt><strong><a name="item_xreparentwindow">$term->XReparentWindow ($window, $parent, [$x, $y])</a></strong><br /> |
|
|
1604 | </dt> |
|
|
1605 | <dt><strong><a name="item_xmapwindow">$term->XMapWindow ($window)</a></strong><br /> |
|
|
1606 | </dt> |
|
|
1607 | <dt><strong><a name="item_xunmapwindow">$term->XUnmapWindow ($window)</a></strong><br /> |
|
|
1608 | </dt> |
|
|
1609 | <dt><strong><a name="item_xmoveresizewindow">$term->XMoveResizeWindow ($window, $x, $y, $width, $height)</a></strong><br /> |
|
|
1610 | </dt> |
|
|
1611 | <dt><strong><a name="item_xtranslatecoordinates">($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)</a></strong><br /> |
|
|
1612 | </dt> |
|
|
1613 | <dt><strong><a name="item_xchangeinput">$term->XChangeInput ($window, $add_events[, $del_events])</a></strong><br /> |
|
|
1614 | </dt> |
|
|
1615 | <dd> |
|
|
1616 | Various X or X-related functions. The <code>$term</code> object only serves as |
|
|
1617 | the source of the display, otherwise those functions map more-or-less |
|
|
1618 | directory onto the X functions of the same name. |
| 1128 | </dd> |
1619 | </dd> |
| 1129 | <p></p></dl> |
1620 | <p></p></dl> |
| 1130 | <p> |
1621 | <p> |
| 1131 | </p> |
1622 | </p> |
| 1132 | <h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> |
1623 | <h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> |
| … | |
… | |
| 1220 | <p></p> |
1711 | <p></p> |
| 1221 | <dt><strong>$timer = $timer->start ($tstamp)</strong><br /> |
1712 | <dt><strong>$timer = $timer->start ($tstamp)</strong><br /> |
| 1222 | </dt> |
1713 | </dt> |
| 1223 | <dd> |
1714 | <dd> |
| 1224 | Set the event trigger time to <code>$tstamp</code> and start the timer. |
1715 | Set the event trigger time to <code>$tstamp</code> and start the timer. |
|
|
1716 | </dd> |
|
|
1717 | <p></p> |
|
|
1718 | <dt><strong><a name="item_after">$timer = $timer->after ($delay)</a></strong><br /> |
|
|
1719 | </dt> |
|
|
1720 | <dd> |
|
|
1721 | Like <a href="#item_start"><code>start</code></a>, but sets the expiry timer to c<urxvt::NOW + $delay>. |
| 1225 | </dd> |
1722 | </dd> |
| 1226 | <p></p> |
1723 | <p></p> |
| 1227 | <dt><strong><a name="item_stop">$timer = $timer->stop</a></strong><br /> |
1724 | <dt><strong><a name="item_stop">$timer = $timer->stop</a></strong><br /> |
| 1228 | </dt> |
1725 | </dt> |
| 1229 | <dd> |
1726 | <dd> |
| … | |
… | |
| 1287 | Stop watching for events on the given filehandle. |
1784 | Stop watching for events on the given filehandle. |
| 1288 | </dd> |
1785 | </dd> |
| 1289 | <p></p></dl> |
1786 | <p></p></dl> |
| 1290 | <p> |
1787 | <p> |
| 1291 | </p> |
1788 | </p> |
|
|
1789 | <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 |
|
|
1791 | the process is idle. They should return as fast as possible, after doing |
|
|
1792 | some useful work.</p> |
|
|
1793 | <dl> |
|
|
1794 | <dt><strong><a name="item__24iw__3d_new_urxvt_3a_3aiw">$iw = new urxvt::iw</a></strong><br /> |
|
|
1795 | </dt> |
|
|
1796 | <dd> |
|
|
1797 | Create a new idle watcher object in stopped state. |
|
|
1798 | </dd> |
|
|
1799 | <p></p> |
|
|
1800 | <dt><strong>$iw = $iw->cb (sub { my ($iw) = @_; ... })</strong><br /> |
|
|
1801 | </dt> |
|
|
1802 | <dd> |
|
|
1803 | Set the callback to be called when the watcher triggers. |
|
|
1804 | </dd> |
|
|
1805 | <p></p> |
|
|
1806 | <dt><strong>$timer = $timer->start</strong><br /> |
|
|
1807 | </dt> |
|
|
1808 | <dd> |
|
|
1809 | Start the watcher. |
|
|
1810 | </dd> |
|
|
1811 | <p></p> |
|
|
1812 | <dt><strong>$timer = $timer->stop</strong><br /> |
|
|
1813 | </dt> |
|
|
1814 | <dd> |
|
|
1815 | Stop the watcher. |
|
|
1816 | </dd> |
|
|
1817 | <p></p></dl> |
|
|
1818 | <p> |
|
|
1819 | </p> |
|
|
1820 | <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 |
|
|
1822 | process exits, after which they stop automatically.</p> |
|
|
1823 | <pre> |
|
|
1824 | my $pid = fork; |
|
|
1825 | ... |
|
|
1826 | $term->{pw} = urxvt::pw |
|
|
1827 | ->new |
|
|
1828 | ->start ($pid) |
|
|
1829 | ->cb (sub { |
|
|
1830 | my ($pw, $exit_status) = @_; |
|
|
1831 | ... |
|
|
1832 | });</pre> |
|
|
1833 | <dl> |
|
|
1834 | <dt><strong><a name="item__24pw__3d_new_urxvt_3a_3apw">$pw = new urxvt::pw</a></strong><br /> |
|
|
1835 | </dt> |
|
|
1836 | <dd> |
|
|
1837 | Create a new process watcher in stopped state. |
|
|
1838 | </dd> |
|
|
1839 | <p></p> |
|
|
1840 | <dt><strong>$pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })</strong><br /> |
|
|
1841 | </dt> |
|
|
1842 | <dd> |
|
|
1843 | Set the callback to be called when the timer triggers. |
|
|
1844 | </dd> |
|
|
1845 | <p></p> |
|
|
1846 | <dt><strong>$pw = $timer->start ($pid)</strong><br /> |
|
|
1847 | </dt> |
|
|
1848 | <dd> |
|
|
1849 | Tells the wqtcher to start watching for process <code>$pid</code>. |
|
|
1850 | </dd> |
|
|
1851 | <p></p> |
|
|
1852 | <dt><strong>$pw = $pw->stop</strong><br /> |
|
|
1853 | </dt> |
|
|
1854 | <dd> |
|
|
1855 | Stop the watcher. |
|
|
1856 | </dd> |
|
|
1857 | <p></p></dl> |
|
|
1858 | <p> |
|
|
1859 | </p> |
| 1292 | <hr /> |
1860 | <hr /> |
| 1293 | <h1><a name="environment">ENVIRONMENT</a></h1> |
1861 | <h1><a name="environment">ENVIRONMENT</a></h1> |
| 1294 | <p> |
1862 | <p> |
| 1295 | </p> |
1863 | </p> |
| 1296 | <h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> |
1864 | <h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> |
| … | |
… | |
| 1299 | <dl> |
1867 | <dl> |
| 1300 | <dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br /> |
1868 | <dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br /> |
| 1301 | </dt> |
1869 | </dt> |
| 1302 | <dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">>= 3 - script loading and management</a></strong><br /> |
1870 | <dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">>= 3 - script loading and management</a></strong><br /> |
| 1303 | </dt> |
1871 | </dt> |
| 1304 | <dt><strong><a name="item__3e_3d10__2d_all_events_received">>=10 - all events received</a></strong><br /> |
1872 | <dt><strong><a name="item__3e_3d10__2d_all_called_hooks">>=10 - all called hooks</a></strong><br /> |
|
|
1873 | </dt> |
|
|
1874 | <dt><strong><a name="item__3e_3d11__2d_hook_reutrn_values">>=11 - hook reutrn values</a></strong><br /> |
| 1305 | </dt> |
1875 | </dt> |
| 1306 | </dl> |
1876 | </dl> |
| 1307 | <p> |
1877 | <p> |
| 1308 | </p> |
1878 | </p> |
| 1309 | <hr /> |
1879 | <hr /> |
