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.38 by root, Wed Jan 11 19:55:34 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, 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
41 I don't like the new selection/popups/hotkeys/perl, how do I
42 change/disable it?
43 You can disable the perl extension completely by setting the
44 perl-ext-common resource to the empty string, which also keeps
45 rxvt-unicode from initialising perl, saving memory.
46
47 If you only want to disable specific features, you first have to
48 identify which perl extension is responsible. For this, read the
49 section PREPACKAGED EXTENSIONS in the rxvtperl(3) manpage. For
50 example, to disable the selection-popup and option-popup, specify
51 this perl-ext-common resource:
52
53 URxvt.perl-ext-common: default,-selection-popup,-option-popup
54
55 This will keep the default extensions, but disable the two popup
56 extensions. Some extensions can also be configured, for example,
57 scrollback search mode is triggered by M-s. You can move it to any
58 other combination either by setting the searchable-scrollback
59 resource:
60
61 URxvt.searchable-scrollback: CM-s
62
23 Isn't rxvt supposed to be small? Don't all those features bloat? 63 Isn't rxvt supposed to be small? Don't all those features bloat?
24 I often get asked about this, and I think, no, they didn't cause 64 I often get asked about this, and I think, no, they didn't cause
25 extra bloat. If you compare a minimal rxvt and a minimal urxvt, you 65 extra bloat. If you compare a minimal rxvt and a minimal urxvt, you
26 can see that the urxvt binary is larger (due to some encoding tables 66 can see that the urxvt binary is larger (due to some encoding tables
27 always being compiled in), but it actually uses less memory (RSS) 67 always being compiled in), but it actually uses less memory (RSS)
614 Mouse cut/paste suddenly no longer works. 654 Mouse cut/paste suddenly no longer works.
615 Make sure that mouse reporting is actually turned off since killing 655 Make sure that mouse reporting is actually turned off since killing
616 some editors prematurely may leave the mouse in mouse report mode. 656 some editors prematurely may leave the mouse in mouse report mode.
617 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
618 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
619 or Shift keys are depressed. See rxvt(7) 659 or Shift keys are depressed.
620 660
621 What's with this bold/blink stuff? 661 What's with this bold/blink stuff?
622 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
623 the standard foreground colour. 663 the standard foreground colour.
624 664
710 750
711 # use Backspace = ^? 751 # use Backspace = ^?
712 $ stty erase ^? 752 $ stty erase ^?
713 $ rxvt 753 $ rxvt
714 754
715 Toggle with "ESC [ 36 h" / "ESC [ 36 l" as documented in rxvt(7). 755 Toggle with "ESC [ 36 h" / "ESC [ 36 l".
716 756
717 For an existing rxvt-unicode: 757 For an existing rxvt-unicode:
718 758
719 # use Backspace = ^H 759 # use Backspace = ^H
720 $ stty erase ^H 760 $ stty erase ^H
1212 1252
1213 "Ps = 9" X10 XTerm 1253 "Ps = 9" X10 XTerm
1214 h Send Mouse X & Y on button press. 1254 h Send Mouse X & Y on button press.
1215 l No mouse reporting. 1255 l No mouse reporting.
1216 1256
1217 "Ps = 10" (rxvt)
1218 h menuBar visible
1219 l menuBar invisible
1220
1221 "Ps = 25" 1257 "Ps = 25"
1222 h Visible cursor {cnorm/cvvis} 1258 h Visible cursor {cnorm/cvvis}
1223 l Invisible cursor {civis} 1259 l Invisible cursor {civis}
1224 1260
1225 "Ps = 30" 1261 "Ps = 30"
1318 Ps = 46 Change Log File to Pt unimplemented 1354 Ps = 46 Change Log File to Pt unimplemented
1319 Ps = 49 Change default background colour to Pt. 1355 Ps = 49 Change default background colour to Pt.
1320 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
1321 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
1322 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).
1323 Ps = 703 Menubar command Pt (Compile menubar).
1324 Ps = 704 Change colour of italic characters to Pt 1359 Ps = 704 Change colour of italic characters to Pt
1325 Ps = 705 Change background pixmap tint colour to Pt (Compile transparency). 1360 Ps = 705 Change background pixmap tint colour to Pt (Compile transparency).
1326 Ps = 706 Change colour of bold characters to Pt 1361 Ps = 706 Change colour of bold characters to Pt
1327 Ps = 707 Change colour of underlined characters to Pt 1362 Ps = 707 Change colour of underlined characters to Pt
1328 Ps = 710 Set normal fontset to Pt. Same as Ps = 50. 1363 Ps = 710 Set normal fontset to Pt. Same as Ps = 50.
1332 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).
1333 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).
1334 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).
1335 1370
1336 1371
1337
1338menuBar
1339 The exact syntax used is *almost* solidified. In the menus, DON'T try to
1340 use menuBar commands that add or remove a menuBar.
1341
1342 Note that in all of the commands, the */path/* *cannot* be omitted: use
1343 ./ to specify a menu relative to the current menu.
1344
1345 Overview of menuBar operation
1346 For the menuBar XTerm escape sequence "ESC ] 703 ; Pt ST", the syntax of
1347 "Pt" can be used for a variety of tasks:
1348
1349 At the top level is the current menuBar which is a member of a circular
1350 linked-list of other such menuBars.
1351
1352 The menuBar acts as a parent for the various drop-down menus, which in
1353 turn, may have labels, separator lines, menuItems and subMenus.
1354
1355 The menuItems are the useful bits: you can use them to mimic keyboard
1356 input or even to send text or escape sequences back to rxvt.
1357
1358 The menuBar syntax is intended to provide a simple yet robust method of
1359 constructing and manipulating menus and navigating through the menuBars.
1360
1361 The first step is to use the tag [menu:*name*] which creates the menuBar
1362 called *name* and allows access. You may now or menus, subMenus, and
1363 menuItems. Finally, use the tag [done] to set the menuBar access as
1364 readonly to prevent accidental corruption of the menus. To re-access the
1365 current menuBar for alterations, use the tag [menu], make the
1366 alterations and then use [done]
1367
1368
1369
1370 Commands
1371 [menu:+*name*]
1372 access the named menuBar for creation or alteration. If a new
1373 menuBar is created, it is called *name* (max of 15 chars) and the
1374 current menuBar is pushed onto the stack
1375
1376 [menu]
1377 access the current menuBar for alteration
1378
1379 [title:+*string*]
1380 set the current menuBar's title to *string*, which may contain the
1381 following format specifiers:
1382
1383 B<%n> rxvt name (as per the B<-name> command-line option)
1384 B<%v> rxvt version
1385 B<%%> literal B<%> character
1386
1387 [done]
1388 set menuBar access as readonly. End-of-file tag for [read:+*file*]
1389 operations.
1390
1391 [read:+*file*]
1392 read menu commands directly from *file* (extension ".menu" will be
1393 appended if required.) Start reading at a line with [menu] or
1394 [menu:+*name* and continuing until [done] is encountered.
1395
1396 Blank and comment lines (starting with #) are ignored. Actually,
1397 since any invalid menu commands are also ignored, almost anything
1398 could be construed as a comment line, but this may be tightened up
1399 in the future ... so don't count on it!.
1400
1401 [read:+*file*;+*name*]
1402 The same as [read:+*file*], but start reading at a line with
1403 [menu:+*name*] and continuing until [done:+*name*] or [done] is
1404 encountered.
1405
1406 [dump]
1407 dump all menuBars to the file /tmp/rxvt-PID in a format suitable for
1408 later rereading.
1409
1410 [rm:name]
1411 remove the named menuBar
1412
1413 [rm] [rm:]
1414 remove the current menuBar
1415
1416 [rm*] [rm:*]
1417 remove all menuBars
1418
1419 [swap]
1420 swap the top two menuBars
1421
1422 [prev]
1423 access the previous menuBar
1424
1425 [next]
1426 access the next menuBar
1427
1428 [show]
1429 Enable display of the menuBar
1430
1431 [hide]
1432 Disable display of the menuBar
1433
1434 [pixmap:+*name*]
1435 [pixmap:+*name*;*scaling*]
1436 (set the background pixmap globally
1437
1438 A Future implementation *may* make this local to the menubar)
1439
1440 [:+*command*:]
1441 ignore the menu readonly status and issue a *command* to or a menu
1442 or menuitem or change the ; a useful shortcut for setting the quick
1443 arrows from a menuBar.
1444
1445
1446
1447 Adding and accessing menus
1448 The following commands may also be + prefixed.
1449
1450 /+ access menuBar top level
1451
1452 ./+ access current menu level
1453
1454 ../+
1455 access parent menu (1 level up)
1456
1457 ../../
1458 access parent menu (multiple levels up)
1459
1460 */path/*menu
1461 add/access menu
1462
1463 */path/*menu/*
1464 add/access menu and clear it if it exists
1465
1466 */path/*{-}
1467 add separator
1468
1469 */path/*{item}
1470 add item as a label
1471
1472 */path/*{item} action
1473 add/alter *menuitem* with an associated *action*
1474
1475 */path/*{item}{right-text}
1476 add/alter *menuitem* with right-text as the right-justified text and
1477 as the associated *action*
1478
1479 */path/*{item}{rtext} action
1480 add/alter *menuitem* with an associated *action* and with rtext as
1481 the right-justified text.
1482
1483 Special characters in *action* must be backslash-escaped:
1484 \a \b \E \e \n \r \t \octal
1485
1486 or in control-character notation:
1487 ^@, ^A .. ^Z .. ^_, ^?
1488
1489 To send a string starting with a NUL (^@) character to the program,
1490 start *action* with a pair of NUL characters (^@^@), the first of which
1491 will be stripped off and the balance directed to the program. Otherwise
1492 if *action* begins with NUL followed by non-+NUL characters, the leading
1493 NUL is stripped off and the balance is sent back to rxvt.
1494
1495 As a convenience for the many Emacs-type editors, *action* may start
1496 with M- (eg, M-$ is equivalent to \E$) and a CR will be appended if
1497 missed from M-x commands.
1498
1499 As a convenience for issuing XTerm ESC ] sequences from a menubar (or
1500 quick arrow), a BEL (^G) will be appended if needed.
1501
1502 For example,
1503 M-xapropos is equivalent to \Exapropos\r
1504
1505 and \E]703;mona;100 is equivalent to \E]703;mona;100\a
1506
1507 The option {*right-rtext*} will be right-justified. In the absence of a
1508 specified action, this text will be used as the *action* as well.
1509
1510 For example,
1511 /File/{Open}{^X^F} is equivalent to /File/{Open}{^X^F} ^X^F
1512
1513 The left label *is* necessary, since it's used for matching, but
1514 implicitly hiding the left label (by using same name for both left and
1515 right labels), or explicitly hiding the left label (by preceeding it
1516 with a dot), makes it possible to have right-justified text only.
1517
1518 For example,
1519 /File/{Open}{Open} Open-File-Action
1520
1521 or hiding it
1522 /File/{.anylabel}{Open} Open-File-Action
1523
1524
1525
1526 Removing menus
1527 -/*+
1528 remove all menus from the menuBar, the same as [clear]
1529
1530 -+*/path*menu+
1531 remove menu
1532
1533 -+*/path*{item}+
1534 remove item
1535
1536 -+*/path*{-}
1537 remove separator)
1538
1539 -/path/menu/*
1540 remove all items, separators and submenus from menu
1541
1542
1543
1544 Quick Arrows
1545 The menus also provide a hook for *quick arrows* to provide easier user
1546 access. If nothing has been explicitly set, the default is to emulate
1547 the curror keys. The syntax permits each arrow to be altered
1548 individually or all four at once without re-entering their common
1549 beginning/end text. For example, to explicitly associate cursor actions
1550 with the arrows, any of the following forms could be used:
1551
1552 <r>+*Right*
1553 <l>+*Left*
1554 <u>+*Up*
1555 <d>+*Down*
1556 Define actions for the respective arrow buttons
1557
1558 <b>+*Begin*
1559 <e>+*End*
1560 Define common beginning/end parts for *quick arrows* which used in
1561 conjunction with the above <r> <l> <u> <d> constructs
1562
1563 For example, define arrows individually,
1564 <u>\E[A
1565
1566 <d>\E[B
1567
1568 <r>\E[C
1569
1570 <l>\E[D
1571
1572 or all at once
1573 <u>\E[AZ<><d>\E[BZ<><r>\E[CZ<><l>\E[D
1574
1575 or more compactly (factoring out common parts)
1576 <b>\E[<u>AZ<><d>BZ<><r>CZ<><l>D
1577
1578
1579
1580 Command Summary
1581 A short summary of the most *common* commands:
1582
1583 [menu:name]
1584 use an existing named menuBar or start a new one
1585
1586 [menu]
1587 use the current menuBar
1588
1589 [title:string]
1590 set menuBar title
1591
1592 [done]
1593 set menu access to readonly and, if reading from a file, signal EOF
1594
1595 [done:name]
1596 if reading from a file using [read:file;name] signal EOF
1597
1598 [rm:name]
1599 remove named menuBar(s)
1600
1601 [rm] [rm:]
1602 remove current menuBar
1603
1604 [rm*] [rm:*]
1605 remove all menuBar(s)
1606
1607 [swap]
1608 swap top two menuBars
1609
1610 [prev]
1611 access the previous menuBar
1612
1613 [next]
1614 access the next menuBar
1615
1616 [show]
1617 map menuBar
1618
1619 [hide]
1620 unmap menuBar
1621
1622 [pixmap;file]
1623 [pixmap;file;scaling]
1624 set a background pixmap
1625
1626 [read:file]
1627 [read:file;name]
1628 read in a menu from a file
1629
1630 [dump]
1631 dump out all menuBars to /tmp/rxvt-PID
1632
1633 / access menuBar top level
1634
1635 ./
1636 ../
1637 ../../
1638 access current or parent menu level
1639
1640 /path/menu
1641 add/access menu
1642
1643 /path/{-}
1644 add separator
1645
1646 /path/{item}{rtext} action
1647 add/alter menu item
1648
1649 -/* remove all menus from the menuBar
1650
1651 -/path/menu
1652 remove menu items, separators and submenus from menu
1653
1654 -/path/menu
1655 remove menu
1656
1657 -/path/{item}
1658 remove item
1659
1660 -/path/{-}
1661 remove separator
1662
1663 <b>Begin<r>Right<l>Left<u>Up<d>Down<e>End
1664 menu quick arrows
1665 1372
1666XPM 1373XPM
1667 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"
1668 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
1669 scaling/positioning commands separated by semi-colons. The 1376 scaling/positioning commands separated by semi-colons. The
1925 1632
1926 --enable-tinting (default: on) 1633 --enable-tinting (default: on)
1927 Add support for tinting of transparent backgrounds (requires 1634 Add support for tinting of transparent backgrounds (requires
1928 "--enable-transparency"). 1635 "--enable-transparency").
1929 1636
1930 --enable-menubar (default: off) [DEPRECATED]
1931 Add support for our menu bar system (this interacts badly with
1932 dynamic locale switching currently). This option is DEPRECATED and
1933 will be removed in the future.
1934
1935 --enable-rxvt-scroll (default: on) 1637 --enable-rxvt-scroll (default: on)
1936 Add support for the original rxvt scrollbar. 1638 Add support for the original rxvt scrollbar.
1937 1639
1938 --enable-next-scroll (default: on) 1640 --enable-next-scroll (default: on)
1939 Add support for a NeXT-like scrollbar. 1641 Add support for a NeXT-like scrollbar.
1962 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
1963 it. 1665 it.
1964 1666
1965 --disable-resources 1667 --disable-resources
1966 Removes any support for resource checking. 1668 Removes any support for resource checking.
1967
1968 --enable-xgetdefault
1969 Make resources checking via XGetDefault() instead of our small
1970 version which only checks ~/.Xdefaults, or if that doesn't exist
1971 then ~/.Xresources.
1972
1973 Please note that nowadays, things like XIM will automatically pull
1974 in and use the full X resource manager, so the overhead of using it
1975 might be very small, if nonexistant.
1976
1977 --enable-strings (default: off)
1978 Add support for our possibly faster memset() function and other
1979 various routines, overriding your system's versions which may have
1980 been hand-crafted in assembly or may require extra libraries to link
1981 in. (this breaks ANSI-C rules and has problems on many GNU/Linux
1982 systems).
1983 1669
1984 --disable-swapscreen 1670 --disable-swapscreen
1985 Remove support for secondary/swap screen. 1671 Remove support for secondary/swap screen.
1986 1672
1987 --enable-frills (default: on) 1673 --enable-frills (default: on)

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines