| 1 | =head1 Rxvt Technical Reference |
1 | =head1 RXVT TECHNICAL REFERENCE |
| 2 | |
|
|
| 3 | Marc Lehmann <rxvt@schmorp.de>, converted to pod and reworked from the |
|
|
| 4 | original Rxvt documentation by Geoff Wing <gcw@pobox.com>, who in turn used |
|
|
| 5 | the XTerm documentation and other sources. |
|
|
| 6 | |
2 | |
| 7 | =head1 Definitions |
3 | =head1 Definitions |
| 8 | |
4 | |
| 9 | =over 4 |
5 | =over 4 |
| 10 | |
6 | |
| … | |
… | |
| 37 | =over 4 |
33 | =over 4 |
| 38 | |
34 | |
| 39 | =item B<< C<ENQ> >> |
35 | =item B<< C<ENQ> >> |
| 40 | |
36 | |
| 41 | Enquiry (Ctrl-E) = Send Device Attributes (DA) |
37 | Enquiry (Ctrl-E) = Send Device Attributes (DA) |
| 42 | request attributes from terminal == |
38 | request attributes from terminal. See B<< C<ESC [ Ps c> >>. |
| 43 | |
39 | |
| 44 | =item B<< C<BEL> >> |
40 | =item B<< C<BEL> >> |
| 45 | |
41 | |
| 46 | Bell (Ctrl-G) |
42 | Bell (Ctrl-G) |
| 47 | |
43 | |
| … | |
… | |
| 139 | Single Shift Select of G3 Character Set (SS3): affects next character |
135 | Single Shift Select of G3 Character Set (SS3): affects next character |
| 140 | only I<unimplemented> |
136 | only I<unimplemented> |
| 141 | |
137 | |
| 142 | =item B<< C<ESC Z> >> |
138 | =item B<< C<ESC Z> >> |
| 143 | |
139 | |
| 144 | Obsolete form of returns: B<< C<ESC[?1;2C> >> I<rxvt compile-time option> |
140 | Obsolete form of returns: B<< C<ESC[?1;2C> >> I<rxvt-unicode compile-time option> |
| 145 | |
141 | |
| 146 | =item B<< C<ESC c> >> |
142 | =item B<< C<ESC c> >> |
| 147 | |
143 | |
| 148 | Full reset (RIS) |
144 | Full reset (RIS) |
| 149 | |
145 | |
| … | |
… | |
| 298 | |
294 | |
| 299 | Move backward B<< C<Ps> >> [default: 1] tab stops |
295 | Move backward B<< C<Ps> >> [default: 1] tab stops |
| 300 | |
296 | |
| 301 | =item B<< C<ESC [ Ps '> >> |
297 | =item B<< C<ESC [ Ps '> >> |
| 302 | |
298 | |
| 303 | == |
299 | See B<< C<ESC [ Ps G> >> |
| 304 | |
300 | |
| 305 | =item B<< C<ESC [ Ps a> >> |
301 | =item B<< C<ESC [ Ps a> >> |
| 306 | |
302 | |
| 307 | ==X<ESCOBPsc> |
303 | See B<< C<ESC [ Ps C> >> |
| 308 | |
304 | |
| 309 | =item B<< C<ESC [ Ps c> >> |
305 | =item B<< C<ESC [ Ps c> >> |
| 310 | |
306 | |
| 311 | Send Device Attributes (DA) |
307 | Send Device Attributes (DA) |
| 312 | B<< C<Ps = 0> >> (or omitted): request attributes from terminal |
308 | B<< C<Ps = 0> >> (or omitted): request attributes from terminal |
| … | |
… | |
| 317 | |
313 | |
| 318 | Cursor to Line B<< C<Ps> >> (VPA) |
314 | Cursor to Line B<< C<Ps> >> (VPA) |
| 319 | |
315 | |
| 320 | =item B<< C<ESC [ Ps e> >> |
316 | =item B<< C<ESC [ Ps e> >> |
| 321 | |
317 | |
| 322 | == |
318 | See B<< C<ESC [ Ps A> >> |
| 323 | |
319 | |
| 324 | =item B<< C<ESC [ Ps;Ps f> >> |
320 | =item B<< C<ESC [ Ps;Ps f> >> |
| 325 | |
321 | |
| 326 | Horizontal and Vertical Position [row;column] (HVP) [default: 1;1] |
322 | Horizontal and Vertical Position [row;column] (HVP) [default: 1;1] |
| 327 | |
323 | |
| … | |
… | |
| 539 | B<< C<h> >> Send Mouse X & Y on button press. |
535 | B<< C<h> >> Send Mouse X & Y on button press. |
| 540 | B<< C<l> >> No mouse reporting. |
536 | B<< C<l> >> No mouse reporting. |
| 541 | |
537 | |
| 542 | =end table |
538 | =end table |
| 543 | |
539 | |
| 544 | )X<Priv10> |
540 | X<Priv10> |
| 545 | |
541 | |
| 546 | =item B<< C<Ps = 10> >> (B<rxvt>) |
542 | =item B<< C<Ps = 10> >> (B<rxvt>) |
| 547 | |
543 | |
| 548 | =begin table |
544 | =begin table |
| 549 | |
545 | |
| … | |
… | |
| 625 | |
621 | |
| 626 | =item B<< C<Ps = 66> >> |
622 | =item B<< C<Ps = 66> >> |
| 627 | |
623 | |
| 628 | =begin table |
624 | =begin table |
| 629 | |
625 | |
| 630 | B<< C<h> >> Application Keypad (DECPAM) == |
626 | B<< C<h> >> Application Keypad (DECPAM) == C<ESC => |
| 631 | B<< C<l> >> Normal Keypad (DECPNM) == |
627 | B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >> |
| 632 | |
628 | |
| 633 | =end table |
629 | =end table |
| 634 | |
630 | |
| 635 | =item B<< C<Ps = 67> >> |
631 | =item B<< C<Ps = 67> >> |
| 636 | |
632 | |
| … | |
… | |
| 729 | B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >> I<rxvt compile-time option> |
725 | B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >> I<rxvt compile-time option> |
| 730 | B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented> |
726 | B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented> |
| 731 | B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >> I<rxvt compile-time option> |
727 | B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >> I<rxvt compile-time option> |
| 732 | B<< C<Ps = 50> >> Set fontset to B<< C<Pt> >>, with the following special values of B<< C<Pt> >> (B<rxvt>) B<< C<#+n> >> change up B<< C<n> >> B<< C<#-n> >> change down B<< C<n> >> if B<< C<n> >> is missing of 0, a value of 1 is used I<empty> change to font0 B<< C<n> >> change to font B<< C<n> >> |
728 | B<< C<Ps = 50> >> Set fontset to B<< C<Pt> >>, with the following special values of B<< C<Pt> >> (B<rxvt>) B<< C<#+n> >> change up B<< C<n> >> B<< C<#-n> >> change down B<< C<n> >> if B<< C<n> >> is missing of 0, a value of 1 is used I<empty> change to font0 B<< C<n> >> change to font B<< C<n> >> |
| 733 | B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> |
729 | B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> |
| 734 | B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (@@RXVTNAME@@ extension) |
730 | B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (@@RXVT_NAME@@ extension) |
| 735 | B<< C<Ps = 702> >> find font for character, used for debugging (@@RXVTNAME@@ extension) |
731 | B<< C<Ps = 702> >> find font for character, used for debugging (@@RXVT_NAME@@ extension) |
| 736 | B<< C<Ps = 703> >> command B<< C<Pt> >> I<rxvt compile-time option> (@@RXVTNAME@@ extension) |
732 | B<< C<Ps = 703> >> command B<< C<Pt> >> I<rxvt compile-time option> (@@RXVT_NAME@@ extension) |
| 737 | |
733 | |
| 738 | =end table |
734 | =end table |
| 739 | |
735 | |
| 740 | =back |
736 | =back |
| 741 | |
737 | |
| … | |
… | |
| 1320 | |
1316 | |
| 1321 | Row = B<< C<< <y> - SPACE >> >> |
1317 | Row = B<< C<< <y> - SPACE >> >> |
| 1322 | |
1318 | |
| 1323 | =back |
1319 | =back |
| 1324 | X<KeyCodes> |
1320 | X<KeyCodes> |
| 1325 | |
|
|
| 1326 | =head1 ISO 14755 support |
|
|
| 1327 | |
|
|
| 1328 | Partial ISO 14755-support is implemented. that means that pressing |
|
|
| 1329 | |
|
|
| 1330 | section 5.1: Control and Shift together enters unicode input |
|
|
| 1331 | mode. Entering hex digits composes a Unicode character, pressing space or |
|
|
| 1332 | releasing the modifiers commits the keycode and every other key cancels |
|
|
| 1333 | the current input character. |
|
|
| 1334 | |
|
|
| 1335 | section 5.2: Pressing and immediately releasing Control and Shift together |
|
|
| 1336 | enters keycap entry mode for the next key: pressing a function key (tab, |
|
|
| 1337 | return etc..) will enter the unicode character corresponding to the given |
|
|
| 1338 | key. |
|
|
| 1339 | |
1321 | |
| 1340 | =head1 Key Codes |
1322 | =head1 Key Codes |
| 1341 | |
1323 | |
| 1342 | Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20> |
1324 | Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20> |
| 1343 | |
1325 | |
| … | |
… | |
| 1408 | XK_KP_8 8 ESC O x |
1390 | XK_KP_8 8 ESC O x |
| 1409 | XK_KP_9 9 ESC O y |
1391 | XK_KP_9 9 ESC O y |
| 1410 | |
1392 | |
| 1411 | =end table |
1393 | =end table |
| 1412 | |
1394 | |
|
|
1395 | =head1 CONFIGURE OPTIONS |
|
|
1396 | |
|
|
1397 | General hint: if you get compile errors, then likely your configuration |
|
|
1398 | hasn't been tested well. Either try with --enable-everything or use the |
|
|
1399 | ./reconf script as a base for experiments. ./reconf is used by myself, |
|
|
1400 | so it should generally be a working config. Of course, you should always |
|
|
1401 | report when a combination doesn't work, so it can be fixed. Marc Lehmann |
|
|
1402 | <rxvt@schmorp.de>. |
|
|
1403 | |
|
|
1404 | =over 4 |
|
|
1405 | |
|
|
1406 | =item --enable-everything |
|
|
1407 | |
|
|
1408 | Add support for all non-multichoice options listed in "./configure |
|
|
1409 | --help". Note that unlike other enable options this is order dependant. |
|
|
1410 | You can specify this and then disable options which this enables by |
|
|
1411 | I<following> this with the appropriate commands. |
|
|
1412 | |
|
|
1413 | =item --enable-xft |
|
|
1414 | |
|
|
1415 | Add support for Xft (anti-aliases, among others) fonts. Xft fonts are |
|
|
1416 | slower and require lots of memory, but as long as you don't use them, you |
|
|
1417 | don't pay for them. |
|
|
1418 | |
|
|
1419 | =item --with-codesets=NAME,... |
|
|
1420 | |
|
|
1421 | Compile in support for additional codeset groups: |
|
|
1422 | |
|
|
1423 | =begin table |
|
|
1424 | |
|
|
1425 | all all of the above |
|
|
1426 | cn common chinese encodings |
|
|
1427 | cn_ext rarely used but very big chinese encodigs |
|
|
1428 | jp common japanese encodings |
|
|
1429 | jp_ext rarely used but big japanese encodings |
|
|
1430 | kr korean encodings |
|
|
1431 | |
|
|
1432 | =end table |
|
|
1433 | |
|
|
1434 | =item --enable-xim |
|
|
1435 | |
|
|
1436 | Add support for XIM (X Input Method) protocol. This allows using |
|
|
1437 | alternative input methods (e.g. kinput2) and will also correctly |
|
|
1438 | set up the input for people using dead keys or compose keys. |
|
|
1439 | |
|
|
1440 | =item --enable-unicode3 |
|
|
1441 | |
|
|
1442 | Enable direct support for displaying unicode codepoints above |
|
|
1443 | 65535 (the basic multilingual page). This increases storage |
|
|
1444 | requirements per character from 2 to 4 bytes. X11 fonts do not yet |
|
|
1445 | support these extra characters, but Xft does. |
|
|
1446 | |
|
|
1447 | Please note that rxvt-unicode can store unicode code points >65535 |
|
|
1448 | even without this flag, but the number of such characters is |
|
|
1449 | limited to a view thousand (shared with combining characters, |
|
|
1450 | see next switch), and right now rxvt-unicode cannot display them |
|
|
1451 | (input/output and cut&paste still work, though). |
|
|
1452 | |
|
|
1453 | =item --enable-combining |
|
|
1454 | |
|
|
1455 | Enable automatic composition of combining characters into |
|
|
1456 | composite characters. This is required for proper viewing of text |
|
|
1457 | where accents are encoded as seperate unicode characters. This is |
|
|
1458 | done by using precomposited characters when available or creating |
|
|
1459 | new pseudo-characters when no precomposed form exists. |
|
|
1460 | |
|
|
1461 | Without --enable-unicode3, the number of additional precomposed |
|
|
1462 | characters is rather limited (2048, if this is full, rxvt will use the |
|
|
1463 | private use area, extending the number of combinations to 8448). With |
|
|
1464 | --enable-unicode3, no practical limit exists. This will also enable |
|
|
1465 | storage of characters >65535. |
|
|
1466 | |
|
|
1467 | The combining table also contains entries for arabic presentation forms, |
|
|
1468 | but these are not currently used. Bug me if you want these to be used. |
|
|
1469 | |
|
|
1470 | =item --enable-fallback(=CLASS) |
|
|
1471 | |
|
|
1472 | When reading resource settings, also read settings for class CLASS |
|
|
1473 | (default: Rxvt). To disable resource fallback use --disable-fallback. |
|
|
1474 | |
|
|
1475 | =item --with-res-name=NAME |
|
|
1476 | |
|
|
1477 | Use the given name (default: urxvt) as default application name when |
|
|
1478 | reading resources. Specify --with-res-name=rxvt to replace rxvt. |
|
|
1479 | |
|
|
1480 | =item --with-res-class=CLASS |
|
|
1481 | |
|
|
1482 | Use the given class (default: URxvt) as default application class |
|
|
1483 | when reading resources. Specify --with-res-class=Rxvt to replace |
|
|
1484 | rxvt. |
|
|
1485 | |
|
|
1486 | =item --enable-utmp |
|
|
1487 | |
|
|
1488 | Write user and tty to utmp file (used by programs like F<w>) at |
|
|
1489 | start of rxvt execution and delete information when rxvt exits. |
|
|
1490 | |
|
|
1491 | =item --enable-wtmp |
|
|
1492 | |
|
|
1493 | Write user and tty to wtmp file (used by programs like F<last>) at |
|
|
1494 | start of rxvt execution and write logout when rxvt exits. This |
|
|
1495 | option requires --enable-utmp to also be specified. |
|
|
1496 | |
|
|
1497 | =item --enable-lastlog |
|
|
1498 | |
|
|
1499 | Write user and tty to lastlog file (used by programs like |
|
|
1500 | F<lastlogin>) at start of rxvt execution. This option requires |
|
|
1501 | --enable-utmp to also be specified. |
|
|
1502 | |
|
|
1503 | =item --enable-xpm-background |
|
|
1504 | |
|
|
1505 | Add support for XPM background pixmaps. |
|
|
1506 | |
|
|
1507 | =item --enable-transparency |
|
|
1508 | |
|
|
1509 | Add support for inheriting parent backgrounds thus giving a fake |
|
|
1510 | transparency to the term. |
|
|
1511 | |
|
|
1512 | =item --enable-fading |
|
|
1513 | |
|
|
1514 | Add support for fading the text when focus is lost. |
|
|
1515 | |
|
|
1516 | =item --enable-tinting |
|
|
1517 | |
|
|
1518 | Add support for tinting of transparent backgrounds. |
|
|
1519 | |
|
|
1520 | =item --enable-menubar |
|
|
1521 | |
|
|
1522 | Add support for our menu bar system (this interacts badly with |
|
|
1523 | dynamic locale switching currently). |
|
|
1524 | |
|
|
1525 | =item --enable-rxvt-scroll |
|
|
1526 | |
|
|
1527 | Add support for the original rxvt scrollbar. |
|
|
1528 | |
|
|
1529 | =item --enable-next-scroll |
|
|
1530 | |
|
|
1531 | Add support for a NeXT-like scrollbar. |
|
|
1532 | |
|
|
1533 | =item --enable-xterm-scroll |
|
|
1534 | |
|
|
1535 | Add support for an Xterm-like scrollbar. |
|
|
1536 | |
|
|
1537 | =item --enable-plain-scroll |
|
|
1538 | |
|
|
1539 | Add support for a very unobtrusive, plain-looking scrollbar that |
|
|
1540 | is the favourite of the rxvt-unicode author, having used it for |
|
|
1541 | many years. |
|
|
1542 | |
|
|
1543 | =item --enable-half-shadow |
|
|
1544 | |
|
|
1545 | Make shadows on the scrollbar only half the normal width & height. |
|
|
1546 | only applicable to rxvt scrollbars. |
|
|
1547 | |
|
|
1548 | =item --enable-ttygid |
|
|
1549 | |
|
|
1550 | Change tty device setting to group "tty" - only use this if |
|
|
1551 | your system uses this type of security. |
|
|
1552 | |
|
|
1553 | =item --disable-backspace-key |
|
|
1554 | |
|
|
1555 | Disable any handling of the backspace key by us - let the X server |
|
|
1556 | do it. |
|
|
1557 | |
|
|
1558 | =item --disable-delete-key |
|
|
1559 | |
|
|
1560 | Disable any handling of the delete key by us - let the X server |
|
|
1561 | do it. |
|
|
1562 | |
|
|
1563 | =item --disable-resources |
|
|
1564 | |
|
|
1565 | Remove all resources checking. |
|
|
1566 | |
|
|
1567 | =item --enable-xgetdefault |
|
|
1568 | |
|
|
1569 | Make resources checking via XGetDefault() instead of our small |
|
|
1570 | version which only checks ~/.Xdefaults, or if that doesn't exist |
|
|
1571 | then ~/.Xresources. |
|
|
1572 | |
|
|
1573 | =item --enable-strings |
|
|
1574 | |
|
|
1575 | Add support for our possibly faster memset() function and other |
|
|
1576 | various routines, overriding your system's versions which may |
|
|
1577 | have been hand-crafted in assembly or may require extra libraries |
|
|
1578 | to link in. (this breaks ANSI-C rules and has problems on many |
|
|
1579 | GNU/Linux systems). |
|
|
1580 | |
|
|
1581 | =item --disable-swapscreen |
|
|
1582 | |
|
|
1583 | Remove support for swap screen. |
|
|
1584 | |
|
|
1585 | =item --enable-frills |
|
|
1586 | |
|
|
1587 | Add support for many small features that are not essential but nice to |
|
|
1588 | have. Normally you want this, but for very small binaries you may want to |
|
|
1589 | disable this. |
|
|
1590 | |
|
|
1591 | =item --enable-linespace |
|
|
1592 | |
|
|
1593 | Add support to provide user specified line spacing between text rows. |
|
|
1594 | |
|
|
1595 | =item --enable-keepscrolling |
|
|
1596 | |
|
|
1597 | Add support for continual scrolling of the display when you hold |
|
|
1598 | the mouse button down on a scrollbar arrow. |
|
|
1599 | |
|
|
1600 | =item --enable-mousewheel |
|
|
1601 | |
|
|
1602 | Add support for scrolling via mouse wheel or buttons 4 & 5. |
|
|
1603 | |
|
|
1604 | =item --enable-slipwheeling |
|
|
1605 | |
|
|
1606 | Add support for continual scrolling (using the mouse wheel as an |
|
|
1607 | accelerator) while the control key is held down. This option |
|
|
1608 | requires --enable-mousewheel to also be specified. |
|
|
1609 | |
|
|
1610 | =item --disable-new-selection |
|
|
1611 | |
|
|
1612 | Remove support for mouse selection style like that of xterm. |
|
|
1613 | |
|
|
1614 | =item --enable-dmalloc |
|
|
1615 | |
|
|
1616 | Use Gray Watson's malloc - which is good for debugging See |
|
|
1617 | http://www.letters.com/dmalloc/ for details If you use either this or the |
|
|
1618 | next option, you may need to edit src/Makefile after compiling to point |
|
|
1619 | DINCLUDE and DLIB to the right places. |
|
|
1620 | |
|
|
1621 | You can only use either this option and the following (should |
|
|
1622 | you use either) . |
|
|
1623 | |
|
|
1624 | =item --enable-dlmalloc |
|
|
1625 | |
|
|
1626 | Use Doug Lea's malloc - which is good for a production version |
|
|
1627 | See L<http://g.oswego.edu/dl/html/malloc.html> for details. |
|
|
1628 | |
|
|
1629 | =item --enable-smart-resize |
|
|
1630 | |
|
|
1631 | Add smart growth/shrink behaviour when changing font size via from hot |
|
|
1632 | keys. This should keep in a fixed position the rxvt corner which is |
|
|
1633 | closest to a corner of the screen. |
|
|
1634 | |
|
|
1635 | =item --enable-256-color |
|
|
1636 | |
|
|
1637 | Add support for 256 colours rather than the base 16 colours. |
|
|
1638 | |
|
|
1639 | This option will likely go away in the future. Speak up if you don't want |
|
|
1640 | this. |
|
|
1641 | |
|
|
1642 | =item --enable-cursor-blink |
|
|
1643 | |
|
|
1644 | Add support for a blinking cursor. |
|
|
1645 | |
|
|
1646 | =item --enable-pointer-blank |
|
|
1647 | |
|
|
1648 | Add support to have the pointer disappear when typing or inactive. |
|
|
1649 | |
|
|
1650 | =item --with-name=NAME |
|
|
1651 | |
|
|
1652 | Set the basename for the installed binaries (default: urxvt, resulting in |
|
|
1653 | urxvt, urxvtd etc.). Specify --with-name=rxvt to replace rxvt. |
|
|
1654 | |
|
|
1655 | =item --with-term=NAME |
|
|
1656 | |
|
|
1657 | Change the environmental variable for the terminal to NAME (default |
|
|
1658 | "rxvt") |
|
|
1659 | |
|
|
1660 | =item --with-terminfo=PATH |
|
|
1661 | |
|
|
1662 | Change the environmental variable for the path to the terminfo tree to |
|
|
1663 | PATH. |
|
|
1664 | |
|
|
1665 | =item --with-x |
|
|
1666 | |
|
|
1667 | Use the X Window System (pretty much default, eh?). |
|
|
1668 | |
|
|
1669 | =item --with-xpm-includes=DIR |
|
|
1670 | |
|
|
1671 | Look for the XPM includes in DIR. |
|
|
1672 | |
|
|
1673 | =item --with-xpm-library=DIR |
|
|
1674 | |
|
|
1675 | Look for the XPM library in DIR. |
|
|
1676 | |
|
|
1677 | =item --with-xpm |
|
|
1678 | |
|
|
1679 | Not needed - define via --enable-xpm-background. |
|
|
1680 | |
|
|
1681 | =back |
|
|
1682 | |
|
|
1683 | =head1 AUTHORS |
|
|
1684 | |
|
|
1685 | Marc Lehmann <rxvt@schmorp.de> converted this document to pod and |
|
|
1686 | reworked it from the original Rxvt documentation, which was done by Geoff |
|
|
1687 | Wing <gcw@pobox.com>, who in turn used the XTerm documentation and other |
|
|
1688 | sources. |
|
|
1689 | |
