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.24 by root, Wed Jan 11 02:13:56 2006 UTC

… …
141</dd> 141</dd>
142<p></p> 142<p></p>
143<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br /> 143<dt><strong><a name="item_mark_2durls">mark-urls</a></strong><br />
144</dt> 144</dt>
145<dd> 145<dd>
146Uses per-line display filtering (<code>on_line_update</code>) to underline urls. 146Uses per-line display filtering (<code>on_line_update</code>) to underline urls and
147make them clickable. When clicked, the program specified in the resource
148<code>urlLauncher</code> (default <code>x-www-browser</code>) will be started.
147</dd> 149</dd>
148<p></p> 150<p></p>
149<dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br /> 151<dt><strong><a name="item_block_2dgraphics_2dto_2dascii">block-graphics-to-ascii</a></strong><br />
150</dt> 152</dt>
151<dd> 153<dd>
… …
183<dl> 185<dl>
184<dt><strong><a name="item__24text">$text</a></strong><br /> 186<dt><strong><a name="item__24text">$text</a></strong><br />
185</dt> 187</dt>
186<dd> 188<dd>
187Rxvt-unicodes special way of encoding text, where one ``unicode'' character 189Rxvt-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. 190always represents one screen cell. See <a href="#item_row_t">ROW_t</a> for a discussion of this format.
189</dd> 191</dd>
190<p></p> 192<p></p>
191<dt><strong><a name="item__24string">$string</a></strong><br /> 193<dt><strong><a name="item__24string">$string</a></strong><br />
192</dt> 194</dt>
193<dd> 195<dd>
… …
476</dt> 478</dt>
477<dd> 479<dd>
478The current terminal. This variable stores the current <code>urxvt::term</code> 480The current terminal. This variable stores the current <code>urxvt::term</code>
479object, whenever a callback/hook is executing. 481object, whenever a callback/hook is executing.
480</dd> 482</dd>
481<p></p> 483<p></p></dl>
482<dt></dt>
483</dl>
484<p> 484<p>
485</p> 485</p>
486<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2> 486<h2><a name="functions_in_the_urxvt_package">Functions in the <code>urxvt</code> Package</a></h2>
487<dl> 487<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 /> 488<dt><strong><a name="item_urxvt_3a_3afatal__24errormessage">urxvt::fatal $errormessage</a></strong><br />
499</dt> 489</dt>
500<dd> 490<dd>
501Fatally aborts execution with the given error message. Avoid at all 491Fatally aborts execution with the given error message. Avoid at all
502costs! The only time this is acceptable is when the terminal process 492costs! The only time this is acceptable is when the terminal process
… …
511that calls this function. 501that calls this function.
512</dd> 502</dd>
513<dd> 503<dd>
514<p>Using this function has the advantage that its output ends up in the 504<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> 505correct place, e.g. on stderr of the connecting urxvtc client.</p>
506</dd>
507<dd>
508<p>Messages have a size limit of 1023 bytes currently.</p>
516</dd> 509</dd>
517<p></p> 510<p></p>
518<dt><strong><a name="item__24is_safe__3d_urxvt_3a_3asafe">$is_safe = urxvt::safe</a></strong><br /> 511<dt><strong><a name="item__24is_safe__3d_urxvt_3a_3asafe">$is_safe = urxvt::safe</a></strong><br />
519</dt> 512</dt>
520<dd> 513<dd>
… …
612work.</p> 605work.</p>
613<p> 606<p>
614</p> 607</p>
615<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2> 608<h2><a name="the_urxvt__term_class">The <code>urxvt::term</code> Class</a></h2>
616<dl> 609<dl>
610<dt><strong><a name="item__24term__3d_new_urxvt_3a_3aterm__24envhashref_2c__">$term = new urxvt::term $envhashref, $rxvtname, [arg...]</a></strong><br />
611</dt>
612<dd>
613Creates a new terminal, very similar as if you had started it with system
614<code>$rxvtname, arg...</code>. <code>$envhashref</code> must be a reference to a <code>%ENV</code>-like
615hash which defines the environment of the new terminal.
616</dd>
617<dd>
618<p>Croaks (and probably outputs an error message) if the new instance
619couldn't be created. Returns <code>undef</code> if the new instance didn't
620initialise perl, and the terminal object otherwise. The <code>init</code> and
621<a href="#item_start"><code>start</code></a> hooks will be called during this call.</p>
622</dd>
623<p></p>
617<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br /> 624<dt><strong><a name="item_destroy">$term-&gt;destroy</a></strong><br />
618</dt> 625</dt>
619<dd> 626<dd>
620Destroy the terminal object (close the window, free resources 627Destroy the terminal object (close the window, free resources
621etc.). Please note that rxvt will not exit as long as any event 628etc.). Please note that rxvt will not exit as long as any event
… …
683 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 690 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
684 shade term_name title transparent transparent_all tripleclickwords 691 shade term_name title transparent transparent_all tripleclickwords
685 utmpInhibit visualBell</pre> 692 utmpInhibit visualBell</pre>
686</dd> 693</dd>
687<p></p> 694<p></p>
695<dt><strong><a name="item_x_resource">$value = $term-&gt;x_resource ($pattern)</a></strong><br />
696</dt>
697<dd>
698Returns the X-Resource for the given pattern, excluding the program or
699class name, i.e. <a href="#item_x_resource"><code>$term-&gt;x_resource (&quot;boldFont&quot;)</code></a> should return the
700same value as used by this instance of rxvt-unicode. Returns <code>undef</code> if no
701resource with that pattern exists.
702</dd>
703<dd>
704<p>This method should only be called during the <code>on_start</code> hook, as there is
705only one resource database per display, and later invocations might return
706the wrong resources.</p>
707</dd>
708<p></p>
688<dt><strong><a name="item_parse_keysym">$success = $term-&gt;parse_keysym ($keysym_spec, $command_string)</a></strong><br /> 709<dt><strong><a name="item_parse_keysym">$success = $term-&gt;parse_keysym ($keysym_spec, $command_string)</a></strong><br />
689</dt> 710</dt>
690<dd> 711<dd>
691Adds a keymap translation exactly as specified via a resource. See the 712Adds a keymap translation exactly as specified via a resource. See the
692<code>keysym</code> resource in the <code>rxvt(1)</code> manpage. 713<code>keysym</code> resource in the <code>rxvt(1)</code> manpage.
… …
906</dt> 927</dt>
907<dd> 928<dd>
908Return various integers describing terminal characteristics. 929Return various integers describing terminal characteristics.
909</dd> 930</dd>
910<p></p> 931<p></p>
932<dt><strong><a name="item_display_id">$x_display = $term-&gt;display_id</a></strong><br />
933</dt>
934<dd>
935Return the DISPLAY used by rxvt-unicode.
936</dd>
937<p></p>
911<dt><strong><a name="item_locale">$lc_ctype = $term-&gt;locale</a></strong><br /> 938<dt><strong><a name="item_locale">$lc_ctype = $term-&gt;locale</a></strong><br />
912</dt> 939</dt>
913<dd> 940<dd>
914Returns the LC_CTYPE category string used by this rxvt-unicode. 941Returns the LC_CTYPE category string used by this rxvt-unicode.
915</dd> 942</dd>
916<p></p> 943<p></p>
917<dt><strong><a name="item_display_id">$x_display = $term-&gt;display_id</a></strong><br /> 944<dt><strong><a name="item_env">$env = $term-&gt;env</a></strong><br />
918</dt> 945</dt>
919<dd> 946<dd>
920Return the DISPLAY used by rxvt-unicode. 947Returns a copy of the environment in effect for the terminal as a hashref
948similar to <code>\%ENV</code>.
921</dd> 949</dd>
922<p></p> 950<p></p>
923<dt><strong><a name="item_modlevel3mask">$modifiermask = $term-&gt;ModLevel3Mask</a></strong><br /> 951<dt><strong><a name="item_modlevel3mask">$modifiermask = $term-&gt;ModLevel3Mask</a></strong><br />
924</dt> 952</dt>
925<dt><strong><a name="item_modmetamask">$modifiermask = $term-&gt;ModMetaMask</a></strong><br /> 953<dt><strong><a name="item_modmetamask">$modifiermask = $term-&gt;ModMetaMask</a></strong><br />

Diff Legend

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