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

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines