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.6 by root, Thu Feb 3 10:24:10 2005 UTC vs.
Revision 1.14 by root, Mon Feb 14 18:47:54 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>4.9</strong>, is a colour vt102 terminal 52<p><strong>rxvt-unicode</strong>, version <strong>5.1</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>
58</p> 58</p>
59<hr /> 59<hr />
60<h1><a name="frequently_asked_questions">FREQUENTLY ASKED QUESTIONS</a></h1> 60<h1><a name="frequently_asked_questions">FREQUENTLY ASKED QUESTIONS</a></h1>
61<p>See <code>rxvt(7)</code> (try <code>man 7 rxvt</code>) for a list of frequently 61<p>See <code>rxvt(7)</code> (try <code>man 7 rxvt</code>) for a list of
62asked questions and answer to them and some common problems.</p> 62frequently asked questions and answer to them and some common
63problems. That document is also accessible on the World-Wide-Web at
64<a href="http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html">http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html</a>.</p>
63<p> 65<p>
64</p> 66</p>
65<hr /> 67<hr />
66<h1><a name="rxvtunicode_vs__rxvt">RXVT-UNICODE VS. RXVT</a></h1> 68<h1><a name="rxvtunicode_vs__rxvt">RXVT-UNICODE VS. RXVT</a></h1>
67<p>Unlike the original rxvt, <strong>rxvt-unicode</strong> stores all text in Unicode 69<p>Unlike the original rxvt, <strong>rxvt-unicode</strong> stores all text in Unicode
… …
509<dd> 511<dd>
510Turn on/off secondary screen scroll (default enabled); resource 512Turn on/off secondary screen scroll (default enabled); resource
511<strong>secondaryScroll</strong>. 513<strong>secondaryScroll</strong>.
512</dd> 514</dd>
513<p></p> 515<p></p>
514<dt><strong><a name="item__2dxrm_resourcestring"><strong>-xrm</strong> <em>resourcestring</em></a></strong><br /> 516<dt><strong><a name="item__2dkeysym_2esym_3a_string"><strong>-keysym.</strong><em>sym</em>: <em>string</em></a></strong><br />
515</dt> 517</dt>
518<dd>
519Remap a key symbol. See resource <strong>keysym</strong>.
516<dd> 520</dd>
517No effect on rxvt-unicode. Simply passes through an argument to be made 521<p></p>
518available in the instance's argument list. Appears in <em>WM_COMMAND</em> in 522<dt><strong><a name="item__2dembed_3a_windowid"><strong>-embed</strong>: <em>windowid</em></a></strong><br />
519some window managers. 523</dt>
524<dd>
525Tells rxvt to embed it's windows into an already-existing window,
526which enables applications to easily embed a terminal.
527</dd>
528<dd>
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
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>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
537can use file descriptors to communicate with the programs within the
538terminal. This works regardless of wether the <code>-embed</code> option was used or
539not.</p>
520</dd> 540</dd>
521<p></p></dl> 541<p></p></dl>
522<p> 542<p>
523</p> 543</p>
524<hr /> 544<hr />
… …
527options) compiled into your version.</p> 547options) compiled into your version.</p>
528<p>There are two different methods that rxvt can use to get the 548<p>There are two different methods that rxvt can use to get the
529Xresource data: using the X libraries (Xrm*-functions) or internal 549Xresource data: using the X libraries (Xrm*-functions) or internal
530Xresources reader (<strong>~/.Xdefaults</strong>). For the first method (ie. 550Xresources reader (<strong>~/.Xdefaults</strong>). For the first method (ie.
531<strong>rxvt -h</strong> lists <strong>XGetDefaults</strong>), you can set and change the 551<strong>rxvt -h</strong> lists <strong>XGetDefaults</strong>), you can set and change the
532resources using X11 tools like <strong>xset</strong>. Many distribution do also load 552resources using X11 tools like <strong>xrdb</strong>. Many distribution do also load
533settings from the <strong>~/.Xresources</strong> file when X starts.</p> 553settings from the <strong>~/.Xresources</strong> file when X starts. rxvt
554will consult the following files/resources in order, with later settings
555overwriting earlier ones:</p>
556<pre>
557 1. system-wide app-defaults file, either locale-dependent OR global
558 2. app-defaults file in $XAPPLRESDIR
559 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
560 4. SCREEN_RESOURCES for the current screen
561 5. $XENVIRONMENT file OR $HOME/.Xdefaults-&lt;nodename&gt;</pre>
534<p>If compiled with internal Xresources support (i.e. <strong>rxvt -h</strong> 562<p>If compiled with internal Xresources support (i.e. <strong>rxvt -h</strong>
535lists <strong>.Xdefaults</strong>) then <strong>rxvt</strong> accepts application defaults 563lists <strong>.Xdefaults</strong>) then <strong>rxvt</strong> accepts application defaults
536set in XAPPLOADDIR/URxvt (compile-time defined: usually 564set in XAPPLOADDIR/URxvt (compile-time defined: usually
537<strong>/usr/lib/X11/app-defaults/URxvt</strong>) and resources set in 565<strong>/usr/lib/X11/app-defaults/URxvt</strong>) and resources set in
538<strong>~/.Xdefaults</strong>, or <strong>~/.Xresources</strong> if <strong>~/.Xdefaults</strong> does not exist. 566<strong>~/.Xdefaults</strong>, or <strong>~/.Xresources</strong> if <strong>~/.Xdefaults</strong> does not exist.
… …
1166<code>\000</code>: octal number) or verbatim control characters (<code>^?</code>: delete, 1194<code>\000</code>: octal number) or verbatim control characters (<code>^?</code>: delete,
1167<code>^@</code>: null, <code>^A</code> ...) and may be enclosed with double quotes so that it 1195<code>^@</code>: null, <code>^A</code> ...) and may be enclosed with double quotes so that it
1168can start or end with whitespace.</p> 1196can start or end with whitespace.</p>
1169</dd> 1197</dd>
1170<dd> 1198<dd>
1199<p>Please note that you need to double the <code>\</code> when using
1200<code>--enable-xgetdefault</code>, as X itself does it's own de-escaping (you can
1201use <code>\033</code> instead of <code>\e</code> (and so on), which will work with both Xt and
1202rxvt's own processing).</p>
1203</dd>
1204<dd>
1171<p>You can define a range of keysyms in one shot by providing a <em>string</em> 1205<p>You can define a range of keysyms in one shot by providing a <em>string</em>
1172with pattern <strong>list/PREFIX/MIDDLE/SUFFIX</strong>, where the delimeter `/' 1206with pattern <strong>list/PREFIX/MIDDLE/SUFFIX</strong>, where the delimeter `/'
1173should be a character not used by the strings.</p> 1207should be a character not used by the strings.</p>
1174</dd> 1208</dd>
1175<dd> 1209<dd>
1176<p>Its usage can be demonstrated by an example:</p> 1210<p>Its usage can be demonstrated by an example:</p>
1177</dd> 1211</dd>
1178<dd> 1212<dd>
1179<pre> 1213<pre>
1180 URxvt.keysym.M-C-0x61: list|\e&lt;M-C-|abc|&gt;</pre> 1214 URxvt.keysym.M-C-0x61: list|\033&lt;M-C-|abc|&gt;</pre>
1181</dd> 1215</dd>
1182<dd> 1216<dd>
1183<p>The above line is equivalent to the following three lines:</p> 1217<p>The above line is equivalent to the following three lines:</p>
1184</dd> 1218</dd>
1185<dd> 1219<dd>
1186<pre> 1220<pre>
1187 URxvt.keysym.Meta-Control-0x61: \e&lt;M-C-a&gt; 1221 URxvt.keysym.Meta-Control-0x61: \033&lt;M-C-a&gt;
1188 URxvt.keysym.Meta-Control-0x62: \e&lt;M-C-b&gt; 1222 URxvt.keysym.Meta-Control-0x62: \033&lt;M-C-b&gt;
1189 URxvt.keysym.Meta-Control-0x63: \e&lt;M-C-c&gt;</pre> 1223 URxvt.keysym.Meta-Control-0x63: \033&lt;M-C-c&gt;</pre>
1190</dd>
1191<dd> 1224</dd>
1225<dd>
1192<p>If <em>string</em> takes the form of <code>proto:STRING</code>, the specified <strong>STRING</strong> 1226<p>If <em>string</em> takes the form of <code>command:STRING</code>, the specified <strong>STRING</strong>
1193is interpreted and executed as rxvt's control sequence. For 1227is interpreted and executed as rxvt's control sequence. For
1194example the following means ``change the current locale to <code>zh_CN.GBK</code> 1228example the following means ``change the current locale to <code>zh_CN.GBK</code>
1195when Control-Meta-c is being pressed'':</p> 1229when Control-Meta-c is being pressed'':</p>
1196</dd> 1230</dd>
1197<dd> 1231<dd>
1198<pre> 1232<pre>
1199 URxvt.keysym.M-C-c: proto:\033]701;zh_CN.GBK\007</pre> 1233 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007</pre>
1200</dd> 1234</dd>
1201<dd> 1235<dd>
1202<p>The following example will map Control-Meta-1 and Control-Meta-2 to 1236<p>The following example will map Control-Meta-1 and Control-Meta-2 to
1203the fonts <code>suxuseuro</code> and <code>9x15bold</code>, so you cna have some limited 1237the fonts <code>suxuseuro</code> and <code>9x15bold</code>, so you can have some limited
1204font-switching at runtime:</p> 1238font-switching at runtime:</p>
1205</dd> 1239</dd>
1206<dd> 1240<dd>
1207<pre> 1241<pre>
1208 URxvt.keysym.M-C-1: proto:\033]50;suxuseuro\007 1242 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1209 URxvt.keysym.M-C-2: proto:\033]50;9x15bold\007</pre> 1243 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007</pre>
1210</dd>
1211<dd> 1244</dd>
1212<p><code>proto:\033]701;zh_CN.GBK\007</code> means: change the current locale to 1245<dd>
1213<code>zh_CN.GBK</code>.</p> 1246<p>Other things are possible, e.g. resizing (see <code>rxvt(7)</code> for more
1247info):</p>
1248</dd>
1249<dd>
1250<pre>
1251 URxvt.keysym.M-C-3: command:\033[8;25;80t
1252 URxvt.keysym.M-C-4: command:\033[8;48;110t</pre>
1214</dd> 1253</dd>
1215<p></p></dl> 1254<p></p></dl>
1216<p> 1255<p>
1217</p> 1256</p>
1218<hr /> 1257<hr />
… …
1232<p>To temporarily override mouse reporting, for either the scrollbar or 1271<p>To temporarily override mouse reporting, for either the scrollbar or
1233the normal text selection/insertion, hold either the Shift or the Meta 1272the normal text selection/insertion, hold either the Shift or the Meta
1234(Alt) key while performing the desired mouse action.</p> 1273(Alt) key while performing the desired mouse action.</p>
1235<p>If mouse reporting mode is active, the normal scrollbar actions are 1274<p>If mouse reporting mode is active, the normal scrollbar actions are
1236disabled -- on the assumption that we are using a fullscreen 1275disabled -- on the assumption that we are using a fullscreen
1237application. Instead, pressing Button1 and Button3 sends <strong>ESC[6~</strong> 1276application. Instead, pressing Button1 and Button3 sends <strong>ESC [ 6 ~</strong>
1238(Next) and <strong>ESC[5~</strong> (Prior), respectively. Similarly, clicking on the 1277(Next) and <strong>ESC [ 5 ~</strong> (Prior), respectively. Similarly, clicking on the
1239up and down arrows sends <strong>ESC[A</strong> (Up) and <strong>ESC[B</strong> (Down), 1278up and down arrows sends <strong>ESC [ A</strong> (Up) and <strong>ESC [ B</strong> (Down),
1240respectively.</p> 1279respectively.</p>
1241<p> 1280<p>
1242</p> 1281</p>
1243<hr /> 1282<hr />
1244<h1><a name="text_selection_and_insertion">TEXT SELECTION AND INSERTION</a></h1> 1283<h1><a name="text_selection_and_insertion">TEXT SELECTION AND INSERTION</a></h1>
… …
1389<p></p></dl> 1428<p></p></dl>
1390<p> 1429<p>
1391</p> 1430</p>
1392<hr /> 1431<hr />
1393<h1><a name="environment">ENVIRONMENT</a></h1> 1432<h1><a name="environment">ENVIRONMENT</a></h1>
1394<p><strong>rxvt</strong> sets the environment variables <strong>TERM</strong>, <strong>COLORTERM</strong> 1433<p><strong>rxvt</strong> sets and/or uses the following environment variables:</p>
1395and <strong>COLORFGBG</strong>. The environment variable <strong>WINDOWID</strong> is set to the X 1434<dl>
1396window id number of the <strong>rxvt</strong> window and it also uses and 1435<dt><strong><a name="item_term"><strong>TERM</strong></a></strong><br />
1397sets the environment variable <strong>DISPLAY</strong> to specify which display 1436</dt>
1398terminal to use. <strong>rxvt</strong> uses the environment variables 1437<dd>
1399<strong>RXVTPATH</strong> and <strong>PATH</strong> to find XPM files.</p> 1438Normally set to <code>rxvt-unicode</code>, unless overwritten at configure time, via
1439resources or on the commandline.
1440</dd>
1441<p></p>
1442<dt><strong><a name="item_colorterm"><strong>COLORTERM</strong></a></strong><br />
1443</dt>
1444<dd>
1445Either <code>rxvt</code>, <code>rxvt-xpm</code>, depending on wether rxvt was
1446compiled with XPM support, and optionally with the added extension
1447<code>-mono</code> to indicate that rxvt-unicode runs on a monochrome screen.
1448</dd>
1449<p></p>
1450<dt><strong><a name="item_colorfgbg"><strong>COLORFGBG</strong></a></strong><br />
1451</dt>
1452<dd>
1453Set to a string of the form <code>fg;bg</code> or <code>fg;xpm;bg</code>, where <code>fg</code> is
1454the colour code used as default foreground/text colour (or the string
1455<code>default</code> to indicate that the default-colour escape sequence is to be
1456used), <code>bg</code> is the colour code used as default background colour (or the
1457string <code>default</code>), and <code>xpm</code> is the string <code>default</code> if rxvt
1458was compiled with XPM support. Libraries like <code>ncurses</code> and <code>slang</code> can
1459(and do) use this information to optimize screen output.
1460</dd>
1461<p></p>
1462<dt><strong><a name="item_windowid"><strong>WINDOWID</strong></a></strong><br />
1463</dt>
1464<dd>
1465Set to the (decimal) X Window ID of the rxvt window (the toplevel
1466window, which usually has subwindows for the scrollbar, the terminal
1467window and so on).
1468</dd>
1469<p></p>
1470<dt><strong><a name="item_terminfo"><strong>TERMINFO</strong></a></strong><br />
1471</dt>
1472<dd>
1473Set to the terminfo directory iff rxvt was configured with
1474<code>--with-terminfo=PATH</code>.
1475</dd>
1476<p></p>
1477<dt><strong><a name="item_display"><strong>DISPLAY</strong></a></strong><br />
1478</dt>
1479<dd>
1480Used by rxvt to connect to the display and set to the correct
1481display in it's child processes.
1482</dd>
1483<p></p>
1484<dt><strong><a name="item_shell"><strong>SHELL</strong></a></strong><br />
1485</dt>
1486<dd>
1487The shell to be used for command execution, defaults to <code>/bin/sh</code>.
1488</dd>
1489<p></p>
1490<dt><strong><a name="item_rxvtpath"><strong>RXVTPATH</strong></a></strong><br />
1491</dt>
1492<dd>
1493The path where rxvt looks for support files such as menu and xpm
1494files.
1495</dd>
1496<p></p>
1497<dt><strong><a name="item_path"><strong>PATH</strong></a></strong><br />
1498</dt>
1499<dd>
1500Used in the same way as <a href="#item_rxvtpath"><code>RXVTPATH</code></a>.
1501</dd>
1502<p></p>
1503<dt><strong><a name="item_rxvt_socket"><strong>RXVT_SOCKET</strong></a></strong><br />
1504</dt>
1505<dd>
1506The unix domain socket path used by <code>rxvtc(1)</code> and
1507rxvtd(1).
1508</dd>
1509<dd>
1510<p>Default <code>$HOME/.rxvt-unicode-&lt;nodename</code>.</p>
1511</dd>
1512<p></p>
1513<dt><strong><a name="item_home"><strong>HOME</strong></a></strong><br />
1514</dt>
1515<dd>
1516Used to locate the default directory for the unix domain socket for
1517daemon communications and to locate various resource files (such as
1518<code>.Xdefaults</code>)
1519</dd>
1520<p></p>
1521<dt><strong><a name="item_xapplresdir"><strong>XAPPLRESDIR</strong></a></strong><br />
1522</dt>
1523<dd>
1524Directory where various X resource files are being located.
1525</dd>
1526<p></p>
1527<dt><strong><a name="item_xenvironment"><strong>XENVIRONMENT</strong></a></strong><br />
1528</dt>
1529<dd>
1530If set and accessible, gives the name of a X resource file to be loaded by
1531rxvt.
1532</dd>
1533<p></p></dl>
1400<p> 1534<p>
1401</p> 1535</p>
1402<hr /> 1536<hr />
1403<h1><a name="files">FILES</a></h1> 1537<h1><a name="files">FILES</a></h1>
1404<dl> 1538<dl>
… …
1426<h1><a name="current_project_coordinator">CURRENT PROJECT COORDINATOR</a></h1> 1560<h1><a name="current_project_coordinator">CURRENT PROJECT COORDINATOR</a></h1>
1427<dl> 1561<dl>
1428<dt><strong><a name="item_project_coordinator">Project Coordinator</a></strong><br /> 1562<dt><strong><a name="item_project_coordinator">Project Coordinator</a></strong><br />
1429</dt> 1563</dt>
1430<dd> 1564<dd>
1431Marc A. Lehmann <em><a href="mailto:rxvt@schmorp.de">rxvt@schmorp.de</a></em> 1565Marc A. Lehmann <em><a href="mailto:<rxvt-unicode@schmorp.de"><rxvt-unicode@schmorp.de</a></em>&gt;
1432</dd>
1433<p></p>
1434<dt><strong><a name="item_web_page_maintainter">Web page maintainter</a></strong><br />
1435</dt>
1436<dd> 1566</dd>
1437Marc A. Lehmann <em><a href="mailto:rxvt@schmorp.de">rxvt@schmorp.de</a></em>
1438</dd> 1567<dd>
1439<dd>
1440<p><a href="http://software.schmorp.de/">http://software.schmorp.de/</a></p> 1568<p><a href="http://software.schmorp.de/#rxvt-unicode">http://software.schmorp.de/#rxvt-unicode</a></p>
1441</dd> 1569</dd>
1442<p></p></dl> 1570<p></p></dl>
1443<p> 1571<p>
1444</p> 1572</p>
1445<hr /> 1573<hr />
… …
1483<dd> 1611<dd>
1484Rewrote screen display and text selection routines. Project Coordinator 1612Rewrote screen display and text selection routines. Project Coordinator
1485(changes.txt 2.4.6 - rxvt-unicode) 1613(changes.txt 2.4.6 - rxvt-unicode)
1486</dd> 1614</dd>
1487<p></p> 1615<p></p>
1488<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 /> 1616<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 />
1489</dt> 1617</dt>
1490<dd> 1618<dd>
1491Forked rxvt-unicode, rewrote most of the display code and internal 1619Forked rxvt-unicode, rewrote most of the display code and internal
1492character handling to store text in unicode, improve xterm 1620character handling to store text in unicode, improve xterm
1493compatibility and apply numerous other bugfixes and extensions. 1621compatibility and apply numerous other bugfixes and extensions.

Diff Legend

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