ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.7.pod
(Generate patch)

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents):
Revision 1.1 by root, Thu Aug 12 20:42:12 2004 UTC vs.
Revision 1.12 by root, Mon Aug 16 00:17:27 2004 UTC

1=head1 Rxvt Technical Reference 1=head1 RXVT TECHNICAL REFERENCE
2
3Marc Lehmann <rxvt@schmorp.de>, converted to pod and reworked from the
4original Rxvt documentation by Geoff Wing <gcw@pobox.com>, who in turn used
5the 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
41Enquiry (Ctrl-E) = Send Device Attributes (DA) 37Enquiry (Ctrl-E) = Send Device Attributes (DA)
42request attributes from terminal == 38request attributes from terminal. See B<< C<ESC [ Ps c> >>.
43 39
44=item B<< C<BEL> >> 40=item B<< C<BEL> >>
45 41
46Bell (Ctrl-G) 42Bell (Ctrl-G)
47 43
139Single Shift Select of G3 Character Set (SS3): affects next character 135Single Shift Select of G3 Character Set (SS3): affects next character
140only I<unimplemented> 136only I<unimplemented>
141 137
142=item B<< C<ESC Z> >> 138=item B<< C<ESC Z> >>
143 139
144Obsolete form of returns: B<< C<ESC[?1;2C> >> I<rxvt compile-time option> 140Obsolete 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
148Full reset (RIS) 144Full reset (RIS)
149 145
191 187
192=back 188=back
193 189
194X<CSI> 190X<CSI>
195 191
196=head1 CSI (Code Sequence Introducer) Sequences 192=head1 CSI (Command Sequence Introducer) Sequences
197 193
198=over 4 194=over 4
199 195
200=item B<< C<ESC [ Ps @> >> 196=item B<< C<ESC [ Ps @> >>
201 197
298 294
299Move backward B<< C<Ps> >> [default: 1] tab stops 295Move 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== 299See 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> 303See B<< C<ESC [ Ps C> >>
308 304
309=item B<< C<ESC [ Ps c> >> 305=item B<< C<ESC [ Ps c> >>
310 306
311Send Device Attributes (DA) 307Send Device Attributes (DA)
312B<< C<Ps = 0> >> (or omitted): request attributes from terminal 308B<< C<Ps = 0> >> (or omitted): request attributes from terminal
317 313
318Cursor to Line B<< C<Ps> >> (VPA) 314Cursor 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== 318See 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
326Horizontal and Vertical Position [row;column] (HVP) [default: 1;1] 322Horizontal and Vertical Position [row;column] (HVP) [default: 1;1]
327 323
364 B<< C<h> >> Insert Mode (SMIR) 360 B<< C<h> >> Insert Mode (SMIR)
365 B<< C<l> >> Replace Mode (RMIR) 361 B<< C<l> >> Replace Mode (RMIR)
366 362
367=end table 363=end table
368 364
369=item B<< C<Ps = 20> >> I<unimplemented> 365=item B<< C<Ps = 20> >> (partially implemented)
370 366
371=begin table 367=begin table
372 368
373 B<< C<h> >> Automatic Newline (LNM) 369 B<< C<h> >> Automatic Newline (LNM)
374 B<< C<h> >> Normal Linefeed (LNM) 370 B<< C<l> >> Normal Linefeed (LNM)
375 371
376=end table 372=end table
377 373
378=back 374=back
379 375
382Character Attributes (SGR) 378Character Attributes (SGR)
383 379
384=begin table 380=begin table
385 381
386 B<< C<Ps = 0> >> Normal (default) 382 B<< C<Ps = 0> >> Normal (default)
387 B<< C<Ps = 1 / 22> >> On / Off Bold (bright fg) 383 B<< C<Ps = 1 / 21> >> On / Off Bold (bright fg)
384 B<< C<Ps = 3 / 23> >> On / Off Italic (NYI)
388 B<< C<Ps = 4 / 24> >> On / Off Underline 385 B<< C<Ps = 4 / 24> >> On / Off Underline
389 B<< C<Ps = 5 / 25> >> On / Off Blink (bright bg) 386 B<< C<Ps = 5 / 25> >> On / Off Slow Blink (bright bg)
387 B<< C<Ps = 6 / 26> >> On / Off Rapid Blink (bright bg)
388 B<< C<Ps = 7 / 27> >> On / Off Invisible (NYI)
390 B<< C<Ps = 7 / 27> >> On / Off Inverse 389 B<< C<Ps = 8 / 27> >> On / Off Inverse
391 B<< C<Ps = 30 / 40> >> fg/bg Black 390 B<< C<Ps = 30 / 40> >> fg/bg Black
392 B<< C<Ps = 31 / 41> >> fg/bg Red 391 B<< C<Ps = 31 / 41> >> fg/bg Red
393 B<< C<Ps = 32 / 42> >> fg/bg Green 392 B<< C<Ps = 32 / 42> >> fg/bg Green
394 B<< C<Ps = 33 / 43> >> fg/bg Yellow 393 B<< C<Ps = 33 / 43> >> fg/bg Yellow
395 B<< C<Ps = 34 / 44> >> fg/bg Blue 394 B<< C<Ps = 34 / 44> >> fg/bg Blue
396 B<< C<Ps = 35 / 45> >> fg/bg Magenta 395 B<< C<Ps = 35 / 45> >> fg/bg Magenta
397 B<< C<Ps = 36 / 46> >> fg/bg Cyan 396 B<< C<Ps = 36 / 46> >> fg/bg Cyan
398 B<< C<Ps = 37 / 47> >> fg/bg White 397 B<< C<Ps = 37 / 47> >> fg/bg White
399 B<< C<Ps = 39 / 49> >> fg/bg Default 398 B<< C<Ps = 39 / 49> >> fg/bg Default
399 B<< C<Ps = 90 / 100> >> fg/bg Bright Black
400 B<< C<Ps = 91 / 101> >> fg/bg Bright Red
401 B<< C<Ps = 92 / 102> >> fg/bg Bright Green
402 B<< C<Ps = 93 / 103> >> fg/bg Bright Yellow
403 B<< C<Ps = 94 / 104> >> fg/bg Bright Blue
404 B<< C<Ps = 95 / 105> >> fg/bg Bright Magenta
405 B<< C<Ps = 96 / 106> >> fg/bg Bright Cyan
406 B<< C<Ps = 97 / 107> >> fg/bg Bright White
407 B<< C<Ps = 99 / 109> >> fg/bg Bright Default
400 408
401=end table 409=end table
402 410
403=item B<< C<ESC [ Ps n> >> 411=item B<< C<ESC [ Ps n> >>
404 412
539 B<< C<h> >> Send Mouse X & Y on button press. 547 B<< C<h> >> Send Mouse X & Y on button press.
540 B<< C<l> >> No mouse reporting. 548 B<< C<l> >> No mouse reporting.
541 549
542=end table 550=end table
543 551
544)X<Priv10>
545
546=item B<< C<Ps = 10> >> (B<rxvt>) 552=item B<< C<Ps = 10> >> (B<rxvt>)
547 553
548=begin table 554=begin table
549 555
550 B<< C<h> >> visible 556 B<< C<h> >> menuBar visible
551 B<< C<l> >> invisible 557 B<< C<l> >> menuBar invisible
552 558
553=end table 559=end table
554 560
555=item B<< C<Ps = 25> >> 561=item B<< C<Ps = 25> >>
556 562
625 631
626=item B<< C<Ps = 66> >> 632=item B<< C<Ps = 66> >>
627 633
628=begin table 634=begin table
629 635
630 B<< C<h> >> Application Keypad (DECPAM) == 636 B<< C<h> >> Application Keypad (DECPAM) == C<ESC =>
631 B<< C<l> >> Normal Keypad (DECPNM) == 637 B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >>
632 638
633=end table 639=end table
634 640
635=item B<< C<Ps = 67> >> 641=item B<< C<Ps = 67> >>
636 642
657 B<< C<h> >> Use Hilite Mouse Tracking. 663 B<< C<h> >> Use Hilite Mouse Tracking.
658 B<< C<l> >> No mouse reporting. 664 B<< C<l> >> No mouse reporting.
659 665
660=end table 666=end table
661 667
662=item B<< C<Ps = 1010> >> 668=item B<< C<Ps = 1010> >> (B<rxvt>)
663 669
664=begin table 670=begin table
665 671
666 B<< C<h> >> Don't scroll to bottom on TTY output 672 B<< C<h> >> Don't scroll to bottom on TTY output
667 B<< C<l> >> Scroll to bottom on TTY output 673 B<< C<l> >> Scroll to bottom on TTY output
668 674
669=end table 675=end table
670 676
671=item B<< C<Ps = 1011> >> 677=item B<< C<Ps = 1011> >> (B<rxvt>)
672 678
673=begin table 679=begin table
674 680
675 B<< C<h> >> Scroll to bottom when a key is pressed 681 B<< C<h> >> Scroll to bottom when a key is pressed
676 B<< C<l> >> Don't scroll to bottom when a key is pressed 682 B<< C<l> >> Don't scroll to bottom when a key is pressed
690 696
691=begin table 697=begin table
692 698
693 B<< C<h> >> Save cursor position 699 B<< C<h> >> Save cursor position
694 B<< C<l> >> Restore cursor position 700 B<< C<l> >> Restore cursor position
701
702=end table
703
704=item B<< C<Ps = 1049> >>
705
706=begin table
707
708 B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it
709 B<< C<l> >> Use Normal Screen Buffer
695 710
696=end table 711=end table
697 712
698=back 713=back
699 714
729 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >> I<rxvt compile-time option> 744 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> 745 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> 746 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> >> 747 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> >> 748 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) 749 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) 750 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) 751 B<< C<Ps = 703> >> menubar command B<< C<Pt> >> I<rxvt compile-time option> (@@RXVT_NAME@@ extension)
737 752
738=end table 753=end table
739 754
740=back 755=back
741 756
1320 1335
1321Row = B<< C<< <y> - SPACE >> >> 1336Row = B<< C<< <y> - SPACE >> >>
1322 1337
1323=back 1338=back
1324X<KeyCodes> 1339X<KeyCodes>
1325
1326=head1 ISO 14755 support
1327
1328Partial ISO 14755-support is implemented. that means that pressing
1329
1330section 5.1: Control and Shift together enters unicode input
1331mode. Entering hex digits composes a Unicode character, pressing space or
1332releasing the modifiers commits the keycode and every other key cancels
1333the current input character.
1334
1335section 5.2: Pressing and immediately releasing Control and Shift together
1336enters keycap entry mode for the next key: pressing a function key (tab,
1337return etc..) will enter the unicode character corresponding to the given
1338key.
1339 1340
1340=head1 Key Codes 1341=head1 Key Codes
1341 1342
1342Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20> 1343Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20>
1343 1344
1408 XK_KP_8 8 ESC O x 1409 XK_KP_8 8 ESC O x
1409 XK_KP_9 9 ESC O y 1410 XK_KP_9 9 ESC O y
1410 1411
1411=end table 1412=end table
1412 1413
1414=head1 CONFIGURE OPTIONS
1415
1416General hint: if you get compile errors, then likely your configuration
1417hasn't been tested well. Either try with --enable-everything or use the
1418./reconf script as a base for experiments. ./reconf is used by myself,
1419so it should generally be a working config. Of course, you should always
1420report when a combination doesn't work, so it can be fixed. Marc Lehmann
1421<rxvt@schmorp.de>.
1422
1423=over 4
1424
1425=item --enable-everything
1426
1427Add support for all non-multichoice options listed in "./configure
1428--help". Note that unlike other enable options this is order dependant.
1429You can specify this and then disable options which this enables by
1430I<following> this with the appropriate commands.
1431
1432=item --enable-xft
1433
1434Add support for Xft (anti-aliases, among others) fonts. Xft fonts are
1435slower and require lots of memory, but as long as you don't use them, you
1436don't pay for them.
1437
1438=item --with-codesets=NAME,...
1439
1440Compile in support for additional codeset (encoding) groups. These codeset
1441tables are currently only used for driving X11 core fonts, they are not
1442required for Xft fonts. Compiling them in will make your binary bigger
1443(together about 700kB), but it doesn't increase memory usage unless you
1444use an X11 font requiring one of these encodings.
1445
1446=begin table
1447
1448 all all available codeset groups
1449 cn common chinese encodings
1450 cn_ext rarely used but very big chinese encodigs
1451 jp common japanese encodings
1452 jp_ext rarely used but big japanese encodings
1453 kr korean encodings
1454
1455=end table
1456
1457=item --enable-xim
1458
1459Add support for XIM (X Input Method) protocol. This allows using
1460alternative input methods (e.g. kinput2) and will also correctly
1461set up the input for people using dead keys or compose keys.
1462
1463=item --enable-unicode3
1464
1465Enable direct support for displaying unicode codepoints above
146665535 (the basic multilingual page). This increases storage
1467requirements per character from 2 to 4 bytes. X11 fonts do not yet
1468support these extra characters, but Xft does.
1469
1470Please note that rxvt-unicode can store unicode code points >65535
1471even without this flag, but the number of such characters is
1472limited to a view thousand (shared with combining characters,
1473see next switch), and right now rxvt-unicode cannot display them
1474(input/output and cut&paste still work, though).
1475
1476=item --enable-combining
1477
1478Enable automatic composition of combining characters into
1479composite characters. This is required for proper viewing of text
1480where accents are encoded as seperate unicode characters. This is
1481done by using precomposited characters when available or creating
1482new pseudo-characters when no precomposed form exists.
1483
1484Without --enable-unicode3, the number of additional precomposed
1485characters is rather limited (2048, if this is full, rxvt will use the
1486private use area, extending the number of combinations to 8448). With
1487--enable-unicode3, no practical limit exists. This will also enable
1488storage of characters >65535.
1489
1490The combining table also contains entries for arabic presentation forms,
1491but these are not currently used. Bug me if you want these to be used.
1492
1493=item --enable-fallback(=CLASS)
1494
1495When reading resource settings, also read settings for class CLASS
1496(default: Rxvt). To disable resource fallback use --disable-fallback.
1497
1498=item --with-res-name=NAME
1499
1500Use the given name (default: urxvt) as default application name when
1501reading resources. Specify --with-res-name=rxvt to replace rxvt.
1502
1503=item --with-res-class=CLASS
1504
1505Use the given class (default: URxvt) as default application class
1506when reading resources. Specify --with-res-class=Rxvt to replace
1507rxvt.
1508
1509=item --enable-utmp
1510
1511Write user and tty to utmp file (used by programs like F<w>) at
1512start of rxvt execution and delete information when rxvt exits.
1513
1514=item --enable-wtmp
1515
1516Write user and tty to wtmp file (used by programs like F<last>) at
1517start of rxvt execution and write logout when rxvt exits. This
1518option requires --enable-utmp to also be specified.
1519
1520=item --enable-lastlog
1521
1522Write user and tty to lastlog file (used by programs like
1523F<lastlogin>) at start of rxvt execution. This option requires
1524--enable-utmp to also be specified.
1525
1526=item --enable-xpm-background
1527
1528Add support for XPM background pixmaps.
1529
1530=item --enable-transparency
1531
1532Add support for inheriting parent backgrounds thus giving a fake
1533transparency to the term.
1534
1535=item --enable-fading
1536
1537Add support for fading the text when focus is lost.
1538
1539=item --enable-tinting
1540
1541Add support for tinting of transparent backgrounds.
1542
1543=item --enable-menubar
1544
1545Add support for our menu bar system (this interacts badly with
1546dynamic locale switching currently).
1547
1548=item --enable-rxvt-scroll
1549
1550Add support for the original rxvt scrollbar.
1551
1552=item --enable-next-scroll
1553
1554Add support for a NeXT-like scrollbar.
1555
1556=item --enable-xterm-scroll
1557
1558Add support for an Xterm-like scrollbar.
1559
1560=item --enable-plain-scroll
1561
1562Add support for a very unobtrusive, plain-looking scrollbar that
1563is the favourite of the rxvt-unicode author, having used it for
1564many years.
1565
1566=item --enable-half-shadow
1567
1568Make shadows on the scrollbar only half the normal width & height.
1569only applicable to rxvt scrollbars.
1570
1571=item --enable-ttygid
1572
1573Change tty device setting to group "tty" - only use this if
1574your system uses this type of security.
1575
1576=item --disable-backspace-key
1577
1578Disable any handling of the backspace key by us - let the X server
1579do it.
1580
1581=item --disable-delete-key
1582
1583Disable any handling of the delete key by us - let the X server
1584do it.
1585
1586=item --disable-resources
1587
1588Remove all resources checking.
1589
1590=item --enable-xgetdefault
1591
1592Make resources checking via XGetDefault() instead of our small
1593version which only checks ~/.Xdefaults, or if that doesn't exist
1594then ~/.Xresources.
1595
1596=item --enable-strings
1597
1598Add support for our possibly faster memset() function and other
1599various routines, overriding your system's versions which may
1600have been hand-crafted in assembly or may require extra libraries
1601to link in. (this breaks ANSI-C rules and has problems on many
1602GNU/Linux systems).
1603
1604=item --disable-swapscreen
1605
1606Remove support for swap screen.
1607
1608=item --enable-frills
1609
1610Add support for many small features that are not essential but nice to
1611have. Normally you want this, but for very small binaries you may want to
1612disable this.
1613
1614=item --enable-iso14755
1615
1616Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
1617F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by
1618C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with
1619this switch.
1620
1621=item --enable-linespace
1622
1623Add support to provide user specified line spacing between text rows.
1624
1625=item --enable-keepscrolling
1626
1627Add support for continual scrolling of the display when you hold
1628the mouse button down on a scrollbar arrow.
1629
1630=item --enable-mousewheel
1631
1632Add support for scrolling via mouse wheel or buttons 4 & 5.
1633
1634=item --enable-slipwheeling
1635
1636Add support for continual scrolling (using the mouse wheel as an
1637accelerator) while the control key is held down. This option
1638requires --enable-mousewheel to also be specified.
1639
1640=item --disable-new-selection
1641
1642Remove support for mouse selection style like that of xterm.
1643
1644=item --enable-dmalloc
1645
1646Use Gray Watson's malloc - which is good for debugging See
1647http://www.letters.com/dmalloc/ for details If you use either this or the
1648next option, you may need to edit src/Makefile after compiling to point
1649DINCLUDE and DLIB to the right places.
1650
1651You can only use either this option and the following (should
1652you use either) .
1653
1654=item --enable-dlmalloc
1655
1656Use Doug Lea's malloc - which is good for a production version
1657See L<http://g.oswego.edu/dl/html/malloc.html> for details.
1658
1659=item --enable-smart-resize
1660
1661Add smart growth/shrink behaviour when changing font size via from hot
1662keys. This should keep in a fixed position the rxvt corner which is
1663closest to a corner of the screen.
1664
1665=item --enable-256-color
1666
1667Add support for 256 colours rather than the base 16 colours.
1668
1669This option will likely go away in the future. Speak up if you don't want
1670this.
1671
1672=item --enable-cursor-blink
1673
1674Add support for a blinking cursor.
1675
1676=item --enable-pointer-blank
1677
1678Add support to have the pointer disappear when typing or inactive.
1679
1680=item --with-name=NAME
1681
1682Set the basename for the installed binaries (default: urxvt, resulting in
1683urxvt, urxvtd etc.). Specify --with-name=rxvt to replace rxvt.
1684
1685=item --with-term=NAME
1686
1687Change the environmental variable for the terminal to NAME (default
1688"rxvt")
1689
1690=item --with-terminfo=PATH
1691
1692Change the environmental variable for the path to the terminfo tree to
1693PATH.
1694
1695=item --with-x
1696
1697Use the X Window System (pretty much default, eh?).
1698
1699=item --with-xpm-includes=DIR
1700
1701Look for the XPM includes in DIR.
1702
1703=item --with-xpm-library=DIR
1704
1705Look for the XPM library in DIR.
1706
1707=item --with-xpm
1708
1709Not needed - define via --enable-xpm-background.
1710
1711=back
1712
1713=head1 AUTHORS
1714
1715Marc Lehmann <rxvt@schmorp.de> converted this document to pod and
1716reworked it from the original Rxvt documentation, which was done by Geoff
1717Wing <gcw@pobox.com>, who in turn used the XTerm documentation and other
1718sources.
1719

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines