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.76 by root, Wed Jan 11 19:55:34 2006 UTC vs.
Revision 1.85 by root, Mon Jan 16 15:12:48 2006 UTC

23L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>. 23L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>.
24 24
25=head1 FREQUENTLY ASKED QUESTIONS 25=head1 FREQUENTLY ASKED QUESTIONS
26 26
27=over 4 27=over 4
28
29=item The new selection selects pieces that are too big, how can I select
30single words?
31
32Yes. For example, if you want to select alphanumeric words, you can use
33the following resource:
34
35 URxvt.selection.pattern-0: ([[:word:]]+)
36
37If you click more than twice, the selection will be extended
38more and more.
39
40To get a selection that is very similar to the old code, try this pattern:
41
42 URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+)
43
44Please also note that the I<LeftClick Shift-LeftClik> combination also
45selects words like the old code.
46
47=item I don't like the new selection/popups/hotkeys/perl, how do I
48change/disable it?
49
50You can disable the perl extension completely by setting the
51B<perl-ext-common> resource to the empty string, which also keeps
52rxvt-unicode from initialising perl, saving memory.
53
54If you only want to disable specific features, you first have to
55identify which perl extension is responsible. For this, read the section
56B<PREPACKAGED EXTENSIONS> in the @@RXVT_NAME@@perl(3) manpage. For
57example, to disable the B<selection-popup> and B<option-popup>, specify
58this B<perl-ext-common> resource:
59
60 URxvt.perl-ext-common: default,-selection-popup,-option-popup
61
62This will keep the default extensions, but disable the two popup
63extensions. Some extensions can also be configured, for example,
64scrollback search mode is triggered by B<M-s>. You can move it to any
65other combination either by setting the B<searchable-scrollback> resource:
66
67 URxvt.searchable-scrollback: CM-s
28 68
29=item Isn't rxvt supposed to be small? Don't all those features bloat? 69=item Isn't rxvt supposed to be small? Don't all those features bloat?
30 70
31I often get asked about this, and I think, no, they didn't cause extra 71I often get asked about this, and I think, no, they didn't cause extra
32bloat. If you compare a minimal rxvt and a minimal urxvt, you can see 72bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
576=item My input method wants <some encoding> but I want UTF-8, what can I do? 616=item My input method wants <some encoding> but I want UTF-8, what can I do?
577 617
578You can specify separate locales for the input method and the rest of the 618You can specify separate locales for the input method and the rest of the
579terminal, using the resource C<imlocale>: 619terminal, using the resource C<imlocale>:
580 620
581 URxvt*imlocale: ja_JP.EUC-JP 621 URxvt.imlocale: ja_JP.EUC-JP
582 622
583Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still 623Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
584use your input method. Please note, however, that you will not be able to 624use your input method. Please note, however, that you will not be able to
585input characters outside C<EUC-JP> in a normal way then, as your input 625input characters outside C<EUC-JP> in a normal way then, as your input
586method limits you. 626method limits you.
632 672
633Make sure that mouse reporting is actually turned off since killing 673Make sure that mouse reporting is actually turned off since killing
634some editors prematurely may leave the mouse in mouse report mode. I've 674some editors prematurely may leave the mouse in mouse report mode. I've
635heard that tcsh may use mouse reporting unless it otherwise specified. A 675heard that tcsh may use mouse reporting unless it otherwise specified. A
636quick check is to see if cut/paste works when the Alt or Shift keys are 676quick check is to see if cut/paste works when the Alt or Shift keys are
637depressed. See @@RXVT_NAME@@(7) 677depressed.
638 678
639=item What's with this bold/blink stuff? 679=item What's with this bold/blink stuff?
640 680
641If no bold colour is set via C<colorBD:>, bold will invert text using the 681If no bold colour is set via C<colorBD:>, bold will invert text using the
642standard foreground colour. 682standard foreground colour.
731 771
732 # use Backspace = ^? 772 # use Backspace = ^?
733 $ stty erase ^? 773 $ stty erase ^?
734 $ @@RXVT_NAME@@ 774 $ @@RXVT_NAME@@
735 775
736Toggle with C<ESC [ 36 h> / C<ESC [ 36 l> as documented in @@RXVT_NAME@@(7). 776Toggle with C<ESC [ 36 h> / C<ESC [ 36 l>.
737 777
738For an existing rxvt-unicode: 778For an existing rxvt-unicode:
739 779
740 # use Backspace = ^H 780 # use Backspace = ^H
741 $ stty erase ^H 781 $ stty erase ^H
859 899
860=head1 DESCRIPTION 900=head1 DESCRIPTION
861 901
862The rest of this document describes various technical aspects of 902The rest of this document describes various technical aspects of
863B<rxvt-unicode>. First the description of supported command sequences, 903B<rxvt-unicode>. First the description of supported command sequences,
864followed by menu and pixmap support and last by a description of all 904followed by pixmap support and last by a description of all features
865features selectable at C<configure> time. 905selectable at C<configure> time.
866 906
867=head1 Definitions 907=head1 Definitions
868 908
869=over 4 909=over 4
870 910
1438 B<< C<h> >> Send Mouse X & Y on button press. 1478 B<< C<h> >> Send Mouse X & Y on button press.
1439 B<< C<l> >> No mouse reporting. 1479 B<< C<l> >> No mouse reporting.
1440 1480
1441=end table 1481=end table
1442 1482
1443=item B<< C<Ps = 10> >> (B<rxvt>)
1444
1445=begin table
1446
1447 B<< C<h> >> menuBar visible
1448 B<< C<l> >> menuBar invisible
1449
1450=end table
1451
1452=item B<< C<Ps = 25> >> 1483=item B<< C<Ps = 25> >>
1453 1484
1454=begin table 1485=begin table
1455 1486
1456 B<< C<h> >> Visible cursor {cnorm/cvvis} 1487 B<< C<h> >> Visible cursor {cnorm/cvvis}
1645 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented> 1676 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
1646 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>. 1677 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>.
1647 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> >> 1678 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> >>
1648 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> 1679 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>
1649 B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (Compile frills). 1680 B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (Compile frills).
1650 B<< C<Ps = 703> >> Menubar command B<< C<Pt> >> (Compile menubar).
1651 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >> 1681 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
1652 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency). 1682 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
1653 B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >> 1683 B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >>
1654 B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >> 1684 B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >>
1655 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>. 1685 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
1662 1692
1663=end table 1693=end table
1664 1694
1665=back 1695=back
1666 1696
1667X<menuBar>
1668
1669=head1 menuBar
1670
1671B<< The exact syntax used is I<almost> solidified. >>
1672In the menus, B<DON'T> try to use menuBar commands that add or remove a
1673menuBar.
1674
1675Note that in all of the commands, the B<< I</path/> >> I<cannot> be
1676omitted: use B<./> to specify a menu relative to the current menu.
1677
1678=head2 Overview of menuBar operation
1679
1680For the menuBar XTerm escape sequence C<ESC ] 703 ; Pt ST>, the syntax
1681of C<Pt> can be used for a variety of tasks:
1682
1683At the top level is the current menuBar which is a member of a circular
1684linked-list of other such menuBars.
1685
1686The menuBar acts as a parent for the various drop-down menus, which in
1687turn, may have labels, separator lines, menuItems and subMenus.
1688
1689The menuItems are the useful bits: you can use them to mimic keyboard
1690input or even to send text or escape sequences back to rxvt.
1691
1692The menuBar syntax is intended to provide a simple yet robust method of
1693constructing and manipulating menus and navigating through the
1694menuBars.
1695
1696The first step is to use the tag B<< [menu:I<name>] >> which creates
1697the menuBar called I<name> and allows access. You may now or menus,
1698subMenus, and menuItems. Finally, use the tag B<[done]> to set the
1699menuBar access as B<readonly> to prevent accidental corruption of the
1700menus. To re-access the current menuBar for alterations, use the tag
1701B<[menu]>, make the alterations and then use B<[done]>
1702
1703X<menuBarCommands>
1704
1705=head2 Commands
1706
1707=over 4
1708
1709=item B<< [menu:+I<name>] >>
1710
1711access the named menuBar for creation or alteration. If a new menuBar
1712is created, it is called I<name> (max of 15 chars) and the current
1713menuBar is pushed onto the stack
1714
1715=item B<[menu]>
1716
1717access the current menuBar for alteration
1718
1719=item B<< [title:+I<string>] >>
1720
1721set the current menuBar's title to I<string>, which may contain the
1722following format specifiers:
1723
1724 B<%n> rxvt name (as per the B<-name> command-line option)
1725 B<%v> rxvt version
1726 B<%%> literal B<%> character
1727
1728=item B<[done]>
1729
1730set menuBar access as B<readonly>.
1731End-of-file tag for B<< [read:+I<file>] >> operations.
1732
1733=item B<< [read:+I<file>] >>
1734
1735read menu commands directly from I<file> (extension ".menu" will be
1736appended if required.) Start reading at a line with B<[menu]> or B<<
1737[menu:+I<name> >> and continuing until B<[done]> is encountered.
1738
1739Blank and comment lines (starting with B<#>) are ignored. Actually,
1740since any invalid menu commands are also ignored, almost anything could
1741be construed as a comment line, but this may be tightened up in the
1742future ... so don't count on it!.
1743
1744=item B<< [read:+I<file>;+I<name>] >>
1745
1746The same as B<< [read:+I<file>] >>, but start reading at a line with
1747B<< [menu:+I<name>] >> and continuing until B<< [done:+I<name>] >> or
1748B<[done]> is encountered.
1749
1750=item B<[dump]>
1751
1752dump all menuBars to the file B</tmp/rxvt-PID> in a format suitable for
1753later rereading.
1754
1755=item B<[rm:name]>
1756
1757remove the named menuBar
1758
1759=item B<[rm] [rm:]>
1760
1761remove the current menuBar
1762
1763=item B<[rm*] [rm:*]>
1764
1765remove all menuBars
1766
1767=item B<[swap]>
1768
1769swap the top two menuBars
1770
1771=item B<[prev]>
1772
1773access the previous menuBar
1774
1775=item B<[next]>
1776
1777access the next menuBar
1778
1779=item B<[show]>
1780
1781Enable display of the menuBar
1782
1783=item B<[hide]>
1784
1785Disable display of the menuBar
1786
1787=item B<< [pixmap:+I<name>] >>
1788
1789=item B<< [pixmap:+I<name>;I<scaling>] >>
1790
1791(set the background pixmap globally
1792
1793B<< A Future implementation I<may> make this local to the menubar >>)
1794
1795=item B<< [:+I<command>:] >>
1796
1797ignore the menu readonly status and issue a I<command> to or a menu or
1798menuitem or change the ; a useful shortcut for setting the quick arrows
1799from a menuBar.
1800
1801=back
1802
1803X<menuBarAdd>
1804
1805=head2 Adding and accessing menus
1806
1807The following commands may also be B<+> prefixed.
1808
1809=over 4
1810
1811=item B</+>
1812
1813access menuBar top level
1814
1815=item B<./+>
1816
1817access current menu level
1818
1819=item B<../+>
1820
1821access parent menu (1 level up)
1822
1823=item B<../../>
1824
1825access parent menu (multiple levels up)
1826
1827=item B<< I</path/>menu >>
1828
1829add/access menu
1830
1831=item B<< I</path/>menu/* >>
1832
1833add/access menu and clear it if it exists
1834
1835=item B<< I</path/>{-} >>
1836
1837add separator
1838
1839=item B<< I</path/>{item} >>
1840
1841add B<item> as a label
1842
1843=item B<< I</path/>{item} action >>
1844
1845add/alter I<menuitem> with an associated I<action>
1846
1847=item B<< I</path/>{item}{right-text} >>
1848
1849add/alter I<menuitem> with B<right-text> as the right-justified text
1850and as the associated I<action>
1851
1852=item B<< I</path/>{item}{rtext} action >>
1853
1854add/alter I<menuitem> with an associated I<action> and with B<rtext> as
1855the right-justified text.
1856
1857=back
1858
1859=over 4
1860
1861=item Special characters in I<action> must be backslash-escaped:
1862
1863B<\a \b \E \e \n \r \t \octal>
1864
1865=item or in control-character notation:
1866
1867B<^@, ^A .. ^Z .. ^_, ^?>
1868
1869=back
1870
1871To send a string starting with a B<NUL> (B<^@>) character to the
1872program, start I<action> with a pair of B<NUL> characters (B<^@^@>),
1873the first of which will be stripped off and the balance directed to the
1874program. Otherwise if I<action> begins with B<NUL> followed by
1875non-+B<NUL> characters, the leading B<NUL> is stripped off and the
1876balance is sent back to rxvt.
1877
1878As a convenience for the many Emacs-type editors, I<action> may start
1879with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be
1880appended if missed from B<M-x> commands.
1881
1882As a convenience for issuing XTerm B<ESC ]> sequences from a menubar (or
1883quick arrow), a B<BEL> (B<^G>) will be appended if needed.
1884
1885=over 4
1886
1887=item For example,
1888
1889B<M-xapropos> is equivalent to B<\Exapropos\r>
1890
1891=item and
1892
1893B<\E]703;mona;100> is equivalent to B<\E]703;mona;100\a>
1894
1895=back
1896
1897The option B<< {I<right-rtext>} >> will be right-justified. In the
1898absence of a specified action, this text will be used as the I<action>
1899as well.
1900
1901=over 4
1902
1903=item For example,
1904
1905B</File/{Open}{^X^F}> is equivalent to B</File/{Open}{^X^F} ^X^F>
1906
1907=back
1908
1909The left label I<is> necessary, since it's used for matching, but
1910implicitly hiding the left label (by using same name for both left and
1911right labels), or explicitly hiding the left label (by preceeding it
1912with a dot), makes it possible to have right-justified text only.
1913
1914=over 4
1915
1916=item For example,
1917
1918B</File/{Open}{Open} Open-File-Action>
1919
1920=item or hiding it
1921
1922B</File/{.anylabel}{Open} Open-File-Action>
1923
1924=back
1925
1926X<menuBarRemove>
1927
1928=head2 Removing menus
1929
1930=over 4
1931
1932=item B<< -/*+ >>
1933
1934remove all menus from the menuBar, the same as B<[clear]>
1935
1936=item B<< -+I</path>menu+ >>
1937
1938remove menu
1939
1940=item B<< -+I</path>{item}+ >>
1941
1942remove item
1943
1944=item B<< -+I</path>{-} >>
1945
1946remove separator)
1947
1948=item B<-/path/menu/*>
1949
1950remove all items, separators and submenus from menu
1951
1952=back
1953
1954X<menuBarArrows>
1955
1956=head2 Quick Arrows
1957
1958The menus also provide a hook for I<quick arrows> to provide easier
1959user access. If nothing has been explicitly set, the default is to
1960emulate the curror keys. The syntax permits each arrow to be altered
1961individually or all four at once without re-entering their common
1962beginning/end text. For example, to explicitly associate cursor actions
1963with the arrows, any of the following forms could be used:
1964
1965=over 4
1966
1967=item B<< <r>+I<Right> >>
1968
1969=item B<< <l>+I<Left> >>
1970
1971=item B<< <u>+I<Up> >>
1972
1973=item B<< <d>+I<Down> >>
1974
1975Define actions for the respective arrow buttons
1976
1977=item B<< <b>+I<Begin> >>
1978
1979=item B<< <e>+I<End> >>
1980
1981Define common beginning/end parts for I<quick arrows> which used in
1982conjunction with the above <r> <l> <u> <d> constructs
1983
1984=back
1985
1986=over 4
1987
1988=item For example, define arrows individually,
1989
1990 <u>\E[A
1991
1992 <d>\E[B
1993
1994 <r>\E[C
1995
1996 <l>\E[D
1997
1998=item or all at once
1999
2000 <u>\E[AZ<><d>\E[BZ<><r>\E[CZ<><l>\E[D
2001
2002=item or more compactly (factoring out common parts)
2003
2004 <b>\E[<u>AZ<><d>BZ<><r>CZ<><l>D
2005
2006=back
2007
2008X<menuBarSummary>
2009
2010=head2 Command Summary
2011
2012A short summary of the most I<common> commands:
2013
2014=over 4
2015
2016=item [menu:name]
2017
2018use an existing named menuBar or start a new one
2019
2020=item [menu]
2021
2022use the current menuBar
2023
2024=item [title:string]
2025
2026set menuBar title
2027
2028=item [done]
2029
2030set menu access to readonly and, if reading from a file, signal EOF
2031
2032=item [done:name]
2033
2034if reading from a file using [read:file;name] signal EOF
2035
2036=item [rm:name]
2037
2038remove named menuBar(s)
2039
2040=item [rm] [rm:]
2041
2042remove current menuBar
2043
2044=item [rm*] [rm:*]
2045
2046remove all menuBar(s)
2047
2048=item [swap]
2049
2050swap top two menuBars
2051
2052=item [prev]
2053
2054access the previous menuBar
2055
2056=item [next]
2057
2058access the next menuBar
2059
2060=item [show]
2061
2062map menuBar
2063
2064=item [hide]
2065
2066unmap menuBar
2067
2068=item [pixmap;file]
2069
2070=item [pixmap;file;scaling]
2071
2072set a background pixmap
2073
2074=item [read:file]
2075
2076=item [read:file;name]
2077
2078read in a menu from a file
2079
2080=item [dump]
2081
2082dump out all menuBars to /tmp/rxvt-PID
2083
2084=item /
2085
2086access menuBar top level
2087
2088=item ./
2089
2090=item ../
2091
2092=item ../../
2093
2094access current or parent menu level
2095
2096=item /path/menu
2097
2098add/access menu
2099
2100=item /path/{-}
2101
2102add separator
2103
2104=item /path/{item}{rtext} action
2105
2106add/alter menu item
2107
2108=item -/*
2109
2110remove all menus from the menuBar
2111
2112=item -/path/menu
2113
2114remove menu items, separators and submenus from menu
2115
2116=item -/path/menu
2117
2118remove menu
2119
2120=item -/path/{item}
2121
2122remove item
2123
2124=item -/path/{-}
2125
2126remove separator
2127
2128=item <b>Begin<r>Right<l>Left<u>Up<d>Down<e>End
2129
2130menu quick arrows
2131
2132=back
2133X<XPM> 1697X<XPM>
2134 1698
2135=head1 XPM 1699=head1 XPM
2136 1700
2137For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value 1701For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value
2464 2028
2465=item --enable-tinting (default: on) 2029=item --enable-tinting (default: on)
2466 2030
2467Add support for tinting of transparent backgrounds (requires C<--enable-transparency>). 2031Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2468 2032
2469=item --enable-menubar (default: off) [DEPRECATED]
2470
2471Add support for our menu bar system (this interacts badly with dynamic
2472locale switching currently). This option is DEPRECATED and will be removed
2473in the future.
2474
2475=item --enable-rxvt-scroll (default: on) 2033=item --enable-rxvt-scroll (default: on)
2476 2034
2477Add support for the original rxvt scrollbar. 2035Add support for the original rxvt scrollbar.
2478 2036
2479=item --enable-next-scroll (default: on) 2037=item --enable-next-scroll (default: on)
2510do it. 2068do it.
2511 2069
2512=item --disable-resources 2070=item --disable-resources
2513 2071
2514Removes any support for resource checking. 2072Removes any support for resource checking.
2515
2516=item --enable-xgetdefault
2517
2518Make resources checking via XGetDefault() instead of our small
2519version which only checks ~/.Xdefaults, or if that doesn't exist then
2520~/.Xresources.
2521
2522Please note that nowadays, things like XIM will automatically pull in and
2523use the full X resource manager, so the overhead of using it might be very
2524small, if nonexistant.
2525
2526=item --enable-strings (default: off)
2527
2528Add support for our possibly faster memset() function and other
2529various routines, overriding your system's versions which may
2530have been hand-crafted in assembly or may require extra libraries
2531to link in. (this breaks ANSI-C rules and has problems on many
2532GNU/Linux systems).
2533 2073
2534=item --disable-swapscreen 2074=item --disable-swapscreen
2535 2075
2536Remove support for secondary/swap screen. 2076Remove support for secondary/swap screen.
2537 2077

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines