… | |
… | |
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 the following bindable keyboard command:</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/^(\\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> |
141 | </dd> |
206 | </dd> |
142 | <p></p> |
207 | <p></p> |
143 | <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 /> |
144 | </dt> |
209 | </dt> |
145 | <dd> |
210 | <dd> |
146 | 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. |
147 | </dd> |
215 | </dd> |
148 | <p></p> |
216 | <p></p> |
149 | <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 /> |
150 | </dt> |
218 | </dt> |
151 | <dd> |
219 | <dd> |
152 | 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, |
153 | 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 |
154 | similar-looking ascii character. |
222 | similar-looking ascii character. |
|
|
223 | </dd> |
|
|
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. |
155 | </dd> |
229 | </dd> |
156 | <p></p> |
230 | <p></p> |
157 | <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 /> |
158 | </dt> |
232 | </dt> |
159 | <dd> |
233 | <dd> |
… | |
… | |
183 | <dl> |
257 | <dl> |
184 | <dt><strong><a name="item__24text">$text</a></strong><br /> |
258 | <dt><strong><a name="item__24text">$text</a></strong><br /> |
185 | </dt> |
259 | </dt> |
186 | <dd> |
260 | <dd> |
187 | Rxvt-unicodes special way of encoding text, where one ``unicode'' character |
261 | 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. |
262 | always represents one screen cell. See <a href="#item_row_t">ROW_t</a> for a discussion of this format. |
189 | </dd> |
263 | </dd> |
190 | <p></p> |
264 | <p></p> |
191 | <dt><strong><a name="item__24string">$string</a></strong><br /> |
265 | <dt><strong><a name="item__24string">$string</a></strong><br /> |
192 | </dt> |
266 | </dt> |
193 | <dd> |
267 | <dd> |
… | |
… | |
301 | </dt> |
375 | </dt> |
302 | <dd> |
376 | <dd> |
303 | 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 |
304 | click) and is either supposed to return false (normal operation), or |
378 | 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 |
379 | should extend the selection itelf and return true to suppress the built-in |
306 | 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. |
307 | </dd> |
383 | </dd> |
308 | <dd> |
384 | <dd> |
309 | <p>See the <em>selection</em> example extension.</p> |
385 | <p>See the <em>selection</em> example extension.</p> |
310 | </dd> |
386 | </dd> |
311 | <p></p> |
387 | <p></p> |
… | |
… | |
476 | </dt> |
552 | </dt> |
477 | <dd> |
553 | <dd> |
478 | 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> |
479 | object, whenever a callback/hook is executing. |
555 | object, whenever a callback/hook is executing. |
480 | </dd> |
556 | </dd> |
481 | <p></p> |
557 | <p></p></dl> |
482 | <dt></dt> |
|
|
483 | </dl> |
|
|
484 | <p> |
558 | <p> |
485 | </p> |
559 | </p> |
486 | <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> |
487 | <dl> |
561 | <dl> |
488 | <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 /> |
… | |
… | |
609 | <dl> |
683 | <dl> |
610 | <dt><strong><a name="item__24term__3d_new_urxvt_3a_3aterm__24envhashref_2c__">$term = new urxvt::term $envhashref, $rxvtname, [arg...]</a></strong><br /> |
684 | <dt><strong><a name="item__24term__3d_new_urxvt_3a_3aterm__24envhashref_2c__">$term = new urxvt::term $envhashref, $rxvtname, [arg...]</a></strong><br /> |
611 | </dt> |
685 | </dt> |
612 | <dd> |
686 | <dd> |
613 | Creates a new terminal, very similar as if you had started it with system |
687 | Creates a new terminal, very similar as if you had started it with system |
614 | <code>$rxvtname, arg...</code>. <code>$envhashref</code> must be a reference to a %ENV>-like |
688 | <code>$rxvtname, arg...</code>. <code>$envhashref</code> must be a reference to a <code>%ENV</code>-like |
615 | <code></code>hash which defines the environment of the new terminal. |
689 | hash which defines the environment of the new terminal. |
616 | </dd> |
|
|
617 | <dd> |
690 | </dd> |
|
|
691 | <dd> |
618 | <p>>Croaks (and probably outputs an error message) if the new instance |
692 | <p>Croaks (and probably outputs an error message) if the new instance |
619 | couldn't be created. Returns <code>undef</code> if the new instance didn't |
693 | couldn't be created. Returns <code>undef</code> if the new instance didn't |
620 | initialise perl, and the terminal object otherwise. The <code>init</code> and |
694 | initialise perl, and the terminal object otherwise. The <code>init</code> and |
621 | <a href="#item_start"><code>start</code></a> hooks will be called during this call.</p> |
695 | <a href="#item_start"><code>start</code></a> hooks will be called during this call.</p> |
622 | </dd> |
696 | </dd> |
623 | <p></p> |
697 | <p></p> |
… | |
… | |
690 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
764 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
691 | shade term_name title transparent transparent_all tripleclickwords |
765 | shade term_name title transparent transparent_all tripleclickwords |
692 | utmpInhibit visualBell</pre> |
766 | utmpInhibit visualBell</pre> |
693 | </dd> |
767 | </dd> |
694 | <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> |
695 | <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 /> |
696 | </dt> |
784 | </dt> |
697 | <dd> |
785 | <dd> |
698 | 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 |
699 | <code>keysym</code> resource in the <code>rxvt(1)</code> manpage. |
787 | <code>keysym</code> resource in the <code>rxvt(1)</code> manpage. |
… | |
… | |
722 | <dd> |
810 | <dd> |
723 | 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, |
724 | and optionally set them to new values. |
812 | and optionally set them to new values. |
725 | </dd> |
813 | </dd> |
726 | <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> |
727 | <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 /> |
728 | </dt> |
825 | </dt> |
729 | <dd> |
826 | <dd> |
730 | 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 |
731 | 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. |
732 | </dd> |
830 | </dd> |
733 | <p></p> |
831 | <p></p> |
734 | <dt><strong>$oldtext = $term->selection ([$newtext])</strong><br /> |
832 | <dt><strong>$oldtext = $term->selection ([$newtext])</strong><br /> |
735 | </dt> |
833 | </dt> |
736 | <dd> |
834 | <dd> |
… | |
… | |
815 | <p></p> |
913 | <p></p> |
816 | <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 /> |
817 | </dt> |
915 | </dt> |
818 | <dd> |
916 | <dd> |
819 | 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 |
820 | (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 |
821 | to the selection. |
919 | refresh hooks to provide effects similar to the selection. |
822 | </dd> |
920 | </dd> |
823 | <p></p> |
921 | <p></p> |
824 | <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 /> |
825 | </dt> |
923 | </dt> |
826 | <dd> |
924 | <dd> |
827 | 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 |
828 | 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 |
829 | 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 |
830 | it instead. |
928 | it instead. Both styles <em>MUST NOT</em> contain font styles. |
831 | </dd> |
929 | </dd> |
832 | <p></p> |
930 | <p></p> |
833 | <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 /> |
834 | </dt> |
932 | </dt> |
835 | <dd> |
933 | <dd> |
… | |
… | |
1063 | <p></p> |
1161 | <p></p> |
1064 | <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 /> |
1065 | </dt> |
1163 | </dt> |
1066 | <dd> |
1164 | <dd> |
1067 | 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 |
1068 | line. |
1166 | line. Works for rows outside the line, too, and returns corresponding |
|
|
1167 | offsets outside the string. |
1069 | </dd> |
1168 | </dd> |
1070 | <p></p> |
1169 | <p></p> |
1071 | <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 /> |
1072 | </dt> |
1171 | </dt> |
1073 | <dd> |
1172 | <dd> |
… | |
… | |
1301 | <dl> |
1400 | <dl> |
1302 | <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 /> |
1303 | </dt> |
1402 | </dt> |
1304 | <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 /> |
1305 | </dt> |
1404 | </dt> |
1306 | <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 /> |
1307 | </dt> |
1408 | </dt> |
1308 | </dl> |
1409 | </dl> |
1309 | <p> |
1410 | <p> |
1310 | </p> |
1411 | </p> |
1311 | <hr /> |
1412 | <hr /> |