| … | |
… | |
| 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 |
| … | |
… | |
| 116 | <dd> |
121 | <dd> |
| 117 | <pre> |
122 | <pre> |
| 118 | URxvt.selection.pattern-0: \\|([^|]+)\\|</pre> |
123 | URxvt.selection.pattern-0: \\|([^|]+)\\|</pre> |
| 119 | </dd> |
124 | </dd> |
| 120 | <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> |
| 121 | <p>You can look at the source of the selection extension to see more |
136 | <p>You can look at the source of the selection extension to see more |
| 122 | interesting uses, such as parsing a line from beginning to end.</p> |
137 | interesting uses, such as parsing a line from beginning to end.</p> |
| 123 | </dd> |
138 | </dd> |
| 124 | <dd> |
139 | <dd> |
| 125 | <p>This extension also offers following bindable keyboard commands:</p> |
140 | <p>This extension also offers following bindable keyboard commands:</p> |
| … | |
… | |
| 132 | </dd> |
147 | </dd> |
| 133 | <dd> |
148 | <dd> |
| 134 | <pre> |
149 | <pre> |
| 135 | URxvt.keysym.C-M-r: perl:selection:rot13</pre> |
150 | URxvt.keysym.C-M-r: perl:selection:rot13</pre> |
| 136 | </dd> |
151 | </dd> |
| 137 | <p></p> |
|
|
| 138 | <dt><strong><a name="item_remote_2dpastebin">remote-pastebin</a></strong><br /> |
|
|
| 139 | </dt> |
|
|
| 140 | <dd> |
|
|
| 141 | Upload the selection as textfile to a remote site. |
|
|
| 142 | </dd> |
|
|
| 143 | <dd> |
|
|
| 144 | <pre> |
|
|
| 145 | URxvt.keysym.C-M-e: perl:selection:remote-pastebin</pre> |
|
|
| 146 | </dd> |
|
|
| 147 | <dd> |
|
|
| 148 | <p>To set the command to upload the file set this resource:</p> |
|
|
| 149 | </dd> |
|
|
| 150 | <dd> |
|
|
| 151 | <pre> |
|
|
| 152 | URxvt.selection-pastebin-cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.</pre> |
|
|
| 153 | </dd> |
|
|
| 154 | <dd> |
|
|
| 155 | <p>The % is the placeholder for the textfile. The name of the textfile is the hex encoded |
|
|
| 156 | md5 sum of the selection. |
|
|
| 157 | After an successful upload the selection will be replaced by the following url |
|
|
| 158 | (the % is the placeholder for the filename):</p> |
|
|
| 159 | </dd> |
|
|
| 160 | <dd> |
|
|
| 161 | <pre> |
|
|
| 162 | URxvt.selection-pastebin-url: <a href="http://www.ta-sa.org/files/txt/%">http://www.ta-sa.org/files/txt/%</a></pre> |
|
|
| 163 | </dd> |
|
|
| 164 | <p></p></dl> |
152 | <p></p></dl> |
| 165 | <dt><strong><a name="item_popup">option-popup (enabled by default)</a></strong><br /> |
153 | <dt><strong><a name="item_popup">option-popup (enabled by default)</a></strong><br /> |
| 166 | </dt> |
154 | </dt> |
| 167 | <dd> |
155 | <dd> |
| 168 | Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at |
156 | Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at |
| … | |
… | |
| 172 | <dt><strong>selection-popup (enabled by default)</strong><br /> |
160 | <dt><strong>selection-popup (enabled by default)</strong><br /> |
| 173 | </dt> |
161 | </dt> |
| 174 | <dd> |
162 | <dd> |
| 175 | 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 |
| 176 | text into various other formats/action (such as uri unescaping, perl |
164 | text into various other formats/action (such as uri unescaping, perl |
| 177 | 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> |
| 178 | </dd> |
190 | </dd> |
| 179 | <p></p> |
191 | <p></p> |
| 180 | <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 /> |
| 181 | </dt> |
193 | </dt> |
| 182 | <dd> |
194 | <dd> |
| … | |
… | |
| 193 | was started, while <code>Enter</code> or <code>Return</code> stay at the current position and |
205 | was started, while <code>Enter</code> or <code>Return</code> stay at the current position and |
| 194 | additionally stores the first match in the current line into the primary |
206 | additionally stores the first match in the current line into the primary |
| 195 | selection.</p> |
207 | selection.</p> |
| 196 | </dd> |
208 | </dd> |
| 197 | <p></p> |
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> |
| 198 | <dt><strong><a name="item_selection_2dautotransform">selection-autotransform</a></strong><br /> |
234 | <dt><strong><a name="item_selection_2dautotransform">selection-autotransform</a></strong><br /> |
| 199 | </dt> |
235 | </dt> |
| 200 | <dd> |
236 | <dd> |
| 201 | This selection allows you to do automatic transforms on a selection |
237 | This selection allows you to do automatic transforms on a selection |
| 202 | whenever a selection is made. |
238 | whenever a selection is made. |
| … | |
… | |
| 224 | <p>And this example matches the same,but replaces it with vi-commands you can |
260 | <p>And this example matches the same,but replaces it with vi-commands you can |
| 225 | paste directly into your (vi :) editor:</p> |
261 | paste directly into your (vi :) editor:</p> |
| 226 | </dd> |
262 | </dd> |
| 227 | <dd> |
263 | <dd> |
| 228 | <pre> |
264 | <pre> |
| 229 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/</pre> |
265 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/</pre> |
| 230 | </dd> |
266 | </dd> |
| 231 | <dd> |
267 | <dd> |
| 232 | <p>Of course, this can be modified to suit your needs and your editor :)</p> |
268 | <p>Of course, this can be modified to suit your needs and your editor :)</p> |
| 233 | </dd> |
269 | </dd> |
| 234 | <dd> |
270 | <dd> |
| 235 | <p>To expand the example above to typical perl error messages (``XXX at |
271 | <p>To expand the example above to typical perl error messages (``XXX at |
| 236 | FILENAME line YYY.''), you need a slightly more elaborate solution:</p> |
272 | FILENAME line YYY.''), you need a slightly more elaborate solution:</p> |
| 237 | </dd> |
273 | </dd> |
| 238 | <dd> |
274 | <dd> |
| 239 | <pre> |
275 | <pre> |
| 240 | URxvt.selection.pattern-0: ( at .*? line \\d+\\.) |
276 | URxvt.selection.pattern-0: ( at .*? line \\d+[,.]) |
| 241 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/</pre> |
277 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/</pre> |
| 242 | </dd> |
278 | </dd> |
| 243 | <dd> |
279 | <dd> |
| 244 | <p>The first line tells the selection code to treat the unchanging part of |
280 | <p>The first line tells the selection code to treat the unchanging part of |
| 245 | every error message as a selection pattern, and the second line transforms |
281 | every error message as a selection pattern, and the second line transforms |
| 246 | the message into vi commands to load the file.</p> |
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> |
| 247 | </dd> |
297 | </dd> |
| 248 | <p></p> |
298 | <p></p> |
| 249 | <dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> |
299 | <dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> |
| 250 | </dt> |
300 | </dt> |
| 251 | <dd> |
301 | <dd> |
| … | |
… | |
| 253 | make them clickable. When middle-clicked, the program specified in the |
303 | make them clickable. When middle-clicked, the program specified in the |
| 254 | resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with |
304 | resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with |
| 255 | the URL as first argument. |
305 | the URL as first argument. |
| 256 | </dd> |
306 | </dd> |
| 257 | <p></p> |
307 | <p></p> |
|
|
308 | <dt><strong><a name="item_xim_2donthespot">xim-onthespot</a></strong><br /> |
|
|
309 | </dt> |
|
|
310 | <dd> |
|
|
311 | This (experimental) perl extension implements OnTheSpot editing. It does |
|
|
312 | not work perfectly, and some input methods don't seem to work well with |
|
|
313 | OnTheSpot editing in general, but it seems to work at leats for SCIM and |
|
|
314 | kinput2. |
|
|
315 | </dd> |
|
|
316 | <dd> |
|
|
317 | <p>You enable it by specifying this extension and a preedit style of |
|
|
318 | <code>OnTheSpot</code>, i.e.:</p> |
|
|
319 | </dd> |
|
|
320 | <dd> |
|
|
321 | <pre> |
|
|
322 | rxvt -pt OnTheSpot -pe xim-onthespot</pre> |
|
|
323 | </dd> |
|
|
324 | <p></p> |
|
|
325 | <dt><strong><a name="item_automove_2dbackground">automove-background</a></strong><br /> |
|
|
326 | </dt> |
|
|
327 | <dd> |
|
|
328 | This is basically a one-line extension that dynamically changes the background pixmap offset |
|
|
329 | to the window position, in effect creating the same effect as pseudo transparency with |
|
|
330 | a custom pixmap. No scaling is supported in this mode. Exmaple: |
|
|
331 | </dd> |
|
|
332 | <dd> |
|
|
333 | <pre> |
|
|
334 | rxvt -pixmap background.xpm -pe automove-background</pre> |
|
|
335 | </dd> |
|
|
336 | <p></p> |
| 258 | <dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br /> |
337 | <dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br /> |
| 259 | </dt> |
338 | </dt> |
| 260 | <dd> |
339 | <dd> |
| 261 | A not very useful example of filtering all text output to the terminal, |
340 | A not very useful example of filtering all text output to the terminal, |
| 262 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
341 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
| … | |
… | |
| 265 | <p></p> |
344 | <p></p> |
| 266 | <dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> |
345 | <dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> |
| 267 | </dt> |
346 | </dt> |
| 268 | <dd> |
347 | <dd> |
| 269 | Displays a digital clock using the built-in overlay. |
348 | Displays a digital clock using the built-in overlay. |
|
|
349 | </dd> |
|
|
350 | <p></p> |
|
|
351 | <dt><strong><a name="item_remote_2dclipboard">remote-clipboard</a></strong><br /> |
|
|
352 | </dt> |
|
|
353 | <dd> |
|
|
354 | Somewhat of a misnomer, this extension adds two menu entries to the |
|
|
355 | selection popup that allows one ti run external commands to store the |
|
|
356 | selection somewhere and fetch it again. |
|
|
357 | </dd> |
|
|
358 | <dd> |
|
|
359 | <p>We use it to implement a ``distributed selection mechanism'', which just |
|
|
360 | means that one command uploads the file to a remote server, and another |
|
|
361 | reads it.</p> |
|
|
362 | </dd> |
|
|
363 | <dd> |
|
|
364 | <p>The commands can be set using the <code>URxvt.remote-selection.store</code> and |
|
|
365 | <code>URxvt.remote-selection.fetch</code> resources. The first should read the |
|
|
366 | selection to store from STDIN (always in UTF-8), the second should provide |
|
|
367 | the selection data on STDOUT (also in UTF-8).</p> |
|
|
368 | </dd> |
|
|
369 | <dd> |
|
|
370 | <p>The defaults (which are likely useless to you) use rsh and cat:</p> |
|
|
371 | </dd> |
|
|
372 | <dd> |
|
|
373 | <pre> |
|
|
374 | URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' |
|
|
375 | URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'</pre> |
|
|
376 | </dd> |
|
|
377 | <p></p> |
|
|
378 | <dt><strong><a name="item_selection_2dpastebin">selection-pastebin</a></strong><br /> |
|
|
379 | </dt> |
|
|
380 | <dd> |
|
|
381 | This is a little rarely useful extension that Uploads the selection as |
|
|
382 | textfile to a remote site (or does other things). (The implementation is |
|
|
383 | not currently secure for use in a multiuser environment as it writes to |
|
|
384 | <em>/tmp</em> directly.). |
|
|
385 | </dd> |
|
|
386 | <dd> |
|
|
387 | <p>It listens to the <code>selection-pastebin:remote-pastebin</code> keyboard command, |
|
|
388 | i.e.</p> |
|
|
389 | </dd> |
|
|
390 | <dd> |
|
|
391 | <pre> |
|
|
392 | URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin</pre> |
|
|
393 | </dd> |
|
|
394 | <dd> |
|
|
395 | <p>Pressing this combination runs a command with <code>%</code> replaced by the name of |
|
|
396 | the textfile. This command can be set via a resource:</p> |
|
|
397 | </dd> |
|
|
398 | <dd> |
|
|
399 | <pre> |
|
|
400 | URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.</pre> |
|
|
401 | </dd> |
|
|
402 | <dd> |
|
|
403 | <p>And the default is likely not useful to anybody but the few people around |
|
|
404 | here :)</p> |
|
|
405 | </dd> |
|
|
406 | <dd> |
|
|
407 | <p>The name of the textfile is the hex encoded md5 sum of the selection, so |
|
|
408 | the same content should lead to the same filename.</p> |
|
|
409 | </dd> |
|
|
410 | <dd> |
|
|
411 | <p>After a successful upload the selection will be replaced by the text given |
|
|
412 | in the <code>selection-pastebin-url</code> resource (again, the % is the placeholder |
|
|
413 | for the filename):</p> |
|
|
414 | </dd> |
|
|
415 | <dd> |
|
|
416 | <pre> |
|
|
417 | URxvt.selection-pastebin.url: <a href="http://www.ta-sa.org/files/txt/%">http://www.ta-sa.org/files/txt/%</a></pre> |
| 270 | </dd> |
418 | </dd> |
| 271 | <p></p> |
419 | <p></p> |
| 272 | <dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> |
420 | <dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> |
| 273 | </dt> |
421 | </dt> |
| 274 | <dd> |
422 | <dd> |
| … | |
… | |
| 357 | <h2><a name="hooks">Hooks</a></h2> |
505 | <h2><a name="hooks">Hooks</a></h2> |
| 358 | <p>The following subroutines can be declared in extension files, and will be |
506 | <p>The following subroutines can be declared in extension files, and will be |
| 359 | called whenever the relevant event happens.</p> |
507 | called whenever the relevant event happens.</p> |
| 360 | <p>The first argument passed to them is an extension oject as described in |
508 | <p>The first argument passed to them is an extension oject as described in |
| 361 | the in the <code>Extension Objects</code> section.</p> |
509 | the in the <code>Extension Objects</code> section.</p> |
| 362 | <p><strong>All</strong> of these hooks must return a boolean value. If it is true, then the |
510 | <p><strong>All</strong> of these hooks must return a boolean value. If any of the called |
| 363 | event counts as being <em>consumed</em>, and the invocation of other hooks is |
511 | hooks returns true, then the event counts as being <em>consumed</em>, and the |
| 364 | skipped, and the relevant action might not be carried out by the C++ code.</p> |
512 | relevant action might not be carried out by the C++ code.</p> |
| 365 | <p><em>When in doubt, return a false value (preferably <code>()</code>). </em>></p> |
513 | <p><em>When in doubt, return a false value (preferably <code>()</code>). </em>></p> |
| 366 | <dl> |
514 | <dl> |
| 367 | <dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> |
515 | <dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> |
| 368 | </dt> |
516 | </dt> |
| 369 | <dd> |
517 | <dd> |
| 370 | Called after a new terminal object has been initialized, but before |
518 | Called after a new terminal object has been initialized, but before |
| 371 | windows are created or the command gets run. Most methods are unsafe to |
519 | windows are created or the command gets run. Most methods are unsafe to |
| 372 | call or deliver senseless data, as terminal size and other characteristics |
520 | call or deliver senseless data, as terminal size and other characteristics |
| 373 | have not yet been determined. You can safely query and change resources, |
521 | have not yet been determined. You can safely query and change resources |
| 374 | though. |
522 | and options, though. For many purposes the <code>on_start</code> hook is a better |
|
|
523 | place. |
|
|
524 | </dd> |
|
|
525 | <p></p> |
|
|
526 | <dt><strong><a name="item_on_start__24term">on_start $term</a></strong><br /> |
|
|
527 | </dt> |
|
|
528 | <dd> |
|
|
529 | Called at the very end of initialisation of a new terminal, just before |
|
|
530 | trying to map (display) the toplevel and returning to the mainloop. |
|
|
531 | </dd> |
|
|
532 | <p></p> |
|
|
533 | <dt><strong><a name="item_on_destroy__24term">on_destroy $term</a></strong><br /> |
|
|
534 | </dt> |
|
|
535 | <dd> |
|
|
536 | Called whenever something tries to destroy terminal, when the terminal is |
|
|
537 | still fully functional (not for long, though). |
| 375 | </dd> |
538 | </dd> |
| 376 | <p></p> |
539 | <p></p> |
| 377 | <dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> |
540 | <dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> |
| 378 | </dt> |
541 | </dt> |
| 379 | <dd> |
542 | <dd> |
| 380 | Called after the screen is ``reset'' for any reason, such as resizing or |
543 | Called after the screen is ``reset'' for any reason, such as resizing or |
| 381 | control sequences. Here is where you can react on changes to size-related |
544 | control sequences. Here is where you can react on changes to size-related |
| 382 | variables. |
545 | variables. |
| 383 | </dd> |
546 | </dd> |
| 384 | <p></p> |
547 | <p></p> |
| 385 | <dt><strong><a name="item_on_start__24term">on_start $term</a></strong><br /> |
548 | <dt><strong><a name="item_on_child_start__24term_2c__24pid">on_child_start $term, $pid</a></strong><br /> |
| 386 | </dt> |
549 | </dt> |
|
|
550 | <dd> |
|
|
551 | Called just after the child process has been <code>fork</code>ed. |
| 387 | <dd> |
552 | </dd> |
| 388 | Called at the very end of initialisation of a new terminal, just before |
553 | <p></p> |
| 389 | returning to the mainloop. |
554 | <dt><strong><a name="item_on_child_exit__24term_2c__24status">on_child_exit $term, $status</a></strong><br /> |
|
|
555 | </dt> |
|
|
556 | <dd> |
|
|
557 | Called just after the child process has exited. <code>$status</code> is the status |
|
|
558 | from <code>waitpid</code>. |
| 390 | </dd> |
559 | </dd> |
| 391 | <p></p> |
560 | <p></p> |
| 392 | <dt><strong><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a></strong><br /> |
561 | <dt><strong><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a></strong><br /> |
| 393 | </dt> |
562 | </dt> |
| 394 | <dd> |
563 | <dd> |
| … | |
… | |
| 511 | </dt> |
680 | </dt> |
| 512 | <dd> |
681 | <dd> |
| 513 | Called just after the screen gets redrawn. See <code>on_refresh_begin</code>. |
682 | Called just after the screen gets redrawn. See <code>on_refresh_begin</code>. |
| 514 | </dd> |
683 | </dd> |
| 515 | <p></p> |
684 | <p></p> |
| 516 | <dt><strong><a name="item_on_keyboard_command__24term_2c__24string">on_keyboard_command $term, $string</a></strong><br /> |
685 | <dt><strong><a name="item_on_user_command__24term_2c__24string">on_user_command $term, $string</a></strong><br /> |
| 517 | </dt> |
686 | </dt> |
| 518 | <dd> |
687 | <dd> |
| 519 | Called whenever the user presses a key combination that has a |
688 | Called whenever the a user-configured event is being activated (e.g. via |
| 520 | <code>perl:string</code> action bound to it (see description of the <strong>keysym</strong> |
689 | a <code>perl:string</code> action bound to a key, see description of the <strong>keysym</strong> |
| 521 | resource in the <code>rxvt(1)</code> manpage). |
690 | resource in the <code>rxvt(1)</code> manpage). |
|
|
691 | </dd> |
|
|
692 | <dd> |
|
|
693 | <p>The event is simply the action string. This interface is assumed to change |
|
|
694 | slightly in the future.</p> |
| 522 | </dd> |
695 | </dd> |
| 523 | <p></p> |
696 | <p></p> |
| 524 | <dt><strong><a name="item_on_x_event__24term_2c__24event">on_x_event $term, $event</a></strong><br /> |
697 | <dt><strong><a name="item_on_x_event__24term_2c__24event">on_x_event $term, $event</a></strong><br /> |
| 525 | </dt> |
698 | </dt> |
| 526 | <dd> |
699 | <dd> |
| … | |
… | |
| 541 | <dd> |
714 | <dd> |
| 542 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
715 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
| 543 | focus out processing. |
716 | focus out processing. |
| 544 | </dd> |
717 | </dd> |
| 545 | <p></p> |
718 | <p></p> |
|
|
719 | <dt><strong><a name="item_on_configure_notify__24term_2c__24event">on_configure_notify $term, $event</a></strong><br /> |
|
|
720 | </dt> |
|
|
721 | <dt><strong><a name="item_on_property_notify__24term_2c__24event">on_property_notify $term, $event</a></strong><br /> |
|
|
722 | </dt> |
| 546 | <dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a></strong><br /> |
723 | <dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a></strong><br /> |
| 547 | </dt> |
724 | </dt> |
| 548 | <dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br /> |
725 | <dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br /> |
| 549 | </dt> |
726 | </dt> |
| 550 | <dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br /> |
727 | <dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br /> |
| … | |
… | |
| 561 | Called whenever the corresponding X event is received for the terminal If |
738 | Called whenever the corresponding X event is received for the terminal If |
| 562 | the hook returns true, then the even will be ignored by rxvt-unicode. |
739 | the hook returns true, then the even will be ignored by rxvt-unicode. |
| 563 | </dd> |
740 | </dd> |
| 564 | <dd> |
741 | <dd> |
| 565 | <p>The event is a hash with most values as named by Xlib (see the XEvent |
742 | <p>The event is a hash with most values as named by Xlib (see the XEvent |
| 566 | manpage), with the additional members <code>row</code> and <code>col</code>, which are the row |
743 | manpage), with the additional members <code>row</code> and <code>col</code>, which are the |
| 567 | and column under the mouse cursor.</p> |
744 | (real, not screen-based) row and column under the mouse cursor.</p> |
| 568 | </dd> |
745 | </dd> |
| 569 | <dd> |
746 | <dd> |
| 570 | <p><code>on_key_press</code> additionally receives the string rxvt-unicode would |
747 | <p><code>on_key_press</code> additionally receives the string rxvt-unicode would |
| 571 | output, if any, in locale-specific encoding.</p> |
748 | output, if any, in locale-specific encoding.</p> |
| 572 | </dd> |
749 | </dd> |
| 573 | <dd> |
750 | <dd> |
| 574 | <p>subwindow.</p> |
751 | <p>subwindow.</p> |
|
|
752 | </dd> |
|
|
753 | <p></p> |
|
|
754 | <dt><strong><a name="item_on_client_message__24term_2c__24event">on_client_message $term, $event</a></strong><br /> |
|
|
755 | </dt> |
|
|
756 | <dt><strong><a name="item_on_wm_protocols__24term_2c__24event">on_wm_protocols $term, $event</a></strong><br /> |
|
|
757 | </dt> |
|
|
758 | <dt><strong><a name="item_on_wm_delete_window__24term_2c__24event">on_wm_delete_window $term, $event</a></strong><br /> |
|
|
759 | </dt> |
|
|
760 | <dd> |
|
|
761 | Called when various types of ClientMessage events are received (all with |
|
|
762 | format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
| 575 | </dd> |
763 | </dd> |
| 576 | <p></p></dl> |
764 | <p></p></dl> |
| 577 | <p> |
765 | <p> |
| 578 | </p> |
766 | </p> |
| 579 | <h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> |
767 | <h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> |
| … | |
… | |
| 601 | </dt> |
789 | </dt> |
| 602 | <dd> |
790 | <dd> |
| 603 | The current terminal. This variable stores the current <code>urxvt::term</code> |
791 | The current terminal. This variable stores the current <code>urxvt::term</code> |
| 604 | object, whenever a callback/hook is executing. |
792 | object, whenever a callback/hook is executing. |
| 605 | </dd> |
793 | </dd> |
|
|
794 | <p></p> |
|
|
795 | <dt><strong><a name="item__40urxvt_3a_3aterm_init">@urxvt::TERM_INIT</a></strong><br /> |
|
|
796 | </dt> |
|
|
797 | <dd> |
|
|
798 | All coderefs in this array will be called as methods of the next newly |
|
|
799 | created <code>urxvt::term</code> object (during the <code>on_init</code> phase). The array |
|
|
800 | gets cleared before the codereferences that were in it are being executed, |
|
|
801 | so coderefs can push themselves onto it again if they so desire. |
|
|
802 | </dd> |
|
|
803 | <dd> |
|
|
804 | <p>This complements to the perl-eval commandline option, but gets executed |
|
|
805 | first.</p> |
|
|
806 | </dd> |
|
|
807 | <p></p> |
|
|
808 | <dt><strong><a name="item__40urxvt_3a_3aterm_ext">@urxvt::TERM_EXT</a></strong><br /> |
|
|
809 | </dt> |
|
|
810 | <dd> |
|
|
811 | Works similar to <code>@TERM_INIT</code>, but contains perl package/class names, which |
|
|
812 | get registered as normal extensions after calling the hooks in <code>@TERM_INIT</code> |
|
|
813 | but before other extensions. Gets cleared just like <code>@TERM_INIT</code>. |
|
|
814 | </dd> |
| 606 | <p></p></dl> |
815 | <p></p></dl> |
| 607 | <p> |
816 | <p> |
| 608 | </p> |
817 | </p> |
| 609 | <h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> |
818 | <h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> |
| 610 | <dl> |
819 | <dl> |
| … | |
… | |
| 627 | <p>Using this function has the advantage that its output ends up in the |
836 | <p>Using this function has the advantage that its output ends up in the |
| 628 | correct place, e.g. on stderr of the connecting urxvtc client.</p> |
837 | correct place, e.g. on stderr of the connecting urxvtc client.</p> |
| 629 | </dd> |
838 | </dd> |
| 630 | <dd> |
839 | <dd> |
| 631 | <p>Messages have a size limit of 1023 bytes currently.</p> |
840 | <p>Messages have a size limit of 1023 bytes currently.</p> |
|
|
841 | </dd> |
|
|
842 | <p></p> |
|
|
843 | <dt><strong><a name="item__40terms__3d_urxvt_3a_3atermlist">@terms = urxvt::termlist</a></strong><br /> |
|
|
844 | </dt> |
|
|
845 | <dd> |
|
|
846 | Returns all urxvt::term objects that exist in this process, regardless of |
|
|
847 | wether they are started, being destroyed etc., so be careful. Only term |
|
|
848 | objects that have perl extensions attached will be returned (because there |
|
|
849 | is no urxvt::term objet associated with others). |
| 632 | </dd> |
850 | </dd> |
| 633 | <p></p> |
851 | <p></p> |
| 634 | <dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> |
852 | <dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> |
| 635 | </dt> |
853 | </dt> |
| 636 | <dd> |
854 | <dd> |
| … | |
… | |
| 747 | </dd> |
965 | </dd> |
| 748 | <dd> |
966 | <dd> |
| 749 | <p>Croaks (and probably outputs an error message) if the new instance |
967 | <p>Croaks (and probably outputs an error message) if the new instance |
| 750 | couldn't be created. Returns <code>undef</code> if the new instance didn't |
968 | couldn't be created. Returns <code>undef</code> if the new instance didn't |
| 751 | initialise perl, and the terminal object otherwise. The <code>init</code> and |
969 | initialise perl, and the terminal object otherwise. The <code>init</code> and |
| 752 | <a href="#item_start"><code>start</code></a> hooks will be called during this call.</p> |
970 | <a href="#item_start"><code>start</code></a> hooks will be called before this call returns, and are free to |
|
|
971 | refer to global data (which is race free).</p> |
| 753 | </dd> |
972 | </dd> |
| 754 | <p></p> |
973 | <p></p> |
| 755 | <dt><strong><a name="item_destroy">$term->destroy</a></strong><br /> |
974 | <dt><strong><a name="item_destroy">$term->destroy</a></strong><br /> |
| 756 | </dt> |
975 | </dt> |
| 757 | <dd> |
976 | <dd> |
| 758 | Destroy the terminal object (close the window, free resources |
977 | Destroy the terminal object (close the window, free resources |
| 759 | etc.). Please note that rxvt will not exit as long as any event |
978 | etc.). Please note that rxvt will not exit as long as any event |
| 760 | watchers (timers, io watchers) are still active. |
979 | watchers (timers, io watchers) are still active. |
| 761 | </dd> |
980 | </dd> |
| 762 | <p></p> |
981 | <p></p> |
|
|
982 | <dt><strong><a name="item_exec_async">$term->exec_async ($cmd[, @args])</a></strong><br /> |
|
|
983 | </dt> |
|
|
984 | <dd> |
|
|
985 | Works like the combination of the <code>fork</code>/<code>exec</code> builtins, which executes |
|
|
986 | (``starts'') programs in the background. This function takes care of setting |
|
|
987 | the user environment before exec'ing the command (e.g. <code>PATH</code>) and should |
|
|
988 | be preferred over explicit calls to <code>exec</code> or <code>system</code>. |
|
|
989 | </dd> |
|
|
990 | <dd> |
|
|
991 | <p>Returns the pid of the subprocess or <code>undef</code> on error.</p> |
|
|
992 | </dd> |
|
|
993 | <p></p> |
| 763 | <dt><strong><a name="item_option">$isset = $term->option ($optval[, $set])</a></strong><br /> |
994 | <dt><strong><a name="item_option">$isset = $term->option ($optval[, $set])</a></strong><br /> |
| 764 | </dt> |
995 | </dt> |
| 765 | <dd> |
996 | <dd> |
| 766 | Returns true if the option specified by <code>$optval</code> is enabled, and |
997 | Returns true if the option specified by <code>$optval</code> is enabled, and |
| 767 | optionally change it. All option values are stored by name in the hash |
998 | optionally change it. All option values are stored by name in the hash |
| … | |
… | |
| 773 | </dd> |
1004 | </dd> |
| 774 | <dd> |
1005 | <dd> |
| 775 | <pre> |
1006 | <pre> |
| 776 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1007 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
| 777 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1008 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
| 778 | pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating |
1009 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
| 779 | scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer |
1010 | scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput |
| 780 | secondaryScreen secondaryScroll skipBuiltinGlyphs transparent |
1011 | scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs |
| 781 | tripleclickwords utmpInhibit visualBell</pre> |
1012 | transparent tripleclickwords utmpInhibit visualBell</pre> |
| 782 | </dd> |
1013 | </dd> |
| 783 | <p></p> |
1014 | <p></p> |
| 784 | <dt><strong><a name="item_resource">$value = $term->resource ($name[, $newval])</a></strong><br /> |
1015 | <dt><strong><a name="item_resource">$value = $term->resource ($name[, $newval])</a></strong><br /> |
| 785 | </dt> |
1016 | </dt> |
| 786 | <dd> |
1017 | <dd> |
| … | |
… | |
| 811 | <pre> |
1042 | <pre> |
| 812 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1043 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
| 813 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
1044 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
| 814 | display_name embed ext_bwidth fade font geometry hold iconName |
1045 | display_name embed ext_bwidth fade font geometry hold iconName |
| 815 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
1046 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
| 816 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
1047 | italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier |
| 817 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 |
1048 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
| 818 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
1049 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
| 819 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
1050 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
| 820 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
1051 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
| 821 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
1052 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
| 822 | shade term_name title transparent transparent_all tripleclickwords |
1053 | secondaryScreen secondaryScroll selectstyle shade term_name title |
|
|
1054 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
| 823 | utmpInhibit visualBell</pre> |
1055 | visualBell</pre> |
| 824 | </dd> |
1056 | </dd> |
| 825 | <p></p> |
1057 | <p></p> |
| 826 | <dt><strong><a name="item_x_resource">$value = $term->x_resource ($pattern)</a></strong><br /> |
1058 | <dt><strong><a name="item_x_resource">$value = $term->x_resource ($pattern)</a></strong><br /> |
| 827 | </dt> |
1059 | </dt> |
| 828 | <dd> |
1060 | <dd> |
| … | |
… | |
| 1003 | <p>Normally its not a good idea to use this function, as programs might be |
1235 | <p>Normally its not a good idea to use this function, as programs might be |
| 1004 | confused by changes in cursor position or scrolling. Its useful inside a |
1236 | confused by changes in cursor position or scrolling. Its useful inside a |
| 1005 | <code>on_add_lines</code> hook, though.</p> |
1237 | <code>on_add_lines</code> hook, though.</p> |
| 1006 | </dd> |
1238 | </dd> |
| 1007 | <p></p> |
1239 | <p></p> |
|
|
1240 | <dt><strong><a name="item_scr_change_screen">$term->scr_change_screen ($screen)</a></strong><br /> |
|
|
1241 | </dt> |
|
|
1242 | <dd> |
|
|
1243 | Switch to given screen - 0 primary, 1 secondary. |
|
|
1244 | </dd> |
|
|
1245 | <p></p> |
| 1008 | <dt><strong><a name="item_cmd_parse">$term->cmd_parse ($octets)</a></strong><br /> |
1246 | <dt><strong><a name="item_cmd_parse">$term->cmd_parse ($octets)</a></strong><br /> |
| 1009 | </dt> |
1247 | </dt> |
| 1010 | <dd> |
1248 | <dd> |
| 1011 | Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the |
1249 | Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the |
| 1012 | locale-specific encoding of the terminal and can contain command sequences |
1250 | locale-specific encoding of the terminal and can contain command sequences |
| … | |
… | |
| 1028 | be used to suppress input and output handling to the pty/tty. See the |
1266 | be used to suppress input and output handling to the pty/tty. See the |
| 1029 | description of <a href="#item_events"><code>urxvt::timer->events</code></a>. Make sure to always restore |
1267 | description of <a href="#item_events"><code>urxvt::timer->events</code></a>. Make sure to always restore |
| 1030 | the previous value. |
1268 | the previous value. |
| 1031 | </dd> |
1269 | </dd> |
| 1032 | <p></p> |
1270 | <p></p> |
|
|
1271 | <dt><strong><a name="item_pty_fd">$fd = $term->pty_fd</a></strong><br /> |
|
|
1272 | </dt> |
|
|
1273 | <dd> |
|
|
1274 | Returns the master file descriptor for the pty in use, or <code>-1</code> if no pty |
|
|
1275 | is used. |
|
|
1276 | </dd> |
|
|
1277 | <p></p> |
| 1033 | <dt><strong><a name="item_parent">$windowid = $term->parent</a></strong><br /> |
1278 | <dt><strong><a name="item_parent">$windowid = $term->parent</a></strong><br /> |
| 1034 | </dt> |
1279 | </dt> |
| 1035 | <dd> |
1280 | <dd> |
| 1036 | Return the window id of the toplevel window. |
1281 | Return the window id of the toplevel window. |
| 1037 | </dd> |
1282 | </dd> |
| … | |
… | |
| 1107 | <dt><strong><a name="item_modnumlockmask">$modifiermask = $term->ModNumLockMask</a></strong><br /> |
1352 | <dt><strong><a name="item_modnumlockmask">$modifiermask = $term->ModNumLockMask</a></strong><br /> |
| 1108 | </dt> |
1353 | </dt> |
| 1109 | <dd> |
1354 | <dd> |
| 1110 | Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often |
1355 | Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often |
| 1111 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1356 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
|
|
1357 | </dd> |
|
|
1358 | <p></p> |
|
|
1359 | <dt><strong><a name="item_current_screen">$screen = $term->current_screen</a></strong><br /> |
|
|
1360 | </dt> |
|
|
1361 | <dd> |
|
|
1362 | Returns the currently displayed screen (0 primary, 1 secondary). |
|
|
1363 | </dd> |
|
|
1364 | <p></p> |
|
|
1365 | <dt><strong><a name="item_hidden_cursor">$cursor_is_hidden = $term->hidden_cursor</a></strong><br /> |
|
|
1366 | </dt> |
|
|
1367 | <dd> |
|
|
1368 | Returns wether the cursor is currently hidden or not. |
| 1112 | </dd> |
1369 | </dd> |
| 1113 | <p></p> |
1370 | <p></p> |
| 1114 | <dt><strong><a name="item_view_start">$view_start = $term->view_start ([$newvalue])</a></strong><br /> |
1371 | <dt><strong><a name="item_view_start">$view_start = $term->view_start ([$newvalue])</a></strong><br /> |
| 1115 | </dt> |
1372 | </dt> |
| 1116 | <dd> |
1373 | <dd> |
| … | |
… | |
| 1145 | to replace only parts of a line. The font index in the rendition will |
1402 | to replace only parts of a line. The font index in the rendition will |
| 1146 | automatically be updated.</p> |
1403 | automatically be updated.</p> |
| 1147 | </dd> |
1404 | </dd> |
| 1148 | <dd> |
1405 | <dd> |
| 1149 | <p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more |
1406 | <p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more |
| 1150 | than one cell when displayed are padded with urxvt::NOCHAR characters |
1407 | than one cell when displayed are padded with <code>$urxvt::NOCHAR</code> (chr 65535) |
| 1151 | (<code>chr 65535</code>). Characters with combining characters and other characters |
1408 | characters. Characters with combining characters and other characters that |
| 1152 | that do not fit into the normal tetx encoding will be replaced with |
1409 | do not fit into the normal tetx encoding will be replaced with characters |
| 1153 | characters in the private use area.</p> |
1410 | in the private use area.</p> |
| 1154 | </dd> |
1411 | </dd> |
| 1155 | <dd> |
1412 | <dd> |
| 1156 | <p>You have to obey this encoding when changing text. The advantage is |
1413 | <p>You have to obey this encoding when changing text. The advantage is |
| 1157 | that <code>substr</code> and similar functions work on screen cells and not on |
1414 | that <code>substr</code> and similar functions work on screen cells and not on |
| 1158 | characters.</p> |
1415 | characters.</p> |
| … | |
… | |
| 1254 | <dd> |
1511 | <dd> |
| 1255 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1512 | Converts rxvt-unicodes text reprsentation into a perl string. See |
| 1256 | <a href="#item_row_t"><code>$term->ROW_t</code></a> for details. |
1513 | <a href="#item_row_t"><code>$term->ROW_t</code></a> for details. |
| 1257 | </dd> |
1514 | </dd> |
| 1258 | <p></p> |
1515 | <p></p> |
| 1259 | <dt><strong><a name="item_grab_button">$success = $term->grab_button ($button, $modifiermask)</a></strong><br /> |
1516 | <dt><strong><a name="item_grab_button">$success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])</a></strong><br /> |
| 1260 | </dt> |
1517 | </dt> |
|
|
1518 | <dt><strong><a name="item_ungrab_button">$term->ungrab_button ($button, $modifiermask[, $window = $term->vt])</a></strong><br /> |
|
|
1519 | </dt> |
| 1261 | <dd> |
1520 | <dd> |
| 1262 | Registers a synchronous button grab. See the XGrabButton manpage. |
1521 | Register/unregister a synchronous button grab. See the XGrabButton |
|
|
1522 | manpage. |
| 1263 | </dd> |
1523 | </dd> |
| 1264 | <p></p> |
1524 | <p></p> |
| 1265 | <dt><strong><a name="item_grab">$success = $term->grab ($eventtime[, $sync])</a></strong><br /> |
1525 | <dt><strong><a name="item_grab">$success = $term->grab ($eventtime[, $sync])</a></strong><br /> |
| 1266 | </dt> |
1526 | </dt> |
| 1267 | <dd> |
1527 | <dd> |
| … | |
… | |
| 1292 | </dt> |
1552 | </dt> |
| 1293 | <dd> |
1553 | <dd> |
| 1294 | Calls XUngrab for the most recent grab. Is called automatically on |
1554 | Calls XUngrab for the most recent grab. Is called automatically on |
| 1295 | evaluation errors, as it is better to lose the grab in the error case as |
1555 | evaluation errors, as it is better to lose the grab in the error case as |
| 1296 | the session. |
1556 | the session. |
|
|
1557 | </dd> |
|
|
1558 | <p></p> |
|
|
1559 | <dt><strong><a name="item_xinternatom">$atom = $term->XInternAtom ($atom_name[, $only_if_exists])</a></strong><br /> |
|
|
1560 | </dt> |
|
|
1561 | <dt><strong><a name="item_xgetatomname">$atom_name = $term->XGetAtomName ($atom)</a></strong><br /> |
|
|
1562 | </dt> |
|
|
1563 | <dt><strong><a name="item_xlistproperties">@atoms = $term->XListProperties ($window)</a></strong><br /> |
|
|
1564 | </dt> |
|
|
1565 | <dt><strong><a name="item_xgetwindowproperty">($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)</a></strong><br /> |
|
|
1566 | </dt> |
|
|
1567 | <dt><strong><a name="item_xchangewindowproperty">$term->XChangeWindowProperty ($window, $property, $type, $format, $octets)</a></strong><br /> |
|
|
1568 | </dt> |
|
|
1569 | <dt><strong><a name="item_xdeleteproperty">$term->XDeleteProperty ($window, $property)</a></strong><br /> |
|
|
1570 | </dt> |
|
|
1571 | <dt><strong><a name="item_defaultrootwindow">$window = $term->DefaultRootWindow</a></strong><br /> |
|
|
1572 | </dt> |
|
|
1573 | <dt><strong><a name="item_xreparentwindow">$term->XReparentWindow ($window, $parent, [$x, $y])</a></strong><br /> |
|
|
1574 | </dt> |
|
|
1575 | <dt><strong><a name="item_xmapwindow">$term->XMapWindow ($window)</a></strong><br /> |
|
|
1576 | </dt> |
|
|
1577 | <dt><strong><a name="item_xunmapwindow">$term->XUnmapWindow ($window)</a></strong><br /> |
|
|
1578 | </dt> |
|
|
1579 | <dt><strong><a name="item_xmoveresizewindow">$term->XMoveResizeWindow ($window, $x, $y, $width, $height)</a></strong><br /> |
|
|
1580 | </dt> |
|
|
1581 | <dt><strong><a name="item_xtranslatecoordinates">($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)</a></strong><br /> |
|
|
1582 | </dt> |
|
|
1583 | <dt><strong><a name="item_xchangeinput">$term->XChangeInput ($window, $add_events[, $del_events])</a></strong><br /> |
|
|
1584 | </dt> |
|
|
1585 | <dd> |
|
|
1586 | Various X or X-related functions. The <code>$term</code> object only serves as |
|
|
1587 | the source of the display, otherwise those functions map more-or-less |
|
|
1588 | directory onto the X functions of the same name. |
| 1297 | </dd> |
1589 | </dd> |
| 1298 | <p></p></dl> |
1590 | <p></p></dl> |
| 1299 | <p> |
1591 | <p> |
| 1300 | </p> |
1592 | </p> |
| 1301 | <h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> |
1593 | <h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> |
| … | |
… | |
| 1389 | <p></p> |
1681 | <p></p> |
| 1390 | <dt><strong>$timer = $timer->start ($tstamp)</strong><br /> |
1682 | <dt><strong>$timer = $timer->start ($tstamp)</strong><br /> |
| 1391 | </dt> |
1683 | </dt> |
| 1392 | <dd> |
1684 | <dd> |
| 1393 | Set the event trigger time to <code>$tstamp</code> and start the timer. |
1685 | Set the event trigger time to <code>$tstamp</code> and start the timer. |
|
|
1686 | </dd> |
|
|
1687 | <p></p> |
|
|
1688 | <dt><strong><a name="item_after">$timer = $timer->after ($delay)</a></strong><br /> |
|
|
1689 | </dt> |
|
|
1690 | <dd> |
|
|
1691 | Like <a href="#item_start"><code>start</code></a>, but sets the expiry timer to c<urxvt::NOW + $delay>. |
| 1394 | </dd> |
1692 | </dd> |
| 1395 | <p></p> |
1693 | <p></p> |
| 1396 | <dt><strong><a name="item_stop">$timer = $timer->stop</a></strong><br /> |
1694 | <dt><strong><a name="item_stop">$timer = $timer->stop</a></strong><br /> |
| 1397 | </dt> |
1695 | </dt> |
| 1398 | <dd> |
1696 | <dd> |
| … | |
… | |
| 1456 | Stop watching for events on the given filehandle. |
1754 | Stop watching for events on the given filehandle. |
| 1457 | </dd> |
1755 | </dd> |
| 1458 | <p></p></dl> |
1756 | <p></p></dl> |
| 1459 | <p> |
1757 | <p> |
| 1460 | </p> |
1758 | </p> |
|
|
1759 | <h2><a name="the_urxvt__iw_class">The <code>urxvt::iw</code> Class</a></h2> |
|
|
1760 | <p>This class implements idle watchers, that get called automatically when |
|
|
1761 | the process is idle. They should return as fast as possible, after doing |
|
|
1762 | some useful work.</p> |
|
|
1763 | <dl> |
|
|
1764 | <dt><strong><a name="item__24iw__3d_new_urxvt_3a_3aiw">$iw = new urxvt::iw</a></strong><br /> |
|
|
1765 | </dt> |
|
|
1766 | <dd> |
|
|
1767 | Create a new idle watcher object in stopped state. |
|
|
1768 | </dd> |
|
|
1769 | <p></p> |
|
|
1770 | <dt><strong>$iw = $iw->cb (sub { my ($iw) = @_; ... })</strong><br /> |
|
|
1771 | </dt> |
|
|
1772 | <dd> |
|
|
1773 | Set the callback to be called when the watcher triggers. |
|
|
1774 | </dd> |
|
|
1775 | <p></p> |
|
|
1776 | <dt><strong>$timer = $timer->start</strong><br /> |
|
|
1777 | </dt> |
|
|
1778 | <dd> |
|
|
1779 | Start the watcher. |
|
|
1780 | </dd> |
|
|
1781 | <p></p> |
|
|
1782 | <dt><strong>$timer = $timer->stop</strong><br /> |
|
|
1783 | </dt> |
|
|
1784 | <dd> |
|
|
1785 | Stop the watcher. |
|
|
1786 | </dd> |
|
|
1787 | <p></p></dl> |
|
|
1788 | <p> |
|
|
1789 | </p> |
|
|
1790 | <h2><a name="the_urxvt__pw_class">The <code>urxvt::pw</code> Class</a></h2> |
|
|
1791 | <p>This class implements process watchers. They create an event whenever a |
|
|
1792 | process exits, after which they stop automatically.</p> |
|
|
1793 | <pre> |
|
|
1794 | my $pid = fork; |
|
|
1795 | ... |
|
|
1796 | $term->{pw} = urxvt::pw |
|
|
1797 | ->new |
|
|
1798 | ->start ($pid) |
|
|
1799 | ->cb (sub { |
|
|
1800 | my ($pw, $exit_status) = @_; |
|
|
1801 | ... |
|
|
1802 | });</pre> |
|
|
1803 | <dl> |
|
|
1804 | <dt><strong><a name="item__24pw__3d_new_urxvt_3a_3apw">$pw = new urxvt::pw</a></strong><br /> |
|
|
1805 | </dt> |
|
|
1806 | <dd> |
|
|
1807 | Create a new process watcher in stopped state. |
|
|
1808 | </dd> |
|
|
1809 | <p></p> |
|
|
1810 | <dt><strong>$pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })</strong><br /> |
|
|
1811 | </dt> |
|
|
1812 | <dd> |
|
|
1813 | Set the callback to be called when the timer triggers. |
|
|
1814 | </dd> |
|
|
1815 | <p></p> |
|
|
1816 | <dt><strong>$pw = $timer->start ($pid)</strong><br /> |
|
|
1817 | </dt> |
|
|
1818 | <dd> |
|
|
1819 | Tells the wqtcher to start watching for process <code>$pid</code>. |
|
|
1820 | </dd> |
|
|
1821 | <p></p> |
|
|
1822 | <dt><strong>$pw = $pw->stop</strong><br /> |
|
|
1823 | </dt> |
|
|
1824 | <dd> |
|
|
1825 | Stop the watcher. |
|
|
1826 | </dd> |
|
|
1827 | <p></p></dl> |
|
|
1828 | <p> |
|
|
1829 | </p> |
| 1461 | <hr /> |
1830 | <hr /> |
| 1462 | <h1><a name="environment">ENVIRONMENT</a></h1> |
1831 | <h1><a name="environment">ENVIRONMENT</a></h1> |
| 1463 | <p> |
1832 | <p> |
| 1464 | </p> |
1833 | </p> |
| 1465 | <h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> |
1834 | <h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> |
