… | |
… | |
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> |
… | |
… | |
117 | <dd> |
147 | <dd> |
118 | 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 |
119 | text into various other formats/action (such as uri unescaping, perl |
149 | text into various other formats/action (such as uri unescaping, perl |
120 | evalution, web-browser starting etc.), depending on content. |
150 | evalution, web-browser starting etc.), depending on content. |
121 | </dd> |
151 | </dd> |
|
|
152 | <dd> |
|
|
153 | <p>Other extensions can extend this popup menu by pushing a code reference |
|
|
154 | onto <code>@{ $term-</code>{selection_popup_hook} }>, that is called whenever the |
|
|
155 | popup is displayed.</p> |
|
|
156 | </dd> |
|
|
157 | <dd> |
|
|
158 | <p>It's sole argument is the popup menu, which can be modified. The selection |
|
|
159 | is in <code>$_</code>, which can be used to decide wether to add something or not. |
|
|
160 | It should either return nothing or a string and a code reference. The |
|
|
161 | string will be used as button text and the code reference will be called |
|
|
162 | when the button gets activated and should transform <code>$_</code>.</p> |
|
|
163 | </dd> |
|
|
164 | <dd> |
|
|
165 | <p>The following will add an entry <code>a to b</code> that transforms all <code>a</code>s in |
|
|
166 | the selection to <code>b</code>s, but only if the selection currently contains any |
|
|
167 | <code>a</code>s:</p> |
|
|
168 | </dd> |
|
|
169 | <dd> |
|
|
170 | <pre> |
|
|
171 | push @{ $self->{term}{selection_popup_hook} }, sub { |
|
|
172 | /a/ ? ("a to be" => sub { s/a/b/g } |
|
|
173 | : () |
|
|
174 | };</pre> |
|
|
175 | </dd> |
122 | <p></p> |
176 | <p></p> |
123 | <dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback<hotkey> (enabled by default)</a></strong><br /> |
177 | <dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback<hotkey> (enabled by default)</a></strong><br /> |
124 | </dt> |
178 | </dt> |
125 | <dd> |
179 | <dd> |
126 | Adds regex search functionality to the scrollback buffer, triggered |
180 | Adds regex search functionality to the scrollback buffer, triggered |
127 | by a hotkey (default: <code>M-s</code>). When in search mode, normal terminal |
181 | by a hotkey (default: <code>M-s</code>). While in search mode, normal terminal |
128 | input/output is suspended. |
182 | input/output is suspended and a regex is displayed at the bottom of the |
129 | </dd> |
183 | screen. |
130 | <dd> |
184 | </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> |
185 | <dd> |
136 | <p></p> |
186 | <p>Inputting characters appends them to the regex and continues incremental |
137 | <dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> |
187 | search. <code>BackSpace</code> removes a character from the regex, <code>Up</code> and <code>Down</code> |
138 | </dt> |
188 | search upwards/downwards in the scrollback buffer, <code>End</code> jumps to the |
|
|
189 | bottom. <code>Escape</code> leaves search mode and returns to the point where search |
|
|
190 | was started, while <code>Enter</code> or <code>Return</code> stay at the current position and |
|
|
191 | additionally stores the first match in the current line into the primary |
|
|
192 | selection.</p> |
139 | <dd> |
193 | </dd> |
140 | Displays a digital clock using the built-in overlay. |
194 | <p></p> |
|
|
195 | <dt><strong><a name="item_selection_2dautotransform">selection-autotransform</a></strong><br /> |
|
|
196 | </dt> |
|
|
197 | <dd> |
|
|
198 | This selection allows you to do automatic transforms on a selection |
|
|
199 | whenever a selection is made. |
|
|
200 | </dd> |
|
|
201 | <dd> |
|
|
202 | <p>It works by specifying perl snippets (most useful is a single <code>s///</code> |
|
|
203 | operator) that modify <code>$_</code> as resources:</p> |
|
|
204 | </dd> |
|
|
205 | <dd> |
|
|
206 | <pre> |
|
|
207 | URxvt.selection-autotransform.0: transform |
|
|
208 | URxvt.selection-autotransform.1: transform |
|
|
209 | ...</pre> |
|
|
210 | </dd> |
|
|
211 | <dd> |
|
|
212 | <p>For example, the following will transform selections of the form |
|
|
213 | <code>filename:number</code>, often seen in compiler messages, into <code>vi +$filename |
|
|
214 | $word</code>:</p> |
|
|
215 | </dd> |
|
|
216 | <dd> |
|
|
217 | <pre> |
|
|
218 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/</pre> |
|
|
219 | </dd> |
|
|
220 | <dd> |
|
|
221 | <p>And this example matches the same,but replaces it with vi-commands you can |
|
|
222 | paste directly into your (vi :) editor:</p> |
|
|
223 | </dd> |
|
|
224 | <dd> |
|
|
225 | <pre> |
|
|
226 | URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/</pre> |
|
|
227 | </dd> |
|
|
228 | <dd> |
|
|
229 | <p>Of course, this can be modified to suit your needs and your editor :)</p> |
|
|
230 | </dd> |
|
|
231 | <dd> |
|
|
232 | <p>To expand the example above to typical perl error messages (``XXX at |
|
|
233 | FILENAME line YYY.''), you need a slightly more elaborate solution:</p> |
|
|
234 | </dd> |
|
|
235 | <dd> |
|
|
236 | <pre> |
|
|
237 | URxvt.selection.pattern-0: ( at .*? line \\d+[,.]) |
|
|
238 | URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/</pre> |
|
|
239 | </dd> |
|
|
240 | <dd> |
|
|
241 | <p>The first line tells the selection code to treat the unchanging part of |
|
|
242 | every error message as a selection pattern, and the second line transforms |
|
|
243 | the message into vi commands to load the file.</p> |
141 | </dd> |
244 | </dd> |
142 | <p></p> |
245 | <p></p> |
143 | <dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> |
246 | <dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> |
144 | </dt> |
247 | </dt> |
145 | <dd> |
248 | <dd> |
146 | Uses per-line display filtering (<code>on_line_update</code>) to underline urls. |
249 | Uses per-line display filtering (<code>on_line_update</code>) to underline urls and |
|
|
250 | make them clickable. When middle-clicked, the program specified in the |
|
|
251 | resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with |
|
|
252 | the URL as first argument. |
|
|
253 | </dd> |
|
|
254 | <p></p> |
|
|
255 | <dt><strong><a name="item_automove_2dbackground">automove-background</a></strong><br /> |
|
|
256 | </dt> |
|
|
257 | <dd> |
|
|
258 | This is basically a one-line extension that dynamically changes the background pixmap offset |
|
|
259 | to the window position, in effect creating the same effect as pseudo transparency with |
|
|
260 | a custom pixmap. No scaling is supported in this mode. Exmaple: |
|
|
261 | </dd> |
|
|
262 | <dd> |
|
|
263 | <pre> |
|
|
264 | rxvt -pixmap background.xpm -pe automove-background</pre> |
147 | </dd> |
265 | </dd> |
148 | <p></p> |
266 | <p></p> |
149 | <dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br /> |
267 | <dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br /> |
150 | </dt> |
268 | </dt> |
151 | <dd> |
269 | <dd> |
152 | A not very useful example of filtering all text output to the terminal, |
270 | 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 |
271 | by replacing all line-drawing characters (U+2500 .. U+259F) by a |
154 | similar-looking ascii character. |
272 | similar-looking ascii character. |
155 | </dd> |
273 | </dd> |
156 | <p></p> |
274 | <p></p> |
|
|
275 | <dt><strong><a name="item_digital_2dclock">digital-clock</a></strong><br /> |
|
|
276 | </dt> |
|
|
277 | <dd> |
|
|
278 | Displays a digital clock using the built-in overlay. |
|
|
279 | </dd> |
|
|
280 | <p></p> |
157 | <dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> |
281 | <dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> |
158 | </dt> |
282 | </dt> |
159 | <dd> |
283 | <dd> |
160 | Displays a very simple digital clock in the upper right corner of the |
284 | Displays a very simple digital clock in the upper right corner of the |
161 | window. Illustrates overwriting the refresh callbacks to create your own |
285 | window. Illustrates overwriting the refresh callbacks to create your own |
162 | overlays or changes. |
286 | overlays or changes. |
|
|
287 | </dd> |
|
|
288 | <p></p> |
|
|
289 | <dt><strong><a name="item_selection_2dpastebin">selection-pastebin</a></strong><br /> |
|
|
290 | </dt> |
|
|
291 | <dd> |
|
|
292 | This is a little rarely useful extension that Uploads the selection as |
|
|
293 | textfile to a remote site (or does other things). (The implementation is |
|
|
294 | not currently secure for use in a multiuser environment as it writes to |
|
|
295 | <em>/tmp</em> directly.). |
|
|
296 | </dd> |
|
|
297 | <dd> |
|
|
298 | <p>It listens to the <code>selection-pastebin:remote-pastebin</code> keyboard command, |
|
|
299 | i.e.</p> |
|
|
300 | </dd> |
|
|
301 | <dd> |
|
|
302 | <pre> |
|
|
303 | URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin</pre> |
|
|
304 | </dd> |
|
|
305 | <dd> |
|
|
306 | <p>Pressing this combination runs a command with <code>%</code> replaced by the name of |
|
|
307 | the textfile. This command can be set via a resource:</p> |
|
|
308 | </dd> |
|
|
309 | <dd> |
|
|
310 | <pre> |
|
|
311 | URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.</pre> |
|
|
312 | </dd> |
|
|
313 | <dd> |
|
|
314 | <p>And the default is likely not useful to anybody but the few people around |
|
|
315 | here :)</p> |
|
|
316 | </dd> |
|
|
317 | <dd> |
|
|
318 | <p>The name of the textfile is the hex encoded md5 sum of the selection, so |
|
|
319 | the same content should lead to the same filename.</p> |
|
|
320 | </dd> |
|
|
321 | <dd> |
|
|
322 | <p>After a successful upload the selection will be replaced by the text given |
|
|
323 | in the <code>selection-pastebin-url</code> resource (again, the % is the placeholder |
|
|
324 | for the filename):</p> |
|
|
325 | </dd> |
|
|
326 | <dd> |
|
|
327 | <pre> |
|
|
328 | URxvt.selection-pastebin.url: <a href="http://www.ta-sa.org/files/txt/%">http://www.ta-sa.org/files/txt/%</a></pre> |
163 | </dd> |
329 | </dd> |
164 | <p></p></dl> |
330 | <p></p></dl> |
165 | <p> |
331 | <p> |
166 | </p> |
332 | </p> |
167 | <hr /> |
333 | <hr /> |
… | |
… | |
183 | <dl> |
349 | <dl> |
184 | <dt><strong><a name="item__24text">$text</a></strong><br /> |
350 | <dt><strong><a name="item__24text">$text</a></strong><br /> |
185 | </dt> |
351 | </dt> |
186 | <dd> |
352 | <dd> |
187 | Rxvt-unicodes special way of encoding text, where one ``unicode'' character |
353 | 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. |
354 | always represents one screen cell. See <a href="#item_row_t">ROW_t</a> for a discussion of this format. |
189 | </dd> |
355 | </dd> |
190 | <p></p> |
356 | <p></p> |
191 | <dt><strong><a name="item__24string">$string</a></strong><br /> |
357 | <dt><strong><a name="item__24string">$string</a></strong><br /> |
192 | </dt> |
358 | </dt> |
193 | <dd> |
359 | <dd> |
… | |
… | |
272 | <dd> |
438 | <dd> |
273 | Called at the very end of initialisation of a new terminal, just before |
439 | Called at the very end of initialisation of a new terminal, just before |
274 | returning to the mainloop. |
440 | returning to the mainloop. |
275 | </dd> |
441 | </dd> |
276 | <p></p> |
442 | <p></p> |
|
|
443 | <dt><strong><a name="item_on_child_start__24term_2c__24pid">on_child_start $term, $pid</a></strong><br /> |
|
|
444 | </dt> |
|
|
445 | <dd> |
|
|
446 | Called just after the child process has been <code>fork</code>ed. |
|
|
447 | </dd> |
|
|
448 | <p></p> |
|
|
449 | <dt><strong><a name="item_on_child_exit__24term_2c__24status">on_child_exit $term, $status</a></strong><br /> |
|
|
450 | </dt> |
|
|
451 | <dd> |
|
|
452 | Called just after the child process has exited. <code>$status</code> is the status |
|
|
453 | from <code>waitpid</code>. |
|
|
454 | </dd> |
|
|
455 | <p></p> |
277 | <dt><strong><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a></strong><br /> |
456 | <dt><strong><a name="item_on_sel_make__24term_2c__24eventtime">on_sel_make $term, $eventtime</a></strong><br /> |
278 | </dt> |
457 | </dt> |
279 | <dd> |
458 | <dd> |
280 | Called whenever a selection has been made by the user, but before the |
459 | Called whenever a selection has been made by the user, but before the |
281 | selection text is copied, so changes to the beginning, end or type of the |
460 | selection text is copied, so changes to the beginning, end or type of the |
… | |
… | |
301 | </dt> |
480 | </dt> |
302 | <dd> |
481 | <dd> |
303 | Called whenever the user tries to extend the selection (e.g. with a double |
482 | 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 |
483 | 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 |
484 | should extend the selection itelf and return true to suppress the built-in |
306 | processing. |
485 | processing. This can happen multiple times, as long as the callback |
|
|
486 | returns true, it will be called on every further click by the user and is |
|
|
487 | supposed to enlarge the selection more and more, if possible. |
307 | </dd> |
488 | </dd> |
308 | <dd> |
489 | <dd> |
309 | <p>See the <em>selection</em> example extension.</p> |
490 | <p>See the <em>selection</em> example extension.</p> |
310 | </dd> |
491 | </dd> |
311 | <p></p> |
492 | <p></p> |
… | |
… | |
402 | Called whenever the user presses a key combination that has a |
583 | 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> |
584 | <code>perl:string</code> action bound to it (see description of the <strong>keysym</strong> |
404 | resource in the <code>rxvt(1)</code> manpage). |
585 | resource in the <code>rxvt(1)</code> manpage). |
405 | </dd> |
586 | </dd> |
406 | <p></p> |
587 | <p></p> |
|
|
588 | <dt><strong><a name="item_on_x_event__24term_2c__24event">on_x_event $term, $event</a></strong><br /> |
|
|
589 | </dt> |
|
|
590 | <dd> |
|
|
591 | Called on every X event received on the vt window (and possibly other |
|
|
592 | windows). Should only be used as a last resort. Most event structure |
|
|
593 | members are not passed. |
|
|
594 | </dd> |
|
|
595 | <p></p> |
407 | <dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> |
596 | <dt><strong><a name="item_on_focus_in__24term">on_focus_in $term</a></strong><br /> |
408 | </dt> |
597 | </dt> |
409 | <dd> |
598 | <dd> |
410 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
599 | Called whenever the window gets the keyboard focus, before rxvt-unicode |
411 | does focus in processing. |
600 | does focus in processing. |
… | |
… | |
416 | <dd> |
605 | <dd> |
417 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
606 | Called wheneever the window loses keyboard focus, before rxvt-unicode does |
418 | focus out processing. |
607 | focus out processing. |
419 | </dd> |
608 | </dd> |
420 | <p></p> |
609 | <p></p> |
|
|
610 | <dt><strong><a name="item_on_configure_notify__24term_2c__24event">on_configure_notify $term, $event</a></strong><br /> |
|
|
611 | </dt> |
421 | <dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a></strong><br /> |
612 | <dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a></strong><br /> |
422 | </dt> |
613 | </dt> |
423 | <dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br /> |
614 | <dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br /> |
424 | </dt> |
615 | </dt> |
425 | <dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br /> |
616 | <dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br /> |
… | |
… | |
451 | <p></p></dl> |
642 | <p></p></dl> |
452 | <p> |
643 | <p> |
453 | </p> |
644 | </p> |
454 | <h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> |
645 | <h2><a name="variables_in_the_urxvt_package">Variables in the <code>urxvt</code> Package</a></h2> |
455 | <dl> |
646 | <dl> |
|
|
647 | <dt><strong><a name="item__24urxvt_3a_3alibdir">$urxvt::LIBDIR</a></strong><br /> |
|
|
648 | </dt> |
|
|
649 | <dd> |
|
|
650 | The rxvt-unicode library directory, where, among other things, the perl |
|
|
651 | modules and scripts are stored. |
|
|
652 | </dd> |
|
|
653 | <p></p> |
|
|
654 | <dt><strong><a name="item__24urxvt_3a_3aresclass_2c__24urxvt_3a_3aresclass">$urxvt::RESCLASS, $urxvt::RESCLASS</a></strong><br /> |
|
|
655 | </dt> |
|
|
656 | <dd> |
|
|
657 | The resource class and name rxvt-unicode uses to look up X resources. |
|
|
658 | </dd> |
|
|
659 | <p></p> |
|
|
660 | <dt><strong><a name="item__24urxvt_3a_3arxvtname">$urxvt::RXVTNAME</a></strong><br /> |
|
|
661 | </dt> |
|
|
662 | <dd> |
|
|
663 | The basename of the installed binaries, usually <code>urxvt</code>. |
|
|
664 | </dd> |
|
|
665 | <p></p> |
456 | <dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br /> |
666 | <dt><strong><a name="item__24urxvt_3a_3aterm">$urxvt::TERM</a></strong><br /> |
457 | </dt> |
667 | </dt> |
458 | <dd> |
668 | <dd> |
459 | The current terminal. This variable stores the current <code>urxvt::term</code> |
669 | The current terminal. This variable stores the current <code>urxvt::term</code> |
460 | object, whenever a callback/hook is executing. |
670 | object, whenever a callback/hook is executing. |
… | |
… | |
462 | <p></p></dl> |
672 | <p></p></dl> |
463 | <p> |
673 | <p> |
464 | </p> |
674 | </p> |
465 | <h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> |
675 | <h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> |
466 | <dl> |
676 | <dl> |
467 | <dt><strong><a name="item__24term__3d_new_urxvt__5barg_2e_2e_2e_5d">$term = new urxvt [arg...]</a></strong><br /> |
|
|
468 | </dt> |
|
|
469 | <dd> |
|
|
470 | Creates a new terminal, very similar as if you had started it with |
|
|
471 | <code>system $binfile, arg...</code>. Croaks (and probably outputs an error message) |
|
|
472 | if the new instance couldn't be created. Returns <code>undef</code> if the new |
|
|
473 | instance didn't initialise perl, and the terminal object otherwise. The |
|
|
474 | <code>init</code> and <a href="#item_start"><code>start</code></a> hooks will be called during the call. |
|
|
475 | </dd> |
|
|
476 | <p></p> |
|
|
477 | <dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br /> |
677 | <dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br /> |
478 | </dt> |
678 | </dt> |
479 | <dd> |
679 | <dd> |
480 | Fatally aborts execution with the given error message. Avoid at all |
680 | Fatally aborts execution with the given error message. Avoid at all |
481 | costs! The only time this is acceptable is when the terminal process |
681 | costs! The only time this is acceptable is when the terminal process |
… | |
… | |
491 | </dd> |
691 | </dd> |
492 | <dd> |
692 | <dd> |
493 | <p>Using this function has the advantage that its output ends up in the |
693 | <p>Using this function has the advantage that its output ends up in the |
494 | correct place, e.g. on stderr of the connecting urxvtc client.</p> |
694 | correct place, e.g. on stderr of the connecting urxvtc client.</p> |
495 | </dd> |
695 | </dd> |
496 | <p></p> |
|
|
497 | <dt><strong><a name="item__24is_safe__3d_urxvt_3a_3asafe">$is_safe = urxvt::safe</a></strong><br /> |
|
|
498 | </dt> |
|
|
499 | <dd> |
696 | <dd> |
500 | Returns true when it is safe to do potentially unsafe things, such as |
697 | <p>Messages have a size limit of 1023 bytes currently.</p> |
501 | evaluating perl code specified by the user. This is true when urxvt was |
|
|
502 | started setuid or setgid. |
|
|
503 | </dd> |
698 | </dd> |
504 | <p></p> |
699 | <p></p> |
505 | <dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> |
700 | <dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> |
506 | </dt> |
701 | </dt> |
507 | <dd> |
702 | <dd> |
… | |
… | |
511 | <dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br /> |
706 | <dt><strong><a name="item_urxvt_3a_3acurrenttime">urxvt::CurrentTime</a></strong><br /> |
512 | </dt> |
707 | </dt> |
513 | <dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
708 | <dt><strong><a name="item_urxvt_3a_3ashiftmask_2c_lockmask_2c_controlmask_2c">urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, |
514 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
709 | Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, |
515 | Button4Mask, Button5Mask, AnyModifier</a></strong><br /> |
710 | Button4Mask, Button5Mask, AnyModifier</a></strong><br /> |
|
|
711 | </dt> |
|
|
712 | <dt><strong><a name="item_urxvt_3a_3anoeventmask_2c_keypressmask_2c_keyrelea">urxvt::NoEventMask, KeyPressMask, KeyReleaseMask, |
|
|
713 | ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, |
|
|
714 | PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask, |
|
|
715 | Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask, |
|
|
716 | KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask, |
|
|
717 | ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask, |
|
|
718 | FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask</a></strong><br /> |
|
|
719 | </dt> |
|
|
720 | <dt><strong><a name="item_urxvt_3a_3akeypress_2c_keyrelease_2c_buttonpress_2">urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify, |
|
|
721 | EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose, |
|
|
722 | GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify, |
|
|
723 | UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify, |
|
|
724 | ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify, |
|
|
725 | CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, |
|
|
726 | SelectionNotify, ColormapNotify, ClientMessage, MappingNotify</a></strong><br /> |
516 | </dt> |
727 | </dt> |
517 | <dd> |
728 | <dd> |
518 | Various constants for use in X calls and event processing. |
729 | Various constants for use in X calls and event processing. |
519 | </dd> |
730 | </dd> |
520 | <p></p></dl> |
731 | <p></p></dl> |
… | |
… | |
555 | </dt> |
766 | </dt> |
556 | <dd> |
767 | <dd> |
557 | Return the foreground/background colour index, respectively. |
768 | Return the foreground/background colour index, respectively. |
558 | </dd> |
769 | </dd> |
559 | <p></p> |
770 | <p></p> |
560 | <dt><strong><a name="item_set_fgcolor">$rend = urxvt::SET_FGCOLOR ($rend, $new_colour)</a></strong><br /> |
771 | <dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_fgcolor__24rend_2c__24n">$rend = urxvt::SET_FGCOLOR $rend, $new_colour</a></strong><br /> |
561 | </dt> |
772 | </dt> |
562 | <dt><strong><a name="item_set_bgcolor">$rend = urxvt::SET_BGCOLOR ($rend, $new_colour)</a></strong><br /> |
773 | <dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_bgcolor__24rend_2c__24n">$rend = urxvt::SET_BGCOLOR $rend, $new_colour</a></strong><br /> |
563 | </dt> |
774 | </dt> |
564 | <dd> |
775 | <dd> |
565 | Replace the foreground/background colour in the rendition mask with the |
776 | Replace the foreground/background colour in the rendition mask with the |
566 | specified one. |
777 | specified one. |
567 | </dd> |
778 | </dd> |
568 | <p></p> |
779 | <p></p> |
569 | <dt><strong><a name="item_get_custom">$value = urxvt::GET_CUSTOM ($rend)</a></strong><br /> |
780 | <dt><strong><a name="item__24value__3d_urxvt_3a_3aget_custom__24rend">$value = urxvt::GET_CUSTOM $rend</a></strong><br /> |
570 | </dt> |
781 | </dt> |
571 | <dd> |
782 | <dd> |
572 | Return the ``custom'' value: Every rendition has 5 bits for use by |
783 | Return the ``custom'' value: Every rendition has 5 bits for use by |
573 | extensions. They can be set and changed as you like and are initially |
784 | extensions. They can be set and changed as you like and are initially |
574 | zero. |
785 | zero. |
575 | </dd> |
786 | </dd> |
576 | <p></p> |
787 | <p></p> |
577 | <dt><strong><a name="item_set_custom">$rend = urxvt::SET_CUSTOM ($rend, $new_value)</a></strong><br /> |
788 | <dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_custom__24rend_2c__24ne">$rend = urxvt::SET_CUSTOM $rend, $new_value</a></strong><br /> |
578 | </dt> |
789 | </dt> |
579 | <dd> |
790 | <dd> |
580 | Change the custom value. |
791 | Change the custom value. |
581 | </dd> |
792 | </dd> |
582 | <p></p></dl> |
793 | <p></p></dl> |
583 | <p> |
794 | <p> |
584 | </p> |
795 | </p> |
585 | <h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2> |
796 | <h2><a name="the_urxvt__anyevent_class">The <code>urxvt::anyevent</code> Class</a></h2> |
586 | <p>The sole purpose of this class is to deliver an interface to the |
797 | <p>The sole purpose of this class is to deliver an interface to the |
587 | <code>AnyEvent</code> module - any module using it will work inside urxvt without |
798 | <code>AnyEvent</code> module - any module using it will work inside urxvt without |
588 | further work. The only exception is that you cannot wait on condition |
799 | further programming. The only exception is that you cannot wait on |
589 | variables, but non-blocking condvar use is ok. What this means is that you |
800 | condition variables, but non-blocking condvar use is ok. What this means |
590 | cannot use blocking APIs, but the non-blocking variant should work.</p> |
801 | is that you cannot use blocking APIs, but the non-blocking variant should |
|
|
802 | work.</p> |
591 | <p> |
803 | <p> |
592 | </p> |
804 | </p> |
593 | <h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> |
805 | <h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> |
594 | <dl> |
806 | <dl> |
|
|
807 | <dt><strong><a name="item__24term__3d_new_urxvt_3a_3aterm__24envhashref_2c__">$term = new urxvt::term $envhashref, $rxvtname, [arg...]</a></strong><br /> |
|
|
808 | </dt> |
|
|
809 | <dd> |
|
|
810 | Creates a new terminal, very similar as if you had started it with system |
|
|
811 | <code>$rxvtname, arg...</code>. <code>$envhashref</code> must be a reference to a <code>%ENV</code>-like |
|
|
812 | hash which defines the environment of the new terminal. |
|
|
813 | </dd> |
|
|
814 | <dd> |
|
|
815 | <p>Croaks (and probably outputs an error message) if the new instance |
|
|
816 | couldn't be created. Returns <code>undef</code> if the new instance didn't |
|
|
817 | initialise perl, and the terminal object otherwise. The <code>init</code> and |
|
|
818 | <a href="#item_start"><code>start</code></a> hooks will be called during this call.</p> |
|
|
819 | </dd> |
|
|
820 | <p></p> |
595 | <dt><strong><a name="item_destroy">$term->destroy</a></strong><br /> |
821 | <dt><strong><a name="item_destroy">$term->destroy</a></strong><br /> |
596 | </dt> |
822 | </dt> |
597 | <dd> |
823 | <dd> |
598 | Destroy the terminal object (close the window, free resources etc.). |
824 | Destroy the terminal object (close the window, free resources |
|
|
825 | etc.). Please note that rxvt will not exit as long as any event |
|
|
826 | watchers (timers, io watchers) are still active. |
|
|
827 | </dd> |
|
|
828 | <p></p> |
|
|
829 | <dt><strong><a name="item_exec_async">$term->exec_async ($cmd[, @args])</a></strong><br /> |
|
|
830 | </dt> |
|
|
831 | <dd> |
|
|
832 | Works like the combination of the <code>fork</code>/<code>exec</code> builtins, which executes |
|
|
833 | (``starts'') programs in the background. This function takes care of setting |
|
|
834 | the user environment before exec'ing the command (e.g. <code>PATH</code>) and should |
|
|
835 | be preferred over explicit calls to <code>exec</code> or <code>system</code>. |
|
|
836 | </dd> |
|
|
837 | <dd> |
|
|
838 | <p>Returns the pid of the subprocess or <code>undef</code> on error.</p> |
599 | </dd> |
839 | </dd> |
600 | <p></p> |
840 | <p></p> |
601 | <dt><strong><a name="item_option">$isset = $term->option ($optval[, $set])</a></strong><br /> |
841 | <dt><strong><a name="item_option">$isset = $term->option ($optval[, $set])</a></strong><br /> |
602 | </dt> |
842 | </dt> |
603 | <dd> |
843 | <dd> |
… | |
… | |
611 | </dd> |
851 | </dd> |
612 | <dd> |
852 | <dd> |
613 | <pre> |
853 | <pre> |
614 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
854 | borderLess console cursorBlink cursorUnderline hold iconic insecure |
615 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
855 | intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage |
616 | pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating |
856 | override-redirect pastableTabs pointerBlank reverseVideo scrollBar |
617 | scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer |
857 | scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput |
618 | secondaryScreen secondaryScroll skipBuiltinGlyphs transparent |
858 | scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs |
619 | tripleclickwords utmpInhibit visualBell</pre> |
859 | transparent tripleclickwords utmpInhibit visualBell</pre> |
620 | </dd> |
860 | </dd> |
621 | <p></p> |
861 | <p></p> |
622 | <dt><strong><a name="item_resource">$value = $term->resource ($name[, $newval])</a></strong><br /> |
862 | <dt><strong><a name="item_resource">$value = $term->resource ($name[, $newval])</a></strong><br /> |
623 | </dt> |
863 | </dt> |
624 | <dd> |
864 | <dd> |
… | |
… | |
649 | <pre> |
889 | <pre> |
650 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
890 | answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont |
651 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
891 | borderLess color cursorBlink cursorUnderline cutchars delete_key |
652 | display_name embed ext_bwidth fade font geometry hold iconName |
892 | display_name embed ext_bwidth fade font geometry hold iconName |
653 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
893 | imFont imLocale inputMethod insecure int_bwidth intensityStyles |
654 | italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier |
894 | italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier |
655 | mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 |
895 | mouseWheelScrollPage name override_redirect pastableTabs path perl_eval |
656 | perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd |
896 | perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay |
657 | reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating |
897 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
658 | scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput |
898 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
659 | scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle |
899 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
660 | shade term_name title transparent transparent_all tripleclickwords |
900 | secondaryScreen secondaryScroll selectstyle shade term_name title |
|
|
901 | transient_for transparent transparent_all tripleclickwords utmpInhibit |
661 | utmpInhibit visualBell</pre> |
902 | visualBell</pre> |
|
|
903 | </dd> |
|
|
904 | <p></p> |
|
|
905 | <dt><strong><a name="item_x_resource">$value = $term->x_resource ($pattern)</a></strong><br /> |
|
|
906 | </dt> |
|
|
907 | <dd> |
|
|
908 | Returns the X-Resource for the given pattern, excluding the program or |
|
|
909 | class name, i.e. <a href="#item_x_resource"><code>$term->x_resource ("boldFont")</code></a> should return the |
|
|
910 | same value as used by this instance of rxvt-unicode. Returns <code>undef</code> if no |
|
|
911 | resource with that pattern exists. |
|
|
912 | </dd> |
|
|
913 | <dd> |
|
|
914 | <p>This method should only be called during the <code>on_start</code> hook, as there is |
|
|
915 | only one resource database per display, and later invocations might return |
|
|
916 | the wrong resources.</p> |
662 | </dd> |
917 | </dd> |
663 | <p></p> |
918 | <p></p> |
664 | <dt><strong><a name="item_parse_keysym">$success = $term->parse_keysym ($keysym_spec, $command_string)</a></strong><br /> |
919 | <dt><strong><a name="item_parse_keysym">$success = $term->parse_keysym ($keysym_spec, $command_string)</a></strong><br /> |
665 | </dt> |
920 | </dt> |
666 | <dd> |
921 | <dd> |
… | |
… | |
691 | <dd> |
946 | <dd> |
692 | Return the current values of the selection mark, begin or end positions, |
947 | Return the current values of the selection mark, begin or end positions, |
693 | and optionally set them to new values. |
948 | and optionally set them to new values. |
694 | </dd> |
949 | </dd> |
695 | <p></p> |
950 | <p></p> |
|
|
951 | <dt><strong><a name="item_selection_make">$term->selection_make ($eventtime[, $rectangular])</a></strong><br /> |
|
|
952 | </dt> |
|
|
953 | <dd> |
|
|
954 | Tries to make a selection as set by <a href="#item_selection_beg"><code>selection_beg</code></a> and |
|
|
955 | <a href="#item_selection_end"><code>selection_end</code></a>. If <code>$rectangular</code> is true (default: false), a |
|
|
956 | rectangular selection will be made. This is the prefered function to make |
|
|
957 | a selection. |
|
|
958 | </dd> |
|
|
959 | <p></p> |
696 | <dt><strong><a name="item_selection_grab">$success = $term->selection_grab ($eventtime)</a></strong><br /> |
960 | <dt><strong><a name="item_selection_grab">$success = $term->selection_grab ($eventtime)</a></strong><br /> |
697 | </dt> |
961 | </dt> |
698 | <dd> |
962 | <dd> |
699 | Try to request the primary selection from the server (for example, as set |
963 | Try to request the primary selection text from the server (for example, as |
700 | by the next method). |
964 | set by the next method). No visual feedback will be given. This function |
|
|
965 | is mostly useful from within <code>on_sel_grab</code> hooks. |
701 | </dd> |
966 | </dd> |
702 | <p></p> |
967 | <p></p> |
703 | <dt><strong>$oldtext = $term->selection ([$newtext])</strong><br /> |
968 | <dt><strong>$oldtext = $term->selection ([$newtext])</strong><br /> |
704 | </dt> |
969 | </dt> |
705 | <dd> |
970 | <dd> |
… | |
… | |
784 | <p></p> |
1049 | <p></p> |
785 | <dt><strong><a name="item_scr_xor_span">$term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])</a></strong><br /> |
1050 | <dt><strong><a name="item_scr_xor_span">$term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])</a></strong><br /> |
786 | </dt> |
1051 | </dt> |
787 | <dd> |
1052 | <dd> |
788 | XORs the rendition values in the given span with the provided value |
1053 | XORs the rendition values in the given span with the provided value |
789 | (default: <code>RS_RVid</code>). Useful in refresh hooks to provide effects similar |
1054 | (default: <code>RS_RVid</code>), which <em>MUST NOT</em> contain font styles. Useful in |
790 | to the selection. |
1055 | refresh hooks to provide effects similar to the selection. |
791 | </dd> |
1056 | </dd> |
792 | <p></p> |
1057 | <p></p> |
793 | <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 /> |
1058 | <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 /> |
794 | </dt> |
1059 | </dt> |
795 | <dd> |
1060 | <dd> |
796 | Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing |
1061 | Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing |
797 | whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults |
1062 | whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults |
798 | to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines |
1063 | to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines |
799 | it instead. |
1064 | it instead. Both styles <em>MUST NOT</em> contain font styles. |
800 | </dd> |
1065 | </dd> |
801 | <p></p> |
1066 | <p></p> |
802 | <dt><strong><a name="item_scr_bell">$term->scr_bell</a></strong><br /> |
1067 | <dt><strong><a name="item_scr_bell">$term->scr_bell</a></strong><br /> |
803 | </dt> |
1068 | </dt> |
804 | <dd> |
1069 | <dd> |
… | |
… | |
854 | </dt> |
1119 | </dt> |
855 | <dd> |
1120 | <dd> |
856 | Return the window id of the terminal window. |
1121 | Return the window id of the terminal window. |
857 | </dd> |
1122 | </dd> |
858 | <p></p> |
1123 | <p></p> |
|
|
1124 | <dt><strong><a name="item_vt_emask_add">$term->vt_emask_add ($x_event_mask)</a></strong><br /> |
|
|
1125 | </dt> |
|
|
1126 | <dd> |
|
|
1127 | Adds the specified events to the vt event mask. Useful e.g. when you want |
|
|
1128 | to receive pointer events all the times: |
|
|
1129 | </dd> |
|
|
1130 | <dd> |
|
|
1131 | <pre> |
|
|
1132 | $term->vt_emask_add (urxvt::PointerMotionMask);</pre> |
|
|
1133 | </dd> |
|
|
1134 | <p></p> |
859 | <dt><strong><a name="item_width">$window_width = $term->width</a></strong><br /> |
1135 | <dt><strong><a name="item_width">$window_width = $term->width</a></strong><br /> |
860 | </dt> |
1136 | </dt> |
861 | <dt><strong><a name="item_height">$window_height = $term->height</a></strong><br /> |
1137 | <dt><strong><a name="item_height">$window_height = $term->height</a></strong><br /> |
862 | </dt> |
1138 | </dt> |
863 | <dt><strong><a name="item_fwidth">$font_width = $term->fwidth</a></strong><br /> |
1139 | <dt><strong><a name="item_fwidth">$font_width = $term->fwidth</a></strong><br /> |
… | |
… | |
876 | </dt> |
1152 | </dt> |
877 | <dt><strong><a name="item_savelines">$max_scrollback = $term->saveLines</a></strong><br /> |
1153 | <dt><strong><a name="item_savelines">$max_scrollback = $term->saveLines</a></strong><br /> |
878 | </dt> |
1154 | </dt> |
879 | <dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term->total_rows</a></strong><br /> |
1155 | <dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term->total_rows</a></strong><br /> |
880 | </dt> |
1156 | </dt> |
881 | <dt><strong><a name="item_nsaved">$lines_in_scrollback = $term->nsaved</a></strong><br /> |
1157 | <dt><strong><a name="item_top_row">$topmost_scrollback_row = $term->top_row</a></strong><br /> |
882 | </dt> |
1158 | </dt> |
883 | <dd> |
1159 | <dd> |
884 | Return various integers describing terminal characteristics. |
1160 | Return various integers describing terminal characteristics. |
885 | </dd> |
1161 | </dd> |
886 | <p></p> |
1162 | <p></p> |
|
|
1163 | <dt><strong><a name="item_display_id">$x_display = $term->display_id</a></strong><br /> |
|
|
1164 | </dt> |
|
|
1165 | <dd> |
|
|
1166 | Return the DISPLAY used by rxvt-unicode. |
|
|
1167 | </dd> |
|
|
1168 | <p></p> |
887 | <dt><strong><a name="item_locale">$lc_ctype = $term->locale</a></strong><br /> |
1169 | <dt><strong><a name="item_locale">$lc_ctype = $term->locale</a></strong><br /> |
888 | </dt> |
1170 | </dt> |
889 | <dd> |
1171 | <dd> |
890 | Returns the LC_CTYPE category string used by this rxvt-unicode. |
1172 | Returns the LC_CTYPE category string used by this rxvt-unicode. |
891 | </dd> |
1173 | </dd> |
892 | <p></p> |
1174 | <p></p> |
893 | <dt><strong><a name="item_display_id">$x_display = $term->display_id</a></strong><br /> |
1175 | <dt><strong><a name="item_env">$env = $term->env</a></strong><br /> |
894 | </dt> |
1176 | </dt> |
895 | <dd> |
1177 | <dd> |
896 | Return the DISPLAY used by rxvt-unicode. |
1178 | Returns a copy of the environment in effect for the terminal as a hashref |
|
|
1179 | similar to <code>\%ENV</code>. |
897 | </dd> |
1180 | </dd> |
898 | <p></p> |
1181 | <p></p> |
899 | <dt><strong><a name="item_modlevel3mask">$modifiermask = $term->ModLevel3Mask</a></strong><br /> |
1182 | <dt><strong><a name="item_modlevel3mask">$modifiermask = $term->ModLevel3Mask</a></strong><br /> |
900 | </dt> |
1183 | </dt> |
901 | <dt><strong><a name="item_modmetamask">$modifiermask = $term->ModMetaMask</a></strong><br /> |
1184 | <dt><strong><a name="item_modmetamask">$modifiermask = $term->ModMetaMask</a></strong><br /> |
… | |
… | |
908 | </dd> |
1191 | </dd> |
909 | <p></p> |
1192 | <p></p> |
910 | <dt><strong><a name="item_view_start">$view_start = $term->view_start ([$newvalue])</a></strong><br /> |
1193 | <dt><strong><a name="item_view_start">$view_start = $term->view_start ([$newvalue])</a></strong><br /> |
911 | </dt> |
1194 | </dt> |
912 | <dd> |
1195 | <dd> |
913 | Returns the negative row number of the topmost line. Minimum value is |
1196 | Returns the row number of the topmost displayed line. Maximum value is |
914 | <code>0</code>, which displays the normal terminal contents. Larger values scroll |
1197 | <code>0</code>, which displays the normal terminal contents. Lower values scroll |
915 | this many lines into the scrollback buffer. |
1198 | this many lines into the scrollback buffer. |
916 | </dd> |
1199 | </dd> |
917 | <p></p> |
1200 | <p></p> |
918 | <dt><strong><a name="item_want_refresh">$term->want_refresh</a></strong><br /> |
1201 | <dt><strong><a name="item_want_refresh">$term->want_refresh</a></strong><br /> |
919 | </dt> |
1202 | </dt> |
… | |
… | |
930 | </dt> |
1213 | </dt> |
931 | <dd> |
1214 | <dd> |
932 | Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code> |
1215 | Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code> |
933 | is the topmost terminal line, row <code>$term->$ncol-1</code> is the bottommost |
1216 | is the topmost terminal line, row <code>$term->$ncol-1</code> is the bottommost |
934 | terminal line. The scrollback buffer starts at line <code>-1</code> and extends to |
1217 | terminal line. The scrollback buffer starts at line <code>-1</code> and extends to |
935 | line <a href="#item_nsaved"><code>-$term->nsaved</code></a>. Nothing will be returned if a nonexistent line |
1218 | line <code>-$term->nsaved</code>. Nothing will be returned if a nonexistent line |
936 | is requested. |
1219 | is requested. |
937 | </dd> |
1220 | </dd> |
938 | <dd> |
1221 | <dd> |
939 | <p>If <code>$new_text</code> is specified, it will replace characters in the current |
1222 | <p>If <code>$new_text</code> is specified, it will replace characters in the current |
940 | line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful |
1223 | line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful |
… | |
… | |
1025 | <p></p> |
1308 | <p></p> |
1026 | <dt><strong><a name="item_offset_of">$offset = $line->offset_of ($row, $col)</a></strong><br /> |
1309 | <dt><strong><a name="item_offset_of">$offset = $line->offset_of ($row, $col)</a></strong><br /> |
1027 | </dt> |
1310 | </dt> |
1028 | <dd> |
1311 | <dd> |
1029 | Returns the character offset of the given row|col pair within the logical |
1312 | Returns the character offset of the given row|col pair within the logical |
1030 | line. |
1313 | line. Works for rows outside the line, too, and returns corresponding |
|
|
1314 | offsets outside the string. |
1031 | </dd> |
1315 | </dd> |
1032 | <p></p> |
1316 | <p></p> |
1033 | <dt><strong><a name="item_coord_of">($row, $col) = $line->coord_of ($offset)</a></strong><br /> |
1317 | <dt><strong><a name="item_coord_of">($row, $col) = $line->coord_of ($offset)</a></strong><br /> |
1034 | </dt> |
1318 | </dt> |
1035 | <dd> |
1319 | <dd> |
… | |
… | |
1092 | </dd> |
1376 | </dd> |
1093 | <p></p></dl> |
1377 | <p></p></dl> |
1094 | <p> |
1378 | <p> |
1095 | </p> |
1379 | </p> |
1096 | <h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> |
1380 | <h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> |
|
|
1381 | <dl> |
|
|
1382 | <dt><strong><a name="item_add_title">$popup->add_title ($title)</a></strong><br /> |
|
|
1383 | </dt> |
|
|
1384 | <dd> |
|
|
1385 | Adds a non-clickable title to the popup. |
|
|
1386 | </dd> |
|
|
1387 | <p></p> |
|
|
1388 | <dt><strong><a name="item_add_separator">$popup->add_separator ([$sepchr])</a></strong><br /> |
|
|
1389 | </dt> |
|
|
1390 | <dd> |
|
|
1391 | Creates a separator, optionally using the character given as <code>$sepchr</code>. |
|
|
1392 | </dd> |
|
|
1393 | <p></p> |
|
|
1394 | <dt><strong><a name="item_add_button">$popup->add_button ($text, $cb)</a></strong><br /> |
|
|
1395 | </dt> |
|
|
1396 | <dd> |
|
|
1397 | Adds a clickable button to the popup. <code>$cb</code> is called whenever it is |
|
|
1398 | selected. |
|
|
1399 | </dd> |
|
|
1400 | <p></p> |
|
|
1401 | <dt><strong><a name="item_add_toggle">$popup->add_toggle ($text, $cb, $initial_value)</a></strong><br /> |
|
|
1402 | </dt> |
|
|
1403 | <dd> |
|
|
1404 | Adds a toggle/checkbox item to the popup. Teh callback gets called |
|
|
1405 | whenever it gets toggled, with a boolean indicating its value as its first |
|
|
1406 | argument. |
|
|
1407 | </dd> |
|
|
1408 | <p></p> |
|
|
1409 | <dt><strong>$popup->show</strong><br /> |
|
|
1410 | </dt> |
|
|
1411 | <dd> |
|
|
1412 | Displays the popup (which is initially hidden). |
|
|
1413 | </dd> |
|
|
1414 | <p></p></dl> |
1097 | <p> |
1415 | <p> |
1098 | </p> |
1416 | </p> |
1099 | <h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> |
1417 | <h2><a name="the_urxvt__timer_class">The <code>urxvt::timer</code> Class</a></h2> |
1100 | <p>This class implements timer watchers/events. Time is represented as a |
1418 | <p>This class implements timer watchers/events. Time is represented as a |
1101 | fractional number of seconds since the epoch. Example:</p> |
1419 | fractional number of seconds since the epoch. Example:</p> |
… | |
… | |
1150 | <p></p> |
1468 | <p></p> |
1151 | <dt><strong>$timer = $timer->start ($tstamp)</strong><br /> |
1469 | <dt><strong>$timer = $timer->start ($tstamp)</strong><br /> |
1152 | </dt> |
1470 | </dt> |
1153 | <dd> |
1471 | <dd> |
1154 | Set the event trigger time to <code>$tstamp</code> and start the timer. |
1472 | Set the event trigger time to <code>$tstamp</code> and start the timer. |
|
|
1473 | </dd> |
|
|
1474 | <p></p> |
|
|
1475 | <dt><strong><a name="item_after">$timer = $timer->after ($delay)</a></strong><br /> |
|
|
1476 | </dt> |
|
|
1477 | <dd> |
|
|
1478 | Like <a href="#item_start"><code>start</code></a>, but sets the expiry timer to c<urxvt::NOW + $delay>. |
1155 | </dd> |
1479 | </dd> |
1156 | <p></p> |
1480 | <p></p> |
1157 | <dt><strong><a name="item_stop">$timer = $timer->stop</a></strong><br /> |
1481 | <dt><strong><a name="item_stop">$timer = $timer->stop</a></strong><br /> |
1158 | </dt> |
1482 | </dt> |
1159 | <dd> |
1483 | <dd> |
… | |
… | |
1229 | <dl> |
1553 | <dl> |
1230 | <dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br /> |
1554 | <dt><strong><a name="item__3d_3d_0__2d_fatal_messages">== 0 - fatal messages</a></strong><br /> |
1231 | </dt> |
1555 | </dt> |
1232 | <dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">>= 3 - script loading and management</a></strong><br /> |
1556 | <dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">>= 3 - script loading and management</a></strong><br /> |
1233 | </dt> |
1557 | </dt> |
1234 | <dt><strong><a name="item__3e_3d10__2d_all_events_received">>=10 - all events received</a></strong><br /> |
1558 | <dt><strong><a name="item__3e_3d10__2d_all_called_hooks">>=10 - all called hooks</a></strong><br /> |
|
|
1559 | </dt> |
|
|
1560 | <dt><strong><a name="item__3e_3d11__2d_hook_reutrn_values">>=11 - hook reutrn values</a></strong><br /> |
1235 | </dt> |
1561 | </dt> |
1236 | </dl> |
1562 | </dl> |
1237 | <p> |
1563 | <p> |
1238 | </p> |
1564 | </p> |
1239 | <hr /> |
1565 | <hr /> |