| … | |
… | |
| 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> |
|
|
28 | <li><a href="#the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></li> |
| 26 | <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> |
| 27 | <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> |
| 28 | <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> |
| 29 | <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> |
| 30 | </ul> |
35 | </ul> |
| 31 | |
36 | |
| 32 | <li><a href="#environment">ENVIRONMENT</a></li> |
37 | <li><a href="#environment">ENVIRONMENT</a></li> |
| 33 | <ul> |
38 | <ul> |
| 34 | |
39 | |
| … | |
… | |
| 70 | thus must be encoded as UTF-8.</p> |
75 | thus must be encoded as UTF-8.</p> |
| 71 | <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 |
| 72 | scripts will be shared (but not enabled) for all terminals.</p> |
77 | scripts will be shared (but not enabled) for all terminals.</p> |
| 73 | <p> |
78 | <p> |
| 74 | </p> |
79 | </p> |
| 75 | <h2><a name="prepackaged_extensions">Prepackaged Extensions</a></h2> |
80 | <hr /> |
|
|
81 | <h1><a name="prepackaged_extensions">PREPACKAGED EXTENSIONS</a></h1> |
| 76 | <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 |
| 77 | find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> |
83 | find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> |
| 78 | <p>You can activate them like this:</p> |
84 | <p>You can activate them like this:</p> |
| 79 | <pre> |
85 | <pre> |
| 80 | 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> |
| 81 | <dl> |
90 | <dl> |
| 82 | <dt><strong><a name="item_selection">selection</a></strong><br /> |
91 | <dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br /> |
| 83 | </dt> |
92 | </dt> |
| 84 | <dd> |
|
|
| 85 | Intelligent selection. This extension tries to be more intelligent when |
|
|
| 86 | the user extends selections (double-click). Right now, it tries to select |
|
|
| 87 | urls and complete shell-quoted arguments, which is very convenient, too, |
|
|
| 88 | if your <em>ls</em> supports <code>--quoting-style=shell</code>. |
|
|
| 89 | </dd> |
93 | <dd> |
|
|
94 | (More) intelligent selection. This extension tries to be more intelligent |
|
|
95 | when the user extends selections (double-click and further clicks). Right |
|
|
96 | now, it tries to select words, urls and complete shell-quoted |
|
|
97 | arguments, which is very convenient, too, if your <em>ls</em> supports |
|
|
98 | <code>--quoting-style=shell</code>. |
| 90 | <dd> |
99 | </dd> |
| 91 | <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>You can look at the source of the selection extension to see more |
|
|
127 | interesting uses, such as parsing a line from beginning to end.</p> |
|
|
128 | </dd> |
|
|
129 | <dd> |
|
|
130 | <p>This extension also offers following bindable keyboard commands:</p> |
| 92 | </dd> |
131 | </dd> |
| 93 | <dl> |
132 | <dl> |
| 94 | <dt><strong><a name="item_rot13">rot13</a></strong><br /> |
133 | <dt><strong><a name="item_rot13">rot13</a></strong><br /> |
| 95 | </dt> |
134 | </dt> |
| 96 | <dd> |
135 | <dd> |
| … | |
… | |
| 99 | <dd> |
138 | <dd> |
| 100 | <pre> |
139 | <pre> |
| 101 | URxvt.keysym.C-M-r: perl:selection:rot13</pre> |
140 | URxvt.keysym.C-M-r: perl:selection:rot13</pre> |
| 102 | </dd> |
141 | </dd> |
| 103 | <p></p></dl> |
142 | <p></p></dl> |
| 104 | <dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> |
143 | <dt><strong><a name="item_popup">option-popup (enabled by default)</a></strong><br /> |
| 105 | </dt> |
144 | </dt> |
|
|
145 | <dd> |
|
|
146 | Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at |
|
|
147 | runtime. |
| 106 | <dd> |
148 | </dd> |
| 107 | Displays a digital clock using the built-in overlay. |
149 | <p></p> |
|
|
150 | <dt><strong>selection-popup (enabled by default)</strong><br /> |
|
|
151 | </dt> |
|
|
152 | <dd> |
|
|
153 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
|
|
154 | text into various other formats/action (such as uri unescaping, perl |
|
|
155 | evaluation, web-browser starting etc.), depending on content. |
|
|
156 | </dd> |
|
|
157 | <dd> |
|
|
158 | <p>Other extensions can extend this popup menu by pushing a code reference |
|
|
159 | onto <code>@{ $term-</code>{selection_popup_hook} }>, that is called whenever the |
|
|
160 | popup is displayed.</p> |
|
|
161 | </dd> |
|
|
162 | <dd> |
|
|
163 | <p>It's sole argument is the popup menu, which can be modified. The selection |
|
|
164 | is in <code>$_</code>, which can be used to decide wether to add something or not. |
|
|
165 | It should either return nothing or a string and a code reference. The |
|
|
166 | string will be used as button text and the code reference will be called |
|
|
167 | when the button gets activated and should transform <code>$_</code>.</p> |
|
|
168 | </dd> |
|
|
169 | <dd> |
|
|
170 | <p>The following will add an entry <code>a to b</code> that transforms all <code>a</code>s in |
|
|
171 | the selection to <code>b</code>s, but only if the selection currently contains any |
|
|
172 | <code>a</code>s:</p> |
|
|
173 | </dd> |
|
|
174 | <dd> |
|
|
175 | <pre> |
|
|
176 | push @{ $self->{term}{selection_popup_hook} }, sub { |
|
|
177 | /a/ ? ("a to be" => sub { s/a/b/g } |
|
|
178 | : () |
|
|
179 | };</pre> |
|
|
180 | </dd> |
|
|
181 | <p></p> |
|
|
182 | <dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback<hotkey> (enabled by default)</a></strong><br /> |
|
|
183 | </dt> |
|
|
184 | <dd> |
|
|
185 | Adds regex search functionality to the scrollback buffer, triggered |
|
|
186 | by a hotkey (default: <code>M-s</code>). While in search mode, normal terminal |
|
|
187 | input/output is suspended and a regex is displayed at the bottom of the |
|
|
188 | screen. |
|
|
189 | </dd> |
|
|
190 | <dd> |
|
|
191 | <p>Inputting characters appends them to the regex and continues incremental |
|
|
192 | search. <code>BackSpace</code> removes a character from the regex, <code>Up</code> and <code>Down</code> |
|
|
193 | search upwards/downwards in the scrollback buffer, <code>End</code> jumps to the |
|
|
194 | bottom. <code>Escape</code> leaves search mode and returns to the point where search |
|
|
195 | was started, while <code>Enter</code> or <code>Return</code> stay at the current position and |
|
|
196 | additionally stores the first match in the current line into the primary |
|
|
197 | selection.</p> |
|
|
198 | </dd> |
|
|
199 | <p></p> |
|
|
200 | <dt><strong><a name="item_readline">readline (enabled by default)</a></strong><br /> |
|
|
201 | </dt> |
|
|
202 | <dd> |
|
|
203 | A support package that tries to make editing with readline easier. At the |
|
|
204 | moment, it reacts to clicking with the left mouse button by trying to |
|
|
205 | move the text cursor to this position. It does so by generating as many |
|
|
206 | cursor-left or cursor-right keypresses as required (the this only works |
|
|
207 | for programs that correctly support wide characters). |
|
|
208 | </dd> |
|
|
209 | <dd> |
|
|
210 | <p>To avoid too many false positives, this is only done when:</p> |
|
|
211 | </dd> |
|
|
212 | <dl> |
|
|
213 | <dt><strong><a name="item_same">- the mouse is on the same (multi-row-) line as the text cursor.</a></strong><br /> |
|
|
214 | </dt> |
|
|
215 | <dt><strong><a name="item__2d_the_primary_screen_is_currently_being_displaye">- the primary screen is currently being displayed.</a></strong><br /> |
|
|
216 | </dt> |
|
|
217 | <dt><strong><a name="item__2d_the_text_cursor_is_visible_2e">- the text cursor is visible.</a></strong><br /> |
|
|
218 | </dt> |
|
|
219 | </dl> |
|
|
220 | <p>The normal selection mechanism isn't disabled, so quick successive clicks |
|
|
221 | might interfere with selection creation in harmless ways.</p> |
|
|
222 | <dt><strong><a name="item_selection_2dautotransform">selection-autotransform</a></strong><br /> |
|
|
223 | </dt> |
|
|
224 | <dd> |
|
|
225 | This selection allows you to do automatic transforms on a selection |
|
|
226 | whenever a selection is made. |
|
|
227 | </dd> |
|
|
228 | <dd> |
|
|
229 | <p>It works by specifying perl snippets (most useful is a single <code>s///</code> |
|
|
230 | operator) that modify <code>$_</code> as resources:</p> |
|
|
231 | </dd> |
|
|
232 | <dd> |
|
|
233 | <pre> |
|
|
234 | URxvt.selection-autotransform.0: transform |
|
|
235 | URxvt.selection-autotransform.1: transform |
|
|
236 | ...</pre> |
|
|
237 | </dd> |
|
|
238 | <dd> |
|
|
239 | <p>For example, the following will transform selections of the form |
|
|
240 | <code>filename:number</code>, often seen in compiler messages, into <code>vi +$filename |
|
|
241 | $word</code>:</p> |
|
|
242 | </dd> |
|
|
243 | <dd> |
|
|
244 | <pre> |
|
|
245 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/</pre> |
|
|
246 | </dd> |
|
|
247 | <dd> |
|
|
248 | <p>And this example matches the same,but replaces it with vi-commands you can |
|
|
249 | paste directly into your (vi :) editor:</p> |
|
|
250 | </dd> |
|
|
251 | <dd> |
|
|
252 | <pre> |
|
|
253 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/</pre> |
|
|
254 | </dd> |
|
|
255 | <dd> |
|
|
256 | <p>Of course, this can be modified to suit your needs and your editor :)</p> |
|
|
257 | </dd> |
|
|
258 | <dd> |
|
|
259 | <p>To expand the example above to typical perl error messages (``XXX at |
|
|
260 | FILENAME line YYY.''), you need a slightly more elaborate solution:</p> |
|
|
261 | </dd> |
|
|
262 | <dd> |
|
|
263 | <pre> |
|
|
264 | URxvt.selection.pattern-0: ( at .*? line \\d+[,.]) |
|
|
265 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/</pre> |
|
|
266 | </dd> |
|
|
267 | <dd> |
|
|
268 | <p>The first line tells the selection code to treat the unchanging part of |
|
|
269 | every error message as a selection pattern, and the second line transforms |
|
|
270 | the message into vi commands to load the file.</p> |
|
|
271 | </dd> |
|
|
272 | <p></p> |
|
|
273 | <dt><strong><a name="item_tabbed">tabbed</a></strong><br /> |
|
|
274 | </dt> |
|
|
275 | <dd> |
|
|
276 | This transforms the terminal into a tabbar with additional terminals, that |
|
|
277 | is, it implements what is commonly refered to as ``tabbed terminal''. The topmost line |
|
|
278 | displays a ``[NEW]'' button, which, when clicked, will add a new tab, followed by one |
|
|
279 | button per tab. |
|
|
280 | </dd> |
|
|
281 | <dd> |
|
|
282 | <p>Clicking a button will activate that tab. Pressing <strong>Shift-Left</strong> and |
|
|
283 | <strong>Shift-Right</strong> will switch to the tab left or right of the current one, |
|
|
284 | while <strong>Shift-Down</strong> creates a new tab.</p> |
| 108 | </dd> |
285 | </dd> |
| 109 | <p></p> |
286 | <p></p> |
| 110 | <dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> |
287 | <dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> |
| 111 | </dt> |
288 | </dt> |
| 112 | <dd> |
289 | <dd> |
| 113 | Uses per-line display filtering (<code>on_line_update</code>) to underline urls. |
290 | Uses per-line display filtering (<code>on_line_update</code>) to underline urls and |
|
|
291 | make them clickable. When middle-clicked, the program specified in the |
|
|
292 | resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with |
|
|
293 | the URL as first argument. |
|
|
294 | </dd> |
|
|
295 | <p></p> |
|
|
296 | <dt><strong><a name="item_automove_2dbackground">automove-background</a></strong><br /> |
|
|
297 | </dt> |
|
|
298 | <dd> |
|
|
299 | This is basically a one-line extension that dynamically changes the background pixmap offset |
|
|
300 | to the window position, in effect creating the same effect as pseudo transparency with |
|
|
301 | a custom pixmap. No scaling is supported in this mode. Exmaple: |
|
|
302 | </dd> |
|
|
303 | <dd> |
|
|
304 | <pre> |
|
|
305 | rxvt -pixmap background.xpm -pe automove-background</pre> |
| 114 | </dd> |
306 | </dd> |
| 115 | <p></p> |
307 | <p></p> |
| 116 | <dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br /> |
308 | <dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br /> |
| 117 | </dt> |
309 | </dt> |
| 118 | <dd> |
310 | <dd> |
| 119 | A not very useful example of filtering all text output to the terminal, |
311 | A not very useful example of filtering all text output to the terminal, |
| 120 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
312 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
| 121 | similar-looking ascii character. |
313 | similar-looking ascii character. |
| 122 | </dd> |
314 | </dd> |
| 123 | <p></p> |
315 | <p></p> |
|
|
316 | <dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> |
|
|
317 | </dt> |
|
|
318 | <dd> |
|
|
319 | Displays a digital clock using the built-in overlay. |
|
|
320 | </dd> |
|
|
321 | <p></p> |
| 124 | <dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> |
322 | <dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> |
| 125 | </dt> |
323 | </dt> |
| 126 | <dd> |
324 | <dd> |
| 127 | Displays a very simple digital clock in the upper right corner of the |
325 | Displays a very simple digital clock in the upper right corner of the |
| 128 | window. Illustrates overwriting the refresh callbacks to create your own |
326 | window. Illustrates overwriting the refresh callbacks to create your own |
| 129 | overlays or changes. |
327 | overlays or changes. |
| 130 | </dd> |
328 | </dd> |
|
|
329 | <p></p> |
|
|
330 | <dt><strong><a name="item_selection_2dpastebin">selection-pastebin</a></strong><br /> |
|
|
331 | </dt> |
|
|
332 | <dd> |
|
|
333 | This is a little rarely useful extension that Uploads the selection as |
|
|
334 | textfile to a remote site (or does other things). (The implementation is |
|
|
335 | not currently secure for use in a multiuser environment as it writes to |
|
|
336 | <em>/tmp</em> directly.). |
|
|
337 | </dd> |
|
|
338 | <dd> |
|
|
339 | <p>It listens to the <code>selection-pastebin:remote-pastebin</code> keyboard command, |
|
|
340 | i.e.</p> |
|
|
341 | </dd> |
|
|
342 | <dd> |
|
|
343 | <pre> |
|
|
344 | URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin</pre> |
|
|
345 | </dd> |
|
|
346 | <dd> |
|
|
347 | <p>Pressing this combination runs a command with <code>%</code> replaced by the name of |
|
|
348 | the textfile. This command can be set via a resource:</p> |
|
|
349 | </dd> |
|
|
350 | <dd> |
|
|
351 | <pre> |
|
|
352 | URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.</pre> |
|
|
353 | </dd> |
|
|
354 | <dd> |
|
|
355 | <p>And the default is likely not useful to anybody but the few people around |
|
|
356 | here :)</p> |
|
|
357 | </dd> |
|
|
358 | <dd> |
|
|
359 | <p>The name of the textfile is the hex encoded md5 sum of the selection, so |
|
|
360 | the same content should lead to the same filename.</p> |
|
|
361 | </dd> |
|
|
362 | <dd> |
|
|
363 | <p>After a successful upload the selection will be replaced by the text given |
|
|
364 | in the <code>selection-pastebin-url</code> resource (again, the % is the placeholder |
|
|
365 | for the filename):</p> |
|
|
366 | </dd> |
|
|
367 | <dd> |
|
|
368 | <pre> |
|
|
369 | URxvt.selection-pastebin.url: <a href="http://www.ta-sa.org/files/txt/%">http://www.ta-sa.org/files/txt/%</a></pre> |
|
|
370 | </dd> |
| 131 | <p></p></dl> |
371 | <p></p></dl> |
|
|
372 | <p> |
|
|
373 | </p> |
|
|
374 | <hr /> |
|
|
375 | <h1><a name="api_documentation">API DOCUMENTATION</a></h1> |
| 132 | <p> |
376 | <p> |
| 133 | </p> |
377 | </p> |
| 134 | <h2><a name="general_api_considerations">General API Considerations</a></h2> |
378 | <h2><a name="general_api_considerations">General API Considerations</a></h2> |
| 135 | <p>All objects (such as terminals, time watchers etc.) are typical |
379 | <p>All objects (such as terminals, time watchers etc.) are typical |
| 136 | reference-to-hash objects. The hash can be used to store anything you |
380 | reference-to-hash objects. The hash can be used to store anything you |
| … | |
… | |
| 146 | <dl> |
390 | <dl> |
| 147 | <dt><strong><a name="item__24text">$text</a></strong><br /> |
391 | <dt><strong><a name="item__24text">$text</a></strong><br /> |
| 148 | </dt> |
392 | </dt> |
| 149 | <dd> |
393 | <dd> |
| 150 | Rxvt-unicodes special way of encoding text, where one ``unicode'' character |
394 | Rxvt-unicodes special way of encoding text, where one ``unicode'' character |
| 151 | always represents one screen cell. See <em>row_t</em> for a discussion of this format. |
395 | always represents one screen cell. See <a href="#item_row_t">ROW_t</a> for a discussion of this format. |
| 152 | </dd> |
396 | </dd> |
| 153 | <p></p> |
397 | <p></p> |
| 154 | <dt><strong><a name="item__24string">$string</a></strong><br /> |
398 | <dt><strong><a name="item__24string">$string</a></strong><br /> |
| 155 | </dt> |
399 | </dt> |
| 156 | <dd> |
400 | <dd> |
| … | |
… | |
| 166 | locale-specific way. |
410 | locale-specific way. |
| 167 | </dd> |
411 | </dd> |
| 168 | <p></p></dl> |
412 | <p></p></dl> |
| 169 | <p> |
413 | <p> |
| 170 | </p> |
414 | </p> |
|
|
415 | <h2><a name="extension_objects">Extension Objects</a></h2> |
|
|
416 | <p>Very perl extension is a perl class. A separate perl object is created |
|
|
417 | for each terminal and each extension and passed as the first parameter to |
|
|
418 | hooks. So extensions can use their <code>$self</code> object without having to think |
|
|
419 | about other extensions, with the exception of methods and members that |
|
|
420 | begin with an underscore character <code>_</code>: these are reserved for internal |
|
|
421 | use.</p> |
|
|
422 | <p>Although it isn't a <code>urxvt::term</code> object, you can call all methods of the |
|
|
423 | <code>urxvt::term</code> class on this object.</p> |
|
|
424 | <p>It has the following methods and data members:</p> |
|
|
425 | <dl> |
|
|
426 | <dt><strong><a name="item__24urxvt_term__3d__24self_2d_3e_7bterm_7d">$urxvt_term = $self->{term}</a></strong><br /> |
|
|
427 | </dt> |
|
|
428 | <dd> |
|
|
429 | Returns the <code>urxvt::term</code> object associated with this instance of the |
|
|
430 | extension. This member <em>must not</em> be changed in any way. |
|
|
431 | </dd> |
|
|
432 | <p></p> |
|
|
433 | <dt><strong><a name="item_enable">$self->enable ($hook_name => $cb, [$hook_name => $cb..])</a></strong><br /> |
|
|
434 | </dt> |
|
|
435 | <dd> |
|
|
436 | Dynamically enable the given hooks (named without the <code>on_</code> prefix) for |
|
|
437 | this extension, replacing any previous hook. This is useful when you want |
|
|
438 | to overwrite time-critical hooks only temporarily. |
|
|
439 | </dd> |
|
|
440 | <p></p> |
|
|
441 | <dt><strong><a name="item_disable">$self->disable ($hook_name[, $hook_name..])</a></strong><br /> |
|
|
442 | </dt> |
|
|
443 | <dd> |
|
|
444 | Dynamically disable the given hooks. |
|
|
445 | </dd> |
|
|
446 | <p></p></dl> |
|
|
447 | <p> |
|
|
448 | </p> |
| 171 | <h2><a name="hooks">Hooks</a></h2> |
449 | <h2><a name="hooks">Hooks</a></h2> |
| 172 | <p>The following subroutines can be declared in extension files, and will be |
450 | <p>The following subroutines can be declared in extension files, and will be |
| 173 | called whenever the relevant event happens.</p> |
451 | called whenever the relevant event happens.</p> |
| 174 | <p>The first argument passed to them is an object private to each terminal |
452 | <p>The first argument passed to them is an extension oject as described in |
| 175 | and extension package. You can call all <code>urxvt::term</code> methods on it, but |
453 | the in the <code>Extension Objects</code> section.</p> |
| 176 | its not a real <code>urxvt::term</code> object. Instead, the real <code>urxvt::term</code> |
454 | <p><strong>All</strong> of these hooks must return a boolean value. If any of the called |
| 177 | object that is shared between all packages is stored in the <code>term</code> |
455 | hooks returns true, then the event counts as being <em>consumed</em>, and the |
| 178 | member. It is, however, blessed intot he package of the extension script, |
|
|
| 179 | so for all practical purposes you can treat an extension script as a class.</p> |
|
|
| 180 | <p>All of them must return a boolean value. If it is true, then the event |
|
|
| 181 | counts as being <em>consumed</em>, and the invocation of other hooks is skipped, |
|
|
| 182 | and the relevant action might not be carried out by the C++ code.</p> |
456 | relevant action might not be carried out by the C++ code.</p> |
| 183 | <p>When in doubt, return a false value (preferably <code>()</code>).</p> |
457 | <p><em>When in doubt, return a false value (preferably <code>()</code>). </em>></p> |
| 184 | <dl> |
458 | <dl> |
| 185 | <dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> |
459 | <dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> |
| 186 | </dt> |
460 | </dt> |
| 187 | <dd> |
461 | <dd> |
| 188 | Called after a new terminal object has been initialized, but before |
462 | Called after a new terminal object has been initialized, but before |
| 189 | windows are created or the command gets run. Most methods are unsafe to |
463 | windows are created or the command gets run. Most methods are unsafe to |
| 190 | call or deliver senseless data, as terminal size and other characteristics |
464 | call or deliver senseless data, as terminal size and other characteristics |
| 191 | have not yet been determined. You can safely query and change resources, |
465 | have not yet been determined. You can safely query and change resources |
| 192 | though. |
466 | and options, though. For many purposes the <code>on_start</code> hook is a better |
|
|
467 | place. |
|
|
468 | </dd> |
|
|
469 | <p></p> |
|
|
470 | <dt><strong><a name="item_on_start__24term">on_start $term</a></strong><br /> |
|
|
471 | </dt> |
|
|
472 | <dd> |
|
|
473 | Called at the very end of initialisation of a new terminal, just before |
|
|
474 | trying to map (display) the toplevel and returning to the mainloop. |
|
|
475 | </dd> |
|
|
476 | <p></p> |
|
|
477 | <dt><strong><a name="item_on_destroy__24term">on_destroy $term</a></strong><br /> |
|
|
478 | </dt> |
|
|
479 | <dd> |
|
|
480 | Called whenever something tries to destroy terminal, before doing anything |
|
|
481 | yet. If this hook returns true, then destruction is skipped, but this is |
|
|
482 | rarely a good idea. |
| 193 | </dd> |
483 | </dd> |
| 194 | <p></p> |
484 | <p></p> |
| 195 | <dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> |
485 | <dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> |
| 196 | </dt> |
486 | </dt> |
| 197 | <dd> |
487 | <dd> |
| 198 | Called after the screen is ``reset'' for any reason, such as resizing or |
488 | Called after the screen is ``reset'' for any reason, such as resizing or |
| 199 | control sequences. Here is where you can react on changes to size-related |
489 | control sequences. Here is where you can react on changes to size-related |
| 200 | variables. |
490 | variables. |
| 201 | </dd> |
491 | </dd> |
| 202 | <p></p> |
492 | <p></p> |
| 203 | <dt><strong><a name="item_on_start__24term">on_start $term</a></strong><br /> |
493 | <dt><strong><a name="item_on_child_start__24term_2c__24pid">on_child_start $term, $pid</a></strong><br /> |
| 204 | </dt> |
494 | </dt> |
|
|
495 | <dd> |
|
|
496 | Called just after the child process has been <code>fork</code>ed. |
| 205 | <dd> |
497 | </dd> |
| 206 | Called at the very end of initialisation of a new terminal, just before |
498 | <p></p> |
| 207 | returning to the mainloop. |
499 | <dt><strong><a name="item_on_child_exit__24term_2c__24status">on_child_exit $term, $status</a></strong><br /> |
|
|
500 | </dt> |
|
|
501 | <dd> |
|
|
502 | Called just after the child process has exited. <code>$status</code> is the status |
|
|
503 | from <code>waitpid</code>. |
| 208 | </dd> |
504 | </dd> |
| 209 | <p></p> |
505 | <p></p> |
| 210 | <dt><strong><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a></strong><br /> |
506 | <dt><strong><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a></strong><br /> |
| 211 | </dt> |
507 | </dt> |
| 212 | <dd> |
508 | <dd> |
| … | |
… | |
| 234 | </dt> |
530 | </dt> |
| 235 | <dd> |
531 | <dd> |
| 236 | Called whenever the user tries to extend the selection (e.g. with a double |
532 | Called whenever the user tries to extend the selection (e.g. with a double |
| 237 | click) and is either supposed to return false (normal operation), or |
533 | click) and is either supposed to return false (normal operation), or |
| 238 | should extend the selection itelf and return true to suppress the built-in |
534 | should extend the selection itelf and return true to suppress the built-in |
| 239 | processing. |
535 | processing. This can happen multiple times, as long as the callback |
|
|
536 | returns true, it will be called on every further click by the user and is |
|
|
537 | supposed to enlarge the selection more and more, if possible. |
| 240 | </dd> |
538 | </dd> |
| 241 | <dd> |
539 | <dd> |
| 242 | <p>See the <em>selection</em> example extension.</p> |
540 | <p>See the <em>selection</em> example extension.</p> |
| 243 | </dd> |
541 | </dd> |
| 244 | <p></p> |
542 | <p></p> |
| … | |
… | |
| 259 | </dd> |
557 | </dd> |
| 260 | <dd> |
558 | <dd> |
| 261 | <p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
559 | <p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, |
| 262 | $nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total |
560 | $nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total |
| 263 | number of lines that will be in the scrollback buffer.</p> |
561 | number of lines that will be in the scrollback buffer.</p> |
| 264 | </dd> |
|
|
| 265 | <p></p> |
|
|
| 266 | <dt><strong><a name="item_on_tty_activity__24term__2anyi_2a">on_tty_activity $term *NYI*</a></strong><br /> |
|
|
| 267 | </dt> |
|
|
| 268 | <dd> |
|
|
| 269 | Called whenever the <code>program(s)</code> running in the urxvt window send output. |
|
|
| 270 | </dd> |
562 | </dd> |
| 271 | <p></p> |
563 | <p></p> |
| 272 | <dt><strong><a name="item_on_osc_seq__24term_2c__24string">on_osc_seq $term, $string</a></strong><br /> |
564 | <dt><strong><a name="item_on_osc_seq__24term_2c__24string">on_osc_seq $term, $string</a></strong><br /> |
| 273 | </dt> |
565 | </dt> |
| 274 | <dd> |
566 | <dd> |
| … | |
… | |
| 293 | and calling <a href="#item_scr_add_lines"><code>$term->scr_add_lines</code></a> yourself. Please note that this |
585 | and calling <a href="#item_scr_add_lines"><code>$term->scr_add_lines</code></a> yourself. Please note that this |
| 294 | might be very slow, however, as your hook is called for <strong>all</strong> text being |
586 | might be very slow, however, as your hook is called for <strong>all</strong> text being |
| 295 | output. |
587 | output. |
| 296 | </dd> |
588 | </dd> |
| 297 | <p></p> |
589 | <p></p> |
|
|
590 | <dt><strong><a name="item_on_tt_write__24term_2c__24octets">on_tt_write $term, $octets</a></strong><br /> |
|
|
591 | </dt> |
|
|
592 | <dd> |
|
|
593 | Called whenever some data is written to the tty/pty and can be used to |
|
|
594 | suppress or filter tty input. |
|
|
595 | </dd> |
|
|
596 | <p></p> |
| 298 | <dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong><br /> |
597 | <dt><strong><a name="item_on_line_update__24term_2c__24row">on_line_update $term, $row</a></strong><br /> |
| 299 | </dt> |
598 | </dt> |
| 300 | <dd> |
599 | <dd> |
| 301 | Called whenever a line was updated or changed. Can be used to filter |
600 | Called whenever a line was updated or changed. Can be used to filter |
| 302 | screen output (e.g. underline urls or other useless stuff). Only lines |
601 | screen output (e.g. underline urls or other useless stuff). Only lines |
| … | |
… | |
| 334 | Called whenever the user presses a key combination that has a |
633 | Called whenever the user presses a key combination that has a |
| 335 | <code>perl:string</code> action bound to it (see description of the <strong>keysym</strong> |
634 | <code>perl:string</code> action bound to it (see description of the <strong>keysym</strong> |
| 336 | resource in the <code>rxvt(1)</code> manpage). |
635 | resource in the <code>rxvt(1)</code> manpage). |
| 337 | </dd> |
636 | </dd> |
| 338 | <p></p> |
637 | <p></p> |
|
|
638 | <dt><strong><a name="item_on_x_event__24term_2c__24event">on_x_event $term, $event</a></strong><br /> |
|
|
639 | </dt> |
|
|
640 | <dd> |
|
|
641 | Called on every X event received on the vt window (and possibly other |
|
|
642 | windows). Should only be used as a last resort. Most event structure |
|
|
643 | members are not passed. |
|
|
644 | </dd> |
|
|
645 | <p></p> |
| 339 | <dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> |
646 | <dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> |
| 340 | </dt> |
647 | </dt> |
| 341 | <dd> |
648 | <dd> |
| 342 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
649 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
| 343 | does focus in processing. |
650 | does focus in processing. |
| … | |
… | |
| 348 | <dd> |
655 | <dd> |
| 349 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
656 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
| 350 | focus out processing. |
657 | focus out processing. |
| 351 | </dd> |
658 | </dd> |
| 352 | <p></p> |
659 | <p></p> |
|
|
660 | <dt><strong><a name="item_on_configure_notify__24term_2c__24event">on_configure_notify $term, $event</a></strong><br /> |
|
|
661 | </dt> |
|
|
662 | <dt><strong><a name="item_on_property_notify__24term_2c__24event">on_property_notify $term, $event</a></strong><br /> |
|
|
663 | </dt> |
| 353 | <dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24octets">on_key_press $term, $event, $octets</a></strong><br /> |
664 | <dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a></strong><br /> |
| 354 | </dt> |
665 | </dt> |
| 355 | <dt><strong><a name="item_on_key_release__24term_2c__24event">on_key_release $term, $event</a></strong><br /> |
666 | <dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br /> |
| 356 | </dt> |
667 | </dt> |
| 357 | <dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br /> |
668 | <dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br /> |
| 358 | </dt> |
669 | </dt> |
| 359 | <dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br /> |
670 | <dt><strong><a name="item_on_button_release__24term_2c__24event">on_button_release $term, $event</a></strong><br /> |
| 360 | </dt> |
671 | </dt> |
| … | |
… | |
| 368 | Called whenever the corresponding X event is received for the terminal If |
679 | Called whenever the corresponding X event is received for the terminal If |
| 369 | the hook returns true, then the even will be ignored by rxvt-unicode. |
680 | the hook returns true, then the even will be ignored by rxvt-unicode. |
| 370 | </dd> |
681 | </dd> |
| 371 | <dd> |
682 | <dd> |
| 372 | <p>The event is a hash with most values as named by Xlib (see the XEvent |
683 | <p>The event is a hash with most values as named by Xlib (see the XEvent |
| 373 | manpage), with the additional members <code>row</code> and <code>col</code>, which are the row |
684 | manpage), with the additional members <code>row</code> and <code>col</code>, which are the |
| 374 | and column under the mouse cursor.</p> |
685 | (real, not screen-based) row and column under the mouse cursor.</p> |
| 375 | </dd> |
686 | </dd> |
| 376 | <dd> |
687 | <dd> |
| 377 | <p><code>on_key_press</code> additionally receives the string rxvt-unicode would |
688 | <p><code>on_key_press</code> additionally receives the string rxvt-unicode would |
| 378 | output, if any, in locale-specific encoding.</p> |
689 | output, if any, in locale-specific encoding.</p> |
| 379 | </dd> |
690 | </dd> |
| 380 | <dd> |
691 | <dd> |
| 381 | <p>subwindow.</p> |
692 | <p>subwindow.</p> |
| 382 | </dd> |
693 | </dd> |
|
|
694 | <p></p> |
|
|
695 | <dt><strong><a name="item_on_client_message__24term_2c__24event">on_client_message $term, $event</a></strong><br /> |
|
|
696 | </dt> |
|
|
697 | <dt><strong><a name="item_on_wm_protocols__24term_2c__24event">on_wm_protocols $term, $event</a></strong><br /> |
|
|
698 | </dt> |
|
|
699 | <dt><strong><a name="item_on_wm_delete_window__24term_2c__24event">on_wm_delete_window $term, $event</a></strong><br /> |
|
|
700 | </dt> |
|
|
701 | <dd> |
|
|
702 | Called when various types of ClientMessage events are received (all with |
|
|
703 | format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
|
|
704 | </dd> |
| 383 | <p></p></dl> |
705 | <p></p></dl> |
| 384 | <p> |
706 | <p> |
| 385 | </p> |
707 | </p> |
| 386 | <h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> |
708 | <h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> |
| 387 | <dl> |
709 | <dl> |
|
|
710 | <dt><strong><a name="item__24urxvt_3a_3alibdir">$urxvt::LIBDIR</a></strong><br /> |
|
|
711 | </dt> |
|
|
712 | <dd> |
|
|
713 | The rxvt-unicode library directory, where, among other things, the perl |
|
|
714 | modules and scripts are stored. |
|
|
715 | </dd> |
|
|
716 | <p></p> |
|
|
717 | <dt><strong><a name="item__24urxvt_3a_3aresclass_2c__24urxvt_3a_3aresclass">$urxvt::RESCLASS, $urxvt::RESCLASS</a></strong><br /> |
|
|
718 | </dt> |
|
|
719 | <dd> |
|
|
720 | The resource class and name rxvt-unicode uses to look up X resources. |
|
|
721 | </dd> |
|
|
722 | <p></p> |
|
|
723 | <dt><strong><a name="item__24urxvt_3a_3arxvtname">$urxvt::RXVTNAME</a></strong><br /> |
|
|
724 | </dt> |
|
|
725 | <dd> |
|
|
726 | The basename of the installed binaries, usually <code>urxvt</code>. |
|
|
727 | </dd> |
|
|
728 | <p></p> |
| 388 | <dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br /> |
729 | <dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br /> |
| 389 | </dt> |
730 | </dt> |
| 390 | <dd> |
731 | <dd> |
| 391 | The current terminal. This variable stores the current <code>urxvt::term</code> |
732 | The current terminal. This variable stores the current <code>urxvt::term</code> |
| 392 | object, whenever a callback/hook is executing. |
733 | object, whenever a callback/hook is executing. |
| 393 | </dd> |
734 | </dd> |
|
|
735 | <p></p> |
|
|
736 | <dt><strong><a name="item__40urxvt_3a_3aterm_init">@urxvt::TERM_INIT</a></strong><br /> |
|
|
737 | </dt> |
|
|
738 | <dd> |
|
|
739 | All coderefs in this array will be called as methods of the next newly |
|
|
740 | created <code>urxvt::term</code> object (during the <code>on_init</code> phase). The array |
|
|
741 | gets cleared before the codereferences that were in it are being executed, |
|
|
742 | so coderefs can push themselves onto it again if they so desire. |
|
|
743 | </dd> |
|
|
744 | <dd> |
|
|
745 | <p>This complements to the perl-eval commandline option, but gets executed |
|
|
746 | first.</p> |
|
|
747 | </dd> |
|
|
748 | <p></p> |
|
|
749 | <dt><strong><a name="item__40urxvt_3a_3aterm_ext">@urxvt::TERM_EXT</a></strong><br /> |
|
|
750 | </dt> |
|
|
751 | <dd> |
|
|
752 | Works similar to <code>@TERM_INIT</code>, but contains perl package/class names, which |
|
|
753 | get registered as normal extensions after calling the hooks in <code>@TERM_INIT</code> |
|
|
754 | but before other extensions. Gets cleared just like <code>@TERM_INIT</code>. |
|
|
755 | </dd> |
| 394 | <p></p></dl> |
756 | <p></p></dl> |
| 395 | <p> |
757 | <p> |
| 396 | </p> |
758 | </p> |
| 397 | <h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> |
759 | <h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> |
| 398 | <dl> |
760 | <dl> |
| 399 | <dt><strong><a name="item__24term__3d_new_urxvt__5barg_2e_2e_2e_5d">$term = new urxvt [arg...]</a></strong><br /> |
|
|
| 400 | </dt> |
|
|
| 401 | <dd> |
|
|
| 402 | Creates a new terminal, very similar as if you had started it with |
|
|
| 403 | <code>system $binfile, arg...</code>. Croaks (and probably outputs an error message) |
|
|
| 404 | if the new instance couldn't be created. Returns <code>undef</code> if the new |
|
|
| 405 | instance didn't initialise perl, and the terminal object otherwise. The |
|
|
| 406 | <code>init</code> and <a href="#item_start"><code>start</code></a> hooks will be called during the call. |
|
|
| 407 | </dd> |
|
|
| 408 | <p></p> |
|
|
| 409 | <dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br /> |
761 | <dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br /> |
| 410 | </dt> |
762 | </dt> |
| 411 | <dd> |
763 | <dd> |
| 412 | Fatally aborts execution with the given error message. Avoid at all |
764 | Fatally aborts execution with the given error message. Avoid at all |
| 413 | costs! The only time this is acceptable is when the terminal process |
765 | costs! The only time this is acceptable is when the terminal process |
| … | |
… | |
| 423 | </dd> |
775 | </dd> |
| 424 | <dd> |
776 | <dd> |
| 425 | <p>Using this function has the advantage that its output ends up in the |
777 | <p>Using this function has the advantage that its output ends up in the |
| 426 | correct place, e.g. on stderr of the connecting urxvtc client.</p> |
778 | correct place, e.g. on stderr of the connecting urxvtc client.</p> |
| 427 | </dd> |
779 | </dd> |
|
|
780 | <dd> |
|
|
781 | <p>Messages have a size limit of 1023 bytes currently.</p> |
|
|
782 | </dd> |
| 428 | <p></p> |
783 | <p></p> |
| 429 | <dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> |
784 | <dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> |
| 430 | </dt> |
785 | </dt> |
| 431 | <dd> |
786 | <dd> |
| 432 | Returns the ``current time'' (as per the event loop). |
787 | Returns the ``current time'' (as per the event loop). |
| … | |
… | |
| 436 | </dt> |
791 | </dt> |
| 437 | <dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
792 | <dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
| 438 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
793 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
| 439 | Button4Mask, Button5Mask, AnyModifier</a></strong><br /> |
794 | Button4Mask, Button5Mask, AnyModifier</a></strong><br /> |
| 440 | </dt> |
795 | </dt> |
|
|
796 | <dt><strong><a name="item_urxvt_3a_3anoeventmask_2c_keypressmask_2c_keyrelea">urxvt::NoEventMask, KeyPressMask, KeyReleaseMask, |
|
|
797 | ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, |
|
|
798 | PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask, |
|
|
799 | Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask, |
|
|
800 | KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask, |
|
|
801 | ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask, |
|
|
802 | FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask</a></strong><br /> |
|
|
803 | </dt> |
|
|
804 | <dt><strong><a name="item_urxvt_3a_3akeypress_2c_keyrelease_2c_buttonpress_2">urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify, |
|
|
805 | EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose, |
|
|
806 | GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify, |
|
|
807 | UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify, |
|
|
808 | ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify, |
|
|
809 | CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, |
|
|
810 | SelectionNotify, ColormapNotify, ClientMessage, MappingNotify</a></strong><br /> |
|
|
811 | </dt> |
| 441 | <dd> |
812 | <dd> |
| 442 | Various constants for use in X events. |
813 | Various constants for use in X calls and event processing. |
| 443 | </dd> |
814 | </dd> |
| 444 | <p></p></dl> |
815 | <p></p></dl> |
| 445 | <p> |
816 | <p> |
| 446 | </p> |
817 | </p> |
| 447 | <h2><a name="rendition">RENDITION</a></h2> |
818 | <h2><a name="rendition">RENDITION</a></h2> |
| … | |
… | |
| 479 | </dt> |
850 | </dt> |
| 480 | <dd> |
851 | <dd> |
| 481 | Return the foreground/background colour index, respectively. |
852 | Return the foreground/background colour index, respectively. |
| 482 | </dd> |
853 | </dd> |
| 483 | <p></p> |
854 | <p></p> |
| 484 | <dt><strong><a name="item_set_fgcolor">$rend = urxvt::SET_FGCOLOR ($rend, $new_colour)</a></strong><br /> |
855 | <dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_fgcolor__24rend_2c__24n">$rend = urxvt::SET_FGCOLOR $rend, $new_colour</a></strong><br /> |
| 485 | </dt> |
856 | </dt> |
| 486 | <dt><strong><a name="item_set_bgcolor">$rend = urxvt::SET_BGCOLOR ($rend, $new_colour)</a></strong><br /> |
857 | <dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_bgcolor__24rend_2c__24n">$rend = urxvt::SET_BGCOLOR $rend, $new_colour</a></strong><br /> |
| 487 | </dt> |
858 | </dt> |
| 488 | <dd> |
859 | <dd> |
| 489 | Replace the foreground/background colour in the rendition mask with the |
860 | Replace the foreground/background colour in the rendition mask with the |
| 490 | specified one. |
861 | specified one. |
| 491 | </dd> |
862 | </dd> |
| 492 | <p></p> |
863 | <p></p> |
| 493 | <dt><strong><a name="item_get_custom">$value = urxvt::GET_CUSTOM ($rend)</a></strong><br /> |
864 | <dt><strong><a name="item__24value__3d_urxvt_3a_3aget_custom__24rend">$value = urxvt::GET_CUSTOM $rend</a></strong><br /> |
| 494 | </dt> |
865 | </dt> |
| 495 | <dd> |
866 | <dd> |
| 496 | Return the ``custom'' value: Every rendition has 5 bits for use by |
867 | Return the ``custom'' value: Every rendition has 5 bits for use by |
| 497 | extensions. They can be set and changed as you like and are initially |
868 | extensions. They can be set and changed as you like and are initially |
| 498 | zero. |
869 | zero. |
| 499 | </dd> |
870 | </dd> |
| 500 | <p></p> |
871 | <p></p> |
| 501 | <dt><strong><a name="item_set_custom">$rend = urxvt::SET_CUSTOM ($rend, $new_value)</a></strong><br /> |
872 | <dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_custom__24rend_2c__24ne">$rend = urxvt::SET_CUSTOM $rend, $new_value</a></strong><br /> |
| 502 | </dt> |
873 | </dt> |
| 503 | <dd> |
874 | <dd> |
| 504 | Change the custom value. |
875 | Change the custom value. |
| 505 | </dd> |
876 | </dd> |
| 506 | <p></p></dl> |
877 | <p></p></dl> |
|
|
878 | <p> |
|
|
879 | </p> |
|
|
880 | <h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2> |
|
|
881 | <p>The sole purpose of this class is to deliver an interface to the |
|
|
882 | <code>AnyEvent</code> module - any module using it will work inside urxvt without |
|
|
883 | further programming. The only exception is that you cannot wait on |
|
|
884 | condition variables, but non-blocking condvar use is ok. What this means |
|
|
885 | is that you cannot use blocking APIs, but the non-blocking variant should |
|
|
886 | work.</p> |
| 507 | <p> |
887 | <p> |
| 508 | </p> |
888 | </p> |
| 509 | <h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> |
889 | <h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> |
| 510 | <dl> |
890 | <dl> |
|
|
891 | <dt><strong><a name="item__24term__3d_new_urxvt_3a_3aterm__24envhashref_2c__">$term = new urxvt::term $envhashref, $rxvtname, [arg...]</a></strong><br /> |
|
|
892 | </dt> |
|
|
893 | <dd> |
|
|
894 | Creates a new terminal, very similar as if you had started it with system |
|
|
895 | <code>$rxvtname, arg...</code>. <code>$envhashref</code> must be a reference to a <code>%ENV</code>-like |
|
|
896 | hash which defines the environment of the new terminal. |
|
|
897 | </dd> |
|
|
898 | <dd> |
|
|
899 | <p>Croaks (and probably outputs an error message) if the new instance |
|
|
900 | couldn't be created. Returns <code>undef</code> if the new instance didn't |
|
|
901 | initialise perl, and the terminal object otherwise. The <code>init</code> and |
|
|
902 | <a href="#item_start"><code>start</code></a> hooks will be called during this call.</p> |
|
|
903 | </dd> |
|
|
904 | <p></p> |
| 511 | <dt><strong><a name="item_destroy">$term->destroy</a></strong><br /> |
905 | <dt><strong><a name="item_destroy">$term->destroy</a></strong><br /> |
| 512 | </dt> |
906 | </dt> |
| 513 | <dd> |
907 | <dd> |
| 514 | Destroy the terminal object (close the window, free resources etc.). |
908 | Destroy the terminal object (close the window, free resources |
|
|
909 | etc.). Please note that rxvt will not exit as long as any event |
|
|
910 | watchers (timers, io watchers) are still active. |
|
|
911 | </dd> |
|
|
912 | <p></p> |
|
|
913 | <dt><strong><a name="item_exec_async">$term->exec_async ($cmd[, @args])</a></strong><br /> |
|
|
914 | </dt> |
|
|
915 | <dd> |
|
|
916 | Works like the combination of the <code>fork</code>/<code>exec</code> builtins, which executes |
|
|
917 | (``starts'') programs in the background. This function takes care of setting |
|
|
918 | the user environment before exec'ing the command (e.g. <code>PATH</code>) and should |
|
|
919 | be preferred over explicit calls to <code>exec</code> or <code>system</code>. |
|
|
920 | </dd> |
|
|
921 | <dd> |
|
|
922 | <p>Returns the pid of the subprocess or <code>undef</code> on error.</p> |
| 515 | </dd> |
923 | </dd> |
| 516 | <p></p> |
924 | <p></p> |
| 517 | <dt><strong><a name="item_option">$isset = $term->option ($optval[, $set])</a></strong><br /> |
925 | <dt><strong><a name="item_option">$isset = $term->option ($optval[, $set])</a></strong><br /> |
| 518 | </dt> |
926 | </dt> |
| 519 | <dd> |
927 | <dd> |
| … | |
… | |
| 527 | </dd> |
935 | </dd> |
| 528 | <dd> |
936 | <dd> |
| 529 | <pre> |
937 | <pre> |
| 530 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
938 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
| 531 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
939 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
| 532 | pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating |
940 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
| 533 | scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer |
941 | scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput |
| 534 | secondaryScreen secondaryScroll skipBuiltinGlyphs transparent |
942 | scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs |
| 535 | tripleclickwords utmpInhibit visualBell</pre> |
943 | transparent tripleclickwords utmpInhibit visualBell</pre> |
| 536 | </dd> |
944 | </dd> |
| 537 | <p></p> |
945 | <p></p> |
| 538 | <dt><strong><a name="item_resource">$value = $term->resource ($name[, $newval])</a></strong><br /> |
946 | <dt><strong><a name="item_resource">$value = $term->resource ($name[, $newval])</a></strong><br /> |
| 539 | </dt> |
947 | </dt> |
| 540 | <dd> |
948 | <dd> |
| … | |
… | |
| 565 | <pre> |
973 | <pre> |
| 566 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
974 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
| 567 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
975 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
| 568 | display_name embed ext_bwidth fade font geometry hold iconName |
976 | display_name embed ext_bwidth fade font geometry hold iconName |
| 569 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
977 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
| 570 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
978 | italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier |
| 571 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 |
979 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
| 572 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
980 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
| 573 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
981 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
| 574 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
982 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
| 575 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
983 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
| 576 | shade term_name title transparent transparent_all tripleclickwords |
984 | secondaryScreen secondaryScroll selectstyle shade term_name title |
|
|
985 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
| 577 | utmpInhibit visualBell</pre> |
986 | visualBell</pre> |
|
|
987 | </dd> |
|
|
988 | <p></p> |
|
|
989 | <dt><strong><a name="item_x_resource">$value = $term->x_resource ($pattern)</a></strong><br /> |
|
|
990 | </dt> |
|
|
991 | <dd> |
|
|
992 | Returns the X-Resource for the given pattern, excluding the program or |
|
|
993 | class name, i.e. <a href="#item_x_resource"><code>$term->x_resource ("boldFont")</code></a> should return the |
|
|
994 | same value as used by this instance of rxvt-unicode. Returns <code>undef</code> if no |
|
|
995 | resource with that pattern exists. |
|
|
996 | </dd> |
|
|
997 | <dd> |
|
|
998 | <p>This method should only be called during the <code>on_start</code> hook, as there is |
|
|
999 | only one resource database per display, and later invocations might return |
|
|
1000 | the wrong resources.</p> |
|
|
1001 | </dd> |
|
|
1002 | <p></p> |
|
|
1003 | <dt><strong><a name="item_parse_keysym">$success = $term->parse_keysym ($keysym_spec, $command_string)</a></strong><br /> |
|
|
1004 | </dt> |
|
|
1005 | <dd> |
|
|
1006 | Adds a keymap translation exactly as specified via a resource. See the |
|
|
1007 | <code>keysym</code> resource in the <code>rxvt(1)</code> manpage. |
| 578 | </dd> |
1008 | </dd> |
| 579 | <p></p> |
1009 | <p></p> |
| 580 | <dt><strong><a name="item_rstyle">$rend = $term->rstyle ([$new_rstyle])</a></strong><br /> |
1010 | <dt><strong><a name="item_rstyle">$rend = $term->rstyle ([$new_rstyle])</a></strong><br /> |
| 581 | </dt> |
1011 | </dt> |
| 582 | <dd> |
1012 | <dd> |
| … | |
… | |
| 600 | <dd> |
1030 | <dd> |
| 601 | Return the current values of the selection mark, begin or end positions, |
1031 | Return the current values of the selection mark, begin or end positions, |
| 602 | and optionally set them to new values. |
1032 | and optionally set them to new values. |
| 603 | </dd> |
1033 | </dd> |
| 604 | <p></p> |
1034 | <p></p> |
|
|
1035 | <dt><strong><a name="item_selection_make">$term->selection_make ($eventtime[, $rectangular])</a></strong><br /> |
|
|
1036 | </dt> |
|
|
1037 | <dd> |
|
|
1038 | Tries to make a selection as set by <a href="#item_selection_beg"><code>selection_beg</code></a> and |
|
|
1039 | <a href="#item_selection_end"><code>selection_end</code></a>. If <code>$rectangular</code> is true (default: false), a |
|
|
1040 | rectangular selection will be made. This is the prefered function to make |
|
|
1041 | a selection. |
|
|
1042 | </dd> |
|
|
1043 | <p></p> |
| 605 | <dt><strong><a name="item_selection_grab">$success = $term->selection_grab ($eventtime)</a></strong><br /> |
1044 | <dt><strong><a name="item_selection_grab">$success = $term->selection_grab ($eventtime)</a></strong><br /> |
| 606 | </dt> |
1045 | </dt> |
| 607 | <dd> |
1046 | <dd> |
| 608 | Try to request the primary selection from the server (for example, as set |
1047 | Try to request the primary selection text from the server (for example, as |
| 609 | by the next method). |
1048 | set by the next method). No visual feedback will be given. This function |
|
|
1049 | is mostly useful from within <code>on_sel_grab</code> hooks. |
| 610 | </dd> |
1050 | </dd> |
| 611 | <p></p> |
1051 | <p></p> |
| 612 | <dt><strong>$oldtext = $term->selection ([$newtext])</strong><br /> |
1052 | <dt><strong>$oldtext = $term->selection ([$newtext])</strong><br /> |
| 613 | </dt> |
1053 | </dt> |
| 614 | <dd> |
1054 | <dd> |
| 615 | Return the current selection text and optionally replace it by <code>$newtext</code>. |
1055 | Return the current selection text and optionally replace it by <code>$newtext</code>. |
| 616 | </dd> |
1056 | </dd> |
|
|
1057 | <p></p> |
|
|
1058 | <dt><strong><a name="item_overlay_simple">$term->overlay_simple ($x, $y, $text)</a></strong><br /> |
|
|
1059 | </dt> |
| 617 | <dd> |
1060 | <dd> |
| 618 | <p>#=item $term->overlay ($x, $y, $text) |
|
|
| 619 | # |
|
|
| 620 | #Create a simple multi-line overlay box. See the next method for details. |
1061 | Create a simple multi-line overlay box. See the next method for details. |
| 621 | # |
|
|
| 622 | #=cut |
|
|
| 623 | # |
|
|
| 624 | #sub urxvt::term::scr_overlay { |
|
|
| 625 | # my ($self, $x, $y, $text) = @_; |
|
|
| 626 | # |
|
|
| 627 | # my @lines = split /\n/, $text; |
|
|
| 628 | # |
|
|
| 629 | # my $w = 0; |
|
|
| 630 | # for (map $self->strwidth ($_), @lines) { |
|
|
| 631 | # $w = $_ if $w < $_; |
|
|
| 632 | # } |
|
|
| 633 | # |
|
|
| 634 | # $self->scr_overlay_new ($x, $y, $w, scalar @lines); |
|
|
| 635 | # $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; |
|
|
| 636 | #}</p> |
|
|
| 637 | </dd> |
1062 | </dd> |
| 638 | <p></p> |
1063 | <p></p> |
| 639 | <dt><strong><a name="item_overlay">$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br /> |
1064 | <dt><strong><a name="item_overlay">$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])</a></strong><br /> |
| 640 | </dt> |
1065 | </dt> |
| 641 | <dd> |
1066 | <dd> |
| … | |
… | |
| 677 | </dt> |
1102 | </dt> |
| 678 | <dd> |
1103 | <dd> |
| 679 | If hidden, display the overlay again. |
1104 | If hidden, display the overlay again. |
| 680 | </dd> |
1105 | </dd> |
| 681 | <p></p></dl> |
1106 | <p></p></dl> |
| 682 | <dt><strong><a name="item_popup">$popup = $term->popup ($event)</a></strong><br /> |
1107 | <dt><strong>$popup = $term->popup ($event)</strong><br /> |
| 683 | </dt> |
1108 | </dt> |
| 684 | <dd> |
1109 | <dd> |
| 685 | Creates a new <code>urxvt::popup</code> object that implements a popup menu. The |
1110 | Creates a new <code>urxvt::popup</code> object that implements a popup menu. The |
| 686 | <code>$event</code> <em>must</em> be the event causing the menu to pop up (a button event, |
1111 | <code>$event</code> <em>must</em> be the event causing the menu to pop up (a button event, |
| 687 | currently). |
1112 | currently). |
| … | |
… | |
| 702 | <p></p> |
1127 | <p></p> |
| 703 | <dt><strong><a name="item_locale_decode">$string = $term->locale_decode ($octets)</a></strong><br /> |
1128 | <dt><strong><a name="item_locale_decode">$string = $term->locale_decode ($octets)</a></strong><br /> |
| 704 | </dt> |
1129 | </dt> |
| 705 | <dd> |
1130 | <dd> |
| 706 | Convert the given locale-encoded octets into a perl string. |
1131 | Convert the given locale-encoded octets into a perl string. |
|
|
1132 | </dd> |
|
|
1133 | <p></p> |
|
|
1134 | <dt><strong><a name="item_scr_xor_span">$term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])</a></strong><br /> |
|
|
1135 | </dt> |
|
|
1136 | <dd> |
|
|
1137 | XORs the rendition values in the given span with the provided value |
|
|
1138 | (default: <code>RS_RVid</code>), which <em>MUST NOT</em> contain font styles. Useful in |
|
|
1139 | refresh hooks to provide effects similar to the selection. |
|
|
1140 | </dd> |
|
|
1141 | <p></p> |
|
|
1142 | <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 /> |
|
|
1143 | </dt> |
|
|
1144 | <dd> |
|
|
1145 | Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing |
|
|
1146 | whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults |
|
|
1147 | to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines |
|
|
1148 | it instead. Both styles <em>MUST NOT</em> contain font styles. |
|
|
1149 | </dd> |
|
|
1150 | <p></p> |
|
|
1151 | <dt><strong><a name="item_scr_bell">$term->scr_bell</a></strong><br /> |
|
|
1152 | </dt> |
|
|
1153 | <dd> |
|
|
1154 | Ring the bell! |
| 707 | </dd> |
1155 | </dd> |
| 708 | <p></p> |
1156 | <p></p> |
| 709 | <dt><strong><a name="item_scr_add_lines">$term->scr_add_lines ($string)</a></strong><br /> |
1157 | <dt><strong><a name="item_scr_add_lines">$term->scr_add_lines ($string)</a></strong><br /> |
| 710 | </dt> |
1158 | </dt> |
| 711 | <dd> |
1159 | <dd> |
| … | |
… | |
| 718 | <p>Normally its not a good idea to use this function, as programs might be |
1166 | <p>Normally its not a good idea to use this function, as programs might be |
| 719 | confused by changes in cursor position or scrolling. Its useful inside a |
1167 | confused by changes in cursor position or scrolling. Its useful inside a |
| 720 | <code>on_add_lines</code> hook, though.</p> |
1168 | <code>on_add_lines</code> hook, though.</p> |
| 721 | </dd> |
1169 | </dd> |
| 722 | <p></p> |
1170 | <p></p> |
|
|
1171 | <dt><strong><a name="item_scr_change_screen">$term->scr_change_screen ($screen)</a></strong><br /> |
|
|
1172 | </dt> |
|
|
1173 | <dd> |
|
|
1174 | Switch to given screen - 0 primary, 1 secondary. |
|
|
1175 | </dd> |
|
|
1176 | <p></p> |
| 723 | <dt><strong><a name="item_cmd_parse">$term->cmd_parse ($octets)</a></strong><br /> |
1177 | <dt><strong><a name="item_cmd_parse">$term->cmd_parse ($octets)</a></strong><br /> |
| 724 | </dt> |
1178 | </dt> |
| 725 | <dd> |
1179 | <dd> |
| 726 | Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the |
1180 | Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the |
| 727 | locale-specific encoding of the terminal and can contain command sequences |
1181 | locale-specific encoding of the terminal and can contain command sequences |
| … | |
… | |
| 734 | Write the octets given in <code>$data</code> to the tty (i.e. as program input). To |
1188 | Write the octets given in <code>$data</code> to the tty (i.e. as program input). To |
| 735 | pass characters instead of octets, you should convert your strings first |
1189 | pass characters instead of octets, you should convert your strings first |
| 736 | to the locale-specific encoding using <a href="#item_locale_encode"><code>$term->locale_encode</code></a>. |
1190 | to the locale-specific encoding using <a href="#item_locale_encode"><code>$term->locale_encode</code></a>. |
| 737 | </dd> |
1191 | </dd> |
| 738 | <p></p> |
1192 | <p></p> |
|
|
1193 | <dt><strong><a name="item_pty_ev_events">$old_events = $term->pty_ev_events ([$new_events])</a></strong><br /> |
|
|
1194 | </dt> |
|
|
1195 | <dd> |
|
|
1196 | Replaces the event mask of the pty watcher by the given event mask. Can |
|
|
1197 | be used to suppress input and output handling to the pty/tty. See the |
|
|
1198 | description of <a href="#item_events"><code>urxvt::timer->events</code></a>. Make sure to always restore |
|
|
1199 | the previous value. |
|
|
1200 | </dd> |
|
|
1201 | <p></p> |
| 739 | <dt><strong><a name="item_parent">$windowid = $term->parent</a></strong><br /> |
1202 | <dt><strong><a name="item_parent">$windowid = $term->parent</a></strong><br /> |
| 740 | </dt> |
1203 | </dt> |
| 741 | <dd> |
1204 | <dd> |
| 742 | Return the window id of the toplevel window. |
1205 | Return the window id of the toplevel window. |
| 743 | </dd> |
1206 | </dd> |
| … | |
… | |
| 746 | </dt> |
1209 | </dt> |
| 747 | <dd> |
1210 | <dd> |
| 748 | Return the window id of the terminal window. |
1211 | Return the window id of the terminal window. |
| 749 | </dd> |
1212 | </dd> |
| 750 | <p></p> |
1213 | <p></p> |
|
|
1214 | <dt><strong><a name="item_vt_emask_add">$term->vt_emask_add ($x_event_mask)</a></strong><br /> |
|
|
1215 | </dt> |
|
|
1216 | <dd> |
|
|
1217 | Adds the specified events to the vt event mask. Useful e.g. when you want |
|
|
1218 | to receive pointer events all the times: |
|
|
1219 | </dd> |
|
|
1220 | <dd> |
|
|
1221 | <pre> |
|
|
1222 | $term->vt_emask_add (urxvt::PointerMotionMask);</pre> |
|
|
1223 | </dd> |
|
|
1224 | <p></p> |
| 751 | <dt><strong><a name="item_width">$window_width = $term->width</a></strong><br /> |
1225 | <dt><strong><a name="item_width">$window_width = $term->width</a></strong><br /> |
| 752 | </dt> |
1226 | </dt> |
| 753 | <dt><strong><a name="item_height">$window_height = $term->height</a></strong><br /> |
1227 | <dt><strong><a name="item_height">$window_height = $term->height</a></strong><br /> |
| 754 | </dt> |
1228 | </dt> |
| 755 | <dt><strong><a name="item_fwidth">$font_width = $term->fwidth</a></strong><br /> |
1229 | <dt><strong><a name="item_fwidth">$font_width = $term->fwidth</a></strong><br /> |
| … | |
… | |
| 768 | </dt> |
1242 | </dt> |
| 769 | <dt><strong><a name="item_savelines">$max_scrollback = $term->saveLines</a></strong><br /> |
1243 | <dt><strong><a name="item_savelines">$max_scrollback = $term->saveLines</a></strong><br /> |
| 770 | </dt> |
1244 | </dt> |
| 771 | <dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term->total_rows</a></strong><br /> |
1245 | <dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term->total_rows</a></strong><br /> |
| 772 | </dt> |
1246 | </dt> |
| 773 | <dt><strong><a name="item_nsaved">$lines_in_scrollback = $term->nsaved</a></strong><br /> |
1247 | <dt><strong><a name="item_top_row">$topmost_scrollback_row = $term->top_row</a></strong><br /> |
| 774 | </dt> |
1248 | </dt> |
| 775 | <dd> |
1249 | <dd> |
| 776 | Return various integers describing terminal characteristics. |
1250 | Return various integers describing terminal characteristics. |
|
|
1251 | </dd> |
|
|
1252 | <p></p> |
|
|
1253 | <dt><strong><a name="item_display_id">$x_display = $term->display_id</a></strong><br /> |
|
|
1254 | </dt> |
|
|
1255 | <dd> |
|
|
1256 | Return the DISPLAY used by rxvt-unicode. |
|
|
1257 | </dd> |
|
|
1258 | <p></p> |
|
|
1259 | <dt><strong><a name="item_locale">$lc_ctype = $term->locale</a></strong><br /> |
|
|
1260 | </dt> |
|
|
1261 | <dd> |
|
|
1262 | Returns the LC_CTYPE category string used by this rxvt-unicode. |
|
|
1263 | </dd> |
|
|
1264 | <p></p> |
|
|
1265 | <dt><strong><a name="item_env">$env = $term->env</a></strong><br /> |
|
|
1266 | </dt> |
|
|
1267 | <dd> |
|
|
1268 | Returns a copy of the environment in effect for the terminal as a hashref |
|
|
1269 | similar to <code>\%ENV</code>. |
| 777 | </dd> |
1270 | </dd> |
| 778 | <p></p> |
1271 | <p></p> |
| 779 | <dt><strong><a name="item_modlevel3mask">$modifiermask = $term->ModLevel3Mask</a></strong><br /> |
1272 | <dt><strong><a name="item_modlevel3mask">$modifiermask = $term->ModLevel3Mask</a></strong><br /> |
| 780 | </dt> |
1273 | </dt> |
| 781 | <dt><strong><a name="item_modmetamask">$modifiermask = $term->ModMetaMask</a></strong><br /> |
1274 | <dt><strong><a name="item_modmetamask">$modifiermask = $term->ModMetaMask</a></strong><br /> |
| … | |
… | |
| 785 | <dd> |
1278 | <dd> |
| 786 | Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often |
1279 | Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often |
| 787 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1280 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
| 788 | </dd> |
1281 | </dd> |
| 789 | <p></p> |
1282 | <p></p> |
|
|
1283 | <dt><strong><a name="item_current_screen">$screen = $term->current_screen</a></strong><br /> |
|
|
1284 | </dt> |
|
|
1285 | <dd> |
|
|
1286 | Returns the currently displayed screen (0 primary, 1 secondary). |
|
|
1287 | </dd> |
|
|
1288 | <p></p> |
|
|
1289 | <dt><strong><a name="item_hidden_cursor">$cursor_is_hidden = $term->hidden_cursor</a></strong><br /> |
|
|
1290 | </dt> |
|
|
1291 | <dd> |
|
|
1292 | Returns wether the cursor is currently hidden or not. |
|
|
1293 | </dd> |
|
|
1294 | <p></p> |
| 790 | <dt><strong><a name="item_view_start">$view_start = $term->view_start ([$newvalue])</a></strong><br /> |
1295 | <dt><strong><a name="item_view_start">$view_start = $term->view_start ([$newvalue])</a></strong><br /> |
| 791 | </dt> |
1296 | </dt> |
| 792 | <dd> |
1297 | <dd> |
| 793 | Returns the negative row number of the topmost line. Minimum value is |
1298 | Returns the row number of the topmost displayed line. Maximum value is |
| 794 | <code>0</code>, which displays the normal terminal contents. Larger values scroll |
1299 | <code>0</code>, which displays the normal terminal contents. Lower values scroll |
| 795 | this many lines into the scrollback buffer. |
1300 | this many lines into the scrollback buffer. |
| 796 | </dd> |
1301 | </dd> |
| 797 | <p></p> |
1302 | <p></p> |
| 798 | <dt><strong><a name="item_want_refresh">$term->want_refresh</a></strong><br /> |
1303 | <dt><strong><a name="item_want_refresh">$term->want_refresh</a></strong><br /> |
| 799 | </dt> |
1304 | </dt> |
| … | |
… | |
| 810 | </dt> |
1315 | </dt> |
| 811 | <dd> |
1316 | <dd> |
| 812 | Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code> |
1317 | Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code> |
| 813 | is the topmost terminal line, row <code>$term->$ncol-1</code> is the bottommost |
1318 | is the topmost terminal line, row <code>$term->$ncol-1</code> is the bottommost |
| 814 | terminal line. The scrollback buffer starts at line <code>-1</code> and extends to |
1319 | terminal line. The scrollback buffer starts at line <code>-1</code> and extends to |
| 815 | line <a href="#item_nsaved"><code>-$term->nsaved</code></a>. Nothing will be returned if a nonexistent line |
1320 | line <code>-$term->nsaved</code>. Nothing will be returned if a nonexistent line |
| 816 | is requested. |
1321 | is requested. |
| 817 | </dd> |
1322 | </dd> |
| 818 | <dd> |
1323 | <dd> |
| 819 | <p>If <code>$new_text</code> is specified, it will replace characters in the current |
1324 | <p>If <code>$new_text</code> is specified, it will replace characters in the current |
| 820 | line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful |
1325 | line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful |
| 821 | to replace only parts of a line. The font index in the rendition will |
1326 | to replace only parts of a line. The font index in the rendition will |
| 822 | automatically be updated.</p> |
1327 | automatically be updated.</p> |
| 823 | </dd> |
1328 | </dd> |
| 824 | <dd> |
1329 | <dd> |
| 825 | <p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more |
1330 | <p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use |
| 826 | than one cell when displayed are padded with urxvt::NOCHAR characters |
1331 | more than one cell when displayed are padded with <code>$urxvt::NOCHAR</code> |
| 827 | (<code>chr 65535</code>). Characters with combining characters and other characters |
1332 | characters. Characters with combining characters and other characters that |
| 828 | that do not fit into the normal tetx encoding will be replaced with |
1333 | do not fit into the normal tetx encoding will be replaced with characters |
| 829 | characters in the private use area.</p> |
1334 | in the private use area.</p> |
| 830 | </dd> |
1335 | </dd> |
| 831 | <dd> |
1336 | <dd> |
| 832 | <p>You have to obey this encoding when changing text. The advantage is |
1337 | <p>You have to obey this encoding when changing text. The advantage is |
| 833 | that <code>substr</code> and similar functions work on screen cells and not on |
1338 | that <code>substr</code> and similar functions work on screen cells and not on |
| 834 | characters.</p> |
1339 | characters.</p> |
| 835 | </dd> |
1340 | </dd> |
| 836 | <dd> |
1341 | <dd> |
| 837 | <p>The methods <code>$term->special_encode</code> and <a href="#item_special_decode"><code>$term->special_decode</code></a> |
1342 | <p>The methods <a href="#item_special_encode"><code>$term->special_encode</code></a> and <a href="#item_special_decode"><code>$term->special_decode</code></a> |
| 838 | can be used to convert normal strings into this encoding and vice versa.</p> |
1343 | can be used to convert normal strings into this encoding and vice versa.</p> |
| 839 | </dd> |
1344 | </dd> |
| 840 | <p></p> |
1345 | <p></p> |
| 841 | <dt><strong><a name="item_row_r">$rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br /> |
1346 | <dt><strong><a name="item_row_r">$rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])</a></strong><br /> |
| 842 | </dt> |
1347 | </dt> |
| … | |
… | |
| 905 | <p></p> |
1410 | <p></p> |
| 906 | <dt><strong><a name="item_offset_of">$offset = $line->offset_of ($row, $col)</a></strong><br /> |
1411 | <dt><strong><a name="item_offset_of">$offset = $line->offset_of ($row, $col)</a></strong><br /> |
| 907 | </dt> |
1412 | </dt> |
| 908 | <dd> |
1413 | <dd> |
| 909 | Returns the character offset of the given row|col pair within the logical |
1414 | Returns the character offset of the given row|col pair within the logical |
| 910 | line. |
1415 | line. Works for rows outside the line, too, and returns corresponding |
|
|
1416 | offsets outside the string. |
| 911 | </dd> |
1417 | </dd> |
| 912 | <p></p> |
1418 | <p></p> |
| 913 | <dt><strong><a name="item_coord_of">($row, $col) = $line->coord_of ($offset)</a></strong><br /> |
1419 | <dt><strong><a name="item_coord_of">($row, $col) = $line->coord_of ($offset)</a></strong><br /> |
| 914 | </dt> |
1420 | </dt> |
| 915 | <dd> |
1421 | <dd> |
| 916 | Translates a string offset into terminal coordinates again. |
1422 | Translates a string offset into terminal coordinates again. |
| 917 | </dd> |
1423 | </dd> |
| 918 | <p></p></dl> |
1424 | <p></p></dl> |
| 919 | <dt><strong>($row, $col) = $line->coord_of ($offset) |
1425 | <dt><strong><a name="item_special_encode">$text = $term->special_encode $string</a></strong><br /> |
| 920 | =item $text = $term->special_encode $string</strong><br /> |
|
|
| 921 | </dt> |
1426 | </dt> |
| 922 | <dd> |
1427 | <dd> |
| 923 | Converts a perl string into the special encoding used by rxvt-unicode, |
1428 | Converts a perl string into the special encoding used by rxvt-unicode, |
| 924 | where one character corresponds to one screen cell. See |
1429 | where one character corresponds to one screen cell. See |
| 925 | <a href="#item_row_t"><code>$term->ROW_t</code></a> for details. |
1430 | <a href="#item_row_t"><code>$term->ROW_t</code></a> for details. |
| … | |
… | |
| 929 | </dt> |
1434 | </dt> |
| 930 | <dd> |
1435 | <dd> |
| 931 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1436 | Converts rxvt-unicodes text reprsentation into a perl string. See |
| 932 | <a href="#item_row_t"><code>$term->ROW_t</code></a> for details. |
1437 | <a href="#item_row_t"><code>$term->ROW_t</code></a> for details. |
| 933 | </dd> |
1438 | </dd> |
|
|
1439 | <p></p> |
|
|
1440 | <dt><strong><a name="item_grab_button">$success = $term->grab_button ($button, $modifiermask)</a></strong><br /> |
|
|
1441 | </dt> |
|
|
1442 | <dd> |
|
|
1443 | Registers a synchronous button grab. See the XGrabButton manpage. |
|
|
1444 | </dd> |
|
|
1445 | <p></p> |
|
|
1446 | <dt><strong><a name="item_grab">$success = $term->grab ($eventtime[, $sync])</a></strong><br /> |
|
|
1447 | </dt> |
|
|
1448 | <dd> |
|
|
1449 | Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or |
|
|
1450 | synchronous (<code>$sync</code> is true). Also remembers the grab timestampe. |
|
|
1451 | </dd> |
|
|
1452 | <p></p> |
|
|
1453 | <dt><strong><a name="item_allow_events_async">$term->allow_events_async</a></strong><br /> |
|
|
1454 | </dt> |
|
|
1455 | <dd> |
|
|
1456 | Calls XAllowEvents with AsyncBoth for the most recent grab. |
|
|
1457 | </dd> |
|
|
1458 | <p></p> |
|
|
1459 | <dt><strong><a name="item_allow_events_sync">$term->allow_events_sync</a></strong><br /> |
|
|
1460 | </dt> |
|
|
1461 | <dd> |
|
|
1462 | Calls XAllowEvents with SyncBoth for the most recent grab. |
|
|
1463 | </dd> |
|
|
1464 | <p></p> |
|
|
1465 | <dt><strong><a name="item_allow_events_replay">$term->allow_events_replay</a></strong><br /> |
|
|
1466 | </dt> |
|
|
1467 | <dd> |
|
|
1468 | Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most |
|
|
1469 | recent grab. |
|
|
1470 | </dd> |
|
|
1471 | <p></p> |
|
|
1472 | <dt><strong><a name="item_ungrab">$term->ungrab</a></strong><br /> |
|
|
1473 | </dt> |
|
|
1474 | <dd> |
|
|
1475 | Calls XUngrab for the most recent grab. Is called automatically on |
|
|
1476 | evaluation errors, as it is better to lose the grab in the error case as |
|
|
1477 | the session. |
|
|
1478 | </dd> |
|
|
1479 | <p></p> |
|
|
1480 | <dt><strong><a name="item_xinternatom">$atom = $term->XInternAtom ($atom_name[, $only_if_exists])</a></strong><br /> |
|
|
1481 | </dt> |
|
|
1482 | <dt><strong><a name="item_xgetatomname">$atom_name = $term->XGetAtomName ($atom)</a></strong><br /> |
|
|
1483 | </dt> |
|
|
1484 | <dt><strong><a name="item_xlistproperties">@atoms = $term->XListProperties ($window)</a></strong><br /> |
|
|
1485 | </dt> |
|
|
1486 | <dt><strong><a name="item_xgetwindowproperty">($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)</a></strong><br /> |
|
|
1487 | </dt> |
|
|
1488 | <dt><strong><a name="item_xchangewindowproperty">$term->XChangeWindowProperty ($window, $property, $type, $format, $octets)</a></strong><br /> |
|
|
1489 | </dt> |
|
|
1490 | <dt><strong><a name="item_xdeleteproperty">$term->XDeleteProperty ($window, $property)</a></strong><br /> |
|
|
1491 | </dt> |
|
|
1492 | <dt><strong><a name="item_defaultrootwindow">$window = $term->DefaultRootWindow</a></strong><br /> |
|
|
1493 | </dt> |
|
|
1494 | <dt><strong><a name="item_xreparentwindow">$term->XReparentWindow ($window, $parent, [$x, $y])</a></strong><br /> |
|
|
1495 | </dt> |
|
|
1496 | <dt><strong><a name="item_xmapwindow">$term->XMapWindow ($window)</a></strong><br /> |
|
|
1497 | </dt> |
|
|
1498 | <dt><strong><a name="item_xunmapwindow">$term->XUnmapWindow ($window)</a></strong><br /> |
|
|
1499 | </dt> |
|
|
1500 | <dt><strong><a name="item_xmoveresizewindow">$term->XMoveResizeWindow ($window, $x, $y, $width, $height)</a></strong><br /> |
|
|
1501 | </dt> |
|
|
1502 | <dt><strong><a name="item_xtranslatecoordinates">($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)</a></strong><br /> |
|
|
1503 | </dt> |
|
|
1504 | <dt><strong><a name="item_xchangeinput">$term->XChangeInput ($window, $add_events[, $del_events])</a></strong><br /> |
|
|
1505 | </dt> |
|
|
1506 | <dd> |
|
|
1507 | Various X or X-related functions. The <code>$term</code> object only serves as |
|
|
1508 | the source of the display, otherwise those functions map more-or-less |
|
|
1509 | directory onto the X functions of the same name. |
|
|
1510 | </dd> |
| 934 | <p></p></dl> |
1511 | <p></p></dl> |
| 935 | <p> |
1512 | <p> |
| 936 | </p> |
1513 | </p> |
| 937 | <h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> |
1514 | <h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> |
|
|
1515 | <dl> |
|
|
1516 | <dt><strong><a name="item_add_title">$popup->add_title ($title)</a></strong><br /> |
|
|
1517 | </dt> |
|
|
1518 | <dd> |
|
|
1519 | Adds a non-clickable title to the popup. |
|
|
1520 | </dd> |
|
|
1521 | <p></p> |
|
|
1522 | <dt><strong><a name="item_add_separator">$popup->add_separator ([$sepchr])</a></strong><br /> |
|
|
1523 | </dt> |
|
|
1524 | <dd> |
|
|
1525 | Creates a separator, optionally using the character given as <code>$sepchr</code>. |
|
|
1526 | </dd> |
|
|
1527 | <p></p> |
|
|
1528 | <dt><strong><a name="item_add_button">$popup->add_button ($text, $cb)</a></strong><br /> |
|
|
1529 | </dt> |
|
|
1530 | <dd> |
|
|
1531 | Adds a clickable button to the popup. <code>$cb</code> is called whenever it is |
|
|
1532 | selected. |
|
|
1533 | </dd> |
|
|
1534 | <p></p> |
|
|
1535 | <dt><strong><a name="item_add_toggle">$popup->add_toggle ($text, $cb, $initial_value)</a></strong><br /> |
|
|
1536 | </dt> |
|
|
1537 | <dd> |
|
|
1538 | Adds a toggle/checkbox item to the popup. Teh callback gets called |
|
|
1539 | whenever it gets toggled, with a boolean indicating its value as its first |
|
|
1540 | argument. |
|
|
1541 | </dd> |
|
|
1542 | <p></p> |
|
|
1543 | <dt><strong>$popup->show</strong><br /> |
|
|
1544 | </dt> |
|
|
1545 | <dd> |
|
|
1546 | Displays the popup (which is initially hidden). |
|
|
1547 | </dd> |
|
|
1548 | <p></p></dl> |
| 938 | <p> |
1549 | <p> |
| 939 | </p> |
1550 | </p> |
| 940 | <h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> |
1551 | <h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> |
| 941 | <p>This class implements timer watchers/events. Time is represented as a |
1552 | <p>This class implements timer watchers/events. Time is represented as a |
| 942 | fractional number of seconds since the epoch. Example:</p> |
1553 | fractional number of seconds since the epoch. Example:</p> |
| … | |
… | |
| 993 | </dt> |
1604 | </dt> |
| 994 | <dd> |
1605 | <dd> |
| 995 | Set the event trigger time to <code>$tstamp</code> and start the timer. |
1606 | Set the event trigger time to <code>$tstamp</code> and start the timer. |
| 996 | </dd> |
1607 | </dd> |
| 997 | <p></p> |
1608 | <p></p> |
|
|
1609 | <dt><strong><a name="item_after">$timer = $timer->after ($delay)</a></strong><br /> |
|
|
1610 | </dt> |
|
|
1611 | <dd> |
|
|
1612 | Like <a href="#item_start"><code>start</code></a>, but sets the expiry timer to c<urxvt::NOW + $delay>. |
|
|
1613 | </dd> |
|
|
1614 | <p></p> |
| 998 | <dt><strong><a name="item_stop">$timer = $timer->stop</a></strong><br /> |
1615 | <dt><strong><a name="item_stop">$timer = $timer->stop</a></strong><br /> |
| 999 | </dt> |
1616 | </dt> |
| 1000 | <dd> |
1617 | <dd> |
| 1001 | Stop the timer. |
1618 | Stop the timer. |
| 1002 | </dd> |
1619 | </dd> |
| … | |
… | |
| 1008 | <pre> |
1625 | <pre> |
| 1009 | $term->{socket} = ... |
1626 | $term->{socket} = ... |
| 1010 | $term->{iow} = urxvt::iow |
1627 | $term->{iow} = urxvt::iow |
| 1011 | ->new |
1628 | ->new |
| 1012 | ->fd (fileno $term->{socket}) |
1629 | ->fd (fileno $term->{socket}) |
| 1013 | ->events (1) # wait for read data |
1630 | ->events (urxvt::EVENT_READ) |
| 1014 | ->start |
1631 | ->start |
| 1015 | ->cb (sub { |
1632 | ->cb (sub { |
| 1016 | my ($iow, $revents) = @_; |
1633 | my ($iow, $revents) = @_; |
| 1017 | # $revents must be 1 here, no need to check |
1634 | # $revents must be 1 here, no need to check |
| 1018 | sysread $term->{socket}, my $buf, 8192 |
1635 | sysread $term->{socket}, my $buf, 8192 |
| … | |
… | |
| 1039 | </dd> |
1656 | </dd> |
| 1040 | <p></p> |
1657 | <p></p> |
| 1041 | <dt><strong><a name="item_events">$iow = $iow->events ($eventmask)</a></strong><br /> |
1658 | <dt><strong><a name="item_events">$iow = $iow->events ($eventmask)</a></strong><br /> |
| 1042 | </dt> |
1659 | </dt> |
| 1043 | <dd> |
1660 | <dd> |
| 1044 | Set the event mask to watch. Bit #0 (value <code>1</code>) enables watching for read |
1661 | Set the event mask to watch. The only allowed values are |
| 1045 | data, Bit #1 (value <code>2</code>) enables watching for write data. |
1662 | <code>urxvt::EVENT_READ</code> and <code>urxvt::EVENT_WRITE</code>, which might be ORed |
|
|
1663 | together, or <code>urxvt::EVENT_NONE</code>. |
| 1046 | </dd> |
1664 | </dd> |
| 1047 | <p></p> |
1665 | <p></p> |
| 1048 | <dt><strong>$iow = $iow->start</strong><br /> |
1666 | <dt><strong>$iow = $iow->start</strong><br /> |
| 1049 | </dt> |
1667 | </dt> |
| 1050 | <dd> |
1668 | <dd> |
| … | |
… | |
| 1053 | <p></p> |
1671 | <p></p> |
| 1054 | <dt><strong>$iow = $iow->stop</strong><br /> |
1672 | <dt><strong>$iow = $iow->stop</strong><br /> |
| 1055 | </dt> |
1673 | </dt> |
| 1056 | <dd> |
1674 | <dd> |
| 1057 | Stop watching for events on the given filehandle. |
1675 | Stop watching for events on the given filehandle. |
|
|
1676 | </dd> |
|
|
1677 | <p></p></dl> |
|
|
1678 | <p> |
|
|
1679 | </p> |
|
|
1680 | <h2><a name="the_urxvt__iw_class">The <code>urxvt::iw</code> Class</a></h2> |
|
|
1681 | <p>This class implements idle watchers, that get called automatically when |
|
|
1682 | the process is idle. They should return as fast as possible, after doing |
|
|
1683 | some useful work.</p> |
|
|
1684 | <dl> |
|
|
1685 | <dt><strong><a name="item__24iw__3d_new_urxvt_3a_3aiw">$iw = new urxvt::iw</a></strong><br /> |
|
|
1686 | </dt> |
|
|
1687 | <dd> |
|
|
1688 | Create a new idle watcher object in stopped state. |
|
|
1689 | </dd> |
|
|
1690 | <p></p> |
|
|
1691 | <dt><strong>$iw = $iw->cb (sub { my ($iw) = @_; ... })</strong><br /> |
|
|
1692 | </dt> |
|
|
1693 | <dd> |
|
|
1694 | Set the callback to be called when the watcher triggers. |
|
|
1695 | </dd> |
|
|
1696 | <p></p> |
|
|
1697 | <dt><strong>$timer = $timer->start</strong><br /> |
|
|
1698 | </dt> |
|
|
1699 | <dd> |
|
|
1700 | Start the watcher. |
|
|
1701 | </dd> |
|
|
1702 | <p></p> |
|
|
1703 | <dt><strong>$timer = $timer->stop</strong><br /> |
|
|
1704 | </dt> |
|
|
1705 | <dd> |
|
|
1706 | Stop the watcher. |
|
|
1707 | </dd> |
|
|
1708 | <p></p></dl> |
|
|
1709 | <p> |
|
|
1710 | </p> |
|
|
1711 | <h2><a name="the_urxvt__pw_class">The <code>urxvt::pw</code> Class</a></h2> |
|
|
1712 | <p>This class implements process watchers. They create an event whenever a |
|
|
1713 | process exits, after which they stop automatically.</p> |
|
|
1714 | <pre> |
|
|
1715 | my $pid = fork; |
|
|
1716 | ... |
|
|
1717 | $term->{pw} = urxvt::pw |
|
|
1718 | ->new |
|
|
1719 | ->start ($pid) |
|
|
1720 | ->cb (sub { |
|
|
1721 | my ($pw, $exit_status) = @_; |
|
|
1722 | ... |
|
|
1723 | });</pre> |
|
|
1724 | <dl> |
|
|
1725 | <dt><strong><a name="item__24pw__3d_new_urxvt_3a_3apw">$pw = new urxvt::pw</a></strong><br /> |
|
|
1726 | </dt> |
|
|
1727 | <dd> |
|
|
1728 | Create a new process watcher in stopped state. |
|
|
1729 | </dd> |
|
|
1730 | <p></p> |
|
|
1731 | <dt><strong>$pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })</strong><br /> |
|
|
1732 | </dt> |
|
|
1733 | <dd> |
|
|
1734 | Set the callback to be called when the timer triggers. |
|
|
1735 | </dd> |
|
|
1736 | <p></p> |
|
|
1737 | <dt><strong>$pw = $timer->start ($pid)</strong><br /> |
|
|
1738 | </dt> |
|
|
1739 | <dd> |
|
|
1740 | Tells the wqtcher to start watching for process <code>$pid</code>. |
|
|
1741 | </dd> |
|
|
1742 | <p></p> |
|
|
1743 | <dt><strong>$pw = $pw->stop</strong><br /> |
|
|
1744 | </dt> |
|
|
1745 | <dd> |
|
|
1746 | Stop the watcher. |
| 1058 | </dd> |
1747 | </dd> |
| 1059 | <p></p></dl> |
1748 | <p></p></dl> |
| 1060 | <p> |
1749 | <p> |
| 1061 | </p> |
1750 | </p> |
| 1062 | <hr /> |
1751 | <hr /> |
| … | |
… | |
| 1065 | </p> |
1754 | </p> |
| 1066 | <h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> |
1755 | <h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> |
| 1067 | <p>This variable controls the verbosity level of the perl extension. Higher |
1756 | <p>This variable controls the verbosity level of the perl extension. Higher |
| 1068 | numbers indicate more verbose output.</p> |
1757 | numbers indicate more verbose output.</p> |
| 1069 | <dl> |
1758 | <dl> |
| 1070 | <dt><strong><a name="item__3d0__2d_only_fatal_messages">=0 - only fatal messages</a></strong><br /> |
1759 | <dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br /> |
| 1071 | </dt> |
1760 | </dt> |
| 1072 | <dt><strong><a name="item__3d3__2d_script_loading_and_management">=3 - script loading and management</a></strong><br /> |
1761 | <dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">>= 3 - script loading and management</a></strong><br /> |
| 1073 | </dt> |
1762 | </dt> |
| 1074 | <dt><strong><a name="item__3d10__2d_all_events_received">=10 - all events received</a></strong><br /> |
1763 | <dt><strong><a name="item__3e_3d10__2d_all_called_hooks">>=10 - all called hooks</a></strong><br /> |
|
|
1764 | </dt> |
|
|
1765 | <dt><strong><a name="item__3e_3d11__2d_hook_reutrn_values">>=11 - hook reutrn values</a></strong><br /> |
| 1075 | </dt> |
1766 | </dt> |
| 1076 | </dl> |
1767 | </dl> |
| 1077 | <p> |
1768 | <p> |
| 1078 | </p> |
1769 | </p> |
| 1079 | <hr /> |
1770 | <hr /> |
