… | |
… | |
13 | <ul> |
13 | <ul> |
14 | |
14 | |
15 | <li><a href="#name">NAME</a></li> |
15 | <li><a href="#name">NAME</a></li> |
16 | <li><a href="#synopsis">SYNOPSIS</a></li> |
16 | <li><a href="#synopsis">SYNOPSIS</a></li> |
17 | <li><a href="#description">DESCRIPTION</a></li> |
17 | <li><a href="#description">DESCRIPTION</a></li> |
|
|
18 | <li><a href="#prepackaged_extensions">PREPACKAGED EXTENSIONS</a></li> |
|
|
19 | <li><a href="#api_documentation">API DOCUMENTATION</a></li> |
18 | <ul> |
20 | <ul> |
19 | |
21 | |
20 | <li><a href="#prepackaged_extensions">Prepackaged Extensions</a></li> |
|
|
21 | <li><a href="#general_api_considerations">General API Considerations</a></li> |
22 | <li><a href="#general_api_considerations">General API Considerations</a></li> |
22 | <li><a href="#extension_objects">Extension Objects</a></li> |
23 | <li><a href="#extension_objects">Extension Objects</a></li> |
23 | <li><a href="#hooks">Hooks</a></li> |
24 | <li><a href="#hooks">Hooks</a></li> |
24 | <li><a href="#variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></li> |
25 | <li><a href="#variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></li> |
25 | <li><a href="#functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></li> |
26 | <li><a href="#functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></li> |
… | |
… | |
72 | thus must be encoded as UTF-8.</p> |
73 | thus must be encoded as UTF-8.</p> |
73 | <p>Each script will only ever be loaded once, even in rxvtd, where |
74 | <p>Each script will only ever be loaded once, even in rxvtd, where |
74 | scripts will be shared (but not enabled) for all terminals.</p> |
75 | scripts will be shared (but not enabled) for all terminals.</p> |
75 | <p> |
76 | <p> |
76 | </p> |
77 | </p> |
77 | <h2><a name="prepackaged_extensions">Prepackaged Extensions</a></h2> |
78 | <hr /> |
|
|
79 | <h1><a name="prepackaged_extensions">PREPACKAGED EXTENSIONS</a></h1> |
78 | <p>This section describes the extensiosn delivered with this version. You can |
80 | <p>This section describes the extensions delivered with this release. You can |
79 | find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> |
81 | find them in <em>/opt/rxvt/lib/urxvt/perl/</em>.</p> |
80 | <p>You can activate them like this:</p> |
82 | <p>You can activate them like this:</p> |
81 | <pre> |
83 | <pre> |
82 | rxvt -pe <extensionname></pre> |
84 | rxvt -pe <extensionname></pre> |
83 | <dl> |
85 | <dl> |
84 | <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 /> |
85 | </dt> |
87 | </dt> |
86 | <dd> |
88 | <dd> |
87 | Intelligent selection. This extension tries to be more intelligent when |
89 | (More) intelligent selection. This extension tries to be more intelligent |
88 | the user extends selections (double-click). Right now, it tries to select |
90 | when the user extends selections (double-click and further clicks). Right |
89 | urls and complete shell-quoted arguments, which is very convenient, too, |
91 | now, it tries to select words, urls and complete shell-quoted |
90 | if your <em>ls</em> supports <code>--quoting-style=shell</code>. |
92 | arguments, which is very convenient, too, if your <em>ls</em> supports |
91 | </dd> |
93 | <code>--quoting-style=shell</code>. |
92 | <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> |
93 | <p>It also offers the following bindable event:</p> |
125 | <p>This extension also offers the following bindable keyboard command:</p> |
94 | </dd> |
126 | </dd> |
95 | <dl> |
127 | <dl> |
96 | <dt><strong><a name="item_rot13">rot13</a></strong><br /> |
128 | <dt><strong><a name="item_rot13">rot13</a></strong><br /> |
97 | </dt> |
129 | </dt> |
98 | <dd> |
130 | <dd> |
… | |
… | |
112 | <p></p> |
144 | <p></p> |
113 | <dt><strong>selection-popup (enabled by default)</strong><br /> |
145 | <dt><strong>selection-popup (enabled by default)</strong><br /> |
114 | </dt> |
146 | </dt> |
115 | <dd> |
147 | <dd> |
116 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
148 | Binds a popup menu to Ctrl-Button3 that lets you convert the selection |
117 | text into various other formats/action. |
149 | text into various other formats/action (such as uri unescaping, perl |
|
|
150 | evalution, web-browser starting etc.), depending on content. |
118 | </dd> |
151 | </dd> |
119 | <p></p> |
152 | <p></p> |
120 | <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 /> |
121 | </dt> |
154 | </dt> |
122 | <dd> |
155 | <dd> |
123 | Adds regex search functionality to the scrollback buffer, triggered |
156 | Adds regex search functionality to the scrollback buffer, triggered |
124 | 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 |
125 | input/output is suspended. |
158 | input/output is suspended and a regex is displayed at the bottom of the |
126 | </dd> |
159 | screen. |
127 | <dd> |
160 | </dd> |
128 | <p><code>/</code> starts an incremental regex search, <code>n</code> searches further, <code>p</code> or |
|
|
129 | <code>N</code> jump to the previous match, <code>G</code> jumps to the bottom and clears the |
|
|
130 | history, <code>enter</code> leaves search mode at the current position and <code>escape</code> |
|
|
131 | returns to the original position.</p> |
|
|
132 | </dd> |
161 | <dd> |
133 | <p></p> |
162 | <p>Inputting characters appends them to the regex and continues incremental |
134 | <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> |
135 | </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> |
136 | <dd> |
169 | </dd> |
137 | 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/^(\\S+):(\\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/^(S+):(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> |
138 | </dd> |
206 | </dd> |
139 | <p></p> |
207 | <p></p> |
140 | <dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> |
208 | <dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> |
141 | </dt> |
209 | </dt> |
142 | <dd> |
210 | <dd> |
143 | Uses per-line display filtering (<code>on_line_update</code>) to underline urls. |
211 | Uses per-line display filtering (<code>on_line_update</code>) to underline urls and |
|
|
212 | make them clickable. When middle-clicked, the program specified in the |
|
|
213 | resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with |
|
|
214 | the URL as first argument. |
144 | </dd> |
215 | </dd> |
145 | <p></p> |
216 | <p></p> |
146 | <dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br /> |
217 | <dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br /> |
147 | </dt> |
218 | </dt> |
148 | <dd> |
219 | <dd> |
149 | A not very useful example of filtering all text output to the terminal, |
220 | A not very useful example of filtering all text output to the terminal, |
150 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
221 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
151 | similar-looking ascii character. |
222 | similar-looking ascii character. |
152 | </dd> |
223 | </dd> |
153 | <p></p> |
224 | <p></p> |
|
|
225 | <dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> |
|
|
226 | </dt> |
|
|
227 | <dd> |
|
|
228 | Displays a digital clock using the built-in overlay. |
|
|
229 | </dd> |
|
|
230 | <p></p> |
154 | <dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> |
231 | <dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> |
155 | </dt> |
232 | </dt> |
156 | <dd> |
233 | <dd> |
157 | Displays a very simple digital clock in the upper right corner of the |
234 | Displays a very simple digital clock in the upper right corner of the |
158 | window. Illustrates overwriting the refresh callbacks to create your own |
235 | window. Illustrates overwriting the refresh callbacks to create your own |
159 | overlays or changes. |
236 | overlays or changes. |
160 | </dd> |
237 | </dd> |
161 | <p></p></dl> |
238 | <p></p></dl> |
|
|
239 | <p> |
|
|
240 | </p> |
|
|
241 | <hr /> |
|
|
242 | <h1><a name="api_documentation">API DOCUMENTATION</a></h1> |
162 | <p> |
243 | <p> |
163 | </p> |
244 | </p> |
164 | <h2><a name="general_api_considerations">General API Considerations</a></h2> |
245 | <h2><a name="general_api_considerations">General API Considerations</a></h2> |
165 | <p>All objects (such as terminals, time watchers etc.) are typical |
246 | <p>All objects (such as terminals, time watchers etc.) are typical |
166 | reference-to-hash objects. The hash can be used to store anything you |
247 | reference-to-hash objects. The hash can be used to store anything you |
… | |
… | |
176 | <dl> |
257 | <dl> |
177 | <dt><strong><a name="item__24text">$text</a></strong><br /> |
258 | <dt><strong><a name="item__24text">$text</a></strong><br /> |
178 | </dt> |
259 | </dt> |
179 | <dd> |
260 | <dd> |
180 | Rxvt-unicodes special way of encoding text, where one ``unicode'' character |
261 | Rxvt-unicodes special way of encoding text, where one ``unicode'' character |
181 | always represents one screen cell. See <em>row_t</em> for a discussion of this format. |
262 | always represents one screen cell. See <a href="#item_row_t">ROW_t</a> for a discussion of this format. |
182 | </dd> |
263 | </dd> |
183 | <p></p> |
264 | <p></p> |
184 | <dt><strong><a name="item__24string">$string</a></strong><br /> |
265 | <dt><strong><a name="item__24string">$string</a></strong><br /> |
185 | </dt> |
266 | </dt> |
186 | <dd> |
267 | <dd> |
… | |
… | |
294 | </dt> |
375 | </dt> |
295 | <dd> |
376 | <dd> |
296 | Called whenever the user tries to extend the selection (e.g. with a double |
377 | Called whenever the user tries to extend the selection (e.g. with a double |
297 | click) and is either supposed to return false (normal operation), or |
378 | click) and is either supposed to return false (normal operation), or |
298 | should extend the selection itelf and return true to suppress the built-in |
379 | should extend the selection itelf and return true to suppress the built-in |
299 | processing. |
380 | processing. This can happen multiple times, as long as the callback |
|
|
381 | returns true, it will be called on every further click by the user and is |
|
|
382 | supposed to enlarge the selection more and more, if possible. |
300 | </dd> |
383 | </dd> |
301 | <dd> |
384 | <dd> |
302 | <p>See the <em>selection</em> example extension.</p> |
385 | <p>See the <em>selection</em> example extension.</p> |
303 | </dd> |
386 | </dd> |
304 | <p></p> |
387 | <p></p> |
… | |
… | |
444 | <p></p></dl> |
527 | <p></p></dl> |
445 | <p> |
528 | <p> |
446 | </p> |
529 | </p> |
447 | <h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> |
530 | <h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> |
448 | <dl> |
531 | <dl> |
|
|
532 | <dt><strong><a name="item__24urxvt_3a_3alibdir">$urxvt::LIBDIR</a></strong><br /> |
|
|
533 | </dt> |
|
|
534 | <dd> |
|
|
535 | The rxvt-unicode library directory, where, among other things, the perl |
|
|
536 | modules and scripts are stored. |
|
|
537 | </dd> |
|
|
538 | <p></p> |
|
|
539 | <dt><strong><a name="item__24urxvt_3a_3aresclass_2c__24urxvt_3a_3aresclass">$urxvt::RESCLASS, $urxvt::RESCLASS</a></strong><br /> |
|
|
540 | </dt> |
|
|
541 | <dd> |
|
|
542 | The resource class and name rxvt-unicode uses to look up X resources. |
|
|
543 | </dd> |
|
|
544 | <p></p> |
|
|
545 | <dt><strong><a name="item__24urxvt_3a_3arxvtname">$urxvt::RXVTNAME</a></strong><br /> |
|
|
546 | </dt> |
|
|
547 | <dd> |
|
|
548 | The basename of the installed binaries, usually <code>urxvt</code>. |
|
|
549 | </dd> |
|
|
550 | <p></p> |
449 | <dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br /> |
551 | <dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br /> |
450 | </dt> |
552 | </dt> |
451 | <dd> |
553 | <dd> |
452 | The current terminal. This variable stores the current <code>urxvt::term</code> |
554 | The current terminal. This variable stores the current <code>urxvt::term</code> |
453 | object, whenever a callback/hook is executing. |
555 | object, whenever a callback/hook is executing. |
… | |
… | |
455 | <p></p></dl> |
557 | <p></p></dl> |
456 | <p> |
558 | <p> |
457 | </p> |
559 | </p> |
458 | <h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> |
560 | <h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> |
459 | <dl> |
561 | <dl> |
460 | <dt><strong><a name="item__24term__3d_new_urxvt__5barg_2e_2e_2e_5d">$term = new urxvt [arg...]</a></strong><br /> |
|
|
461 | </dt> |
|
|
462 | <dd> |
|
|
463 | Creates a new terminal, very similar as if you had started it with |
|
|
464 | <code>system $binfile, arg...</code>. Croaks (and probably outputs an error message) |
|
|
465 | if the new instance couldn't be created. Returns <code>undef</code> if the new |
|
|
466 | instance didn't initialise perl, and the terminal object otherwise. The |
|
|
467 | <code>init</code> and <a href="#item_start"><code>start</code></a> hooks will be called during the call. |
|
|
468 | </dd> |
|
|
469 | <p></p> |
|
|
470 | <dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br /> |
562 | <dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br /> |
471 | </dt> |
563 | </dt> |
472 | <dd> |
564 | <dd> |
473 | Fatally aborts execution with the given error message. Avoid at all |
565 | Fatally aborts execution with the given error message. Avoid at all |
474 | costs! The only time this is acceptable is when the terminal process |
566 | costs! The only time this is acceptable is when the terminal process |
… | |
… | |
483 | that calls this function. |
575 | that calls this function. |
484 | </dd> |
576 | </dd> |
485 | <dd> |
577 | <dd> |
486 | <p>Using this function has the advantage that its output ends up in the |
578 | <p>Using this function has the advantage that its output ends up in the |
487 | correct place, e.g. on stderr of the connecting urxvtc client.</p> |
579 | correct place, e.g. on stderr of the connecting urxvtc client.</p> |
|
|
580 | </dd> |
|
|
581 | <dd> |
|
|
582 | <p>Messages have a size limit of 1023 bytes currently.</p> |
488 | </dd> |
583 | </dd> |
489 | <p></p> |
584 | <p></p> |
490 | <dt><strong><a name="item__24is_safe__3d_urxvt_3a_3asafe">$is_safe = urxvt::safe</a></strong><br /> |
585 | <dt><strong><a name="item__24is_safe__3d_urxvt_3a_3asafe">$is_safe = urxvt::safe</a></strong><br /> |
491 | </dt> |
586 | </dt> |
492 | <dd> |
587 | <dd> |
… | |
… | |
548 | </dt> |
643 | </dt> |
549 | <dd> |
644 | <dd> |
550 | Return the foreground/background colour index, respectively. |
645 | Return the foreground/background colour index, respectively. |
551 | </dd> |
646 | </dd> |
552 | <p></p> |
647 | <p></p> |
553 | <dt><strong><a name="item_set_fgcolor">$rend = urxvt::SET_FGCOLOR ($rend, $new_colour)</a></strong><br /> |
648 | <dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_fgcolor__24rend_2c__24n">$rend = urxvt::SET_FGCOLOR $rend, $new_colour</a></strong><br /> |
554 | </dt> |
649 | </dt> |
555 | <dt><strong><a name="item_set_bgcolor">$rend = urxvt::SET_BGCOLOR ($rend, $new_colour)</a></strong><br /> |
650 | <dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_bgcolor__24rend_2c__24n">$rend = urxvt::SET_BGCOLOR $rend, $new_colour</a></strong><br /> |
556 | </dt> |
651 | </dt> |
557 | <dd> |
652 | <dd> |
558 | Replace the foreground/background colour in the rendition mask with the |
653 | Replace the foreground/background colour in the rendition mask with the |
559 | specified one. |
654 | specified one. |
560 | </dd> |
655 | </dd> |
561 | <p></p> |
656 | <p></p> |
562 | <dt><strong><a name="item_get_custom">$value = urxvt::GET_CUSTOM ($rend)</a></strong><br /> |
657 | <dt><strong><a name="item__24value__3d_urxvt_3a_3aget_custom__24rend">$value = urxvt::GET_CUSTOM $rend</a></strong><br /> |
563 | </dt> |
658 | </dt> |
564 | <dd> |
659 | <dd> |
565 | Return the ``custom'' value: Every rendition has 5 bits for use by |
660 | Return the ``custom'' value: Every rendition has 5 bits for use by |
566 | extensions. They can be set and changed as you like and are initially |
661 | extensions. They can be set and changed as you like and are initially |
567 | zero. |
662 | zero. |
568 | </dd> |
663 | </dd> |
569 | <p></p> |
664 | <p></p> |
570 | <dt><strong><a name="item_set_custom">$rend = urxvt::SET_CUSTOM ($rend, $new_value)</a></strong><br /> |
665 | <dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_custom__24rend_2c__24ne">$rend = urxvt::SET_CUSTOM $rend, $new_value</a></strong><br /> |
571 | </dt> |
666 | </dt> |
572 | <dd> |
667 | <dd> |
573 | Change the custom value. |
668 | Change the custom value. |
574 | </dd> |
669 | </dd> |
575 | <p></p></dl> |
670 | <p></p></dl> |
576 | <p> |
671 | <p> |
577 | </p> |
672 | </p> |
578 | <h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2> |
673 | <h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2> |
579 | <p>The sole purpose of this class is to deliver an interface to the |
674 | <p>The sole purpose of this class is to deliver an interface to the |
580 | <code>AnyEvent</code> module - any module using it will work inside urxvt without |
675 | <code>AnyEvent</code> module - any module using it will work inside urxvt without |
581 | further work. The only exception is that you cannot wait on condition |
676 | further programming. The only exception is that you cannot wait on |
582 | variables, but non-blocking condvar use is ok. What this means is that you |
677 | condition variables, but non-blocking condvar use is ok. What this means |
583 | cannot use blocking APIs, but the non-blocking variant should work.</p> |
678 | is that you cannot use blocking APIs, but the non-blocking variant should |
|
|
679 | work.</p> |
584 | <p> |
680 | <p> |
585 | </p> |
681 | </p> |
586 | <h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> |
682 | <h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> |
587 | <dl> |
683 | <dl> |
|
|
684 | <dt><strong><a name="item__24term__3d_new_urxvt_3a_3aterm__24envhashref_2c__">$term = new urxvt::term $envhashref, $rxvtname, [arg...]</a></strong><br /> |
|
|
685 | </dt> |
|
|
686 | <dd> |
|
|
687 | Creates a new terminal, very similar as if you had started it with system |
|
|
688 | <code>$rxvtname, arg...</code>. <code>$envhashref</code> must be a reference to a <code>%ENV</code>-like |
|
|
689 | hash which defines the environment of the new terminal. |
|
|
690 | </dd> |
|
|
691 | <dd> |
|
|
692 | <p>Croaks (and probably outputs an error message) if the new instance |
|
|
693 | couldn't be created. Returns <code>undef</code> if the new instance didn't |
|
|
694 | initialise perl, and the terminal object otherwise. The <code>init</code> and |
|
|
695 | <a href="#item_start"><code>start</code></a> hooks will be called during this call.</p> |
|
|
696 | </dd> |
|
|
697 | <p></p> |
588 | <dt><strong><a name="item_destroy">$term->destroy</a></strong><br /> |
698 | <dt><strong><a name="item_destroy">$term->destroy</a></strong><br /> |
589 | </dt> |
699 | </dt> |
590 | <dd> |
700 | <dd> |
591 | Destroy the terminal object (close the window, free resources etc.). |
701 | Destroy the terminal object (close the window, free resources |
|
|
702 | etc.). Please note that rxvt will not exit as long as any event |
|
|
703 | watchers (timers, io watchers) are still active. |
592 | </dd> |
704 | </dd> |
593 | <p></p> |
705 | <p></p> |
594 | <dt><strong><a name="item_option">$isset = $term->option ($optval[, $set])</a></strong><br /> |
706 | <dt><strong><a name="item_option">$isset = $term->option ($optval[, $set])</a></strong><br /> |
595 | </dt> |
707 | </dt> |
596 | <dd> |
708 | <dd> |
… | |
… | |
652 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
764 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
653 | shade term_name title transparent transparent_all tripleclickwords |
765 | shade term_name title transparent transparent_all tripleclickwords |
654 | utmpInhibit visualBell</pre> |
766 | utmpInhibit visualBell</pre> |
655 | </dd> |
767 | </dd> |
656 | <p></p> |
768 | <p></p> |
|
|
769 | <dt><strong><a name="item_x_resource">$value = $term->x_resource ($pattern)</a></strong><br /> |
|
|
770 | </dt> |
|
|
771 | <dd> |
|
|
772 | Returns the X-Resource for the given pattern, excluding the program or |
|
|
773 | class name, i.e. <a href="#item_x_resource"><code>$term->x_resource ("boldFont")</code></a> should return the |
|
|
774 | same value as used by this instance of rxvt-unicode. Returns <code>undef</code> if no |
|
|
775 | resource with that pattern exists. |
|
|
776 | </dd> |
|
|
777 | <dd> |
|
|
778 | <p>This method should only be called during the <code>on_start</code> hook, as there is |
|
|
779 | only one resource database per display, and later invocations might return |
|
|
780 | the wrong resources.</p> |
|
|
781 | </dd> |
|
|
782 | <p></p> |
657 | <dt><strong><a name="item_parse_keysym">$success = $term->parse_keysym ($keysym_spec, $command_string)</a></strong><br /> |
783 | <dt><strong><a name="item_parse_keysym">$success = $term->parse_keysym ($keysym_spec, $command_string)</a></strong><br /> |
658 | </dt> |
784 | </dt> |
659 | <dd> |
785 | <dd> |
660 | Adds a keymap translation exactly as specified via a resource. See the |
786 | Adds a keymap translation exactly as specified via a resource. See the |
661 | <code>keysym</code> resource in the <code>rxvt(1)</code> manpage. |
787 | <code>keysym</code> resource in the <code>rxvt(1)</code> manpage. |
… | |
… | |
684 | <dd> |
810 | <dd> |
685 | Return the current values of the selection mark, begin or end positions, |
811 | Return the current values of the selection mark, begin or end positions, |
686 | and optionally set them to new values. |
812 | and optionally set them to new values. |
687 | </dd> |
813 | </dd> |
688 | <p></p> |
814 | <p></p> |
|
|
815 | <dt><strong><a name="item_selection_make">$term->selection_make ($eventtime[, $rectangular])</a></strong><br /> |
|
|
816 | </dt> |
|
|
817 | <dd> |
|
|
818 | Tries to make a selection as set by <a href="#item_selection_beg"><code>selection_beg</code></a> and |
|
|
819 | <a href="#item_selection_end"><code>selection_end</code></a>. If <code>$rectangular</code> is true (default: false), a |
|
|
820 | rectangular selection will be made. This is the prefered function to make |
|
|
821 | a selection. |
|
|
822 | </dd> |
|
|
823 | <p></p> |
689 | <dt><strong><a name="item_selection_grab">$success = $term->selection_grab ($eventtime)</a></strong><br /> |
824 | <dt><strong><a name="item_selection_grab">$success = $term->selection_grab ($eventtime)</a></strong><br /> |
690 | </dt> |
825 | </dt> |
691 | <dd> |
826 | <dd> |
692 | Try to request the primary selection from the server (for example, as set |
827 | Try to request the primary selection text from the server (for example, as |
693 | by the next method). |
828 | set by the next method). No visual feedback will be given. This function |
|
|
829 | is mostly useful from within <code>on_sel_grab</code> hooks. |
694 | </dd> |
830 | </dd> |
695 | <p></p> |
831 | <p></p> |
696 | <dt><strong>$oldtext = $term->selection ([$newtext])</strong><br /> |
832 | <dt><strong>$oldtext = $term->selection ([$newtext])</strong><br /> |
697 | </dt> |
833 | </dt> |
698 | <dd> |
834 | <dd> |
… | |
… | |
777 | <p></p> |
913 | <p></p> |
778 | <dt><strong><a name="item_scr_xor_span">$term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])</a></strong><br /> |
914 | <dt><strong><a name="item_scr_xor_span">$term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])</a></strong><br /> |
779 | </dt> |
915 | </dt> |
780 | <dd> |
916 | <dd> |
781 | XORs the rendition values in the given span with the provided value |
917 | XORs the rendition values in the given span with the provided value |
782 | (default: <code>RS_RVid</code>). Useful in refresh hooks to provide effects similar |
918 | (default: <code>RS_RVid</code>), which <em>MUST NOT</em> contain font styles. Useful in |
783 | to the selection. |
919 | refresh hooks to provide effects similar to the selection. |
784 | </dd> |
920 | </dd> |
785 | <p></p> |
921 | <p></p> |
786 | <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 /> |
922 | <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 /> |
787 | </dt> |
923 | </dt> |
788 | <dd> |
924 | <dd> |
789 | Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing |
925 | Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing |
790 | whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults |
926 | whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults |
791 | to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines |
927 | to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines |
792 | it instead. |
928 | it instead. Both styles <em>MUST NOT</em> contain font styles. |
793 | </dd> |
929 | </dd> |
794 | <p></p> |
930 | <p></p> |
795 | <dt><strong><a name="item_scr_bell">$term->scr_bell</a></strong><br /> |
931 | <dt><strong><a name="item_scr_bell">$term->scr_bell</a></strong><br /> |
796 | </dt> |
932 | </dt> |
797 | <dd> |
933 | <dd> |
… | |
… | |
875 | </dt> |
1011 | </dt> |
876 | <dd> |
1012 | <dd> |
877 | Return various integers describing terminal characteristics. |
1013 | Return various integers describing terminal characteristics. |
878 | </dd> |
1014 | </dd> |
879 | <p></p> |
1015 | <p></p> |
|
|
1016 | <dt><strong><a name="item_display_id">$x_display = $term->display_id</a></strong><br /> |
|
|
1017 | </dt> |
|
|
1018 | <dd> |
|
|
1019 | Return the DISPLAY used by rxvt-unicode. |
|
|
1020 | </dd> |
|
|
1021 | <p></p> |
880 | <dt><strong><a name="item_locale">$lc_ctype = $term->locale</a></strong><br /> |
1022 | <dt><strong><a name="item_locale">$lc_ctype = $term->locale</a></strong><br /> |
881 | </dt> |
1023 | </dt> |
882 | <dd> |
1024 | <dd> |
883 | Returns the LC_CTYPE category string used by this rxvt-unicode. |
1025 | Returns the LC_CTYPE category string used by this rxvt-unicode. |
884 | </dd> |
1026 | </dd> |
885 | <p></p> |
1027 | <p></p> |
886 | <dt><strong><a name="item_display_id">$x_display = $term->display_id</a></strong><br /> |
1028 | <dt><strong><a name="item_env">$env = $term->env</a></strong><br /> |
887 | </dt> |
1029 | </dt> |
888 | <dd> |
1030 | <dd> |
889 | Return the DISPLAY used by rxvt-unicode. |
1031 | Returns a copy of the environment in effect for the terminal as a hashref |
|
|
1032 | similar to <code>\%ENV</code>. |
890 | </dd> |
1033 | </dd> |
891 | <p></p> |
1034 | <p></p> |
892 | <dt><strong><a name="item_modlevel3mask">$modifiermask = $term->ModLevel3Mask</a></strong><br /> |
1035 | <dt><strong><a name="item_modlevel3mask">$modifiermask = $term->ModLevel3Mask</a></strong><br /> |
893 | </dt> |
1036 | </dt> |
894 | <dt><strong><a name="item_modmetamask">$modifiermask = $term->ModMetaMask</a></strong><br /> |
1037 | <dt><strong><a name="item_modmetamask">$modifiermask = $term->ModMetaMask</a></strong><br /> |
… | |
… | |
1018 | <p></p> |
1161 | <p></p> |
1019 | <dt><strong><a name="item_offset_of">$offset = $line->offset_of ($row, $col)</a></strong><br /> |
1162 | <dt><strong><a name="item_offset_of">$offset = $line->offset_of ($row, $col)</a></strong><br /> |
1020 | </dt> |
1163 | </dt> |
1021 | <dd> |
1164 | <dd> |
1022 | Returns the character offset of the given row|col pair within the logical |
1165 | Returns the character offset of the given row|col pair within the logical |
1023 | line. |
1166 | line. Works for rows outside the line, too, and returns corresponding |
|
|
1167 | offsets outside the string. |
1024 | </dd> |
1168 | </dd> |
1025 | <p></p> |
1169 | <p></p> |
1026 | <dt><strong><a name="item_coord_of">($row, $col) = $line->coord_of ($offset)</a></strong><br /> |
1170 | <dt><strong><a name="item_coord_of">($row, $col) = $line->coord_of ($offset)</a></strong><br /> |
1027 | </dt> |
1171 | </dt> |
1028 | <dd> |
1172 | <dd> |
… | |
… | |
1085 | </dd> |
1229 | </dd> |
1086 | <p></p></dl> |
1230 | <p></p></dl> |
1087 | <p> |
1231 | <p> |
1088 | </p> |
1232 | </p> |
1089 | <h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> |
1233 | <h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> |
|
|
1234 | <dl> |
|
|
1235 | <dt><strong><a name="item_add_title">$popup->add_title ($title)</a></strong><br /> |
|
|
1236 | </dt> |
|
|
1237 | <dd> |
|
|
1238 | Adds a non-clickable title to the popup. |
|
|
1239 | </dd> |
|
|
1240 | <p></p> |
|
|
1241 | <dt><strong><a name="item_add_separator">$popup->add_separator ([$sepchr])</a></strong><br /> |
|
|
1242 | </dt> |
|
|
1243 | <dd> |
|
|
1244 | Creates a separator, optionally using the character given as <code>$sepchr</code>. |
|
|
1245 | </dd> |
|
|
1246 | <p></p> |
|
|
1247 | <dt><strong><a name="item_add_button">$popup->add_button ($text, $cb)</a></strong><br /> |
|
|
1248 | </dt> |
|
|
1249 | <dd> |
|
|
1250 | Adds a clickable button to the popup. <code>$cb</code> is called whenever it is |
|
|
1251 | selected. |
|
|
1252 | </dd> |
|
|
1253 | <p></p> |
|
|
1254 | <dt><strong><a name="item_add_toggle">$popup->add_toggle ($text, $cb, $initial_value)</a></strong><br /> |
|
|
1255 | </dt> |
|
|
1256 | <dd> |
|
|
1257 | Adds a toggle/checkbox item to the popup. Teh callback gets called |
|
|
1258 | whenever it gets toggled, with a boolean indicating its value as its first |
|
|
1259 | argument. |
|
|
1260 | </dd> |
|
|
1261 | <p></p> |
|
|
1262 | <dt><strong>$popup->show</strong><br /> |
|
|
1263 | </dt> |
|
|
1264 | <dd> |
|
|
1265 | Displays the popup (which is initially hidden). |
|
|
1266 | </dd> |
|
|
1267 | <p></p></dl> |
1090 | <p> |
1268 | <p> |
1091 | </p> |
1269 | </p> |
1092 | <h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> |
1270 | <h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> |
1093 | <p>This class implements timer watchers/events. Time is represented as a |
1271 | <p>This class implements timer watchers/events. Time is represented as a |
1094 | fractional number of seconds since the epoch. Example:</p> |
1272 | fractional number of seconds since the epoch. Example:</p> |
… | |
… | |
1222 | <dl> |
1400 | <dl> |
1223 | <dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br /> |
1401 | <dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br /> |
1224 | </dt> |
1402 | </dt> |
1225 | <dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">>= 3 - script loading and management</a></strong><br /> |
1403 | <dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">>= 3 - script loading and management</a></strong><br /> |
1226 | </dt> |
1404 | </dt> |
1227 | <dt><strong><a name="item__3e_3d10__2d_all_events_received">>=10 - all events received</a></strong><br /> |
1405 | <dt><strong><a name="item__3e_3d10__2d_all_called_hooks">>=10 - all called hooks</a></strong><br /> |
|
|
1406 | </dt> |
|
|
1407 | <dt><strong><a name="item__3e_3d11__2d_hook_reutrn_values">>=11 - hook reutrn values</a></strong><br /> |
1228 | </dt> |
1408 | </dt> |
1229 | </dl> |
1409 | </dl> |
1230 | <p> |
1410 | <p> |
1231 | </p> |
1411 | </p> |
1232 | <hr /> |
1412 | <hr /> |