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.22 by root, Sat Jun 18 11:01:41 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.5</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>
… …
336</dd> 336</dd>
337<p></p> 337<p></p>
338<dt><strong><a name="item__2dst_7c_2bst"><strong>-st</strong>|<strong>+st</strong></a></strong><br /> 338<dt><strong><a name="item__2dst_7c_2bst"><strong>-st</strong>|<strong>+st</strong></a></strong><br />
339</dt> 339</dt>
340<dd> 340<dd>
341Display normal (non XTerm/NeXT) scrollbar without/with a trough; 341Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
342resource <strong>scrollBar_floating</strong>. 342resource <strong>scrollBar_floating</strong>.
343</dd> 343</dd>
344<p></p> 344<p></p>
345<dt><strong><a name="item__2dptab_7c_2bptab"><strong>-ptab</strong>|<strong>+ptab</strong></a></strong><br /> 345<dt><strong><a name="item__2dptab_7c_2bptab"><strong>-ptab</strong>|<strong>+ptab</strong></a></strong><br />
346</dt> 346</dt>
… …
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::Socket;
551 $rxvt-&gt;signal_connect_after (realize =&gt; sub {
552 my $xid = $_[0]-&gt;window-&gt;get_xid;
553 system &quot;rxvt -embed $xid &amp;&quot;;
554 });</pre>
555</dd>
556<p></p>
557<dt><strong><a name="item__2dpty_2dfd_fileno"><strong>-pty-fd</strong> <em>fileno</em></a></strong><br />
558</dt>
559<dd>
560Tells rxvt NOT to execute any commands or create a new pty/tty
561pair but instead use the given filehandle as the tty master. This is
562useful if you want to drive rxvt as a generic terminal emulator
563without having to run a program within it.
564</dd>
565<dd>
566<p>If this switch is given, rxvt will not create any utmp/wtmp
567entries and will not tinker with pty/tty permissions - you have to do that
568yourself if you want that.</p>
569</dd>
570<dd>
571<p>Here is a example in perl that illustrates how this option can be used (a
572longer example is in <em>doc/pty-fd</em>):</p>
573</dd>
574<dd>
575<pre>
576 use IO::Pty;
577 use Fcntl;</pre>
578</dd>
579<dd>
580<pre>
581 my $pty = new IO::Pty;
582 fcntl $pty, F_SETFD, 0; # clear close-on-exec
583 system &quot;rxvt -pty-fd &quot; . (fileno $pty) . &quot;&amp;&quot;;
584 close $pty;</pre>
585</dd>
586<dd>
587<pre>
588 # now communicate with rxvt
589 my $slave = $pty-&gt;slave;
590 while (&lt;$slave&gt;) { print $slave &quot;got &lt;$_&gt;\n&quot; }</pre>
540</dd> 591</dd>
541<p></p></dl> 592<p></p></dl>
542<p> 593<p>
543</p> 594</p>
544<hr /> 595<hr />
… …
711<p></p> 762<p></p>
712<dt><strong><a name="item_troughcolor_3a_colour"><strong>troughColor:</strong> <em>colour</em></a></strong><br /> 763<dt><strong><a name="item_troughcolor_3a_colour"><strong>troughColor:</strong> <em>colour</em></a></strong><br />
713</dt> 764</dt>
714<dd> 765<dd>
715Use the specified colour for the scrollbar's trough area [default 766Use the specified colour for the scrollbar's trough area [default
716#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 767#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
717</dd> 768</dd>
718<p></p> 769<p></p>
719<dt><strong><a name="item_bordercolor_3a_colour"><strong>borderColor:</strong> <em>colour</em></a></strong><br /> 770<dt><strong><a name="item_bordercolor_3a_colour"><strong>borderColor:</strong> <em>colour</em></a></strong><br />
720</dt> 771</dt>
721<dd> 772<dd>
… …
841<p></p> 892<p></p>
842<dt><strong><a name="item_scrollstyle_3a_mode"><strong>scrollstyle:</strong> <em>mode</em></a></strong><br /> 893<dt><strong><a name="item_scrollstyle_3a_mode"><strong>scrollstyle:</strong> <em>mode</em></a></strong><br />
843</dt> 894</dt>
844<dd> 895<dd>
845Set scrollbar style to <strong>rxvt</strong>, <strong>plain</strong>, <strong>next</strong> or <strong>xterm</strong>. <strong>plain</strong> is 896Set scrollbar style to <strong>rxvt</strong>, <strong>plain</strong>, <strong>next</strong> or <strong>xterm</strong>. <strong>plain</strong> is
846the author's favourite.. 897the author's favourite.
847</dd> 898</dd>
848<p></p> 899<p></p>
849<dt><strong><a name="item_title_3a_string"><strong>title:</strong> <em>string</em></a></strong><br /> 900<dt><strong><a name="item_title_3a_string"><strong>title:</strong> <em>string</em></a></strong><br />
850</dt> 901</dt>
851<dd> 902<dd>
… …
938<p></p> 989<p></p>
939<dt><strong><a name="item_scrollwithbuffer_3a_boolean"><strong>scrollWithBuffer:</strong> <em>boolean</em></a></strong><br /> 990<dt><strong><a name="item_scrollwithbuffer_3a_boolean"><strong>scrollWithBuffer:</strong> <em>boolean</em></a></strong><br />
940</dt> 991</dt>
941<dd> 992<dd>
942<strong>True</strong>: scroll with scrollback buffer when tty receives new lines (and 993<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 994<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>. 995with scrollback buffer when tty recieves new lines; option <strong>+sw</strong>.
945</dd> 996</dd>
946<p></p> 997<p></p>
947<dt><strong><a name="item_scrollttykeypress_3a_boolean"><strong>scrollTtyKeypress:</strong> <em>boolean</em></a></strong><br /> 998<dt><strong><a name="item_scrollttykeypress_3a_boolean"><strong>scrollTtyKeypress:</strong> <em>boolean</em></a></strong><br />
948</dt> 999</dt>
949<dd> 1000<dd>
… …
1044</dd> 1095</dd>
1045<p></p> 1096<p></p>
1046<dt><strong><a name="item_pointerblankdelay_3a_number"><strong>pointerBlankDelay:</strong> <em>number</em></a></strong><br /> 1097<dt><strong><a name="item_pointerblankdelay_3a_number"><strong>pointerBlankDelay:</strong> <em>number</em></a></strong><br />
1047</dt> 1098</dt>
1048<dd> 1099<dd>
1049Specifies number of seconds before blanking the pointer [default 2]. 1100Specifies number of seconds before blanking the pointer [default 2]. Use a
1101large number (e.g. <code>987654321</code>) to effectively disable the timeout.
1050</dd> 1102</dd>
1051<p></p> 1103<p></p>
1052<dt><strong><a name="item_backspacekey_3a_string"><strong>backspacekey:</strong> <em>string</em></a></strong><br /> 1104<dt><strong><a name="item_backspacekey_3a_string"><strong>backspacekey:</strong> <em>string</em></a></strong><br />
1053</dt> 1105</dt>
1054<dd> 1106<dd>
… …
1229when Control-Meta-c is being pressed'':</p> 1281when Control-Meta-c is being pressed'':</p>
1230</dd> 1282</dd>
1231<dd> 1283<dd>
1232<pre> 1284<pre>
1233 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007</pre> 1285 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007</pre>
1286</dd>
1287<dd>
1288<p>Due the the large number of modifier combinations, a defined key mapping
1289will match if at <em>at least</em> the specified identifiers are being set, and
1290no other key mappings with those and more bits are being defined. That
1291means that defining a key map for <code>a</code> will automatically provide
1292definitions for <code>Meta-a</code>, <code>Shift-a</code> and so on, unless some of those are defined
1293mappings themselves.</p>
1294</dd>
1295<dd>
1296<p>Unfortunately, this will override built-in key mappings. For example
1297if you overwrite the <code>Insert</code> key you will disable rxvt's
1298<code>Shift-Insert</code> mapping. To re-enable that, you can poke ``holes'' into the
1299user-defined keymap using the <code>builtin:</code> replacement:</p>
1300</dd>
1301<dd>
1302<pre>
1303 URxvt.keysym.Insert: &lt;my insert key sequence&gt;
1304 URxvt.keysym.S-Insert: builtin:</pre>
1305</dd>
1306<dd>
1307<p>The first line defines a mapping for <code>Insert</code> and <em>any</em> combination
1308of modifiers. The second line re-establishes the default mapping for
1309<code>Shift-Insert</code>.</p>
1234</dd> 1310</dd>
1235<dd> 1311<dd>
1236<p>The following example will map Control-Meta-1 and Control-Meta-2 to 1312<p>The following example will map Control-Meta-1 and Control-Meta-2 to
1237the fonts <code>suxuseuro</code> and <code>9x15bold</code>, so you can have some limited 1313the fonts <code>suxuseuro</code> and <code>9x15bold</code>, so you can have some limited
1238font-switching at runtime:</p> 1314font-switching at runtime:</p>

Diff Legend

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