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.81 by root, Fri Jan 13 12:40:46 2006 UTC vs.
Revision 1.83 by root, Mon Jan 16 14:48:39 2006 UTC

… …
1478 B<< C<h> >> Send Mouse X & Y on button press. 1478 B<< C<h> >> Send Mouse X & Y on button press.
1479 B<< C<l> >> No mouse reporting. 1479 B<< C<l> >> No mouse reporting.
1480 1480
1481=end table 1481=end table
1482 1482
1483=item B<< C<Ps = 10> >> (B<rxvt>)
1484
1485=begin table
1486
1487 B<< C<h> >> menuBar visible
1488 B<< C<l> >> menuBar invisible
1489
1490=end table
1491
1492=item B<< C<Ps = 25> >> 1483=item B<< C<Ps = 25> >>
1493 1484
1494=begin table 1485=begin table
1495 1486
1496 B<< C<h> >> Visible cursor {cnorm/cvvis} 1487 B<< C<h> >> Visible cursor {cnorm/cvvis}
… …
1685 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>
1686 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> >>.
1687 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> >>
1688 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> >>
1689 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).
1690 B<< C<Ps = 703> >> Menubar command B<< C<Pt> >> (Compile menubar).
1691 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> >>
1692 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).
1693 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> >>
1694 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> >>
1695 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>.
… …
1702 1692
1703=end table 1693=end table
1704 1694
1705=back 1695=back
1706 1696
1707X<menuBar>
1708
1709=head1 menuBar
1710
1711B<< The exact syntax used is I<almost> solidified. >>
1712In the menus, B<DON'T> try to use menuBar commands that add or remove a
1713menuBar.
1714
1715Note that in all of the commands, the B<< I</path/> >> I<cannot> be
1716omitted: use B<./> to specify a menu relative to the current menu.
1717
1718=head2 Overview of menuBar operation
1719
1720For the menuBar XTerm escape sequence C<ESC ] 703 ; Pt ST>, the syntax
1721of C<Pt> can be used for a variety of tasks:
1722
1723At the top level is the current menuBar which is a member of a circular
1724linked-list of other such menuBars.
1725
1726The menuBar acts as a parent for the various drop-down menus, which in
1727turn, may have labels, separator lines, menuItems and subMenus.
1728
1729The menuItems are the useful bits: you can use them to mimic keyboard
1730input or even to send text or escape sequences back to rxvt.
1731
1732The menuBar syntax is intended to provide a simple yet robust method of
1733constructing and manipulating menus and navigating through the
1734menuBars.
1735
1736The first step is to use the tag B<< [menu:I<name>] >> which creates
1737the menuBar called I<name> and allows access. You may now or menus,
1738subMenus, and menuItems. Finally, use the tag B<[done]> to set the
1739menuBar access as B<readonly> to prevent accidental corruption of the
1740menus. To re-access the current menuBar for alterations, use the tag
1741B<[menu]>, make the alterations and then use B<[done]>
1742
1743X<menuBarCommands>
1744
1745=head2 Commands
1746
1747=over 4
1748
1749=item B<< [menu:+I<name>] >>
1750
1751access the named menuBar for creation or alteration. If a new menuBar
1752is created, it is called I<name> (max of 15 chars) and the current
1753menuBar is pushed onto the stack
1754
1755=item B<[menu]>
1756
1757access the current menuBar for alteration
1758
1759=item B<< [title:+I<string>] >>
1760
1761set the current menuBar's title to I<string>, which may contain the
1762following format specifiers:
1763
1764 B<%n> rxvt name (as per the B<-name> command-line option)
1765 B<%v> rxvt version
1766 B<%%> literal B<%> character
1767
1768=item B<[done]>
1769
1770set menuBar access as B<readonly>.
1771End-of-file tag for B<< [read:+I<file>] >> operations.
1772
1773=item B<< [read:+I<file>] >>
1774
1775read menu commands directly from I<file> (extension ".menu" will be
1776appended if required.) Start reading at a line with B<[menu]> or B<<
1777[menu:+I<name> >> and continuing until B<[done]> is encountered.
1778
1779Blank and comment lines (starting with B<#>) are ignored. Actually,
1780since any invalid menu commands are also ignored, almost anything could
1781be construed as a comment line, but this may be tightened up in the
1782future ... so don't count on it!.
1783
1784=item B<< [read:+I<file>;+I<name>] >>
1785
1786The same as B<< [read:+I<file>] >>, but start reading at a line with
1787B<< [menu:+I<name>] >> and continuing until B<< [done:+I<name>] >> or
1788B<[done]> is encountered.
1789
1790=item B<[dump]>
1791
1792dump all menuBars to the file B</tmp/rxvt-PID> in a format suitable for
1793later rereading.
1794
1795=item B<[rm:name]>
1796
1797remove the named menuBar
1798
1799=item B<[rm] [rm:]>
1800
1801remove the current menuBar
1802
1803=item B<[rm*] [rm:*]>
1804
1805remove all menuBars
1806
1807=item B<[swap]>
1808
1809swap the top two menuBars
1810
1811=item B<[prev]>
1812
1813access the previous menuBar
1814
1815=item B<[next]>
1816
1817access the next menuBar
1818
1819=item B<[show]>
1820
1821Enable display of the menuBar
1822
1823=item B<[hide]>
1824
1825Disable display of the menuBar
1826
1827=item B<< [pixmap:+I<name>] >>
1828
1829=item B<< [pixmap:+I<name>;I<scaling>] >>
1830
1831(set the background pixmap globally
1832
1833B<< A Future implementation I<may> make this local to the menubar >>)
1834
1835=item B<< [:+I<command>:] >>
1836
1837ignore the menu readonly status and issue a I<command> to or a menu or
1838menuitem or change the ; a useful shortcut for setting the quick arrows
1839from a menuBar.
1840
1841=back
1842
1843X<menuBarAdd>
1844
1845=head2 Adding and accessing menus
1846
1847The following commands may also be B<+> prefixed.
1848
1849=over 4
1850
1851=item B</+>
1852
1853access menuBar top level
1854
1855=item B<./+>
1856
1857access current menu level
1858
1859=item B<../+>
1860
1861access parent menu (1 level up)
1862
1863=item B<../../>
1864
1865access parent menu (multiple levels up)
1866
1867=item B<< I</path/>menu >>
1868
1869add/access menu
1870
1871=item B<< I</path/>menu/* >>
1872
1873add/access menu and clear it if it exists
1874
1875=item B<< I</path/>{-} >>
1876
1877add separator
1878
1879=item B<< I</path/>{item} >>
1880
1881add B<item> as a label
1882
1883=item B<< I</path/>{item} action >>
1884
1885add/alter I<menuitem> with an associated I<action>
1886
1887=item B<< I</path/>{item}{right-text} >>
1888
1889add/alter I<menuitem> with B<right-text> as the right-justified text
1890and as the associated I<action>
1891
1892=item B<< I</path/>{item}{rtext} action >>
1893
1894add/alter I<menuitem> with an associated I<action> and with B<rtext> as
1895the right-justified text.
1896
1897=back
1898
1899=over 4
1900
1901=item Special characters in I<action> must be backslash-escaped:
1902
1903B<\a \b \E \e \n \r \t \octal>
1904
1905=item or in control-character notation:
1906
1907B<^@, ^A .. ^Z .. ^_, ^?>
1908
1909=back
1910
1911To send a string starting with a B<NUL> (B<^@>) character to the
1912program, start I<action> with a pair of B<NUL> characters (B<^@^@>),
1913the first of which will be stripped off and the balance directed to the
1914program. Otherwise if I<action> begins with B<NUL> followed by
1915non-+B<NUL> characters, the leading B<NUL> is stripped off and the
1916balance is sent back to rxvt.
1917
1918As a convenience for the many Emacs-type editors, I<action> may start
1919with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be
1920appended if missed from B<M-x> commands.
1921
1922As a convenience for issuing XTerm B<ESC ]> sequences from a menubar (or
1923quick arrow), a B<BEL> (B<^G>) will be appended if needed.
1924
1925=over 4
1926
1927=item For example,
1928
1929B<M-xapropos> is equivalent to B<\Exapropos\r>
1930
1931=item and
1932
1933B<\E]703;mona;100> is equivalent to B<\E]703;mona;100\a>
1934
1935=back
1936
1937The option B<< {I<right-rtext>} >> will be right-justified. In the
1938absence of a specified action, this text will be used as the I<action>
1939as well.
1940
1941=over 4
1942
1943=item For example,
1944
1945B</File/{Open}{^X^F}> is equivalent to B</File/{Open}{^X^F} ^X^F>
1946
1947=back
1948
1949The left label I<is> necessary, since it's used for matching, but
1950implicitly hiding the left label (by using same name for both left and
1951right labels), or explicitly hiding the left label (by preceeding it
1952with a dot), makes it possible to have right-justified text only.
1953
1954=over 4
1955
1956=item For example,
1957
1958B</File/{Open}{Open} Open-File-Action>
1959
1960=item or hiding it
1961
1962B</File/{.anylabel}{Open} Open-File-Action>
1963
1964=back
1965
1966X<menuBarRemove>
1967
1968=head2 Removing menus
1969
1970=over 4
1971
1972=item B<< -/*+ >>
1973
1974remove all menus from the menuBar, the same as B<[clear]>
1975
1976=item B<< -+I</path>menu+ >>
1977
1978remove menu
1979
1980=item B<< -+I</path>{item}+ >>
1981
1982remove item
1983
1984=item B<< -+I</path>{-} >>
1985
1986remove separator)
1987
1988=item B<-/path/menu/*>
1989
1990remove all items, separators and submenus from menu
1991
1992=back
1993
1994X<menuBarArrows>
1995
1996=head2 Quick Arrows
1997
1998The menus also provide a hook for I<quick arrows> to provide easier
1999user access. If nothing has been explicitly set, the default is to
2000emulate the curror keys. The syntax permits each arrow to be altered
2001individually or all four at once without re-entering their common
2002beginning/end text. For example, to explicitly associate cursor actions
2003with the arrows, any of the following forms could be used:
2004
2005=over 4
2006
2007=item B<< <r>+I<Right> >>
2008
2009=item B<< <l>+I<Left> >>
2010
2011=item B<< <u>+I<Up> >>
2012
2013=item B<< <d>+I<Down> >>
2014
2015Define actions for the respective arrow buttons
2016
2017=item B<< <b>+I<Begin> >>
2018
2019=item B<< <e>+I<End> >>
2020
2021Define common beginning/end parts for I<quick arrows> which used in
2022conjunction with the above <r> <l> <u> <d> constructs
2023
2024=back
2025
2026=over 4
2027
2028=item For example, define arrows individually,
2029
2030 <u>\E[A
2031
2032 <d>\E[B
2033
2034 <r>\E[C
2035
2036 <l>\E[D
2037
2038=item or all at once
2039
2040 <u>\E[AZ<><d>\E[BZ<><r>\E[CZ<><l>\E[D
2041
2042=item or more compactly (factoring out common parts)
2043
2044 <b>\E[<u>AZ<><d>BZ<><r>CZ<><l>D
2045
2046=back
2047
2048X<menuBarSummary>
2049
2050=head2 Command Summary
2051
2052A short summary of the most I<common> commands:
2053
2054=over 4
2055
2056=item [menu:name]
2057
2058use an existing named menuBar or start a new one
2059
2060=item [menu]
2061
2062use the current menuBar
2063
2064=item [title:string]
2065
2066set menuBar title
2067
2068=item [done]
2069
2070set menu access to readonly and, if reading from a file, signal EOF
2071
2072=item [done:name]
2073
2074if reading from a file using [read:file;name] signal EOF
2075
2076=item [rm:name]
2077
2078remove named menuBar(s)
2079
2080=item [rm] [rm:]
2081
2082remove current menuBar
2083
2084=item [rm*] [rm:*]
2085
2086remove all menuBar(s)
2087
2088=item [swap]
2089
2090swap top two menuBars
2091
2092=item [prev]
2093
2094access the previous menuBar
2095
2096=item [next]
2097
2098access the next menuBar
2099
2100=item [show]
2101
2102map menuBar
2103
2104=item [hide]
2105
2106unmap menuBar
2107
2108=item [pixmap;file]
2109
2110=item [pixmap;file;scaling]
2111
2112set a background pixmap
2113
2114=item [read:file]
2115
2116=item [read:file;name]
2117
2118read in a menu from a file
2119
2120=item [dump]
2121
2122dump out all menuBars to /tmp/rxvt-PID
2123
2124=item /
2125
2126access menuBar top level
2127
2128=item ./
2129
2130=item ../
2131
2132=item ../../
2133
2134access current or parent menu level
2135
2136=item /path/menu
2137
2138add/access menu
2139
2140=item /path/{-}
2141
2142add separator
2143
2144=item /path/{item}{rtext} action
2145
2146add/alter menu item
2147
2148=item -/*
2149
2150remove all menus from the menuBar
2151
2152=item -/path/menu
2153
2154remove menu items, separators and submenus from menu
2155
2156=item -/path/menu
2157
2158remove menu
2159
2160=item -/path/{item}
2161
2162remove item
2163
2164=item -/path/{-}
2165
2166remove separator
2167
2168=item <b>Begin<r>Right<l>Left<u>Up<d>Down<e>End
2169
2170menu quick arrows
2171
2172=back
2173X<XPM> 1697X<XPM>
2174 1698
2175=head1 XPM 1699=head1 XPM
2176 1700
2177For 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
… …
2504 2028
2505=item --enable-tinting (default: on) 2029=item --enable-tinting (default: on)
2506 2030
2507Add support for tinting of transparent backgrounds (requires C<--enable-transparency>). 2031Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2508 2032
2509=item --enable-menubar (default: off) [DEPRECATED]
2510
2511Add support for our menu bar system (this interacts badly with dynamic
2512locale switching currently). This option is DEPRECATED and will be removed
2513in the future.
2514
2515=item --enable-rxvt-scroll (default: on) 2033=item --enable-rxvt-scroll (default: on)
2516 2034
2517Add support for the original rxvt scrollbar. 2035Add support for the original rxvt scrollbar.
2518 2036
2519=item --enable-next-scroll (default: on) 2037=item --enable-next-scroll (default: on)
… …
2550do it. 2068do it.
2551 2069
2552=item --disable-resources 2070=item --disable-resources
2553 2071
2554Removes any support for resource checking. 2072Removes any support for resource checking.
2555
2556=item --enable-strings (default: off)
2557
2558Add support for our possibly faster memset() function and other
2559various routines, overriding your system's versions which may
2560have been hand-crafted in assembly or may require extra libraries
2561to link in. (this breaks ANSI-C rules and has problems on many
2562GNU/Linux systems).
2563 2073
2564=item --disable-swapscreen 2074=item --disable-swapscreen
2565 2075
2566Remove support for secondary/swap screen. 2076Remove support for secondary/swap screen.
2567 2077

Diff Legend

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