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.46 by root, Mon Jan 16 15:07:27 2006 UTC vs.
Revision 1.55 by root, Sun Jan 29 22:38:43 2006 UTC

46<p><strong>rxvt</strong> [options] [-e command [ args ]]</p> 46<p><strong>rxvt</strong> [options] [-e command [ args ]]</p>
47<p> 47<p>
48</p> 48</p>
49<hr /> 49<hr />
50<h1><a name="description">DESCRIPTION</a></h1> 50<h1><a name="description">DESCRIPTION</a></h1>
51<p><strong>rxvt-unicode</strong>, version <strong>7.0</strong>, is a colour vt102 terminal 51<p><strong>rxvt-unicode</strong>, version <strong>7.4</strong>, is a colour vt102 terminal
52emulator 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
53require features such as Tektronix 4014 emulation and toolkit-style 53require features such as Tektronix 4014 emulation and toolkit-style
54configurability. 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 --
55a significant advantage on a machine serving many X sessions.</p> 55a significant advantage on a machine serving many X sessions.</p>
56<p> 56<p>
131Attempt to open a window on the named X display (<strong>-d</strong> still 131Attempt to open a window on the named X display (<strong>-d</strong> still
132respected). In the absence of this option, the display specified by the 132respected). In the absence of this option, the display specified by the
133<strong>DISPLAY</strong> environment variable is used. 133<strong>DISPLAY</strong> environment variable is used.
134</dd> 134</dd>
135<p></p> 135<p></p>
136<dt><strong><a name="item__2ddepth_bitdepth"><strong>-depth</strong> <em>bitdepth</em></a></strong><br />
137</dt>
138<dd>
139Compile <em>xft</em>: Attempt to find a visual with the given bit depth;
140resource <strong>depth</strong>.
141</dd>
142<p></p>
136<dt><strong><a name="item__2dgeometry_geom"><strong>-geometry</strong> <em>geom</em></a></strong><br /> 143<dt><strong><a name="item__2dgeometry_geom"><strong>-geometry</strong> <em>geom</em></a></strong><br />
137</dt> 144</dt>
138<dd> 145<dd>
139Window geometry (<strong>-g</strong> still respected); resource <strong>geometry</strong>. 146Window geometry (<strong>-g</strong> still respected); resource <strong>geometry</strong>.
140</dd> 147</dd>
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 /> 161<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 />
155</dt> 162</dt>
156<dd> 163<dd>
157Turn on/off inheriting parent window's pixmap. Alternative form is 164Turn on/off inheriting parent window's pixmap. Alternative form is
158<strong>-tr</strong>; resource <strong>inheritPixmap</strong>. 165<strong>-tr</strong>; resource <strong>inheritPixmap</strong>.
166</dd>
167<dd>
168<p><em>Please note that transparency of any kind if completely unsupported by
169the author. Don't bug him with installation questions!</em></p>
159</dd> 170</dd>
160<p></p> 171<p></p>
161<dt><strong><a name="item__2dfade_number"><strong>-fade</strong> <em>number</em></a></strong><br /> 172<dt><strong><a name="item__2dfade_number"><strong>-fade</strong> <em>number</em></a></strong><br />
162</dt> 173</dt>
163<dd> 174<dd>
168<p></p> 179<p></p>
169<dt><strong><a name="item__2dfadecolor_colour"><strong>-fadecolor</strong> <em>colour</em></a></strong><br /> 180<dt><strong><a name="item__2dfadecolor_colour"><strong>-fadecolor</strong> <em>colour</em></a></strong><br />
170</dt> 181</dt>
171<dd> 182<dd>
172Fade to this colour when fading is used (see <strong>-fade</strong>). The default colour 183Fade to this colour when fading is used (see <strong>-fade</strong>). The default colour
173is black. resource <strong>fadeColor</strong>. 184is opaque black. resource <strong>fadeColor</strong>.
174</dd> 185</dd>
175<p></p> 186<p></p>
176<dt><strong><a name="item__2dtint_colour"><strong>-tint</strong> <em>colour</em></a></strong><br /> 187<dt><strong><a name="item__2dtint_colour"><strong>-tint</strong> <em>colour</em></a></strong><br />
177</dt> 188</dt>
178<dd> 189<dd>
413</dt> 424</dt>
414<dd> 425<dd>
415Compile <em>frills</em>: Set MWM hints to request a borderless window, i.e. 426Compile <em>frills</em>: Set MWM hints to request a borderless window, i.e.
416if honoured by the WM, the rxvt-unicode window will not have window 427if honoured by the WM, the rxvt-unicode window will not have window
417decorations; resource <strong>borderLess</strong>. 428decorations; resource <strong>borderLess</strong>.
429</dd>
430<p></p>
431<dt><strong><a name="item__2doverride_2dredirect"><strong>-override-redirect</strong></a></strong><br />
432</dt>
433<dd>
434Compile <em>frills</em>: Sets override-redirect on the window; resource
435<strong>override-redirect</strong>.
418</dd> 436</dd>
419<p></p> 437<p></p>
420<dt><strong><a name="item__2dsbg"><strong>-sbg</strong></a></strong><br /> 438<dt><strong><a name="item__2dsbg"><strong>-sbg</strong></a></strong><br />
421</dt> 439</dt>
422<dd> 440<dd>
674be used. Command-line arguments can be used to override resource 692be used. Command-line arguments can be used to override resource
675settings. The following resources are supported (you might want to 693settings. The following resources are supported (you might want to
676check the <code>rxvtperl(3)</code> manpage for additional settings by perl 694check the <code>rxvtperl(3)</code> manpage for additional settings by perl
677extensions not documented here):</p> 695extensions not documented here):</p>
678<dl> 696<dl>
697<dt><strong><a name="item_depth_3a_bitdepth"><strong>depth:</strong> <em>bitdepth</em></a></strong><br />
698</dt>
699<dd>
700Compile <em>xft</em>: Attempt to find a visual with the given bit depth;
701option <strong>-depth</strong>.
702</dd>
703<p></p>
679<dt><strong><a name="item_geometry_3a_geom"><strong>geometry:</strong> <em>geom</em></a></strong><br /> 704<dt><strong><a name="item_geometry_3a_geom"><strong>geometry:</strong> <em>geom</em></a></strong><br />
680</dt> 705</dt>
681<dd> 706<dd>
682Create the window with the specified X window geometry [default 80x24]; 707Create the window with the specified X window geometry [default 80x24];
683option <strong>-geometry</strong>. 708option <strong>-geometry</strong>.
782</dt> 807</dt>
783<dd> 808<dd>
784<strong>True</strong>: make the background inherit the parent windows' pixmap, giving 809<strong>True</strong>: make the background inherit the parent windows' pixmap, giving
785artificial transparency. <strong>False</strong>: do not inherit the parent windows' 810artificial transparency. <strong>False</strong>: do not inherit the parent windows'
786pixmap. 811pixmap.
812</dd>
813<dd>
814<p><em>Please note that transparency of any kind if completely unsupported by
815the author. Don't bug him with installation questions!</em></p>
787</dd> 816</dd>
788<p></p> 817<p></p>
789<dt><strong><a name="item_fading_3a_number"><strong>fading:</strong> <em>number</em></a></strong><br /> 818<dt><strong><a name="item_fading_3a_number"><strong>fading:</strong> <em>number</em></a></strong><br />
790</dt> 819</dt>
791<dd> 820<dd>
1201</dd> 1230</dd>
1202<p></p> 1231<p></p>
1203<dt><strong><a name="item_cutchars_3a_string"><strong>cutchars:</strong> <em>string</em></a></strong><br /> 1232<dt><strong><a name="item_cutchars_3a_string"><strong>cutchars:</strong> <em>string</em></a></strong><br />
1204</dt> 1233</dt>
1205<dd> 1234<dd>
1206The characters used as delimiters for double-click word selection. The 1235The characters used as delimiters for double-click word selection
1207built-in default: 1236(whitespace delimiting is added automatically if resource is given).
1237</dd>
1238<dd>
1239<p>When the selection extension is in use (the default if compiled in, see
1240the <code>rxvtperl(3)</code> manpage), a suitable regex using these characters
1241will be created (if the resource exists, otherwise, no regex will be
1242created). In this mode, characters outside ISO-8859-1 can be used.</p>
1243</dd>
1244<dd>
1245<p>When the selection extension is not used, only ISO-8859-1 characters can
1246be used. If not specified, the built-in default is used:</p>
1208</dd> 1247</dd>
1209<dd> 1248<dd>
1210<p><strong>BACKSLASH ```'&amp;()*,;&lt;=</strong>?@[]{|} &gt;&gt;</p> 1249<p><strong>BACKSLASH ```'&amp;()*,;&lt;=</strong>?@[]{|} &gt;&gt;</p>
1211</dd> 1250</dd>
1212<p></p> 1251<p></p>
1281Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) 1320Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
1282character is passed through. It may contain escape values as described 1321character is passed through. It may contain escape values as described
1283in the entry on <strong>keysym</strong> following. 1322in the entry on <strong>keysym</strong> following.
1284</dd> 1323</dd>
1285<p></p> 1324<p></p>
1286<dt><strong><a name="item_secondaryscreen_3a_bool"><strong>secondaryScreen:</strong> <em>bool</em></a></strong><br /> 1325<dt><strong><a name="item_secondaryscreen_3a_boolean"><strong>secondaryScreen:</strong> <em>boolean</em></a></strong><br />
1287</dt> 1326</dt>
1288<dd> 1327<dd>
1289Turn on/off secondary screen (default enabled). 1328Turn on/off secondary screen (default enabled).
1290</dd> 1329</dd>
1291<p></p> 1330<p></p>
1292<dt><strong><a name="item_secondaryscroll_3a_bool"><strong>secondaryScroll:</strong> <em>bool</em></a></strong><br /> 1331<dt><strong><a name="item_secondaryscroll_3a_boolean"><strong>secondaryScroll:</strong> <em>boolean</em></a></strong><br />
1293</dt> 1332</dt>
1294<dd> 1333<dd>
1295Turn on/off secondary screen scroll (default enabled). If the this 1334Turn on/off secondary screen scroll (default enabled). If the this
1296option is enabled, scrolls on the secondary screen will change the 1335option is enabled, scrolls on the secondary screen will change the
1297scrollback buffer and switching to/from the secondary screen will 1336scrollback buffer and switching to/from the secondary screen will
1298instead scroll the screen up. 1337instead scroll the screen up.
1299</dd> 1338</dd>
1300<p></p> 1339<p></p>
1301<dt><strong><a name="item_hold_3a_bool"><strong>hold</strong>: <em>bool</em></a></strong><br /> 1340<dt><strong><a name="item_hold_3a_boolean"><strong>hold</strong>: <em>boolean</em></a></strong><br />
1302</dt> 1341</dt>
1303<dd> 1342<dd>
1304Turn on/off hold window after exit support. If enabled, rxvt 1343Turn on/off hold window after exit support. If enabled, rxvt
1305will not immediately destroy its window when the program executed within 1344will not immediately destroy its window when the program executed within
1306it exits. Instead, it will wait till it is being killed or closed by the 1345it exits. Instead, it will wait till it is being killed or closed by the
1514</dd> 1553</dd>
1515<p></p> 1554<p></p>
1516<dt><strong><a name="item_transient_2dfor_3a_windowid"><strong>transient-for</strong>: <em>windowid</em></a></strong><br /> 1555<dt><strong><a name="item_transient_2dfor_3a_windowid"><strong>transient-for</strong>: <em>windowid</em></a></strong><br />
1517</dt> 1556</dt>
1518<dd> 1557<dd>
1519Sets the WM_TRANSIENT_FOR property to the given window iw. 1558Compile <em>frills</em>: Sets the WM_TRANSIENT_FOR property to the given window id.
1559</dd>
1560<p></p>
1561<dt><strong><a name="item_override_2dredirect_3a_boolean"><strong>override-redirect</strong>: <em>boolean</em></a></strong><br />
1562</dt>
1563<dd>
1564Compile <em>frills</em>: Sets override-redirect for the terminal window, making
1565it almost invisible to window managers; option <strong>-override-redirect</strong>.
1520</dd> 1566</dd>
1521<p></p></dl> 1567<p></p></dl>
1522<p> 1568<p>
1523</p> 1569</p>
1524<hr /> 1570<hr />
1569</dd> 1615</dd>
1570<p></p> 1616<p></p>
1571<dt><strong><a name="item_insertion_3a"><strong>Insertion</strong>:</a></strong><br /> 1617<dt><strong><a name="item_insertion_3a"><strong>Insertion</strong>:</a></strong><br />
1572</dt> 1618</dt>
1573<dd> 1619<dd>
1574Pressing and releasing the Middle mouse button (or <strong>Shift-Insert</strong>) in 1620Pressing and releasing the Middle mouse button in an <strong>rxvt</strong>
1575an <strong>rxvt</strong> window causes the current text selection to be 1621window causes the value of the PRIMARY selection (or CLIPBOARD with the
1576inserted as if it had been typed on the keyboard. 1622Meta modifier) to be inserted as if it had been typed on the keyboard.
1623</dd>
1624<dd>
1625<p>Pressing <strong>Shift-Insert</strong> causes the value of the PRIMARY selection to be
1626inserted too.</p>
1577</dd> 1627</dd>
1578<p></p></dl> 1628<p></p></dl>
1579<p> 1629<p>
1580</p> 1630</p>
1581<hr /> 1631<hr />
1660<hr /> 1710<hr />
1661<h1><a name="colors_and_graphics">COLORS AND GRAPHICS</a></h1> 1711<h1><a name="colors_and_graphics">COLORS AND GRAPHICS</a></h1>
1662<p>In addition to the default foreground and background colours, 1712<p>In addition to the default foreground and background colours,
1663<strong>rxvt</strong> can display up to 16 colours (8 ANSI colours plus 1713<strong>rxvt</strong> can display up to 16 colours (8 ANSI colours plus
1664high-intensity bold/blink versions of the same). Here is a list of the 1714high-intensity bold/blink versions of the same). Here is a list of the
1665colours with their <strong>rgb.txt</strong> names.</p> 1715colours with their names.</p>
1666<table> 1716<table>
1667<tr><td>color0</td><td>(black)</td><td>= Black</td></tr> 1717<tr><td>color0</td><td>(black)</td><td>= Black</td></tr>
1668<tr><td>color1</td><td>(red)</td><td>= Red3</td></tr> 1718<tr><td>color1</td><td>(red)</td><td>= Red3</td></tr>
1669<tr><td>color2</td><td>(green)</td><td>= Green3</td></tr> 1719<tr><td>color2</td><td>(green)</td><td>= Green3</td></tr>
1670<tr><td>color3</td><td>(yellow)</td><td>= Yellow3</td></tr> 1720<tr><td>color3</td><td>(yellow)</td><td>= Yellow3</td></tr>
1684<tr><td>background</td><td></td><td>= White</td></tr> 1734<tr><td>background</td><td></td><td>= White</td></tr>
1685</table><p>It is also possible to specify the colour values of <strong>foreground</strong>, 1735</table><p>It is also possible to specify the colour values of <strong>foreground</strong>,
1686<strong>background</strong>, <strong>cursorColor</strong>, <strong>cursorColor2</strong>, <strong>colorBD</strong>, <strong>colorUL</strong> as 1736<strong>background</strong>, <strong>cursorColor</strong>, <strong>cursorColor2</strong>, <strong>colorBD</strong>, <strong>colorUL</strong> as
1687a number 0-15, as a convenient shorthand to reference the colour name of 1737a number 0-15, as a convenient shorthand to reference the colour name of
1688color0-color15.</p> 1738color0-color15.</p>
1739<p>If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1740their act together, rxvt-unicode will support <code>rgba:rrrr/gggg/bbbb/aaaa</code>
1741(recommended, but <strong>MUST</strong> have 4 digits/component), <code>#ARGB</code>, <code>#AARRGGBB</code>
1742and <code>#AAAARRRRGGGGBBBB</code> colour specifications, in addition to the ones
1743provided by X, where the additional A component specifies alpha (opacity)
1744values (0 is completely transparent and the maximum is opaque). You
1745probably need to specify <strong>``-depth 32''</strong>, too, and have the luck that your
1746X-server uses ARGB pixel layout, as X is far from just supporting ARGB
1747visuals out of the box, and rxvt-unicode just fudges around.</p>
1748<p><em>Please note that transparency of any kind if completely unsupported by
1749the author. Don't bug him with installation questions!</em></p>
1689<p>Note that <strong>-rv</strong> (<strong>``reverseVideo: True''</strong>) simulates reverse video by 1750<p>Note that <strong>-rv</strong> (<strong>``reverseVideo: True''</strong>) simulates reverse video by
1690always swapping the foreground/background colours. This is in contrast to 1751always swapping the foreground/background colours. This is in contrast to
1691<em>xterm</em>(1) where the colours are only swapped if they have not otherwise 1752<em>xterm</em>(1) where the colours are only swapped if they have not otherwise
1692been specified. For example,</p> 1753been specified. For example,</p>
1693<dl> 1754<dl>
1755<p></p> 1816<p></p>
1756<dt><strong><a name="item_shell"><strong>SHELL</strong></a></strong><br /> 1817<dt><strong><a name="item_shell"><strong>SHELL</strong></a></strong><br />
1757</dt> 1818</dt>
1758<dd> 1819<dd>
1759The shell to be used for command execution, defaults to <code>/bin/sh</code>. 1820The shell to be used for command execution, defaults to <code>/bin/sh</code>.
1760</dd>
1761<p></p>
1762<dt><strong><a name="item_rxvtpath"><strong>RXVTPATH</strong></a></strong><br />
1763</dt>
1764<dd>
1765The path where rxvt looks for support files such as menu and xpm
1766files.
1767</dd>
1768<p></p>
1769<dt><strong><a name="item_path"><strong>PATH</strong></a></strong><br />
1770</dt>
1771<dd>
1772Used in the same way as <a href="#item_rxvtpath"><code>RXVTPATH</code></a>.
1773</dd> 1821</dd>
1774<p></p> 1822<p></p>
1775<dt><strong><a name="item_rxvt_socket"><strong>RXVT_SOCKET</strong></a></strong><br /> 1823<dt><strong><a name="item_rxvt_socket"><strong>RXVT_SOCKET</strong></a></strong><br />
1776</dt> 1824</dt>
1777<dd> 1825<dd>
1872</dd> 1920</dd>
1873<p></p> 1921<p></p>
1874<dt><strong><a name="item_geoff_wing__3cgcw_40pobox_2ecom_3e">Geoff Wing <em><a href="mailto:<gcw@pobox.com"><gcw@pobox.com</a></em>&gt;</a></strong><br /> 1922<dt><strong><a name="item_geoff_wing__3cgcw_40pobox_2ecom_3e">Geoff Wing <em><a href="mailto:<gcw@pobox.com"><gcw@pobox.com</a></em>&gt;</a></strong><br />
1875</dt> 1923</dt>
1876<dd> 1924<dd>
1877Rewrote screen display and text selection routines. Project Coordinator 1925Rewrote screen display and text selection routines.
1878(changes.txt 2.4.6 - rxvt-unicode) 1926
1927</dd>
1928<dd>
1929<pre>
1930
1931Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)</pre>
1879</dd> 1932</dd>
1880<p></p> 1933<p></p>
1881<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 /> 1934<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 />
1882</dt> 1935</dt>
1883<dd> 1936<dd>
1884Forked rxvt-unicode, rewrote most of the display code and internal 1937Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1885character handling to store text in unicode, improve xterm 1938extension, random hacks, numerous bugfixes and extensions.
1886compatibility and apply numerous other bugfixes and extensions.
1887</dd> 1939</dd>
1888<dd> 1940<dd>
1889<p>Project Coordinator (Changes 1.0 -)</p> 1941<p>Project Coordinator (Changes 1.0 -)</p>
1942</dd>
1943<p></p>
1944<dt><strong><a name="item_emanuele_giaquinta__3ce_2egiaquinta_40glauco_2eit_">Emanuele Giaquinta <em><a href="mailto:<e.giaquinta@glauco.it"><e.giaquinta@glauco.it</a></em>&gt;</a></strong><br />
1945</dt>
1946<dd>
1947Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1890</dd> 1948</dd>
1891<p></p></dl> 1949<p></p></dl>
1892 1950
1893</body> 1951</body>
1894 1952

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines