| … | |
… | |
| 28 | <li><a href="#the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></li> |
28 | <li><a href="#the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></li> |
| 29 | <li><a href="#the_urxvt__term_class">The <code>urxvt::term</code> Class</a></li> |
29 | <li><a href="#the_urxvt__term_class">The <code>urxvt::term</code> Class</a></li> |
| 30 | <li><a href="#the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></li> |
30 | <li><a href="#the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></li> |
| 31 | <li><a href="#the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></li> |
31 | <li><a href="#the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></li> |
| 32 | <li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li> |
32 | <li><a href="#the_urxvt__iow_class">The <code>urxvt::iow</code> Class</a></li> |
|
|
33 | <li><a href="#the_urxvt__iw_class">The <code>urxvt::iw</code> Class</a></li> |
|
|
34 | <li><a href="#the_urxvt__pw_class">The <code>urxvt::pw</code> Class</a></li> |
| 33 | </ul> |
35 | </ul> |
| 34 | |
36 | |
| 35 | <li><a href="#environment">ENVIRONMENT</a></li> |
37 | <li><a href="#environment">ENVIRONMENT</a></li> |
| 36 | <ul> |
38 | <ul> |
| 37 | |
39 | |
| … | |
… | |
| 80 | <p>This section describes the extensions delivered with this release. You can |
82 | <p>This section describes the extensions delivered with this release. You can |
| 81 | find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> |
83 | find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> |
| 82 | <p>You can activate them like this:</p> |
84 | <p>You can activate them like this:</p> |
| 83 | <pre> |
85 | <pre> |
| 84 | rxvt -pe <extensionname></pre> |
86 | rxvt -pe <extensionname></pre> |
|
|
87 | <p>Or by adding them to the resource for extensions loaded by default:</p> |
|
|
88 | <pre> |
|
|
89 | URxvt.perl-ext-common: default,automove-background,selection-autotransform</pre> |
| 85 | <dl> |
90 | <dl> |
| 86 | <dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br /> |
91 | <dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br /> |
| 87 | </dt> |
92 | </dt> |
| 88 | <dd> |
93 | <dd> |
| 89 | (More) intelligent selection. This extension tries to be more intelligent |
94 | (More) intelligent selection. This extension tries to be more intelligent |
| 90 | when the user extends selections (double-click). Right now, it tries to |
95 | when the user extends selections (double-click and further clicks). Right |
| 91 | select urls and complete shell-quoted arguments, which is very convenient, |
96 | now, it tries to select words, urls and complete shell-quoted |
| 92 | too, if your <em>ls</em> supports <code>--quoting-style=shell</code>. |
97 | arguments, which is very convenient, too, if your <em>ls</em> supports |
| 93 | </dd> |
98 | <code>--quoting-style=shell</code>. |
| 94 | <dd> |
99 | </dd> |
|
|
100 | <dd> |
|
|
101 | <p>A double-click usually selects the word under the cursor, further clicks |
|
|
102 | will enlarge the selection.</p> |
|
|
103 | </dd> |
|
|
104 | <dd> |
|
|
105 | <p>The selection works by trying to match a number of regexes and displaying |
|
|
106 | them in increasing order of length. You can add your own regexes by |
|
|
107 | specifying resources of the form:</p> |
|
|
108 | </dd> |
|
|
109 | <dd> |
|
|
110 | <pre> |
|
|
111 | URxvt.selection.pattern-0: perl-regex |
|
|
112 | URxvt.selection.pattern-1: perl-regex |
|
|
113 | ...</pre> |
|
|
114 | </dd> |
|
|
115 | <dd> |
|
|
116 | <p>The index number (0, 1...) must not have any holes, and each regex must |
|
|
117 | contain at least one pair of capturing parentheses, which will be used for |
|
|
118 | the match. For example, the followign adds a regex that matches everything |
|
|
119 | between two vertical bars:</p> |
|
|
120 | </dd> |
|
|
121 | <dd> |
|
|
122 | <pre> |
|
|
123 | URxvt.selection.pattern-0: \\|([^|]+)\\|</pre> |
|
|
124 | </dd> |
|
|
125 | <dd> |
|
|
126 | <p>Another example: Programs I use often output ``absolute path: '' at the |
|
|
127 | beginning of a line when they process multiple files. The following |
|
|
128 | pattern matches the filename (note, there is a single space at the very |
|
|
129 | end):</p> |
|
|
130 | </dd> |
|
|
131 | <dd> |
|
|
132 | <pre> |
|
|
133 | URxvt.selection.pattern-0: ^(/[^:]+):\</pre> |
|
|
134 | </dd> |
|
|
135 | <dd> |
|
|
136 | <p>You can look at the source of the selection extension to see more |
|
|
137 | interesting uses, such as parsing a line from beginning to end.</p> |
|
|
138 | </dd> |
|
|
139 | <dd> |
| 95 | <p>It also offers the following bindable keyboard command:</p> |
140 | <p>This extension also offers following bindable keyboard commands:</p> |
| 96 | </dd> |
141 | </dd> |
| 97 | <dl> |
142 | <dl> |
| 98 | <dt><strong><a name="item_rot13">rot13</a></strong><br /> |
143 | <dt><strong><a name="item_rot13">rot13</a></strong><br /> |
| 99 | </dt> |
144 | </dt> |
| 100 | <dd> |
145 | <dd> |
| … | |
… | |
| 109 | </dt> |
154 | </dt> |
| 110 | <dd> |
155 | <dd> |
| 111 | Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at |
156 | Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at |
| 112 | runtime. |
157 | runtime. |
| 113 | </dd> |
158 | </dd> |
|
|
159 | <dd> |
|
|
160 | <p>Other extensions can extend this popup menu by pushing a code reference |
|
|
161 | onto <code>@{ $term-</code>{option_popup_hook} }>, which gets called whenever the |
|
|
162 | popup is being displayed.</p> |
|
|
163 | </dd> |
|
|
164 | <dd> |
|
|
165 | <p>It's sole argument is the popup menu, which can be modified. It should |
|
|
166 | either return nothing or a string, the initial boolean value and a code |
|
|
167 | reference. The string will be used as button text and the code reference |
|
|
168 | will be called when the toggle changes, with the new boolean value as |
|
|
169 | first argument.</p> |
|
|
170 | </dd> |
|
|
171 | <dd> |
|
|
172 | <p>The following will add an entry <code>myoption</code> that changes |
|
|
173 | <code>$self-</code>{myoption}>:</p> |
|
|
174 | </dd> |
|
|
175 | <dd> |
|
|
176 | <pre> |
|
|
177 | push @{ $self->{term}{option_popup_hook} }, sub { |
|
|
178 | ("my option" => $myoption, sub { $self->{myoption} = $_[0] }) |
|
|
179 | };</pre> |
|
|
180 | </dd> |
| 114 | <p></p> |
181 | <p></p> |
| 115 | <dt><strong>selection-popup (enabled by default)</strong><br /> |
182 | <dt><strong>selection-popup (enabled by default)</strong><br /> |
| 116 | </dt> |
183 | </dt> |
| 117 | <dd> |
184 | <dd> |
| 118 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
185 | 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 |
186 | text into various other formats/action (such as uri unescaping, perl |
| 120 | evalution, web-browser starting etc.), depending on content. |
187 | evaluation, web-browser starting etc.), depending on content. |
|
|
188 | </dd> |
|
|
189 | <dd> |
|
|
190 | <p>Other extensions can extend this popup menu by pushing a code reference |
|
|
191 | onto <code>@{ $term-</code>{selection_popup_hook} }>, which gets called whenever the |
|
|
192 | popup is being displayed.</p> |
|
|
193 | </dd> |
|
|
194 | <dd> |
|
|
195 | <p>It's sole argument is the popup menu, which can be modified. The selection |
|
|
196 | is in <code>$_</code>, which can be used to decide wether to add something or not. |
|
|
197 | It should either return nothing or a string and a code reference. The |
|
|
198 | string will be used as button text and the code reference will be called |
|
|
199 | when the button gets activated and should transform <code>$_</code>.</p> |
|
|
200 | </dd> |
|
|
201 | <dd> |
|
|
202 | <p>The following will add an entry <code>a to b</code> that transforms all <code>a</code>s in |
|
|
203 | the selection to <code>b</code>s, but only if the selection currently contains any |
|
|
204 | <code>a</code>s:</p> |
|
|
205 | </dd> |
|
|
206 | <dd> |
|
|
207 | <pre> |
|
|
208 | push @{ $self->{term}{selection_popup_hook} }, sub { |
|
|
209 | /a/ ? ("a to be" => sub { s/a/b/g } |
|
|
210 | : () |
|
|
211 | };</pre> |
| 121 | </dd> |
212 | </dd> |
| 122 | <p></p> |
213 | <p></p> |
| 123 | <dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback<hotkey> (enabled by default)</a></strong><br /> |
214 | <dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback<hotkey> (enabled by default)</a></strong><br /> |
| 124 | </dt> |
215 | </dt> |
| 125 | <dd> |
216 | <dd> |
| 126 | Adds regex search functionality to the scrollback buffer, triggered |
217 | Adds regex search functionality to the scrollback buffer, triggered |
| 127 | by a hotkey (default: <code>M-s</code>). When in search mode, normal terminal |
218 | by a hotkey (default: <code>M-s</code>). While in search mode, normal terminal |
| 128 | input/output is suspended. |
219 | input/output is suspended and a regex is displayed at the bottom of the |
| 129 | </dd> |
220 | screen. |
| 130 | <dd> |
221 | </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> |
222 | <dd> |
| 136 | <p></p> |
223 | <p>Inputting characters appends them to the regex and continues incremental |
| 137 | <dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> |
224 | search. <code>BackSpace</code> removes a character from the regex, <code>Up</code> and <code>Down</code> |
| 138 | </dt> |
225 | search upwards/downwards in the scrollback buffer, <code>End</code> jumps to the |
|
|
226 | bottom. <code>Escape</code> leaves search mode and returns to the point where search |
|
|
227 | was started, while <code>Enter</code> or <code>Return</code> stay at the current position and |
|
|
228 | additionally stores the first match in the current line into the primary |
|
|
229 | selection.</p> |
| 139 | <dd> |
230 | </dd> |
| 140 | Displays a digital clock using the built-in overlay. |
231 | <p></p> |
|
|
232 | <dt><strong><a name="item_readline">readline (enabled by default)</a></strong><br /> |
|
|
233 | </dt> |
|
|
234 | <dd> |
|
|
235 | A support package that tries to make editing with readline easier. At the |
|
|
236 | moment, it reacts to clicking with the left mouse button by trying to |
|
|
237 | move the text cursor to this position. It does so by generating as many |
|
|
238 | cursor-left or cursor-right keypresses as required (the this only works |
|
|
239 | for programs that correctly support wide characters). |
|
|
240 | </dd> |
|
|
241 | <dd> |
|
|
242 | <p>To avoid too many false positives, this is only done when:</p> |
|
|
243 | </dd> |
|
|
244 | <dl> |
|
|
245 | <dt><strong><a name="item__2d_the_tty_is_in_icanon_state_2e">- the tty is in ICANON state.</a></strong><br /> |
|
|
246 | </dt> |
|
|
247 | <dt><strong><a name="item__2d_the_text_cursor_is_visible_2e">- the text cursor is visible.</a></strong><br /> |
|
|
248 | </dt> |
|
|
249 | <dt><strong><a name="item__2d_the_primary_screen_is_currently_being_displaye">- the primary screen is currently being displayed.</a></strong><br /> |
|
|
250 | </dt> |
|
|
251 | <dt><strong><a name="item_same">- the mouse is on the same (multi-row-) line as the text cursor.</a></strong><br /> |
|
|
252 | </dt> |
|
|
253 | </dl> |
|
|
254 | <p>The normal selection mechanism isn't disabled, so quick successive clicks |
|
|
255 | might interfere with selection creation in harmless ways.</p> |
|
|
256 | <dt><strong><a name="item_selection_2dautotransform">selection-autotransform</a></strong><br /> |
|
|
257 | </dt> |
|
|
258 | <dd> |
|
|
259 | This selection allows you to do automatic transforms on a selection |
|
|
260 | whenever a selection is made. |
|
|
261 | </dd> |
|
|
262 | <dd> |
|
|
263 | <p>It works by specifying perl snippets (most useful is a single <code>s///</code> |
|
|
264 | operator) that modify <code>$_</code> as resources:</p> |
|
|
265 | </dd> |
|
|
266 | <dd> |
|
|
267 | <pre> |
|
|
268 | URxvt.selection-autotransform.0: transform |
|
|
269 | URxvt.selection-autotransform.1: transform |
|
|
270 | ...</pre> |
|
|
271 | </dd> |
|
|
272 | <dd> |
|
|
273 | <p>For example, the following will transform selections of the form |
|
|
274 | <code>filename:number</code>, often seen in compiler messages, into <code>vi +$filename |
|
|
275 | $word</code>:</p> |
|
|
276 | </dd> |
|
|
277 | <dd> |
|
|
278 | <pre> |
|
|
279 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/</pre> |
|
|
280 | </dd> |
|
|
281 | <dd> |
|
|
282 | <p>And this example matches the same,but replaces it with vi-commands you can |
|
|
283 | paste directly into your (vi :) editor:</p> |
|
|
284 | </dd> |
|
|
285 | <dd> |
|
|
286 | <pre> |
|
|
287 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/</pre> |
|
|
288 | </dd> |
|
|
289 | <dd> |
|
|
290 | <p>Of course, this can be modified to suit your needs and your editor :)</p> |
|
|
291 | </dd> |
|
|
292 | <dd> |
|
|
293 | <p>To expand the example above to typical perl error messages (``XXX at |
|
|
294 | FILENAME line YYY.''), you need a slightly more elaborate solution:</p> |
|
|
295 | </dd> |
|
|
296 | <dd> |
|
|
297 | <pre> |
|
|
298 | URxvt.selection.pattern-0: ( at .*? line \\d+[,.]) |
|
|
299 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/</pre> |
|
|
300 | </dd> |
|
|
301 | <dd> |
|
|
302 | <p>The first line tells the selection code to treat the unchanging part of |
|
|
303 | every error message as a selection pattern, and the second line transforms |
|
|
304 | the message into vi commands to load the file.</p> |
|
|
305 | </dd> |
|
|
306 | <p></p> |
|
|
307 | <dt><strong><a name="item_tabbed">tabbed</a></strong><br /> |
|
|
308 | </dt> |
|
|
309 | <dd> |
|
|
310 | This transforms the terminal into a tabbar with additional terminals, that |
|
|
311 | is, it implements what is commonly refered to as ``tabbed terminal''. The topmost line |
|
|
312 | displays a ``[NEW]'' button, which, when clicked, will add a new tab, followed by one |
|
|
313 | button per tab. |
|
|
314 | </dd> |
|
|
315 | <dd> |
|
|
316 | <p>Clicking a button will activate that tab. Pressing <strong>Shift-Left</strong> and |
|
|
317 | <strong>Shift-Right</strong> will switch to the tab left or right of the current one, |
|
|
318 | while <strong>Shift-Down</strong> creates a new tab.</p> |
|
|
319 | </dd> |
|
|
320 | <dd> |
|
|
321 | <p>The tabbar itself can be configured similarly to a normal terminal, but |
|
|
322 | with a resource class of <code>URxvt.tabbed</code>. In addition, it supports the |
|
|
323 | following four resources (shown with defaults):</p> |
|
|
324 | </dd> |
|
|
325 | <dd> |
|
|
326 | <pre> |
|
|
327 | URxvt.tabbed.tabbar-fg: <colour-index, default 3> |
|
|
328 | URxvt.tabbed.tabbar-bg: <colour-index, default 0> |
|
|
329 | URxvt.tabbed.tab-fg: <colour-index, default 0> |
|
|
330 | URxvt.tabbed.tab-bg: <colour-index, default 1></pre> |
|
|
331 | </dd> |
|
|
332 | <dd> |
|
|
333 | <p>See <em>COLOR AND GRAPHICS</em> in the <code>rxvt(1)</code> manpage for valid |
|
|
334 | indices.</p> |
| 141 | </dd> |
335 | </dd> |
| 142 | <p></p> |
336 | <p></p> |
| 143 | <dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> |
337 | <dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> |
| 144 | </dt> |
338 | </dt> |
| 145 | <dd> |
339 | <dd> |
| 146 | Uses per-line display filtering (<code>on_line_update</code>) to underline urls. |
340 | Uses per-line display filtering (<code>on_line_update</code>) to underline urls and |
|
|
341 | make them clickable. When middle-clicked, the program specified in the |
|
|
342 | resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with |
|
|
343 | the URL as first argument. |
|
|
344 | </dd> |
|
|
345 | <p></p> |
|
|
346 | <dt><strong><a name="item_xim_2donthespot">xim-onthespot</a></strong><br /> |
|
|
347 | </dt> |
|
|
348 | <dd> |
|
|
349 | This (experimental) perl extension implements OnTheSpot editing. It does |
|
|
350 | not work perfectly, and some input methods don't seem to work well with |
|
|
351 | OnTheSpot editing in general, but it seems to work at leats for SCIM and |
|
|
352 | kinput2. |
|
|
353 | </dd> |
|
|
354 | <dd> |
|
|
355 | <p>You enable it by specifying this extension and a preedit style of |
|
|
356 | <code>OnTheSpot</code>, i.e.:</p> |
|
|
357 | </dd> |
|
|
358 | <dd> |
|
|
359 | <pre> |
|
|
360 | rxvt -pt OnTheSpot -pe xim-onthespot</pre> |
|
|
361 | </dd> |
|
|
362 | <p></p> |
|
|
363 | <dt><strong><a name="item_automove_2dbackground">automove-background</a></strong><br /> |
|
|
364 | </dt> |
|
|
365 | <dd> |
|
|
366 | This is basically a one-line extension that dynamically changes the background pixmap offset |
|
|
367 | to the window position, in effect creating the same effect as pseudo transparency with |
|
|
368 | a custom pixmap. No scaling is supported in this mode. Exmaple: |
|
|
369 | </dd> |
|
|
370 | <dd> |
|
|
371 | <pre> |
|
|
372 | rxvt -pixmap background.xpm -pe automove-background</pre> |
| 147 | </dd> |
373 | </dd> |
| 148 | <p></p> |
374 | <p></p> |
| 149 | <dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br /> |
375 | <dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br /> |
| 150 | </dt> |
376 | </dt> |
| 151 | <dd> |
377 | <dd> |
| 152 | A not very useful example of filtering all text output to the terminal, |
378 | 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 |
379 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
| 154 | similar-looking ascii character. |
380 | similar-looking ascii character. |
|
|
381 | </dd> |
|
|
382 | <p></p> |
|
|
383 | <dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> |
|
|
384 | </dt> |
|
|
385 | <dd> |
|
|
386 | Displays a digital clock using the built-in overlay. |
|
|
387 | </dd> |
|
|
388 | <p></p> |
|
|
389 | <dt><strong><a name="item_remote_2dclipboard">remote-clipboard</a></strong><br /> |
|
|
390 | </dt> |
|
|
391 | <dd> |
|
|
392 | Somewhat of a misnomer, this extension adds two menu entries to the |
|
|
393 | selection popup that allows one ti run external commands to store the |
|
|
394 | selection somewhere and fetch it again. |
|
|
395 | </dd> |
|
|
396 | <dd> |
|
|
397 | <p>We use it to implement a ``distributed selection mechanism'', which just |
|
|
398 | means that one command uploads the file to a remote server, and another |
|
|
399 | reads it.</p> |
|
|
400 | </dd> |
|
|
401 | <dd> |
|
|
402 | <p>The commands can be set using the <code>URxvt.remote-selection.store</code> and |
|
|
403 | <code>URxvt.remote-selection.fetch</code> resources. The first should read the |
|
|
404 | selection to store from STDIN (always in UTF-8), the second should provide |
|
|
405 | the selection data on STDOUT (also in UTF-8).</p> |
|
|
406 | </dd> |
|
|
407 | <dd> |
|
|
408 | <p>The defaults (which are likely useless to you) use rsh and cat:</p> |
|
|
409 | </dd> |
|
|
410 | <dd> |
|
|
411 | <pre> |
|
|
412 | URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' |
|
|
413 | URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'</pre> |
|
|
414 | </dd> |
|
|
415 | <p></p> |
|
|
416 | <dt><strong><a name="item_selection_2dpastebin">selection-pastebin</a></strong><br /> |
|
|
417 | </dt> |
|
|
418 | <dd> |
|
|
419 | This is a little rarely useful extension that Uploads the selection as |
|
|
420 | textfile to a remote site (or does other things). (The implementation is |
|
|
421 | not currently secure for use in a multiuser environment as it writes to |
|
|
422 | <em>/tmp</em> directly.). |
|
|
423 | </dd> |
|
|
424 | <dd> |
|
|
425 | <p>It listens to the <code>selection-pastebin:remote-pastebin</code> keyboard command, |
|
|
426 | i.e.</p> |
|
|
427 | </dd> |
|
|
428 | <dd> |
|
|
429 | <pre> |
|
|
430 | URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin</pre> |
|
|
431 | </dd> |
|
|
432 | <dd> |
|
|
433 | <p>Pressing this combination runs a command with <code>%</code> replaced by the name of |
|
|
434 | the textfile. This command can be set via a resource:</p> |
|
|
435 | </dd> |
|
|
436 | <dd> |
|
|
437 | <pre> |
|
|
438 | URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.</pre> |
|
|
439 | </dd> |
|
|
440 | <dd> |
|
|
441 | <p>And the default is likely not useful to anybody but the few people around |
|
|
442 | here :)</p> |
|
|
443 | </dd> |
|
|
444 | <dd> |
|
|
445 | <p>The name of the textfile is the hex encoded md5 sum of the selection, so |
|
|
446 | the same content should lead to the same filename.</p> |
|
|
447 | </dd> |
|
|
448 | <dd> |
|
|
449 | <p>After a successful upload the selection will be replaced by the text given |
|
|
450 | in the <code>selection-pastebin-url</code> resource (again, the % is the placeholder |
|
|
451 | for the filename):</p> |
|
|
452 | </dd> |
|
|
453 | <dd> |
|
|
454 | <pre> |
|
|
455 | URxvt.selection-pastebin.url: <a href="http://www.ta-sa.org/files/txt/%">http://www.ta-sa.org/files/txt/%</a></pre> |
| 155 | </dd> |
456 | </dd> |
| 156 | <p></p> |
457 | <p></p> |
| 157 | <dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> |
458 | <dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> |
| 158 | </dt> |
459 | </dt> |
| 159 | <dd> |
460 | <dd> |
| … | |
… | |
| 183 | <dl> |
484 | <dl> |
| 184 | <dt><strong><a name="item__24text">$text</a></strong><br /> |
485 | <dt><strong><a name="item__24text">$text</a></strong><br /> |
| 185 | </dt> |
486 | </dt> |
| 186 | <dd> |
487 | <dd> |
| 187 | Rxvt-unicodes special way of encoding text, where one ``unicode'' character |
488 | 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. |
489 | always represents one screen cell. See <a href="#item_row_t">ROW_t</a> for a discussion of this format. |
| 189 | </dd> |
490 | </dd> |
| 190 | <p></p> |
491 | <p></p> |
| 191 | <dt><strong><a name="item__24string">$string</a></strong><br /> |
492 | <dt><strong><a name="item__24string">$string</a></strong><br /> |
| 192 | </dt> |
493 | </dt> |
| 193 | <dd> |
494 | <dd> |
| … | |
… | |
| 242 | <h2><a name="hooks">Hooks</a></h2> |
543 | <h2><a name="hooks">Hooks</a></h2> |
| 243 | <p>The following subroutines can be declared in extension files, and will be |
544 | <p>The following subroutines can be declared in extension files, and will be |
| 244 | called whenever the relevant event happens.</p> |
545 | called whenever the relevant event happens.</p> |
| 245 | <p>The first argument passed to them is an extension oject as described in |
546 | <p>The first argument passed to them is an extension oject as described in |
| 246 | the in the <code>Extension Objects</code> section.</p> |
547 | 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 |
548 | <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 |
549 | 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> |
550 | 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> |
551 | <p><em>When in doubt, return a false value (preferably <code>()</code>). </em>></p> |
| 251 | <dl> |
552 | <dl> |
| 252 | <dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> |
553 | <dt><strong><a name="item_on_init__24term">on_init $term</a></strong><br /> |
| 253 | </dt> |
554 | </dt> |
| 254 | <dd> |
555 | <dd> |
| 255 | Called after a new terminal object has been initialized, but before |
556 | 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 |
557 | 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 |
558 | call or deliver senseless data, as terminal size and other characteristics |
| 258 | have not yet been determined. You can safely query and change resources, |
559 | have not yet been determined. You can safely query and change resources |
| 259 | though. |
560 | and options, though. For many purposes the <code>on_start</code> hook is a better |
|
|
561 | place. |
|
|
562 | </dd> |
|
|
563 | <p></p> |
|
|
564 | <dt><strong><a name="item_on_start__24term">on_start $term</a></strong><br /> |
|
|
565 | </dt> |
|
|
566 | <dd> |
|
|
567 | Called at the very end of initialisation of a new terminal, just before |
|
|
568 | trying to map (display) the toplevel and returning to the mainloop. |
|
|
569 | </dd> |
|
|
570 | <p></p> |
|
|
571 | <dt><strong><a name="item_on_destroy__24term">on_destroy $term</a></strong><br /> |
|
|
572 | </dt> |
|
|
573 | <dd> |
|
|
574 | Called whenever something tries to destroy terminal, when the terminal is |
|
|
575 | still fully functional (not for long, though). |
| 260 | </dd> |
576 | </dd> |
| 261 | <p></p> |
577 | <p></p> |
| 262 | <dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> |
578 | <dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> |
| 263 | </dt> |
579 | </dt> |
| 264 | <dd> |
580 | <dd> |
| 265 | Called after the screen is ``reset'' for any reason, such as resizing or |
581 | 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 |
582 | control sequences. Here is where you can react on changes to size-related |
| 267 | variables. |
583 | variables. |
| 268 | </dd> |
584 | </dd> |
| 269 | <p></p> |
585 | <p></p> |
| 270 | <dt><strong><a name="item_on_start__24term">on_start $term</a></strong><br /> |
586 | <dt><strong><a name="item_on_child_start__24term_2c__24pid">on_child_start $term, $pid</a></strong><br /> |
| 271 | </dt> |
587 | </dt> |
|
|
588 | <dd> |
|
|
589 | Called just after the child process has been <code>fork</code>ed. |
| 272 | <dd> |
590 | </dd> |
| 273 | Called at the very end of initialisation of a new terminal, just before |
591 | <p></p> |
| 274 | returning to the mainloop. |
592 | <dt><strong><a name="item_on_child_exit__24term_2c__24status">on_child_exit $term, $status</a></strong><br /> |
|
|
593 | </dt> |
|
|
594 | <dd> |
|
|
595 | Called just after the child process has exited. <code>$status</code> is the status |
|
|
596 | from <code>waitpid</code>. |
| 275 | </dd> |
597 | </dd> |
| 276 | <p></p> |
598 | <p></p> |
| 277 | <dt><strong><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a></strong><br /> |
599 | <dt><strong><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a></strong><br /> |
| 278 | </dt> |
600 | </dt> |
| 279 | <dd> |
601 | <dd> |
| … | |
… | |
| 301 | </dt> |
623 | </dt> |
| 302 | <dd> |
624 | <dd> |
| 303 | Called whenever the user tries to extend the selection (e.g. with a double |
625 | 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 |
626 | 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 |
627 | should extend the selection itelf and return true to suppress the built-in |
| 306 | processing. |
628 | processing. This can happen multiple times, as long as the callback |
|
|
629 | returns true, it will be called on every further click by the user and is |
|
|
630 | supposed to enlarge the selection more and more, if possible. |
| 307 | </dd> |
631 | </dd> |
| 308 | <dd> |
632 | <dd> |
| 309 | <p>See the <em>selection</em> example extension.</p> |
633 | <p>See the <em>selection</em> example extension.</p> |
| 310 | </dd> |
634 | </dd> |
| 311 | <p></p> |
635 | <p></p> |
| … | |
… | |
| 394 | </dt> |
718 | </dt> |
| 395 | <dd> |
719 | <dd> |
| 396 | Called just after the screen gets redrawn. See <code>on_refresh_begin</code>. |
720 | Called just after the screen gets redrawn. See <code>on_refresh_begin</code>. |
| 397 | </dd> |
721 | </dd> |
| 398 | <p></p> |
722 | <p></p> |
| 399 | <dt><strong><a name="item_on_keyboard_command__24term_2c__24string">on_keyboard_command $term, $string</a></strong><br /> |
723 | <dt><strong><a name="item_on_user_command__24term_2c__24string">on_user_command $term, $string</a></strong><br /> |
| 400 | </dt> |
724 | </dt> |
| 401 | <dd> |
725 | <dd> |
| 402 | Called whenever the user presses a key combination that has a |
726 | Called whenever the a user-configured event is being activated (e.g. via |
| 403 | <code>perl:string</code> action bound to it (see description of the <strong>keysym</strong> |
727 | a <code>perl:string</code> action bound to a key, see description of the <strong>keysym</strong> |
| 404 | resource in the <code>rxvt(1)</code> manpage). |
728 | resource in the <code>rxvt(1)</code> manpage). |
|
|
729 | </dd> |
|
|
730 | <dd> |
|
|
731 | <p>The event is simply the action string. This interface is assumed to change |
|
|
732 | slightly in the future.</p> |
|
|
733 | </dd> |
|
|
734 | <p></p> |
|
|
735 | <dt><strong><a name="item_on_x_event__24term_2c__24event">on_x_event $term, $event</a></strong><br /> |
|
|
736 | </dt> |
|
|
737 | <dd> |
|
|
738 | Called on every X event received on the vt window (and possibly other |
|
|
739 | windows). Should only be used as a last resort. Most event structure |
|
|
740 | members are not passed. |
| 405 | </dd> |
741 | </dd> |
| 406 | <p></p> |
742 | <p></p> |
| 407 | <dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> |
743 | <dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> |
| 408 | </dt> |
744 | </dt> |
| 409 | <dd> |
745 | <dd> |
| … | |
… | |
| 416 | <dd> |
752 | <dd> |
| 417 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
753 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
| 418 | focus out processing. |
754 | focus out processing. |
| 419 | </dd> |
755 | </dd> |
| 420 | <p></p> |
756 | <p></p> |
|
|
757 | <dt><strong><a name="item_on_configure_notify__24term_2c__24event">on_configure_notify $term, $event</a></strong><br /> |
|
|
758 | </dt> |
|
|
759 | <dt><strong><a name="item_on_property_notify__24term_2c__24event">on_property_notify $term, $event</a></strong><br /> |
|
|
760 | </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 /> |
761 | <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> |
762 | </dt> |
| 423 | <dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br /> |
763 | <dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br /> |
| 424 | </dt> |
764 | </dt> |
| 425 | <dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br /> |
765 | <dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br /> |
| … | |
… | |
| 436 | Called whenever the corresponding X event is received for the terminal If |
776 | Called whenever the corresponding X event is received for the terminal If |
| 437 | the hook returns true, then the even will be ignored by rxvt-unicode. |
777 | the hook returns true, then the even will be ignored by rxvt-unicode. |
| 438 | </dd> |
778 | </dd> |
| 439 | <dd> |
779 | <dd> |
| 440 | <p>The event is a hash with most values as named by Xlib (see the XEvent |
780 | <p>The event is a hash with most values as named by Xlib (see the XEvent |
| 441 | manpage), with the additional members <code>row</code> and <code>col</code>, which are the row |
781 | manpage), with the additional members <code>row</code> and <code>col</code>, which are the |
| 442 | and column under the mouse cursor.</p> |
782 | (real, not screen-based) row and column under the mouse cursor.</p> |
| 443 | </dd> |
783 | </dd> |
| 444 | <dd> |
784 | <dd> |
| 445 | <p><code>on_key_press</code> additionally receives the string rxvt-unicode would |
785 | <p><code>on_key_press</code> additionally receives the string rxvt-unicode would |
| 446 | output, if any, in locale-specific encoding.</p> |
786 | output, if any, in locale-specific encoding.</p> |
| 447 | </dd> |
787 | </dd> |
| 448 | <dd> |
788 | <dd> |
| 449 | <p>subwindow.</p> |
789 | <p>subwindow.</p> |
|
|
790 | </dd> |
|
|
791 | <p></p> |
|
|
792 | <dt><strong><a name="item_on_client_message__24term_2c__24event">on_client_message $term, $event</a></strong><br /> |
|
|
793 | </dt> |
|
|
794 | <dt><strong><a name="item_on_wm_protocols__24term_2c__24event">on_wm_protocols $term, $event</a></strong><br /> |
|
|
795 | </dt> |
|
|
796 | <dt><strong><a name="item_on_wm_delete_window__24term_2c__24event">on_wm_delete_window $term, $event</a></strong><br /> |
|
|
797 | </dt> |
|
|
798 | <dd> |
|
|
799 | Called when various types of ClientMessage events are received (all with |
|
|
800 | format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). |
| 450 | </dd> |
801 | </dd> |
| 451 | <p></p></dl> |
802 | <p></p></dl> |
| 452 | <p> |
803 | <p> |
| 453 | </p> |
804 | </p> |
| 454 | <h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> |
805 | <h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> |
| … | |
… | |
| 477 | <dd> |
828 | <dd> |
| 478 | The current terminal. This variable stores the current <code>urxvt::term</code> |
829 | The current terminal. This variable stores the current <code>urxvt::term</code> |
| 479 | object, whenever a callback/hook is executing. |
830 | object, whenever a callback/hook is executing. |
| 480 | </dd> |
831 | </dd> |
| 481 | <p></p> |
832 | <p></p> |
| 482 | <dt></dt> |
833 | <dt><strong><a name="item__40urxvt_3a_3aterm_init">@urxvt::TERM_INIT</a></strong><br /> |
| 483 | </dl> |
834 | </dt> |
|
|
835 | <dd> |
|
|
836 | All coderefs in this array will be called as methods of the next newly |
|
|
837 | created <code>urxvt::term</code> object (during the <code>on_init</code> phase). The array |
|
|
838 | gets cleared before the codereferences that were in it are being executed, |
|
|
839 | so coderefs can push themselves onto it again if they so desire. |
|
|
840 | </dd> |
|
|
841 | <dd> |
|
|
842 | <p>This complements to the perl-eval commandline option, but gets executed |
|
|
843 | first.</p> |
|
|
844 | </dd> |
|
|
845 | <p></p> |
|
|
846 | <dt><strong><a name="item__40urxvt_3a_3aterm_ext">@urxvt::TERM_EXT</a></strong><br /> |
|
|
847 | </dt> |
|
|
848 | <dd> |
|
|
849 | Works similar to <code>@TERM_INIT</code>, but contains perl package/class names, which |
|
|
850 | get registered as normal extensions after calling the hooks in <code>@TERM_INIT</code> |
|
|
851 | but before other extensions. Gets cleared just like <code>@TERM_INIT</code>. |
|
|
852 | </dd> |
|
|
853 | <p></p></dl> |
| 484 | <p> |
854 | <p> |
| 485 | </p> |
855 | </p> |
| 486 | <h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> |
856 | <h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> |
| 487 | <dl> |
857 | <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 /> |
858 | <dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br /> |
| 499 | </dt> |
859 | </dt> |
| 500 | <dd> |
860 | <dd> |
| 501 | Fatally aborts execution with the given error message. Avoid at all |
861 | Fatally aborts execution with the given error message. Avoid at all |
| 502 | costs! The only time this is acceptable is when the terminal process |
862 | costs! The only time this is acceptable is when the terminal process |
| … | |
… | |
| 512 | </dd> |
872 | </dd> |
| 513 | <dd> |
873 | <dd> |
| 514 | <p>Using this function has the advantage that its output ends up in the |
874 | <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> |
875 | correct place, e.g. on stderr of the connecting urxvtc client.</p> |
| 516 | </dd> |
876 | </dd> |
| 517 | <p></p> |
877 | <dd> |
| 518 | <dt><strong><a name="item__24is_safe__3d_urxvt_3a_3asafe">$is_safe = urxvt::safe</a></strong><br /> |
878 | <p>Messages have a size limit of 1023 bytes currently.</p> |
| 519 | </dt> |
|
|
| 520 | <dd> |
879 | </dd> |
| 521 | Returns true when it is safe to do potentially unsafe things, such as |
880 | <p></p> |
| 522 | evaluating perl code specified by the user. This is true when urxvt was |
881 | <dt><strong><a name="item__40terms__3d_urxvt_3a_3atermlist">@terms = urxvt::termlist</a></strong><br /> |
| 523 | started setuid or setgid. |
882 | </dt> |
|
|
883 | <dd> |
|
|
884 | Returns all urxvt::term objects that exist in this process, regardless of |
|
|
885 | wether they are started, being destroyed etc., so be careful. Only term |
|
|
886 | objects that have perl extensions attached will be returned (because there |
|
|
887 | is no urxvt::term objet associated with others). |
| 524 | </dd> |
888 | </dd> |
| 525 | <p></p> |
889 | <p></p> |
| 526 | <dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> |
890 | <dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> |
| 527 | </dt> |
891 | </dt> |
| 528 | <dd> |
892 | <dd> |
| … | |
… | |
| 532 | <dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br /> |
896 | <dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br /> |
| 533 | </dt> |
897 | </dt> |
| 534 | <dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
898 | <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, |
899 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
| 536 | Button4Mask, Button5Mask, AnyModifier</a></strong><br /> |
900 | Button4Mask, Button5Mask, AnyModifier</a></strong><br /> |
|
|
901 | </dt> |
|
|
902 | <dt><strong><a name="item_urxvt_3a_3anoeventmask_2c_keypressmask_2c_keyrelea">urxvt::NoEventMask, KeyPressMask, KeyReleaseMask, |
|
|
903 | ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, |
|
|
904 | PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask, |
|
|
905 | Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask, |
|
|
906 | KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask, |
|
|
907 | ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask, |
|
|
908 | FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask</a></strong><br /> |
|
|
909 | </dt> |
|
|
910 | <dt><strong><a name="item_urxvt_3a_3akeypress_2c_keyrelease_2c_buttonpress_2">urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify, |
|
|
911 | EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose, |
|
|
912 | GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify, |
|
|
913 | UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify, |
|
|
914 | ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify, |
|
|
915 | CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, |
|
|
916 | SelectionNotify, ColormapNotify, ClientMessage, MappingNotify</a></strong><br /> |
| 537 | </dt> |
917 | </dt> |
| 538 | <dd> |
918 | <dd> |
| 539 | Various constants for use in X calls and event processing. |
919 | Various constants for use in X calls and event processing. |
| 540 | </dd> |
920 | </dd> |
| 541 | <p></p></dl> |
921 | <p></p></dl> |
| … | |
… | |
| 580 | <p></p> |
960 | <p></p> |
| 581 | <dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_fgcolor__24rend_2c__24n">$rend = urxvt::SET_FGCOLOR $rend, $new_colour</a></strong><br /> |
961 | <dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_fgcolor__24rend_2c__24n">$rend = urxvt::SET_FGCOLOR $rend, $new_colour</a></strong><br /> |
| 582 | </dt> |
962 | </dt> |
| 583 | <dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_bgcolor__24rend_2c__24n">$rend = urxvt::SET_BGCOLOR $rend, $new_colour</a></strong><br /> |
963 | <dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_bgcolor__24rend_2c__24n">$rend = urxvt::SET_BGCOLOR $rend, $new_colour</a></strong><br /> |
| 584 | </dt> |
964 | </dt> |
|
|
965 | <dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_color__24rend_2c__24new">$rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg</a></strong><br /> |
|
|
966 | </dt> |
| 585 | <dd> |
967 | <dd> |
| 586 | Replace the foreground/background colour in the rendition mask with the |
968 | Replace the foreground/background colour in the rendition mask with the |
| 587 | specified one. |
969 | specified one. |
| 588 | </dd> |
970 | </dd> |
| 589 | <p></p> |
971 | <p></p> |
| … | |
… | |
| 612 | work.</p> |
994 | work.</p> |
| 613 | <p> |
995 | <p> |
| 614 | </p> |
996 | </p> |
| 615 | <h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> |
997 | <h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> |
| 616 | <dl> |
998 | <dl> |
|
|
999 | <dt><strong><a name="item__24term__3d_new_urxvt_3a_3aterm__24envhashref_2c__">$term = new urxvt::term $envhashref, $rxvtname, [arg...]</a></strong><br /> |
|
|
1000 | </dt> |
|
|
1001 | <dd> |
|
|
1002 | Creates a new terminal, very similar as if you had started it with system |
|
|
1003 | <code>$rxvtname, arg...</code>. <code>$envhashref</code> must be a reference to a <code>%ENV</code>-like |
|
|
1004 | hash which defines the environment of the new terminal. |
|
|
1005 | </dd> |
|
|
1006 | <dd> |
|
|
1007 | <p>Croaks (and probably outputs an error message) if the new instance |
|
|
1008 | couldn't be created. Returns <code>undef</code> if the new instance didn't |
|
|
1009 | initialise perl, and the terminal object otherwise. The <code>init</code> and |
|
|
1010 | <a href="#item_start"><code>start</code></a> hooks will be called before this call returns, and are free to |
|
|
1011 | refer to global data (which is race free).</p> |
|
|
1012 | </dd> |
|
|
1013 | <p></p> |
| 617 | <dt><strong><a name="item_destroy">$term->destroy</a></strong><br /> |
1014 | <dt><strong><a name="item_destroy">$term->destroy</a></strong><br /> |
| 618 | </dt> |
1015 | </dt> |
| 619 | <dd> |
1016 | <dd> |
| 620 | Destroy the terminal object (close the window, free resources |
1017 | Destroy the terminal object (close the window, free resources |
| 621 | etc.). Please note that rxvt will not exit as long as any event |
1018 | etc.). Please note that rxvt will not exit as long as any event |
| 622 | watchers (timers, io watchers) are still active. |
1019 | watchers (timers, io watchers) are still active. |
| 623 | </dd> |
1020 | </dd> |
| 624 | <p></p> |
1021 | <p></p> |
|
|
1022 | <dt><strong><a name="item_exec_async">$term->exec_async ($cmd[, @args])</a></strong><br /> |
|
|
1023 | </dt> |
|
|
1024 | <dd> |
|
|
1025 | Works like the combination of the <code>fork</code>/<code>exec</code> builtins, which executes |
|
|
1026 | (``starts'') programs in the background. This function takes care of setting |
|
|
1027 | the user environment before exec'ing the command (e.g. <code>PATH</code>) and should |
|
|
1028 | be preferred over explicit calls to <code>exec</code> or <code>system</code>. |
|
|
1029 | </dd> |
|
|
1030 | <dd> |
|
|
1031 | <p>Returns the pid of the subprocess or <code>undef</code> on error.</p> |
|
|
1032 | </dd> |
|
|
1033 | <p></p> |
| 625 | <dt><strong><a name="item_option">$isset = $term->option ($optval[, $set])</a></strong><br /> |
1034 | <dt><strong><a name="item_option">$isset = $term->option ($optval[, $set])</a></strong><br /> |
| 626 | </dt> |
1035 | </dt> |
| 627 | <dd> |
1036 | <dd> |
| 628 | Returns true if the option specified by <code>$optval</code> is enabled, and |
1037 | 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 |
1038 | optionally change it. All option values are stored by name in the hash |
| … | |
… | |
| 635 | </dd> |
1044 | </dd> |
| 636 | <dd> |
1045 | <dd> |
| 637 | <pre> |
1046 | <pre> |
| 638 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
1047 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
| 639 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
1048 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
| 640 | pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating |
1049 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
| 641 | scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer |
1050 | scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput |
| 642 | secondaryScreen secondaryScroll skipBuiltinGlyphs transparent |
1051 | scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs |
| 643 | tripleclickwords utmpInhibit visualBell</pre> |
1052 | transparent tripleclickwords utmpInhibit visualBell</pre> |
| 644 | </dd> |
1053 | </dd> |
| 645 | <p></p> |
1054 | <p></p> |
| 646 | <dt><strong><a name="item_resource">$value = $term->resource ($name[, $newval])</a></strong><br /> |
1055 | <dt><strong><a name="item_resource">$value = $term->resource ($name[, $newval])</a></strong><br /> |
| 647 | </dt> |
1056 | </dt> |
| 648 | <dd> |
1057 | <dd> |
| … | |
… | |
| 673 | <pre> |
1082 | <pre> |
| 674 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
1083 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
| 675 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
1084 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
| 676 | display_name embed ext_bwidth fade font geometry hold iconName |
1085 | display_name embed ext_bwidth fade font geometry hold iconName |
| 677 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
1086 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
| 678 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
1087 | italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier |
| 679 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 |
1088 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
| 680 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
1089 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
| 681 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
1090 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
| 682 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
1091 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
| 683 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
1092 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
| 684 | shade term_name title transparent transparent_all tripleclickwords |
1093 | secondaryScreen secondaryScroll selectstyle shade term_name title |
|
|
1094 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
| 685 | utmpInhibit visualBell</pre> |
1095 | visualBell</pre> |
|
|
1096 | </dd> |
|
|
1097 | <p></p> |
|
|
1098 | <dt><strong><a name="item_x_resource">$value = $term->x_resource ($pattern)</a></strong><br /> |
|
|
1099 | </dt> |
|
|
1100 | <dd> |
|
|
1101 | Returns the X-Resource for the given pattern, excluding the program or |
|
|
1102 | class name, i.e. <a href="#item_x_resource"><code>$term->x_resource ("boldFont")</code></a> should return the |
|
|
1103 | same value as used by this instance of rxvt-unicode. Returns <code>undef</code> if no |
|
|
1104 | resource with that pattern exists. |
|
|
1105 | </dd> |
|
|
1106 | <dd> |
|
|
1107 | <p>This method should only be called during the <code>on_start</code> hook, as there is |
|
|
1108 | only one resource database per display, and later invocations might return |
|
|
1109 | the wrong resources.</p> |
| 686 | </dd> |
1110 | </dd> |
| 687 | <p></p> |
1111 | <p></p> |
| 688 | <dt><strong><a name="item_parse_keysym">$success = $term->parse_keysym ($keysym_spec, $command_string)</a></strong><br /> |
1112 | <dt><strong><a name="item_parse_keysym">$success = $term->parse_keysym ($keysym_spec, $command_string)</a></strong><br /> |
| 689 | </dt> |
1113 | </dt> |
| 690 | <dd> |
1114 | <dd> |
| … | |
… | |
| 715 | <dd> |
1139 | <dd> |
| 716 | Return the current values of the selection mark, begin or end positions, |
1140 | Return the current values of the selection mark, begin or end positions, |
| 717 | and optionally set them to new values. |
1141 | and optionally set them to new values. |
| 718 | </dd> |
1142 | </dd> |
| 719 | <p></p> |
1143 | <p></p> |
|
|
1144 | <dt><strong><a name="item_selection_make">$term->selection_make ($eventtime[, $rectangular])</a></strong><br /> |
|
|
1145 | </dt> |
|
|
1146 | <dd> |
|
|
1147 | Tries to make a selection as set by <a href="#item_selection_beg"><code>selection_beg</code></a> and |
|
|
1148 | <a href="#item_selection_end"><code>selection_end</code></a>. If <code>$rectangular</code> is true (default: false), a |
|
|
1149 | rectangular selection will be made. This is the prefered function to make |
|
|
1150 | a selection. |
|
|
1151 | </dd> |
|
|
1152 | <p></p> |
| 720 | <dt><strong><a name="item_selection_grab">$success = $term->selection_grab ($eventtime)</a></strong><br /> |
1153 | <dt><strong><a name="item_selection_grab">$success = $term->selection_grab ($eventtime)</a></strong><br /> |
| 721 | </dt> |
1154 | </dt> |
| 722 | <dd> |
1155 | <dd> |
| 723 | Try to request the primary selection from the server (for example, as set |
1156 | Try to request the primary selection text from the server (for example, as |
| 724 | by the next method). |
1157 | set by the next method). No visual feedback will be given. This function |
|
|
1158 | is mostly useful from within <code>on_sel_grab</code> hooks. |
| 725 | </dd> |
1159 | </dd> |
| 726 | <p></p> |
1160 | <p></p> |
| 727 | <dt><strong>$oldtext = $term->selection ([$newtext])</strong><br /> |
1161 | <dt><strong>$oldtext = $term->selection ([$newtext])</strong><br /> |
| 728 | </dt> |
1162 | </dt> |
| 729 | <dd> |
1163 | <dd> |
| … | |
… | |
| 808 | <p></p> |
1242 | <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 /> |
1243 | <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> |
1244 | </dt> |
| 811 | <dd> |
1245 | <dd> |
| 812 | XORs the rendition values in the given span with the provided value |
1246 | 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 |
1247 | (default: <code>RS_RVid</code>), which <em>MUST NOT</em> contain font styles. Useful in |
| 814 | to the selection. |
1248 | refresh hooks to provide effects similar to the selection. |
| 815 | </dd> |
1249 | </dd> |
| 816 | <p></p> |
1250 | <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 /> |
1251 | <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> |
1252 | </dt> |
| 819 | <dd> |
1253 | <dd> |
| 820 | Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing |
1254 | 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 |
1255 | 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 |
1256 | to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines |
| 823 | it instead. |
1257 | it instead. Both styles <em>MUST NOT</em> contain font styles. |
| 824 | </dd> |
1258 | </dd> |
| 825 | <p></p> |
1259 | <p></p> |
| 826 | <dt><strong><a name="item_scr_bell">$term->scr_bell</a></strong><br /> |
1260 | <dt><strong><a name="item_scr_bell">$term->scr_bell</a></strong><br /> |
| 827 | </dt> |
1261 | </dt> |
| 828 | <dd> |
1262 | <dd> |
| … | |
… | |
| 841 | <p>Normally its not a good idea to use this function, as programs might be |
1275 | <p>Normally its not a good idea to use this function, as programs might be |
| 842 | confused by changes in cursor position or scrolling. Its useful inside a |
1276 | confused by changes in cursor position or scrolling. Its useful inside a |
| 843 | <code>on_add_lines</code> hook, though.</p> |
1277 | <code>on_add_lines</code> hook, though.</p> |
| 844 | </dd> |
1278 | </dd> |
| 845 | <p></p> |
1279 | <p></p> |
|
|
1280 | <dt><strong><a name="item_scr_change_screen">$term->scr_change_screen ($screen)</a></strong><br /> |
|
|
1281 | </dt> |
|
|
1282 | <dd> |
|
|
1283 | Switch to given screen - 0 primary, 1 secondary. |
|
|
1284 | </dd> |
|
|
1285 | <p></p> |
| 846 | <dt><strong><a name="item_cmd_parse">$term->cmd_parse ($octets)</a></strong><br /> |
1286 | <dt><strong><a name="item_cmd_parse">$term->cmd_parse ($octets)</a></strong><br /> |
| 847 | </dt> |
1287 | </dt> |
| 848 | <dd> |
1288 | <dd> |
| 849 | Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the |
1289 | Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the |
| 850 | locale-specific encoding of the terminal and can contain command sequences |
1290 | locale-specific encoding of the terminal and can contain command sequences |
| … | |
… | |
| 866 | be used to suppress input and output handling to the pty/tty. See the |
1306 | be used to suppress input and output handling to the pty/tty. See the |
| 867 | description of <a href="#item_events"><code>urxvt::timer->events</code></a>. Make sure to always restore |
1307 | description of <a href="#item_events"><code>urxvt::timer->events</code></a>. Make sure to always restore |
| 868 | the previous value. |
1308 | the previous value. |
| 869 | </dd> |
1309 | </dd> |
| 870 | <p></p> |
1310 | <p></p> |
|
|
1311 | <dt><strong><a name="item_pty_fd">$fd = $term->pty_fd</a></strong><br /> |
|
|
1312 | </dt> |
|
|
1313 | <dd> |
|
|
1314 | Returns the master file descriptor for the pty in use, or <code>-1</code> if no pty |
|
|
1315 | is used. |
|
|
1316 | </dd> |
|
|
1317 | <p></p> |
| 871 | <dt><strong><a name="item_parent">$windowid = $term->parent</a></strong><br /> |
1318 | <dt><strong><a name="item_parent">$windowid = $term->parent</a></strong><br /> |
| 872 | </dt> |
1319 | </dt> |
| 873 | <dd> |
1320 | <dd> |
| 874 | Return the window id of the toplevel window. |
1321 | Return the window id of the toplevel window. |
| 875 | </dd> |
1322 | </dd> |
| … | |
… | |
| 878 | </dt> |
1325 | </dt> |
| 879 | <dd> |
1326 | <dd> |
| 880 | Return the window id of the terminal window. |
1327 | Return the window id of the terminal window. |
| 881 | </dd> |
1328 | </dd> |
| 882 | <p></p> |
1329 | <p></p> |
|
|
1330 | <dt><strong><a name="item_vt_emask_add">$term->vt_emask_add ($x_event_mask)</a></strong><br /> |
|
|
1331 | </dt> |
|
|
1332 | <dd> |
|
|
1333 | Adds the specified events to the vt event mask. Useful e.g. when you want |
|
|
1334 | to receive pointer events all the times: |
|
|
1335 | </dd> |
|
|
1336 | <dd> |
|
|
1337 | <pre> |
|
|
1338 | $term->vt_emask_add (urxvt::PointerMotionMask);</pre> |
|
|
1339 | </dd> |
|
|
1340 | <p></p> |
|
|
1341 | <dt><strong><a name="item_focus_in">$term->focus_in</a></strong><br /> |
|
|
1342 | </dt> |
|
|
1343 | <dt><strong><a name="item_focus_out">$term->focus_out</a></strong><br /> |
|
|
1344 | </dt> |
|
|
1345 | <dt><strong><a name="item_key_press">$term->key_press ($state, $keycode[, $time])</a></strong><br /> |
|
|
1346 | </dt> |
|
|
1347 | <dt><strong><a name="item_key_release">$term->key_release ($state, $keycode[, $time])</a></strong><br /> |
|
|
1348 | </dt> |
|
|
1349 | <dd> |
|
|
1350 | Deliver various fake events to to terminal. |
|
|
1351 | </dd> |
|
|
1352 | <p></p> |
| 883 | <dt><strong><a name="item_width">$window_width = $term->width</a></strong><br /> |
1353 | <dt><strong><a name="item_width">$window_width = $term->width</a></strong><br /> |
| 884 | </dt> |
1354 | </dt> |
| 885 | <dt><strong><a name="item_height">$window_height = $term->height</a></strong><br /> |
1355 | <dt><strong><a name="item_height">$window_height = $term->height</a></strong><br /> |
| 886 | </dt> |
1356 | </dt> |
| 887 | <dt><strong><a name="item_fwidth">$font_width = $term->fwidth</a></strong><br /> |
1357 | <dt><strong><a name="item_fwidth">$font_width = $term->fwidth</a></strong><br /> |
| … | |
… | |
| 900 | </dt> |
1370 | </dt> |
| 901 | <dt><strong><a name="item_savelines">$max_scrollback = $term->saveLines</a></strong><br /> |
1371 | <dt><strong><a name="item_savelines">$max_scrollback = $term->saveLines</a></strong><br /> |
| 902 | </dt> |
1372 | </dt> |
| 903 | <dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term->total_rows</a></strong><br /> |
1373 | <dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term->total_rows</a></strong><br /> |
| 904 | </dt> |
1374 | </dt> |
| 905 | <dt><strong><a name="item_nsaved">$lines_in_scrollback = $term->nsaved</a></strong><br /> |
1375 | <dt><strong><a name="item_top_row">$topmost_scrollback_row = $term->top_row</a></strong><br /> |
| 906 | </dt> |
1376 | </dt> |
| 907 | <dd> |
1377 | <dd> |
| 908 | Return various integers describing terminal characteristics. |
1378 | Return various integers describing terminal characteristics. |
| 909 | </dd> |
1379 | </dd> |
| 910 | <p></p> |
1380 | <p></p> |
|
|
1381 | <dt><strong><a name="item_display_id">$x_display = $term->display_id</a></strong><br /> |
|
|
1382 | </dt> |
|
|
1383 | <dd> |
|
|
1384 | Return the DISPLAY used by rxvt-unicode. |
|
|
1385 | </dd> |
|
|
1386 | <p></p> |
| 911 | <dt><strong><a name="item_locale">$lc_ctype = $term->locale</a></strong><br /> |
1387 | <dt><strong><a name="item_locale">$lc_ctype = $term->locale</a></strong><br /> |
| 912 | </dt> |
1388 | </dt> |
| 913 | <dd> |
1389 | <dd> |
| 914 | Returns the LC_CTYPE category string used by this rxvt-unicode. |
1390 | Returns the LC_CTYPE category string used by this rxvt-unicode. |
| 915 | </dd> |
1391 | </dd> |
| 916 | <p></p> |
1392 | <p></p> |
| 917 | <dt><strong><a name="item_display_id">$x_display = $term->display_id</a></strong><br /> |
1393 | <dt><strong><a name="item_env">$env = $term->env</a></strong><br /> |
| 918 | </dt> |
1394 | </dt> |
| 919 | <dd> |
1395 | <dd> |
| 920 | Return the DISPLAY used by rxvt-unicode. |
1396 | Returns a copy of the environment in effect for the terminal as a hashref |
|
|
1397 | similar to <code>\%ENV</code>. |
| 921 | </dd> |
1398 | </dd> |
| 922 | <p></p> |
1399 | <p></p> |
| 923 | <dt><strong><a name="item_modlevel3mask">$modifiermask = $term->ModLevel3Mask</a></strong><br /> |
1400 | <dt><strong><a name="item_modlevel3mask">$modifiermask = $term->ModLevel3Mask</a></strong><br /> |
| 924 | </dt> |
1401 | </dt> |
| 925 | <dt><strong><a name="item_modmetamask">$modifiermask = $term->ModMetaMask</a></strong><br /> |
1402 | <dt><strong><a name="item_modmetamask">$modifiermask = $term->ModMetaMask</a></strong><br /> |
| … | |
… | |
| 929 | <dd> |
1406 | <dd> |
| 930 | Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often |
1407 | Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often |
| 931 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
1408 | AltGr), the meta key (often Alt) and the num lock key, if applicable. |
| 932 | </dd> |
1409 | </dd> |
| 933 | <p></p> |
1410 | <p></p> |
|
|
1411 | <dt><strong><a name="item_current_screen">$screen = $term->current_screen</a></strong><br /> |
|
|
1412 | </dt> |
|
|
1413 | <dd> |
|
|
1414 | Returns the currently displayed screen (0 primary, 1 secondary). |
|
|
1415 | </dd> |
|
|
1416 | <p></p> |
|
|
1417 | <dt><strong><a name="item_hidden_cursor">$cursor_is_hidden = $term->hidden_cursor</a></strong><br /> |
|
|
1418 | </dt> |
|
|
1419 | <dd> |
|
|
1420 | Returns wether the cursor is currently hidden or not. |
|
|
1421 | </dd> |
|
|
1422 | <p></p> |
| 934 | <dt><strong><a name="item_view_start">$view_start = $term->view_start ([$newvalue])</a></strong><br /> |
1423 | <dt><strong><a name="item_view_start">$view_start = $term->view_start ([$newvalue])</a></strong><br /> |
| 935 | </dt> |
1424 | </dt> |
| 936 | <dd> |
1425 | <dd> |
| 937 | Returns the negative row number of the topmost line. Minimum value is |
1426 | 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 |
1427 | <code>0</code>, which displays the normal terminal contents. Lower values scroll |
| 939 | this many lines into the scrollback buffer. |
1428 | this many lines into the scrollback buffer. |
| 940 | </dd> |
1429 | </dd> |
| 941 | <p></p> |
1430 | <p></p> |
| 942 | <dt><strong><a name="item_want_refresh">$term->want_refresh</a></strong><br /> |
1431 | <dt><strong><a name="item_want_refresh">$term->want_refresh</a></strong><br /> |
| 943 | </dt> |
1432 | </dt> |
| … | |
… | |
| 954 | </dt> |
1443 | </dt> |
| 955 | <dd> |
1444 | <dd> |
| 956 | Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code> |
1445 | 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 |
1446 | 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 |
1447 | 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 |
1448 | line <code>-$term->nsaved</code>. Nothing will be returned if a nonexistent line |
| 960 | is requested. |
1449 | is requested. |
| 961 | </dd> |
1450 | </dd> |
| 962 | <dd> |
1451 | <dd> |
| 963 | <p>If <code>$new_text</code> is specified, it will replace characters in the current |
1452 | <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 |
1453 | line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful |
| 965 | to replace only parts of a line. The font index in the rendition will |
1454 | to replace only parts of a line. The font index in the rendition will |
| 966 | automatically be updated.</p> |
1455 | automatically be updated.</p> |
| 967 | </dd> |
1456 | </dd> |
| 968 | <dd> |
1457 | <dd> |
| 969 | <p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more |
1458 | <p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more |
| 970 | than one cell when displayed are padded with urxvt::NOCHAR characters |
1459 | than one cell when displayed are padded with <code>$urxvt::NOCHAR</code> (chr 65535) |
| 971 | (<code>chr 65535</code>). Characters with combining characters and other characters |
1460 | characters. Characters with combining characters and other characters that |
| 972 | that do not fit into the normal tetx encoding will be replaced with |
1461 | do not fit into the normal tetx encoding will be replaced with characters |
| 973 | characters in the private use area.</p> |
1462 | in the private use area.</p> |
| 974 | </dd> |
1463 | </dd> |
| 975 | <dd> |
1464 | <dd> |
| 976 | <p>You have to obey this encoding when changing text. The advantage is |
1465 | <p>You have to obey this encoding when changing text. The advantage is |
| 977 | that <code>substr</code> and similar functions work on screen cells and not on |
1466 | that <code>substr</code> and similar functions work on screen cells and not on |
| 978 | characters.</p> |
1467 | characters.</p> |
| … | |
… | |
| 1049 | <p></p> |
1538 | <p></p> |
| 1050 | <dt><strong><a name="item_offset_of">$offset = $line->offset_of ($row, $col)</a></strong><br /> |
1539 | <dt><strong><a name="item_offset_of">$offset = $line->offset_of ($row, $col)</a></strong><br /> |
| 1051 | </dt> |
1540 | </dt> |
| 1052 | <dd> |
1541 | <dd> |
| 1053 | Returns the character offset of the given row|col pair within the logical |
1542 | Returns the character offset of the given row|col pair within the logical |
| 1054 | line. |
1543 | line. Works for rows outside the line, too, and returns corresponding |
|
|
1544 | offsets outside the string. |
| 1055 | </dd> |
1545 | </dd> |
| 1056 | <p></p> |
1546 | <p></p> |
| 1057 | <dt><strong><a name="item_coord_of">($row, $col) = $line->coord_of ($offset)</a></strong><br /> |
1547 | <dt><strong><a name="item_coord_of">($row, $col) = $line->coord_of ($offset)</a></strong><br /> |
| 1058 | </dt> |
1548 | </dt> |
| 1059 | <dd> |
1549 | <dd> |
| … | |
… | |
| 1073 | <dd> |
1563 | <dd> |
| 1074 | Converts rxvt-unicodes text reprsentation into a perl string. See |
1564 | Converts rxvt-unicodes text reprsentation into a perl string. See |
| 1075 | <a href="#item_row_t"><code>$term->ROW_t</code></a> for details. |
1565 | <a href="#item_row_t"><code>$term->ROW_t</code></a> for details. |
| 1076 | </dd> |
1566 | </dd> |
| 1077 | <p></p> |
1567 | <p></p> |
| 1078 | <dt><strong><a name="item_grab_button">$success = $term->grab_button ($button, $modifiermask)</a></strong><br /> |
1568 | <dt><strong><a name="item_grab_button">$success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])</a></strong><br /> |
| 1079 | </dt> |
1569 | </dt> |
|
|
1570 | <dt><strong><a name="item_ungrab_button">$term->ungrab_button ($button, $modifiermask[, $window = $term->vt])</a></strong><br /> |
|
|
1571 | </dt> |
| 1080 | <dd> |
1572 | <dd> |
| 1081 | Registers a synchronous button grab. See the XGrabButton manpage. |
1573 | Register/unregister a synchronous button grab. See the XGrabButton |
|
|
1574 | manpage. |
| 1082 | </dd> |
1575 | </dd> |
| 1083 | <p></p> |
1576 | <p></p> |
| 1084 | <dt><strong><a name="item_grab">$success = $term->grab ($eventtime[, $sync])</a></strong><br /> |
1577 | <dt><strong><a name="item_grab">$success = $term->grab ($eventtime[, $sync])</a></strong><br /> |
| 1085 | </dt> |
1578 | </dt> |
| 1086 | <dd> |
1579 | <dd> |
| … | |
… | |
| 1112 | <dd> |
1605 | <dd> |
| 1113 | Calls XUngrab for the most recent grab. Is called automatically on |
1606 | Calls XUngrab for the most recent grab. Is called automatically on |
| 1114 | evaluation errors, as it is better to lose the grab in the error case as |
1607 | evaluation errors, as it is better to lose the grab in the error case as |
| 1115 | the session. |
1608 | the session. |
| 1116 | </dd> |
1609 | </dd> |
|
|
1610 | <p></p> |
|
|
1611 | <dt><strong><a name="item_xinternatom">$atom = $term->XInternAtom ($atom_name[, $only_if_exists])</a></strong><br /> |
|
|
1612 | </dt> |
|
|
1613 | <dt><strong><a name="item_xgetatomname">$atom_name = $term->XGetAtomName ($atom)</a></strong><br /> |
|
|
1614 | </dt> |
|
|
1615 | <dt><strong><a name="item_xlistproperties">@atoms = $term->XListProperties ($window)</a></strong><br /> |
|
|
1616 | </dt> |
|
|
1617 | <dt><strong><a name="item_xgetwindowproperty">($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)</a></strong><br /> |
|
|
1618 | </dt> |
|
|
1619 | <dt><strong><a name="item_xchangewindowproperty">$term->XChangeWindowProperty ($window, $property, $type, $format, $octets)</a></strong><br /> |
|
|
1620 | </dt> |
|
|
1621 | <dt><strong><a name="item_xdeleteproperty">$term->XDeleteProperty ($window, $property)</a></strong><br /> |
|
|
1622 | </dt> |
|
|
1623 | <dt><strong><a name="item_defaultrootwindow">$window = $term->DefaultRootWindow</a></strong><br /> |
|
|
1624 | </dt> |
|
|
1625 | <dt><strong><a name="item_xreparentwindow">$term->XReparentWindow ($window, $parent, [$x, $y])</a></strong><br /> |
|
|
1626 | </dt> |
|
|
1627 | <dt><strong><a name="item_xmapwindow">$term->XMapWindow ($window)</a></strong><br /> |
|
|
1628 | </dt> |
|
|
1629 | <dt><strong><a name="item_xunmapwindow">$term->XUnmapWindow ($window)</a></strong><br /> |
|
|
1630 | </dt> |
|
|
1631 | <dt><strong><a name="item_xmoveresizewindow">$term->XMoveResizeWindow ($window, $x, $y, $width, $height)</a></strong><br /> |
|
|
1632 | </dt> |
|
|
1633 | <dt><strong><a name="item_xtranslatecoordinates">($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)</a></strong><br /> |
|
|
1634 | </dt> |
|
|
1635 | <dt><strong><a name="item_xchangeinput">$term->XChangeInput ($window, $add_events[, $del_events])</a></strong><br /> |
|
|
1636 | </dt> |
|
|
1637 | <dd> |
|
|
1638 | Various X or X-related functions. The <code>$term</code> object only serves as |
|
|
1639 | the source of the display, otherwise those functions map more-or-less |
|
|
1640 | directory onto the X functions of the same name. |
|
|
1641 | </dd> |
| 1117 | <p></p></dl> |
1642 | <p></p></dl> |
| 1118 | <p> |
1643 | <p> |
| 1119 | </p> |
1644 | </p> |
| 1120 | <h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> |
1645 | <h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> |
| 1121 | <dl> |
1646 | <dl> |
| … | |
… | |
| 1136 | <dd> |
1661 | <dd> |
| 1137 | Adds a clickable button to the popup. <code>$cb</code> is called whenever it is |
1662 | Adds a clickable button to the popup. <code>$cb</code> is called whenever it is |
| 1138 | selected. |
1663 | selected. |
| 1139 | </dd> |
1664 | </dd> |
| 1140 | <p></p> |
1665 | <p></p> |
| 1141 | <dt><strong><a name="item_add_toggle">$popup->add_toggle ($text, $cb, $initial_value)</a></strong><br /> |
1666 | <dt><strong><a name="item_add_toggle">$popup->add_toggle ($text, $initial_value, $cb)</a></strong><br /> |
| 1142 | </dt> |
1667 | </dt> |
| 1143 | <dd> |
1668 | <dd> |
| 1144 | Adds a toggle/checkbox item to the popup. Teh callback gets called |
1669 | Adds a toggle/checkbox item to the popup. The callback gets called |
| 1145 | whenever it gets toggled, with a boolean indicating its value as its first |
1670 | whenever it gets toggled, with a boolean indicating its new value as its |
| 1146 | argument. |
1671 | first argument. |
| 1147 | </dd> |
1672 | </dd> |
| 1148 | <p></p> |
1673 | <p></p> |
| 1149 | <dt><strong>$popup->show</strong><br /> |
1674 | <dt><strong>$popup->show</strong><br /> |
| 1150 | </dt> |
1675 | </dt> |
| 1151 | <dd> |
1676 | <dd> |
| … | |
… | |
| 1208 | <p></p> |
1733 | <p></p> |
| 1209 | <dt><strong>$timer = $timer->start ($tstamp)</strong><br /> |
1734 | <dt><strong>$timer = $timer->start ($tstamp)</strong><br /> |
| 1210 | </dt> |
1735 | </dt> |
| 1211 | <dd> |
1736 | <dd> |
| 1212 | Set the event trigger time to <code>$tstamp</code> and start the timer. |
1737 | Set the event trigger time to <code>$tstamp</code> and start the timer. |
|
|
1738 | </dd> |
|
|
1739 | <p></p> |
|
|
1740 | <dt><strong><a name="item_after">$timer = $timer->after ($delay)</a></strong><br /> |
|
|
1741 | </dt> |
|
|
1742 | <dd> |
|
|
1743 | Like <a href="#item_start"><code>start</code></a>, but sets the expiry timer to c<urxvt::NOW + $delay>. |
| 1213 | </dd> |
1744 | </dd> |
| 1214 | <p></p> |
1745 | <p></p> |
| 1215 | <dt><strong><a name="item_stop">$timer = $timer->stop</a></strong><br /> |
1746 | <dt><strong><a name="item_stop">$timer = $timer->stop</a></strong><br /> |
| 1216 | </dt> |
1747 | </dt> |
| 1217 | <dd> |
1748 | <dd> |
| … | |
… | |
| 1275 | Stop watching for events on the given filehandle. |
1806 | Stop watching for events on the given filehandle. |
| 1276 | </dd> |
1807 | </dd> |
| 1277 | <p></p></dl> |
1808 | <p></p></dl> |
| 1278 | <p> |
1809 | <p> |
| 1279 | </p> |
1810 | </p> |
|
|
1811 | <h2><a name="the_urxvt__iw_class">The <code>urxvt::iw</code> Class</a></h2> |
|
|
1812 | <p>This class implements idle watchers, that get called automatically when |
|
|
1813 | the process is idle. They should return as fast as possible, after doing |
|
|
1814 | some useful work.</p> |
|
|
1815 | <dl> |
|
|
1816 | <dt><strong><a name="item__24iw__3d_new_urxvt_3a_3aiw">$iw = new urxvt::iw</a></strong><br /> |
|
|
1817 | </dt> |
|
|
1818 | <dd> |
|
|
1819 | Create a new idle watcher object in stopped state. |
|
|
1820 | </dd> |
|
|
1821 | <p></p> |
|
|
1822 | <dt><strong>$iw = $iw->cb (sub { my ($iw) = @_; ... })</strong><br /> |
|
|
1823 | </dt> |
|
|
1824 | <dd> |
|
|
1825 | Set the callback to be called when the watcher triggers. |
|
|
1826 | </dd> |
|
|
1827 | <p></p> |
|
|
1828 | <dt><strong>$timer = $timer->start</strong><br /> |
|
|
1829 | </dt> |
|
|
1830 | <dd> |
|
|
1831 | Start the watcher. |
|
|
1832 | </dd> |
|
|
1833 | <p></p> |
|
|
1834 | <dt><strong>$timer = $timer->stop</strong><br /> |
|
|
1835 | </dt> |
|
|
1836 | <dd> |
|
|
1837 | Stop the watcher. |
|
|
1838 | </dd> |
|
|
1839 | <p></p></dl> |
|
|
1840 | <p> |
|
|
1841 | </p> |
|
|
1842 | <h2><a name="the_urxvt__pw_class">The <code>urxvt::pw</code> Class</a></h2> |
|
|
1843 | <p>This class implements process watchers. They create an event whenever a |
|
|
1844 | process exits, after which they stop automatically.</p> |
|
|
1845 | <pre> |
|
|
1846 | my $pid = fork; |
|
|
1847 | ... |
|
|
1848 | $term->{pw} = urxvt::pw |
|
|
1849 | ->new |
|
|
1850 | ->start ($pid) |
|
|
1851 | ->cb (sub { |
|
|
1852 | my ($pw, $exit_status) = @_; |
|
|
1853 | ... |
|
|
1854 | });</pre> |
|
|
1855 | <dl> |
|
|
1856 | <dt><strong><a name="item__24pw__3d_new_urxvt_3a_3apw">$pw = new urxvt::pw</a></strong><br /> |
|
|
1857 | </dt> |
|
|
1858 | <dd> |
|
|
1859 | Create a new process watcher in stopped state. |
|
|
1860 | </dd> |
|
|
1861 | <p></p> |
|
|
1862 | <dt><strong>$pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })</strong><br /> |
|
|
1863 | </dt> |
|
|
1864 | <dd> |
|
|
1865 | Set the callback to be called when the timer triggers. |
|
|
1866 | </dd> |
|
|
1867 | <p></p> |
|
|
1868 | <dt><strong>$pw = $timer->start ($pid)</strong><br /> |
|
|
1869 | </dt> |
|
|
1870 | <dd> |
|
|
1871 | Tells the wqtcher to start watching for process <code>$pid</code>. |
|
|
1872 | </dd> |
|
|
1873 | <p></p> |
|
|
1874 | <dt><strong>$pw = $pw->stop</strong><br /> |
|
|
1875 | </dt> |
|
|
1876 | <dd> |
|
|
1877 | Stop the watcher. |
|
|
1878 | </dd> |
|
|
1879 | <p></p></dl> |
|
|
1880 | <p> |
|
|
1881 | </p> |
| 1280 | <hr /> |
1882 | <hr /> |
| 1281 | <h1><a name="environment">ENVIRONMENT</a></h1> |
1883 | <h1><a name="environment">ENVIRONMENT</a></h1> |
| 1282 | <p> |
1884 | <p> |
| 1283 | </p> |
1885 | </p> |
| 1284 | <h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> |
1886 | <h2><a name="urxvt_perl_verbosity">URXVT_PERL_VERBOSITY</a></h2> |
| … | |
… | |
| 1287 | <dl> |
1889 | <dl> |
| 1288 | <dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br /> |
1890 | <dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br /> |
| 1289 | </dt> |
1891 | </dt> |
| 1290 | <dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">>= 3 - script loading and management</a></strong><br /> |
1892 | <dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">>= 3 - script loading and management</a></strong><br /> |
| 1291 | </dt> |
1893 | </dt> |
| 1292 | <dt><strong><a name="item__3e_3d10__2d_all_events_received">>=10 - all events received</a></strong><br /> |
1894 | <dt><strong><a name="item__3e_3d10__2d_all_called_hooks">>=10 - all called hooks</a></strong><br /> |
|
|
1895 | </dt> |
|
|
1896 | <dt><strong><a name="item__3e_3d11__2d_hook_reutrn_values">>=11 - hook reutrn values</a></strong><br /> |
| 1293 | </dt> |
1897 | </dt> |
| 1294 | </dl> |
1898 | </dl> |
| 1295 | <p> |
1899 | <p> |
| 1296 | </p> |
1900 | </p> |
| 1297 | <hr /> |
1901 | <hr /> |
