… | |
… | |
85 | <dl> |
85 | <dl> |
86 | <dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br /> |
86 | <dt><strong><a name="item_selection">selection (enabled by default)</a></strong><br /> |
87 | </dt> |
87 | </dt> |
88 | <dd> |
88 | <dd> |
89 | (More) intelligent selection. This extension tries to be more intelligent |
89 | (More) intelligent selection. This extension tries to be more intelligent |
90 | when the user extends selections (double-click). Right now, it tries to |
90 | when the user extends selections (double-click and further clicks). Right |
91 | select urls and complete shell-quoted arguments, which is very convenient, |
91 | now, it tries to select words, urls and complete shell-quoted |
92 | too, if your <em>ls</em> supports <code>--quoting-style=shell</code>. |
92 | arguments, which is very convenient, too, if your <em>ls</em> supports |
93 | </dd> |
93 | <code>--quoting-style=shell</code>. |
94 | <dd> |
94 | </dd> |
|
|
95 | <dd> |
|
|
96 | <p>A double-click usually selects the word under the cursor, further clicks |
|
|
97 | will enlarge the selection.</p> |
|
|
98 | </dd> |
|
|
99 | <dd> |
|
|
100 | <p>The selection works by trying to match a number of regexes and displaying |
|
|
101 | them in increasing order of length. You can add your own regexes by |
|
|
102 | specifying resources of the form:</p> |
|
|
103 | </dd> |
|
|
104 | <dd> |
|
|
105 | <pre> |
|
|
106 | URxvt.selection.pattern-0: perl-regex |
|
|
107 | URxvt.selection.pattern-1: perl-regex |
|
|
108 | ...</pre> |
|
|
109 | </dd> |
|
|
110 | <dd> |
|
|
111 | <p>The index number (0, 1...) must not have any holes, and each regex must |
|
|
112 | contain at least one pair of capturing parentheses, which will be used for |
|
|
113 | the match. For example, the followign adds a regex that matches everything |
|
|
114 | between two vertical bars:</p> |
|
|
115 | </dd> |
|
|
116 | <dd> |
|
|
117 | <pre> |
|
|
118 | URxvt.selection.pattern-0: \\|([^|]+)\\|</pre> |
|
|
119 | </dd> |
|
|
120 | <dd> |
|
|
121 | <p>You can look at the source of the selection extension to see more |
|
|
122 | interesting uses, such as parsing a line from beginning to end.</p> |
|
|
123 | </dd> |
|
|
124 | <dd> |
95 | <p>It also offers the following bindable keyboard command:</p> |
125 | <p>This extension also offers following bindable keyboard commands:</p> |
96 | </dd> |
126 | </dd> |
97 | <dl> |
127 | <dl> |
98 | <dt><strong><a name="item_rot13">rot13</a></strong><br /> |
128 | <dt><strong><a name="item_rot13">rot13</a></strong><br /> |
99 | </dt> |
129 | </dt> |
100 | <dd> |
130 | <dd> |
… | |
… | |
122 | <p></p> |
152 | <p></p> |
123 | <dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback<hotkey> (enabled by default)</a></strong><br /> |
153 | <dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback<hotkey> (enabled by default)</a></strong><br /> |
124 | </dt> |
154 | </dt> |
125 | <dd> |
155 | <dd> |
126 | Adds regex search functionality to the scrollback buffer, triggered |
156 | Adds regex search functionality to the scrollback buffer, triggered |
127 | by a hotkey (default: <code>M-s</code>). When in search mode, normal terminal |
157 | by a hotkey (default: <code>M-s</code>). While in search mode, normal terminal |
128 | input/output is suspended. |
158 | input/output is suspended and a regex is displayed at the bottom of the |
129 | </dd> |
159 | screen. |
130 | <dd> |
160 | </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> |
161 | <dd> |
136 | <p></p> |
162 | <p>Inputting characters appends them to the regex and continues incremental |
137 | <dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> |
163 | search. <code>BackSpace</code> removes a character from the regex, <code>Up</code> and <code>Down</code> |
138 | </dt> |
164 | search upwards/downwards in the scrollback buffer, <code>End</code> jumps to the |
|
|
165 | bottom. <code>Escape</code> leaves search mode and returns to the point where search |
|
|
166 | was started, while <code>Enter</code> or <code>Return</code> stay at the current position and |
|
|
167 | additionally stores the first match in the current line into the primary |
|
|
168 | selection.</p> |
139 | <dd> |
169 | </dd> |
140 | Displays a digital clock using the built-in overlay. |
170 | <p></p> |
|
|
171 | <dt><strong><a name="item_selection_2dautotransform">selection-autotransform</a></strong><br /> |
|
|
172 | </dt> |
|
|
173 | <dd> |
|
|
174 | This selection allows you to do automatic transforms on a selection |
|
|
175 | whenever a selection is made. |
|
|
176 | </dd> |
|
|
177 | <dd> |
|
|
178 | <p>It works by specifying perl snippets (most useful is a single <code>s///</code> |
|
|
179 | operator) that modify <code>$_</code> as resources:</p> |
|
|
180 | </dd> |
|
|
181 | <dd> |
|
|
182 | <pre> |
|
|
183 | URxvt.selection-autotransform.0: transform |
|
|
184 | URxvt.selection-autotransform.1: transform |
|
|
185 | ...</pre> |
|
|
186 | </dd> |
|
|
187 | <dd> |
|
|
188 | <p>For example, the following will transform selections of the form |
|
|
189 | <code>filename:number</code>, often seen in compiler messages, into <code>vi +$filename |
|
|
190 | $word</code>:</p> |
|
|
191 | </dd> |
|
|
192 | <dd> |
|
|
193 | <pre> |
|
|
194 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/</pre> |
|
|
195 | </dd> |
|
|
196 | <dd> |
|
|
197 | <p>And this example matches the same,but replaces it with vi-commands you can |
|
|
198 | paste directly into your (vi :) editor:</p> |
|
|
199 | </dd> |
|
|
200 | <dd> |
|
|
201 | <pre> |
|
|
202 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/</pre> |
|
|
203 | </dd> |
|
|
204 | <dd> |
|
|
205 | <p>Of course, this can be modified to suit your needs and your editor :)</p> |
|
|
206 | </dd> |
|
|
207 | <dd> |
|
|
208 | <p>To expand the example above to typical perl error messages (``XXX at |
|
|
209 | FILENAME line YYY.''), you need a slightly more elaborate solution:</p> |
|
|
210 | </dd> |
|
|
211 | <dd> |
|
|
212 | <pre> |
|
|
213 | URxvt.selection.pattern-0: ( at .*? line \\d+\\.) |
|
|
214 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/</pre> |
|
|
215 | </dd> |
|
|
216 | <dd> |
|
|
217 | <p>The first line tells the selection code to treat the unchanging part of |
|
|
218 | every error message as a selection pattern, and the second line transforms |
|
|
219 | the message into vi commands to load the file.</p> |
141 | </dd> |
220 | </dd> |
142 | <p></p> |
221 | <p></p> |
143 | <dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> |
222 | <dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> |
144 | </dt> |
223 | </dt> |
145 | <dd> |
224 | <dd> |
146 | Uses per-line display filtering (<code>on_line_update</code>) to underline urls. |
225 | Uses per-line display filtering (<code>on_line_update</code>) to underline urls and |
|
|
226 | make them clickable. When middle-clicked, the program specified in the |
|
|
227 | resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with |
|
|
228 | the URL as first argument. |
147 | </dd> |
229 | </dd> |
148 | <p></p> |
230 | <p></p> |
149 | <dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br /> |
231 | <dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br /> |
150 | </dt> |
232 | </dt> |
151 | <dd> |
233 | <dd> |
152 | A not very useful example of filtering all text output to the terminal, |
234 | 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 |
235 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
154 | similar-looking ascii character. |
236 | similar-looking ascii character. |
155 | </dd> |
237 | </dd> |
156 | <p></p> |
238 | <p></p> |
|
|
239 | <dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> |
|
|
240 | </dt> |
|
|
241 | <dd> |
|
|
242 | Displays a digital clock using the built-in overlay. |
|
|
243 | </dd> |
|
|
244 | <p></p> |
157 | <dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> |
245 | <dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> |
158 | </dt> |
246 | </dt> |
159 | <dd> |
247 | <dd> |
160 | Displays a very simple digital clock in the upper right corner of the |
248 | Displays a very simple digital clock in the upper right corner of the |
161 | window. Illustrates overwriting the refresh callbacks to create your own |
249 | window. Illustrates overwriting the refresh callbacks to create your own |
162 | overlays or changes. |
250 | overlays or changes. |
|
|
251 | </dd> |
|
|
252 | <p></p> |
|
|
253 | <dt><strong><a name="item_selection_2dpastebin">selection-pastebin</a></strong><br /> |
|
|
254 | </dt> |
|
|
255 | <dd> |
|
|
256 | This is a little rarely useful extension that Uploads the selection as |
|
|
257 | textfile to a remote site (or does other things). (The implementation is |
|
|
258 | not currently secure for use in a multiuser environment as it writes to |
|
|
259 | <em>/tmp</em> directly.). |
|
|
260 | </dd> |
|
|
261 | <dd> |
|
|
262 | <p>It listens to the <code>selection-pastebin:remote-pastebin</code> keyboard command, |
|
|
263 | i.e.</p> |
|
|
264 | </dd> |
|
|
265 | <dd> |
|
|
266 | <pre> |
|
|
267 | URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin</pre> |
|
|
268 | </dd> |
|
|
269 | <dd> |
|
|
270 | <p>Pressing this combination runs a command with <code>%</code> replaced by the name of |
|
|
271 | the textfile. This command can be set via a resource:</p> |
|
|
272 | </dd> |
|
|
273 | <dd> |
|
|
274 | <pre> |
|
|
275 | URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.</pre> |
|
|
276 | </dd> |
|
|
277 | <dd> |
|
|
278 | <p>And the default is likely not useful to anybody but the few people around |
|
|
279 | here :)</p> |
|
|
280 | </dd> |
|
|
281 | <dd> |
|
|
282 | <p>The name of the textfile is the hex encoded md5 sum of the selection, so |
|
|
283 | the same content should lead to the same filename.</p> |
|
|
284 | </dd> |
|
|
285 | <dd> |
|
|
286 | <p>After a successful upload the selection will be replaced by the text given |
|
|
287 | in the <code>selection-pastebin-url</code> resource (again, the % is the placeholder |
|
|
288 | for the filename):</p> |
|
|
289 | </dd> |
|
|
290 | <dd> |
|
|
291 | <pre> |
|
|
292 | URxvt.selection-pastebin.url: <a href="http://www.ta-sa.org/files/txt/%">http://www.ta-sa.org/files/txt/%</a></pre> |
163 | </dd> |
293 | </dd> |
164 | <p></p></dl> |
294 | <p></p></dl> |
165 | <p> |
295 | <p> |
166 | </p> |
296 | </p> |
167 | <hr /> |
297 | <hr /> |
… | |
… | |
183 | <dl> |
313 | <dl> |
184 | <dt><strong><a name="item__24text">$text</a></strong><br /> |
314 | <dt><strong><a name="item__24text">$text</a></strong><br /> |
185 | </dt> |
315 | </dt> |
186 | <dd> |
316 | <dd> |
187 | Rxvt-unicodes special way of encoding text, where one ``unicode'' character |
317 | 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. |
318 | always represents one screen cell. See <a href="#item_row_t">ROW_t</a> for a discussion of this format. |
189 | </dd> |
319 | </dd> |
190 | <p></p> |
320 | <p></p> |
191 | <dt><strong><a name="item__24string">$string</a></strong><br /> |
321 | <dt><strong><a name="item__24string">$string</a></strong><br /> |
192 | </dt> |
322 | </dt> |
193 | <dd> |
323 | <dd> |
… | |
… | |
301 | </dt> |
431 | </dt> |
302 | <dd> |
432 | <dd> |
303 | Called whenever the user tries to extend the selection (e.g. with a double |
433 | 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 |
434 | 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 |
435 | should extend the selection itelf and return true to suppress the built-in |
306 | processing. |
436 | processing. This can happen multiple times, as long as the callback |
|
|
437 | returns true, it will be called on every further click by the user and is |
|
|
438 | supposed to enlarge the selection more and more, if possible. |
307 | </dd> |
439 | </dd> |
308 | <dd> |
440 | <dd> |
309 | <p>See the <em>selection</em> example extension.</p> |
441 | <p>See the <em>selection</em> example extension.</p> |
310 | </dd> |
442 | </dd> |
311 | <p></p> |
443 | <p></p> |
… | |
… | |
402 | Called whenever the user presses a key combination that has a |
534 | 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> |
535 | <code>perl:string</code> action bound to it (see description of the <strong>keysym</strong> |
404 | resource in the <code>rxvt(1)</code> manpage). |
536 | resource in the <code>rxvt(1)</code> manpage). |
405 | </dd> |
537 | </dd> |
406 | <p></p> |
538 | <p></p> |
|
|
539 | <dt><strong><a name="item_on_x_event__24term_2c__24event">on_x_event $term, $event</a></strong><br /> |
|
|
540 | </dt> |
|
|
541 | <dd> |
|
|
542 | Called on every X event received on the vt window (and possibly other |
|
|
543 | windows). Should only be used as a last resort. Most event structure |
|
|
544 | members are not passed. |
|
|
545 | </dd> |
|
|
546 | <p></p> |
407 | <dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> |
547 | <dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> |
408 | </dt> |
548 | </dt> |
409 | <dd> |
549 | <dd> |
410 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
550 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
411 | does focus in processing. |
551 | does focus in processing. |
… | |
… | |
476 | </dt> |
616 | </dt> |
477 | <dd> |
617 | <dd> |
478 | The current terminal. This variable stores the current <code>urxvt::term</code> |
618 | The current terminal. This variable stores the current <code>urxvt::term</code> |
479 | object, whenever a callback/hook is executing. |
619 | object, whenever a callback/hook is executing. |
480 | </dd> |
620 | </dd> |
481 | <p></p> |
621 | <p></p></dl> |
482 | <dt></dt> |
|
|
483 | </dl> |
|
|
484 | <p> |
622 | <p> |
485 | </p> |
623 | </p> |
486 | <h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> |
624 | <h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> |
487 | <dl> |
625 | <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 /> |
626 | <dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br /> |
499 | </dt> |
627 | </dt> |
500 | <dd> |
628 | <dd> |
501 | Fatally aborts execution with the given error message. Avoid at all |
629 | Fatally aborts execution with the given error message. Avoid at all |
502 | costs! The only time this is acceptable is when the terminal process |
630 | costs! The only time this is acceptable is when the terminal process |
… | |
… | |
512 | </dd> |
640 | </dd> |
513 | <dd> |
641 | <dd> |
514 | <p>Using this function has the advantage that its output ends up in the |
642 | <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> |
643 | correct place, e.g. on stderr of the connecting urxvtc client.</p> |
516 | </dd> |
644 | </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> |
645 | <dd> |
521 | Returns true when it is safe to do potentially unsafe things, such as |
646 | <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> |
647 | </dd> |
525 | <p></p> |
648 | <p></p> |
526 | <dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> |
649 | <dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> |
527 | </dt> |
650 | </dt> |
528 | <dd> |
651 | <dd> |
… | |
… | |
532 | <dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br /> |
655 | <dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br /> |
533 | </dt> |
656 | </dt> |
534 | <dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
657 | <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, |
658 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
536 | Button4Mask, Button5Mask, AnyModifier</a></strong><br /> |
659 | Button4Mask, Button5Mask, AnyModifier</a></strong><br /> |
|
|
660 | </dt> |
|
|
661 | <dt><strong><a name="item_urxvt_3a_3anoeventmask_2c_keypressmask_2c_keyrelea">urxvt::NoEventMask, KeyPressMask, KeyReleaseMask, |
|
|
662 | ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, |
|
|
663 | PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask, |
|
|
664 | Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask, |
|
|
665 | KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask, |
|
|
666 | ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask, |
|
|
667 | FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask</a></strong><br /> |
|
|
668 | </dt> |
|
|
669 | <dt><strong><a name="item_urxvt_3a_3akeypress_2c_keyrelease_2c_buttonpress_2">urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify, |
|
|
670 | EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose, |
|
|
671 | GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify, |
|
|
672 | UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify, |
|
|
673 | ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify, |
|
|
674 | CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, |
|
|
675 | SelectionNotify, ColormapNotify, ClientMessage, MappingNotify</a></strong><br /> |
537 | </dt> |
676 | </dt> |
538 | <dd> |
677 | <dd> |
539 | Various constants for use in X calls and event processing. |
678 | Various constants for use in X calls and event processing. |
540 | </dd> |
679 | </dd> |
541 | <p></p></dl> |
680 | <p></p></dl> |
… | |
… | |
612 | work.</p> |
751 | work.</p> |
613 | <p> |
752 | <p> |
614 | </p> |
753 | </p> |
615 | <h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> |
754 | <h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> |
616 | <dl> |
755 | <dl> |
|
|
756 | <dt><strong><a name="item__24term__3d_new_urxvt_3a_3aterm__24envhashref_2c__">$term = new urxvt::term $envhashref, $rxvtname, [arg...]</a></strong><br /> |
|
|
757 | </dt> |
|
|
758 | <dd> |
|
|
759 | Creates a new terminal, very similar as if you had started it with system |
|
|
760 | <code>$rxvtname, arg...</code>. <code>$envhashref</code> must be a reference to a <code>%ENV</code>-like |
|
|
761 | hash which defines the environment of the new terminal. |
|
|
762 | </dd> |
|
|
763 | <dd> |
|
|
764 | <p>Croaks (and probably outputs an error message) if the new instance |
|
|
765 | couldn't be created. Returns <code>undef</code> if the new instance didn't |
|
|
766 | initialise perl, and the terminal object otherwise. The <code>init</code> and |
|
|
767 | <a href="#item_start"><code>start</code></a> hooks will be called during this call.</p> |
|
|
768 | </dd> |
|
|
769 | <p></p> |
617 | <dt><strong><a name="item_destroy">$term->destroy</a></strong><br /> |
770 | <dt><strong><a name="item_destroy">$term->destroy</a></strong><br /> |
618 | </dt> |
771 | </dt> |
619 | <dd> |
772 | <dd> |
620 | Destroy the terminal object (close the window, free resources |
773 | Destroy the terminal object (close the window, free resources |
621 | etc.). Please note that rxvt will not exit as long as any event |
774 | etc.). Please note that rxvt will not exit as long as any event |
… | |
… | |
683 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
836 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
684 | shade term_name title transparent transparent_all tripleclickwords |
837 | shade term_name title transparent transparent_all tripleclickwords |
685 | utmpInhibit visualBell</pre> |
838 | utmpInhibit visualBell</pre> |
686 | </dd> |
839 | </dd> |
687 | <p></p> |
840 | <p></p> |
|
|
841 | <dt><strong><a name="item_x_resource">$value = $term->x_resource ($pattern)</a></strong><br /> |
|
|
842 | </dt> |
|
|
843 | <dd> |
|
|
844 | Returns the X-Resource for the given pattern, excluding the program or |
|
|
845 | class name, i.e. <a href="#item_x_resource"><code>$term->x_resource ("boldFont")</code></a> should return the |
|
|
846 | same value as used by this instance of rxvt-unicode. Returns <code>undef</code> if no |
|
|
847 | resource with that pattern exists. |
|
|
848 | </dd> |
|
|
849 | <dd> |
|
|
850 | <p>This method should only be called during the <code>on_start</code> hook, as there is |
|
|
851 | only one resource database per display, and later invocations might return |
|
|
852 | the wrong resources.</p> |
|
|
853 | </dd> |
|
|
854 | <p></p> |
688 | <dt><strong><a name="item_parse_keysym">$success = $term->parse_keysym ($keysym_spec, $command_string)</a></strong><br /> |
855 | <dt><strong><a name="item_parse_keysym">$success = $term->parse_keysym ($keysym_spec, $command_string)</a></strong><br /> |
689 | </dt> |
856 | </dt> |
690 | <dd> |
857 | <dd> |
691 | Adds a keymap translation exactly as specified via a resource. See the |
858 | Adds a keymap translation exactly as specified via a resource. See the |
692 | <code>keysym</code> resource in the <code>rxvt(1)</code> manpage. |
859 | <code>keysym</code> resource in the <code>rxvt(1)</code> manpage. |
… | |
… | |
715 | <dd> |
882 | <dd> |
716 | Return the current values of the selection mark, begin or end positions, |
883 | Return the current values of the selection mark, begin or end positions, |
717 | and optionally set them to new values. |
884 | and optionally set them to new values. |
718 | </dd> |
885 | </dd> |
719 | <p></p> |
886 | <p></p> |
|
|
887 | <dt><strong><a name="item_selection_make">$term->selection_make ($eventtime[, $rectangular])</a></strong><br /> |
|
|
888 | </dt> |
|
|
889 | <dd> |
|
|
890 | Tries to make a selection as set by <a href="#item_selection_beg"><code>selection_beg</code></a> and |
|
|
891 | <a href="#item_selection_end"><code>selection_end</code></a>. If <code>$rectangular</code> is true (default: false), a |
|
|
892 | rectangular selection will be made. This is the prefered function to make |
|
|
893 | a selection. |
|
|
894 | </dd> |
|
|
895 | <p></p> |
720 | <dt><strong><a name="item_selection_grab">$success = $term->selection_grab ($eventtime)</a></strong><br /> |
896 | <dt><strong><a name="item_selection_grab">$success = $term->selection_grab ($eventtime)</a></strong><br /> |
721 | </dt> |
897 | </dt> |
722 | <dd> |
898 | <dd> |
723 | Try to request the primary selection from the server (for example, as set |
899 | Try to request the primary selection text from the server (for example, as |
724 | by the next method). |
900 | set by the next method). No visual feedback will be given. This function |
|
|
901 | is mostly useful from within <code>on_sel_grab</code> hooks. |
725 | </dd> |
902 | </dd> |
726 | <p></p> |
903 | <p></p> |
727 | <dt><strong>$oldtext = $term->selection ([$newtext])</strong><br /> |
904 | <dt><strong>$oldtext = $term->selection ([$newtext])</strong><br /> |
728 | </dt> |
905 | </dt> |
729 | <dd> |
906 | <dd> |
… | |
… | |
808 | <p></p> |
985 | <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 /> |
986 | <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> |
987 | </dt> |
811 | <dd> |
988 | <dd> |
812 | XORs the rendition values in the given span with the provided value |
989 | 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 |
990 | (default: <code>RS_RVid</code>), which <em>MUST NOT</em> contain font styles. Useful in |
814 | to the selection. |
991 | refresh hooks to provide effects similar to the selection. |
815 | </dd> |
992 | </dd> |
816 | <p></p> |
993 | <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 /> |
994 | <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> |
995 | </dt> |
819 | <dd> |
996 | <dd> |
820 | Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing |
997 | 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 |
998 | 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 |
999 | to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines |
823 | it instead. |
1000 | it instead. Both styles <em>MUST NOT</em> contain font styles. |
824 | </dd> |
1001 | </dd> |
825 | <p></p> |
1002 | <p></p> |
826 | <dt><strong><a name="item_scr_bell">$term->scr_bell</a></strong><br /> |
1003 | <dt><strong><a name="item_scr_bell">$term->scr_bell</a></strong><br /> |
827 | </dt> |
1004 | </dt> |
828 | <dd> |
1005 | <dd> |
… | |
… | |
878 | </dt> |
1055 | </dt> |
879 | <dd> |
1056 | <dd> |
880 | Return the window id of the terminal window. |
1057 | Return the window id of the terminal window. |
881 | </dd> |
1058 | </dd> |
882 | <p></p> |
1059 | <p></p> |
|
|
1060 | <dt><strong><a name="item_vt_emask_add">$term->vt_emask_add ($x_event_mask)</a></strong><br /> |
|
|
1061 | </dt> |
|
|
1062 | <dd> |
|
|
1063 | Adds the specified events to the vt event mask. Useful e.g. when you want |
|
|
1064 | to receive pointer events all the times: |
|
|
1065 | </dd> |
|
|
1066 | <dd> |
|
|
1067 | <pre> |
|
|
1068 | $term->vt_emask_add (urxvt::PointerMotionMask);</pre> |
|
|
1069 | </dd> |
|
|
1070 | <p></p> |
883 | <dt><strong><a name="item_width">$window_width = $term->width</a></strong><br /> |
1071 | <dt><strong><a name="item_width">$window_width = $term->width</a></strong><br /> |
884 | </dt> |
1072 | </dt> |
885 | <dt><strong><a name="item_height">$window_height = $term->height</a></strong><br /> |
1073 | <dt><strong><a name="item_height">$window_height = $term->height</a></strong><br /> |
886 | </dt> |
1074 | </dt> |
887 | <dt><strong><a name="item_fwidth">$font_width = $term->fwidth</a></strong><br /> |
1075 | <dt><strong><a name="item_fwidth">$font_width = $term->fwidth</a></strong><br /> |
… | |
… | |
900 | </dt> |
1088 | </dt> |
901 | <dt><strong><a name="item_savelines">$max_scrollback = $term->saveLines</a></strong><br /> |
1089 | <dt><strong><a name="item_savelines">$max_scrollback = $term->saveLines</a></strong><br /> |
902 | </dt> |
1090 | </dt> |
903 | <dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term->total_rows</a></strong><br /> |
1091 | <dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term->total_rows</a></strong><br /> |
904 | </dt> |
1092 | </dt> |
905 | <dt><strong><a name="item_nsaved">$lines_in_scrollback = $term->nsaved</a></strong><br /> |
1093 | <dt><strong><a name="item_top_row">$topmost_scrollback_row = $term->top_row</a></strong><br /> |
906 | </dt> |
1094 | </dt> |
907 | <dd> |
1095 | <dd> |
908 | Return various integers describing terminal characteristics. |
1096 | Return various integers describing terminal characteristics. |
909 | </dd> |
1097 | </dd> |
910 | <p></p> |
1098 | <p></p> |
|
|
1099 | <dt><strong><a name="item_display_id">$x_display = $term->display_id</a></strong><br /> |
|
|
1100 | </dt> |
|
|
1101 | <dd> |
|
|
1102 | Return the DISPLAY used by rxvt-unicode. |
|
|
1103 | </dd> |
|
|
1104 | <p></p> |
911 | <dt><strong><a name="item_locale">$lc_ctype = $term->locale</a></strong><br /> |
1105 | <dt><strong><a name="item_locale">$lc_ctype = $term->locale</a></strong><br /> |
912 | </dt> |
1106 | </dt> |
913 | <dd> |
1107 | <dd> |
914 | Returns the LC_CTYPE category string used by this rxvt-unicode. |
1108 | Returns the LC_CTYPE category string used by this rxvt-unicode. |
915 | </dd> |
1109 | </dd> |
916 | <p></p> |
1110 | <p></p> |
917 | <dt><strong><a name="item_display_id">$x_display = $term->display_id</a></strong><br /> |
1111 | <dt><strong><a name="item_env">$env = $term->env</a></strong><br /> |
918 | </dt> |
1112 | </dt> |
919 | <dd> |
1113 | <dd> |
920 | Return the DISPLAY used by rxvt-unicode. |
1114 | Returns a copy of the environment in effect for the terminal as a hashref |
|
|
1115 | similar to <code>\%ENV</code>. |
921 | </dd> |
1116 | </dd> |
922 | <p></p> |
1117 | <p></p> |
923 | <dt><strong><a name="item_modlevel3mask">$modifiermask = $term->ModLevel3Mask</a></strong><br /> |
1118 | <dt><strong><a name="item_modlevel3mask">$modifiermask = $term->ModLevel3Mask</a></strong><br /> |
924 | </dt> |
1119 | </dt> |
925 | <dt><strong><a name="item_modmetamask">$modifiermask = $term->ModMetaMask</a></strong><br /> |
1120 | <dt><strong><a name="item_modmetamask">$modifiermask = $term->ModMetaMask</a></strong><br /> |
… | |
… | |
932 | </dd> |
1127 | </dd> |
933 | <p></p> |
1128 | <p></p> |
934 | <dt><strong><a name="item_view_start">$view_start = $term->view_start ([$newvalue])</a></strong><br /> |
1129 | <dt><strong><a name="item_view_start">$view_start = $term->view_start ([$newvalue])</a></strong><br /> |
935 | </dt> |
1130 | </dt> |
936 | <dd> |
1131 | <dd> |
937 | Returns the negative row number of the topmost line. Minimum value is |
1132 | 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 |
1133 | <code>0</code>, which displays the normal terminal contents. Lower values scroll |
939 | this many lines into the scrollback buffer. |
1134 | this many lines into the scrollback buffer. |
940 | </dd> |
1135 | </dd> |
941 | <p></p> |
1136 | <p></p> |
942 | <dt><strong><a name="item_want_refresh">$term->want_refresh</a></strong><br /> |
1137 | <dt><strong><a name="item_want_refresh">$term->want_refresh</a></strong><br /> |
943 | </dt> |
1138 | </dt> |
… | |
… | |
954 | </dt> |
1149 | </dt> |
955 | <dd> |
1150 | <dd> |
956 | Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code> |
1151 | 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 |
1152 | 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 |
1153 | 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 |
1154 | line <code>-$term->nsaved</code>. Nothing will be returned if a nonexistent line |
960 | is requested. |
1155 | is requested. |
961 | </dd> |
1156 | </dd> |
962 | <dd> |
1157 | <dd> |
963 | <p>If <code>$new_text</code> is specified, it will replace characters in the current |
1158 | <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 |
1159 | line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful |
… | |
… | |
1049 | <p></p> |
1244 | <p></p> |
1050 | <dt><strong><a name="item_offset_of">$offset = $line->offset_of ($row, $col)</a></strong><br /> |
1245 | <dt><strong><a name="item_offset_of">$offset = $line->offset_of ($row, $col)</a></strong><br /> |
1051 | </dt> |
1246 | </dt> |
1052 | <dd> |
1247 | <dd> |
1053 | Returns the character offset of the given row|col pair within the logical |
1248 | Returns the character offset of the given row|col pair within the logical |
1054 | line. |
1249 | line. Works for rows outside the line, too, and returns corresponding |
|
|
1250 | offsets outside the string. |
1055 | </dd> |
1251 | </dd> |
1056 | <p></p> |
1252 | <p></p> |
1057 | <dt><strong><a name="item_coord_of">($row, $col) = $line->coord_of ($offset)</a></strong><br /> |
1253 | <dt><strong><a name="item_coord_of">($row, $col) = $line->coord_of ($offset)</a></strong><br /> |
1058 | </dt> |
1254 | </dt> |
1059 | <dd> |
1255 | <dd> |
… | |
… | |
1287 | <dl> |
1483 | <dl> |
1288 | <dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br /> |
1484 | <dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br /> |
1289 | </dt> |
1485 | </dt> |
1290 | <dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">>= 3 - script loading and management</a></strong><br /> |
1486 | <dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">>= 3 - script loading and management</a></strong><br /> |
1291 | </dt> |
1487 | </dt> |
1292 | <dt><strong><a name="item__3e_3d10__2d_all_events_received">>=10 - all events received</a></strong><br /> |
1488 | <dt><strong><a name="item__3e_3d10__2d_all_called_hooks">>=10 - all called hooks</a></strong><br /> |
|
|
1489 | </dt> |
|
|
1490 | <dt><strong><a name="item__3e_3d11__2d_hook_reutrn_values">>=11 - hook reutrn values</a></strong><br /> |
1293 | </dt> |
1491 | </dt> |
1294 | </dl> |
1492 | </dl> |
1295 | <p> |
1493 | <p> |
1296 | </p> |
1494 | </p> |
1297 | <hr /> |
1495 | <hr /> |