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.16 by root, Wed Feb 16 22:16:30 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.2</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>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>
520</dd> 543</dd>
521<p></p></dl> 544<p></p></dl>
522<p> 545<p>
523</p> 546</p>
524<hr /> 547<hr />
… …
527options) compiled into your version.</p> 550options) compiled into your version.</p>
528<p>There are two different methods that rxvt can use to get the 551<p>There are two different methods that rxvt can use to get the
529Xresource data: using the X libraries (Xrm*-functions) or internal 552Xresource data: using the X libraries (Xrm*-functions) or internal
530Xresources reader (<strong>~/.Xdefaults</strong>). For the first method (ie. 553Xresources reader (<strong>~/.Xdefaults</strong>). For the first method (ie.
531<strong>rxvt -h</strong> lists <strong>XGetDefaults</strong>), you can set and change the 554<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 555resources using X11 tools like <strong>xrdb</strong>. Many distribution do also load
533settings from the <strong>~/.Xresources</strong> file when X starts.</p> 556settings from the <strong>~/.Xresources</strong> file when X starts. rxvt
557will consult the following files/resources in order, with later settings
558overwriting earlier ones:</p>
559<pre>
560 1. system-wide app-defaults file, either locale-dependent OR global
561 2. app-defaults file in $XAPPLRESDIR
562 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
563 4. SCREEN_RESOURCES for the current screen
564 5. $XENVIRONMENT file OR $HOME/.Xdefaults-&lt;nodename&gt;</pre>
534<p>If compiled with internal Xresources support (i.e. <strong>rxvt -h</strong> 565<p>If compiled with internal Xresources support (i.e. <strong>rxvt -h</strong>
535lists <strong>.Xdefaults</strong>) then <strong>rxvt</strong> accepts application defaults 566lists <strong>.Xdefaults</strong>) then <strong>rxvt</strong> accepts application defaults
536set in XAPPLOADDIR/URxvt (compile-time defined: usually 567set in XAPPLOADDIR/URxvt (compile-time defined: usually
537<strong>/usr/lib/X11/app-defaults/URxvt</strong>) and resources set in 568<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. 569<strong>~/.Xdefaults</strong>, or <strong>~/.Xresources</strong> if <strong>~/.Xdefaults</strong> does not exist.
… …
910<p></p> 941<p></p>
911<dt><strong><a name="item_scrollwithbuffer_3a_boolean"><strong>scrollWithBuffer:</strong> <em>boolean</em></a></strong><br /> 942<dt><strong><a name="item_scrollwithbuffer_3a_boolean"><strong>scrollWithBuffer:</strong> <em>boolean</em></a></strong><br />
912</dt> 943</dt>
913<dd> 944<dd>
914<strong>True</strong>: scroll with scrollback buffer when tty receives new lines (and 945<strong>True</strong>: scroll with scrollback buffer when tty receives new lines (and
915<strong>scrollTtyOutput</strong> is False); option <strong>+sw</strong>. <strong>False</strong>: do not scroll 946<strong>scrollTtyOutput</strong> is False); option <strong>-sw</strong>. <strong>False</strong>: do not scroll
916with scrollback buffer when tty recieves new lines; option <strong>-sw</strong>. 947with scrollback buffer when tty recieves new lines; option <strong>+sw</strong>.
917</dd> 948</dd>
918<p></p> 949<p></p>
919<dt><strong><a name="item_scrollttykeypress_3a_boolean"><strong>scrollTtyKeypress:</strong> <em>boolean</em></a></strong><br /> 950<dt><strong><a name="item_scrollttykeypress_3a_boolean"><strong>scrollTtyKeypress:</strong> <em>boolean</em></a></strong><br />
920</dt> 951</dt>
921<dd> 952<dd>
… …
1166<code>\000</code>: octal number) or verbatim control characters (<code>^?</code>: delete, 1197<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 1198<code>^@</code>: null, <code>^A</code> ...) and may be enclosed with double quotes so that it
1168can start or end with whitespace.</p> 1199can start or end with whitespace.</p>
1169</dd> 1200</dd>
1170<dd> 1201<dd>
1202<p>Please note that you need to double the <code>\</code> when using
1203<code>--enable-xgetdefault</code>, as X itself does it's own de-escaping (you can
1204use <code>\033</code> instead of <code>\e</code> (and so on), which will work with both Xt and
1205rxvt's own processing).</p>
1206</dd>
1207<dd>
1171<p>You can define a range of keysyms in one shot by providing a <em>string</em> 1208<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 `/' 1209with pattern <strong>list/PREFIX/MIDDLE/SUFFIX</strong>, where the delimeter `/'
1173should be a character not used by the strings.</p> 1210should be a character not used by the strings.</p>
1174</dd> 1211</dd>
1175<dd> 1212<dd>
1176<p>Its usage can be demonstrated by an example:</p> 1213<p>Its usage can be demonstrated by an example:</p>
1177</dd> 1214</dd>
1178<dd> 1215<dd>
1179<pre> 1216<pre>
1180 URxvt.keysym.M-C-0x61: list|\e&lt;M-C-|abc|&gt;</pre> 1217 URxvt.keysym.M-C-0x61: list|\033&lt;M-C-|abc|&gt;</pre>
1181</dd> 1218</dd>
1182<dd> 1219<dd>
1183<p>The above line is equivalent to the following three lines:</p> 1220<p>The above line is equivalent to the following three lines:</p>
1184</dd> 1221</dd>
1185<dd> 1222<dd>
1186<pre> 1223<pre>
1187 URxvt.keysym.Meta-Control-0x61: \e&lt;M-C-a&gt; 1224 URxvt.keysym.Meta-Control-0x61: \033&lt;M-C-a&gt;
1188 URxvt.keysym.Meta-Control-0x62: \e&lt;M-C-b&gt; 1225 URxvt.keysym.Meta-Control-0x62: \033&lt;M-C-b&gt;
1189 URxvt.keysym.Meta-Control-0x63: \e&lt;M-C-c&gt;</pre> 1226 URxvt.keysym.Meta-Control-0x63: \033&lt;M-C-c&gt;</pre>
1190</dd>
1191<dd> 1227</dd>
1228<dd>
1192<p>If <em>string</em> takes the form of <code>proto:STRING</code>, the specified <strong>STRING</strong> 1229<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 1230is interpreted and executed as rxvt's control sequence. For
1194example the following means ``change the current locale to <code>zh_CN.GBK</code> 1231example the following means ``change the current locale to <code>zh_CN.GBK</code>
1195when Control-Meta-c is being pressed'':</p> 1232when Control-Meta-c is being pressed'':</p>
1196</dd> 1233</dd>
1197<dd> 1234<dd>
1198<pre> 1235<pre>
1199 URxvt.keysym.M-C-c: proto:\033]701;zh_CN.GBK\007</pre> 1236 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007</pre>
1200</dd> 1237</dd>
1201<dd> 1238<dd>
1202<p>The following example will map Control-Meta-1 and Control-Meta-2 to 1239<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 1240the fonts <code>suxuseuro</code> and <code>9x15bold</code>, so you can have some limited
1204font-switching at runtime:</p> 1241font-switching at runtime:</p>
1205</dd> 1242</dd>
1206<dd> 1243<dd>
1207<pre> 1244<pre>
1208 URxvt.keysym.M-C-1: proto:\033]50;suxuseuro\007 1245 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1209 URxvt.keysym.M-C-2: proto:\033]50;9x15bold\007</pre> 1246 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007</pre>
1210</dd>
1211<dd> 1247</dd>
1212<p><code>proto:\033]701;zh_CN.GBK\007</code> means: change the current locale to 1248<dd>
1213<code>zh_CN.GBK</code>.</p> 1249<p>Other things are possible, e.g. resizing (see <code>rxvt(7)</code> for more
1250info):</p>
1251</dd>
1252<dd>
1253<pre>
1254 URxvt.keysym.M-C-3: command:\033[8;25;80t
1255 URxvt.keysym.M-C-4: command:\033[8;48;110t</pre>
1214</dd> 1256</dd>
1215<p></p></dl> 1257<p></p></dl>
1216<p> 1258<p>
1217</p> 1259</p>
1218<hr /> 1260<hr />
… …
1232<p>To temporarily override mouse reporting, for either the scrollbar or 1274<p>To temporarily override mouse reporting, for either the scrollbar or
1233the normal text selection/insertion, hold either the Shift or the Meta 1275the normal text selection/insertion, hold either the Shift or the Meta
1234(Alt) key while performing the desired mouse action.</p> 1276(Alt) key while performing the desired mouse action.</p>
1235<p>If mouse reporting mode is active, the normal scrollbar actions are 1277<p>If mouse reporting mode is active, the normal scrollbar actions are
1236disabled -- on the assumption that we are using a fullscreen 1278disabled -- on the assumption that we are using a fullscreen
1237application. Instead, pressing Button1 and Button3 sends <strong>ESC[6~</strong> 1279application. Instead, pressing Button1 and Button3 sends <strong>ESC [ 6 ~</strong>
1238(Next) and <strong>ESC[5~</strong> (Prior), respectively. Similarly, clicking on the 1280(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), 1281up and down arrows sends <strong>ESC [ A</strong> (Up) and <strong>ESC [ B</strong> (Down),
1240respectively.</p> 1282respectively.</p>
1241<p> 1283<p>
1242</p> 1284</p>
1243<hr /> 1285<hr />
1244<h1><a name="text_selection_and_insertion">TEXT SELECTION AND INSERTION</a></h1> 1286<h1><a name="text_selection_and_insertion">TEXT SELECTION AND INSERTION</a></h1>
… …
1389<p></p></dl> 1431<p></p></dl>
1390<p> 1432<p>
1391</p> 1433</p>
1392<hr /> 1434<hr />
1393<h1><a name="environment">ENVIRONMENT</a></h1> 1435<h1><a name="environment">ENVIRONMENT</a></h1>
1394<p><strong>rxvt</strong> sets the environment variables <strong>TERM</strong>, <strong>COLORTERM</strong> 1436<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 1437<dl>
1396window id number of the <strong>rxvt</strong> window and it also uses and 1438<dt><strong><a name="item_term"><strong>TERM</strong></a></strong><br />
1397sets the environment variable <strong>DISPLAY</strong> to specify which display 1439</dt>
1398terminal to use. <strong>rxvt</strong> uses the environment variables 1440<dd>
1399<strong>RXVTPATH</strong> and <strong>PATH</strong> to find XPM files.</p> 1441Normally set to <code>rxvt-unicode</code>, unless overwritten at configure time, via
1442resources or on the commandline.
1443</dd>
1444<p></p>
1445<dt><strong><a name="item_colorterm"><strong>COLORTERM</strong></a></strong><br />
1446</dt>
1447<dd>
1448Either <code>rxvt</code>, <code>rxvt-xpm</code>, depending on wether rxvt was
1449compiled with XPM support, and optionally with the added extension
1450<code>-mono</code> to indicate that rxvt-unicode runs on a monochrome screen.
1451</dd>
1452<p></p>
1453<dt><strong><a name="item_colorfgbg"><strong>COLORFGBG</strong></a></strong><br />
1454</dt>
1455<dd>
1456Set to a string of the form <code>fg;bg</code> or <code>fg;xpm;bg</code>, where <code>fg</code> is
1457the colour code used as default foreground/text colour (or the string
1458<code>default</code> to indicate that the default-colour escape sequence is to be
1459used), <code>bg</code> is the colour code used as default background colour (or the
1460string <code>default</code>), and <code>xpm</code> is the string <code>default</code> if rxvt
1461was compiled with XPM support. Libraries like <code>ncurses</code> and <code>slang</code> can
1462(and do) use this information to optimize screen output.
1463</dd>
1464<p></p>
1465<dt><strong><a name="item_windowid"><strong>WINDOWID</strong></a></strong><br />
1466</dt>
1467<dd>
1468Set to the (decimal) X Window ID of the rxvt window (the toplevel
1469window, which usually has subwindows for the scrollbar, the terminal
1470window and so on).
1471</dd>
1472<p></p>
1473<dt><strong><a name="item_terminfo"><strong>TERMINFO</strong></a></strong><br />
1474</dt>
1475<dd>
1476Set to the terminfo directory iff rxvt was configured with
1477<code>--with-terminfo=PATH</code>.
1478</dd>
1479<p></p>
1480<dt><strong><a name="item_display"><strong>DISPLAY</strong></a></strong><br />
1481</dt>
1482<dd>
1483Used by rxvt to connect to the display and set to the correct
1484display in it's child processes.
1485</dd>
1486<p></p>
1487<dt><strong><a name="item_shell"><strong>SHELL</strong></a></strong><br />
1488</dt>
1489<dd>
1490The shell to be used for command execution, defaults to <code>/bin/sh</code>.
1491</dd>
1492<p></p>
1493<dt><strong><a name="item_rxvtpath"><strong>RXVTPATH</strong></a></strong><br />
1494</dt>
1495<dd>
1496The path where rxvt looks for support files such as menu and xpm
1497files.
1498</dd>
1499<p></p>
1500<dt><strong><a name="item_path"><strong>PATH</strong></a></strong><br />
1501</dt>
1502<dd>
1503Used in the same way as <a href="#item_rxvtpath"><code>RXVTPATH</code></a>.
1504</dd>
1505<p></p>
1506<dt><strong><a name="item_rxvt_socket"><strong>RXVT_SOCKET</strong></a></strong><br />
1507</dt>
1508<dd>
1509The unix domain socket path used by <code>rxvtc(1)</code> and
1510rxvtd(1).
1511</dd>
1512<dd>
1513<p>Default <code>$HOME/.rxvt-unicode-&lt;nodename</code>.</p>
1514</dd>
1515<p></p>
1516<dt><strong><a name="item_home"><strong>HOME</strong></a></strong><br />
1517</dt>
1518<dd>
1519Used to locate the default directory for the unix domain socket for
1520daemon communications and to locate various resource files (such as
1521<code>.Xdefaults</code>)
1522</dd>
1523<p></p>
1524<dt><strong><a name="item_xapplresdir"><strong>XAPPLRESDIR</strong></a></strong><br />
1525</dt>
1526<dd>
1527Directory where various X resource files are being located.
1528</dd>
1529<p></p>
1530<dt><strong><a name="item_xenvironment"><strong>XENVIRONMENT</strong></a></strong><br />
1531</dt>
1532<dd>
1533If set and accessible, gives the name of a X resource file to be loaded by
1534rxvt.
1535</dd>
1536<p></p></dl>
1400<p> 1537<p>
1401</p> 1538</p>
1402<hr /> 1539<hr />
1403<h1><a name="files">FILES</a></h1> 1540<h1><a name="files">FILES</a></h1>
1404<dl> 1541<dl>
… …
1426<h1><a name="current_project_coordinator">CURRENT PROJECT COORDINATOR</a></h1> 1563<h1><a name="current_project_coordinator">CURRENT PROJECT COORDINATOR</a></h1>
1427<dl> 1564<dl>
1428<dt><strong><a name="item_project_coordinator">Project Coordinator</a></strong><br /> 1565<dt><strong><a name="item_project_coordinator">Project Coordinator</a></strong><br />
1429</dt> 1566</dt>
1430<dd> 1567<dd>
1431Marc A. Lehmann <em><a href="mailto:rxvt@schmorp.de">rxvt@schmorp.de</a></em> 1568Marc 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> 1569</dd>
1437Marc A. Lehmann <em><a href="mailto:rxvt@schmorp.de">rxvt@schmorp.de</a></em>
1438</dd> 1570<dd>
1439<dd>
1440<p><a href="http://software.schmorp.de/">http://software.schmorp.de/</a></p> 1571<p><a href="http://software.schmorp.de/#rxvt-unicode">http://software.schmorp.de/#rxvt-unicode</a></p>
1441</dd> 1572</dd>
1442<p></p></dl> 1573<p></p></dl>
1443<p> 1574<p>
1444</p> 1575</p>
1445<hr /> 1576<hr />
… …
1483<dd> 1614<dd>
1484Rewrote screen display and text selection routines. Project Coordinator 1615Rewrote screen display and text selection routines. Project Coordinator
1485(changes.txt 2.4.6 - rxvt-unicode) 1616(changes.txt 2.4.6 - rxvt-unicode)
1486</dd> 1617</dd>
1487<p></p> 1618<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 /> 1619<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> 1620</dt>
1490<dd> 1621<dd>
1491Forked rxvt-unicode, rewrote most of the display code and internal 1622Forked rxvt-unicode, rewrote most of the display code and internal
1492character handling to store text in unicode, improve xterm 1623character handling to store text in unicode, improve xterm
1493compatibility and apply numerous other bugfixes and extensions. 1624compatibility and apply numerous other bugfixes and extensions.

Diff Legend

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