| … | |
… | |
| 13 | <ul> |
13 | <ul> |
| 14 | |
14 | |
| 15 | <li><a href="#name">NAME</a></li> |
15 | <li><a href="#name">NAME</a></li> |
| 16 | <li><a href="#synopsis">SYNOPSIS</a></li> |
16 | <li><a href="#synopsis">SYNOPSIS</a></li> |
| 17 | <li><a href="#description">DESCRIPTION</a></li> |
17 | <li><a href="#description">DESCRIPTION</a></li> |
|
|
18 | <li><a href="#prepackaged_extensions">PREPACKAGED EXTENSIONS</a></li> |
|
|
19 | <li><a href="#api_documentation">API DOCUMENTATION</a></li> |
| 18 | <ul> |
20 | <ul> |
| 19 | |
21 | |
| 20 | <li><a href="#prepackaged_extensions">Prepackaged Extensions</a></li> |
|
|
| 21 | <li><a href="#general_api_considerations">General API Considerations</a></li> |
22 | <li><a href="#general_api_considerations">General API Considerations</a></li> |
|
|
23 | <li><a href="#extension_objects">Extension Objects</a></li> |
| 22 | <li><a href="#hooks">Hooks</a></li> |
24 | <li><a href="#hooks">Hooks</a></li> |
| 23 | <li><a href="#variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></li> |
25 | <li><a href="#variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></li> |
| 24 | <li><a href="#functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></li> |
26 | <li><a href="#functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></li> |
| 25 | <li><a href="#rendition">RENDITION</a></li> |
27 | <li><a href="#rendition">RENDITION</a></li> |
| 26 | <li><a href="#the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></li> |
28 | <li><a href="#the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></li> |
| 27 | <li><a href="#the_urxvt__term_class">The <code>urxvt::term</code> Class</a></li> |
29 | <li><a href="#the_urxvt__term_class">The <code>urxvt::term</code> Class</a></li> |
| 28 | <li><a href="#the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></li> |
30 | <li><a href="#the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></li> |
| 29 | <li><a href="#the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></li> |
31 | <li><a href="#the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></li> |
| 30 | <li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li> |
32 | <li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li> |
|
|
33 | <li><a href="#the_urxvt__iw_class">The <code>urxvt::iw</code> Class</a></li> |
|
|
34 | <li><a href="#the_urxvt__pw_class">The <code>urxvt::pw</code> Class</a></li> |
| 31 | </ul> |
35 | </ul> |
| 32 | |
36 | |
| 33 | <li><a href="#environment">ENVIRONMENT</a></li> |
37 | <li><a href="#environment">ENVIRONMENT</a></li> |
| 34 | <ul> |
38 | <ul> |
| 35 | |
39 | |
| … | |
… | |
| 71 | thus must be encoded as UTF-8.</p> |
75 | thus must be encoded as UTF-8.</p> |
| 72 | <p>Each script will only ever be loaded once, even in rxvtd, where |
76 | <p>Each script will only ever be loaded once, even in rxvtd, where |
| 73 | scripts will be shared (but not enabled) for all terminals.</p> |
77 | scripts will be shared (but not enabled) for all terminals.</p> |
| 74 | <p> |
78 | <p> |
| 75 | </p> |
79 | </p> |
| 76 | <h2><a name="prepackaged_extensions">Prepackaged Extensions</a></h2> |
80 | <hr /> |
|
|
81 | <h1><a name="prepackaged_extensions">PREPACKAGED EXTENSIONS</a></h1> |
| 77 | <p>This section describes the extensiosn delivered with this version. You can |
82 | <p>This section describes the extensions delivered with this release. You can |
| 78 | find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> |
83 | find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> |
| 79 | <p>You can activate them like this:</p> |
84 | <p>You can activate them like this:</p> |
| 80 | <pre> |
85 | <pre> |
| 81 | rxvt -pe <extensionname></pre> |
86 | rxvt -pe <extensionname></pre> |
|
|
87 | <p>Or by adding them to the resource for extensions loaded by default:</p> |
|
|
88 | <pre> |
|
|
89 | URxvt.perl-ext-common: default,automove-background,selection-autotransform</pre> |
| 82 | <dl> |
90 | <dl> |
| 83 | <dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br /> |
91 | <dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br /> |
| 84 | </dt> |
92 | </dt> |
| 85 | <dd> |
93 | <dd> |
| 86 | Intelligent selection. This extension tries to be more intelligent when |
94 | (More) intelligent selection. This extension tries to be more intelligent |
| 87 | the user extends selections (double-click). Right now, it tries to select |
95 | when the user extends selections (double-click and further clicks). Right |
| 88 | urls and complete shell-quoted arguments, which is very convenient, too, |
96 | now, it tries to select words, urls and complete shell-quoted |
| 89 | if your <em>ls</em> supports <code>--quoting-style=shell</code>. |
97 | arguments, which is very convenient, too, if your <em>ls</em> supports |
| 90 | </dd> |
98 | <code>--quoting-style=shell</code>. |
| 91 | <dd> |
99 | </dd> |
| 92 | <p>It also offers the following bindable event:</p> |
100 | <dd> |
|
|
101 | <p>A double-click usually selects the word under the cursor, further clicks |
|
|
102 | will enlarge the selection.</p> |
|
|
103 | </dd> |
|
|
104 | <dd> |
|
|
105 | <p>The selection works by trying to match a number of regexes and displaying |
|
|
106 | them in increasing order of length. You can add your own regexes by |
|
|
107 | specifying resources of the form:</p> |
|
|
108 | </dd> |
|
|
109 | <dd> |
|
|
110 | <pre> |
|
|
111 | URxvt.selection.pattern-0: perl-regex |
|
|
112 | URxvt.selection.pattern-1: perl-regex |
|
|
113 | ...</pre> |
|
|
114 | </dd> |
|
|
115 | <dd> |
|
|
116 | <p>The index number (0, 1...) must not have any holes, and each regex must |
|
|
117 | contain at least one pair of capturing parentheses, which will be used for |
|
|
118 | the match. For example, the followign adds a regex that matches everything |
|
|
119 | between two vertical bars:</p> |
|
|
120 | </dd> |
|
|
121 | <dd> |
|
|
122 | <pre> |
|
|
123 | URxvt.selection.pattern-0: \\|([^|]+)\\|</pre> |
|
|
124 | </dd> |
|
|
125 | <dd> |
|
|
126 | <p>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> |
|
|
140 | <p>This extension also offers following bindable keyboard commands:</p> |
| 93 | </dd> |
141 | </dd> |
| 94 | <dl> |
142 | <dl> |
| 95 | <dt><strong><a name="item_rot13">rot13</a></strong><br /> |
143 | <dt><strong><a name="item_rot13">rot13</a></strong><br /> |
| 96 | </dt> |
144 | </dt> |
| 97 | <dd> |
145 | <dd> |
| … | |
… | |
| 111 | <p></p> |
159 | <p></p> |
| 112 | <dt><strong>selection-popup (enabled by default)</strong><br /> |
160 | <dt><strong>selection-popup (enabled by default)</strong><br /> |
| 113 | </dt> |
161 | </dt> |
| 114 | <dd> |
162 | <dd> |
| 115 | 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 |
| 116 | text into various other formats/action. |
164 | text into various other formats/action (such as uri unescaping, perl |
| 117 | </dd> |
165 | evaluation, web-browser starting etc.), depending on content. |
| 118 | <p></p> |
|
|
| 119 | <dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> |
|
|
| 120 | </dt> |
|
|
| 121 | <dd> |
166 | </dd> |
| 122 | Displays a digital clock using the built-in overlay. |
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> |
|
|
190 | </dd> |
|
|
191 | <p></p> |
|
|
192 | <dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback<hotkey> (enabled by default)</a></strong><br /> |
|
|
193 | </dt> |
|
|
194 | <dd> |
|
|
195 | Adds regex search functionality to the scrollback buffer, triggered |
|
|
196 | by a hotkey (default: <code>M-s</code>). While in search mode, normal terminal |
|
|
197 | input/output is suspended and a regex is displayed at the bottom of the |
|
|
198 | screen. |
|
|
199 | </dd> |
|
|
200 | <dd> |
|
|
201 | <p>Inputting characters appends them to the regex and continues incremental |
|
|
202 | search. <code>BackSpace</code> removes a character from the regex, <code>Up</code> and <code>Down</code> |
|
|
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> |
|
|
208 | </dd> |
|
|
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> |
| 123 | </dd> |
297 | </dd> |
| 124 | <p></p> |
298 | <p></p> |
| 125 | <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 /> |
| 126 | </dt> |
300 | </dt> |
| 127 | <dd> |
301 | <dd> |
| 128 | Uses per-line display filtering (<code>on_line_update</code>) to underline urls. |
302 | Uses per-line display filtering (<code>on_line_update</code>) to underline urls and |
|
|
303 | make them clickable. When middle-clicked, the program specified in the |
|
|
304 | resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with |
|
|
305 | the URL as first argument. |
|
|
306 | </dd> |
|
|
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> |
| 129 | </dd> |
335 | </dd> |
| 130 | <p></p> |
336 | <p></p> |
| 131 | <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 /> |
| 132 | </dt> |
338 | </dt> |
| 133 | <dd> |
339 | <dd> |
| 134 | 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, |
| 135 | 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 |
| 136 | similar-looking ascii character. |
342 | similar-looking ascii character. |
| 137 | </dd> |
343 | </dd> |
| 138 | <p></p> |
344 | <p></p> |
|
|
345 | <dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> |
|
|
346 | </dt> |
|
|
347 | <dd> |
|
|
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> |
|
|
418 | </dd> |
|
|
419 | <p></p> |
| 139 | <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 /> |
| 140 | </dt> |
421 | </dt> |
| 141 | <dd> |
422 | <dd> |
| 142 | Displays a very simple digital clock in the upper right corner of the |
423 | Displays a very simple digital clock in the upper right corner of the |
| 143 | window. Illustrates overwriting the refresh callbacks to create your own |
424 | window. Illustrates overwriting the refresh callbacks to create your own |
| 144 | overlays or changes. |
425 | overlays or changes. |
| 145 | </dd> |
426 | </dd> |
| 146 | <p></p></dl> |
427 | <p></p></dl> |
|
|
428 | <p> |
|
|
429 | </p> |
|
|
430 | <hr /> |
|
|
431 | <h1><a name="api_documentation">API DOCUMENTATION</a></h1> |
| 147 | <p> |
432 | <p> |
| 148 | </p> |
433 | </p> |
| 149 | <h2><a name="general_api_considerations">General API Considerations</a></h2> |
434 | <h2><a name="general_api_considerations">General API Considerations</a></h2> |
| 150 | <p>All objects (such as terminals, time watchers etc.) are typical |
435 | <p>All objects (such as terminals, time watchers etc.) are typical |
| 151 | reference-to-hash objects. The hash can be used to store anything you |
436 | reference-to-hash objects. The hash can be used to store anything you |
| … | |
… | |
| 161 | <dl> |
446 | <dl> |
| 162 | <dt><strong><a name="item__24text">$text</a></strong><br /> |
447 | <dt><strong><a name="item__24text">$text</a></strong><br /> |
| 163 | </dt> |
448 | </dt> |
| 164 | <dd> |
449 | <dd> |
| 165 | Rxvt-unicodes special way of encoding text, where one ``unicode'' character |
450 | Rxvt-unicodes special way of encoding text, where one ``unicode'' character |
| 166 | always represents one screen cell. See <em>row_t</em> for a discussion of this format. |
451 | always represents one screen cell. See <a href="#item_row_t">ROW_t</a> for a discussion of this format. |
| 167 | </dd> |
452 | </dd> |
| 168 | <p></p> |
453 | <p></p> |
| 169 | <dt><strong><a name="item__24string">$string</a></strong><br /> |
454 | <dt><strong><a name="item__24string">$string</a></strong><br /> |
| 170 | </dt> |
455 | </dt> |
| 171 | <dd> |
456 | <dd> |
| … | |
… | |
| 181 | locale-specific way. |
466 | locale-specific way. |
| 182 | </dd> |
467 | </dd> |
| 183 | <p></p></dl> |
468 | <p></p></dl> |
| 184 | <p> |
469 | <p> |
| 185 | </p> |
470 | </p> |
|
|
471 | <h2><a name="extension_objects">Extension Objects</a></h2> |
|
|
472 | <p>Very perl extension is a perl class. A separate perl object is created |
|
|
473 | for each terminal and each extension and passed as the first parameter to |
|
|
474 | hooks. So extensions can use their <code>$self</code> object without having to think |
|
|
475 | about other extensions, with the exception of methods and members that |
|
|
476 | begin with an underscore character <code>_</code>: these are reserved for internal |
|
|
477 | use.</p> |
|
|
478 | <p>Although it isn't a <code>urxvt::term</code> object, you can call all methods of the |
|
|
479 | <code>urxvt::term</code> class on this object.</p> |
|
|
480 | <p>It has the following methods and data members:</p> |
|
|
481 | <dl> |
|
|
482 | <dt><strong><a name="item__24urxvt_term__3d__24self_2d_3e_7bterm_7d">$urxvt_term = $self->{term}</a></strong><br /> |
|
|
483 | </dt> |
|
|
484 | <dd> |
|
|
485 | Returns the <code>urxvt::term</code> object associated with this instance of the |
|
|
486 | extension. This member <em>must not</em> be changed in any way. |
|
|
487 | </dd> |
|
|
488 | <p></p> |
|
|
489 | <dt><strong><a name="item_enable">$self->enable ($hook_name => $cb, [$hook_name => $cb..])</a></strong><br /> |
|
|
490 | </dt> |
|
|
491 | <dd> |
|
|
492 | Dynamically enable the given hooks (named without the <code>on_</code> prefix) for |
|
|
493 | this extension, replacing any previous hook. This is useful when you want |
|
|
494 | to overwrite time-critical hooks only temporarily. |
|
|
495 | </dd> |
|
|
496 | <p></p> |
|
|
497 | <dt><strong><a name="item_disable">$self->disable ($hook_name[, $hook_name..])</a></strong><br /> |
|
|
498 | </dt> |
|
|
499 | <dd> |
|
|
500 | Dynamically disable the given hooks. |
|
|
501 | </dd> |
|
|
502 | <p></p></dl> |
|
|
503 | <p> |
|
|
504 | </p> |
| 186 | <h2><a name="hooks">Hooks</a></h2> |
505 | <h2><a name="hooks">Hooks</a></h2> |
| 187 | <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 |
| 188 | called whenever the relevant event happens.</p> |
507 | called whenever the relevant event happens.</p> |
| 189 | <p>The first argument passed to them is an object private to each terminal |
508 | <p>The first argument passed to them is an extension oject as described in |
| 190 | and extension package. You can call all <code>urxvt::term</code> methods on it, but |
509 | the in the <code>Extension Objects</code> section.</p> |
| 191 | its not a real <code>urxvt::term</code> object. Instead, the real <code>urxvt::term</code> |
510 | <p><strong>All</strong> of these hooks must return a boolean value. If any of the called |
| 192 | object that is shared between all packages is stored in the <code>term</code> |
511 | hooks returns true, then the event counts as being <em>consumed</em>, and the |
| 193 | member. It is, however, blessed intot he package of the extension script, |
|
|
| 194 | so for all practical purposes you can treat an extension script as a class.</p> |
|
|
| 195 | <p>All of them must return a boolean value. If it is true, then the event |
|
|
| 196 | counts as being <em>consumed</em>, and the invocation of other hooks is skipped, |
|
|
| 197 | and the relevant action might not be carried out by the C++ code.</p> |
512 | relevant action might not be carried out by the C++ code.</p> |
| 198 | <p>When in doubt, return a false value (preferably <code>()</code>).</p> |
513 | <p><em>When in doubt, return a false value (preferably <code>()</code>). </em>></p> |
| 199 | <dl> |
514 | <dl> |
| 200 | <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 /> |
| 201 | </dt> |
516 | </dt> |
| 202 | <dd> |
517 | <dd> |
| 203 | Called after a new terminal object has been initialized, but before |
518 | Called after a new terminal object has been initialized, but before |
| 204 | windows are created or the command gets run. Most methods are unsafe to |
519 | windows are created or the command gets run. Most methods are unsafe to |
| 205 | call or deliver senseless data, as terminal size and other characteristics |
520 | call or deliver senseless data, as terminal size and other characteristics |
| 206 | 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 |
| 207 | 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). |
| 208 | </dd> |
538 | </dd> |
| 209 | <p></p> |
539 | <p></p> |
| 210 | <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 /> |
| 211 | </dt> |
541 | </dt> |
| 212 | <dd> |
542 | <dd> |
| 213 | 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 |
| 214 | 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 |
| 215 | variables. |
545 | variables. |
| 216 | </dd> |
546 | </dd> |
| 217 | <p></p> |
547 | <p></p> |
| 218 | <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 /> |
| 219 | </dt> |
549 | </dt> |
|
|
550 | <dd> |
|
|
551 | Called just after the child process has been <code>fork</code>ed. |
| 220 | <dd> |
552 | </dd> |
| 221 | Called at the very end of initialisation of a new terminal, just before |
553 | <p></p> |
| 222 | 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>. |
| 223 | </dd> |
559 | </dd> |
| 224 | <p></p> |
560 | <p></p> |
| 225 | <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 /> |
| 226 | </dt> |
562 | </dt> |
| 227 | <dd> |
563 | <dd> |
| … | |
… | |
| 249 | </dt> |
585 | </dt> |
| 250 | <dd> |
586 | <dd> |
| 251 | Called whenever the user tries to extend the selection (e.g. with a double |
587 | Called whenever the user tries to extend the selection (e.g. with a double |
| 252 | click) and is either supposed to return false (normal operation), or |
588 | click) and is either supposed to return false (normal operation), or |
| 253 | should extend the selection itelf and return true to suppress the built-in |
589 | should extend the selection itelf and return true to suppress the built-in |
| 254 | processing. |
590 | processing. This can happen multiple times, as long as the callback |
|
|
591 | returns true, it will be called on every further click by the user and is |
|
|
592 | supposed to enlarge the selection more and more, if possible. |
| 255 | </dd> |
593 | </dd> |
| 256 | <dd> |
594 | <dd> |
| 257 | <p>See the <em>selection</em> example extension.</p> |
595 | <p>See the <em>selection</em> example extension.</p> |
| 258 | </dd> |
596 | </dd> |
| 259 | <p></p> |
597 | <p></p> |
| … | |
… | |
| 302 | and calling <a href="#item_scr_add_lines"><code>$term->scr_add_lines</code></a> yourself. Please note that this |
640 | and calling <a href="#item_scr_add_lines"><code>$term->scr_add_lines</code></a> yourself. Please note that this |
| 303 | might be very slow, however, as your hook is called for <strong>all</strong> text being |
641 | might be very slow, however, as your hook is called for <strong>all</strong> text being |
| 304 | output. |
642 | output. |
| 305 | </dd> |
643 | </dd> |
| 306 | <p></p> |
644 | <p></p> |
|
|
645 | <dt><strong><a name="item_on_tt_write__24term_2c__24octets">on_tt_write $term, $octets</a></strong><br /> |
|
|
646 | </dt> |
|
|
647 | <dd> |
|
|
648 | Called whenever some data is written to the tty/pty and can be used to |
|
|
649 | suppress or filter tty input. |
|
|
650 | </dd> |
|
|
651 | <p></p> |
| 307 | <dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong><br /> |
652 | <dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong><br /> |
| 308 | </dt> |
653 | </dt> |
| 309 | <dd> |
654 | <dd> |
| 310 | Called whenever a line was updated or changed. Can be used to filter |
655 | Called whenever a line was updated or changed. Can be used to filter |
| 311 | screen output (e.g. underline urls or other useless stuff). Only lines |
656 | screen output (e.g. underline urls or other useless stuff). Only lines |
| … | |
… | |
| 335 | </dt> |
680 | </dt> |
| 336 | <dd> |
681 | <dd> |
| 337 | 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>. |
| 338 | </dd> |
683 | </dd> |
| 339 | <p></p> |
684 | <p></p> |
| 340 | <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 /> |
| 341 | </dt> |
686 | </dt> |
| 342 | <dd> |
687 | <dd> |
| 343 | 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 |
| 344 | <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> |
| 345 | 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> |
|
|
695 | </dd> |
|
|
696 | <p></p> |
|
|
697 | <dt><strong><a name="item_on_x_event__24term_2c__24event">on_x_event $term, $event</a></strong><br /> |
|
|
698 | </dt> |
|
|
699 | <dd> |
|
|
700 | Called on every X event received on the vt window (and possibly other |
|
|
701 | windows). Should only be used as a last resort. Most event structure |
|
|
702 | members are not passed. |
| 346 | </dd> |
703 | </dd> |
| 347 | <p></p> |
704 | <p></p> |
| 348 | <dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> |
705 | <dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> |
| 349 | </dt> |
706 | </dt> |
| 350 | <dd> |
707 | <dd> |
| … | |
… | |
| 357 | <dd> |
714 | <dd> |
| 358 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
715 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
| 359 | focus out processing. |
716 | focus out processing. |
| 360 | </dd> |
717 | </dd> |
| 361 | <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> |
| 362 | <dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24octets">on_key_press $term, $event, $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 /> |
| 363 | </dt> |
724 | </dt> |
| 364 | <dt><strong><a name="item_on_key_release__24term_2c__24event">on_key_release $term, $event</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 /> |
| 365 | </dt> |
726 | </dt> |
| 366 | <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 /> |
| 367 | </dt> |
728 | </dt> |
| 368 | <dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br /> |
729 | <dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br /> |
| 369 | </dt> |
730 | </dt> |
| … | |
… | |
| 377 | 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 |
| 378 | 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. |
| 379 | </dd> |
740 | </dd> |
| 380 | <dd> |
741 | <dd> |
| 381 | <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 |
| 382 | 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 |
| 383 | and column under the mouse cursor.</p> |
744 | (real, not screen-based) row and column under the mouse cursor.</p> |
| 384 | </dd> |
745 | </dd> |
| 385 | <dd> |
746 | <dd> |
| 386 | <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 |
| 387 | output, if any, in locale-specific encoding.</p> |
748 | output, if any, in locale-specific encoding.</p> |
| 388 | </dd> |
749 | </dd> |
| 389 | <dd> |
750 | <dd> |
| 390 | <p>subwindow.</p> |
751 | <p>subwindow.</p> |
| 391 | </dd> |
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). |
|
|
763 | </dd> |
| 392 | <p></p></dl> |
764 | <p></p></dl> |
| 393 | <p> |
765 | <p> |
| 394 | </p> |
766 | </p> |
| 395 | <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> |
| 396 | <dl> |
768 | <dl> |
|
|
769 | <dt><strong><a name="item__24urxvt_3a_3alibdir">$urxvt::LIBDIR</a></strong><br /> |
|
|
770 | </dt> |
|
|
771 | <dd> |
|
|
772 | The rxvt-unicode library directory, where, among other things, the perl |
|
|
773 | modules and scripts are stored. |
|
|
774 | </dd> |
|
|
775 | <p></p> |
|
|
776 | <dt><strong><a name="item__24urxvt_3a_3aresclass_2c__24urxvt_3a_3aresclass">$urxvt::RESCLASS, $urxvt::RESCLASS</a></strong><br /> |
|
|
777 | </dt> |
|
|
778 | <dd> |
|
|
779 | The resource class and name rxvt-unicode uses to look up X resources. |
|
|
780 | </dd> |
|
|
781 | <p></p> |
|
|
782 | <dt><strong><a name="item__24urxvt_3a_3arxvtname">$urxvt::RXVTNAME</a></strong><br /> |
|
|
783 | </dt> |
|
|
784 | <dd> |
|
|
785 | The basename of the installed binaries, usually <code>urxvt</code>. |
|
|
786 | </dd> |
|
|
787 | <p></p> |
| 397 | <dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br /> |
788 | <dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br /> |
| 398 | </dt> |
789 | </dt> |
| 399 | <dd> |
790 | <dd> |
| 400 | 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> |
| 401 | object, whenever a callback/hook is executing. |
792 | object, whenever a callback/hook is executing. |
| 402 | </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> |
| 403 | <p></p></dl> |
815 | <p></p></dl> |
| 404 | <p> |
816 | <p> |
| 405 | </p> |
817 | </p> |
| 406 | <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> |
| 407 | <dl> |
819 | <dl> |
| 408 | <dt><strong><a name="item__24term__3d_new_urxvt__5barg_2e_2e_2e_5d">$term = new urxvt [arg...]</a></strong><br /> |
|
|
| 409 | </dt> |
|
|
| 410 | <dd> |
|
|
| 411 | Creates a new terminal, very similar as if you had started it with |
|
|
| 412 | <code>system $binfile, arg...</code>. Croaks (and probably outputs an error message) |
|
|
| 413 | if the new instance couldn't be created. Returns <code>undef</code> if the new |
|
|
| 414 | instance didn't initialise perl, and the terminal object otherwise. The |
|
|
| 415 | <code>init</code> and <a href="#item_start"><code>start</code></a> hooks will be called during the call. |
|
|
| 416 | </dd> |
|
|
| 417 | <p></p> |
|
|
| 418 | <dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br /> |
820 | <dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br /> |
| 419 | </dt> |
821 | </dt> |
| 420 | <dd> |
822 | <dd> |
| 421 | Fatally aborts execution with the given error message. Avoid at all |
823 | Fatally aborts execution with the given error message. Avoid at all |
| 422 | costs! The only time this is acceptable is when the terminal process |
824 | costs! The only time this is acceptable is when the terminal process |
| … | |
… | |
| 432 | </dd> |
834 | </dd> |
| 433 | <dd> |
835 | <dd> |
| 434 | <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 |
| 435 | 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> |
| 436 | </dd> |
838 | </dd> |
|
|
839 | <dd> |
|
|
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). |
|
|
850 | </dd> |
| 437 | <p></p> |
851 | <p></p> |
| 438 | <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 /> |
| 439 | </dt> |
853 | </dt> |
| 440 | <dd> |
854 | <dd> |
| 441 | Returns the ``current time'' (as per the event loop). |
855 | Returns the ``current time'' (as per the event loop). |
| … | |
… | |
| 444 | <dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br /> |
858 | <dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br /> |
| 445 | </dt> |
859 | </dt> |
| 446 | <dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
860 | <dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
| 447 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
861 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
| 448 | Button4Mask, Button5Mask, AnyModifier</a></strong><br /> |
862 | Button4Mask, Button5Mask, AnyModifier</a></strong><br /> |
|
|
863 | </dt> |
|
|
864 | <dt><strong><a name="item_urxvt_3a_3anoeventmask_2c_keypressmask_2c_keyrelea">urxvt::NoEventMask, KeyPressMask, KeyReleaseMask, |
|
|
865 | ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, |
|
|
866 | PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask, |
|
|
867 | Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask, |
|
|
868 | KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask, |
|
|
869 | ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask, |
|
|
870 | FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask</a></strong><br /> |
|
|
871 | </dt> |
|
|
872 | <dt><strong><a name="item_urxvt_3a_3akeypress_2c_keyrelease_2c_buttonpress_2">urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify, |
|
|
873 | EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose, |
|
|
874 | GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify, |
|
|
875 | UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify, |
|
|
876 | ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify, |
|
|
877 | CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, |
|
|
878 | SelectionNotify, ColormapNotify, ClientMessage, MappingNotify</a></strong><br /> |
| 449 | </dt> |
879 | </dt> |
| 450 | <dd> |
880 | <dd> |
| 451 | Various constants for use in X calls and event processing. |
881 | Various constants for use in X calls and event processing. |
| 452 | </dd> |
882 | </dd> |
| 453 | <p></p></dl> |
883 | <p></p></dl> |
| … | |
… | |
| 488 | </dt> |
918 | </dt> |
| 489 | <dd> |
919 | <dd> |
| 490 | Return the foreground/background colour index, respectively. |
920 | Return the foreground/background colour index, respectively. |
| 491 | </dd> |
921 | </dd> |
| 492 | <p></p> |
922 | <p></p> |
| 493 | <dt><strong><a name="item_set_fgcolor">$rend = urxvt::SET_FGCOLOR ($rend, $new_colour)</a></strong><br /> |
923 | <dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_fgcolor__24rend_2c__24n">$rend = urxvt::SET_FGCOLOR $rend, $new_colour</a></strong><br /> |
| 494 | </dt> |
924 | </dt> |
| 495 | <dt><strong><a name="item_set_bgcolor">$rend = urxvt::SET_BGCOLOR ($rend, $new_colour)</a></strong><br /> |
925 | <dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_bgcolor__24rend_2c__24n">$rend = urxvt::SET_BGCOLOR $rend, $new_colour</a></strong><br /> |
| 496 | </dt> |
926 | </dt> |
| 497 | <dd> |
927 | <dd> |
| 498 | Replace the foreground/background colour in the rendition mask with the |
928 | Replace the foreground/background colour in the rendition mask with the |
| 499 | specified one. |
929 | specified one. |
| 500 | </dd> |
930 | </dd> |
| 501 | <p></p> |
931 | <p></p> |
| 502 | <dt><strong><a name="item_get_custom">$value = urxvt::GET_CUSTOM ($rend)</a></strong><br /> |
932 | <dt><strong><a name="item__24value__3d_urxvt_3a_3aget_custom__24rend">$value = urxvt::GET_CUSTOM $rend</a></strong><br /> |
| 503 | </dt> |
933 | </dt> |
| 504 | <dd> |
934 | <dd> |
| 505 | Return the ``custom'' value: Every rendition has 5 bits for use by |
935 | Return the ``custom'' value: Every rendition has 5 bits for use by |
| 506 | extensions. They can be set and changed as you like and are initially |
936 | extensions. They can be set and changed as you like and are initially |
| 507 | zero. |
937 | zero. |
| 508 | </dd> |
938 | </dd> |
| 509 | <p></p> |
939 | <p></p> |
| 510 | <dt><strong><a name="item_set_custom">$rend = urxvt::SET_CUSTOM ($rend, $new_value)</a></strong><br /> |
940 | <dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_custom__24rend_2c__24ne">$rend = urxvt::SET_CUSTOM $rend, $new_value</a></strong><br /> |
| 511 | </dt> |
941 | </dt> |
| 512 | <dd> |
942 | <dd> |
| 513 | Change the custom value. |
943 | Change the custom value. |
| 514 | </dd> |
944 | </dd> |
| 515 | <p></p></dl> |
945 | <p></p></dl> |
| 516 | <p> |
946 | <p> |
| 517 | </p> |
947 | </p> |
| 518 | <h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2> |
948 | <h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2> |
| 519 | <p>The sole purpose of this class is to deliver an interface to the |
949 | <p>The sole purpose of this class is to deliver an interface to the |
| 520 | <code>AnyEvent</code> module - any module using it will work inside urxvt without |
950 | <code>AnyEvent</code> module - any module using it will work inside urxvt without |
| 521 | further work. The only exception is that you cannot wait on condition |
951 | further programming. The only exception is that you cannot wait on |
| 522 | variables, but non-blocking condvar use is ok. What this means is that you |
952 | condition variables, but non-blocking condvar use is ok. What this means |
| 523 | cannot use blocking APIs, but the non-blocking variant should work.</p> |
953 | is that you cannot use blocking APIs, but the non-blocking variant should |
|
|
954 | work.</p> |
| 524 | <p> |
955 | <p> |
| 525 | </p> |
956 | </p> |
| 526 | <h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> |
957 | <h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> |
| 527 | <dl> |
958 | <dl> |
|
|
959 | <dt><strong><a name="item__24term__3d_new_urxvt_3a_3aterm__24envhashref_2c__">$term = new urxvt::term $envhashref, $rxvtname, [arg...]</a></strong><br /> |
|
|
960 | </dt> |
|
|
961 | <dd> |
|
|
962 | Creates a new terminal, very similar as if you had started it with system |
|
|
963 | <code>$rxvtname, arg...</code>. <code>$envhashref</code> must be a reference to a <code>%ENV</code>-like |
|
|
964 | hash which defines the environment of the new terminal. |
|
|
965 | </dd> |
|
|
966 | <dd> |
|
|
967 | <p>Croaks (and probably outputs an error message) if the new instance |
|
|
968 | couldn't be created. Returns <code>undef</code> if the new instance didn't |
|
|
969 | initialise perl, and the terminal object otherwise. The <code>init</code> and |
|
|
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> |
|
|
972 | </dd> |
|
|
973 | <p></p> |
| 528 | <dt><strong><a name="item_destroy">$term->destroy</a></strong><br /> |
974 | <dt><strong><a name="item_destroy">$term->destroy</a></strong><br /> |
| 529 | </dt> |
975 | </dt> |
| 530 | <dd> |
976 | <dd> |
| 531 | Destroy the terminal object (close the window, free resources etc.). |
977 | Destroy the terminal object (close the window, free resources |
|
|
978 | etc.). Please note that rxvt will not exit as long as any event |
|
|
979 | watchers (timers, io watchers) are still active. |
|
|
980 | </dd> |
|
|
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> |
| 532 | </dd> |
992 | </dd> |
| 533 | <p></p> |
993 | <p></p> |
| 534 | <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 /> |
| 535 | </dt> |
995 | </dt> |
| 536 | <dd> |
996 | <dd> |
| … | |
… | |
| 544 | </dd> |
1004 | </dd> |
| 545 | <dd> |
1005 | <dd> |
| 546 | <pre> |
1006 | <pre> |
| 547 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1007 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
| 548 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1008 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
| 549 | pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating |
1009 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
| 550 | scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer |
1010 | scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput |
| 551 | secondaryScreen secondaryScroll skipBuiltinGlyphs transparent |
1011 | scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs |
| 552 | tripleclickwords utmpInhibit visualBell</pre> |
1012 | transparent tripleclickwords utmpInhibit visualBell</pre> |
| 553 | </dd> |
1013 | </dd> |
| 554 | <p></p> |
1014 | <p></p> |
| 555 | <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 /> |
| 556 | </dt> |
1016 | </dt> |
| 557 | <dd> |
1017 | <dd> |
| … | |
… | |
| 582 | <pre> |
1042 | <pre> |
| 583 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1043 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
| 584 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
1044 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
| 585 | display_name embed ext_bwidth fade font geometry hold iconName |
1045 | display_name embed ext_bwidth fade font geometry hold iconName |
| 586 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
1046 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
| 587 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
1047 | italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier |
| 588 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 |
1048 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
| 589 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
1049 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
| 590 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
1050 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
| 591 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
1051 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
| 592 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
1052 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
| 593 | shade term_name title transparent transparent_all tripleclickwords |
1053 | secondaryScreen secondaryScroll selectstyle shade term_name title |
|
|
1054 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
| 594 | utmpInhibit visualBell</pre> |
1055 | visualBell</pre> |
|
|
1056 | </dd> |
|
|
1057 | <p></p> |
|
|
1058 | <dt><strong><a name="item_x_resource">$value = $term->x_resource ($pattern)</a></strong><br /> |
|
|
1059 | </dt> |
|
|
1060 | <dd> |
|
|
1061 | Returns the X-Resource for the given pattern, excluding the program or |
|
|
1062 | class name, i.e. <a href="#item_x_resource"><code>$term->x_resource ("boldFont")</code></a> should return the |
|
|
1063 | same value as used by this instance of rxvt-unicode. Returns <code>undef</code> if no |
|
|
1064 | resource with that pattern exists. |
|
|
1065 | </dd> |
|
|
1066 | <dd> |
|
|
1067 | <p>This method should only be called during the <code>on_start</code> hook, as there is |
|
|
1068 | only one resource database per display, and later invocations might return |
|
|
1069 | the wrong resources.</p> |
|
|
1070 | </dd> |
|
|
1071 | <p></p> |
|
|
1072 | <dt><strong><a name="item_parse_keysym">$success = $term->parse_keysym ($keysym_spec, $command_string)</a></strong><br /> |
|
|
1073 | </dt> |
|
|
1074 | <dd> |
|
|
1075 | Adds a keymap translation exactly as specified via a resource. See the |
|
|
1076 | <code>keysym</code> resource in the <code>rxvt(1)</code> manpage. |
| 595 | </dd> |
1077 | </dd> |
| 596 | <p></p> |
1078 | <p></p> |
| 597 | <dt><strong><a name="item_rstyle">$rend = $term->rstyle ([$new_rstyle])</a></strong><br /> |
1079 | <dt><strong><a name="item_rstyle">$rend = $term->rstyle ([$new_rstyle])</a></strong><br /> |
| 598 | </dt> |
1080 | </dt> |
| 599 | <dd> |
1081 | <dd> |
| … | |
… | |
| 617 | <dd> |
1099 | <dd> |
| 618 | Return the current values of the selection mark, begin or end positions, |
1100 | Return the current values of the selection mark, begin or end positions, |
| 619 | and optionally set them to new values. |
1101 | and optionally set them to new values. |
| 620 | </dd> |
1102 | </dd> |
| 621 | <p></p> |
1103 | <p></p> |
|
|
1104 | <dt><strong><a name="item_selection_make">$term->selection_make ($eventtime[, $rectangular])</a></strong><br /> |
|
|
1105 | </dt> |
|
|
1106 | <dd> |
|
|
1107 | Tries to make a selection as set by <a href="#item_selection_beg"><code>selection_beg</code></a> and |
|
|
1108 | <a href="#item_selection_end"><code>selection_end</code></a>. If <code>$rectangular</code> is true (default: false), a |
|
|
1109 | rectangular selection will be made. This is the prefered function to make |
|
|
1110 | a selection. |
|
|
1111 | </dd> |
|
|
1112 | <p></p> |
| 622 | <dt><strong><a name="item_selection_grab">$success = $term->selection_grab ($eventtime)</a></strong><br /> |
1113 | <dt><strong><a name="item_selection_grab">$success = $term->selection_grab ($eventtime)</a></strong><br /> |
| 623 | </dt> |
1114 | </dt> |
| 624 | <dd> |
1115 | <dd> |
| 625 | Try to request the primary selection from the server (for example, as set |
1116 | Try to request the primary selection text from the server (for example, as |
| 626 | by the next method). |
1117 | set by the next method). No visual feedback will be given. This function |
|
|
1118 | is mostly useful from within <code>on_sel_grab</code> hooks. |
| 627 | </dd> |
1119 | </dd> |
| 628 | <p></p> |
1120 | <p></p> |
| 629 | <dt><strong>$oldtext = $term->selection ([$newtext])</strong><br /> |
1121 | <dt><strong>$oldtext = $term->selection ([$newtext])</strong><br /> |
| 630 | </dt> |
1122 | </dt> |
| 631 | <dd> |
1123 | <dd> |
| 632 | Return the current selection text and optionally replace it by <code>$newtext</code>. |
1124 | Return the current selection text and optionally replace it by <code>$newtext</code>. |
| 633 | </dd> |
1125 | </dd> |
|
|
1126 | <p></p> |
|
|
1127 | <dt><strong><a name="item_overlay_simple">$term->overlay_simple ($x, $y, $text)</a></strong><br /> |
|
|
1128 | </dt> |
| 634 | <dd> |
1129 | <dd> |
| 635 | <p>#=item $term->overlay ($x, $y, $text) |
|
|
| 636 | # |
|
|
| 637 | #Create a simple multi-line overlay box. See the next method for details. |
1130 | Create a simple multi-line overlay box. See the next method for details. |
| 638 | # |
|
|
| 639 | #=cut |
|
|
| 640 | # |
|
|
| 641 | #sub urxvt::term::scr_overlay { |
|
|
| 642 | # my ($self, $x, $y, $text) = @_; |
|
|
| 643 | # |
|
|
| 644 | # my @lines = split /\n/, $text; |
|
|
| 645 | # |
|
|
| 646 | # my $w = 0; |
|
|
| 647 | # for (map $self->strwidth ($_), @lines) { |
|
|
| 648 | # $w = $_ if $w < $_; |
|
|
| 649 | # } |
|
|
| 650 | # |
|
|
| 651 | # $self->scr_overlay_new ($x, $y, $w, scalar @lines); |
|
|
| 652 | # $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; |
|
|
| 653 | #}</p> |
|
|
| 654 | </dd> |
1131 | </dd> |
| 655 | <p></p> |
1132 | <p></p> |
| 656 | <dt><strong><a name="item_overlay">$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br /> |
1133 | <dt><strong><a name="item_overlay">$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br /> |
| 657 | </dt> |
1134 | </dt> |
| 658 | <dd> |
1135 | <dd> |
| … | |
… | |
| 719 | <p></p> |
1196 | <p></p> |
| 720 | <dt><strong><a name="item_locale_decode">$string = $term->locale_decode ($octets)</a></strong><br /> |
1197 | <dt><strong><a name="item_locale_decode">$string = $term->locale_decode ($octets)</a></strong><br /> |
| 721 | </dt> |
1198 | </dt> |
| 722 | <dd> |
1199 | <dd> |
| 723 | Convert the given locale-encoded octets into a perl string. |
1200 | Convert the given locale-encoded octets into a perl string. |
|
|
1201 | </dd> |
|
|
1202 | <p></p> |
|
|
1203 | <dt><strong><a name="item_scr_xor_span">$term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])</a></strong><br /> |
|
|
1204 | </dt> |
|
|
1205 | <dd> |
|
|
1206 | XORs the rendition values in the given span with the provided value |
|
|
1207 | (default: <code>RS_RVid</code>), which <em>MUST NOT</em> contain font styles. Useful in |
|
|
1208 | refresh hooks to provide effects similar to the selection. |
|
|
1209 | </dd> |
|
|
1210 | <p></p> |
|
|
1211 | <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 /> |
|
|
1212 | </dt> |
|
|
1213 | <dd> |
|
|
1214 | Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing |
|
|
1215 | whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults |
|
|
1216 | to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines |
|
|
1217 | it instead. Both styles <em>MUST NOT</em> contain font styles. |
|
|
1218 | </dd> |
|
|
1219 | <p></p> |
|
|
1220 | <dt><strong><a name="item_scr_bell">$term->scr_bell</a></strong><br /> |
|
|
1221 | </dt> |
|
|
1222 | <dd> |
|
|
1223 | Ring the bell! |
| 724 | </dd> |
1224 | </dd> |
| 725 | <p></p> |
1225 | <p></p> |
| 726 | <dt><strong><a name="item_scr_add_lines">$term->scr_add_lines ($string)</a></strong><br /> |
1226 | <dt><strong><a name="item_scr_add_lines">$term->scr_add_lines ($string)</a></strong><br /> |
| 727 | </dt> |
1227 | </dt> |
| 728 | <dd> |
1228 | <dd> |
| … | |
… | |
| 735 | <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 |
| 736 | 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 |
| 737 | <code>on_add_lines</code> hook, though.</p> |
1237 | <code>on_add_lines</code> hook, though.</p> |
| 738 | </dd> |
1238 | </dd> |
| 739 | <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> |
| 740 | <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 /> |
| 741 | </dt> |
1247 | </dt> |
| 742 | <dd> |
1248 | <dd> |
| 743 | 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 |
| 744 | locale-specific encoding of the terminal and can contain command sequences |
1250 | locale-specific encoding of the terminal and can contain command sequences |
| … | |
… | |
| 751 | Write the octets given in <code>$data</code> to the tty (i.e. as program input). To |
1257 | Write the octets given in <code>$data</code> to the tty (i.e. as program input). To |
| 752 | pass characters instead of octets, you should convert your strings first |
1258 | pass characters instead of octets, you should convert your strings first |
| 753 | to the locale-specific encoding using <a href="#item_locale_encode"><code>$term->locale_encode</code></a>. |
1259 | to the locale-specific encoding using <a href="#item_locale_encode"><code>$term->locale_encode</code></a>. |
| 754 | </dd> |
1260 | </dd> |
| 755 | <p></p> |
1261 | <p></p> |
|
|
1262 | <dt><strong><a name="item_pty_ev_events">$old_events = $term->pty_ev_events ([$new_events])</a></strong><br /> |
|
|
1263 | </dt> |
|
|
1264 | <dd> |
|
|
1265 | Replaces the event mask of the pty watcher by the given event mask. Can |
|
|
1266 | be used to suppress input and output handling to the pty/tty. See the |
|
|
1267 | description of <a href="#item_events"><code>urxvt::timer->events</code></a>. Make sure to always restore |
|
|
1268 | the previous value. |
|
|
1269 | </dd> |
|
|
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> |
| 756 | <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 /> |
| 757 | </dt> |
1279 | </dt> |
| 758 | <dd> |
1280 | <dd> |
| 759 | Return the window id of the toplevel window. |
1281 | Return the window id of the toplevel window. |
| 760 | </dd> |
1282 | </dd> |
| … | |
… | |
| 763 | </dt> |
1285 | </dt> |
| 764 | <dd> |
1286 | <dd> |
| 765 | Return the window id of the terminal window. |
1287 | Return the window id of the terminal window. |
| 766 | </dd> |
1288 | </dd> |
| 767 | <p></p> |
1289 | <p></p> |
|
|
1290 | <dt><strong><a name="item_vt_emask_add">$term->vt_emask_add ($x_event_mask)</a></strong><br /> |
|
|
1291 | </dt> |
|
|
1292 | <dd> |
|
|
1293 | Adds the specified events to the vt event mask. Useful e.g. when you want |
|
|
1294 | to receive pointer events all the times: |
|
|
1295 | </dd> |
|
|
1296 | <dd> |
|
|
1297 | <pre> |
|
|
1298 | $term->vt_emask_add (urxvt::PointerMotionMask);</pre> |
|
|
1299 | </dd> |
|
|
1300 | <p></p> |
| 768 | <dt><strong><a name="item_width">$window_width = $term->width</a></strong><br /> |
1301 | <dt><strong><a name="item_width">$window_width = $term->width</a></strong><br /> |
| 769 | </dt> |
1302 | </dt> |
| 770 | <dt><strong><a name="item_height">$window_height = $term->height</a></strong><br /> |
1303 | <dt><strong><a name="item_height">$window_height = $term->height</a></strong><br /> |
| 771 | </dt> |
1304 | </dt> |
| 772 | <dt><strong><a name="item_fwidth">$font_width = $term->fwidth</a></strong><br /> |
1305 | <dt><strong><a name="item_fwidth">$font_width = $term->fwidth</a></strong><br /> |
| … | |
… | |
| 785 | </dt> |
1318 | </dt> |
| 786 | <dt><strong><a name="item_savelines">$max_scrollback = $term->saveLines</a></strong><br /> |
1319 | <dt><strong><a name="item_savelines">$max_scrollback = $term->saveLines</a></strong><br /> |
| 787 | </dt> |
1320 | </dt> |
| 788 | <dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term->total_rows</a></strong><br /> |
1321 | <dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term->total_rows</a></strong><br /> |
| 789 | </dt> |
1322 | </dt> |
| 790 | <dt><strong><a name="item_nsaved">$lines_in_scrollback = $term->nsaved</a></strong><br /> |
1323 | <dt><strong><a name="item_top_row">$topmost_scrollback_row = $term->top_row</a></strong><br /> |
| 791 | </dt> |
1324 | </dt> |
| 792 | <dd> |
1325 | <dd> |
| 793 | Return various integers describing terminal characteristics. |
1326 | Return various integers describing terminal characteristics. |
|
|
1327 | </dd> |
|
|
1328 | <p></p> |
|
|
1329 | <dt><strong><a name="item_display_id">$x_display = $term->display_id</a></strong><br /> |
|
|
1330 | </dt> |
|
|
1331 | <dd> |
|
|
1332 | Return the DISPLAY used by rxvt-unicode. |
|
|
1333 | </dd> |
|
|
1334 | <p></p> |
|
|
1335 | <dt><strong><a name="item_locale">$lc_ctype = $term->locale</a></strong><br /> |
|
|
1336 | </dt> |
|
|
1337 | <dd> |
|
|
1338 | Returns the LC_CTYPE category string used by this rxvt-unicode. |
|
|
1339 | </dd> |
|
|
1340 | <p></p> |
|
|
1341 | <dt><strong><a name="item_env">$env = $term->env</a></strong><br /> |
|
|
1342 | </dt> |
|
|
1343 | <dd> |
|
|
1344 | Returns a copy of the environment in effect for the terminal as a hashref |
|
|
1345 | similar to <code>\%ENV</code>. |
| 794 | </dd> |
1346 | </dd> |
| 795 | <p></p> |
1347 | <p></p> |
| 796 | <dt><strong><a name="item_modlevel3mask">$modifiermask = $term->ModLevel3Mask</a></strong><br /> |
1348 | <dt><strong><a name="item_modlevel3mask">$modifiermask = $term->ModLevel3Mask</a></strong><br /> |
| 797 | </dt> |
1349 | </dt> |
| 798 | <dt><strong><a name="item_modmetamask">$modifiermask = $term->ModMetaMask</a></strong><br /> |
1350 | <dt><strong><a name="item_modmetamask">$modifiermask = $term->ModMetaMask</a></strong><br /> |
| … | |
… | |
| 802 | <dd> |
1354 | <dd> |
| 803 | 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 |
| 804 | 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. |
| 805 | </dd> |
1357 | </dd> |
| 806 | <p></p> |
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. |
|
|
1369 | </dd> |
|
|
1370 | <p></p> |
| 807 | <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 /> |
| 808 | </dt> |
1372 | </dt> |
| 809 | <dd> |
1373 | <dd> |
| 810 | Returns the negative row number of the topmost line. Minimum value is |
1374 | Returns the row number of the topmost displayed line. Maximum value is |
| 811 | <code>0</code>, which displays the normal terminal contents. Larger values scroll |
1375 | <code>0</code>, which displays the normal terminal contents. Lower values scroll |
| 812 | this many lines into the scrollback buffer. |
1376 | this many lines into the scrollback buffer. |
| 813 | </dd> |
1377 | </dd> |
| 814 | <p></p> |
1378 | <p></p> |
| 815 | <dt><strong><a name="item_want_refresh">$term->want_refresh</a></strong><br /> |
1379 | <dt><strong><a name="item_want_refresh">$term->want_refresh</a></strong><br /> |
| 816 | </dt> |
1380 | </dt> |
| … | |
… | |
| 827 | </dt> |
1391 | </dt> |
| 828 | <dd> |
1392 | <dd> |
| 829 | Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code> |
1393 | Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code> |
| 830 | is the topmost terminal line, row <code>$term->$ncol-1</code> is the bottommost |
1394 | is the topmost terminal line, row <code>$term->$ncol-1</code> is the bottommost |
| 831 | terminal line. The scrollback buffer starts at line <code>-1</code> and extends to |
1395 | terminal line. The scrollback buffer starts at line <code>-1</code> and extends to |
| 832 | line <a href="#item_nsaved"><code>-$term->nsaved</code></a>. Nothing will be returned if a nonexistent line |
1396 | line <code>-$term->nsaved</code>. Nothing will be returned if a nonexistent line |
| 833 | is requested. |
1397 | is requested. |
| 834 | </dd> |
1398 | </dd> |
| 835 | <dd> |
1399 | <dd> |
| 836 | <p>If <code>$new_text</code> is specified, it will replace characters in the current |
1400 | <p>If <code>$new_text</code> is specified, it will replace characters in the current |
| 837 | line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful |
1401 | line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful |
| 838 | 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 |
| 839 | automatically be updated.</p> |
1403 | automatically be updated.</p> |
| 840 | </dd> |
1404 | </dd> |
| 841 | <dd> |
1405 | <dd> |
| 842 | <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 |
| 843 | 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) |
| 844 | (<code>chr 65535</code>). Characters with combining characters and other characters |
1408 | characters. Characters with combining characters and other characters that |
| 845 | 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 |
| 846 | characters in the private use area.</p> |
1410 | in the private use area.</p> |
| 847 | </dd> |
1411 | </dd> |
| 848 | <dd> |
1412 | <dd> |
| 849 | <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 |
| 850 | 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 |
| 851 | characters.</p> |
1415 | characters.</p> |
| … | |
… | |
| 922 | <p></p> |
1486 | <p></p> |
| 923 | <dt><strong><a name="item_offset_of">$offset = $line->offset_of ($row, $col)</a></strong><br /> |
1487 | <dt><strong><a name="item_offset_of">$offset = $line->offset_of ($row, $col)</a></strong><br /> |
| 924 | </dt> |
1488 | </dt> |
| 925 | <dd> |
1489 | <dd> |
| 926 | Returns the character offset of the given row|col pair within the logical |
1490 | Returns the character offset of the given row|col pair within the logical |
| 927 | line. |
1491 | line. Works for rows outside the line, too, and returns corresponding |
|
|
1492 | offsets outside the string. |
| 928 | </dd> |
1493 | </dd> |
| 929 | <p></p> |
1494 | <p></p> |
| 930 | <dt><strong><a name="item_coord_of">($row, $col) = $line->coord_of ($offset)</a></strong><br /> |
1495 | <dt><strong><a name="item_coord_of">($row, $col) = $line->coord_of ($offset)</a></strong><br /> |
| 931 | </dt> |
1496 | </dt> |
| 932 | <dd> |
1497 | <dd> |
| … | |
… | |
| 946 | <dd> |
1511 | <dd> |
| 947 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1512 | Converts rxvt-unicodes text reprsentation into a perl string. See |
| 948 | <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. |
| 949 | </dd> |
1514 | </dd> |
| 950 | <p></p> |
1515 | <p></p> |
| 951 | <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 /> |
| 952 | </dt> |
1517 | </dt> |
|
|
1518 | <dt><strong><a name="item_ungrab_button">$term->ungrab_button ($button, $modifiermask[, $window = $term->vt])</a></strong><br /> |
|
|
1519 | </dt> |
| 953 | <dd> |
1520 | <dd> |
| 954 | Registers a synchronous button grab. See XGrabButton. |
1521 | Register/unregister a synchronous button grab. See the XGrabButton |
|
|
1522 | manpage. |
| 955 | </dd> |
1523 | </dd> |
| 956 | <p></p> |
1524 | <p></p> |
| 957 | <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 /> |
| 958 | </dt> |
1526 | </dt> |
| 959 | <dd> |
1527 | <dd> |
| … | |
… | |
| 985 | <dd> |
1553 | <dd> |
| 986 | Calls XUngrab for the most recent grab. Is called automatically on |
1554 | Calls XUngrab for the most recent grab. Is called automatically on |
| 987 | 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 |
| 988 | the session. |
1556 | the session. |
| 989 | </dd> |
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. |
|
|
1589 | </dd> |
| 990 | <p></p></dl> |
1590 | <p></p></dl> |
| 991 | <p> |
1591 | <p> |
| 992 | </p> |
1592 | </p> |
| 993 | <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> |
|
|
1594 | <dl> |
|
|
1595 | <dt><strong><a name="item_add_title">$popup->add_title ($title)</a></strong><br /> |
|
|
1596 | </dt> |
|
|
1597 | <dd> |
|
|
1598 | Adds a non-clickable title to the popup. |
|
|
1599 | </dd> |
|
|
1600 | <p></p> |
|
|
1601 | <dt><strong><a name="item_add_separator">$popup->add_separator ([$sepchr])</a></strong><br /> |
|
|
1602 | </dt> |
|
|
1603 | <dd> |
|
|
1604 | Creates a separator, optionally using the character given as <code>$sepchr</code>. |
|
|
1605 | </dd> |
|
|
1606 | <p></p> |
|
|
1607 | <dt><strong><a name="item_add_button">$popup->add_button ($text, $cb)</a></strong><br /> |
|
|
1608 | </dt> |
|
|
1609 | <dd> |
|
|
1610 | Adds a clickable button to the popup. <code>$cb</code> is called whenever it is |
|
|
1611 | selected. |
|
|
1612 | </dd> |
|
|
1613 | <p></p> |
|
|
1614 | <dt><strong><a name="item_add_toggle">$popup->add_toggle ($text, $cb, $initial_value)</a></strong><br /> |
|
|
1615 | </dt> |
|
|
1616 | <dd> |
|
|
1617 | Adds a toggle/checkbox item to the popup. Teh callback gets called |
|
|
1618 | whenever it gets toggled, with a boolean indicating its value as its first |
|
|
1619 | argument. |
|
|
1620 | </dd> |
|
|
1621 | <p></p> |
|
|
1622 | <dt><strong>$popup->show</strong><br /> |
|
|
1623 | </dt> |
|
|
1624 | <dd> |
|
|
1625 | Displays the popup (which is initially hidden). |
|
|
1626 | </dd> |
|
|
1627 | <p></p></dl> |
| 994 | <p> |
1628 | <p> |
| 995 | </p> |
1629 | </p> |
| 996 | <h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> |
1630 | <h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> |
| 997 | <p>This class implements timer watchers/events. Time is represented as a |
1631 | <p>This class implements timer watchers/events. Time is represented as a |
| 998 | fractional number of seconds since the epoch. Example:</p> |
1632 | fractional number of seconds since the epoch. Example:</p> |
| … | |
… | |
| 1049 | </dt> |
1683 | </dt> |
| 1050 | <dd> |
1684 | <dd> |
| 1051 | 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. |
| 1052 | </dd> |
1686 | </dd> |
| 1053 | <p></p> |
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>. |
|
|
1692 | </dd> |
|
|
1693 | <p></p> |
| 1054 | <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 /> |
| 1055 | </dt> |
1695 | </dt> |
| 1056 | <dd> |
1696 | <dd> |
| 1057 | Stop the timer. |
1697 | Stop the timer. |
| 1058 | </dd> |
1698 | </dd> |
| … | |
… | |
| 1064 | <pre> |
1704 | <pre> |
| 1065 | $term->{socket} = ... |
1705 | $term->{socket} = ... |
| 1066 | $term->{iow} = urxvt::iow |
1706 | $term->{iow} = urxvt::iow |
| 1067 | ->new |
1707 | ->new |
| 1068 | ->fd (fileno $term->{socket}) |
1708 | ->fd (fileno $term->{socket}) |
| 1069 | ->events (1) # wait for read data |
1709 | ->events (urxvt::EVENT_READ) |
| 1070 | ->start |
1710 | ->start |
| 1071 | ->cb (sub { |
1711 | ->cb (sub { |
| 1072 | my ($iow, $revents) = @_; |
1712 | my ($iow, $revents) = @_; |
| 1073 | # $revents must be 1 here, no need to check |
1713 | # $revents must be 1 here, no need to check |
| 1074 | sysread $term->{socket}, my $buf, 8192 |
1714 | sysread $term->{socket}, my $buf, 8192 |
| … | |
… | |
| 1095 | </dd> |
1735 | </dd> |
| 1096 | <p></p> |
1736 | <p></p> |
| 1097 | <dt><strong><a name="item_events">$iow = $iow->events ($eventmask)</a></strong><br /> |
1737 | <dt><strong><a name="item_events">$iow = $iow->events ($eventmask)</a></strong><br /> |
| 1098 | </dt> |
1738 | </dt> |
| 1099 | <dd> |
1739 | <dd> |
| 1100 | Set the event mask to watch. Bit #0 (value <code>1</code>) enables watching for read |
1740 | Set the event mask to watch. The only allowed values are |
| 1101 | data, Bit #1 (value <code>2</code>) enables watching for write data. |
1741 | <code>urxvt::EVENT_READ</code> and <code>urxvt::EVENT_WRITE</code>, which might be ORed |
|
|
1742 | together, or <code>urxvt::EVENT_NONE</code>. |
| 1102 | </dd> |
1743 | </dd> |
| 1103 | <p></p> |
1744 | <p></p> |
| 1104 | <dt><strong>$iow = $iow->start</strong><br /> |
1745 | <dt><strong>$iow = $iow->start</strong><br /> |
| 1105 | </dt> |
1746 | </dt> |
| 1106 | <dd> |
1747 | <dd> |
| … | |
… | |
| 1109 | <p></p> |
1750 | <p></p> |
| 1110 | <dt><strong>$iow = $iow->stop</strong><br /> |
1751 | <dt><strong>$iow = $iow->stop</strong><br /> |
| 1111 | </dt> |
1752 | </dt> |
| 1112 | <dd> |
1753 | <dd> |
| 1113 | Stop watching for events on the given filehandle. |
1754 | Stop watching for events on the given filehandle. |
|
|
1755 | </dd> |
|
|
1756 | <p></p></dl> |
|
|
1757 | <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. |
| 1114 | </dd> |
1826 | </dd> |
| 1115 | <p></p></dl> |
1827 | <p></p></dl> |
| 1116 | <p> |
1828 | <p> |
| 1117 | </p> |
1829 | </p> |
| 1118 | <hr /> |
1830 | <hr /> |
| … | |
… | |
| 1125 | <dl> |
1837 | <dl> |
| 1126 | <dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br /> |
1838 | <dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br /> |
| 1127 | </dt> |
1839 | </dt> |
| 1128 | <dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">>= 3 - script loading and management</a></strong><br /> |
1840 | <dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">>= 3 - script loading and management</a></strong><br /> |
| 1129 | </dt> |
1841 | </dt> |
| 1130 | <dt><strong><a name="item__3e_3d10__2d_all_events_received">>=10 - all events received</a></strong><br /> |
1842 | <dt><strong><a name="item__3e_3d10__2d_all_called_hooks">>=10 - all called hooks</a></strong><br /> |
|
|
1843 | </dt> |
|
|
1844 | <dt><strong><a name="item__3e_3d11__2d_hook_reutrn_values">>=11 - hook reutrn values</a></strong><br /> |
| 1131 | </dt> |
1845 | </dt> |
| 1132 | </dl> |
1846 | </dl> |
| 1133 | <p> |
1847 | <p> |
| 1134 | </p> |
1848 | </p> |
| 1135 | <hr /> |
1849 | <hr /> |
