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.11 by root, Fri Feb 11 18:14:07 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.0</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__2dxrm_resourcestring"><strong>-xrm</strong> <em>resourcestring</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>
525Tells rxvt to embed it's windows into an already-existing window,
526which enables applications to easily embed a terminal.
524<dd> 527</dd>
525No effect on rxvt-unicode. Simply passes through an argument to be made 528<dd>
526available in the instance's argument list. Appears in <em>WM_COMMAND</em> in 529<p>Right now, rxvt will first unmap/map the specified window, so it
527some window managers. 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
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>
536</dd>
537<dd>
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
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
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>
528</dd> 591</dd>
529<p></p></dl> 592<p></p></dl>
530<p> 593<p>
531</p> 594</p>
532<hr /> 595<hr />
… …
699<p></p> 762<p></p>
700<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 />
701</dt> 764</dt>
702<dd> 765<dd>
703Use the specified colour for the scrollbar's trough area [default 766Use the specified colour for the scrollbar's trough area [default
704#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 767#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
705</dd> 768</dd>
706<p></p> 769<p></p>
707<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 />
708</dt> 771</dt>
709<dd> 772<dd>
… …
829<p></p> 892<p></p>
830<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 />
831</dt> 894</dt>
832<dd> 895<dd>
833Set 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
834the author's favourite.. 897the author's favourite.
835</dd> 898</dd>
836<p></p> 899<p></p>
837<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 />
838</dt> 901</dt>
839<dd> 902<dd>
… …
926<p></p> 989<p></p>
927<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 />
928</dt> 991</dt>
929<dd> 992<dd>
930<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
931<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
932with scrollback buffer when tty recieves new lines; option <strong>-sw</strong>. 995with scrollback buffer when tty recieves new lines; option <strong>+sw</strong>.
933</dd> 996</dd>
934<p></p> 997<p></p>
935<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 />
936</dt> 999</dt>
937<dd> 1000<dd>
… …
1032</dd> 1095</dd>
1033<p></p> 1096<p></p>
1034<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 />
1035</dt> 1098</dt>
1036<dd> 1099<dd>
1037Specifies 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.
1038</dd> 1102</dd>
1039<p></p> 1103<p></p>
1040<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 />
1041</dt> 1105</dt>
1042<dd> 1106<dd>
… …
1217when Control-Meta-c is being pressed'':</p> 1281when Control-Meta-c is being pressed'':</p>
1218</dd> 1282</dd>
1219<dd> 1283<dd>
1220<pre> 1284<pre>
1221 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>
1222</dd> 1310</dd>
1223<dd> 1311<dd>
1224<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
1225the 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
1226font-switching at runtime:</p> 1314font-switching at runtime:</p>
… …
1441Set to a string of the form <code>fg;bg</code> or <code>fg;xpm;bg</code>, where <code>fg</code> is 1529Set to a string of the form <code>fg;bg</code> or <code>fg;xpm;bg</code>, where <code>fg</code> is
1442the colour code used as default foreground/text colour (or the string 1530the colour code used as default foreground/text colour (or the string
1443<code>default</code> to indicate that the default-colour escape sequence is to be 1531<code>default</code> to indicate that the default-colour escape sequence is to be
1444used), <code>bg</code> is the colour code used as default background colour (or the 1532used), <code>bg</code> is the colour code used as default background colour (or the
1445string <code>default</code>), and <code>xpm</code> is the string <code>default</code> if rxvt 1533string <code>default</code>), and <code>xpm</code> is the string <code>default</code> if rxvt
1446was compiled with XPM support. Libraries like <code>slang</code> can (and do) use 1534was compiled with XPM support. Libraries like <code>ncurses</code> and <code>slang</code> can
1447this information to optimize screen output. 1535(and do) use this information to optimize screen output.
1448</dd> 1536</dd>
1449<p></p> 1537<p></p>
1450<dt><strong><a name="item_windowid"><strong>WINDOWID</strong></a></strong><br /> 1538<dt><strong><a name="item_windowid"><strong>WINDOWID</strong></a></strong><br />
1451</dt> 1539</dt>
1452<dd> 1540<dd>
… …
1548<h1><a name="current_project_coordinator">CURRENT PROJECT COORDINATOR</a></h1> 1636<h1><a name="current_project_coordinator">CURRENT PROJECT COORDINATOR</a></h1>
1549<dl> 1637<dl>
1550<dt><strong><a name="item_project_coordinator">Project Coordinator</a></strong><br /> 1638<dt><strong><a name="item_project_coordinator">Project Coordinator</a></strong><br />
1551</dt> 1639</dt>
1552<dd> 1640<dd>
1553Marc A. Lehmann <em><a href="mailto:rxvt@schmorp.de">rxvt@schmorp.de</a></em> 1641Marc A. Lehmann <em><a href="mailto:<rxvt-unicode@schmorp.de"><rxvt-unicode@schmorp.de</a></em>&gt;
1554</dd>
1555<dd> 1642</dd>
1643<dd>
1556<p><a href="http://software.schmorp.de/">http://software.schmorp.de/</a></p> 1644<p><a href="http://software.schmorp.de/#rxvt-unicode">http://software.schmorp.de/#rxvt-unicode</a></p>
1557</dd> 1645</dd>
1558<p></p></dl> 1646<p></p></dl>
1559<p> 1647<p>
1560</p> 1648</p>
1561<hr /> 1649<hr />
… …
1599<dd> 1687<dd>
1600Rewrote screen display and text selection routines. Project Coordinator 1688Rewrote screen display and text selection routines. Project Coordinator
1601(changes.txt 2.4.6 - rxvt-unicode) 1689(changes.txt 2.4.6 - rxvt-unicode)
1602</dd> 1690</dd>
1603<p></p> 1691<p></p>
1604<dt><strong><a name="item_marc_alexander_lehmann__3crxvt_40schmorp_2ede_3e">Marc Alexander Lehmann <em><a href="mailto:<rxvt@schmorp.de"><rxvt@schmorp.de</a></em>&gt;</a></strong><br /> 1692<dt><strong><a name="item_marc_alexander_lehmann__3crxvt_2dunicode_40schmorp">Marc Alexander Lehmann <em><a href="mailto:<rxvt-unicode@schmorp.de"><rxvt-unicode@schmorp.de</a></em>&gt;</a></strong><br />
1605</dt> 1693</dt>
1606<dd> 1694<dd>
1607Forked rxvt-unicode, rewrote most of the display code and internal 1695Forked rxvt-unicode, rewrote most of the display code and internal
1608character handling to store text in unicode, improve xterm 1696character handling to store text in unicode, improve xterm
1609compatibility and apply numerous other bugfixes and extensions. 1697compatibility and apply numerous other bugfixes and extensions.

Diff Legend

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