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.23 by root, Wed Jan 11 01:01:52 2006 UTC

… …
183<dl> 183<dl>
184<dt><strong><a name="item__24text">$text</a></strong><br /> 184<dt><strong><a name="item__24text">$text</a></strong><br />
185</dt> 185</dt>
186<dd> 186<dd>
187Rxvt-unicodes special way of encoding text, where one ``unicode'' character 187Rxvt-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. 188always represents one screen cell. See <a href="#item_row_t">ROW_t</a> for a discussion of this format.
189</dd> 189</dd>
190<p></p> 190<p></p>
191<dt><strong><a name="item__24string">$string</a></strong><br /> 191<dt><strong><a name="item__24string">$string</a></strong><br />
192</dt> 192</dt>
193<dd> 193<dd>
… …
476</dt> 476</dt>
477<dd> 477<dd>
478The current terminal. This variable stores the current <code>urxvt::term</code> 478The current terminal. This variable stores the current <code>urxvt::term</code>
479object, whenever a callback/hook is executing. 479object, whenever a callback/hook is executing.
480</dd> 480</dd>
481<p></p> 481<p></p></dl>
482<dt></dt>
483</dl>
484<p> 482<p>
485</p> 483</p>
486<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> 484<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2>
487<dl> 485<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 /> 486<dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br />
499</dt> 487</dt>
500<dd> 488<dd>
501Fatally aborts execution with the given error message. Avoid at all 489Fatally aborts execution with the given error message. Avoid at all
502costs! The only time this is acceptable is when the terminal process 490costs! The only time this is acceptable is when the terminal process
… …
511that calls this function. 499that calls this function.
512</dd> 500</dd>
513<dd> 501<dd>
514<p>Using this function has the advantage that its output ends up in the 502<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> 503correct place, e.g. on stderr of the connecting urxvtc client.</p>
504</dd>
505<dd>
506<p>Messages have a size limit of 1023 bytes currently.</p>
516</dd> 507</dd>
517<p></p> 508<p></p>
518<dt><strong><a name="item__24is_safe__3d_urxvt_3a_3asafe">$is_safe = urxvt::safe</a></strong><br /> 509<dt><strong><a name="item__24is_safe__3d_urxvt_3a_3asafe">$is_safe = urxvt::safe</a></strong><br />
519</dt> 510</dt>
520<dd> 511<dd>
… …
612work.</p> 603work.</p>
613<p> 604<p>
614</p> 605</p>
615<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> 606<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2>
616<dl> 607<dl>
608<dt><strong><a name="item__24term__3d_new_urxvt_3a_3aterm__24envhashref_2c__">$term = new urxvt::term $envhashref, $rxvtname, [arg...]</a></strong><br />
609</dt>
610<dd>
611Creates a new terminal, very similar as if you had started it with system
612<code>$rxvtname, arg...</code>. <code>$envhashref</code> must be a reference to a <code>%ENV</code>-like
613hash which defines the environment of the new terminal.
614</dd>
615<dd>
616<p>Croaks (and probably outputs an error message) if the new instance
617couldn't be created. Returns <code>undef</code> if the new instance didn't
618initialise perl, and the terminal object otherwise. The <code>init</code> and
619<a href="#item_start"><code>start</code></a> hooks will be called during this call.</p>
620</dd>
621<p></p>
617<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br /> 622<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br />
618</dt> 623</dt>
619<dd> 624<dd>
620Destroy the terminal object (close the window, free resources 625Destroy the terminal object (close the window, free resources
621etc.). Please note that rxvt will not exit as long as any event 626etc.). Please note that rxvt will not exit as long as any event
… …
906</dt> 911</dt>
907<dd> 912<dd>
908Return various integers describing terminal characteristics. 913Return various integers describing terminal characteristics.
909</dd> 914</dd>
910<p></p> 915<p></p>
916<dt><strong><a name="item_display_id">$x_display = $term-&gt;display_id</a></strong><br />
917</dt>
918<dd>
919Return the DISPLAY used by rxvt-unicode.
920</dd>
921<p></p>
911<dt><strong><a name="item_locale">$lc_ctype = $term-&gt;locale</a></strong><br /> 922<dt><strong><a name="item_locale">$lc_ctype = $term-&gt;locale</a></strong><br />
912</dt> 923</dt>
913<dd> 924<dd>
914Returns the LC_CTYPE category string used by this rxvt-unicode. 925Returns the LC_CTYPE category string used by this rxvt-unicode.
915</dd> 926</dd>
916<p></p> 927<p></p>
917<dt><strong><a name="item_display_id">$x_display = $term-&gt;display_id</a></strong><br /> 928<dt><strong><a name="item_env">$env = $term-&gt;env</a></strong><br />
918</dt> 929</dt>
919<dd> 930<dd>
920Return the DISPLAY used by rxvt-unicode. 931Returns a copy of the environment in effect for the terminal as a hashref
932similar to <code>\%ENV</code>.
921</dd> 933</dd>
922<p></p> 934<p></p>
923<dt><strong><a name="item_modlevel3mask">$modifiermask = $term-&gt;ModLevel3Mask</a></strong><br /> 935<dt><strong><a name="item_modlevel3mask">$modifiermask = $term-&gt;ModLevel3Mask</a></strong><br />
924</dt> 936</dt>
925<dt><strong><a name="item_modmetamask">$modifiermask = $term-&gt;ModMetaMask</a></strong><br /> 937<dt><strong><a name="item_modmetamask">$modifiermask = $term-&gt;ModMetaMask</a></strong><br />

Diff Legend

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