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.25 by root, Tue Oct 25 20:22:39 2005 UTC

… …
27 <li><a href="#login_stamp">LOGIN STAMP</a></li> 27 <li><a href="#login_stamp">LOGIN STAMP</a></li>
28 <li><a href="#colors_and_graphics">COLORS AND GRAPHICS</a></li> 28 <li><a href="#colors_and_graphics">COLORS AND GRAPHICS</a></li>
29 <li><a href="#environment">ENVIRONMENT</a></li> 29 <li><a href="#environment">ENVIRONMENT</a></li>
30 <li><a href="#files">FILES</a></li> 30 <li><a href="#files">FILES</a></li>
31 <li><a href="#see_also">SEE ALSO</a></li> 31 <li><a href="#see_also">SEE ALSO</a></li>
32 <li><a href="#bugs">BUGS</a></li>
33 <li><a href="#current_project_coordinator">CURRENT PROJECT COORDINATOR</a></li> 32 <li><a href="#current_project_coordinator">CURRENT PROJECT COORDINATOR</a></li>
34 <li><a href="#authors">AUTHORS</a></li> 33 <li><a href="#authors">AUTHORS</a></li>
35</ul> 34</ul>
36<!-- INDEX END --> 35<!-- INDEX END -->
37 36
… …
47<p><strong>rxvt</strong> [options] [-e command [ args ]]</p> 46<p><strong>rxvt</strong> [options] [-e command [ args ]]</p>
48<p> 47<p>
49</p> 48</p>
50<hr /> 49<hr />
51<h1><a name="description">DESCRIPTION</a></h1> 50<h1><a name="description">DESCRIPTION</a></h1>
52<p><strong>rxvt-unicode</strong>, version <strong>5.1</strong>, is a colour vt102 terminal 51<p><strong>rxvt-unicode</strong>, version <strong>5.8</strong>, is a colour vt102 terminal
53emulator intended as an <em>xterm</em>(1) replacement for users who do not 52emulator intended as an <em>xterm</em>(1) replacement for users who do not
54require features such as Tektronix 4014 emulation and toolkit-style 53require features such as Tektronix 4014 emulation and toolkit-style
55configurability. As a result, <strong>rxvt-unicode</strong> uses much less swap space -- 54configurability. As a result, <strong>rxvt-unicode</strong> uses much less swap space --
56a significant advantage on a machine serving many X sessions.</p> 55a significant advantage on a machine serving many X sessions.</p>
57<p> 56<p>
… …
150</dt> 149</dt>
151<dd> 150<dd>
152Turn on/off jump scrolling; resource <strong>jumpScroll</strong>. 151Turn on/off jump scrolling; resource <strong>jumpScroll</strong>.
153</dd> 152</dd>
154<p></p> 153<p></p>
155<dt><strong><a name="item__2dip_7c_2bip"><strong>-ip</strong>|<strong>+ip</strong></a></strong><br /> 154<dt><strong><a name="item__2dip_7c_2bip__7c__2dtr_7c_2btr"><strong>-ip</strong>|<strong>+ip</strong> | <strong>-tr</strong>|<strong>+tr</strong></a></strong><br />
156</dt> 155</dt>
157<dd> 156<dd>
158Turn on/off inheriting parent window's pixmap. Alternative form is 157Turn on/off inheriting parent window's pixmap. Alternative form is
159<strong>-tr</strong>; resource <strong>inheritPixmap</strong>. 158<strong>-tr</strong>; resource <strong>inheritPixmap</strong>.
160</dd> 159</dd>
161<p></p> 160<p></p>
162<dt><strong><a name="item__2dfade_number"><strong>-fade</strong> <em>number</em></a></strong><br /> 161<dt><strong><a name="item__2dfade_number"><strong>-fade</strong> <em>number</em></a></strong><br />
163</dt> 162</dt>
164<dd> 163<dd>
165Fade the text by the given percentage when focus is lost. resource <strong>fading</strong>. 164Fade the text by the given percentage when focus is lost. Small values
165fade a little only, 100 completely replaces all colours by the fade
166colour; resource <strong>fading</strong>.
167</dd>
168<p></p>
169<dt><strong><a name="item__2dfadecolor_colour"><strong>-fadecolor</strong> <em>colour</em></a></strong><br />
170</dt>
171<dd>
172Fade to this colour when fading is used (see <strong>-fade</strong>). The default colour
173is black. resource <strong>fadeColor</strong>.
166</dd> 174</dd>
167<p></p> 175<p></p>
168<dt><strong><a name="item__2dtint_colour"><strong>-tint</strong> <em>colour</em></a></strong><br /> 176<dt><strong><a name="item__2dtint_colour"><strong>-tint</strong> <em>colour</em></a></strong><br />
169</dt> 177</dt>
170<dd> 178<dd>
171Tint the transparent background pixmap with the given colour when 179Tint the transparent background pixmap with the given colour when
172transparency is enabled with <strong>-tr</strong> or <strong>-ip</strong>. See also the <strong>-sh</strong> 180transparency is enabled with <strong>-tr</strong> or <strong>-ip</strong>. This only works for
173option that can be used to brighten or darken the image in addition to 181non-tiled backgrounds, currently. See also the <strong>-sh</strong> option that can be
174tinting it. 182used to brighten or darken the image in addition to tinting it; resource
183<em>tintColor</em>. Example:
184</dd>
185<dd>
186<pre>
187 rxvt -tr -tint blue -sh 40</pre>
175</dd> 188</dd>
176<p></p> 189<p></p>
177<dt><strong><a name="item__2dsh"><strong>-sh</strong></a></strong><br /> 190<dt><strong><a name="item__2dsh"><strong>-sh</strong></a></strong><br />
178</dt> 191</dt>
179<dd> 192<dd>
… …
336</dd> 349</dd>
337<p></p> 350<p></p>
338<dt><strong><a name="item__2dst_7c_2bst"><strong>-st</strong>|<strong>+st</strong></a></strong><br /> 351<dt><strong><a name="item__2dst_7c_2bst"><strong>-st</strong>|<strong>+st</strong></a></strong><br />
339</dt> 352</dt>
340<dd> 353<dd>
341Display normal (non XTerm/NeXT) scrollbar without/with a trough; 354Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
342resource <strong>scrollBar_floating</strong>. 355resource <strong>scrollBar_floating</strong>.
343</dd> 356</dd>
344<p></p> 357<p></p>
345<dt><strong><a name="item__2dptab_7c_2bptab"><strong>-ptab</strong>|<strong>+ptab</strong></a></strong><br /> 358<dt><strong><a name="item__2dptab_7c_2bptab"><strong>-ptab</strong>|<strong>+ptab</strong></a></strong><br />
346</dt> 359</dt>
… …
511<dd> 524<dd>
512Turn on/off secondary screen scroll (default enabled); resource 525Turn on/off secondary screen scroll (default enabled); resource
513<strong>secondaryScroll</strong>. 526<strong>secondaryScroll</strong>.
514</dd> 527</dd>
515<p></p> 528<p></p>
516<dt><strong><a name="item__2dkeysym_2esym_3a_string"><strong>-keysym.</strong><em>sym</em>: <em>string</em></a></strong><br /> 529<dt><strong><a name="item__2dkeysym_2esym_string"><strong>-keysym.</strong><em>sym</em> <em>string</em></a></strong><br />
517</dt> 530</dt>
518<dd> 531<dd>
519Remap a key symbol. See resource <strong>keysym</strong>. 532Remap a key symbol. See resource <strong>keysym</strong>.
520</dd> 533</dd>
521<p></p> 534<p></p>
522<dt><strong><a name="item__2dembed_3a_windowid"><strong>-embed</strong>: <em>windowid</em></a></strong><br /> 535<dt><strong><a name="item__2dembed_windowid"><strong>-embed</strong> <em>windowid</em></a></strong><br />
523</dt> 536</dt>
524<dd> 537<dd>
525Tells rxvt to embed it's windows into an already-existing window, 538Tells rxvt to embed it's windows into an already-existing window,
526which enables applications to easily embed a terminal. 539which enables applications to easily embed a terminal.
527</dd> 540</dd>
… …
538<p>It might be useful to know that rxvt will not close file 551<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 552descriptors passed to it (except for stdin/out/err, of course), so you
540can use file descriptors to communicate with the programs within the 553can use file descriptors to communicate with the programs within the
541terminal. This works regardless of wether the <code>-embed</code> option was used or 554terminal. This works regardless of wether the <code>-embed</code> option was used or
542not.</p> 555not.</p>
556</dd>
557<dd>
558<p>Here is a short Gtk2-perl snippet that illustrates how this option can be
559used (a longer example is in <em>doc/embed</em>):</p>
560</dd>
561<dd>
562<pre>
563 my $rxvt = new Gtk2::Socket;
564 $rxvt-&gt;signal_connect_after (realize =&gt; sub {
565 my $xid = $_[0]-&gt;window-&gt;get_xid;
566 system &quot;rxvt -embed $xid &amp;&quot;;
567 });</pre>
568</dd>
569<p></p>
570<dt><strong><a name="item__2dpty_2dfd_fileno"><strong>-pty-fd</strong> <em>fileno</em></a></strong><br />
571</dt>
572<dd>
573Tells rxvt NOT to execute any commands or create a new pty/tty
574pair but instead use the given filehandle as the tty master. This is
575useful if you want to drive rxvt as a generic terminal emulator
576without having to run a program within it.
577</dd>
578<dd>
579<p>If this switch is given, rxvt will not create any utmp/wtmp
580entries and will not tinker with pty/tty permissions - you have to do that
581yourself if you want that.</p>
582</dd>
583<dd>
584<p>Here is a example in perl that illustrates how this option can be used (a
585longer example is in <em>doc/pty-fd</em>):</p>
586</dd>
587<dd>
588<pre>
589 use IO::Pty;
590 use Fcntl;</pre>
591</dd>
592<dd>
593<pre>
594 my $pty = new IO::Pty;
595 fcntl $pty, F_SETFD, 0; # clear close-on-exec
596 system &quot;rxvt -pty-fd &quot; . (fileno $pty) . &quot;&amp;&quot;;
597 close $pty;</pre>
598</dd>
599<dd>
600<pre>
601 # now communicate with rxvt
602 my $slave = $pty-&gt;slave;
603 while (&lt;$slave&gt;) { print $slave &quot;got &lt;$_&gt;\n&quot; }</pre>
543</dd> 604</dd>
544<p></p></dl> 605<p></p></dl>
545<p> 606<p>
546</p> 607</p>
547<hr /> 608<hr />
… …
688</dd> 749</dd>
689<p></p> 750<p></p>
690<dt><strong><a name="item_fading_3a_number"><strong>fading:</strong> <em>number</em></a></strong><br /> 751<dt><strong><a name="item_fading_3a_number"><strong>fading:</strong> <em>number</em></a></strong><br />
691</dt> 752</dt>
692<dd> 753<dd>
693Fade the text by the given percentage when focus is lost. 754Fade the text by the given percentage when focus is lost; option <strong>-fade</strong>.
755</dd>
756<p></p>
757<dt><strong><a name="item_fadecolor_3a_colour"><strong>fadeColor:</strong> <em>colour</em></a></strong><br />
758</dt>
759<dd>
760Fade to this colour, when fading is used (see <strong>fading:</strong>). The default
761colour is black; option <strong>-fadecolor</strong>.
694</dd> 762</dd>
695<p></p> 763<p></p>
696<dt><strong><a name="item_tintcolor_3a_colour"><strong>tintColor:</strong> <em>colour</em></a></strong><br /> 764<dt><strong><a name="item_tintcolor_3a_colour"><strong>tintColor:</strong> <em>colour</em></a></strong><br />
697</dt> 765</dt>
698<dd> 766<dd>
699Tint the transparent background pixmap with the given colour. 767Tint the transparent background pixmap with the given colour; option
768<strong>-tint</strong>.
700</dd> 769</dd>
701<p></p> 770<p></p>
702<dt><strong><a name="item_shading_3a_number"><strong>shading:</strong> <em>number</em></a></strong><br /> 771<dt><strong><a name="item_shading_3a_number"><strong>shading:</strong> <em>number</em></a></strong><br />
703</dt> 772</dt>
704<dd> 773<dd>
… …
714<p></p> 783<p></p>
715<dt><strong><a name="item_troughcolor_3a_colour"><strong>troughColor:</strong> <em>colour</em></a></strong><br /> 784<dt><strong><a name="item_troughcolor_3a_colour"><strong>troughColor:</strong> <em>colour</em></a></strong><br />
716</dt> 785</dt>
717<dd> 786<dd>
718Use the specified colour for the scrollbar's trough area [default 787Use the specified colour for the scrollbar's trough area [default
719#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 788#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
720</dd> 789</dd>
721<p></p> 790<p></p>
722<dt><strong><a name="item_bordercolor_3a_colour"><strong>borderColor:</strong> <em>colour</em></a></strong><br /> 791<dt><strong><a name="item_bordercolor_3a_colour"><strong>borderColor:</strong> <em>colour</em></a></strong><br />
723</dt> 792</dt>
724<dd> 793<dd>
… …
844<p></p> 913<p></p>
845<dt><strong><a name="item_scrollstyle_3a_mode"><strong>scrollstyle:</strong> <em>mode</em></a></strong><br /> 914<dt><strong><a name="item_scrollstyle_3a_mode"><strong>scrollstyle:</strong> <em>mode</em></a></strong><br />
846</dt> 915</dt>
847<dd> 916<dd>
848Set scrollbar style to <strong>rxvt</strong>, <strong>plain</strong>, <strong>next</strong> or <strong>xterm</strong>. <strong>plain</strong> is 917Set scrollbar style to <strong>rxvt</strong>, <strong>plain</strong>, <strong>next</strong> or <strong>xterm</strong>. <strong>plain</strong> is
849the author's favourite.. 918the author's favourite.
850</dd> 919</dd>
851<p></p> 920<p></p>
852<dt><strong><a name="item_title_3a_string"><strong>title:</strong> <em>string</em></a></strong><br /> 921<dt><strong><a name="item_title_3a_string"><strong>title:</strong> <em>string</em></a></strong><br />
853</dt> 922</dt>
854<dd> 923<dd>
… …
900<dd> 969<dd>
901Specify a command pipe for vt100 printer [default <em>lpr(1)</em>]. Use 970Specify 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 971<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. 972<strong>Shift-Print</strong> to include the scrollback as well.
904</dd> 973</dd>
974<dd>
975<p>The string will be interpreted as if typed into the shell as-is.</p>
976</dd>
977<dd>
978<p>Example:</p>
979</dd>
980<dd>
981<pre>
982 URxvt*print-pipe: cat &gt; $(TMPDIR=$HOME mktemp urxvt.XXXXXX)</pre>
983</dd>
984<dd>
985<p>This creates a new file in your home directory with the screen contents
986everytime you hit <code>Print</code>.</p>
987</dd>
905<p></p> 988<p></p>
906<dt><strong><a name="item_scrollbar_3a_boolean"><strong>scrollBar:</strong> <em>boolean</em></a></strong><br /> 989<dt><strong><a name="item_scrollbar_3a_boolean"><strong>scrollBar:</strong> <em>boolean</em></a></strong><br />
907</dt> 990</dt>
908<dd> 991<dd>
909<strong>True</strong>: enable the scrollbar [default]; option <strong>-sb</strong>. <strong>False</strong>: 992<strong>True</strong>: enable the scrollbar [default]; option <strong>-sb</strong>. <strong>False</strong>:
… …
941<p></p> 1024<p></p>
942<dt><strong><a name="item_scrollwithbuffer_3a_boolean"><strong>scrollWithBuffer:</strong> <em>boolean</em></a></strong><br /> 1025<dt><strong><a name="item_scrollwithbuffer_3a_boolean"><strong>scrollWithBuffer:</strong> <em>boolean</em></a></strong><br />
943</dt> 1026</dt>
944<dd> 1027<dd>
945<strong>True</strong>: scroll with scrollback buffer when tty receives new lines (and 1028<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 1029<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>. 1030with scrollback buffer when tty recieves new lines; option <strong>+sw</strong>.
948</dd> 1031</dd>
949<p></p> 1032<p></p>
950<dt><strong><a name="item_scrollttykeypress_3a_boolean"><strong>scrollTtyKeypress:</strong> <em>boolean</em></a></strong><br /> 1033<dt><strong><a name="item_scrollttykeypress_3a_boolean"><strong>scrollTtyKeypress:</strong> <em>boolean</em></a></strong><br />
951</dt> 1034</dt>
952<dd> 1035<dd>
… …
1047</dd> 1130</dd>
1048<p></p> 1131<p></p>
1049<dt><strong><a name="item_pointerblankdelay_3a_number"><strong>pointerBlankDelay:</strong> <em>number</em></a></strong><br /> 1132<dt><strong><a name="item_pointerblankdelay_3a_number"><strong>pointerBlankDelay:</strong> <em>number</em></a></strong><br />
1050</dt> 1133</dt>
1051<dd> 1134<dd>
1052Specifies number of seconds before blanking the pointer [default 2]. 1135Specifies number of seconds before blanking the pointer [default 2]. Use a
1136large number (e.g. <code>987654321</code>) to effectively disable the timeout.
1053</dd> 1137</dd>
1054<p></p> 1138<p></p>
1055<dt><strong><a name="item_backspacekey_3a_string"><strong>backspacekey:</strong> <em>string</em></a></strong><br /> 1139<dt><strong><a name="item_backspacekey_3a_string"><strong>backspacekey:</strong> <em>string</em></a></strong><br />
1056</dt> 1140</dt>
1057<dd> 1141<dd>
… …
1232when Control-Meta-c is being pressed'':</p> 1316when Control-Meta-c is being pressed'':</p>
1233</dd> 1317</dd>
1234<dd> 1318<dd>
1235<pre> 1319<pre>
1236 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007</pre> 1320 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007</pre>
1321</dd>
1322<dd>
1323<p>Due the the large number of modifier combinations, a defined key mapping
1324will match if at <em>at least</em> the specified identifiers are being set, and
1325no other key mappings with those and more bits are being defined. That
1326means that defining a key map for <code>a</code> will automatically provide
1327definitions for <code>Meta-a</code>, <code>Shift-a</code> and so on, unless some of those are defined
1328mappings themselves.</p>
1329</dd>
1330<dd>
1331<p>Unfortunately, this will override built-in key mappings. For example
1332if you overwrite the <code>Insert</code> key you will disable rxvt's
1333<code>Shift-Insert</code> mapping. To re-enable that, you can poke ``holes'' into the
1334user-defined keymap using the <code>builtin:</code> replacement:</p>
1335</dd>
1336<dd>
1337<pre>
1338 URxvt.keysym.Insert: &lt;my insert key sequence&gt;
1339 URxvt.keysym.S-Insert: builtin:</pre>
1340</dd>
1341<dd>
1342<p>The first line defines a mapping for <code>Insert</code> and <em>any</em> combination
1343of modifiers. The second line re-establishes the default mapping for
1344<code>Shift-Insert</code>.</p>
1237</dd> 1345</dd>
1238<dd> 1346<dd>
1239<p>The following example will map Control-Meta-1 and Control-Meta-2 to 1347<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 1348the fonts <code>suxuseuro</code> and <code>9x15bold</code>, so you can have some limited
1241font-switching at runtime:</p> 1349font-switching at runtime:</p>
… …
1508<dd> 1616<dd>
1509The unix domain socket path used by <code>rxvtc(1)</code> and 1617The unix domain socket path used by <code>rxvtc(1)</code> and
1510rxvtd(1). 1618rxvtd(1).
1511</dd> 1619</dd>
1512<dd> 1620<dd>
1513<p>Default <code>$HOME/.rxvt-unicode-&lt;nodename</code>.</p> 1621<p>Default <em>$HOME/.rxvt-unicode-<em>&lt;nodename </em></em> &gt;&gt;&gt;.</p>
1514</dd> 1622</dd>
1515<p></p> 1623<p></p>
1516<dt><strong><a name="item_home"><strong>HOME</strong></a></strong><br /> 1624<dt><strong><a name="item_home"><strong>HOME</strong></a></strong><br />
1517</dt> 1625</dt>
1518<dd> 1626<dd>
… …
1547<p></p></dl> 1655<p></p></dl>
1548<p> 1656<p>
1549</p> 1657</p>
1550<hr /> 1658<hr />
1551<h1><a name="see_also">SEE ALSO</a></h1> 1659<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> 1660<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>
1554</p>
1555<hr />
1556<h1><a name="bugs">BUGS</a></h1>
1557<p>Check the BUGS file for an up-to-date list.</p>
1558<p>Cursor change support is not yet implemented.</p>
1559<p>Click-and-drag doesn't work with X11 mouse report overriding.</p>
1560<p> 1661<p>
1561</p> 1662</p>
1562<hr /> 1663<hr />
1563<h1><a name="current_project_coordinator">CURRENT PROJECT COORDINATOR</a></h1> 1664<h1><a name="current_project_coordinator">CURRENT PROJECT COORDINATOR</a></h1>
1564<dl> 1665<dl>

Diff Legend

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