… | |
… | |
28 | <li><a href="#the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></li> |
28 | <li><a href="#the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></li> |
29 | <li><a href="#the_urxvt__term_class">The <code>urxvt::term</code> Class</a></li> |
29 | <li><a href="#the_urxvt__term_class">The <code>urxvt::term</code> Class</a></li> |
30 | <li><a href="#the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></li> |
30 | <li><a href="#the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></li> |
31 | <li><a href="#the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></li> |
31 | <li><a href="#the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></li> |
32 | <li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li> |
32 | <li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li> |
|
|
33 | <li><a href="#the_urxvt__iw_class">The <code>urxvt::iw</code> Class</a></li> |
|
|
34 | <li><a href="#the_urxvt__pw_class">The <code>urxvt::pw</code> Class</a></li> |
33 | </ul> |
35 | </ul> |
34 | |
36 | |
35 | <li><a href="#environment">ENVIRONMENT</a></li> |
37 | <li><a href="#environment">ENVIRONMENT</a></li> |
36 | <ul> |
38 | <ul> |
37 | |
39 | |
… | |
… | |
80 | <p>This section describes the extensions delivered with this release. You can |
82 | <p>This section describes the extensions delivered with this release. You can |
81 | find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> |
83 | find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> |
82 | <p>You can activate them like this:</p> |
84 | <p>You can activate them like this:</p> |
83 | <pre> |
85 | <pre> |
84 | rxvt -pe <extensionname></pre> |
86 | rxvt -pe <extensionname></pre> |
|
|
87 | <p>Or by adding them to the resource for extensions loaded by default:</p> |
|
|
88 | <pre> |
|
|
89 | URxvt.perl-ext-common: default,automove-background,selection-autotransform</pre> |
85 | <dl> |
90 | <dl> |
86 | <dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br /> |
91 | <dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br /> |
87 | </dt> |
92 | </dt> |
88 | <dd> |
93 | <dd> |
89 | (More) intelligent selection. This extension tries to be more intelligent |
94 | (More) intelligent selection. This extension tries to be more intelligent |
90 | when the user extends selections (double-click). Right now, it tries to |
95 | when the user extends selections (double-click and further clicks). Right |
91 | select urls and complete shell-quoted arguments, which is very convenient, |
96 | now, it tries to select words, urls and complete shell-quoted |
92 | too, if your <em>ls</em> supports <code>--quoting-style=shell</code>. |
97 | arguments, which is very convenient, too, if your <em>ls</em> supports |
93 | </dd> |
98 | <code>--quoting-style=shell</code>. |
94 | <dd> |
99 | </dd> |
|
|
100 | <dd> |
|
|
101 | <p>A double-click usually selects the word under the cursor, further clicks |
|
|
102 | will enlarge the selection.</p> |
|
|
103 | </dd> |
|
|
104 | <dd> |
|
|
105 | <p>The selection works by trying to match a number of regexes and displaying |
|
|
106 | them in increasing order of length. You can add your own regexes by |
|
|
107 | specifying resources of the form:</p> |
|
|
108 | </dd> |
|
|
109 | <dd> |
|
|
110 | <pre> |
|
|
111 | URxvt.selection.pattern-0: perl-regex |
|
|
112 | URxvt.selection.pattern-1: perl-regex |
|
|
113 | ...</pre> |
|
|
114 | </dd> |
|
|
115 | <dd> |
|
|
116 | <p>The index number (0, 1...) must not have any holes, and each regex must |
|
|
117 | contain at least one pair of capturing parentheses, which will be used for |
|
|
118 | the match. For example, the followign adds a regex that matches everything |
|
|
119 | between two vertical bars:</p> |
|
|
120 | </dd> |
|
|
121 | <dd> |
|
|
122 | <pre> |
|
|
123 | URxvt.selection.pattern-0: \\|([^|]+)\\|</pre> |
|
|
124 | </dd> |
|
|
125 | <dd> |
|
|
126 | <p>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> |
95 | <p>It also offers the following bindable keyboard command:</p> |
130 | <p>This extension also offers following bindable keyboard commands:</p> |
96 | </dd> |
131 | </dd> |
97 | <dl> |
132 | <dl> |
98 | <dt><strong><a name="item_rot13">rot13</a></strong><br /> |
133 | <dt><strong><a name="item_rot13">rot13</a></strong><br /> |
99 | </dt> |
134 | </dt> |
100 | <dd> |
135 | <dd> |
… | |
… | |
117 | <dd> |
152 | <dd> |
118 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
153 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
119 | text into various other formats/action (such as uri unescaping, perl |
154 | text into various other formats/action (such as uri unescaping, perl |
120 | evalution, web-browser starting etc.), depending on content. |
155 | evalution, web-browser starting etc.), depending on content. |
121 | </dd> |
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> |
122 | <p></p> |
181 | <p></p> |
123 | <dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback<hotkey> (enabled by default)</a></strong><br /> |
182 | <dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback<hotkey> (enabled by default)</a></strong><br /> |
124 | </dt> |
183 | </dt> |
125 | <dd> |
184 | <dd> |
126 | Adds regex search functionality to the scrollback buffer, triggered |
185 | Adds regex search functionality to the scrollback buffer, triggered |
127 | by a hotkey (default: <code>M-s</code>). When in search mode, normal terminal |
186 | by a hotkey (default: <code>M-s</code>). While in search mode, normal terminal |
128 | input/output is suspended. |
187 | input/output is suspended and a regex is displayed at the bottom of the |
129 | </dd> |
188 | screen. |
130 | <dd> |
189 | </dd> |
131 | <p><code>/</code> starts an incremental regex search, <code>n</code> searches further, <code>p</code> or |
|
|
132 | <code>N</code> jump to the previous match, <code>G</code> jumps to the bottom and clears the |
|
|
133 | history, <code>enter</code> leaves search mode at the current position and <code>escape</code> |
|
|
134 | returns to the original position.</p> |
|
|
135 | </dd> |
190 | <dd> |
136 | <p></p> |
191 | <p>Inputting characters appends them to the regex and continues incremental |
137 | <dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> |
192 | search. <code>BackSpace</code> removes a character from the regex, <code>Up</code> and <code>Down</code> |
138 | </dt> |
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> |
139 | <dd> |
198 | </dd> |
140 | Displays a digital clock using the built-in overlay. |
199 | <p></p> |
|
|
200 | <dt><strong><a name="item_selection_2dautotransform">selection-autotransform</a></strong><br /> |
|
|
201 | </dt> |
|
|
202 | <dd> |
|
|
203 | This selection allows you to do automatic transforms on a selection |
|
|
204 | whenever a selection is made. |
|
|
205 | </dd> |
|
|
206 | <dd> |
|
|
207 | <p>It works by specifying perl snippets (most useful is a single <code>s///</code> |
|
|
208 | operator) that modify <code>$_</code> as resources:</p> |
|
|
209 | </dd> |
|
|
210 | <dd> |
|
|
211 | <pre> |
|
|
212 | URxvt.selection-autotransform.0: transform |
|
|
213 | URxvt.selection-autotransform.1: transform |
|
|
214 | ...</pre> |
|
|
215 | </dd> |
|
|
216 | <dd> |
|
|
217 | <p>For example, the following will transform selections of the form |
|
|
218 | <code>filename:number</code>, often seen in compiler messages, into <code>vi +$filename |
|
|
219 | $word</code>:</p> |
|
|
220 | </dd> |
|
|
221 | <dd> |
|
|
222 | <pre> |
|
|
223 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/</pre> |
|
|
224 | </dd> |
|
|
225 | <dd> |
|
|
226 | <p>And this example matches the same,but replaces it with vi-commands you can |
|
|
227 | paste directly into your (vi :) editor:</p> |
|
|
228 | </dd> |
|
|
229 | <dd> |
|
|
230 | <pre> |
|
|
231 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/</pre> |
|
|
232 | </dd> |
|
|
233 | <dd> |
|
|
234 | <p>Of course, this can be modified to suit your needs and your editor :)</p> |
|
|
235 | </dd> |
|
|
236 | <dd> |
|
|
237 | <p>To expand the example above to typical perl error messages (``XXX at |
|
|
238 | FILENAME line YYY.''), you need a slightly more elaborate solution:</p> |
|
|
239 | </dd> |
|
|
240 | <dd> |
|
|
241 | <pre> |
|
|
242 | URxvt.selection.pattern-0: ( at .*? line \\d+[,.]) |
|
|
243 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/</pre> |
|
|
244 | </dd> |
|
|
245 | <dd> |
|
|
246 | <p>The first line tells the selection code to treat the unchanging part of |
|
|
247 | every error message as a selection pattern, and the second line transforms |
|
|
248 | the message into vi commands to load the file.</p> |
|
|
249 | </dd> |
|
|
250 | <p></p> |
|
|
251 | <dt><strong><a name="item_tabbed">tabbed</a></strong><br /> |
|
|
252 | </dt> |
|
|
253 | <dd> |
|
|
254 | This transforms the terminal into a tabbar with additional terminals, that |
|
|
255 | is, it implements what is commonly refered to as ``tabbed terminal''. The topmost line |
|
|
256 | displays a ``[NEW]'' button, which, when clicked, will add a new tab, followed by one |
|
|
257 | button per tab. |
|
|
258 | </dd> |
|
|
259 | <dd> |
|
|
260 | <p>Clicking a button will activate that tab. Pressing Shift-Left and |
|
|
261 | Shift-Right will switch to the tab left or right of the current one.</p> |
141 | </dd> |
262 | </dd> |
142 | <p></p> |
263 | <p></p> |
143 | <dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> |
264 | <dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> |
144 | </dt> |
265 | </dt> |
145 | <dd> |
266 | <dd> |
146 | Uses per-line display filtering (<code>on_line_update</code>) to underline urls. |
267 | Uses per-line display filtering (<code>on_line_update</code>) to underline urls and |
|
|
268 | make them clickable. When middle-clicked, the program specified in the |
|
|
269 | resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with |
|
|
270 | the URL as first argument. |
|
|
271 | </dd> |
|
|
272 | <p></p> |
|
|
273 | <dt><strong><a name="item_automove_2dbackground">automove-background</a></strong><br /> |
|
|
274 | </dt> |
|
|
275 | <dd> |
|
|
276 | This is basically a one-line extension that dynamically changes the background pixmap offset |
|
|
277 | to the window position, in effect creating the same effect as pseudo transparency with |
|
|
278 | a custom pixmap. No scaling is supported in this mode. Exmaple: |
|
|
279 | </dd> |
|
|
280 | <dd> |
|
|
281 | <pre> |
|
|
282 | rxvt -pixmap background.xpm -pe automove-background</pre> |
147 | </dd> |
283 | </dd> |
148 | <p></p> |
284 | <p></p> |
149 | <dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br /> |
285 | <dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br /> |
150 | </dt> |
286 | </dt> |
151 | <dd> |
287 | <dd> |
152 | A not very useful example of filtering all text output to the terminal, |
288 | A not very useful example of filtering all text output to the terminal, |
153 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
289 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
154 | similar-looking ascii character. |
290 | similar-looking ascii character. |
155 | </dd> |
291 | </dd> |
156 | <p></p> |
292 | <p></p> |
|
|
293 | <dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> |
|
|
294 | </dt> |
|
|
295 | <dd> |
|
|
296 | Displays a digital clock using the built-in overlay. |
|
|
297 | </dd> |
|
|
298 | <p></p> |
157 | <dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> |
299 | <dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> |
158 | </dt> |
300 | </dt> |
159 | <dd> |
301 | <dd> |
160 | Displays a very simple digital clock in the upper right corner of the |
302 | Displays a very simple digital clock in the upper right corner of the |
161 | window. Illustrates overwriting the refresh callbacks to create your own |
303 | window. Illustrates overwriting the refresh callbacks to create your own |
162 | overlays or changes. |
304 | overlays or changes. |
|
|
305 | </dd> |
|
|
306 | <p></p> |
|
|
307 | <dt><strong><a name="item_selection_2dpastebin">selection-pastebin</a></strong><br /> |
|
|
308 | </dt> |
|
|
309 | <dd> |
|
|
310 | This is a little rarely useful extension that Uploads the selection as |
|
|
311 | textfile to a remote site (or does other things). (The implementation is |
|
|
312 | not currently secure for use in a multiuser environment as it writes to |
|
|
313 | <em>/tmp</em> directly.). |
|
|
314 | </dd> |
|
|
315 | <dd> |
|
|
316 | <p>It listens to the <code>selection-pastebin:remote-pastebin</code> keyboard command, |
|
|
317 | i.e.</p> |
|
|
318 | </dd> |
|
|
319 | <dd> |
|
|
320 | <pre> |
|
|
321 | URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin</pre> |
|
|
322 | </dd> |
|
|
323 | <dd> |
|
|
324 | <p>Pressing this combination runs a command with <code>%</code> replaced by the name of |
|
|
325 | the textfile. This command can be set via a resource:</p> |
|
|
326 | </dd> |
|
|
327 | <dd> |
|
|
328 | <pre> |
|
|
329 | URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.</pre> |
|
|
330 | </dd> |
|
|
331 | <dd> |
|
|
332 | <p>And the default is likely not useful to anybody but the few people around |
|
|
333 | here :)</p> |
|
|
334 | </dd> |
|
|
335 | <dd> |
|
|
336 | <p>The name of the textfile is the hex encoded md5 sum of the selection, so |
|
|
337 | the same content should lead to the same filename.</p> |
|
|
338 | </dd> |
|
|
339 | <dd> |
|
|
340 | <p>After a successful upload the selection will be replaced by the text given |
|
|
341 | in the <code>selection-pastebin-url</code> resource (again, the % is the placeholder |
|
|
342 | for the filename):</p> |
|
|
343 | </dd> |
|
|
344 | <dd> |
|
|
345 | <pre> |
|
|
346 | URxvt.selection-pastebin.url: <a href="http://www.ta-sa.org/files/txt/%">http://www.ta-sa.org/files/txt/%</a></pre> |
163 | </dd> |
347 | </dd> |
164 | <p></p></dl> |
348 | <p></p></dl> |
165 | <p> |
349 | <p> |
166 | </p> |
350 | </p> |
167 | <hr /> |
351 | <hr /> |
… | |
… | |
183 | <dl> |
367 | <dl> |
184 | <dt><strong><a name="item__24text">$text</a></strong><br /> |
368 | <dt><strong><a name="item__24text">$text</a></strong><br /> |
185 | </dt> |
369 | </dt> |
186 | <dd> |
370 | <dd> |
187 | Rxvt-unicodes special way of encoding text, where one ``unicode'' character |
371 | Rxvt-unicodes special way of encoding text, where one ``unicode'' character |
188 | always represents one screen cell. See <em>row_t</em> for a discussion of this format. |
372 | always represents one screen cell. See <a href="#item_row_t">ROW_t</a> for a discussion of this format. |
189 | </dd> |
373 | </dd> |
190 | <p></p> |
374 | <p></p> |
191 | <dt><strong><a name="item__24string">$string</a></strong><br /> |
375 | <dt><strong><a name="item__24string">$string</a></strong><br /> |
192 | </dt> |
376 | </dt> |
193 | <dd> |
377 | <dd> |
… | |
… | |
242 | <h2><a name="hooks">Hooks</a></h2> |
426 | <h2><a name="hooks">Hooks</a></h2> |
243 | <p>The following subroutines can be declared in extension files, and will be |
427 | <p>The following subroutines can be declared in extension files, and will be |
244 | called whenever the relevant event happens.</p> |
428 | called whenever the relevant event happens.</p> |
245 | <p>The first argument passed to them is an extension oject as described in |
429 | <p>The first argument passed to them is an extension oject as described in |
246 | the in the <code>Extension Objects</code> section.</p> |
430 | the in the <code>Extension Objects</code> section.</p> |
247 | <p><strong>All</strong> of these hooks must return a boolean value. If it is true, then the |
431 | <p><strong>All</strong> of these hooks must return a boolean value. If any of the called |
248 | event counts as being <em>consumed</em>, and the invocation of other hooks is |
432 | hooks returns true, then the event counts as being <em>consumed</em>, and the |
249 | skipped, and the relevant action might not be carried out by the C++ code.</p> |
433 | relevant action might not be carried out by the C++ code.</p> |
250 | <p><em>When in doubt, return a false value (preferably <code>()</code>). </em>></p> |
434 | <p><em>When in doubt, return a false value (preferably <code>()</code>). </em>></p> |
251 | <dl> |
435 | <dl> |
252 | <dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> |
436 | <dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> |
253 | </dt> |
437 | </dt> |
254 | <dd> |
438 | <dd> |
255 | Called after a new terminal object has been initialized, but before |
439 | Called after a new terminal object has been initialized, but before |
256 | windows are created or the command gets run. Most methods are unsafe to |
440 | windows are created or the command gets run. Most methods are unsafe to |
257 | call or deliver senseless data, as terminal size and other characteristics |
441 | call or deliver senseless data, as terminal size and other characteristics |
258 | have not yet been determined. You can safely query and change resources, |
442 | have not yet been determined. You can safely query and change resources |
259 | though. |
443 | and options, though. For many purposes the <code>on_start</code> hook is a better |
|
|
444 | place. |
|
|
445 | </dd> |
|
|
446 | <p></p> |
|
|
447 | <dt><strong><a name="item_on_start__24term">on_start $term</a></strong><br /> |
|
|
448 | </dt> |
|
|
449 | <dd> |
|
|
450 | Called at the very end of initialisation of a new terminal, just before |
|
|
451 | trying to map (display) the toplevel and returning to the mainloop. |
|
|
452 | </dd> |
|
|
453 | <p></p> |
|
|
454 | <dt><strong><a name="item_on_destroy__24term">on_destroy $term</a></strong><br /> |
|
|
455 | </dt> |
|
|
456 | <dd> |
|
|
457 | Called whenever something tries to destroy terminal, before doing anything |
|
|
458 | yet. If this hook returns true, then destruction is skipped, but this is |
|
|
459 | rarely a good idea. |
260 | </dd> |
460 | </dd> |
261 | <p></p> |
461 | <p></p> |
262 | <dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> |
462 | <dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> |
263 | </dt> |
463 | </dt> |
264 | <dd> |
464 | <dd> |
265 | Called after the screen is ``reset'' for any reason, such as resizing or |
465 | Called after the screen is ``reset'' for any reason, such as resizing or |
266 | control sequences. Here is where you can react on changes to size-related |
466 | control sequences. Here is where you can react on changes to size-related |
267 | variables. |
467 | variables. |
268 | </dd> |
468 | </dd> |
269 | <p></p> |
469 | <p></p> |
270 | <dt><strong><a name="item_on_start__24term">on_start $term</a></strong><br /> |
470 | <dt><strong><a name="item_on_child_start__24term_2c__24pid">on_child_start $term, $pid</a></strong><br /> |
271 | </dt> |
471 | </dt> |
|
|
472 | <dd> |
|
|
473 | Called just after the child process has been <code>fork</code>ed. |
272 | <dd> |
474 | </dd> |
273 | Called at the very end of initialisation of a new terminal, just before |
475 | <p></p> |
274 | returning to the mainloop. |
476 | <dt><strong><a name="item_on_child_exit__24term_2c__24status">on_child_exit $term, $status</a></strong><br /> |
|
|
477 | </dt> |
|
|
478 | <dd> |
|
|
479 | Called just after the child process has exited. <code>$status</code> is the status |
|
|
480 | from <code>waitpid</code>. |
275 | </dd> |
481 | </dd> |
276 | <p></p> |
482 | <p></p> |
277 | <dt><strong><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a></strong><br /> |
483 | <dt><strong><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a></strong><br /> |
278 | </dt> |
484 | </dt> |
279 | <dd> |
485 | <dd> |
… | |
… | |
301 | </dt> |
507 | </dt> |
302 | <dd> |
508 | <dd> |
303 | Called whenever the user tries to extend the selection (e.g. with a double |
509 | Called whenever the user tries to extend the selection (e.g. with a double |
304 | click) and is either supposed to return false (normal operation), or |
510 | click) and is either supposed to return false (normal operation), or |
305 | should extend the selection itelf and return true to suppress the built-in |
511 | should extend the selection itelf and return true to suppress the built-in |
306 | processing. |
512 | processing. This can happen multiple times, as long as the callback |
|
|
513 | returns true, it will be called on every further click by the user and is |
|
|
514 | supposed to enlarge the selection more and more, if possible. |
307 | </dd> |
515 | </dd> |
308 | <dd> |
516 | <dd> |
309 | <p>See the <em>selection</em> example extension.</p> |
517 | <p>See the <em>selection</em> example extension.</p> |
310 | </dd> |
518 | </dd> |
311 | <p></p> |
519 | <p></p> |
… | |
… | |
402 | Called whenever the user presses a key combination that has a |
610 | Called whenever the user presses a key combination that has a |
403 | <code>perl:string</code> action bound to it (see description of the <strong>keysym</strong> |
611 | <code>perl:string</code> action bound to it (see description of the <strong>keysym</strong> |
404 | resource in the <code>rxvt(1)</code> manpage). |
612 | resource in the <code>rxvt(1)</code> manpage). |
405 | </dd> |
613 | </dd> |
406 | <p></p> |
614 | <p></p> |
|
|
615 | <dt><strong><a name="item_on_x_event__24term_2c__24event">on_x_event $term, $event</a></strong><br /> |
|
|
616 | </dt> |
|
|
617 | <dd> |
|
|
618 | Called on every X event received on the vt window (and possibly other |
|
|
619 | windows). Should only be used as a last resort. Most event structure |
|
|
620 | members are not passed. |
|
|
621 | </dd> |
|
|
622 | <p></p> |
407 | <dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> |
623 | <dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> |
408 | </dt> |
624 | </dt> |
409 | <dd> |
625 | <dd> |
410 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
626 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
411 | does focus in processing. |
627 | does focus in processing. |
… | |
… | |
416 | <dd> |
632 | <dd> |
417 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
633 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
418 | focus out processing. |
634 | focus out processing. |
419 | </dd> |
635 | </dd> |
420 | <p></p> |
636 | <p></p> |
|
|
637 | <dt><strong><a name="item_on_configure_notify__24term_2c__24event">on_configure_notify $term, $event</a></strong><br /> |
|
|
638 | </dt> |
421 | <dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a></strong><br /> |
639 | <dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a></strong><br /> |
422 | </dt> |
640 | </dt> |
423 | <dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br /> |
641 | <dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br /> |
424 | </dt> |
642 | </dt> |
425 | <dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br /> |
643 | <dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br /> |
… | |
… | |
446 | output, if any, in locale-specific encoding.</p> |
664 | output, if any, in locale-specific encoding.</p> |
447 | </dd> |
665 | </dd> |
448 | <dd> |
666 | <dd> |
449 | <p>subwindow.</p> |
667 | <p>subwindow.</p> |
450 | </dd> |
668 | </dd> |
|
|
669 | <p></p> |
|
|
670 | <dt><strong><a name="item_on_client_message__24term_2c__24event">on_client_message $term, $event</a></strong><br /> |
|
|
671 | </dt> |
|
|
672 | <dt><strong><a name="item_on_wm_protocols__24term_2c__24event">on_wm_protocols $term, $event</a></strong><br /> |
|
|
673 | </dt> |
|
|
674 | <dt><strong><a name="item_on_wm_delete_window__24term_2c__24event">on_wm_delete_window $term, $event</a></strong><br /> |
|
|
675 | </dt> |
|
|
676 | <dd> |
|
|
677 | Called when various types of ClientMessage events are received (all with |
|
|
678 | format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
|
|
679 | </dd> |
451 | <p></p></dl> |
680 | <p></p></dl> |
452 | <p> |
681 | <p> |
453 | </p> |
682 | </p> |
454 | <h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> |
683 | <h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> |
455 | <dl> |
684 | <dl> |
… | |
… | |
477 | <dd> |
706 | <dd> |
478 | The current terminal. This variable stores the current <code>urxvt::term</code> |
707 | The current terminal. This variable stores the current <code>urxvt::term</code> |
479 | object, whenever a callback/hook is executing. |
708 | object, whenever a callback/hook is executing. |
480 | </dd> |
709 | </dd> |
481 | <p></p> |
710 | <p></p> |
482 | <dt></dt> |
711 | <dt><strong><a name="item__40urxvt_3a_3aterm_init">@urxvt::TERM_INIT</a></strong><br /> |
483 | </dl> |
712 | </dt> |
|
|
713 | <dd> |
|
|
714 | All coderefs in this array will be called as methods of the next newly |
|
|
715 | created <code>urxvt::term</code> object (during the <code>on_init</code> phase). The array |
|
|
716 | gets cleared before the codereferences that were in it are being executed, |
|
|
717 | so coderefs can push themselves onto it again if they so desire. |
|
|
718 | </dd> |
|
|
719 | <dd> |
|
|
720 | <p>This complements to the perl-eval commandline option, but gets executed |
|
|
721 | first.</p> |
|
|
722 | </dd> |
|
|
723 | <p></p> |
|
|
724 | <dt><strong><a name="item__40urxvt_3a_3aterm_ext">@urxvt::TERM_EXT</a></strong><br /> |
|
|
725 | </dt> |
|
|
726 | <dd> |
|
|
727 | Works similar to <code>@TERM_INIT</code>, but contains perl package/class names, which |
|
|
728 | get registered as normal extensions after calling the hooks in <code>@TERM_INIT</code> |
|
|
729 | but before other extensions. Gets cleared just like <code>@TERM_INIT</code>. |
|
|
730 | </dd> |
|
|
731 | <p></p></dl> |
484 | <p> |
732 | <p> |
485 | </p> |
733 | </p> |
486 | <h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> |
734 | <h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> |
487 | <dl> |
735 | <dl> |
488 | <dt><strong><a name="item__24term__3d_new_urxvt__5barg_2e_2e_2e_5d">$term = new urxvt [arg...]</a></strong><br /> |
|
|
489 | </dt> |
|
|
490 | <dd> |
|
|
491 | Creates a new terminal, very similar as if you had started it with |
|
|
492 | <code>system $binfile, arg...</code>. Croaks (and probably outputs an error message) |
|
|
493 | if the new instance couldn't be created. Returns <code>undef</code> if the new |
|
|
494 | instance didn't initialise perl, and the terminal object otherwise. The |
|
|
495 | <code>init</code> and <a href="#item_start"><code>start</code></a> hooks will be called during the call. |
|
|
496 | </dd> |
|
|
497 | <p></p> |
|
|
498 | <dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br /> |
736 | <dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br /> |
499 | </dt> |
737 | </dt> |
500 | <dd> |
738 | <dd> |
501 | Fatally aborts execution with the given error message. Avoid at all |
739 | Fatally aborts execution with the given error message. Avoid at all |
502 | costs! The only time this is acceptable is when the terminal process |
740 | costs! The only time this is acceptable is when the terminal process |
… | |
… | |
512 | </dd> |
750 | </dd> |
513 | <dd> |
751 | <dd> |
514 | <p>Using this function has the advantage that its output ends up in the |
752 | <p>Using this function has the advantage that its output ends up in the |
515 | correct place, e.g. on stderr of the connecting urxvtc client.</p> |
753 | correct place, e.g. on stderr of the connecting urxvtc client.</p> |
516 | </dd> |
754 | </dd> |
517 | <p></p> |
|
|
518 | <dt><strong><a name="item__24is_safe__3d_urxvt_3a_3asafe">$is_safe = urxvt::safe</a></strong><br /> |
|
|
519 | </dt> |
|
|
520 | <dd> |
755 | <dd> |
521 | Returns true when it is safe to do potentially unsafe things, such as |
756 | <p>Messages have a size limit of 1023 bytes currently.</p> |
522 | evaluating perl code specified by the user. This is true when urxvt was |
|
|
523 | started setuid or setgid. |
|
|
524 | </dd> |
757 | </dd> |
525 | <p></p> |
758 | <p></p> |
526 | <dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> |
759 | <dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> |
527 | </dt> |
760 | </dt> |
528 | <dd> |
761 | <dd> |
… | |
… | |
532 | <dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br /> |
765 | <dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br /> |
533 | </dt> |
766 | </dt> |
534 | <dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
767 | <dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
535 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
768 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
536 | Button4Mask, Button5Mask, AnyModifier</a></strong><br /> |
769 | Button4Mask, Button5Mask, AnyModifier</a></strong><br /> |
|
|
770 | </dt> |
|
|
771 | <dt><strong><a name="item_urxvt_3a_3anoeventmask_2c_keypressmask_2c_keyrelea">urxvt::NoEventMask, KeyPressMask, KeyReleaseMask, |
|
|
772 | ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, |
|
|
773 | PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask, |
|
|
774 | Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask, |
|
|
775 | KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask, |
|
|
776 | ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask, |
|
|
777 | FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask</a></strong><br /> |
|
|
778 | </dt> |
|
|
779 | <dt><strong><a name="item_urxvt_3a_3akeypress_2c_keyrelease_2c_buttonpress_2">urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify, |
|
|
780 | EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose, |
|
|
781 | GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify, |
|
|
782 | UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify, |
|
|
783 | ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify, |
|
|
784 | CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, |
|
|
785 | SelectionNotify, ColormapNotify, ClientMessage, MappingNotify</a></strong><br /> |
537 | </dt> |
786 | </dt> |
538 | <dd> |
787 | <dd> |
539 | Various constants for use in X calls and event processing. |
788 | Various constants for use in X calls and event processing. |
540 | </dd> |
789 | </dd> |
541 | <p></p></dl> |
790 | <p></p></dl> |
… | |
… | |
612 | work.</p> |
861 | work.</p> |
613 | <p> |
862 | <p> |
614 | </p> |
863 | </p> |
615 | <h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> |
864 | <h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> |
616 | <dl> |
865 | <dl> |
|
|
866 | <dt><strong><a name="item__24term__3d_new_urxvt_3a_3aterm__24envhashref_2c__">$term = new urxvt::term $envhashref, $rxvtname, [arg...]</a></strong><br /> |
|
|
867 | </dt> |
|
|
868 | <dd> |
|
|
869 | Creates a new terminal, very similar as if you had started it with system |
|
|
870 | <code>$rxvtname, arg...</code>. <code>$envhashref</code> must be a reference to a <code>%ENV</code>-like |
|
|
871 | hash which defines the environment of the new terminal. |
|
|
872 | </dd> |
|
|
873 | <dd> |
|
|
874 | <p>Croaks (and probably outputs an error message) if the new instance |
|
|
875 | couldn't be created. Returns <code>undef</code> if the new instance didn't |
|
|
876 | initialise perl, and the terminal object otherwise. The <code>init</code> and |
|
|
877 | <a href="#item_start"><code>start</code></a> hooks will be called during this call.</p> |
|
|
878 | </dd> |
|
|
879 | <p></p> |
617 | <dt><strong><a name="item_destroy">$term->destroy</a></strong><br /> |
880 | <dt><strong><a name="item_destroy">$term->destroy</a></strong><br /> |
618 | </dt> |
881 | </dt> |
619 | <dd> |
882 | <dd> |
620 | Destroy the terminal object (close the window, free resources |
883 | Destroy the terminal object (close the window, free resources |
621 | etc.). Please note that rxvt will not exit as long as any event |
884 | etc.). Please note that rxvt will not exit as long as any event |
622 | watchers (timers, io watchers) are still active. |
885 | watchers (timers, io watchers) are still active. |
623 | </dd> |
886 | </dd> |
624 | <p></p> |
887 | <p></p> |
|
|
888 | <dt><strong><a name="item_exec_async">$term->exec_async ($cmd[, @args])</a></strong><br /> |
|
|
889 | </dt> |
|
|
890 | <dd> |
|
|
891 | Works like the combination of the <code>fork</code>/<code>exec</code> builtins, which executes |
|
|
892 | (``starts'') programs in the background. This function takes care of setting |
|
|
893 | the user environment before exec'ing the command (e.g. <code>PATH</code>) and should |
|
|
894 | be preferred over explicit calls to <code>exec</code> or <code>system</code>. |
|
|
895 | </dd> |
|
|
896 | <dd> |
|
|
897 | <p>Returns the pid of the subprocess or <code>undef</code> on error.</p> |
|
|
898 | </dd> |
|
|
899 | <p></p> |
625 | <dt><strong><a name="item_option">$isset = $term->option ($optval[, $set])</a></strong><br /> |
900 | <dt><strong><a name="item_option">$isset = $term->option ($optval[, $set])</a></strong><br /> |
626 | </dt> |
901 | </dt> |
627 | <dd> |
902 | <dd> |
628 | Returns true if the option specified by <code>$optval</code> is enabled, and |
903 | Returns true if the option specified by <code>$optval</code> is enabled, and |
629 | optionally change it. All option values are stored by name in the hash |
904 | optionally change it. All option values are stored by name in the hash |
… | |
… | |
635 | </dd> |
910 | </dd> |
636 | <dd> |
911 | <dd> |
637 | <pre> |
912 | <pre> |
638 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
913 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
639 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
914 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
640 | pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating |
915 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
641 | scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer |
916 | scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput |
642 | secondaryScreen secondaryScroll skipBuiltinGlyphs transparent |
917 | scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs |
643 | tripleclickwords utmpInhibit visualBell</pre> |
918 | transparent tripleclickwords utmpInhibit visualBell</pre> |
644 | </dd> |
919 | </dd> |
645 | <p></p> |
920 | <p></p> |
646 | <dt><strong><a name="item_resource">$value = $term->resource ($name[, $newval])</a></strong><br /> |
921 | <dt><strong><a name="item_resource">$value = $term->resource ($name[, $newval])</a></strong><br /> |
647 | </dt> |
922 | </dt> |
648 | <dd> |
923 | <dd> |
… | |
… | |
673 | <pre> |
948 | <pre> |
674 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
949 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
675 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
950 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
676 | display_name embed ext_bwidth fade font geometry hold iconName |
951 | display_name embed ext_bwidth fade font geometry hold iconName |
677 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
952 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
678 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
953 | italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier |
679 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 |
954 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
680 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
955 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
681 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
956 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
682 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
957 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
683 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
958 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
684 | shade term_name title transparent transparent_all tripleclickwords |
959 | secondaryScreen secondaryScroll selectstyle shade term_name title |
|
|
960 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
685 | utmpInhibit visualBell</pre> |
961 | visualBell</pre> |
|
|
962 | </dd> |
|
|
963 | <p></p> |
|
|
964 | <dt><strong><a name="item_x_resource">$value = $term->x_resource ($pattern)</a></strong><br /> |
|
|
965 | </dt> |
|
|
966 | <dd> |
|
|
967 | Returns the X-Resource for the given pattern, excluding the program or |
|
|
968 | class name, i.e. <a href="#item_x_resource"><code>$term->x_resource ("boldFont")</code></a> should return the |
|
|
969 | same value as used by this instance of rxvt-unicode. Returns <code>undef</code> if no |
|
|
970 | resource with that pattern exists. |
|
|
971 | </dd> |
|
|
972 | <dd> |
|
|
973 | <p>This method should only be called during the <code>on_start</code> hook, as there is |
|
|
974 | only one resource database per display, and later invocations might return |
|
|
975 | the wrong resources.</p> |
686 | </dd> |
976 | </dd> |
687 | <p></p> |
977 | <p></p> |
688 | <dt><strong><a name="item_parse_keysym">$success = $term->parse_keysym ($keysym_spec, $command_string)</a></strong><br /> |
978 | <dt><strong><a name="item_parse_keysym">$success = $term->parse_keysym ($keysym_spec, $command_string)</a></strong><br /> |
689 | </dt> |
979 | </dt> |
690 | <dd> |
980 | <dd> |
… | |
… | |
715 | <dd> |
1005 | <dd> |
716 | Return the current values of the selection mark, begin or end positions, |
1006 | Return the current values of the selection mark, begin or end positions, |
717 | and optionally set them to new values. |
1007 | and optionally set them to new values. |
718 | </dd> |
1008 | </dd> |
719 | <p></p> |
1009 | <p></p> |
|
|
1010 | <dt><strong><a name="item_selection_make">$term->selection_make ($eventtime[, $rectangular])</a></strong><br /> |
|
|
1011 | </dt> |
|
|
1012 | <dd> |
|
|
1013 | Tries to make a selection as set by <a href="#item_selection_beg"><code>selection_beg</code></a> and |
|
|
1014 | <a href="#item_selection_end"><code>selection_end</code></a>. If <code>$rectangular</code> is true (default: false), a |
|
|
1015 | rectangular selection will be made. This is the prefered function to make |
|
|
1016 | a selection. |
|
|
1017 | </dd> |
|
|
1018 | <p></p> |
720 | <dt><strong><a name="item_selection_grab">$success = $term->selection_grab ($eventtime)</a></strong><br /> |
1019 | <dt><strong><a name="item_selection_grab">$success = $term->selection_grab ($eventtime)</a></strong><br /> |
721 | </dt> |
1020 | </dt> |
722 | <dd> |
1021 | <dd> |
723 | Try to request the primary selection from the server (for example, as set |
1022 | Try to request the primary selection text from the server (for example, as |
724 | by the next method). |
1023 | set by the next method). No visual feedback will be given. This function |
|
|
1024 | is mostly useful from within <code>on_sel_grab</code> hooks. |
725 | </dd> |
1025 | </dd> |
726 | <p></p> |
1026 | <p></p> |
727 | <dt><strong>$oldtext = $term->selection ([$newtext])</strong><br /> |
1027 | <dt><strong>$oldtext = $term->selection ([$newtext])</strong><br /> |
728 | </dt> |
1028 | </dt> |
729 | <dd> |
1029 | <dd> |
… | |
… | |
808 | <p></p> |
1108 | <p></p> |
809 | <dt><strong><a name="item_scr_xor_span">$term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])</a></strong><br /> |
1109 | <dt><strong><a name="item_scr_xor_span">$term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])</a></strong><br /> |
810 | </dt> |
1110 | </dt> |
811 | <dd> |
1111 | <dd> |
812 | XORs the rendition values in the given span with the provided value |
1112 | XORs the rendition values in the given span with the provided value |
813 | (default: <code>RS_RVid</code>). Useful in refresh hooks to provide effects similar |
1113 | (default: <code>RS_RVid</code>), which <em>MUST NOT</em> contain font styles. Useful in |
814 | to the selection. |
1114 | refresh hooks to provide effects similar to the selection. |
815 | </dd> |
1115 | </dd> |
816 | <p></p> |
1116 | <p></p> |
817 | <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 /> |
1117 | <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 /> |
818 | </dt> |
1118 | </dt> |
819 | <dd> |
1119 | <dd> |
820 | Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing |
1120 | Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing |
821 | whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults |
1121 | whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults |
822 | to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines |
1122 | to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines |
823 | it instead. |
1123 | it instead. Both styles <em>MUST NOT</em> contain font styles. |
824 | </dd> |
1124 | </dd> |
825 | <p></p> |
1125 | <p></p> |
826 | <dt><strong><a name="item_scr_bell">$term->scr_bell</a></strong><br /> |
1126 | <dt><strong><a name="item_scr_bell">$term->scr_bell</a></strong><br /> |
827 | </dt> |
1127 | </dt> |
828 | <dd> |
1128 | <dd> |
… | |
… | |
878 | </dt> |
1178 | </dt> |
879 | <dd> |
1179 | <dd> |
880 | Return the window id of the terminal window. |
1180 | Return the window id of the terminal window. |
881 | </dd> |
1181 | </dd> |
882 | <p></p> |
1182 | <p></p> |
|
|
1183 | <dt><strong><a name="item_vt_emask_add">$term->vt_emask_add ($x_event_mask)</a></strong><br /> |
|
|
1184 | </dt> |
|
|
1185 | <dd> |
|
|
1186 | Adds the specified events to the vt event mask. Useful e.g. when you want |
|
|
1187 | to receive pointer events all the times: |
|
|
1188 | </dd> |
|
|
1189 | <dd> |
|
|
1190 | <pre> |
|
|
1191 | $term->vt_emask_add (urxvt::PointerMotionMask);</pre> |
|
|
1192 | </dd> |
|
|
1193 | <p></p> |
883 | <dt><strong><a name="item_width">$window_width = $term->width</a></strong><br /> |
1194 | <dt><strong><a name="item_width">$window_width = $term->width</a></strong><br /> |
884 | </dt> |
1195 | </dt> |
885 | <dt><strong><a name="item_height">$window_height = $term->height</a></strong><br /> |
1196 | <dt><strong><a name="item_height">$window_height = $term->height</a></strong><br /> |
886 | </dt> |
1197 | </dt> |
887 | <dt><strong><a name="item_fwidth">$font_width = $term->fwidth</a></strong><br /> |
1198 | <dt><strong><a name="item_fwidth">$font_width = $term->fwidth</a></strong><br /> |
… | |
… | |
900 | </dt> |
1211 | </dt> |
901 | <dt><strong><a name="item_savelines">$max_scrollback = $term->saveLines</a></strong><br /> |
1212 | <dt><strong><a name="item_savelines">$max_scrollback = $term->saveLines</a></strong><br /> |
902 | </dt> |
1213 | </dt> |
903 | <dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term->total_rows</a></strong><br /> |
1214 | <dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term->total_rows</a></strong><br /> |
904 | </dt> |
1215 | </dt> |
905 | <dt><strong><a name="item_nsaved">$lines_in_scrollback = $term->nsaved</a></strong><br /> |
1216 | <dt><strong><a name="item_top_row">$topmost_scrollback_row = $term->top_row</a></strong><br /> |
906 | </dt> |
1217 | </dt> |
907 | <dd> |
1218 | <dd> |
908 | Return various integers describing terminal characteristics. |
1219 | Return various integers describing terminal characteristics. |
909 | </dd> |
1220 | </dd> |
910 | <p></p> |
1221 | <p></p> |
|
|
1222 | <dt><strong><a name="item_display_id">$x_display = $term->display_id</a></strong><br /> |
|
|
1223 | </dt> |
|
|
1224 | <dd> |
|
|
1225 | Return the DISPLAY used by rxvt-unicode. |
|
|
1226 | </dd> |
|
|
1227 | <p></p> |
911 | <dt><strong><a name="item_locale">$lc_ctype = $term->locale</a></strong><br /> |
1228 | <dt><strong><a name="item_locale">$lc_ctype = $term->locale</a></strong><br /> |
912 | </dt> |
1229 | </dt> |
913 | <dd> |
1230 | <dd> |
914 | Returns the LC_CTYPE category string used by this rxvt-unicode. |
1231 | Returns the LC_CTYPE category string used by this rxvt-unicode. |
915 | </dd> |
1232 | </dd> |
916 | <p></p> |
1233 | <p></p> |
917 | <dt><strong><a name="item_display_id">$x_display = $term->display_id</a></strong><br /> |
1234 | <dt><strong><a name="item_env">$env = $term->env</a></strong><br /> |
918 | </dt> |
1235 | </dt> |
919 | <dd> |
1236 | <dd> |
920 | Return the DISPLAY used by rxvt-unicode. |
1237 | Returns a copy of the environment in effect for the terminal as a hashref |
|
|
1238 | similar to <code>\%ENV</code>. |
921 | </dd> |
1239 | </dd> |
922 | <p></p> |
1240 | <p></p> |
923 | <dt><strong><a name="item_modlevel3mask">$modifiermask = $term->ModLevel3Mask</a></strong><br /> |
1241 | <dt><strong><a name="item_modlevel3mask">$modifiermask = $term->ModLevel3Mask</a></strong><br /> |
924 | </dt> |
1242 | </dt> |
925 | <dt><strong><a name="item_modmetamask">$modifiermask = $term->ModMetaMask</a></strong><br /> |
1243 | <dt><strong><a name="item_modmetamask">$modifiermask = $term->ModMetaMask</a></strong><br /> |
… | |
… | |
932 | </dd> |
1250 | </dd> |
933 | <p></p> |
1251 | <p></p> |
934 | <dt><strong><a name="item_view_start">$view_start = $term->view_start ([$newvalue])</a></strong><br /> |
1252 | <dt><strong><a name="item_view_start">$view_start = $term->view_start ([$newvalue])</a></strong><br /> |
935 | </dt> |
1253 | </dt> |
936 | <dd> |
1254 | <dd> |
937 | Returns the negative row number of the topmost line. Minimum value is |
1255 | Returns the row number of the topmost displayed line. Maximum value is |
938 | <code>0</code>, which displays the normal terminal contents. Larger values scroll |
1256 | <code>0</code>, which displays the normal terminal contents. Lower values scroll |
939 | this many lines into the scrollback buffer. |
1257 | this many lines into the scrollback buffer. |
940 | </dd> |
1258 | </dd> |
941 | <p></p> |
1259 | <p></p> |
942 | <dt><strong><a name="item_want_refresh">$term->want_refresh</a></strong><br /> |
1260 | <dt><strong><a name="item_want_refresh">$term->want_refresh</a></strong><br /> |
943 | </dt> |
1261 | </dt> |
… | |
… | |
954 | </dt> |
1272 | </dt> |
955 | <dd> |
1273 | <dd> |
956 | Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code> |
1274 | Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code> |
957 | is the topmost terminal line, row <code>$term->$ncol-1</code> is the bottommost |
1275 | is the topmost terminal line, row <code>$term->$ncol-1</code> is the bottommost |
958 | terminal line. The scrollback buffer starts at line <code>-1</code> and extends to |
1276 | terminal line. The scrollback buffer starts at line <code>-1</code> and extends to |
959 | line <a href="#item_nsaved"><code>-$term->nsaved</code></a>. Nothing will be returned if a nonexistent line |
1277 | line <code>-$term->nsaved</code>. Nothing will be returned if a nonexistent line |
960 | is requested. |
1278 | is requested. |
961 | </dd> |
1279 | </dd> |
962 | <dd> |
1280 | <dd> |
963 | <p>If <code>$new_text</code> is specified, it will replace characters in the current |
1281 | <p>If <code>$new_text</code> is specified, it will replace characters in the current |
964 | line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful |
1282 | line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful |
… | |
… | |
1049 | <p></p> |
1367 | <p></p> |
1050 | <dt><strong><a name="item_offset_of">$offset = $line->offset_of ($row, $col)</a></strong><br /> |
1368 | <dt><strong><a name="item_offset_of">$offset = $line->offset_of ($row, $col)</a></strong><br /> |
1051 | </dt> |
1369 | </dt> |
1052 | <dd> |
1370 | <dd> |
1053 | Returns the character offset of the given row|col pair within the logical |
1371 | Returns the character offset of the given row|col pair within the logical |
1054 | line. |
1372 | line. Works for rows outside the line, too, and returns corresponding |
|
|
1373 | offsets outside the string. |
1055 | </dd> |
1374 | </dd> |
1056 | <p></p> |
1375 | <p></p> |
1057 | <dt><strong><a name="item_coord_of">($row, $col) = $line->coord_of ($offset)</a></strong><br /> |
1376 | <dt><strong><a name="item_coord_of">($row, $col) = $line->coord_of ($offset)</a></strong><br /> |
1058 | </dt> |
1377 | </dt> |
1059 | <dd> |
1378 | <dd> |
… | |
… | |
1208 | <p></p> |
1527 | <p></p> |
1209 | <dt><strong>$timer = $timer->start ($tstamp)</strong><br /> |
1528 | <dt><strong>$timer = $timer->start ($tstamp)</strong><br /> |
1210 | </dt> |
1529 | </dt> |
1211 | <dd> |
1530 | <dd> |
1212 | Set the event trigger time to <code>$tstamp</code> and start the timer. |
1531 | Set the event trigger time to <code>$tstamp</code> and start the timer. |
|
|
1532 | </dd> |
|
|
1533 | <p></p> |
|
|
1534 | <dt><strong><a name="item_after">$timer = $timer->after ($delay)</a></strong><br /> |
|
|
1535 | </dt> |
|
|
1536 | <dd> |
|
|
1537 | Like <a href="#item_start"><code>start</code></a>, but sets the expiry timer to c<urxvt::NOW + $delay>. |
1213 | </dd> |
1538 | </dd> |
1214 | <p></p> |
1539 | <p></p> |
1215 | <dt><strong><a name="item_stop">$timer = $timer->stop</a></strong><br /> |
1540 | <dt><strong><a name="item_stop">$timer = $timer->stop</a></strong><br /> |
1216 | </dt> |
1541 | </dt> |
1217 | <dd> |
1542 | <dd> |
… | |
… | |
1275 | Stop watching for events on the given filehandle. |
1600 | Stop watching for events on the given filehandle. |
1276 | </dd> |
1601 | </dd> |
1277 | <p></p></dl> |
1602 | <p></p></dl> |
1278 | <p> |
1603 | <p> |
1279 | </p> |
1604 | </p> |
|
|
1605 | <h2><a name="the_urxvt__iw_class">The <code>urxvt::iw</code> Class</a></h2> |
|
|
1606 | <p>This class implements idle watchers, that get called automatically when |
|
|
1607 | the process is idle. They should return as fast as possible, after doing |
|
|
1608 | some useful work.</p> |
|
|
1609 | <dl> |
|
|
1610 | <dt><strong><a name="item__24iw__3d_new_urxvt_3a_3aiw">$iw = new urxvt::iw</a></strong><br /> |
|
|
1611 | </dt> |
|
|
1612 | <dd> |
|
|
1613 | Create a new idle watcher object in stopped state. |
|
|
1614 | </dd> |
|
|
1615 | <p></p> |
|
|
1616 | <dt><strong>$iw = $iw->cb (sub { my ($iw) = @_; ... })</strong><br /> |
|
|
1617 | </dt> |
|
|
1618 | <dd> |
|
|
1619 | Set the callback to be called when the watcher triggers. |
|
|
1620 | </dd> |
|
|
1621 | <p></p> |
|
|
1622 | <dt><strong>$timer = $timer->start</strong><br /> |
|
|
1623 | </dt> |
|
|
1624 | <dd> |
|
|
1625 | Start the watcher. |
|
|
1626 | </dd> |
|
|
1627 | <p></p> |
|
|
1628 | <dt><strong>$timer = $timer->stop</strong><br /> |
|
|
1629 | </dt> |
|
|
1630 | <dd> |
|
|
1631 | Stop the watcher. |
|
|
1632 | </dd> |
|
|
1633 | <p></p></dl> |
|
|
1634 | <p> |
|
|
1635 | </p> |
|
|
1636 | <h2><a name="the_urxvt__pw_class">The <code>urxvt::pw</code> Class</a></h2> |
|
|
1637 | <p>This class implements process watchers. They create an event whenever a |
|
|
1638 | process exits, after which they stop automatically.</p> |
|
|
1639 | <pre> |
|
|
1640 | my $pid = fork; |
|
|
1641 | ... |
|
|
1642 | $term->{pw} = urxvt::pw |
|
|
1643 | ->new |
|
|
1644 | ->start ($pid) |
|
|
1645 | ->cb (sub { |
|
|
1646 | my ($pw, $exit_status) = @_; |
|
|
1647 | ... |
|
|
1648 | });</pre> |
|
|
1649 | <dl> |
|
|
1650 | <dt><strong><a name="item__24pw__3d_new_urxvt_3a_3apw">$pw = new urxvt::pw</a></strong><br /> |
|
|
1651 | </dt> |
|
|
1652 | <dd> |
|
|
1653 | Create a new process watcher in stopped state. |
|
|
1654 | </dd> |
|
|
1655 | <p></p> |
|
|
1656 | <dt><strong>$pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })</strong><br /> |
|
|
1657 | </dt> |
|
|
1658 | <dd> |
|
|
1659 | Set the callback to be called when the timer triggers. |
|
|
1660 | </dd> |
|
|
1661 | <p></p> |
|
|
1662 | <dt><strong>$pw = $timer->start ($pid)</strong><br /> |
|
|
1663 | </dt> |
|
|
1664 | <dd> |
|
|
1665 | Tells the wqtcher to start watching for process <code>$pid</code>. |
|
|
1666 | </dd> |
|
|
1667 | <p></p> |
|
|
1668 | <dt><strong>$pw = $pw->stop</strong><br /> |
|
|
1669 | </dt> |
|
|
1670 | <dd> |
|
|
1671 | Stop the watcher. |
|
|
1672 | </dd> |
|
|
1673 | <p></p></dl> |
|
|
1674 | <p> |
|
|
1675 | </p> |
1280 | <hr /> |
1676 | <hr /> |
1281 | <h1><a name="environment">ENVIRONMENT</a></h1> |
1677 | <h1><a name="environment">ENVIRONMENT</a></h1> |
1282 | <p> |
1678 | <p> |
1283 | </p> |
1679 | </p> |
1284 | <h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> |
1680 | <h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> |
… | |
… | |
1287 | <dl> |
1683 | <dl> |
1288 | <dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br /> |
1684 | <dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br /> |
1289 | </dt> |
1685 | </dt> |
1290 | <dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">>= 3 - script loading and management</a></strong><br /> |
1686 | <dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">>= 3 - script loading and management</a></strong><br /> |
1291 | </dt> |
1687 | </dt> |
1292 | <dt><strong><a name="item__3e_3d10__2d_all_events_received">>=10 - all events received</a></strong><br /> |
1688 | <dt><strong><a name="item__3e_3d10__2d_all_called_hooks">>=10 - all called hooks</a></strong><br /> |
|
|
1689 | </dt> |
|
|
1690 | <dt><strong><a name="item__3e_3d11__2d_hook_reutrn_values">>=11 - hook reutrn values</a></strong><br /> |
1293 | </dt> |
1691 | </dt> |
1294 | </dl> |
1692 | </dl> |
1295 | <p> |
1693 | <p> |
1296 | </p> |
1694 | </p> |
1297 | <hr /> |
1695 | <hr /> |