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.5 by root, Thu Aug 12 22:29:28 2004 UTC vs.
Revision 1.23 by root, Wed Aug 25 03:47:20 2004 UTC

1=head1 NAME
2
3RXVT TECHNICAL REFERENCE - command sequences and background information
4
5=head1 SYNOPSIS
6
7 # set a new font set
8 printf '\33]50;%s\007' 9x15,xft:Kochi" Mincho"
9
10 # change the locale and tell rxvt-unicode about it
11 export LC_CTYPE=ja_JP.EUC-JP; printf "\33]701;$LC_CTYPE\007"
12
13 # set window title
14 printf '\33]2;%s\007' "new window title"
15
16=head1 DESCRIPTION
17
18The rest of this document describes various technical aspects of
19B<rxvt-unicode>. First the description of supported command sequences,
20followed by menu and pixmap support and last by a description of all
21features selectable at C<configure> time.
22
1=head1 RXVT TECHNICAL REFERENCE 23=head1 RXVT TECHNICAL REFERENCE
2 24
3=head1 Definitions 25=head1 Definitions
4 26
5=over 4 27=over 4
149 171
150=item B<< C<ESC o> >> 172=item B<< C<ESC o> >>
151 173
152Invoke the G3 Character Set (LS3) 174Invoke the G3 Character Set (LS3)
153 175
154=item B<< C<ESC>(C<C> >> 176=item B<< C<ESC> ( C> >>
155 177
156Designate G0 Character Set (ISO 2022), see below for values of C<C>. 178Designate G0 Character Set (ISO 2022), see below for values of C<C>.
157 179
158=item B<< C<ESC>)C<C> >> 180=item B<< C<ESC> ) C> >>
159 181
160Designate G1 Character Set (ISO 2022), see below for values of C<C>. 182Designate G1 Character Set (ISO 2022), see below for values of C<C>.
161 183
162=item B<< C<ESC * C> >> 184=item B<< C<ESC * C> >>
163 185
187 209
188=back 210=back
189 211
190X<CSI> 212X<CSI>
191 213
192=head1 CSI (Code Sequence Introducer) Sequences 214=head1 CSI (Command Sequence Introducer) Sequences
193 215
194=over 4 216=over 4
195 217
196=item B<< C<ESC [ Ps @> >> 218=item B<< C<ESC [ Ps @> >>
197 219
330 B<< C<Ps = 0> >> Clear Current Column (default) 352 B<< C<Ps = 0> >> Clear Current Column (default)
331 B<< C<Ps = 3> >> Clear All (TBC) 353 B<< C<Ps = 3> >> Clear All (TBC)
332 354
333=end table 355=end table
334 356
357=item B<< C<ESC [ Pm h> >>
358
359Set Mode (SM). See B<< C<ESC [ Pm l> >> sequence for description of C<Pm>.
360
335=item B<< C<ESC [ Ps i> >> 361=item B<< C<ESC [ Ps i> >>
336 362
337Printing 363Printing. See also the C<print-pipe> resource.
338 364
339=begin table 365=begin table
340 366
367 B<< C<Ps = 0> >> print screen (MC0)
341 B<< C<Ps = 4> >> disable transparent print mode (MC4) 368 B<< C<Ps = 4> >> disable transparent print mode (MC4)
342 B<< C<Ps = 5> >> enable transparent print mode (MC5) I<unimplemented> 369 B<< C<Ps = 5> >> enable transparent print mode (MC5)
343 370
344=end table 371=end table
345
346=item B<< C<ESC [ Pm h> >>
347
348Set Mode (SM). See next sequence for description of C<Pm>.
349 372
350=item B<< C<ESC [ Pm l> >> 373=item B<< C<ESC [ Pm l> >>
351 374
352Reset Mode (RM) 375Reset Mode (RM)
353 376
360 B<< C<h> >> Insert Mode (SMIR) 383 B<< C<h> >> Insert Mode (SMIR)
361 B<< C<l> >> Replace Mode (RMIR) 384 B<< C<l> >> Replace Mode (RMIR)
362 385
363=end table 386=end table
364 387
365=item B<< C<Ps = 20> >> I<unimplemented> 388=item B<< C<Ps = 20> >> (partially implemented)
366 389
367=begin table 390=begin table
368 391
369 B<< C<h> >> Automatic Newline (LNM) 392 B<< C<h> >> Automatic Newline (LNM)
370 B<< C<h> >> Normal Linefeed (LNM) 393 B<< C<l> >> Normal Linefeed (LNM)
371 394
372=end table 395=end table
373 396
374=back 397=back
375 398
378Character Attributes (SGR) 401Character Attributes (SGR)
379 402
380=begin table 403=begin table
381 404
382 B<< C<Ps = 0> >> Normal (default) 405 B<< C<Ps = 0> >> Normal (default)
383 B<< C<Ps = 1 / 22> >> On / Off Bold (bright fg) 406 B<< C<Ps = 1 / 21> >> On / Off Bold (bright fg)
407 B<< C<Ps = 3 / 23> >> On / Off Italic
384 B<< C<Ps = 4 / 24> >> On / Off Underline 408 B<< C<Ps = 4 / 24> >> On / Off Underline
385 B<< C<Ps = 5 / 25> >> On / Off Blink (bright bg) 409 B<< C<Ps = 5 / 25> >> On / Off Slow Blink (bright bg)
410 B<< C<Ps = 6 / 26> >> On / Off Rapid Blink (bright bg)
386 B<< C<Ps = 7 / 27> >> On / Off Inverse 411 B<< C<Ps = 7 / 27> >> On / Off Inverse
412 B<< C<Ps = 8 / 27> >> On / Off Invisible (NYI)
387 B<< C<Ps = 30 / 40> >> fg/bg Black 413 B<< C<Ps = 30 / 40> >> fg/bg Black
388 B<< C<Ps = 31 / 41> >> fg/bg Red 414 B<< C<Ps = 31 / 41> >> fg/bg Red
389 B<< C<Ps = 32 / 42> >> fg/bg Green 415 B<< C<Ps = 32 / 42> >> fg/bg Green
390 B<< C<Ps = 33 / 43> >> fg/bg Yellow 416 B<< C<Ps = 33 / 43> >> fg/bg Yellow
391 B<< C<Ps = 34 / 44> >> fg/bg Blue 417 B<< C<Ps = 34 / 44> >> fg/bg Blue
392 B<< C<Ps = 35 / 45> >> fg/bg Magenta 418 B<< C<Ps = 35 / 45> >> fg/bg Magenta
393 B<< C<Ps = 36 / 46> >> fg/bg Cyan 419 B<< C<Ps = 36 / 46> >> fg/bg Cyan
420 B<< C<Ps = 38;5 / 48;5> >> set fg/bg to color #m (ISO 8613-6)
394 B<< C<Ps = 37 / 47> >> fg/bg White 421 B<< C<Ps = 37 / 47> >> fg/bg White
395 B<< C<Ps = 39 / 49> >> fg/bg Default 422 B<< C<Ps = 39 / 49> >> fg/bg Default
423 B<< C<Ps = 90 / 100> >> fg/bg Bright Black
424 B<< C<Ps = 91 / 101> >> fg/bg Bright Red
425 B<< C<Ps = 92 / 102> >> fg/bg Bright Green
426 B<< C<Ps = 93 / 103> >> fg/bg Bright Yellow
427 B<< C<Ps = 94 / 104> >> fg/bg Bright Blue
428 B<< C<Ps = 95 / 105> >> fg/bg Bright Magenta
429 B<< C<Ps = 96 / 106> >> fg/bg Bright Cyan
430 B<< C<Ps = 97 / 107> >> fg/bg Bright White
431 B<< C<Ps = 99 / 109> >> fg/bg Bright Default
396 432
397=end table 433=end table
398 434
399=item B<< C<ESC [ Ps n> >> 435=item B<< C<ESC [ Ps n> >>
400 436
535 B<< C<h> >> Send Mouse X & Y on button press. 571 B<< C<h> >> Send Mouse X & Y on button press.
536 B<< C<l> >> No mouse reporting. 572 B<< C<l> >> No mouse reporting.
537 573
538=end table 574=end table
539 575
540X<Priv10>
541
542=item B<< C<Ps = 10> >> (B<rxvt>) 576=item B<< C<Ps = 10> >> (B<rxvt>)
543 577
544=begin table 578=begin table
545 579
546 B<< C<h> >> visible 580 B<< C<h> >> menuBar visible
547 B<< C<l> >> invisible 581 B<< C<l> >> menuBar invisible
548 582
549=end table 583=end table
550 584
551=item B<< C<Ps = 25> >> 585=item B<< C<Ps = 25> >>
552 586
653 B<< C<h> >> Use Hilite Mouse Tracking. 687 B<< C<h> >> Use Hilite Mouse Tracking.
654 B<< C<l> >> No mouse reporting. 688 B<< C<l> >> No mouse reporting.
655 689
656=end table 690=end table
657 691
658=item B<< C<Ps = 1010> >> 692=item B<< C<Ps = 1010> >> (B<rxvt>)
659 693
660=begin table 694=begin table
661 695
662 B<< C<h> >> Don't scroll to bottom on TTY output 696 B<< C<h> >> Don't scroll to bottom on TTY output
663 B<< C<l> >> Scroll to bottom on TTY output 697 B<< C<l> >> Scroll to bottom on TTY output
664 698
665=end table 699=end table
666 700
667=item B<< C<Ps = 1011> >> 701=item B<< C<Ps = 1011> >> (B<rxvt>)
668 702
669=begin table 703=begin table
670 704
671 B<< C<h> >> Scroll to bottom when a key is pressed 705 B<< C<h> >> Scroll to bottom when a key is pressed
672 B<< C<l> >> Don't scroll to bottom when a key is pressed 706 B<< C<l> >> Don't scroll to bottom when a key is pressed
686 720
687=begin table 721=begin table
688 722
689 B<< C<h> >> Save cursor position 723 B<< C<h> >> Save cursor position
690 B<< C<l> >> Restore cursor position 724 B<< C<l> >> Restore cursor position
725
726=end table
727
728=item B<< C<Ps = 1049> >>
729
730=begin table
731
732 B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it
733 B<< C<l> >> Use Normal Screen Buffer
691 734
692=end table 735=end table
693 736
694=back 737=back
695 738
726 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented> 769 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
727 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >> I<rxvt compile-time option> 770 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >> I<rxvt compile-time option>
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> >> 771 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> >>
729 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> 772 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>
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) 773 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)
731 B<< C<Ps = 702> >> find font for character, used for debugging (@@RXVT_NAME@@ extension)
732 B<< C<Ps = 703> >> command B<< C<Pt> >> I<rxvt compile-time option> (@@RXVT_NAME@@ extension) 774 B<< C<Ps = 703> >> Menubar command B<< C<Pt> >> I<rxvt compile-time option> (rxvt-unicode extension)
775 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
776 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >>
777 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
778 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50>.
779 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50>.
780 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50>.
733 781
734=end table 782=end table
735 783
736=back 784=back
737 785
1390 XK_KP_8 8 ESC O x 1438 XK_KP_8 8 ESC O x
1391 XK_KP_9 9 ESC O y 1439 XK_KP_9 9 ESC O y
1392 1440
1393=end table 1441=end table
1394 1442
1443=head1 CONFIGURE OPTIONS
1444
1445General hint: if you get compile errors, then likely your configuration
1446hasn't been tested well. Either try with --enable-everything or use the
1447./reconf script as a base for experiments. ./reconf is used by myself,
1448so it should generally be a working config. Of course, you should always
1449report when a combination doesn't work, so it can be fixed. Marc Lehmann
1450<rxvt@schmorp.de>.
1451
1452=over 4
1453
1454=item --enable-everything
1455
1456Add support for all non-multichoice options listed in "./configure
1457--help". Note that unlike other enable options this is order dependant.
1458You can specify this and then disable options which this enables by
1459I<following> this with the appropriate commands.
1460
1461=item --enable-xft
1462
1463Add support for Xft (anti-aliases, among others) fonts. Xft fonts are
1464slower and require lots of memory, but as long as you don't use them, you
1465don't pay for them.
1466
1467=item --enable-font-styles
1468
1469Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
1470styles. The fonts can be set manually or automatically.
1471
1472=item --with-codesets=NAME,...
1473
1474Compile in support for additional codeset (encoding) groups (eu, vn are
1475always compiled in, which includes most 8-bit character sets). These
1476codeset tables are currently only used for driving X11 core fonts, they
1477are not required for Xft fonts. Compiling them in will make your binary
1478bigger (together about 700kB), but it doesn't increase memory usage unless
1479you use an X11 font requiring one of these encodings.
1480
1481=begin table
1482
1483 all all available codeset groups
1484 cn common chinese encodings
1485 cn_ext rarely used but very big chinese encodigs
1486 jp common japanese encodings
1487 jp_ext rarely used but big japanese encodings
1488 kr korean encodings
1489
1490=end table
1491
1492=item --enable-xim
1493
1494Add support for XIM (X Input Method) protocol. This allows using
1495alternative input methods (e.g. kinput2) and will also correctly
1496set up the input for people using dead keys or compose keys.
1497
1498=item --enable-unicode3
1499
1500Enable direct support for displaying unicode codepoints above
150165535 (the basic multilingual page). This increases storage
1502requirements per character from 2 to 4 bytes. X11 fonts do not yet
1503support these extra characters, but Xft does.
1504
1505Please note that rxvt-unicode can store unicode code points >65535
1506even without this flag, but the number of such characters is
1507limited to a view thousand (shared with combining characters,
1508see next switch), and right now rxvt-unicode cannot display them
1509(input/output and cut&paste still work, though).
1510
1511=item --enable-combining
1512
1513Enable automatic composition of combining characters into
1514composite characters. This is required for proper viewing of text
1515where accents are encoded as seperate unicode characters. This is
1516done by using precomposited characters when available or creating
1517new pseudo-characters when no precomposed form exists.
1518
1519Without --enable-unicode3, the number of additional precomposed
1520characters is rather limited (2048, if this is full, rxvt will use the
1521private use area, extending the number of combinations to 8448). With
1522--enable-unicode3, no practical limit exists. This will also enable
1523storage of characters >65535.
1524
1525The combining table also contains entries for arabic presentation forms,
1526but these are not currently used. Bug me if you want these to be used.
1527
1528=item --enable-fallback(=CLASS)
1529
1530When reading resource settings, also read settings for class CLASS
1531(default: Rxvt). To disable resource fallback use --disable-fallback.
1532
1533=item --with-res-name=NAME
1534
1535Use the given name (default: urxvt) as default application name when
1536reading resources. Specify --with-res-name=rxvt to replace rxvt.
1537
1538=item --with-res-class=CLASS
1539
1540Use the given class (default: URxvt) as default application class
1541when reading resources. Specify --with-res-class=Rxvt to replace
1542rxvt.
1543
1544=item --enable-utmp
1545
1546Write user and tty to utmp file (used by programs like F<w>) at
1547start of rxvt execution and delete information when rxvt exits.
1548
1549=item --enable-wtmp
1550
1551Write user and tty to wtmp file (used by programs like F<last>) at
1552start of rxvt execution and write logout when rxvt exits. This
1553option requires --enable-utmp to also be specified.
1554
1555=item --enable-lastlog
1556
1557Write user and tty to lastlog file (used by programs like
1558F<lastlogin>) at start of rxvt execution. This option requires
1559--enable-utmp to also be specified.
1560
1561=item --enable-xpm-background
1562
1563Add support for XPM background pixmaps.
1564
1565=item --enable-transparency
1566
1567Add support for inheriting parent backgrounds thus giving a fake
1568transparency to the term.
1569
1570=item --enable-fading
1571
1572Add support for fading the text when focus is lost.
1573
1574=item --enable-tinting
1575
1576Add support for tinting of transparent backgrounds.
1577
1578=item --enable-menubar
1579
1580Add support for our menu bar system (this interacts badly with
1581dynamic locale switching currently).
1582
1583=item --enable-rxvt-scroll
1584
1585Add support for the original rxvt scrollbar.
1586
1587=item --enable-next-scroll
1588
1589Add support for a NeXT-like scrollbar.
1590
1591=item --enable-xterm-scroll
1592
1593Add support for an Xterm-like scrollbar.
1594
1595=item --enable-plain-scroll
1596
1597Add support for a very unobtrusive, plain-looking scrollbar that
1598is the favourite of the rxvt-unicode author, having used it for
1599many years.
1600
1601=item --enable-half-shadow
1602
1603Make shadows on the scrollbar only half the normal width & height.
1604only applicable to rxvt scrollbars.
1605
1606=item --enable-ttygid
1607
1608Change tty device setting to group "tty" - only use this if
1609your system uses this type of security.
1610
1611=item --disable-backspace-key
1612
1613Disable any handling of the backspace key by us - let the X server
1614do it.
1615
1616=item --disable-delete-key
1617
1618Disable any handling of the delete key by us - let the X server
1619do it.
1620
1621=item --disable-resources
1622
1623Remove all resources checking.
1624
1625=item --enable-xgetdefault
1626
1627Make resources checking via XGetDefault() instead of our small
1628version which only checks ~/.Xdefaults, or if that doesn't exist
1629then ~/.Xresources.
1630
1631=item --enable-strings
1632
1633Add support for our possibly faster memset() function and other
1634various routines, overriding your system's versions which may
1635have been hand-crafted in assembly or may require extra libraries
1636to link in. (this breaks ANSI-C rules and has problems on many
1637GNU/Linux systems).
1638
1639=item --disable-swapscreen
1640
1641Remove support for swap screen.
1642
1643=item --enable-frills
1644
1645Add support for many small features that are not essential but nice to
1646have. Normally you want this, but for very small binaries you may want to
1647disable this.
1648
1649=item --enable-iso14755
1650
1651Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
1652F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by
1653C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with
1654this switch.
1655
1656=item --enable-linespace
1657
1658Add support to provide user specified line spacing between text rows.
1659
1660=item --enable-keepscrolling
1661
1662Add support for continual scrolling of the display when you hold
1663the mouse button down on a scrollbar arrow.
1664
1665=item --enable-mousewheel
1666
1667Add support for scrolling via mouse wheel or buttons 4 & 5.
1668
1669=item --enable-slipwheeling
1670
1671Add support for continual scrolling (using the mouse wheel as an
1672accelerator) while the control key is held down. This option
1673requires --enable-mousewheel to also be specified.
1674
1675=item --disable-new-selection
1676
1677Remove support for mouse selection style like that of xterm.
1678
1679=item --enable-dmalloc
1680
1681Use Gray Watson's malloc - which is good for debugging See
1682http://www.letters.com/dmalloc/ for details If you use either this or the
1683next option, you may need to edit src/Makefile after compiling to point
1684DINCLUDE and DLIB to the right places.
1685
1686You can only use either this option and the following (should
1687you use either) .
1688
1689=item --enable-dlmalloc
1690
1691Use Doug Lea's malloc - which is good for a production version
1692See L<http://g.oswego.edu/dl/html/malloc.html> for details.
1693
1694=item --enable-smart-resize
1695
1696Add smart growth/shrink behaviour when changing font size via from hot
1697keys. This should keep in a fixed position the rxvt corner which is
1698closest to a corner of the screen.
1699
1700=item --enable-cursor-blink
1701
1702Add support for a blinking cursor.
1703
1704=item --enable-pointer-blank
1705
1706Add support to have the pointer disappear when typing or inactive.
1707
1708=item --with-name=NAME
1709
1710Set the basename for the installed binaries (default: urxvt, resulting in
1711urxvt, urxvtd etc.). Specify --with-name=rxvt to replace rxvt.
1712
1713=item --with-term=NAME
1714
1715Change the environmental variable for the terminal to NAME (default
1716"rxvt")
1717
1718=item --with-terminfo=PATH
1719
1720Change the environmental variable for the path to the terminfo tree to
1721PATH.
1722
1723=item --with-x
1724
1725Use the X Window System (pretty much default, eh?).
1726
1727=item --with-xpm-includes=DIR
1728
1729Look for the XPM includes in DIR.
1730
1731=item --with-xpm-library=DIR
1732
1733Look for the XPM library in DIR.
1734
1735=item --with-xpm
1736
1737Not needed - define via --enable-xpm-background.
1738
1739=back
1740
1395=head1 AUTHORS 1741=head1 AUTHORS
1396 1742
1397Marc Lehmann <rxvt@schmorp.de> converted this document to pod and 1743Marc Lehmann <rxvt@schmorp.de> converted this document to pod and
1398reworked it from the original Rxvt documentation, which was done by Geoff 1744reworked it from the original Rxvt documentation, which was done by Geoff
1399Wing <gcw@pobox.com>, who in turn used the XTerm documentation and other 1745Wing <gcw@pobox.com>, who in turn used the XTerm documentation and other

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines