… | |
… | |
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.0</strong>, is a colour vt102 terminal |
53 | emulator intended as an <em>xterm</em>(1) replacement for users who do not |
53 | emulator intended as an <em>xterm</em>(1) replacement for users who do not |
54 | require features such as Tektronix 4014 emulation and toolkit-style |
54 | require features such as Tektronix 4014 emulation and toolkit-style |
55 | configurability. As a result, <strong>rxvt-unicode</strong> uses much less swap space -- |
55 | configurability. As a result, <strong>rxvt-unicode</strong> uses much less swap space -- |
56 | a significant advantage on a machine serving many X sessions.</p> |
56 | a 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 |
62 | asked questions and answer to them and some common problems.</p> |
62 | frequently asked questions and answer to them and some common |
|
|
63 | problems. 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> |
510 | Turn on/off secondary screen scroll (default enabled); resource |
512 | Turn 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> |
|
|
516 | <dt><strong><a name="item__2dkeysym_2esym_3a_string"><strong>-keysym.</strong><em>sym</em>: <em>string</em></a></strong><br /> |
|
|
517 | </dt> |
|
|
518 | <dd> |
|
|
519 | Remap a key symbol. See resource <strong>keysym</strong>. |
|
|
520 | </dd> |
|
|
521 | <p></p> |
514 | <dt><strong><a name="item__2dxrm_resourcestring"><strong>-xrm</strong> <em>resourcestring</em></a></strong><br /> |
522 | <dt><strong><a name="item__2dxrm_resourcestring"><strong>-xrm</strong> <em>resourcestring</em></a></strong><br /> |
515 | </dt> |
523 | </dt> |
516 | <dd> |
524 | <dd> |
517 | No effect on rxvt-unicode. Simply passes through an argument to be made |
525 | No effect on rxvt-unicode. Simply passes through an argument to be made |
518 | available in the instance's argument list. Appears in <em>WM_COMMAND</em> in |
526 | available in the instance's argument list. Appears in <em>WM_COMMAND</em> in |
… | |
… | |
527 | options) compiled into your version.</p> |
535 | options) compiled into your version.</p> |
528 | <p>There are two different methods that rxvt can use to get the |
536 | <p>There are two different methods that rxvt can use to get the |
529 | Xresource data: using the X libraries (Xrm*-functions) or internal |
537 | Xresource data: using the X libraries (Xrm*-functions) or internal |
530 | Xresources reader (<strong>~/.Xdefaults</strong>). For the first method (ie. |
538 | Xresources reader (<strong>~/.Xdefaults</strong>). For the first method (ie. |
531 | <strong>rxvt -h</strong> lists <strong>XGetDefaults</strong>), you can set and change the |
539 | <strong>rxvt -h</strong> lists <strong>XGetDefaults</strong>), you can set and change the |
532 | resources using X11 tools like <strong>xset</strong>. Many distribution do also load |
540 | resources using X11 tools like <strong>xrdb</strong>. Many distribution do also load |
533 | settings from the <strong>~/.Xresources</strong> file when X starts.</p> |
541 | settings from the <strong>~/.Xresources</strong> file when X starts. rxvt |
|
|
542 | will consult the following files/resources in order, with later settings |
|
|
543 | overwriting earlier ones:</p> |
|
|
544 | <pre> |
|
|
545 | 1. system-wide app-defaults file, either locale-dependent OR global |
|
|
546 | 2. app-defaults file in $XAPPLRESDIR |
|
|
547 | 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults |
|
|
548 | 4. SCREEN_RESOURCES for the current screen |
|
|
549 | 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename></pre> |
534 | <p>If compiled with internal Xresources support (i.e. <strong>rxvt -h</strong> |
550 | <p>If compiled with internal Xresources support (i.e. <strong>rxvt -h</strong> |
535 | lists <strong>.Xdefaults</strong>) then <strong>rxvt</strong> accepts application defaults |
551 | lists <strong>.Xdefaults</strong>) then <strong>rxvt</strong> accepts application defaults |
536 | set in XAPPLOADDIR/URxvt (compile-time defined: usually |
552 | set in XAPPLOADDIR/URxvt (compile-time defined: usually |
537 | <strong>/usr/lib/X11/app-defaults/URxvt</strong>) and resources set in |
553 | <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. |
554 | <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, |
1182 | <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 |
1183 | <code>^@</code>: null, <code>^A</code> ...) and may be enclosed with double quotes so that it |
1168 | can start or end with whitespace.</p> |
1184 | can start or end with whitespace.</p> |
1169 | </dd> |
1185 | </dd> |
1170 | <dd> |
1186 | <dd> |
|
|
1187 | <p>Please note that you need to double the <code>\</code> when using |
|
|
1188 | <code>--enable-xgetdefault</code>, as X itself does it's own de-escaping (you can |
|
|
1189 | use <code>\033</code> instead of <code>\e</code> (and so on), which will work with both Xt and |
|
|
1190 | rxvt's own processing).</p> |
|
|
1191 | </dd> |
|
|
1192 | <dd> |
1171 | <p>You can define a range of keysyms in one shot by providing a <em>string</em> |
1193 | <p>You can define a range of keysyms in one shot by providing a <em>string</em> |
1172 | with pattern <strong>list/PREFIX/MIDDLE/SUFFIX</strong>, where the delimeter `/' |
1194 | with pattern <strong>list/PREFIX/MIDDLE/SUFFIX</strong>, where the delimeter `/' |
1173 | should be a character not used by the strings.</p> |
1195 | should be a character not used by the strings.</p> |
1174 | </dd> |
1196 | </dd> |
1175 | <dd> |
1197 | <dd> |
1176 | <p>Its usage can be demonstrated by an example:</p> |
1198 | <p>Its usage can be demonstrated by an example:</p> |
1177 | </dd> |
1199 | </dd> |
1178 | <dd> |
1200 | <dd> |
1179 | <pre> |
1201 | <pre> |
1180 | URxvt.keysym.M-C-0x61: list|\e<M-C-|abc|></pre> |
1202 | URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|></pre> |
1181 | </dd> |
1203 | </dd> |
1182 | <dd> |
1204 | <dd> |
1183 | <p>The above line is equivalent to the following three lines:</p> |
1205 | <p>The above line is equivalent to the following three lines:</p> |
1184 | </dd> |
1206 | </dd> |
1185 | <dd> |
1207 | <dd> |
1186 | <pre> |
1208 | <pre> |
1187 | URxvt.keysym.Meta-Control-0x61: \e<M-C-a> |
1209 | URxvt.keysym.Meta-Control-0x61: \033<M-C-a> |
1188 | URxvt.keysym.Meta-Control-0x62: \e<M-C-b> |
1210 | URxvt.keysym.Meta-Control-0x62: \033<M-C-b> |
1189 | URxvt.keysym.Meta-Control-0x63: \e<M-C-c></pre> |
1211 | URxvt.keysym.Meta-Control-0x63: \033<M-C-c></pre> |
1190 | </dd> |
|
|
1191 | <dd> |
1212 | </dd> |
|
|
1213 | <dd> |
1192 | <p>If <em>string</em> takes the form of <code>proto:STRING</code>, the specified <strong>STRING</strong> |
1214 | <p>If <em>string</em> takes the form of <code>command:STRING</code>, the specified <strong>STRING</strong> |
1193 | is interpreted and executed as rxvt's control sequence. For |
1215 | is interpreted and executed as rxvt's control sequence. For |
1194 | example the following means ``change the current locale to <code>zh_CN.GBK</code> |
1216 | example the following means ``change the current locale to <code>zh_CN.GBK</code> |
1195 | when Control-Meta-c is being pressed'':</p> |
1217 | when Control-Meta-c is being pressed'':</p> |
1196 | </dd> |
1218 | </dd> |
1197 | <dd> |
1219 | <dd> |
1198 | <pre> |
1220 | <pre> |
1199 | URxvt.keysym.M-C-c: proto:\033]701;zh_CN.GBK\007</pre> |
1221 | URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007</pre> |
1200 | </dd> |
1222 | </dd> |
1201 | <dd> |
1223 | <dd> |
1202 | <p>The following example will map Control-Meta-1 and Control-Meta-2 to |
1224 | <p>The following example will map Control-Meta-1 and Control-Meta-2 to |
1203 | the fonts <code>suxuseuro</code> and <code>9x15bold</code>, so you cna have some limited |
1225 | the fonts <code>suxuseuro</code> and <code>9x15bold</code>, so you can have some limited |
1204 | font-switching at runtime:</p> |
1226 | font-switching at runtime:</p> |
1205 | </dd> |
1227 | </dd> |
1206 | <dd> |
1228 | <dd> |
1207 | <pre> |
1229 | <pre> |
1208 | URxvt.keysym.M-C-1: proto:\033]50;suxuseuro\007 |
1230 | URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 |
1209 | URxvt.keysym.M-C-2: proto:\033]50;9x15bold\007</pre> |
1231 | URxvt.keysym.M-C-2: command:\033]50;9x15bold\007</pre> |
1210 | </dd> |
|
|
1211 | <dd> |
1232 | </dd> |
1212 | <p><code>proto:\033]701;zh_CN.GBK\007</code> means: change the current locale to |
1233 | <dd> |
1213 | <code>zh_CN.GBK</code>.</p> |
1234 | <p>Other things are possible, e.g. resizing (see <code>rxvt(7)</code> for more |
|
|
1235 | info):</p> |
|
|
1236 | </dd> |
|
|
1237 | <dd> |
|
|
1238 | <pre> |
|
|
1239 | URxvt.keysym.M-C-3: command:\033[8;25;80t |
|
|
1240 | URxvt.keysym.M-C-4: command:\033[8;48;110t</pre> |
1214 | </dd> |
1241 | </dd> |
1215 | <p></p></dl> |
1242 | <p></p></dl> |
1216 | <p> |
1243 | <p> |
1217 | </p> |
1244 | </p> |
1218 | <hr /> |
1245 | <hr /> |
… | |
… | |
1232 | <p>To temporarily override mouse reporting, for either the scrollbar or |
1259 | <p>To temporarily override mouse reporting, for either the scrollbar or |
1233 | the normal text selection/insertion, hold either the Shift or the Meta |
1260 | the normal text selection/insertion, hold either the Shift or the Meta |
1234 | (Alt) key while performing the desired mouse action.</p> |
1261 | (Alt) key while performing the desired mouse action.</p> |
1235 | <p>If mouse reporting mode is active, the normal scrollbar actions are |
1262 | <p>If mouse reporting mode is active, the normal scrollbar actions are |
1236 | disabled -- on the assumption that we are using a fullscreen |
1263 | disabled -- on the assumption that we are using a fullscreen |
1237 | application. Instead, pressing Button1 and Button3 sends <strong>ESC[6~</strong> |
1264 | application. Instead, pressing Button1 and Button3 sends <strong>ESC [ 6 ~</strong> |
1238 | (Next) and <strong>ESC[5~</strong> (Prior), respectively. Similarly, clicking on the |
1265 | (Next) and <strong>ESC [ 5 ~</strong> (Prior), respectively. Similarly, clicking on the |
1239 | up and down arrows sends <strong>ESC[A</strong> (Up) and <strong>ESC[B</strong> (Down), |
1266 | up and down arrows sends <strong>ESC [ A</strong> (Up) and <strong>ESC [ B</strong> (Down), |
1240 | respectively.</p> |
1267 | respectively.</p> |
1241 | <p> |
1268 | <p> |
1242 | </p> |
1269 | </p> |
1243 | <hr /> |
1270 | <hr /> |
1244 | <h1><a name="text_selection_and_insertion">TEXT SELECTION AND INSERTION</a></h1> |
1271 | <h1><a name="text_selection_and_insertion">TEXT SELECTION AND INSERTION</a></h1> |
… | |
… | |
1389 | <p></p></dl> |
1416 | <p></p></dl> |
1390 | <p> |
1417 | <p> |
1391 | </p> |
1418 | </p> |
1392 | <hr /> |
1419 | <hr /> |
1393 | <h1><a name="environment">ENVIRONMENT</a></h1> |
1420 | <h1><a name="environment">ENVIRONMENT</a></h1> |
1394 | <p><strong>rxvt</strong> sets the environment variables <strong>TERM</strong>, <strong>COLORTERM</strong> |
1421 | <p><strong>rxvt</strong> sets and/or uses the following environment variables:</p> |
1395 | and <strong>COLORFGBG</strong>. The environment variable <strong>WINDOWID</strong> is set to the X |
1422 | <dl> |
1396 | window id number of the <strong>rxvt</strong> window and it also uses and |
1423 | <dt><strong><a name="item_term"><strong>TERM</strong></a></strong><br /> |
1397 | sets the environment variable <strong>DISPLAY</strong> to specify which display |
1424 | </dt> |
1398 | terminal to use. <strong>rxvt</strong> uses the environment variables |
1425 | <dd> |
1399 | <strong>RXVTPATH</strong> and <strong>PATH</strong> to find XPM files.</p> |
1426 | Normally set to <code>rxvt-unicode</code>, unless overwritten at configure time, via |
|
|
1427 | resources or on the commandline. |
|
|
1428 | </dd> |
|
|
1429 | <p></p> |
|
|
1430 | <dt><strong><a name="item_colorterm"><strong>COLORTERM</strong></a></strong><br /> |
|
|
1431 | </dt> |
|
|
1432 | <dd> |
|
|
1433 | Either <code>rxvt</code>, <code>rxvt-xpm</code>, depending on wether rxvt was |
|
|
1434 | compiled with XPM support, and optionally with the added extension |
|
|
1435 | <code>-mono</code> to indicate that rxvt-unicode runs on a monochrome screen. |
|
|
1436 | </dd> |
|
|
1437 | <p></p> |
|
|
1438 | <dt><strong><a name="item_colorfgbg"><strong>COLORFGBG</strong></a></strong><br /> |
|
|
1439 | </dt> |
|
|
1440 | <dd> |
|
|
1441 | Set to a string of the form <code>fg;bg</code> or <code>fg;xpm;bg</code>, where <code>fg</code> is |
|
|
1442 | the 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 |
|
|
1444 | used), <code>bg</code> is the colour code used as default background colour (or the |
|
|
1445 | string <code>default</code>), and <code>xpm</code> is the string <code>default</code> if rxvt |
|
|
1446 | was compiled with XPM support. Libraries like <code>slang</code> can (and do) use |
|
|
1447 | this information to optimize screen output. |
|
|
1448 | </dd> |
|
|
1449 | <p></p> |
|
|
1450 | <dt><strong><a name="item_windowid"><strong>WINDOWID</strong></a></strong><br /> |
|
|
1451 | </dt> |
|
|
1452 | <dd> |
|
|
1453 | Set to the (decimal) X Window ID of the rxvt window (the toplevel |
|
|
1454 | window, which usually has subwindows for the scrollbar, the terminal |
|
|
1455 | window and so on). |
|
|
1456 | </dd> |
|
|
1457 | <p></p> |
|
|
1458 | <dt><strong><a name="item_terminfo"><strong>TERMINFO</strong></a></strong><br /> |
|
|
1459 | </dt> |
|
|
1460 | <dd> |
|
|
1461 | Set to the terminfo directory iff rxvt was configured with |
|
|
1462 | <code>--with-terminfo=PATH</code>. |
|
|
1463 | </dd> |
|
|
1464 | <p></p> |
|
|
1465 | <dt><strong><a name="item_display"><strong>DISPLAY</strong></a></strong><br /> |
|
|
1466 | </dt> |
|
|
1467 | <dd> |
|
|
1468 | Used by rxvt to connect to the display and set to the correct |
|
|
1469 | display in it's child processes. |
|
|
1470 | </dd> |
|
|
1471 | <p></p> |
|
|
1472 | <dt><strong><a name="item_shell"><strong>SHELL</strong></a></strong><br /> |
|
|
1473 | </dt> |
|
|
1474 | <dd> |
|
|
1475 | The shell to be used for command execution, defaults to <code>/bin/sh</code>. |
|
|
1476 | </dd> |
|
|
1477 | <p></p> |
|
|
1478 | <dt><strong><a name="item_rxvtpath"><strong>RXVTPATH</strong></a></strong><br /> |
|
|
1479 | </dt> |
|
|
1480 | <dd> |
|
|
1481 | The path where rxvt looks for support files such as menu and xpm |
|
|
1482 | files. |
|
|
1483 | </dd> |
|
|
1484 | <p></p> |
|
|
1485 | <dt><strong><a name="item_path"><strong>PATH</strong></a></strong><br /> |
|
|
1486 | </dt> |
|
|
1487 | <dd> |
|
|
1488 | Used in the same way as <a href="#item_rxvtpath"><code>RXVTPATH</code></a>. |
|
|
1489 | </dd> |
|
|
1490 | <p></p> |
|
|
1491 | <dt><strong><a name="item_rxvt_socket"><strong>RXVT_SOCKET</strong></a></strong><br /> |
|
|
1492 | </dt> |
|
|
1493 | <dd> |
|
|
1494 | The unix domain socket path used by <code>rxvtc(1)</code> and |
|
|
1495 | rxvtd(1). |
|
|
1496 | </dd> |
|
|
1497 | <dd> |
|
|
1498 | <p>Default <code>$HOME/.rxvt-unicode-<nodename</code>.</p> |
|
|
1499 | </dd> |
|
|
1500 | <p></p> |
|
|
1501 | <dt><strong><a name="item_home"><strong>HOME</strong></a></strong><br /> |
|
|
1502 | </dt> |
|
|
1503 | <dd> |
|
|
1504 | Used to locate the default directory for the unix domain socket for |
|
|
1505 | daemon communications and to locate various resource files (such as |
|
|
1506 | <code>.Xdefaults</code>) |
|
|
1507 | </dd> |
|
|
1508 | <p></p> |
|
|
1509 | <dt><strong><a name="item_xapplresdir"><strong>XAPPLRESDIR</strong></a></strong><br /> |
|
|
1510 | </dt> |
|
|
1511 | <dd> |
|
|
1512 | Directory where various X resource files are being located. |
|
|
1513 | </dd> |
|
|
1514 | <p></p> |
|
|
1515 | <dt><strong><a name="item_xenvironment"><strong>XENVIRONMENT</strong></a></strong><br /> |
|
|
1516 | </dt> |
|
|
1517 | <dd> |
|
|
1518 | If set and accessible, gives the name of a X resource file to be loaded by |
|
|
1519 | rxvt. |
|
|
1520 | </dd> |
|
|
1521 | <p></p></dl> |
1400 | <p> |
1522 | <p> |
1401 | </p> |
1523 | </p> |
1402 | <hr /> |
1524 | <hr /> |
1403 | <h1><a name="files">FILES</a></h1> |
1525 | <h1><a name="files">FILES</a></h1> |
1404 | <dl> |
1526 | <dl> |
… | |
… | |
1424 | </p> |
1546 | </p> |
1425 | <hr /> |
1547 | <hr /> |
1426 | <h1><a name="current_project_coordinator">CURRENT PROJECT COORDINATOR</a></h1> |
1548 | <h1><a name="current_project_coordinator">CURRENT PROJECT COORDINATOR</a></h1> |
1427 | <dl> |
1549 | <dl> |
1428 | <dt><strong><a name="item_project_coordinator">Project Coordinator</a></strong><br /> |
1550 | <dt><strong><a name="item_project_coordinator">Project Coordinator</a></strong><br /> |
1429 | </dt> |
|
|
1430 | <dd> |
|
|
1431 | Marc A. Lehmann <em><a href="mailto:rxvt@schmorp.de">rxvt@schmorp.de</a></em> |
|
|
1432 | </dd> |
|
|
1433 | <p></p> |
|
|
1434 | <dt><strong><a name="item_web_page_maintainter">Web page maintainter</a></strong><br /> |
|
|
1435 | </dt> |
1551 | </dt> |
1436 | <dd> |
1552 | <dd> |
1437 | Marc A. Lehmann <em><a href="mailto:rxvt@schmorp.de">rxvt@schmorp.de</a></em> |
1553 | Marc A. Lehmann <em><a href="mailto:rxvt@schmorp.de">rxvt@schmorp.de</a></em> |
1438 | </dd> |
1554 | </dd> |
1439 | <dd> |
1555 | <dd> |