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

Comparing rxvt-unicode/doc/rxvt.7.txt (file contents):
Revision 1.43 by root, Fri Jan 13 12:40:46 2006 UTC vs.
Revision 1.44 by root, Mon Jan 16 14:48:39 2006 UTC

44 perl-ext-common resource to the empty string, which also keeps 44 perl-ext-common resource to the empty string, which also keeps
45 rxvt-unicode from initialising perl, saving memory. 45 rxvt-unicode from initialising perl, saving memory.
46 46
47 If you only want to disable specific features, you first have to 47 If you only want to disable specific features, you first have to
48 identify which perl extension is responsible. For this, read the 48 identify which perl extension is responsible. For this, read the
49 section PREPACKAGED EXTENSIONS in the urxvtperl(3) manpage. For 49 section PREPACKAGED EXTENSIONS in the rxvtperl(3) manpage. For
50 example, to disable the selection-popup and option-popup, specify 50 example, to disable the selection-popup and option-popup, specify
51 this perl-ext-common resource: 51 this perl-ext-common resource:
52 52
53 URxvt.perl-ext-common: default,-selection-popup,-option-popup 53 URxvt.perl-ext-common: default,-selection-popup,-option-popup
54 54
144 terminal as an example embedding application. 144 terminal as an example embedding application.
145 145
146 How do I know which rxvt-unicode version I'm using? 146 How do I know which rxvt-unicode version I'm using?
147 The version number is displayed with the usage (-h). Also the escape 147 The version number is displayed with the usage (-h). Also the escape
148 sequence "ESC [ 8 n" sets the window title to the version number. 148 sequence "ESC [ 8 n" sets the window title to the version number.
149 When using the urxvtc client, the version displayed is that of the 149 When using the rxvtc client, the version displayed is that of the
150 daemon. 150 daemon.
151 151
152 I am using Debian GNU/Linux and have a problem... 152 I am using Debian GNU/Linux and have a problem...
153 The Debian GNU/Linux package of rxvt-unicode in sarge contains large 153 The Debian GNU/Linux package of rxvt-unicode in sarge contains large
154 patches that considerably change the behaviour of rxvt-unicode. 154 patches that considerably change the behaviour of rxvt-unicode.
238 238
239 "tic" outputs some error when compiling the terminfo entry. 239 "tic" outputs some error when compiling the terminfo entry.
240 Most likely it's the empty definition for "enacs=". Just replace it 240 Most likely it's the empty definition for "enacs=". Just replace it
241 by "enacs=\E[0@" and try again. 241 by "enacs=\E[0@" and try again.
242 242
243 "bash"'s readline does not work correctly under urxvt. 243 "bash"'s readline does not work correctly under rxvt.
244 I need a termcap file entry. 244 I need a termcap file entry.
245 One reason you might want this is that some distributions or 245 One reason you might want this is that some distributions or
246 operating systems still compile some programs using the 246 operating systems still compile some programs using the
247 long-obsoleted termcap library (Fedora Core's bash is one example) 247 long-obsoleted termcap library (Fedora Core's bash is one example)
248 and rely on a termcap entry for "rxvt-unicode". 248 and rely on a termcap entry for "rxvt-unicode".
359 indeed look correct. 359 indeed look correct.
360 360
361 In that case, select a font of your taste and add it to the font 361 In that case, select a font of your taste and add it to the font
362 list, e.g.: 362 list, e.g.:
363 363
364 urxvt -fn basefont,font2,font3... 364 rxvt -fn basefont,font2,font3...
365 365
366 When rxvt-unicode sees a character, it will first look at the base 366 When rxvt-unicode sees a character, it will first look at the base
367 font. If the base font does not contain the character, it will go to 367 font. If the base font does not contain the character, it will go to
368 the next font, and so on. Specifying your own fonts will also speed 368 the next font, and so on. Specifying your own fonts will also speed
369 up this search and use less resources within rxvt-unicode and the 369 up this search and use less resources within rxvt-unicode and the
719 URxvt.color6: #73f7ff 719 URxvt.color6: #73f7ff
720 URxvt.color14: #73f7ff 720 URxvt.color14: #73f7ff
721 URxvt.color7: #e1dddd 721 URxvt.color7: #e1dddd
722 URxvt.color15: #e1dddd 722 URxvt.color15: #e1dddd
723 723
724 How can I start urxvtd in a race-free way? 724 How can I start rxvtd in a race-free way?
725 Try "urxvtd -f -o", which tells urxvtd to open the display, create 725 Try "rxvtd -f -o", which tells rxvtd to open the display, create the
726 the listening socket and then fork. 726 listening socket and then fork.
727 727
728 What's with the strange Backspace/Delete key behaviour? 728 What's with the strange Backspace/Delete key behaviour?
729 Assuming that the physical Backspace key corresponds to the 729 Assuming that the physical Backspace key corresponds to the
730 BackSpace keysym (not likely for Linux ... see the following 730 BackSpace keysym (not likely for Linux ... see the following
731 question) there are two standard values that can be used for 731 question) there are two standard values that can be used for
744 744
745 For starting a new rxvt-unicode: 745 For starting a new rxvt-unicode:
746 746
747 # use Backspace = ^H 747 # use Backspace = ^H
748 $ stty erase ^H 748 $ stty erase ^H
749 $ urxvt 749 $ rxvt
750 750
751 # use Backspace = ^? 751 # use Backspace = ^?
752 $ stty erase ^? 752 $ stty erase ^?
753 $ urxvt 753 $ rxvt
754 754
755 Toggle with "ESC [ 36 h" / "ESC [ 36 l". 755 Toggle with "ESC [ 36 h" / "ESC [ 36 l".
756 756
757 For an existing rxvt-unicode: 757 For an existing rxvt-unicode:
758 758
786 There are some compile-time selections available via configure. 786 There are some compile-time selections available via configure.
787 Unless you have run "configure" with the "--disable-resources" 787 Unless you have run "configure" with the "--disable-resources"
788 option you can use the `keysym' resource to alter the keystrings 788 option you can use the `keysym' resource to alter the keystrings
789 associated with keysyms. 789 associated with keysyms.
790 790
791 Here's an example for a URxvt session started using "urxvt -name 791 Here's an example for a URxvt session started using "rxvt -name
792 URxvt" 792 URxvt"
793 793
794 URxvt.keysym.Home: \033[1~ 794 URxvt.keysym.Home: \033[1~
795 URxvt.keysym.End: \033[4~ 795 URxvt.keysym.End: \033[4~
796 URxvt.keysym.C-apostrophe: \033<C-'> 796 URxvt.keysym.C-apostrophe: \033<C-'>
1252 1252
1253 "Ps = 9" X10 XTerm 1253 "Ps = 9" X10 XTerm
1254 h Send Mouse X & Y on button press. 1254 h Send Mouse X & Y on button press.
1255 l No mouse reporting. 1255 l No mouse reporting.
1256 1256
1257 "Ps = 10" (rxvt)
1258 h menuBar visible
1259 l menuBar invisible
1260
1261 "Ps = 25" 1257 "Ps = 25"
1262 h Visible cursor {cnorm/cvvis} 1258 h Visible cursor {cnorm/cvvis}
1263 l Invisible cursor {civis} 1259 l Invisible cursor {civis}
1264 1260
1265 "Ps = 30" 1261 "Ps = 30"
1358 Ps = 46 Change Log File to Pt unimplemented 1354 Ps = 46 Change Log File to Pt unimplemented
1359 Ps = 49 Change default background colour to Pt. 1355 Ps = 49 Change default background colour to Pt.
1360 Ps = 50 Set fontset to Pt, with the following special values of Pt (rxvt) #+n change up n #-n change down n if n is missing of 0, a value of 1 is used empty change to font0 n change to font n 1356 Ps = 50 Set fontset to Pt, with the following special values of Pt (rxvt) #+n change up n #-n change down n if n is missing of 0, a value of 1 is used empty change to font0 n change to font n
1361 Ps = 55 Log all scrollback buffer and all of screen to Pt 1357 Ps = 55 Log all scrollback buffer and all of screen to Pt
1362 Ps = 701 Change current locale to Pt, or, if Pt is ?, return the current locale (Compile frills). 1358 Ps = 701 Change current locale to Pt, or, if Pt is ?, return the current locale (Compile frills).
1363 Ps = 703 Menubar command Pt (Compile menubar).
1364 Ps = 704 Change colour of italic characters to Pt 1359 Ps = 704 Change colour of italic characters to Pt
1365 Ps = 705 Change background pixmap tint colour to Pt (Compile transparency). 1360 Ps = 705 Change background pixmap tint colour to Pt (Compile transparency).
1366 Ps = 706 Change colour of bold characters to Pt 1361 Ps = 706 Change colour of bold characters to Pt
1367 Ps = 707 Change colour of underlined characters to Pt 1362 Ps = 707 Change colour of underlined characters to Pt
1368 Ps = 710 Set normal fontset to Pt. Same as Ps = 50. 1363 Ps = 710 Set normal fontset to Pt. Same as Ps = 50.
1372 Ps = 720 Move viewing window up by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills). 1367 Ps = 720 Move viewing window up by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills).
1373 Ps = 721 Move viewing window down by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills). 1368 Ps = 721 Move viewing window down by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills).
1374 Ps = 777 Call the perl extension with the given string, which should be of the form extension:parameters (Compile perl). 1369 Ps = 777 Call the perl extension with the given string, which should be of the form extension:parameters (Compile perl).
1375 1370
1376 1371
1377
1378menuBar
1379 The exact syntax used is *almost* solidified. In the menus, DON'T try to
1380 use menuBar commands that add or remove a menuBar.
1381
1382 Note that in all of the commands, the */path/* *cannot* be omitted: use
1383 ./ to specify a menu relative to the current menu.
1384
1385 Overview of menuBar operation
1386 For the menuBar XTerm escape sequence "ESC ] 703 ; Pt ST", the syntax of
1387 "Pt" can be used for a variety of tasks:
1388
1389 At the top level is the current menuBar which is a member of a circular
1390 linked-list of other such menuBars.
1391
1392 The menuBar acts as a parent for the various drop-down menus, which in
1393 turn, may have labels, separator lines, menuItems and subMenus.
1394
1395 The menuItems are the useful bits: you can use them to mimic keyboard
1396 input or even to send text or escape sequences back to rxvt.
1397
1398 The menuBar syntax is intended to provide a simple yet robust method of
1399 constructing and manipulating menus and navigating through the menuBars.
1400
1401 The first step is to use the tag [menu:*name*] which creates the menuBar
1402 called *name* and allows access. You may now or menus, subMenus, and
1403 menuItems. Finally, use the tag [done] to set the menuBar access as
1404 readonly to prevent accidental corruption of the menus. To re-access the
1405 current menuBar for alterations, use the tag [menu], make the
1406 alterations and then use [done]
1407
1408
1409
1410 Commands
1411 [menu:+*name*]
1412 access the named menuBar for creation or alteration. If a new
1413 menuBar is created, it is called *name* (max of 15 chars) and the
1414 current menuBar is pushed onto the stack
1415
1416 [menu]
1417 access the current menuBar for alteration
1418
1419 [title:+*string*]
1420 set the current menuBar's title to *string*, which may contain the
1421 following format specifiers:
1422
1423 B<%n> rxvt name (as per the B<-name> command-line option)
1424 B<%v> rxvt version
1425 B<%%> literal B<%> character
1426
1427 [done]
1428 set menuBar access as readonly. End-of-file tag for [read:+*file*]
1429 operations.
1430
1431 [read:+*file*]
1432 read menu commands directly from *file* (extension ".menu" will be
1433 appended if required.) Start reading at a line with [menu] or
1434 [menu:+*name* and continuing until [done] is encountered.
1435
1436 Blank and comment lines (starting with #) are ignored. Actually,
1437 since any invalid menu commands are also ignored, almost anything
1438 could be construed as a comment line, but this may be tightened up
1439 in the future ... so don't count on it!.
1440
1441 [read:+*file*;+*name*]
1442 The same as [read:+*file*], but start reading at a line with
1443 [menu:+*name*] and continuing until [done:+*name*] or [done] is
1444 encountered.
1445
1446 [dump]
1447 dump all menuBars to the file /tmp/rxvt-PID in a format suitable for
1448 later rereading.
1449
1450 [rm:name]
1451 remove the named menuBar
1452
1453 [rm] [rm:]
1454 remove the current menuBar
1455
1456 [rm*] [rm:*]
1457 remove all menuBars
1458
1459 [swap]
1460 swap the top two menuBars
1461
1462 [prev]
1463 access the previous menuBar
1464
1465 [next]
1466 access the next menuBar
1467
1468 [show]
1469 Enable display of the menuBar
1470
1471 [hide]
1472 Disable display of the menuBar
1473
1474 [pixmap:+*name*]
1475 [pixmap:+*name*;*scaling*]
1476 (set the background pixmap globally
1477
1478 A Future implementation *may* make this local to the menubar)
1479
1480 [:+*command*:]
1481 ignore the menu readonly status and issue a *command* to or a menu
1482 or menuitem or change the ; a useful shortcut for setting the quick
1483 arrows from a menuBar.
1484
1485
1486
1487 Adding and accessing menus
1488 The following commands may also be + prefixed.
1489
1490 /+ access menuBar top level
1491
1492 ./+ access current menu level
1493
1494 ../+
1495 access parent menu (1 level up)
1496
1497 ../../
1498 access parent menu (multiple levels up)
1499
1500 */path/*menu
1501 add/access menu
1502
1503 */path/*menu/*
1504 add/access menu and clear it if it exists
1505
1506 */path/*{-}
1507 add separator
1508
1509 */path/*{item}
1510 add item as a label
1511
1512 */path/*{item} action
1513 add/alter *menuitem* with an associated *action*
1514
1515 */path/*{item}{right-text}
1516 add/alter *menuitem* with right-text as the right-justified text and
1517 as the associated *action*
1518
1519 */path/*{item}{rtext} action
1520 add/alter *menuitem* with an associated *action* and with rtext as
1521 the right-justified text.
1522
1523 Special characters in *action* must be backslash-escaped:
1524 \a \b \E \e \n \r \t \octal
1525
1526 or in control-character notation:
1527 ^@, ^A .. ^Z .. ^_, ^?
1528
1529 To send a string starting with a NUL (^@) character to the program,
1530 start *action* with a pair of NUL characters (^@^@), the first of which
1531 will be stripped off and the balance directed to the program. Otherwise
1532 if *action* begins with NUL followed by non-+NUL characters, the leading
1533 NUL is stripped off and the balance is sent back to rxvt.
1534
1535 As a convenience for the many Emacs-type editors, *action* may start
1536 with M- (eg, M-$ is equivalent to \E$) and a CR will be appended if
1537 missed from M-x commands.
1538
1539 As a convenience for issuing XTerm ESC ] sequences from a menubar (or
1540 quick arrow), a BEL (^G) will be appended if needed.
1541
1542 For example,
1543 M-xapropos is equivalent to \Exapropos\r
1544
1545 and \E]703;mona;100 is equivalent to \E]703;mona;100\a
1546
1547 The option {*right-rtext*} will be right-justified. In the absence of a
1548 specified action, this text will be used as the *action* as well.
1549
1550 For example,
1551 /File/{Open}{^X^F} is equivalent to /File/{Open}{^X^F} ^X^F
1552
1553 The left label *is* necessary, since it's used for matching, but
1554 implicitly hiding the left label (by using same name for both left and
1555 right labels), or explicitly hiding the left label (by preceeding it
1556 with a dot), makes it possible to have right-justified text only.
1557
1558 For example,
1559 /File/{Open}{Open} Open-File-Action
1560
1561 or hiding it
1562 /File/{.anylabel}{Open} Open-File-Action
1563
1564
1565
1566 Removing menus
1567 -/*+
1568 remove all menus from the menuBar, the same as [clear]
1569
1570 -+*/path*menu+
1571 remove menu
1572
1573 -+*/path*{item}+
1574 remove item
1575
1576 -+*/path*{-}
1577 remove separator)
1578
1579 -/path/menu/*
1580 remove all items, separators and submenus from menu
1581
1582
1583
1584 Quick Arrows
1585 The menus also provide a hook for *quick arrows* to provide easier user
1586 access. If nothing has been explicitly set, the default is to emulate
1587 the curror keys. The syntax permits each arrow to be altered
1588 individually or all four at once without re-entering their common
1589 beginning/end text. For example, to explicitly associate cursor actions
1590 with the arrows, any of the following forms could be used:
1591
1592 <r>+*Right*
1593 <l>+*Left*
1594 <u>+*Up*
1595 <d>+*Down*
1596 Define actions for the respective arrow buttons
1597
1598 <b>+*Begin*
1599 <e>+*End*
1600 Define common beginning/end parts for *quick arrows* which used in
1601 conjunction with the above <r> <l> <u> <d> constructs
1602
1603 For example, define arrows individually,
1604 <u>\E[A
1605
1606 <d>\E[B
1607
1608 <r>\E[C
1609
1610 <l>\E[D
1611
1612 or all at once
1613 <u>\E[AZ<><d>\E[BZ<><r>\E[CZ<><l>\E[D
1614
1615 or more compactly (factoring out common parts)
1616 <b>\E[<u>AZ<><d>BZ<><r>CZ<><l>D
1617
1618
1619
1620 Command Summary
1621 A short summary of the most *common* commands:
1622
1623 [menu:name]
1624 use an existing named menuBar or start a new one
1625
1626 [menu]
1627 use the current menuBar
1628
1629 [title:string]
1630 set menuBar title
1631
1632 [done]
1633 set menu access to readonly and, if reading from a file, signal EOF
1634
1635 [done:name]
1636 if reading from a file using [read:file;name] signal EOF
1637
1638 [rm:name]
1639 remove named menuBar(s)
1640
1641 [rm] [rm:]
1642 remove current menuBar
1643
1644 [rm*] [rm:*]
1645 remove all menuBar(s)
1646
1647 [swap]
1648 swap top two menuBars
1649
1650 [prev]
1651 access the previous menuBar
1652
1653 [next]
1654 access the next menuBar
1655
1656 [show]
1657 map menuBar
1658
1659 [hide]
1660 unmap menuBar
1661
1662 [pixmap;file]
1663 [pixmap;file;scaling]
1664 set a background pixmap
1665
1666 [read:file]
1667 [read:file;name]
1668 read in a menu from a file
1669
1670 [dump]
1671 dump out all menuBars to /tmp/rxvt-PID
1672
1673 / access menuBar top level
1674
1675 ./
1676 ../
1677 ../../
1678 access current or parent menu level
1679
1680 /path/menu
1681 add/access menu
1682
1683 /path/{-}
1684 add separator
1685
1686 /path/{item}{rtext} action
1687 add/alter menu item
1688
1689 -/* remove all menus from the menuBar
1690
1691 -/path/menu
1692 remove menu items, separators and submenus from menu
1693
1694 -/path/menu
1695 remove menu
1696
1697 -/path/{item}
1698 remove item
1699
1700 -/path/{-}
1701 remove separator
1702
1703 <b>Begin<r>Right<l>Left<u>Up<d>Down<e>End
1704 menu quick arrows
1705 1372
1706XPM 1373XPM
1707 For the XPM XTerm escape sequence "ESC ] 20 ; Pt ST" then value of "Pt" 1374 For the XPM XTerm escape sequence "ESC ] 20 ; Pt ST" then value of "Pt"
1708 can be the name of the background pixmap followed by a sequence of 1375 can be the name of the background pixmap followed by a sequence of
1709 scaling/positioning commands separated by semi-colons. The 1376 scaling/positioning commands separated by semi-colons. The
1965 1632
1966 --enable-tinting (default: on) 1633 --enable-tinting (default: on)
1967 Add support for tinting of transparent backgrounds (requires 1634 Add support for tinting of transparent backgrounds (requires
1968 "--enable-transparency"). 1635 "--enable-transparency").
1969 1636
1970 --enable-menubar (default: off) [DEPRECATED]
1971 Add support for our menu bar system (this interacts badly with
1972 dynamic locale switching currently). This option is DEPRECATED and
1973 will be removed in the future.
1974
1975 --enable-rxvt-scroll (default: on) 1637 --enable-rxvt-scroll (default: on)
1976 Add support for the original rxvt scrollbar. 1638 Add support for the original rxvt scrollbar.
1977 1639
1978 --enable-next-scroll (default: on) 1640 --enable-next-scroll (default: on)
1979 Add support for a NeXT-like scrollbar. 1641 Add support for a NeXT-like scrollbar.
2002 Removes any handling of the delete key by us - let the X server do 1664 Removes any handling of the delete key by us - let the X server do
2003 it. 1665 it.
2004 1666
2005 --disable-resources 1667 --disable-resources
2006 Removes any support for resource checking. 1668 Removes any support for resource checking.
2007
2008 --enable-strings (default: off)
2009 Add support for our possibly faster memset() function and other
2010 various routines, overriding your system's versions which may have
2011 been hand-crafted in assembly or may require extra libraries to link
2012 in. (this breaks ANSI-C rules and has problems on many GNU/Linux
2013 systems).
2014 1669
2015 --disable-swapscreen 1670 --disable-swapscreen
2016 Remove support for secondary/swap screen. 1671 Remove support for secondary/swap screen.
2017 1672
2018 --enable-frills (default: on) 1673 --enable-frills (default: on)
2040 hold on exit (-hold) 1695 hold on exit (-hold)
2041 skip builtin block graphics (-sbg) 1696 skip builtin block graphics (-sbg)
2042 sgr modes 90..97 and 100..107 1697 sgr modes 90..97 and 100..107
2043 1698
2044 --enable-iso14755 (default: on) 1699 --enable-iso14755 (default: on)
2045 Enable extended ISO 14755 support (see urxvt(1), or doc/rxvt.1.txt). 1700 Enable extended ISO 14755 support (see rxvt(1), or doc/rxvt.1.txt).
2046 Basic support (section 5.1) is enabled by "--enable-frills", while 1701 Basic support (section 5.1) is enabled by "--enable-frills", while
2047 support for 5.2, 5.3 and 5.4 is enabled with this switch. 1702 support for 5.2, 5.3 and 5.4 is enabled with this switch.
2048 1703
2049 --enable-keepscrolling (default: on) 1704 --enable-keepscrolling (default: on)
2050 Add support for continual scrolling of the display when you hold the 1705 Add support for continual scrolling of the display when you hold the
2081 1736
2082 --enable-pointer-blank (default: on) 1737 --enable-pointer-blank (default: on)
2083 Add support to have the pointer disappear when typing or inactive. 1738 Add support to have the pointer disappear when typing or inactive.
2084 1739
2085 --enable-perl (default: off) 1740 --enable-perl (default: off)
2086 Enable an embedded perl interpreter. See the urxvtperl(3) manpage 1741 Enable an embedded perl interpreter. See the rxvtperl(3) manpage
2087 (doc/rxvtperl.txt) for more info on this feature, or the files in 1742 (doc/rxvtperl.txt) for more info on this feature, or the files in
2088 src/perl-ext/ for the extensions that are installed by default. The 1743 src/perl-ext/ for the extensions that are installed by default. The
2089 perl interpreter that is used can be specified via the "PERL" 1744 perl interpreter that is used can be specified via the "PERL"
2090 environment variable when running configure. 1745 environment variable when running configure.
2091 1746

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines