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.41 by root, Thu Jan 12 23:11:23 2006 UTC vs.
Revision 1.44 by root, Mon Jan 16 14:48:39 2006 UTC

18 The newest version of this document is also available on the World Wide 18 The newest version of this document is also available on the World Wide
19 Web at 19 Web at
20 <http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>. 20 <http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>.
21 21
22FREQUENTLY ASKED QUESTIONS 22FREQUENTLY ASKED QUESTIONS
23 The new selection selects pieces that are too big/too small, can I 23 The new selection selects pieces that are too big, how can I select
24 change this? 24 single words?
25 Yes. For example, if you want to select smaller pieces ("words") you 25 Yes. For example, if you want to select alphanumeric words, you can
26 can use the following resource: 26 use the following resource:
27 27
28 URxvt.selection.pattern-0: ([[:word:]]+) 28 URxvt.selection.pattern-0: ([[:word:]]+)
29 29
30 If you click more than twice, the selection will be extended more 30 If you click more than twice, the selection will be extended more
31 and more. 31 and more.
32 32
33 To get a selection that is very similar to the old code, try this 33 To get a selection that is very similar to the old code, try this
34 pattern: 34 pattern:
35 35
36 URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+) 36 URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+)
37
38 Please also note that the *LeftClick Shift-LeftClik* combination
39 also selects words like the old code.
37 40
38 I don't like the new selection/popups/hotkeys/perl, how do I 41 I don't like the new selection/popups/hotkeys/perl, how do I
39 change/disable it? 42 change/disable it?
40 You can disable the perl extension completely by setting the 43 You can disable the perl extension completely by setting the
41 perl-ext-common resource to the empty string, which also keeps 44 perl-ext-common resource to the empty string, which also keeps
651 Mouse cut/paste suddenly no longer works. 654 Mouse cut/paste suddenly no longer works.
652 Make sure that mouse reporting is actually turned off since killing 655 Make sure that mouse reporting is actually turned off since killing
653 some editors prematurely may leave the mouse in mouse report mode. 656 some editors prematurely may leave the mouse in mouse report mode.
654 I've heard that tcsh may use mouse reporting unless it otherwise 657 I've heard that tcsh may use mouse reporting unless it otherwise
655 specified. A quick check is to see if cut/paste works when the Alt 658 specified. A quick check is to see if cut/paste works when the Alt
656 or Shift keys are depressed. See rxvt(7) 659 or Shift keys are depressed.
657 660
658 What's with this bold/blink stuff? 661 What's with this bold/blink stuff?
659 If no bold colour is set via "colorBD:", bold will invert text using 662 If no bold colour is set via "colorBD:", bold will invert text using
660 the standard foreground colour. 663 the standard foreground colour.
661 664
747 750
748 # use Backspace = ^? 751 # use Backspace = ^?
749 $ stty erase ^? 752 $ stty erase ^?
750 $ rxvt 753 $ rxvt
751 754
752 Toggle with "ESC [ 36 h" / "ESC [ 36 l" as documented in rxvt(7). 755 Toggle with "ESC [ 36 h" / "ESC [ 36 l".
753 756
754 For an existing rxvt-unicode: 757 For an existing rxvt-unicode:
755 758
756 # use Backspace = ^H 759 # use Backspace = ^H
757 $ stty erase ^H 760 $ stty erase ^H
1249 1252
1250 "Ps = 9" X10 XTerm 1253 "Ps = 9" X10 XTerm
1251 h Send Mouse X & Y on button press. 1254 h Send Mouse X & Y on button press.
1252 l No mouse reporting. 1255 l No mouse reporting.
1253 1256
1254 "Ps = 10" (rxvt)
1255 h menuBar visible
1256 l menuBar invisible
1257
1258 "Ps = 25" 1257 "Ps = 25"
1259 h Visible cursor {cnorm/cvvis} 1258 h Visible cursor {cnorm/cvvis}
1260 l Invisible cursor {civis} 1259 l Invisible cursor {civis}
1261 1260
1262 "Ps = 30" 1261 "Ps = 30"
1355 Ps = 46 Change Log File to Pt unimplemented 1354 Ps = 46 Change Log File to Pt unimplemented
1356 Ps = 49 Change default background colour to Pt. 1355 Ps = 49 Change default background colour to Pt.
1357 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
1358 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
1359 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).
1360 Ps = 703 Menubar command Pt (Compile menubar).
1361 Ps = 704 Change colour of italic characters to Pt 1359 Ps = 704 Change colour of italic characters to Pt
1362 Ps = 705 Change background pixmap tint colour to Pt (Compile transparency). 1360 Ps = 705 Change background pixmap tint colour to Pt (Compile transparency).
1363 Ps = 706 Change colour of bold characters to Pt 1361 Ps = 706 Change colour of bold characters to Pt
1364 Ps = 707 Change colour of underlined characters to Pt 1362 Ps = 707 Change colour of underlined characters to Pt
1365 Ps = 710 Set normal fontset to Pt. Same as Ps = 50. 1363 Ps = 710 Set normal fontset to Pt. Same as Ps = 50.
1369 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).
1370 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).
1371 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).
1372 1370
1373 1371
1374
1375menuBar
1376 The exact syntax used is *almost* solidified. In the menus, DON'T try to
1377 use menuBar commands that add or remove a menuBar.
1378
1379 Note that in all of the commands, the */path/* *cannot* be omitted: use
1380 ./ to specify a menu relative to the current menu.
1381
1382 Overview of menuBar operation
1383 For the menuBar XTerm escape sequence "ESC ] 703 ; Pt ST", the syntax of
1384 "Pt" can be used for a variety of tasks:
1385
1386 At the top level is the current menuBar which is a member of a circular
1387 linked-list of other such menuBars.
1388
1389 The menuBar acts as a parent for the various drop-down menus, which in
1390 turn, may have labels, separator lines, menuItems and subMenus.
1391
1392 The menuItems are the useful bits: you can use them to mimic keyboard
1393 input or even to send text or escape sequences back to rxvt.
1394
1395 The menuBar syntax is intended to provide a simple yet robust method of
1396 constructing and manipulating menus and navigating through the menuBars.
1397
1398 The first step is to use the tag [menu:*name*] which creates the menuBar
1399 called *name* and allows access. You may now or menus, subMenus, and
1400 menuItems. Finally, use the tag [done] to set the menuBar access as
1401 readonly to prevent accidental corruption of the menus. To re-access the
1402 current menuBar for alterations, use the tag [menu], make the
1403 alterations and then use [done]
1404
1405
1406
1407 Commands
1408 [menu:+*name*]
1409 access the named menuBar for creation or alteration. If a new
1410 menuBar is created, it is called *name* (max of 15 chars) and the
1411 current menuBar is pushed onto the stack
1412
1413 [menu]
1414 access the current menuBar for alteration
1415
1416 [title:+*string*]
1417 set the current menuBar's title to *string*, which may contain the
1418 following format specifiers:
1419
1420 B<%n> rxvt name (as per the B<-name> command-line option)
1421 B<%v> rxvt version
1422 B<%%> literal B<%> character
1423
1424 [done]
1425 set menuBar access as readonly. End-of-file tag for [read:+*file*]
1426 operations.
1427
1428 [read:+*file*]
1429 read menu commands directly from *file* (extension ".menu" will be
1430 appended if required.) Start reading at a line with [menu] or
1431 [menu:+*name* and continuing until [done] is encountered.
1432
1433 Blank and comment lines (starting with #) are ignored. Actually,
1434 since any invalid menu commands are also ignored, almost anything
1435 could be construed as a comment line, but this may be tightened up
1436 in the future ... so don't count on it!.
1437
1438 [read:+*file*;+*name*]
1439 The same as [read:+*file*], but start reading at a line with
1440 [menu:+*name*] and continuing until [done:+*name*] or [done] is
1441 encountered.
1442
1443 [dump]
1444 dump all menuBars to the file /tmp/rxvt-PID in a format suitable for
1445 later rereading.
1446
1447 [rm:name]
1448 remove the named menuBar
1449
1450 [rm] [rm:]
1451 remove the current menuBar
1452
1453 [rm*] [rm:*]
1454 remove all menuBars
1455
1456 [swap]
1457 swap the top two menuBars
1458
1459 [prev]
1460 access the previous menuBar
1461
1462 [next]
1463 access the next menuBar
1464
1465 [show]
1466 Enable display of the menuBar
1467
1468 [hide]
1469 Disable display of the menuBar
1470
1471 [pixmap:+*name*]
1472 [pixmap:+*name*;*scaling*]
1473 (set the background pixmap globally
1474
1475 A Future implementation *may* make this local to the menubar)
1476
1477 [:+*command*:]
1478 ignore the menu readonly status and issue a *command* to or a menu
1479 or menuitem or change the ; a useful shortcut for setting the quick
1480 arrows from a menuBar.
1481
1482
1483
1484 Adding and accessing menus
1485 The following commands may also be + prefixed.
1486
1487 /+ access menuBar top level
1488
1489 ./+ access current menu level
1490
1491 ../+
1492 access parent menu (1 level up)
1493
1494 ../../
1495 access parent menu (multiple levels up)
1496
1497 */path/*menu
1498 add/access menu
1499
1500 */path/*menu/*
1501 add/access menu and clear it if it exists
1502
1503 */path/*{-}
1504 add separator
1505
1506 */path/*{item}
1507 add item as a label
1508
1509 */path/*{item} action
1510 add/alter *menuitem* with an associated *action*
1511
1512 */path/*{item}{right-text}
1513 add/alter *menuitem* with right-text as the right-justified text and
1514 as the associated *action*
1515
1516 */path/*{item}{rtext} action
1517 add/alter *menuitem* with an associated *action* and with rtext as
1518 the right-justified text.
1519
1520 Special characters in *action* must be backslash-escaped:
1521 \a \b \E \e \n \r \t \octal
1522
1523 or in control-character notation:
1524 ^@, ^A .. ^Z .. ^_, ^?
1525
1526 To send a string starting with a NUL (^@) character to the program,
1527 start *action* with a pair of NUL characters (^@^@), the first of which
1528 will be stripped off and the balance directed to the program. Otherwise
1529 if *action* begins with NUL followed by non-+NUL characters, the leading
1530 NUL is stripped off and the balance is sent back to rxvt.
1531
1532 As a convenience for the many Emacs-type editors, *action* may start
1533 with M- (eg, M-$ is equivalent to \E$) and a CR will be appended if
1534 missed from M-x commands.
1535
1536 As a convenience for issuing XTerm ESC ] sequences from a menubar (or
1537 quick arrow), a BEL (^G) will be appended if needed.
1538
1539 For example,
1540 M-xapropos is equivalent to \Exapropos\r
1541
1542 and \E]703;mona;100 is equivalent to \E]703;mona;100\a
1543
1544 The option {*right-rtext*} will be right-justified. In the absence of a
1545 specified action, this text will be used as the *action* as well.
1546
1547 For example,
1548 /File/{Open}{^X^F} is equivalent to /File/{Open}{^X^F} ^X^F
1549
1550 The left label *is* necessary, since it's used for matching, but
1551 implicitly hiding the left label (by using same name for both left and
1552 right labels), or explicitly hiding the left label (by preceeding it
1553 with a dot), makes it possible to have right-justified text only.
1554
1555 For example,
1556 /File/{Open}{Open} Open-File-Action
1557
1558 or hiding it
1559 /File/{.anylabel}{Open} Open-File-Action
1560
1561
1562
1563 Removing menus
1564 -/*+
1565 remove all menus from the menuBar, the same as [clear]
1566
1567 -+*/path*menu+
1568 remove menu
1569
1570 -+*/path*{item}+
1571 remove item
1572
1573 -+*/path*{-}
1574 remove separator)
1575
1576 -/path/menu/*
1577 remove all items, separators and submenus from menu
1578
1579
1580
1581 Quick Arrows
1582 The menus also provide a hook for *quick arrows* to provide easier user
1583 access. If nothing has been explicitly set, the default is to emulate
1584 the curror keys. The syntax permits each arrow to be altered
1585 individually or all four at once without re-entering their common
1586 beginning/end text. For example, to explicitly associate cursor actions
1587 with the arrows, any of the following forms could be used:
1588
1589 <r>+*Right*
1590 <l>+*Left*
1591 <u>+*Up*
1592 <d>+*Down*
1593 Define actions for the respective arrow buttons
1594
1595 <b>+*Begin*
1596 <e>+*End*
1597 Define common beginning/end parts for *quick arrows* which used in
1598 conjunction with the above <r> <l> <u> <d> constructs
1599
1600 For example, define arrows individually,
1601 <u>\E[A
1602
1603 <d>\E[B
1604
1605 <r>\E[C
1606
1607 <l>\E[D
1608
1609 or all at once
1610 <u>\E[AZ<><d>\E[BZ<><r>\E[CZ<><l>\E[D
1611
1612 or more compactly (factoring out common parts)
1613 <b>\E[<u>AZ<><d>BZ<><r>CZ<><l>D
1614
1615
1616
1617 Command Summary
1618 A short summary of the most *common* commands:
1619
1620 [menu:name]
1621 use an existing named menuBar or start a new one
1622
1623 [menu]
1624 use the current menuBar
1625
1626 [title:string]
1627 set menuBar title
1628
1629 [done]
1630 set menu access to readonly and, if reading from a file, signal EOF
1631
1632 [done:name]
1633 if reading from a file using [read:file;name] signal EOF
1634
1635 [rm:name]
1636 remove named menuBar(s)
1637
1638 [rm] [rm:]
1639 remove current menuBar
1640
1641 [rm*] [rm:*]
1642 remove all menuBar(s)
1643
1644 [swap]
1645 swap top two menuBars
1646
1647 [prev]
1648 access the previous menuBar
1649
1650 [next]
1651 access the next menuBar
1652
1653 [show]
1654 map menuBar
1655
1656 [hide]
1657 unmap menuBar
1658
1659 [pixmap;file]
1660 [pixmap;file;scaling]
1661 set a background pixmap
1662
1663 [read:file]
1664 [read:file;name]
1665 read in a menu from a file
1666
1667 [dump]
1668 dump out all menuBars to /tmp/rxvt-PID
1669
1670 / access menuBar top level
1671
1672 ./
1673 ../
1674 ../../
1675 access current or parent menu level
1676
1677 /path/menu
1678 add/access menu
1679
1680 /path/{-}
1681 add separator
1682
1683 /path/{item}{rtext} action
1684 add/alter menu item
1685
1686 -/* remove all menus from the menuBar
1687
1688 -/path/menu
1689 remove menu items, separators and submenus from menu
1690
1691 -/path/menu
1692 remove menu
1693
1694 -/path/{item}
1695 remove item
1696
1697 -/path/{-}
1698 remove separator
1699
1700 <b>Begin<r>Right<l>Left<u>Up<d>Down<e>End
1701 menu quick arrows
1702 1372
1703XPM 1373XPM
1704 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"
1705 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
1706 scaling/positioning commands separated by semi-colons. The 1376 scaling/positioning commands separated by semi-colons. The
1962 1632
1963 --enable-tinting (default: on) 1633 --enable-tinting (default: on)
1964 Add support for tinting of transparent backgrounds (requires 1634 Add support for tinting of transparent backgrounds (requires
1965 "--enable-transparency"). 1635 "--enable-transparency").
1966 1636
1967 --enable-menubar (default: off) [DEPRECATED]
1968 Add support for our menu bar system (this interacts badly with
1969 dynamic locale switching currently). This option is DEPRECATED and
1970 will be removed in the future.
1971
1972 --enable-rxvt-scroll (default: on) 1637 --enable-rxvt-scroll (default: on)
1973 Add support for the original rxvt scrollbar. 1638 Add support for the original rxvt scrollbar.
1974 1639
1975 --enable-next-scroll (default: on) 1640 --enable-next-scroll (default: on)
1976 Add support for a NeXT-like scrollbar. 1641 Add support for a NeXT-like scrollbar.
1999 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
2000 it. 1665 it.
2001 1666
2002 --disable-resources 1667 --disable-resources
2003 Removes any support for resource checking. 1668 Removes any support for resource checking.
2004
2005 --enable-strings (default: off)
2006 Add support for our possibly faster memset() function and other
2007 various routines, overriding your system's versions which may have
2008 been hand-crafted in assembly or may require extra libraries to link
2009 in. (this breaks ANSI-C rules and has problems on many GNU/Linux
2010 systems).
2011 1669
2012 --disable-swapscreen 1670 --disable-swapscreen
2013 Remove support for secondary/swap screen. 1671 Remove support for secondary/swap screen.
2014 1672
2015 --enable-frills (default: on) 1673 --enable-frills (default: on)

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines