… | |
… | |
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> |
101 | Rot-13 the selection when activated. Used via keyboard trigger: |
131 | Rot-13 the selection when activated. Used via keyboard trigger: |
102 | </dd> |
132 | </dd> |
103 | <dd> |
133 | <dd> |
104 | <pre> |
134 | <pre> |
105 | URxvt.keysym.C-M-r: perl:selection:rot13</pre> |
135 | URxvt.keysym.C-M-r: perl:selection:rot13</pre> |
|
|
136 | </dd> |
|
|
137 | <p></p> |
|
|
138 | <dt><strong><a name="item_remote_2dpastebin">remote-pastebin</a></strong><br /> |
|
|
139 | </dt> |
|
|
140 | <dd> |
|
|
141 | Upload the selection as textfile to a remote site. |
|
|
142 | </dd> |
|
|
143 | <dd> |
|
|
144 | <pre> |
|
|
145 | URxvt.keysym.C-M-e: perl:selection:remote-pastebin</pre> |
|
|
146 | </dd> |
|
|
147 | <dd> |
|
|
148 | <p>To set the command to upload the file set this resource:</p> |
|
|
149 | </dd> |
|
|
150 | <dd> |
|
|
151 | <pre> |
|
|
152 | URxvt.selection-pastebin-cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.</pre> |
|
|
153 | </dd> |
|
|
154 | <dd> |
|
|
155 | <p>The % is the placeholder for the textfile. The name of the textfile is the hex encoded |
|
|
156 | md5 sum of the selection. |
|
|
157 | After an successful upload the selection will be replaced by the following url |
|
|
158 | (the % is the placeholder for the filename):</p> |
|
|
159 | </dd> |
|
|
160 | <dd> |
|
|
161 | <pre> |
|
|
162 | URxvt.selection-pastebin-url: <a href="http://www.ta-sa.org/files/txt/%">http://www.ta-sa.org/files/txt/%</a></pre> |
106 | </dd> |
163 | </dd> |
107 | <p></p></dl> |
164 | <p></p></dl> |
108 | <dt><strong><a name="item_popup">option-popup (enabled by default)</a></strong><br /> |
165 | <dt><strong><a name="item_popup">option-popup (enabled by default)</a></strong><br /> |
109 | </dt> |
166 | </dt> |
110 | <dd> |
167 | <dd> |
… | |
… | |
122 | <p></p> |
179 | <p></p> |
123 | <dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback<hotkey> (enabled by default)</a></strong><br /> |
180 | <dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback<hotkey> (enabled by default)</a></strong><br /> |
124 | </dt> |
181 | </dt> |
125 | <dd> |
182 | <dd> |
126 | Adds regex search functionality to the scrollback buffer, triggered |
183 | Adds regex search functionality to the scrollback buffer, triggered |
127 | by a hotkey (default: <code>M-s</code>). When in search mode, normal terminal |
184 | by a hotkey (default: <code>M-s</code>). While in search mode, normal terminal |
128 | input/output is suspended. |
185 | input/output is suspended and a regex is displayed at the bottom of the |
129 | </dd> |
186 | screen. |
130 | <dd> |
187 | </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> |
188 | <dd> |
136 | <p></p> |
189 | <p>Inputting characters appends them to the regex and continues incremental |
137 | <dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> |
190 | search. <code>BackSpace</code> removes a character from the regex, <code>Up</code> and <code>Down</code> |
138 | </dt> |
191 | search upwards/downwards in the scrollback buffer, <code>End</code> jumps to the |
|
|
192 | bottom. <code>Escape</code> leaves search mode and returns to the point where search |
|
|
193 | was started, while <code>Enter</code> or <code>Return</code> stay at the current position and |
|
|
194 | additionally stores the first match in the current line into the primary |
|
|
195 | selection.</p> |
139 | <dd> |
196 | </dd> |
140 | Displays a digital clock using the built-in overlay. |
197 | <p></p> |
|
|
198 | <dt><strong><a name="item_selection_2dautotransform">selection-autotransform</a></strong><br /> |
|
|
199 | </dt> |
|
|
200 | <dd> |
|
|
201 | This selection allows you to do automatic transforms on a selection |
|
|
202 | whenever a selection is made. |
|
|
203 | </dd> |
|
|
204 | <dd> |
|
|
205 | <p>It works by specifying perl snippets (most useful is a single <code>s///</code> |
|
|
206 | operator) that modify <code>$_</code> as resources:</p> |
|
|
207 | </dd> |
|
|
208 | <dd> |
|
|
209 | <pre> |
|
|
210 | URxvt.selection-autotransform.0: transform |
|
|
211 | URxvt.selection-autotransform.1: transform |
|
|
212 | ...</pre> |
|
|
213 | </dd> |
|
|
214 | <dd> |
|
|
215 | <p>For example, the following will transform selections of the form |
|
|
216 | <code>filename:number</code>, often seen in compiler messages, into <code>vi +$filename |
|
|
217 | $word</code>:</p> |
|
|
218 | </dd> |
|
|
219 | <dd> |
|
|
220 | <pre> |
|
|
221 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/</pre> |
|
|
222 | </dd> |
|
|
223 | <dd> |
|
|
224 | <p>And this example matches the same,but replaces it with vi-commands you can |
|
|
225 | paste directly into your (vi :) editor:</p> |
|
|
226 | </dd> |
|
|
227 | <dd> |
|
|
228 | <pre> |
|
|
229 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/</pre> |
|
|
230 | </dd> |
|
|
231 | <dd> |
|
|
232 | <p>Of course, this can be modified to suit your needs and your editor :)</p> |
|
|
233 | </dd> |
|
|
234 | <dd> |
|
|
235 | <p>To expand the example above to typical perl error messages (``XXX at |
|
|
236 | FILENAME line YYY.''), you need a slightly more elaborate solution:</p> |
|
|
237 | </dd> |
|
|
238 | <dd> |
|
|
239 | <pre> |
|
|
240 | URxvt.selection.pattern-0: ( at .*? line \\d+\\.) |
|
|
241 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/</pre> |
|
|
242 | </dd> |
|
|
243 | <dd> |
|
|
244 | <p>The first line tells the selection code to treat the unchanging part of |
|
|
245 | every error message as a selection pattern, and the second line transforms |
|
|
246 | the message into vi commands to load the file.</p> |
141 | </dd> |
247 | </dd> |
142 | <p></p> |
248 | <p></p> |
143 | <dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> |
249 | <dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> |
144 | </dt> |
250 | </dt> |
145 | <dd> |
251 | <dd> |
146 | Uses per-line display filtering (<code>on_line_update</code>) to underline urls. |
252 | Uses per-line display filtering (<code>on_line_update</code>) to underline urls and |
|
|
253 | make them clickable. When middle-clicked, the program specified in the |
|
|
254 | resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with |
|
|
255 | the URL as first argument. |
147 | </dd> |
256 | </dd> |
148 | <p></p> |
257 | <p></p> |
149 | <dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br /> |
258 | <dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br /> |
150 | </dt> |
259 | </dt> |
151 | <dd> |
260 | <dd> |
152 | A not very useful example of filtering all text output to the terminal, |
261 | 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 |
262 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
154 | similar-looking ascii character. |
263 | similar-looking ascii character. |
|
|
264 | </dd> |
|
|
265 | <p></p> |
|
|
266 | <dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> |
|
|
267 | </dt> |
|
|
268 | <dd> |
|
|
269 | Displays a digital clock using the built-in overlay. |
155 | </dd> |
270 | </dd> |
156 | <p></p> |
271 | <p></p> |
157 | <dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> |
272 | <dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> |
158 | </dt> |
273 | </dt> |
159 | <dd> |
274 | <dd> |
… | |
… | |
183 | <dl> |
298 | <dl> |
184 | <dt><strong><a name="item__24text">$text</a></strong><br /> |
299 | <dt><strong><a name="item__24text">$text</a></strong><br /> |
185 | </dt> |
300 | </dt> |
186 | <dd> |
301 | <dd> |
187 | Rxvt-unicodes special way of encoding text, where one ``unicode'' character |
302 | 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. |
303 | always represents one screen cell. See <a href="#item_row_t">ROW_t</a> for a discussion of this format. |
189 | </dd> |
304 | </dd> |
190 | <p></p> |
305 | <p></p> |
191 | <dt><strong><a name="item__24string">$string</a></strong><br /> |
306 | <dt><strong><a name="item__24string">$string</a></strong><br /> |
192 | </dt> |
307 | </dt> |
193 | <dd> |
308 | <dd> |
… | |
… | |
301 | </dt> |
416 | </dt> |
302 | <dd> |
417 | <dd> |
303 | Called whenever the user tries to extend the selection (e.g. with a double |
418 | 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 |
419 | 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 |
420 | should extend the selection itelf and return true to suppress the built-in |
306 | processing. |
421 | processing. This can happen multiple times, as long as the callback |
|
|
422 | returns true, it will be called on every further click by the user and is |
|
|
423 | supposed to enlarge the selection more and more, if possible. |
307 | </dd> |
424 | </dd> |
308 | <dd> |
425 | <dd> |
309 | <p>See the <em>selection</em> example extension.</p> |
426 | <p>See the <em>selection</em> example extension.</p> |
310 | </dd> |
427 | </dd> |
311 | <p></p> |
428 | <p></p> |
… | |
… | |
402 | Called whenever the user presses a key combination that has a |
519 | 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> |
520 | <code>perl:string</code> action bound to it (see description of the <strong>keysym</strong> |
404 | resource in the <code>rxvt(1)</code> manpage). |
521 | resource in the <code>rxvt(1)</code> manpage). |
405 | </dd> |
522 | </dd> |
406 | <p></p> |
523 | <p></p> |
|
|
524 | <dt><strong><a name="item_on_x_event__24term_2c__24event">on_x_event $term, $event</a></strong><br /> |
|
|
525 | </dt> |
|
|
526 | <dd> |
|
|
527 | Called on every X event received on the vt window (and possibly other |
|
|
528 | windows). Should only be used as a last resort. Most event structure |
|
|
529 | members are not passed. |
|
|
530 | </dd> |
|
|
531 | <p></p> |
407 | <dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> |
532 | <dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> |
408 | </dt> |
533 | </dt> |
409 | <dd> |
534 | <dd> |
410 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
535 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
411 | does focus in processing. |
536 | does focus in processing. |
… | |
… | |
476 | </dt> |
601 | </dt> |
477 | <dd> |
602 | <dd> |
478 | The current terminal. This variable stores the current <code>urxvt::term</code> |
603 | The current terminal. This variable stores the current <code>urxvt::term</code> |
479 | object, whenever a callback/hook is executing. |
604 | object, whenever a callback/hook is executing. |
480 | </dd> |
605 | </dd> |
481 | <p></p> |
606 | <p></p></dl> |
482 | <dt></dt> |
|
|
483 | </dl> |
|
|
484 | <p> |
607 | <p> |
485 | </p> |
608 | </p> |
486 | <h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> |
609 | <h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> |
487 | <dl> |
610 | <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 /> |
611 | <dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br /> |
499 | </dt> |
612 | </dt> |
500 | <dd> |
613 | <dd> |
501 | Fatally aborts execution with the given error message. Avoid at all |
614 | Fatally aborts execution with the given error message. Avoid at all |
502 | costs! The only time this is acceptable is when the terminal process |
615 | costs! The only time this is acceptable is when the terminal process |
… | |
… | |
512 | </dd> |
625 | </dd> |
513 | <dd> |
626 | <dd> |
514 | <p>Using this function has the advantage that its output ends up in the |
627 | <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> |
628 | correct place, e.g. on stderr of the connecting urxvtc client.</p> |
516 | </dd> |
629 | </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> |
630 | <dd> |
521 | Returns true when it is safe to do potentially unsafe things, such as |
631 | <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> |
632 | </dd> |
525 | <p></p> |
633 | <p></p> |
526 | <dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> |
634 | <dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> |
527 | </dt> |
635 | </dt> |
528 | <dd> |
636 | <dd> |
… | |
… | |
532 | <dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br /> |
640 | <dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br /> |
533 | </dt> |
641 | </dt> |
534 | <dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
642 | <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, |
643 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
536 | Button4Mask, Button5Mask, AnyModifier</a></strong><br /> |
644 | Button4Mask, Button5Mask, AnyModifier</a></strong><br /> |
|
|
645 | </dt> |
|
|
646 | <dt><strong><a name="item_urxvt_3a_3anoeventmask_2c_keypressmask_2c_keyrelea">urxvt::NoEventMask, KeyPressMask, KeyReleaseMask, |
|
|
647 | ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, |
|
|
648 | PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask, |
|
|
649 | Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask, |
|
|
650 | KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask, |
|
|
651 | ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask, |
|
|
652 | FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask</a></strong><br /> |
|
|
653 | </dt> |
|
|
654 | <dt><strong><a name="item_urxvt_3a_3akeypress_2c_keyrelease_2c_buttonpress_2">urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify, |
|
|
655 | EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose, |
|
|
656 | GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify, |
|
|
657 | UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify, |
|
|
658 | ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify, |
|
|
659 | CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, |
|
|
660 | SelectionNotify, ColormapNotify, ClientMessage, MappingNotify</a></strong><br /> |
537 | </dt> |
661 | </dt> |
538 | <dd> |
662 | <dd> |
539 | Various constants for use in X calls and event processing. |
663 | Various constants for use in X calls and event processing. |
540 | </dd> |
664 | </dd> |
541 | <p></p></dl> |
665 | <p></p></dl> |
… | |
… | |
612 | work.</p> |
736 | work.</p> |
613 | <p> |
737 | <p> |
614 | </p> |
738 | </p> |
615 | <h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> |
739 | <h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> |
616 | <dl> |
740 | <dl> |
|
|
741 | <dt><strong><a name="item__24term__3d_new_urxvt_3a_3aterm__24envhashref_2c__">$term = new urxvt::term $envhashref, $rxvtname, [arg...]</a></strong><br /> |
|
|
742 | </dt> |
|
|
743 | <dd> |
|
|
744 | Creates a new terminal, very similar as if you had started it with system |
|
|
745 | <code>$rxvtname, arg...</code>. <code>$envhashref</code> must be a reference to a <code>%ENV</code>-like |
|
|
746 | hash which defines the environment of the new terminal. |
|
|
747 | </dd> |
|
|
748 | <dd> |
|
|
749 | <p>Croaks (and probably outputs an error message) if the new instance |
|
|
750 | couldn't be created. Returns <code>undef</code> if the new instance didn't |
|
|
751 | initialise perl, and the terminal object otherwise. The <code>init</code> and |
|
|
752 | <a href="#item_start"><code>start</code></a> hooks will be called during this call.</p> |
|
|
753 | </dd> |
|
|
754 | <p></p> |
617 | <dt><strong><a name="item_destroy">$term->destroy</a></strong><br /> |
755 | <dt><strong><a name="item_destroy">$term->destroy</a></strong><br /> |
618 | </dt> |
756 | </dt> |
619 | <dd> |
757 | <dd> |
620 | Destroy the terminal object (close the window, free resources |
758 | Destroy the terminal object (close the window, free resources |
621 | etc.). Please note that rxvt will not exit as long as any event |
759 | etc.). Please note that rxvt will not exit as long as any event |
… | |
… | |
683 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
821 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
684 | shade term_name title transparent transparent_all tripleclickwords |
822 | shade term_name title transparent transparent_all tripleclickwords |
685 | utmpInhibit visualBell</pre> |
823 | utmpInhibit visualBell</pre> |
686 | </dd> |
824 | </dd> |
687 | <p></p> |
825 | <p></p> |
|
|
826 | <dt><strong><a name="item_x_resource">$value = $term->x_resource ($pattern)</a></strong><br /> |
|
|
827 | </dt> |
|
|
828 | <dd> |
|
|
829 | Returns the X-Resource for the given pattern, excluding the program or |
|
|
830 | class name, i.e. <a href="#item_x_resource"><code>$term->x_resource ("boldFont")</code></a> should return the |
|
|
831 | same value as used by this instance of rxvt-unicode. Returns <code>undef</code> if no |
|
|
832 | resource with that pattern exists. |
|
|
833 | </dd> |
|
|
834 | <dd> |
|
|
835 | <p>This method should only be called during the <code>on_start</code> hook, as there is |
|
|
836 | only one resource database per display, and later invocations might return |
|
|
837 | the wrong resources.</p> |
|
|
838 | </dd> |
|
|
839 | <p></p> |
688 | <dt><strong><a name="item_parse_keysym">$success = $term->parse_keysym ($keysym_spec, $command_string)</a></strong><br /> |
840 | <dt><strong><a name="item_parse_keysym">$success = $term->parse_keysym ($keysym_spec, $command_string)</a></strong><br /> |
689 | </dt> |
841 | </dt> |
690 | <dd> |
842 | <dd> |
691 | Adds a keymap translation exactly as specified via a resource. See the |
843 | Adds a keymap translation exactly as specified via a resource. See the |
692 | <code>keysym</code> resource in the <code>rxvt(1)</code> manpage. |
844 | <code>keysym</code> resource in the <code>rxvt(1)</code> manpage. |
… | |
… | |
715 | <dd> |
867 | <dd> |
716 | Return the current values of the selection mark, begin or end positions, |
868 | Return the current values of the selection mark, begin or end positions, |
717 | and optionally set them to new values. |
869 | and optionally set them to new values. |
718 | </dd> |
870 | </dd> |
719 | <p></p> |
871 | <p></p> |
|
|
872 | <dt><strong><a name="item_selection_make">$term->selection_make ($eventtime[, $rectangular])</a></strong><br /> |
|
|
873 | </dt> |
|
|
874 | <dd> |
|
|
875 | Tries to make a selection as set by <a href="#item_selection_beg"><code>selection_beg</code></a> and |
|
|
876 | <a href="#item_selection_end"><code>selection_end</code></a>. If <code>$rectangular</code> is true (default: false), a |
|
|
877 | rectangular selection will be made. This is the prefered function to make |
|
|
878 | a selection. |
|
|
879 | </dd> |
|
|
880 | <p></p> |
720 | <dt><strong><a name="item_selection_grab">$success = $term->selection_grab ($eventtime)</a></strong><br /> |
881 | <dt><strong><a name="item_selection_grab">$success = $term->selection_grab ($eventtime)</a></strong><br /> |
721 | </dt> |
882 | </dt> |
722 | <dd> |
883 | <dd> |
723 | Try to request the primary selection from the server (for example, as set |
884 | Try to request the primary selection text from the server (for example, as |
724 | by the next method). |
885 | set by the next method). No visual feedback will be given. This function |
|
|
886 | is mostly useful from within <code>on_sel_grab</code> hooks. |
725 | </dd> |
887 | </dd> |
726 | <p></p> |
888 | <p></p> |
727 | <dt><strong>$oldtext = $term->selection ([$newtext])</strong><br /> |
889 | <dt><strong>$oldtext = $term->selection ([$newtext])</strong><br /> |
728 | </dt> |
890 | </dt> |
729 | <dd> |
891 | <dd> |
… | |
… | |
808 | <p></p> |
970 | <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 /> |
971 | <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> |
972 | </dt> |
811 | <dd> |
973 | <dd> |
812 | XORs the rendition values in the given span with the provided value |
974 | 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 |
975 | (default: <code>RS_RVid</code>), which <em>MUST NOT</em> contain font styles. Useful in |
814 | to the selection. |
976 | refresh hooks to provide effects similar to the selection. |
815 | </dd> |
977 | </dd> |
816 | <p></p> |
978 | <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 /> |
979 | <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> |
980 | </dt> |
819 | <dd> |
981 | <dd> |
820 | Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing |
982 | 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 |
983 | 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 |
984 | to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines |
823 | it instead. |
985 | it instead. Both styles <em>MUST NOT</em> contain font styles. |
824 | </dd> |
986 | </dd> |
825 | <p></p> |
987 | <p></p> |
826 | <dt><strong><a name="item_scr_bell">$term->scr_bell</a></strong><br /> |
988 | <dt><strong><a name="item_scr_bell">$term->scr_bell</a></strong><br /> |
827 | </dt> |
989 | </dt> |
828 | <dd> |
990 | <dd> |
… | |
… | |
878 | </dt> |
1040 | </dt> |
879 | <dd> |
1041 | <dd> |
880 | Return the window id of the terminal window. |
1042 | Return the window id of the terminal window. |
881 | </dd> |
1043 | </dd> |
882 | <p></p> |
1044 | <p></p> |
|
|
1045 | <dt><strong><a name="item_vt_emask_add">$term->vt_emask_add ($x_event_mask)</a></strong><br /> |
|
|
1046 | </dt> |
|
|
1047 | <dd> |
|
|
1048 | Adds the specified events to the vt event mask. Useful e.g. when you want |
|
|
1049 | to receive pointer events all the times: |
|
|
1050 | </dd> |
|
|
1051 | <dd> |
|
|
1052 | <pre> |
|
|
1053 | $term->vt_emask_add (urxvt::PointerMotionMask);</pre> |
|
|
1054 | </dd> |
|
|
1055 | <p></p> |
883 | <dt><strong><a name="item_width">$window_width = $term->width</a></strong><br /> |
1056 | <dt><strong><a name="item_width">$window_width = $term->width</a></strong><br /> |
884 | </dt> |
1057 | </dt> |
885 | <dt><strong><a name="item_height">$window_height = $term->height</a></strong><br /> |
1058 | <dt><strong><a name="item_height">$window_height = $term->height</a></strong><br /> |
886 | </dt> |
1059 | </dt> |
887 | <dt><strong><a name="item_fwidth">$font_width = $term->fwidth</a></strong><br /> |
1060 | <dt><strong><a name="item_fwidth">$font_width = $term->fwidth</a></strong><br /> |
… | |
… | |
900 | </dt> |
1073 | </dt> |
901 | <dt><strong><a name="item_savelines">$max_scrollback = $term->saveLines</a></strong><br /> |
1074 | <dt><strong><a name="item_savelines">$max_scrollback = $term->saveLines</a></strong><br /> |
902 | </dt> |
1075 | </dt> |
903 | <dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term->total_rows</a></strong><br /> |
1076 | <dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term->total_rows</a></strong><br /> |
904 | </dt> |
1077 | </dt> |
905 | <dt><strong><a name="item_nsaved">$lines_in_scrollback = $term->nsaved</a></strong><br /> |
1078 | <dt><strong><a name="item_top_row">$topmost_scrollback_row = $term->top_row</a></strong><br /> |
906 | </dt> |
1079 | </dt> |
907 | <dd> |
1080 | <dd> |
908 | Return various integers describing terminal characteristics. |
1081 | Return various integers describing terminal characteristics. |
909 | </dd> |
1082 | </dd> |
910 | <p></p> |
1083 | <p></p> |
|
|
1084 | <dt><strong><a name="item_display_id">$x_display = $term->display_id</a></strong><br /> |
|
|
1085 | </dt> |
|
|
1086 | <dd> |
|
|
1087 | Return the DISPLAY used by rxvt-unicode. |
|
|
1088 | </dd> |
|
|
1089 | <p></p> |
911 | <dt><strong><a name="item_locale">$lc_ctype = $term->locale</a></strong><br /> |
1090 | <dt><strong><a name="item_locale">$lc_ctype = $term->locale</a></strong><br /> |
912 | </dt> |
1091 | </dt> |
913 | <dd> |
1092 | <dd> |
914 | Returns the LC_CTYPE category string used by this rxvt-unicode. |
1093 | Returns the LC_CTYPE category string used by this rxvt-unicode. |
915 | </dd> |
1094 | </dd> |
916 | <p></p> |
1095 | <p></p> |
917 | <dt><strong><a name="item_display_id">$x_display = $term->display_id</a></strong><br /> |
1096 | <dt><strong><a name="item_env">$env = $term->env</a></strong><br /> |
918 | </dt> |
1097 | </dt> |
919 | <dd> |
1098 | <dd> |
920 | Return the DISPLAY used by rxvt-unicode. |
1099 | Returns a copy of the environment in effect for the terminal as a hashref |
|
|
1100 | similar to <code>\%ENV</code>. |
921 | </dd> |
1101 | </dd> |
922 | <p></p> |
1102 | <p></p> |
923 | <dt><strong><a name="item_modlevel3mask">$modifiermask = $term->ModLevel3Mask</a></strong><br /> |
1103 | <dt><strong><a name="item_modlevel3mask">$modifiermask = $term->ModLevel3Mask</a></strong><br /> |
924 | </dt> |
1104 | </dt> |
925 | <dt><strong><a name="item_modmetamask">$modifiermask = $term->ModMetaMask</a></strong><br /> |
1105 | <dt><strong><a name="item_modmetamask">$modifiermask = $term->ModMetaMask</a></strong><br /> |
… | |
… | |
932 | </dd> |
1112 | </dd> |
933 | <p></p> |
1113 | <p></p> |
934 | <dt><strong><a name="item_view_start">$view_start = $term->view_start ([$newvalue])</a></strong><br /> |
1114 | <dt><strong><a name="item_view_start">$view_start = $term->view_start ([$newvalue])</a></strong><br /> |
935 | </dt> |
1115 | </dt> |
936 | <dd> |
1116 | <dd> |
937 | Returns the negative row number of the topmost line. Minimum value is |
1117 | 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 |
1118 | <code>0</code>, which displays the normal terminal contents. Lower values scroll |
939 | this many lines into the scrollback buffer. |
1119 | this many lines into the scrollback buffer. |
940 | </dd> |
1120 | </dd> |
941 | <p></p> |
1121 | <p></p> |
942 | <dt><strong><a name="item_want_refresh">$term->want_refresh</a></strong><br /> |
1122 | <dt><strong><a name="item_want_refresh">$term->want_refresh</a></strong><br /> |
943 | </dt> |
1123 | </dt> |
… | |
… | |
954 | </dt> |
1134 | </dt> |
955 | <dd> |
1135 | <dd> |
956 | Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code> |
1136 | 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 |
1137 | 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 |
1138 | 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 |
1139 | line <code>-$term->nsaved</code>. Nothing will be returned if a nonexistent line |
960 | is requested. |
1140 | is requested. |
961 | </dd> |
1141 | </dd> |
962 | <dd> |
1142 | <dd> |
963 | <p>If <code>$new_text</code> is specified, it will replace characters in the current |
1143 | <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 |
1144 | line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful |
… | |
… | |
1049 | <p></p> |
1229 | <p></p> |
1050 | <dt><strong><a name="item_offset_of">$offset = $line->offset_of ($row, $col)</a></strong><br /> |
1230 | <dt><strong><a name="item_offset_of">$offset = $line->offset_of ($row, $col)</a></strong><br /> |
1051 | </dt> |
1231 | </dt> |
1052 | <dd> |
1232 | <dd> |
1053 | Returns the character offset of the given row|col pair within the logical |
1233 | Returns the character offset of the given row|col pair within the logical |
1054 | line. |
1234 | line. Works for rows outside the line, too, and returns corresponding |
|
|
1235 | offsets outside the string. |
1055 | </dd> |
1236 | </dd> |
1056 | <p></p> |
1237 | <p></p> |
1057 | <dt><strong><a name="item_coord_of">($row, $col) = $line->coord_of ($offset)</a></strong><br /> |
1238 | <dt><strong><a name="item_coord_of">($row, $col) = $line->coord_of ($offset)</a></strong><br /> |
1058 | </dt> |
1239 | </dt> |
1059 | <dd> |
1240 | <dd> |
… | |
… | |
1287 | <dl> |
1468 | <dl> |
1288 | <dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br /> |
1469 | <dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br /> |
1289 | </dt> |
1470 | </dt> |
1290 | <dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">>= 3 - script loading and management</a></strong><br /> |
1471 | <dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">>= 3 - script loading and management</a></strong><br /> |
1291 | </dt> |
1472 | </dt> |
1292 | <dt><strong><a name="item__3e_3d10__2d_all_events_received">>=10 - all events received</a></strong><br /> |
1473 | <dt><strong><a name="item__3e_3d10__2d_all_called_hooks">>=10 - all called hooks</a></strong><br /> |
|
|
1474 | </dt> |
|
|
1475 | <dt><strong><a name="item__3e_3d11__2d_hook_reutrn_values">>=11 - hook reutrn values</a></strong><br /> |
1293 | </dt> |
1476 | </dt> |
1294 | </dl> |
1477 | </dl> |
1295 | <p> |
1478 | <p> |
1296 | </p> |
1479 | </p> |
1297 | <hr /> |
1480 | <hr /> |