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.15 by root, Mon Feb 14 18:50:56 2005 UTC vs.
Revision 1.23 by root, Thu Jul 7 19:37:46 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.6</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>
… …
538<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
539descriptors 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
540can use file descriptors to communicate with the programs within the 540can use file descriptors to communicate with the programs within the
541terminal. 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
542not.</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>
543</dd> 591</dd>
544<p></p></dl> 592<p></p></dl>
545<p> 593<p>
546</p> 594</p>
547<hr /> 595<hr />
… …
714<p></p> 762<p></p>
715<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 />
716</dt> 764</dt>
717<dd> 765<dd>
718Use the specified colour for the scrollbar's trough area [default 766Use the specified colour for the scrollbar's trough area [default
719#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 767#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
720</dd> 768</dd>
721<p></p> 769<p></p>
722<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 />
723</dt> 771</dt>
724<dd> 772<dd>
… …
844<p></p> 892<p></p>
845<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 />
846</dt> 894</dt>
847<dd> 895<dd>
848Set 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
849the author's favourite.. 897the author's favourite.
850</dd> 898</dd>
851<p></p> 899<p></p>
852<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 />
853</dt> 901</dt>
854<dd> 902<dd>
… …
900<dd> 948<dd>
901Specify a command pipe for vt100 printer [default <em>lpr(1)</em>]. Use 949Specify a command pipe for vt100 printer [default <em>lpr(1)</em>]. Use
902<strong>Print</strong> to initiate a screen dump to the printer and <strong>Ctrl-Print</strong> or 950<strong>Print</strong> to initiate a screen dump to the printer and <strong>Ctrl-Print</strong> or
903<strong>Shift-Print</strong> to include the scrollback as well. 951<strong>Shift-Print</strong> to include the scrollback as well.
904</dd> 952</dd>
953<dd>
954<p>The string will be interpreted as if typed into the shell as-is.</p>
955</dd>
956<dd>
957<p>Example:</p>
958</dd>
959<dd>
960<pre>
961 URxvt*print-pipe: cat &gt; $(TMPDIR=$HOME mktemp urxvt.XXXXXX)</pre>
962</dd>
963<dd>
964<p>This creates a new file in your home directory with the screen contents
965everytime you hit <code>Print</code>.</p>
966</dd>
905<p></p> 967<p></p>
906<dt><strong><a name="item_scrollbar_3a_boolean"><strong>scrollBar:</strong> <em>boolean</em></a></strong><br /> 968<dt><strong><a name="item_scrollbar_3a_boolean"><strong>scrollBar:</strong> <em>boolean</em></a></strong><br />
907</dt> 969</dt>
908<dd> 970<dd>
909<strong>True</strong>: enable the scrollbar [default]; option <strong>-sb</strong>. <strong>False</strong>: 971<strong>True</strong>: enable the scrollbar [default]; option <strong>-sb</strong>. <strong>False</strong>:
… …
941<p></p> 1003<p></p>
942<dt><strong><a name="item_scrollwithbuffer_3a_boolean"><strong>scrollWithBuffer:</strong> <em>boolean</em></a></strong><br /> 1004<dt><strong><a name="item_scrollwithbuffer_3a_boolean"><strong>scrollWithBuffer:</strong> <em>boolean</em></a></strong><br />
943</dt> 1005</dt>
944<dd> 1006<dd>
945<strong>True</strong>: scroll with scrollback buffer when tty receives new lines (and 1007<strong>True</strong>: scroll with scrollback buffer when tty receives new lines (and
946<strong>scrollTtyOutput</strong> is False); option <strong>+sw</strong>. <strong>False</strong>: do not scroll 1008<strong>scrollTtyOutput</strong> is False); option <strong>-sw</strong>. <strong>False</strong>: do not scroll
947with scrollback buffer when tty recieves new lines; option <strong>-sw</strong>. 1009with scrollback buffer when tty recieves new lines; option <strong>+sw</strong>.
948</dd> 1010</dd>
949<p></p> 1011<p></p>
950<dt><strong><a name="item_scrollttykeypress_3a_boolean"><strong>scrollTtyKeypress:</strong> <em>boolean</em></a></strong><br /> 1012<dt><strong><a name="item_scrollttykeypress_3a_boolean"><strong>scrollTtyKeypress:</strong> <em>boolean</em></a></strong><br />
951</dt> 1013</dt>
952<dd> 1014<dd>
… …
1047</dd> 1109</dd>
1048<p></p> 1110<p></p>
1049<dt><strong><a name="item_pointerblankdelay_3a_number"><strong>pointerBlankDelay:</strong> <em>number</em></a></strong><br /> 1111<dt><strong><a name="item_pointerblankdelay_3a_number"><strong>pointerBlankDelay:</strong> <em>number</em></a></strong><br />
1050</dt> 1112</dt>
1051<dd> 1113<dd>
1052Specifies number of seconds before blanking the pointer [default 2]. 1114Specifies number of seconds before blanking the pointer [default 2]. Use a
1115large number (e.g. <code>987654321</code>) to effectively disable the timeout.
1053</dd> 1116</dd>
1054<p></p> 1117<p></p>
1055<dt><strong><a name="item_backspacekey_3a_string"><strong>backspacekey:</strong> <em>string</em></a></strong><br /> 1118<dt><strong><a name="item_backspacekey_3a_string"><strong>backspacekey:</strong> <em>string</em></a></strong><br />
1056</dt> 1119</dt>
1057<dd> 1120<dd>
… …
1232when Control-Meta-c is being pressed'':</p> 1295when Control-Meta-c is being pressed'':</p>
1233</dd> 1296</dd>
1234<dd> 1297<dd>
1235<pre> 1298<pre>
1236 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007</pre> 1299 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007</pre>
1300</dd>
1301<dd>
1302<p>Due the the large number of modifier combinations, a defined key mapping
1303will match if at <em>at least</em> the specified identifiers are being set, and
1304no other key mappings with those and more bits are being defined. That
1305means that defining a key map for <code>a</code> will automatically provide
1306definitions for <code>Meta-a</code>, <code>Shift-a</code> and so on, unless some of those are defined
1307mappings themselves.</p>
1308</dd>
1309<dd>
1310<p>Unfortunately, this will override built-in key mappings. For example
1311if you overwrite the <code>Insert</code> key you will disable rxvt's
1312<code>Shift-Insert</code> mapping. To re-enable that, you can poke ``holes'' into the
1313user-defined keymap using the <code>builtin:</code> replacement:</p>
1314</dd>
1315<dd>
1316<pre>
1317 URxvt.keysym.Insert: &lt;my insert key sequence&gt;
1318 URxvt.keysym.S-Insert: builtin:</pre>
1319</dd>
1320<dd>
1321<p>The first line defines a mapping for <code>Insert</code> and <em>any</em> combination
1322of modifiers. The second line re-establishes the default mapping for
1323<code>Shift-Insert</code>.</p>
1237</dd> 1324</dd>
1238<dd> 1325<dd>
1239<p>The following example will map Control-Meta-1 and Control-Meta-2 to 1326<p>The following example will map Control-Meta-1 and Control-Meta-2 to
1240the fonts <code>suxuseuro</code> and <code>9x15bold</code>, so you can have some limited 1327the fonts <code>suxuseuro</code> and <code>9x15bold</code>, so you can have some limited
1241font-switching at runtime:</p> 1328font-switching at runtime:</p>
… …
1508<dd> 1595<dd>
1509The unix domain socket path used by <code>rxvtc(1)</code> and 1596The unix domain socket path used by <code>rxvtc(1)</code> and
1510rxvtd(1). 1597rxvtd(1).
1511</dd> 1598</dd>
1512<dd> 1599<dd>
1513<p>Default <code>$HOME/.rxvt-unicode-&lt;nodename</code>.</p> 1600<p>Default <em>$HOME/.rxvt-unicode-<em>&lt;nodename </em></em> &gt;&gt;&gt;.</p>
1514</dd> 1601</dd>
1515<p></p> 1602<p></p>
1516<dt><strong><a name="item_home"><strong>HOME</strong></a></strong><br /> 1603<dt><strong><a name="item_home"><strong>HOME</strong></a></strong><br />
1517</dt> 1604</dt>
1518<dd> 1605<dd>
… …
1547<p></p></dl> 1634<p></p></dl>
1548<p> 1635<p>
1549</p> 1636</p>
1550<hr /> 1637<hr />
1551<h1><a name="see_also">SEE ALSO</a></h1> 1638<h1><a name="see_also">SEE ALSO</a></h1>
1552<p>rxvt(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), <code>utmp(5)</code></p> 1639<p>rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), <code>utmp(5)</code></p>
1553<p> 1640<p>
1554</p> 1641</p>
1555<hr /> 1642<hr />
1556<h1><a name="bugs">BUGS</a></h1> 1643<h1><a name="bugs">BUGS</a></h1>
1557<p>Check the BUGS file for an up-to-date list.</p> 1644<p>Check the BUGS file for an up-to-date list.</p>

Diff Legend

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