ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvtperl.3.html
(Generate patch)

Comparing rxvt-unicode/doc/rxvtperl.3.html (file contents):
Revision 1.21 by root, Tue Jan 10 19:46:28 2006 UTC vs.
Revision 1.33 by root, Thu Jan 19 19:26:31 2006 UTC

… …
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
90when the user extends selections (double-click). Right now, it tries to 90when the user extends selections (double-click and further clicks). Right
91select urls and complete shell-quoted arguments, which is very convenient, 91now, it tries to select words, urls and complete shell-quoted
92too, if your <em>ls</em> supports <code>--quoting-style=shell</code>. 92arguments, 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
97will enlarge the selection.</p>
98</dd>
99<dd>
100<p>The selection works by trying to match a number of regexes and displaying
101them in increasing order of length. You can add your own regexes by
102specifying 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
112contain at least one pair of capturing parentheses, which will be used for
113the match. For example, the followign adds a regex that matches everything
114between 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
122interesting 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>
118Binds a popup menu to Ctrl-Button3 that lets you convert the selection 148Binds a popup menu to Ctrl-Button3 that lets you convert the selection
119text into various other formats/action (such as uri unescaping, perl 149text into various other formats/action (such as uri unescaping, perl
120evalution, web-browser starting etc.), depending on content. 150evalution, 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
154onto <code>@{ $term-</code>{selection_popup_hook} }&gt;, that is called whenever the
155popup is displayed.</p>
156</dd>
157<dd>
158<p>It's sole argument is the popup menu, which can be modified. The selection
159is in <code>$_</code>, which can be used to decide wether to add something or not.
160It should either return nothing or a string and a code reference. The
161string will be used as button text and the code reference will be called
162when 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
166the 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-&gt;{term}{selection_popup_hook} }, sub {
172 /a/ ? (&quot;a to be&quot; =&gt; 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&lt;hotkey&gt; (enabled by default)</a></strong><br /> 177<dt><strong><a name="item_searchable_2dscrollback_3chotkey_3e__28enabled_by_">searchable-scrollback&lt;hotkey&gt; (enabled by default)</a></strong><br />
124</dt> 178</dt>
125<dd> 179<dd>
126Adds regex search functionality to the scrollback buffer, triggered 180Adds regex search functionality to the scrollback buffer, triggered
127by a hotkey (default: <code>M-s</code>). When in search mode, normal terminal 181by a hotkey (default: <code>M-s</code>). While in search mode, normal terminal
128input/output is suspended. 182input/output is suspended and a regex is displayed at the bottom of the
129</dd> 183screen.
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
133history, <code>enter</code> leaves search mode at the current position and <code>escape</code>
134returns 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 /> 187search. <code>BackSpace</code> removes a character from the regex, <code>Up</code> and <code>Down</code>
138</dt> 188search upwards/downwards in the scrollback buffer, <code>End</code> jumps to the
189bottom. <code>Escape</code> leaves search mode and returns to the point where search
190was started, while <code>Enter</code> or <code>Return</code> stay at the current position and
191additionally stores the first match in the current line into the primary
192selection.</p>
139<dd> 193</dd>
140Displays 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>
198This selection allows you to do automatic transforms on a selection
199whenever a selection is made.
200</dd>
201<dd>
202<p>It works by specifying perl snippets (most useful is a single <code>s///</code>
203operator) 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
222paste 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
233FILENAME 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
242every error message as a selection pattern, and the second line transforms
243the 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>
146Uses per-line display filtering (<code>on_line_update</code>) to underline urls. 249Uses per-line display filtering (<code>on_line_update</code>) to underline urls and
250make them clickable. When middle-clicked, the program specified in the
251resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with
252the 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>
258This is basically a one-line extension that dynamically changes the background pixmap offset
259to the window position, in effect creating the same effect as pseudo transparency with
260a 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>
152A not very useful example of filtering all text output to the terminal, 270A not very useful example of filtering all text output to the terminal,
153by replacing all line-drawing characters (U+2500 .. U+259F) by a 271by replacing all line-drawing characters (U+2500 .. U+259F) by a
154similar-looking ascii character. 272similar-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>
278Displays 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>
160Displays a very simple digital clock in the upper right corner of the 284Displays a very simple digital clock in the upper right corner of the
161window. Illustrates overwriting the refresh callbacks to create your own 285window. Illustrates overwriting the refresh callbacks to create your own
162overlays or changes. 286overlays or changes.
287</dd>
288<p></p>
289<dt><strong><a name="item_selection_2dpastebin">selection-pastebin</a></strong><br />
290</dt>
291<dd>
292This is a little rarely useful extension that Uploads the selection as
293textfile to a remote site (or does other things). (The implementation is
294not 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,
299i.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
307the 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
315here :)</p>
316</dd>
317<dd>
318<p>The name of the textfile is the hex encoded md5 sum of the selection, so
319the 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
323in the <code>selection-pastebin-url</code> resource (again, the % is the placeholder
324for 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>
187Rxvt-unicodes special way of encoding text, where one ``unicode'' character 353Rxvt-unicodes special way of encoding text, where one ``unicode'' character
188always represents one screen cell. See <em>row_t</em> for a discussion of this format. 354always 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>
273Called at the very end of initialisation of a new terminal, just before 439Called at the very end of initialisation of a new terminal, just before
274returning to the mainloop. 440returning 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>
446Called 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>
452Called just after the child process has exited. <code>$status</code> is the status
453from <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>
280Called whenever a selection has been made by the user, but before the 459Called whenever a selection has been made by the user, but before the
281selection text is copied, so changes to the beginning, end or type of the 460selection text is copied, so changes to the beginning, end or type of the
… …
301</dt> 480</dt>
302<dd> 481<dd>
303Called whenever the user tries to extend the selection (e.g. with a double 482Called whenever the user tries to extend the selection (e.g. with a double
304click) and is either supposed to return false (normal operation), or 483click) and is either supposed to return false (normal operation), or
305should extend the selection itelf and return true to suppress the built-in 484should extend the selection itelf and return true to suppress the built-in
306processing. 485processing. This can happen multiple times, as long as the callback
486returns true, it will be called on every further click by the user and is
487supposed 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>
… …
402Called whenever the user presses a key combination that has a 583Called 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>
404resource in the <code>rxvt(1)</code> manpage). 585resource 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>
591Called on every X event received on the vt window (and possibly other
592windows). Should only be used as a last resort. Most event structure
593members 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>
410Called whenever the window gets the keyboard focus, before rxvt-unicode 599Called whenever the window gets the keyboard focus, before rxvt-unicode
411does focus in processing. 600does focus in processing.
… …
416<dd> 605<dd>
417Called wheneever the window loses keyboard focus, before rxvt-unicode does 606Called wheneever the window loses keyboard focus, before rxvt-unicode does
418focus out processing. 607focus 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 />
… …
476</dt> 667</dt>
477<dd> 668<dd>
478The current terminal. This variable stores the current <code>urxvt::term</code> 669The current terminal. This variable stores the current <code>urxvt::term</code>
479object, whenever a callback/hook is executing. 670object, whenever a callback/hook is executing.
480</dd> 671</dd>
481<p></p> 672<p></p></dl>
482<dt></dt>
483</dl>
484<p> 673<p>
485</p> 674</p>
486<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>
487<dl> 676<dl>
488<dt><strong><a name="item__24term__3d_new_urxvt__5barg_2e_2e_2e_5d">$term = new urxvt [arg...]</a></strong><br />
489</dt>
490<dd>
491Creates a new terminal, very similar as if you had started it with
492<code>system $binfile, arg...</code>. Croaks (and probably outputs an error message)
493if the new instance couldn't be created. Returns <code>undef</code> if the new
494instance didn't initialise perl, and the terminal object otherwise. The
495<code>init</code> and <a href="#item_start"><code>start</code></a> hooks will be called during the call.
496</dd>
497<p></p>
498<dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br /> 677<dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br />
499</dt> 678</dt>
500<dd> 679<dd>
501Fatally aborts execution with the given error message. Avoid at all 680Fatally aborts execution with the given error message. Avoid at all
502costs! The only time this is acceptable is when the terminal process 681costs! The only time this is acceptable is when the terminal process
… …
512</dd> 691</dd>
513<dd> 692<dd>
514<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
515correct place, e.g. on stderr of the connecting urxvtc client.</p> 694correct place, e.g. on stderr of the connecting urxvtc client.</p>
516</dd> 695</dd>
517<p></p>
518<dt><strong><a name="item__24is_safe__3d_urxvt_3a_3asafe">$is_safe = urxvt::safe</a></strong><br />
519</dt>
520<dd> 696<dd>
521Returns true when it is safe to do potentially unsafe things, such as 697<p>Messages have a size limit of 1023 bytes currently.</p>
522evaluating perl code specified by the user. This is true when urxvt was
523started setuid or setgid.
524</dd> 698</dd>
525<p></p> 699<p></p>
526<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 />
527</dt> 701</dt>
528<dd> 702<dd>
… …
532<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 />
533</dt> 707</dt>
534<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,
535Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 709Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
536Button4Mask, Button5Mask, AnyModifier</a></strong><br /> 710Button4Mask, Button5Mask, AnyModifier</a></strong><br />
711</dt>
712<dt><strong><a name="item_urxvt_3a_3anoeventmask_2c_keypressmask_2c_keyrelea">urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
713ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
714PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
715Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
716KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
717ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
718FocusChangeMask, 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,
721EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
722GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
723UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
724ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
725CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
726SelectionNotify, ColormapNotify, ClientMessage, MappingNotify</a></strong><br />
537</dt> 727</dt>
538<dd> 728<dd>
539Various constants for use in X calls and event processing. 729Various constants for use in X calls and event processing.
540</dd> 730</dd>
541<p></p></dl> 731<p></p></dl>
… …
612work.</p> 802work.</p>
613<p> 803<p>
614</p> 804</p>
615<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>
616<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>
810Creates 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
812hash 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
816couldn't be created. Returns <code>undef</code> if the new instance didn't
817initialise 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>
617<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br /> 821<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br />
618</dt> 822</dt>
619<dd> 823<dd>
620Destroy the terminal object (close the window, free resources 824Destroy the terminal object (close the window, free resources
621etc.). Please note that rxvt will not exit as long as any event 825etc.). Please note that rxvt will not exit as long as any event
622watchers (timers, io watchers) are still active. 826watchers (timers, io watchers) are still active.
623</dd> 827</dd>
624<p></p> 828<p></p>
829<dt><strong><a name="item_exec_async">$term-&gt;exec_async ($cmd[, @args])</a></strong><br />
830</dt>
831<dd>
832Works 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
834the user environment before exec'ing the command (e.g. <code>PATH</code>) and should
835be 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>
839</dd>
840<p></p>
625<dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br /> 841<dt><strong><a name="item_option">$isset = $term-&gt;option ($optval[, $set])</a></strong><br />
626</dt> 842</dt>
627<dd> 843<dd>
628Returns true if the option specified by <code>$optval</code> is enabled, and 844Returns true if the option specified by <code>$optval</code> is enabled, and
629optionally change it. All option values are stored by name in the hash 845optionally change it. All option values are stored by name in the hash
… …
635</dd> 851</dd>
636<dd> 852<dd>
637<pre> 853<pre>
638 borderLess console cursorBlink cursorUnderline hold iconic insecure 854 borderLess console cursorBlink cursorUnderline hold iconic insecure
639 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 855 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
640 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 856 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
641 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 857 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
642 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 858 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
643 tripleclickwords utmpInhibit visualBell</pre> 859 transparent tripleclickwords utmpInhibit visualBell</pre>
644</dd> 860</dd>
645<p></p> 861<p></p>
646<dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br /> 862<dt><strong><a name="item_resource">$value = $term-&gt;resource ($name[, $newval])</a></strong><br />
647</dt> 863</dt>
648<dd> 864<dd>
… …
673<pre> 889<pre>
674 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 890 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
675 borderLess color cursorBlink cursorUnderline cutchars delete_key 891 borderLess color cursorBlink cursorUnderline cutchars delete_key
676 display_name embed ext_bwidth fade font geometry hold iconName 892 display_name embed ext_bwidth fade font geometry hold iconName
677 imFont imLocale inputMethod insecure int_bwidth intensityStyles 893 imFont imLocale inputMethod insecure int_bwidth intensityStyles
678 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 894 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
679 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 895 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
680 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 896 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
681 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 897 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
682 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 898 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
683 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 899 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
684 shade term_name title transparent transparent_all tripleclickwords 900 secondaryScreen secondaryScroll selectstyle shade term_name title
901 transient_for transparent transparent_all tripleclickwords utmpInhibit
685 utmpInhibit visualBell</pre> 902 visualBell</pre>
903</dd>
904<p></p>
905<dt><strong><a name="item_x_resource">$value = $term-&gt;x_resource ($pattern)</a></strong><br />
906</dt>
907<dd>
908Returns the X-Resource for the given pattern, excluding the program or
909class name, i.e. <a href="#item_x_resource"><code>$term-&gt;x_resource (&quot;boldFont&quot;)</code></a> should return the
910same value as used by this instance of rxvt-unicode. Returns <code>undef</code> if no
911resource 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
915only one resource database per display, and later invocations might return
916the wrong resources.</p>
686</dd> 917</dd>
687<p></p> 918<p></p>
688<dt><strong><a name="item_parse_keysym">$success = $term-&gt;parse_keysym ($keysym_spec, $command_string)</a></strong><br /> 919<dt><strong><a name="item_parse_keysym">$success = $term-&gt;parse_keysym ($keysym_spec, $command_string)</a></strong><br />
689</dt> 920</dt>
690<dd> 921<dd>
… …
715<dd> 946<dd>
716Return the current values of the selection mark, begin or end positions, 947Return the current values of the selection mark, begin or end positions,
717and optionally set them to new values. 948and optionally set them to new values.
718</dd> 949</dd>
719<p></p> 950<p></p>
951<dt><strong><a name="item_selection_make">$term-&gt;selection_make ($eventtime[, $rectangular])</a></strong><br />
952</dt>
953<dd>
954Tries 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
956rectangular selection will be made. This is the prefered function to make
957a selection.
958</dd>
959<p></p>
720<dt><strong><a name="item_selection_grab">$success = $term-&gt;selection_grab ($eventtime)</a></strong><br /> 960<dt><strong><a name="item_selection_grab">$success = $term-&gt;selection_grab ($eventtime)</a></strong><br />
721</dt> 961</dt>
722<dd> 962<dd>
723Try to request the primary selection from the server (for example, as set 963Try to request the primary selection text from the server (for example, as
724by the next method). 964set by the next method). No visual feedback will be given. This function
965is mostly useful from within <code>on_sel_grab</code> hooks.
725</dd> 966</dd>
726<p></p> 967<p></p>
727<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br /> 968<dt><strong>$oldtext = $term-&gt;selection ([$newtext])</strong><br />
728</dt> 969</dt>
729<dd> 970<dd>
… …
808<p></p> 1049<p></p>
809<dt><strong><a name="item_scr_xor_span">$term-&gt;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-&gt;scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])</a></strong><br />
810</dt> 1051</dt>
811<dd> 1052<dd>
812XORs the rendition values in the given span with the provided value 1053XORs the rendition values in the given span with the provided value
813(default: <code>RS_RVid</code>). Useful in refresh hooks to provide effects similar 1054(default: <code>RS_RVid</code>), which <em>MUST NOT</em> contain font styles. Useful in
814to the selection. 1055refresh hooks to provide effects similar to the selection.
815</dd> 1056</dd>
816<p></p> 1057<p></p>
817<dt><strong><a name="item_scr_xor_rect">$term-&gt;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-&gt;scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])</a></strong><br />
818</dt> 1059</dt>
819<dd> 1060<dd>
820Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing 1061Similar to <a href="#item_scr_xor_span"><code>scr_xor_span</code></a>, but xors a rectangle instead. Trailing
821whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults 1062whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults
822to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines 1063to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines
823it instead. 1064it instead. Both styles <em>MUST NOT</em> contain font styles.
824</dd> 1065</dd>
825<p></p> 1066<p></p>
826<dt><strong><a name="item_scr_bell">$term-&gt;scr_bell</a></strong><br /> 1067<dt><strong><a name="item_scr_bell">$term-&gt;scr_bell</a></strong><br />
827</dt> 1068</dt>
828<dd> 1069<dd>
… …
878</dt> 1119</dt>
879<dd> 1120<dd>
880Return the window id of the terminal window. 1121Return the window id of the terminal window.
881</dd> 1122</dd>
882<p></p> 1123<p></p>
1124<dt><strong><a name="item_vt_emask_add">$term-&gt;vt_emask_add ($x_event_mask)</a></strong><br />
1125</dt>
1126<dd>
1127Adds the specified events to the vt event mask. Useful e.g. when you want
1128to receive pointer events all the times:
1129</dd>
1130<dd>
1131<pre>
1132 $term-&gt;vt_emask_add (urxvt::PointerMotionMask);</pre>
1133</dd>
1134<p></p>
883<dt><strong><a name="item_width">$window_width = $term-&gt;width</a></strong><br /> 1135<dt><strong><a name="item_width">$window_width = $term-&gt;width</a></strong><br />
884</dt> 1136</dt>
885<dt><strong><a name="item_height">$window_height = $term-&gt;height</a></strong><br /> 1137<dt><strong><a name="item_height">$window_height = $term-&gt;height</a></strong><br />
886</dt> 1138</dt>
887<dt><strong><a name="item_fwidth">$font_width = $term-&gt;fwidth</a></strong><br /> 1139<dt><strong><a name="item_fwidth">$font_width = $term-&gt;fwidth</a></strong><br />
… …
900</dt> 1152</dt>
901<dt><strong><a name="item_savelines">$max_scrollback = $term-&gt;saveLines</a></strong><br /> 1153<dt><strong><a name="item_savelines">$max_scrollback = $term-&gt;saveLines</a></strong><br />
902</dt> 1154</dt>
903<dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term-&gt;total_rows</a></strong><br /> 1155<dt><strong><a name="item_total_rows">$nrow_plus_saveLines = $term-&gt;total_rows</a></strong><br />
904</dt> 1156</dt>
905<dt><strong><a name="item_nsaved">$lines_in_scrollback = $term-&gt;nsaved</a></strong><br /> 1157<dt><strong><a name="item_top_row">$topmost_scrollback_row = $term-&gt;top_row</a></strong><br />
906</dt> 1158</dt>
907<dd> 1159<dd>
908Return various integers describing terminal characteristics. 1160Return various integers describing terminal characteristics.
909</dd> 1161</dd>
910<p></p> 1162<p></p>
1163<dt><strong><a name="item_display_id">$x_display = $term-&gt;display_id</a></strong><br />
1164</dt>
1165<dd>
1166Return the DISPLAY used by rxvt-unicode.
1167</dd>
1168<p></p>
911<dt><strong><a name="item_locale">$lc_ctype = $term-&gt;locale</a></strong><br /> 1169<dt><strong><a name="item_locale">$lc_ctype = $term-&gt;locale</a></strong><br />
912</dt> 1170</dt>
913<dd> 1171<dd>
914Returns the LC_CTYPE category string used by this rxvt-unicode. 1172Returns the LC_CTYPE category string used by this rxvt-unicode.
915</dd> 1173</dd>
916<p></p> 1174<p></p>
917<dt><strong><a name="item_display_id">$x_display = $term-&gt;display_id</a></strong><br /> 1175<dt><strong><a name="item_env">$env = $term-&gt;env</a></strong><br />
918</dt> 1176</dt>
919<dd> 1177<dd>
920Return the DISPLAY used by rxvt-unicode. 1178Returns a copy of the environment in effect for the terminal as a hashref
1179similar to <code>\%ENV</code>.
921</dd> 1180</dd>
922<p></p> 1181<p></p>
923<dt><strong><a name="item_modlevel3mask">$modifiermask = $term-&gt;ModLevel3Mask</a></strong><br /> 1182<dt><strong><a name="item_modlevel3mask">$modifiermask = $term-&gt;ModLevel3Mask</a></strong><br />
924</dt> 1183</dt>
925<dt><strong><a name="item_modmetamask">$modifiermask = $term-&gt;ModMetaMask</a></strong><br /> 1184<dt><strong><a name="item_modmetamask">$modifiermask = $term-&gt;ModMetaMask</a></strong><br />
… …
932</dd> 1191</dd>
933<p></p> 1192<p></p>
934<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br /> 1193<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br />
935</dt> 1194</dt>
936<dd> 1195<dd>
937Returns the negative row number of the topmost line. Minimum value is 1196Returns the row number of the topmost displayed line. Maximum value is
938<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
939this many lines into the scrollback buffer. 1198this many lines into the scrollback buffer.
940</dd> 1199</dd>
941<p></p> 1200<p></p>
942<dt><strong><a name="item_want_refresh">$term-&gt;want_refresh</a></strong><br /> 1201<dt><strong><a name="item_want_refresh">$term-&gt;want_refresh</a></strong><br />
943</dt> 1202</dt>
… …
954</dt> 1213</dt>
955<dd> 1214<dd>
956Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code> 1215Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code>
957is the topmost terminal line, row <code>$term-&gt;$ncol-1</code> is the bottommost 1216is the topmost terminal line, row <code>$term-&gt;$ncol-1</code> is the bottommost
958terminal line. The scrollback buffer starts at line <code>-1</code> and extends to 1217terminal line. The scrollback buffer starts at line <code>-1</code> and extends to
959line <a href="#item_nsaved"><code>-$term-&gt;nsaved</code></a>. Nothing will be returned if a nonexistent line 1218line <code>-$term-&gt;nsaved</code>. Nothing will be returned if a nonexistent line
960is requested. 1219is requested.
961</dd> 1220</dd>
962<dd> 1221<dd>
963<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
964line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful 1223line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful
… …
1049<p></p> 1308<p></p>
1050<dt><strong><a name="item_offset_of">$offset = $line-&gt;offset_of ($row, $col)</a></strong><br /> 1309<dt><strong><a name="item_offset_of">$offset = $line-&gt;offset_of ($row, $col)</a></strong><br />
1051</dt> 1310</dt>
1052<dd> 1311<dd>
1053Returns the character offset of the given row|col pair within the logical 1312Returns the character offset of the given row|col pair within the logical
1054line. 1313line. Works for rows outside the line, too, and returns corresponding
1314offsets outside the string.
1055</dd> 1315</dd>
1056<p></p> 1316<p></p>
1057<dt><strong><a name="item_coord_of">($row, $col) = $line-&gt;coord_of ($offset)</a></strong><br /> 1317<dt><strong><a name="item_coord_of">($row, $col) = $line-&gt;coord_of ($offset)</a></strong><br />
1058</dt> 1318</dt>
1059<dd> 1319<dd>
… …
1208<p></p> 1468<p></p>
1209<dt><strong>$timer = $timer-&gt;start ($tstamp)</strong><br /> 1469<dt><strong>$timer = $timer-&gt;start ($tstamp)</strong><br />
1210</dt> 1470</dt>
1211<dd> 1471<dd>
1212Set the event trigger time to <code>$tstamp</code> and start the timer. 1472Set 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-&gt;after ($delay)</a></strong><br />
1476</dt>
1477<dd>
1478Like <a href="#item_start"><code>start</code></a>, but sets the expiry timer to c&lt;urxvt::NOW + $delay&gt;.
1213</dd> 1479</dd>
1214<p></p> 1480<p></p>
1215<dt><strong><a name="item_stop">$timer = $timer-&gt;stop</a></strong><br /> 1481<dt><strong><a name="item_stop">$timer = $timer-&gt;stop</a></strong><br />
1216</dt> 1482</dt>
1217<dd> 1483<dd>
… …
1287<dl> 1553<dl>
1288<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 />
1289</dt> 1555</dt>
1290<dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">&gt;= 3 - script loading and management</a></strong><br /> 1556<dt><strong><a name="item__3e_3d_3__2d_script_loading_and_management">&gt;= 3 - script loading and management</a></strong><br />
1291</dt> 1557</dt>
1292<dt><strong><a name="item__3e_3d10__2d_all_events_received">&gt;=10 - all events received</a></strong><br /> 1558<dt><strong><a name="item__3e_3d10__2d_all_called_hooks">&gt;=10 - all called hooks</a></strong><br />
1559</dt>
1560<dt><strong><a name="item__3e_3d11__2d_hook_reutrn_values">&gt;=11 - hook reutrn values</a></strong><br />
1293</dt> 1561</dt>
1294</dl> 1562</dl>
1295<p> 1563<p>
1296</p> 1564</p>
1297<hr /> 1565<hr />

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines