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

Comparing rxvt-unicode/doc/rxvt.1.html (file contents):
Revision 1.14 by root, Mon Feb 14 18:47:54 2005 UTC vs.
Revision 1.17 by root, Thu Feb 17 15:07:48 2005 UTC

47<p><strong>rxvt</strong> [options] [-e command [ args ]]</p> 47<p><strong>rxvt</strong> [options] [-e command [ args ]]</p>
48<p> 48<p>
49</p> 49</p>
50<hr /> 50<hr />
51<h1><a name="description">DESCRIPTION</a></h1> 51<h1><a name="description">DESCRIPTION</a></h1>
52<p><strong>rxvt-unicode</strong>, version <strong>5.1</strong>, is a colour vt102 terminal 52<p><strong>rxvt-unicode</strong>, version <strong>5.2</strong>, is a colour vt102 terminal
53emulator intended as an <em>xterm</em>(1) replacement for users who do not 53emulator intended as an <em>xterm</em>(1) replacement for users who do not
54require features such as Tektronix 4014 emulation and toolkit-style 54require features such as Tektronix 4014 emulation and toolkit-style
55configurability. As a result, <strong>rxvt-unicode</strong> uses much less swap space -- 55configurability. As a result, <strong>rxvt-unicode</strong> uses much less swap space --
56a significant advantage on a machine serving many X sessions.</p> 56a significant advantage on a machine serving many X sessions.</p>
57<p> 57<p>
511<dd> 511<dd>
512Turn on/off secondary screen scroll (default enabled); resource 512Turn on/off secondary screen scroll (default enabled); resource
513<strong>secondaryScroll</strong>. 513<strong>secondaryScroll</strong>.
514</dd> 514</dd>
515<p></p> 515<p></p>
516<dt><strong><a name="item__2dkeysym_2esym_3a_string"><strong>-keysym.</strong><em>sym</em>: <em>string</em></a></strong><br /> 516<dt><strong><a name="item__2dkeysym_2esym_string"><strong>-keysym.</strong><em>sym</em> <em>string</em></a></strong><br />
517</dt> 517</dt>
518<dd> 518<dd>
519Remap a key symbol. See resource <strong>keysym</strong>. 519Remap a key symbol. See resource <strong>keysym</strong>.
520</dd> 520</dd>
521<p></p> 521<p></p>
522<dt><strong><a name="item__2dembed_3a_windowid"><strong>-embed</strong>: <em>windowid</em></a></strong><br /> 522<dt><strong><a name="item__2dembed_windowid"><strong>-embed</strong> <em>windowid</em></a></strong><br />
523</dt> 523</dt>
524<dd> 524<dd>
525Tells rxvt to embed it's windows into an already-existing window, 525Tells rxvt to embed it's windows into an already-existing window,
526which enables applications to easily embed a terminal. 526which enables applications to easily embed a terminal.
527</dd> 527</dd>
528<dd> 528<dd>
529<p>Right now, rxvt will first unmap/map the specified window, so it 529<p>Right now, rxvt will first unmap/map the specified window, so it
530shouldn't be a top-level window. rxvt will also reconfigure it 530shouldn't be a top-level window. rxvt will also reconfigure it
531quite a bit, so don't expect it to keep some specific state. It's best to 531quite a bit, so don't expect it to keep some specific state. It's best to
532create an extra subwindow for rxvt and leave it alone.</p> 532create an extra subwindow for rxvt and leave it alone.</p>
533</dd>
534<dd>
535<p>The window will not be destroyed when rxvt exits.</p>
533</dd> 536</dd>
534<dd> 537<dd>
535<p>It might be useful to know that rxvt will not close file 538<p>It might be useful to know that rxvt will not close file
536descriptors passed to it (except for stdin/out/err, of course), so you 539descriptors passed to it (except for stdin/out/err, of course), so you
537can use file descriptors to communicate with the programs within the 540can use file descriptors to communicate with the programs within the
538terminal. This works regardless of wether the <code>-embed</code> option was used or 541terminal. This works regardless of wether the <code>-embed</code> option was used or
539not.</p> 542not.</p>
543</dd>
544<dd>
545<p>Here is a short Gtk2-perl snippet that illustrates how this option can be
546used (a longer example is in <em>doc/embed</em>):</p>
547</dd>
548<dd>
549<pre>
550 my $rxvt = new Gtk2::DrawingArea;
551 $...-&gt;add ($rxvt); # important to add it somewhere first
552 $rxvt-&gt;realize; # now it can be realized
553 my $xid = $rxvt-&gt;window-&gt;get_xid;</pre>
554</dd>
555<dd>
556<pre>
557 system &quot;rxvt -embed $xid &amp;&quot;;</pre>
558</dd>
559<p></p>
560<dt><strong><a name="item__2dpty_2dfd_fileno"><strong>-pty-fd</strong> <em>fileno</em></a></strong><br />
561</dt>
562<dd>
563Tells rxvt NOT to execute any commands or create a new pty/tty
564pair but instead use the given filehandle as the tty master. This is
565useful if you want to drive rxvt as a generic terminal emulator
566without having to run a program within it.
567</dd>
568<dd>
569<p>If this switch is given, rxvt will not create any utmp/wtmp
570entries and will not tinker with pty/tty permissions - you have to do that
571yourself if you want that.</p>
572</dd>
573<dd>
574<p>Here is a example in perl that illustrates how this option can be used (a
575longer example is in <em>doc/pty-fd</em>):</p>
576</dd>
577<dd>
578<pre>
579 use IO::Pty;
580 use Fcntl;</pre>
581</dd>
582<dd>
583<pre>
584 my $pty = new IO::Pty;
585 fcntl $pty, F_SETFD, 0; # clear close-on-exec</pre>
586</dd>
587<dd>
588<pre>
589 system &quot;rxvt -pty-fd &quot; . (fileno $pty) . &quot;&amp;&quot;;</pre>
590</dd>
591<dd>
592<pre>
593 # now communicate with rxvt
594 my $slave = $pty-&gt;slave;
595 while (&lt;$slave&gt;) { print $slave &quot;got &lt;$_&gt;\n&quot; }</pre>
540</dd> 596</dd>
541<p></p></dl> 597<p></p></dl>
542<p> 598<p>
543</p> 599</p>
544<hr /> 600<hr />
938<p></p> 994<p></p>
939<dt><strong><a name="item_scrollwithbuffer_3a_boolean"><strong>scrollWithBuffer:</strong> <em>boolean</em></a></strong><br /> 995<dt><strong><a name="item_scrollwithbuffer_3a_boolean"><strong>scrollWithBuffer:</strong> <em>boolean</em></a></strong><br />
940</dt> 996</dt>
941<dd> 997<dd>
942<strong>True</strong>: scroll with scrollback buffer when tty receives new lines (and 998<strong>True</strong>: scroll with scrollback buffer when tty receives new lines (and
943<strong>scrollTtyOutput</strong> is False); option <strong>+sw</strong>. <strong>False</strong>: do not scroll 999<strong>scrollTtyOutput</strong> is False); option <strong>-sw</strong>. <strong>False</strong>: do not scroll
944with scrollback buffer when tty recieves new lines; option <strong>-sw</strong>. 1000with scrollback buffer when tty recieves new lines; option <strong>+sw</strong>.
945</dd> 1001</dd>
946<p></p> 1002<p></p>
947<dt><strong><a name="item_scrollttykeypress_3a_boolean"><strong>scrollTtyKeypress:</strong> <em>boolean</em></a></strong><br /> 1003<dt><strong><a name="item_scrollttykeypress_3a_boolean"><strong>scrollTtyKeypress:</strong> <em>boolean</em></a></strong><br />
948</dt> 1004</dt>
949<dd> 1005<dd>

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines