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.34 by root, Fri Jan 20 16:02:20 2006 UTC vs.
Revision 1.43 by root, Tue Feb 21 01:00:40 2006 UTC

… …
121<dd> 121<dd>
122<pre> 122<pre>
123 URxvt.selection.pattern-0: \\|([^|]+)\\|</pre> 123 URxvt.selection.pattern-0: \\|([^|]+)\\|</pre>
124</dd> 124</dd>
125<dd> 125<dd>
126<p>Another example: Programs I use often output ``absolute path: '' at the
127beginning of a line when they process multiple files. The following
128pattern matches the filename (note, there is a single space at the very
129end):</p>
130</dd>
131<dd>
132<pre>
133 URxvt.selection.pattern-0: ^(/[^:]+):\</pre>
134</dd>
135<dd>
126<p>You can look at the source of the selection extension to see more 136<p>You can look at the source of the selection extension to see more
127interesting uses, such as parsing a line from beginning to end.</p> 137interesting uses, such as parsing a line from beginning to end.</p>
128</dd> 138</dd>
129<dd> 139<dd>
130<p>This extension also offers following bindable keyboard commands:</p> 140<p>This extension also offers following bindable keyboard commands:</p>
… …
144</dt> 154</dt>
145<dd> 155<dd>
146Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at 156Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
147runtime. 157runtime.
148</dd> 158</dd>
159<dd>
160<p>Other extensions can extend this popup menu by pushing a code reference
161onto <code>@{ $term-</code>{option_popup_hook} }&gt;, which gets called whenever the
162popup is being displayed.</p>
163</dd>
164<dd>
165<p>It's sole argument is the popup menu, which can be modified. It should
166either return nothing or a string, the initial boolean value and a code
167reference. The string will be used as button text and the code reference
168will be called when the toggle changes, with the new boolean value as
169first argument.</p>
170</dd>
171<dd>
172<p>The following will add an entry <code>myoption</code> that changes
173<code>$self-</code>{myoption}&gt;:</p>
174</dd>
175<dd>
176<pre>
177 push @{ $self-&gt;{term}{option_popup_hook} }, sub {
178 (&quot;my option&quot; =&gt; $myoption, sub { $self-&gt;{myoption} = $_[0] })
179 };</pre>
180</dd>
149<p></p> 181<p></p>
150<dt><strong>selection-popup (enabled by default)</strong><br /> 182<dt><strong>selection-popup (enabled by default)</strong><br />
151</dt> 183</dt>
152<dd> 184<dd>
153Binds a popup menu to Ctrl-Button3 that lets you convert the selection 185Binds a popup menu to Ctrl-Button3 that lets you convert the selection
154text into various other formats/action (such as uri unescaping, perl 186text into various other formats/action (such as uri unescaping, perl
155evalution, web-browser starting etc.), depending on content. 187evaluation, web-browser starting etc.), depending on content.
156</dd> 188</dd>
157<dd> 189<dd>
158<p>Other extensions can extend this popup menu by pushing a code reference 190<p>Other extensions can extend this popup menu by pushing a code reference
159onto <code>@{ $term-</code>{selection_popup_hook} }&gt;, that is called whenever the 191onto <code>@{ $term-</code>{selection_popup_hook} }&gt;, which gets called whenever the
160popup is displayed.</p> 192popup is being displayed.</p>
161</dd> 193</dd>
162<dd> 194<dd>
163<p>It's sole argument is the popup menu, which can be modified. The selection 195<p>It's sole argument is the popup menu, which can be modified. The selection
164is in <code>$_</code>, which can be used to decide wether to add something or not. 196is in <code>$_</code>, which can be used to decide wether to add something or not.
165It should either return nothing or a string and a code reference. The 197It should either return nothing or a string and a code reference. The
… …
195was started, while <code>Enter</code> or <code>Return</code> stay at the current position and 227was started, while <code>Enter</code> or <code>Return</code> stay at the current position and
196additionally stores the first match in the current line into the primary 228additionally stores the first match in the current line into the primary
197selection.</p> 229selection.</p>
198</dd> 230</dd>
199<p></p> 231<p></p>
232<dt><strong><a name="item_readline">readline (enabled by default)</a></strong><br />
233</dt>
234<dd>
235A support package that tries to make editing with readline easier. At
236the moment, it reacts to clicking shift-left mouse button by trying to
237move the text cursor to this position. It does so by generating as many
238cursor-left or cursor-right keypresses as required (the this only works
239for programs that correctly support wide characters).
240</dd>
241<dd>
242<p>To avoid too many false positives, this is only done when:</p>
243</dd>
244<dl>
245<dt><strong><a name="item__2d_the_tty_is_in_icanon_state_2e">- the tty is in ICANON state.</a></strong><br />
246</dt>
247<dt><strong><a name="item__2d_the_text_cursor_is_visible_2e">- the text cursor is visible.</a></strong><br />
248</dt>
249<dt><strong><a name="item__2d_the_primary_screen_is_currently_being_displaye">- the primary screen is currently being displayed.</a></strong><br />
250</dt>
251<dt><strong><a name="item_same">- the mouse is on the same (multi-row-) line as the text cursor.</a></strong><br />
252</dt>
253</dl>
254<p>The normal selection mechanism isn't disabled, so quick successive clicks
255might interfere with selection creation in harmless ways.</p>
200<dt><strong><a name="item_selection_2dautotransform">selection-autotransform</a></strong><br /> 256<dt><strong><a name="item_selection_2dautotransform">selection-autotransform</a></strong><br />
201</dt> 257</dt>
202<dd> 258<dd>
203This selection allows you to do automatic transforms on a selection 259This selection allows you to do automatic transforms on a selection
204whenever a selection is made. 260whenever a selection is made.
… …
255is, it implements what is commonly refered to as ``tabbed terminal''. The topmost line 311is, it implements what is commonly refered to as ``tabbed terminal''. The topmost line
256displays a ``[NEW]'' button, which, when clicked, will add a new tab, followed by one 312displays a ``[NEW]'' button, which, when clicked, will add a new tab, followed by one
257button per tab. 313button per tab.
258</dd> 314</dd>
259<dd> 315<dd>
260<p>Clicking a button will activate that tab. Pressing Shift-Left and 316<p>Clicking a button will activate that tab. Pressing <strong>Shift-Left</strong> and
261Shift-Right will switch to the tab left or right of the current one.</p> 317<strong>Shift-Right</strong> will switch to the tab left or right of the current one,
318while <strong>Shift-Down</strong> creates a new tab.</p>
319</dd>
320<dd>
321<p>The tabbar itself can be configured similarly to a normal terminal, but
322with a resource class of <code>URxvt.tabbed</code>. In addition, it supports the
323following four resources (shown with defaults):</p>
324</dd>
325<dd>
326<pre>
327 URxvt.tabbed.tabbar-fg: &lt;colour-index, default 3&gt;
328 URxvt.tabbed.tabbar-bg: &lt;colour-index, default 0&gt;
329 URxvt.tabbed.tab-fg: &lt;colour-index, default 0&gt;
330 URxvt.tabbed.tab-bg: &lt;colour-index, default 1&gt;</pre>
331</dd>
332<dd>
333<p>See <em>COLOR AND GRAPHICS</em> in the <code>rxvt(1)</code> manpage for valid
334indices.</p>
262</dd> 335</dd>
263<p></p> 336<p></p>
264<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> 337<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br />
265</dt> 338</dt>
266<dd> 339<dd>
… …
268make them clickable. When middle-clicked, the program specified in the 341make them clickable. When middle-clicked, the program specified in the
269resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with 342resource <code>urlLauncher</code> (default <code>x-www-browser</code>) will be started with
270the URL as first argument. 343the URL as first argument.
271</dd> 344</dd>
272<p></p> 345<p></p>
346<dt><strong><a name="item_xim_2donthespot">xim-onthespot</a></strong><br />
347</dt>
348<dd>
349This (experimental) perl extension implements OnTheSpot editing. It does
350not work perfectly, and some input methods don't seem to work well with
351OnTheSpot editing in general, but it seems to work at leats for SCIM and
352kinput2.
353</dd>
354<dd>
355<p>You enable it by specifying this extension and a preedit style of
356<code>OnTheSpot</code>, i.e.:</p>
357</dd>
358<dd>
359<pre>
360 rxvt -pt OnTheSpot -pe xim-onthespot</pre>
361</dd>
362<p></p>
273<dt><strong><a name="item_automove_2dbackground">automove-background</a></strong><br /> 363<dt><strong><a name="item_automove_2dbackground">automove-background</a></strong><br />
274</dt> 364</dt>
275<dd> 365<dd>
276This is basically a one-line extension that dynamically changes the background pixmap offset 366This is basically a one-line extension that dynamically changes the background pixmap offset
277to the window position, in effect creating the same effect as pseudo transparency with 367to the window position, in effect creating the same effect as pseudo transparency with
… …
294</dt> 384</dt>
295<dd> 385<dd>
296Displays a digital clock using the built-in overlay. 386Displays a digital clock using the built-in overlay.
297</dd> 387</dd>
298<p></p> 388<p></p>
299<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br /> 389<dt><strong><a name="item_remote_2dclipboard">remote-clipboard</a></strong><br />
300</dt> 390</dt>
391<dd>
392Somewhat of a misnomer, this extension adds two menu entries to the
393selection popup that allows one ti run external commands to store the
394selection somewhere and fetch it again.
301<dd> 395</dd>
302Displays a very simple digital clock in the upper right corner of the 396<dd>
303window. Illustrates overwriting the refresh callbacks to create your own 397<p>We use it to implement a ``distributed selection mechanism'', which just
304overlays or changes. 398means that one command uploads the file to a remote server, and another
399reads it.</p>
400</dd>
401<dd>
402<p>The commands can be set using the <code>URxvt.remote-selection.store</code> and
403<code>URxvt.remote-selection.fetch</code> resources. The first should read the
404selection to store from STDIN (always in UTF-8), the second should provide
405the selection data on STDOUT (also in UTF-8).</p>
406</dd>
407<dd>
408<p>The defaults (which are likely useless to you) use rsh and cat:</p>
409</dd>
410<dd>
411<pre>
412 URxvt.remote-selection.store: rsh ruth 'cat &gt;/tmp/distributed-selection'
413 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'</pre>
305</dd> 414</dd>
306<p></p> 415<p></p>
307<dt><strong><a name="item_selection_2dpastebin">selection-pastebin</a></strong><br /> 416<dt><strong><a name="item_selection_2dpastebin">selection-pastebin</a></strong><br />
308</dt> 417</dt>
309<dd> 418<dd>
… …
342for the filename):</p> 451for the filename):</p>
343</dd> 452</dd>
344<dd> 453<dd>
345<pre> 454<pre>
346 URxvt.selection-pastebin.url: <a href="http://www.ta-sa.org/files/txt/%">http://www.ta-sa.org/files/txt/%</a></pre> 455 URxvt.selection-pastebin.url: <a href="http://www.ta-sa.org/files/txt/%">http://www.ta-sa.org/files/txt/%</a></pre>
456</dd>
457<p></p>
458<dt><strong><a name="item_example_2drefresh_2dhooks">example-refresh-hooks</a></strong><br />
459</dt>
460<dd>
461Displays a very simple digital clock in the upper right corner of the
462window. Illustrates overwriting the refresh callbacks to create your own
463overlays or changes.
347</dd> 464</dd>
348<p></p></dl> 465<p></p></dl>
349<p> 466<p>
350</p> 467</p>
351<hr /> 468<hr />
… …
452</dd> 569</dd>
453<p></p> 570<p></p>
454<dt><strong><a name="item_on_destroy__24term">on_destroy $term</a></strong><br /> 571<dt><strong><a name="item_on_destroy__24term">on_destroy $term</a></strong><br />
455</dt> 572</dt>
456<dd> 573<dd>
457Called whenever something tries to destroy terminal, before doing anything 574Called whenever something tries to destroy terminal, when the terminal is
458yet. If this hook returns true, then destruction is skipped, but this is 575still fully functional (not for long, though).
459rarely a good idea.
460</dd> 576</dd>
461<p></p> 577<p></p>
462<dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br /> 578<dt><strong><a name="item_on_reset__24term">on_reset $term</a></strong><br />
463</dt> 579</dt>
464<dd> 580<dd>
… …
602</dt> 718</dt>
603<dd> 719<dd>
604Called just after the screen gets redrawn. See <code>on_refresh_begin</code>. 720Called just after the screen gets redrawn. See <code>on_refresh_begin</code>.
605</dd> 721</dd>
606<p></p> 722<p></p>
607<dt><strong><a name="item_on_keyboard_command__24term_2c__24string">on_keyboard_command $term, $string</a></strong><br /> 723<dt><strong><a name="item_on_user_command__24term_2c__24string">on_user_command $term, $string</a></strong><br />
608</dt> 724</dt>
609<dd> 725<dd>
610Called whenever the user presses a key combination that has a 726Called whenever the a user-configured event is being activated (e.g. via
611<code>perl:string</code> action bound to it (see description of the <strong>keysym</strong> 727a <code>perl:string</code> action bound to a key, see description of the <strong>keysym</strong>
612resource in the <code>rxvt(1)</code> manpage). 728resource in the <code>rxvt(1)</code> manpage).
729</dd>
730<dd>
731<p>The event is simply the action string. This interface is assumed to change
732slightly in the future.</p>
733</dd>
734<p></p>
735<dt><strong><a name="item_on_resize_all_windows__24tern_2c__24new_width_2c__">on_resize_all_windows $tern, $new_width, $new_height</a></strong><br />
736</dt>
737<dd>
738Called just after the new window size has been calculcated, but before
739windows are actually being resized or hints are being set. If this hook
740returns TRUE, setting of the window hints is being skipped.
613</dd> 741</dd>
614<p></p> 742<p></p>
615<dt><strong><a name="item_on_x_event__24term_2c__24event">on_x_event $term, $event</a></strong><br /> 743<dt><strong><a name="item_on_x_event__24term_2c__24event">on_x_event $term, $event</a></strong><br />
616</dt> 744</dt>
617<dd> 745<dd>
… …
634focus out processing. 762focus out processing.
635</dd> 763</dd>
636<p></p> 764<p></p>
637<dt><strong><a name="item_on_configure_notify__24term_2c__24event">on_configure_notify $term, $event</a></strong><br /> 765<dt><strong><a name="item_on_configure_notify__24term_2c__24event">on_configure_notify $term, $event</a></strong><br />
638</dt> 766</dt>
767<dt><strong><a name="item_on_property_notify__24term_2c__24event">on_property_notify $term, $event</a></strong><br />
768</dt>
639<dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a></strong><br /> 769<dt><strong><a name="item_on_key_press__24term_2c__24event_2c__24keysym_2c__">on_key_press $term, $event, $keysym, $octets</a></strong><br />
640</dt> 770</dt>
641<dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br /> 771<dt><strong><a name="item_on_key_release__24term_2c__24event_2c__24keysym">on_key_release $term, $event, $keysym</a></strong><br />
642</dt> 772</dt>
643<dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br /> 773<dt><strong><a name="item_on_button_press__24term_2c__24event">on_button_press $term, $event</a></strong><br />
… …
654Called whenever the corresponding X event is received for the terminal If 784Called whenever the corresponding X event is received for the terminal If
655the hook returns true, then the even will be ignored by rxvt-unicode. 785the hook returns true, then the even will be ignored by rxvt-unicode.
656</dd> 786</dd>
657<dd> 787<dd>
658<p>The event is a hash with most values as named by Xlib (see the XEvent 788<p>The event is a hash with most values as named by Xlib (see the XEvent
659manpage), with the additional members <code>row</code> and <code>col</code>, which are the row 789manpage), with the additional members <code>row</code> and <code>col</code>, which are the
660and column under the mouse cursor.</p> 790(real, not screen-based) row and column under the mouse cursor.</p>
661</dd> 791</dd>
662<dd> 792<dd>
663<p><code>on_key_press</code> additionally receives the string rxvt-unicode would 793<p><code>on_key_press</code> additionally receives the string rxvt-unicode would
664output, if any, in locale-specific encoding.</p> 794output, if any, in locale-specific encoding.</p>
665</dd> 795</dd>
… …
752<p>Using this function has the advantage that its output ends up in the 882<p>Using this function has the advantage that its output ends up in the
753correct place, e.g. on stderr of the connecting urxvtc client.</p> 883correct place, e.g. on stderr of the connecting urxvtc client.</p>
754</dd> 884</dd>
755<dd> 885<dd>
756<p>Messages have a size limit of 1023 bytes currently.</p> 886<p>Messages have a size limit of 1023 bytes currently.</p>
887</dd>
888<p></p>
889<dt><strong><a name="item__40terms__3d_urxvt_3a_3atermlist">@terms = urxvt::termlist</a></strong><br />
890</dt>
891<dd>
892Returns all urxvt::term objects that exist in this process, regardless of
893wether they are started, being destroyed etc., so be careful. Only term
894objects that have perl extensions attached will be returned (because there
895is no urxvt::term objet associated with others).
757</dd> 896</dd>
758<p></p> 897<p></p>
759<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br /> 898<dt><strong><a name="item__24time__3d_urxvt_3a_3anow">$time = urxvt::NOW</a></strong><br />
760</dt> 899</dt>
761<dd> 900<dd>
… …
829<p></p> 968<p></p>
830<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_fgcolor__24rend_2c__24n">$rend = urxvt::SET_FGCOLOR $rend, $new_colour</a></strong><br /> 969<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_fgcolor__24rend_2c__24n">$rend = urxvt::SET_FGCOLOR $rend, $new_colour</a></strong><br />
831</dt> 970</dt>
832<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_bgcolor__24rend_2c__24n">$rend = urxvt::SET_BGCOLOR $rend, $new_colour</a></strong><br /> 971<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_bgcolor__24rend_2c__24n">$rend = urxvt::SET_BGCOLOR $rend, $new_colour</a></strong><br />
833</dt> 972</dt>
973<dt><strong><a name="item__24rend__3d_urxvt_3a_3aset_color__24rend_2c__24new">$rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg</a></strong><br />
974</dt>
834<dd> 975<dd>
835Replace the foreground/background colour in the rendition mask with the 976Replace the foreground/background colour in the rendition mask with the
836specified one. 977specified one.
837</dd> 978</dd>
838<p></p> 979<p></p>
… …
872</dd> 1013</dd>
873<dd> 1014<dd>
874<p>Croaks (and probably outputs an error message) if the new instance 1015<p>Croaks (and probably outputs an error message) if the new instance
875couldn't be created. Returns <code>undef</code> if the new instance didn't 1016couldn't be created. Returns <code>undef</code> if the new instance didn't
876initialise perl, and the terminal object otherwise. The <code>init</code> and 1017initialise perl, and the terminal object otherwise. The <code>init</code> and
877<a href="#item_start"><code>start</code></a> hooks will be called during this call.</p> 1018<a href="#item_start"><code>start</code></a> hooks will be called before this call returns, and are free to
1019refer to global data (which is race free).</p>
878</dd> 1020</dd>
879<p></p> 1021<p></p>
880<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br /> 1022<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br />
881</dt> 1023</dt>
882<dd> 1024<dd>
… …
1141<p>Normally its not a good idea to use this function, as programs might be 1283<p>Normally its not a good idea to use this function, as programs might be
1142confused by changes in cursor position or scrolling. Its useful inside a 1284confused by changes in cursor position or scrolling. Its useful inside a
1143<code>on_add_lines</code> hook, though.</p> 1285<code>on_add_lines</code> hook, though.</p>
1144</dd> 1286</dd>
1145<p></p> 1287<p></p>
1288<dt><strong><a name="item_scr_change_screen">$term-&gt;scr_change_screen ($screen)</a></strong><br />
1289</dt>
1290<dd>
1291Switch to given screen - 0 primary, 1 secondary.
1292</dd>
1293<p></p>
1146<dt><strong><a name="item_cmd_parse">$term-&gt;cmd_parse ($octets)</a></strong><br /> 1294<dt><strong><a name="item_cmd_parse">$term-&gt;cmd_parse ($octets)</a></strong><br />
1147</dt> 1295</dt>
1148<dd> 1296<dd>
1149Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the 1297Similar to <a href="#item_scr_add_lines"><code>scr_add_lines</code></a>, but the argument must be in the
1150locale-specific encoding of the terminal and can contain command sequences 1298locale-specific encoding of the terminal and can contain command sequences
… …
1166be used to suppress input and output handling to the pty/tty. See the 1314be used to suppress input and output handling to the pty/tty. See the
1167description of <a href="#item_events"><code>urxvt::timer-&gt;events</code></a>. Make sure to always restore 1315description of <a href="#item_events"><code>urxvt::timer-&gt;events</code></a>. Make sure to always restore
1168the previous value. 1316the previous value.
1169</dd> 1317</dd>
1170<p></p> 1318<p></p>
1319<dt><strong><a name="item_pty_fd">$fd = $term-&gt;pty_fd</a></strong><br />
1320</dt>
1321<dd>
1322Returns the master file descriptor for the pty in use, or <code>-1</code> if no pty
1323is used.
1324</dd>
1325<p></p>
1171<dt><strong><a name="item_parent">$windowid = $term-&gt;parent</a></strong><br /> 1326<dt><strong><a name="item_parent">$windowid = $term-&gt;parent</a></strong><br />
1172</dt> 1327</dt>
1173<dd> 1328<dd>
1174Return the window id of the toplevel window. 1329Return the window id of the toplevel window.
1175</dd> 1330</dd>
… …
1189<dd> 1344<dd>
1190<pre> 1345<pre>
1191 $term-&gt;vt_emask_add (urxvt::PointerMotionMask);</pre> 1346 $term-&gt;vt_emask_add (urxvt::PointerMotionMask);</pre>
1192</dd> 1347</dd>
1193<p></p> 1348<p></p>
1349<dt><strong><a name="item_focus_in">$term-&gt;focus_in</a></strong><br />
1350</dt>
1351<dt><strong><a name="item_focus_out">$term-&gt;focus_out</a></strong><br />
1352</dt>
1353<dt><strong><a name="item_key_press">$term-&gt;key_press ($state, $keycode[, $time])</a></strong><br />
1354</dt>
1355<dt><strong><a name="item_key_release">$term-&gt;key_release ($state, $keycode[, $time])</a></strong><br />
1356</dt>
1357<dd>
1358Deliver various fake events to to terminal.
1359</dd>
1360<p></p>
1194<dt><strong><a name="item_width">$window_width = $term-&gt;width</a></strong><br /> 1361<dt><strong><a name="item_width">$window_width = $term-&gt;width</a></strong><br />
1195</dt> 1362</dt>
1196<dt><strong><a name="item_height">$window_height = $term-&gt;height</a></strong><br /> 1363<dt><strong><a name="item_height">$window_height = $term-&gt;height</a></strong><br />
1197</dt> 1364</dt>
1198<dt><strong><a name="item_fwidth">$font_width = $term-&gt;fwidth</a></strong><br /> 1365<dt><strong><a name="item_fwidth">$font_width = $term-&gt;fwidth</a></strong><br />
… …
1236<dd> 1403<dd>
1237Returns a copy of the environment in effect for the terminal as a hashref 1404Returns a copy of the environment in effect for the terminal as a hashref
1238similar to <code>\%ENV</code>. 1405similar to <code>\%ENV</code>.
1239</dd> 1406</dd>
1240<p></p> 1407<p></p>
1408<dt><strong><a name="item_envv">@envv = $term-&gt;envv</a></strong><br />
1409</dt>
1410<dd>
1411Returns the environment as array of strings of the form <code>VAR=VALUE</code>.
1412</dd>
1413<p></p>
1414<dt><strong><a name="item_argv">@argv = $term-&gt;argv</a></strong><br />
1415</dt>
1416<dd>
1417Return the argument vector as this terminal, similar to @ARGV, but
1418includes the program name as first element.
1419</dd>
1420<p></p>
1241<dt><strong><a name="item_modlevel3mask">$modifiermask = $term-&gt;ModLevel3Mask</a></strong><br /> 1421<dt><strong><a name="item_modlevel3mask">$modifiermask = $term-&gt;ModLevel3Mask</a></strong><br />
1242</dt> 1422</dt>
1243<dt><strong><a name="item_modmetamask">$modifiermask = $term-&gt;ModMetaMask</a></strong><br /> 1423<dt><strong><a name="item_modmetamask">$modifiermask = $term-&gt;ModMetaMask</a></strong><br />
1244</dt> 1424</dt>
1245<dt><strong><a name="item_modnumlockmask">$modifiermask = $term-&gt;ModNumLockMask</a></strong><br /> 1425<dt><strong><a name="item_modnumlockmask">$modifiermask = $term-&gt;ModNumLockMask</a></strong><br />
1246</dt> 1426</dt>
1247<dd> 1427<dd>
1248Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often 1428Return the modifier masks corresponding to the ``ISO Level 3 Shift'' (often
1249AltGr), the meta key (often Alt) and the num lock key, if applicable. 1429AltGr), the meta key (often Alt) and the num lock key, if applicable.
1430</dd>
1431<p></p>
1432<dt><strong><a name="item_current_screen">$screen = $term-&gt;current_screen</a></strong><br />
1433</dt>
1434<dd>
1435Returns the currently displayed screen (0 primary, 1 secondary).
1436</dd>
1437<p></p>
1438<dt><strong><a name="item_hidden_cursor">$cursor_is_hidden = $term-&gt;hidden_cursor</a></strong><br />
1439</dt>
1440<dd>
1441Returns wether the cursor is currently hidden or not.
1250</dd> 1442</dd>
1251<p></p> 1443<p></p>
1252<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br /> 1444<dt><strong><a name="item_view_start">$view_start = $term-&gt;view_start ([$newvalue])</a></strong><br />
1253</dt> 1445</dt>
1254<dd> 1446<dd>
… …
1283to replace only parts of a line. The font index in the rendition will 1475to replace only parts of a line. The font index in the rendition will
1284automatically be updated.</p> 1476automatically be updated.</p>
1285</dd> 1477</dd>
1286<dd> 1478<dd>
1287<p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more 1479<p><a href="#item__24text"><code>$text</code></a> is in a special encoding: tabs and wide characters that use more
1288than one cell when displayed are padded with urxvt::NOCHAR characters 1480than one cell when displayed are padded with <code>$urxvt::NOCHAR</code> (chr 65535)
1289(<code>chr 65535</code>). Characters with combining characters and other characters 1481characters. Characters with combining characters and other characters that
1290that do not fit into the normal tetx encoding will be replaced with 1482do not fit into the normal tetx encoding will be replaced with characters
1291characters in the private use area.</p> 1483in the private use area.</p>
1292</dd> 1484</dd>
1293<dd> 1485<dd>
1294<p>You have to obey this encoding when changing text. The advantage is 1486<p>You have to obey this encoding when changing text. The advantage is
1295that <code>substr</code> and similar functions work on screen cells and not on 1487that <code>substr</code> and similar functions work on screen cells and not on
1296characters.</p> 1488characters.</p>
… …
1392<dd> 1584<dd>
1393Converts rxvt-unicodes text reprsentation into a perl string. See 1585Converts rxvt-unicodes text reprsentation into a perl string. See
1394<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details. 1586<a href="#item_row_t"><code>$term-&gt;ROW_t</code></a> for details.
1395</dd> 1587</dd>
1396<p></p> 1588<p></p>
1397<dt><strong><a name="item_grab_button">$success = $term-&gt;grab_button ($button, $modifiermask)</a></strong><br /> 1589<dt><strong><a name="item_grab_button">$success = $term-&gt;grab_button ($button, $modifiermask[, $window = $term-&gt;vt])</a></strong><br />
1398</dt> 1590</dt>
1591<dt><strong><a name="item_ungrab_button">$term-&gt;ungrab_button ($button, $modifiermask[, $window = $term-&gt;vt])</a></strong><br />
1592</dt>
1399<dd> 1593<dd>
1400Registers a synchronous button grab. See the XGrabButton manpage. 1594Register/unregister a synchronous button grab. See the XGrabButton
1595manpage.
1401</dd> 1596</dd>
1402<p></p> 1597<p></p>
1403<dt><strong><a name="item_grab">$success = $term-&gt;grab ($eventtime[, $sync])</a></strong><br /> 1598<dt><strong><a name="item_grab">$success = $term-&gt;grab ($eventtime[, $sync])</a></strong><br />
1404</dt> 1599</dt>
1405<dd> 1600<dd>
… …
1431<dd> 1626<dd>
1432Calls XUngrab for the most recent grab. Is called automatically on 1627Calls XUngrab for the most recent grab. Is called automatically on
1433evaluation errors, as it is better to lose the grab in the error case as 1628evaluation errors, as it is better to lose the grab in the error case as
1434the session. 1629the session.
1435</dd> 1630</dd>
1631<p></p>
1632<dt><strong><a name="item_xinternatom">$atom = $term-&gt;XInternAtom ($atom_name[, $only_if_exists])</a></strong><br />
1633</dt>
1634<dt><strong><a name="item_xgetatomname">$atom_name = $term-&gt;XGetAtomName ($atom)</a></strong><br />
1635</dt>
1636<dt><strong><a name="item_xlistproperties">@atoms = $term-&gt;XListProperties ($window)</a></strong><br />
1637</dt>
1638<dt><strong><a name="item_xgetwindowproperty">($type,$format,$octets) = $term-&gt;XGetWindowProperty ($window, $property)</a></strong><br />
1639</dt>
1640<dt><strong><a name="item_xchangewindowproperty">$term-&gt;XChangeWindowProperty ($window, $property, $type, $format, $octets)</a></strong><br />
1641</dt>
1642<dt><strong><a name="item_xdeleteproperty">$term-&gt;XDeleteProperty ($window, $property)</a></strong><br />
1643</dt>
1644<dt><strong><a name="item_defaultrootwindow">$window = $term-&gt;DefaultRootWindow</a></strong><br />
1645</dt>
1646<dt><strong><a name="item_xreparentwindow">$term-&gt;XReparentWindow ($window, $parent, [$x, $y])</a></strong><br />
1647</dt>
1648<dt><strong><a name="item_xmapwindow">$term-&gt;XMapWindow ($window)</a></strong><br />
1649</dt>
1650<dt><strong><a name="item_xunmapwindow">$term-&gt;XUnmapWindow ($window)</a></strong><br />
1651</dt>
1652<dt><strong><a name="item_xmoveresizewindow">$term-&gt;XMoveResizeWindow ($window, $x, $y, $width, $height)</a></strong><br />
1653</dt>
1654<dt><strong><a name="item_xtranslatecoordinates">($x, $y, $child_window) = $term-&gt;XTranslateCoordinates ($src, $dst, $x, $y)</a></strong><br />
1655</dt>
1656<dt><strong><a name="item_xchangeinput">$term-&gt;XChangeInput ($window, $add_events[, $del_events])</a></strong><br />
1657</dt>
1658<dd>
1659Various X or X-related functions. The <code>$term</code> object only serves as
1660the source of the display, otherwise those functions map more-or-less
1661directory onto the X functions of the same name.
1662</dd>
1436<p></p></dl> 1663<p></p></dl>
1437<p> 1664<p>
1438</p> 1665</p>
1439<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2> 1666<h2><a name="the_urxvt__popup_class">The <code>urxvt::popup</code> Class</a></h2>
1440<dl> 1667<dl>
… …
1455<dd> 1682<dd>
1456Adds a clickable button to the popup. <code>$cb</code> is called whenever it is 1683Adds a clickable button to the popup. <code>$cb</code> is called whenever it is
1457selected. 1684selected.
1458</dd> 1685</dd>
1459<p></p> 1686<p></p>
1460<dt><strong><a name="item_add_toggle">$popup-&gt;add_toggle ($text, $cb, $initial_value)</a></strong><br /> 1687<dt><strong><a name="item_add_toggle">$popup-&gt;add_toggle ($text, $initial_value, $cb)</a></strong><br />
1461</dt> 1688</dt>
1462<dd> 1689<dd>
1463Adds a toggle/checkbox item to the popup. Teh callback gets called 1690Adds a toggle/checkbox item to the popup. The callback gets called
1464whenever it gets toggled, with a boolean indicating its value as its first 1691whenever it gets toggled, with a boolean indicating its new value as its
1465argument. 1692first argument.
1466</dd> 1693</dd>
1467<p></p> 1694<p></p>
1468<dt><strong>$popup-&gt;show</strong><br /> 1695<dt><strong>$popup-&gt;show</strong><br />
1469</dt> 1696</dt>
1470<dd> 1697<dd>

Diff Legend

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