[ViewVC] Diff of: cvs/rxvt-unicode/doc/rxvt.7.pod

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents):
Revision 1.79 by root, Thu Jan 12 23:11:23 2006 UTC vs.
Revision 1.86 by root, Mon Jan 16 17:24:29 2006 UTC

…		…
24		24
25	=head1 FREQUENTLY ASKED QUESTIONS	25	=head1 FREQUENTLY ASKED QUESTIONS
26		26
27	=over 4	27	=over 4
28		28
29	=item The new selection selects pieces that are too big/too small, can I	29	=item The new selection selects pieces that are too big, how can I select
30	change this?	30	single words?
31		31
32	Yes. For example, if you want to select smaller pieces ("words") you can	32	Yes. For example, if you want to select alphanumeric words, you can use
33	use the following resource:	33	the following resource:
34		34
35	URxvt.selection.pattern-0: ([[:word:]]+)	35	URxvt.selection.pattern-0: ([[:word:]]+)
36		36
37	If you click more than twice, the selection will be extended	37	If you click more than twice, the selection will be extended
38	more and more.	38	more and more.
39		39
40	To get a selection that is very similar to the old code, try this pattern:	40	To get a selection that is very similar to the old code, try this pattern:
41		41
42	URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{\|})]+)	42	URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{\|})]+)
		43
		44	Please also note that the I<LeftClick Shift-LeftClik> combination also
		45	selects words like the old code.
43		46
44	=item I don't like the new selection/popups/hotkeys/perl, how do I	47	=item I don't like the new selection/popups/hotkeys/perl, how do I
45	change/disable it?	48	change/disable it?
46		49
47	You can disable the perl extension completely by setting the	50	You can disable the perl extension completely by setting the
…		…
613	=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?
614		617
615	You can specify separate locales for the input method and the rest of the	618	You can specify separate locales for the input method and the rest of the
616	terminal, using the resource C<imlocale>:	619	terminal, using the resource C<imlocale>:
617		620
618	URxvt*imlocale: ja_JP.EUC-JP	621	URxvt.imlocale: ja_JP.EUC-JP
619		622
620	Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still	623	Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
621	use your input method. Please note, however, that you will not be able to	624	use your input method. Please note, however, that you will not be able to
622	input characters outside C<EUC-JP> in a normal way then, as your input	625	input characters outside C<EUC-JP> in a normal way then, as your input
623	method limits you.	626	method limits you.
…		…
669		672
670	Make sure that mouse reporting is actually turned off since killing	673	Make sure that mouse reporting is actually turned off since killing
671	some editors prematurely may leave the mouse in mouse report mode. I've	674	some editors prematurely may leave the mouse in mouse report mode. I've
672	heard that tcsh may use mouse reporting unless it otherwise specified. A	675	heard that tcsh may use mouse reporting unless it otherwise specified. A
673	quick check is to see if cut/paste works when the Alt or Shift keys are	676	quick check is to see if cut/paste works when the Alt or Shift keys are
674	depressed. See @@RXVT_NAME@@(7)	677	depressed.
675		678
676	=item What's with this bold/blink stuff?	679	=item What's with this bold/blink stuff?
677		680
678	If no bold colour is set via C<colorBD:>, bold will invert text using the	681	If no bold colour is set via C<colorBD:>, bold will invert text using the
679	standard foreground colour.	682	standard foreground colour.
…		…
768		771
769	# use Backspace = ^?	772	# use Backspace = ^?
770	$ stty erase ^?	773	$ stty erase ^?
771	$ @@RXVT_NAME@@	774	$ @@RXVT_NAME@@
772		775
773	Toggle with C<ESC [ 36 h> / C<ESC [ 36 l> as documented in @@RXVT_NAME@@(7).	776	Toggle with C<ESC [ 36 h> / C<ESC [ 36 l>.
774		777
775	For an existing rxvt-unicode:	778	For an existing rxvt-unicode:
776		779
777	# use Backspace = ^H	780	# use Backspace = ^H
778	$ stty erase ^H	781	$ stty erase ^H
…		…
896		899
897	=head1 DESCRIPTION	900	=head1 DESCRIPTION
898		901
899	The rest of this document describes various technical aspects of	902	The rest of this document describes various technical aspects of
900	B<rxvt-unicode>. First the description of supported command sequences,	903	B<rxvt-unicode>. First the description of supported command sequences,
901	followed by menu and pixmap support and last by a description of all	904	followed by pixmap support and last by a description of all features
902	features selectable at C<configure> time.	905	selectable at C<configure> time.
903		906
904	=head1 Definitions	907	=head1 Definitions
905		908
906	=over 4	909	=over 4
907		910
…		…
1475	B<< C<h> >> Send Mouse X & Y on button press.	1478	B<< C<h> >> Send Mouse X & Y on button press.
1476	B<< C<l> >> No mouse reporting.	1479	B<< C<l> >> No mouse reporting.
1477		1480
1478	=end table	1481	=end table
1479		1482
1480	=item B<< C<Ps = 10> >> (B<rxvt>)
1481
1482	=begin table
1483
1484	B<< C<h> >> menuBar visible
1485	B<< C<l> >> menuBar invisible
1486
1487	=end table
1488
1489	=item B<< C<Ps = 25> >>	1483	=item B<< C<Ps = 25> >>
1490		1484
1491	=begin table	1485	=begin table
1492		1486
1493	B<< C<h> >> Visible cursor {cnorm/cvvis}	1487	B<< C<h> >> Visible cursor {cnorm/cvvis}
…		…
1682	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>
1683	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> >>.
1684	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> >>
1685	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> >>
1686	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).
1687	B<< C<Ps = 703> >> Menubar command B<< C<Pt> >> (Compile menubar).
1688	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> >>
1689	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).
1690	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> >>
1691	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> >>
1692	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>.
…		…
1699		1692
1700	=end table	1693	=end table
1701		1694
1702	=back	1695	=back
1703		1696
1704	X<menuBar>
1705
1706	=head1 menuBar
1707
1708	B<< The exact syntax used is I<almost> solidified. >>
1709	In the menus, B<DON'T> try to use menuBar commands that add or remove a
1710	menuBar.
1711
1712	Note that in all of the commands, the B<< I</path/> >> I<cannot> be
1713	omitted: use B<./> to specify a menu relative to the current menu.
1714
1715	=head2 Overview of menuBar operation
1716
1717	For the menuBar XTerm escape sequence C<ESC ] 703 ; Pt ST>, the syntax
1718	of C<Pt> can be used for a variety of tasks:
1719
1720	At the top level is the current menuBar which is a member of a circular
1721	linked-list of other such menuBars.
1722
1723	The menuBar acts as a parent for the various drop-down menus, which in
1724	turn, may have labels, separator lines, menuItems and subMenus.
1725
1726	The menuItems are the useful bits: you can use them to mimic keyboard
1727	input or even to send text or escape sequences back to rxvt.
1728
1729	The menuBar syntax is intended to provide a simple yet robust method of
1730	constructing and manipulating menus and navigating through the
1731	menuBars.
1732
1733	The first step is to use the tag B<< [menu:I<name>] >> which creates
1734	the menuBar called I<name> and allows access. You may now or menus,
1735	subMenus, and menuItems. Finally, use the tag B<[done]> to set the
1736	menuBar access as B<readonly> to prevent accidental corruption of the
1737	menus. To re-access the current menuBar for alterations, use the tag
1738	B<[menu]>, make the alterations and then use B<[done]>
1739
1740	X<menuBarCommands>
1741
1742	=head2 Commands
1743
1744	=over 4
1745
1746	=item B<< [menu:+I<name>] >>
1747
1748	access the named menuBar for creation or alteration. If a new menuBar
1749	is created, it is called I<name> (max of 15 chars) and the current
1750	menuBar is pushed onto the stack
1751
1752	=item B<[menu]>
1753
1754	access the current menuBar for alteration
1755
1756	=item B<< [title:+I<string>] >>
1757
1758	set the current menuBar's title to I<string>, which may contain the
1759	following format specifiers:
1760
1761	B<%n> rxvt name (as per the B<-name> command-line option)
1762	B<%v> rxvt version
1763	B<%%> literal B<%> character
1764
1765	=item B<[done]>
1766
1767	set menuBar access as B<readonly>.
1768	End-of-file tag for B<< [read:+I<file>] >> operations.
1769
1770	=item B<< [read:+I<file>] >>
1771
1772	read menu commands directly from I<file> (extension ".menu" will be
1773	appended if required.) Start reading at a line with B<[menu]> or B<<
1774	[menu:+I<name> >> and continuing until B<[done]> is encountered.
1775
1776	Blank and comment lines (starting with B<#>) are ignored. Actually,
1777	since any invalid menu commands are also ignored, almost anything could
1778	be construed as a comment line, but this may be tightened up in the
1779	future ... so don't count on it!.
1780
1781	=item B<< [read:+I<file>;+I<name>] >>
1782
1783	The same as B<< [read:+I<file>] >>, but start reading at a line with
1784	B<< [menu:+I<name>] >> and continuing until B<< [done:+I<name>] >> or
1785	B<[done]> is encountered.
1786
1787	=item B<[dump]>
1788
1789	dump all menuBars to the file B</tmp/rxvt-PID> in a format suitable for
1790	later rereading.
1791
1792	=item B<[rm:name]>
1793
1794	remove the named menuBar
1795
1796	=item B<[rm] [rm:]>
1797
1798	remove the current menuBar
1799
1800	=item B<[rm] [rm:]>
1801
1802	remove all menuBars
1803
1804	=item B<[swap]>
1805
1806	swap the top two menuBars
1807
1808	=item B<[prev]>
1809
1810	access the previous menuBar
1811
1812	=item B<[next]>
1813
1814	access the next menuBar
1815
1816	=item B<[show]>
1817
1818	Enable display of the menuBar
1819
1820	=item B<[hide]>
1821
1822	Disable display of the menuBar
1823
1824	=item B<< [pixmap:+I<name>] >>
1825
1826	=item B<< [pixmap:+I<name>;I<scaling>] >>
1827
1828	(set the background pixmap globally
1829
1830	B<< A Future implementation I<may> make this local to the menubar >>)
1831
1832	=item B<< [:+I<command>:] >>
1833
1834	ignore the menu readonly status and issue a I<command> to or a menu or
1835	menuitem or change the ; a useful shortcut for setting the quick arrows
1836	from a menuBar.
1837
1838	=back
1839
1840	X<menuBarAdd>
1841
1842	=head2 Adding and accessing menus
1843
1844	The following commands may also be B<+> prefixed.
1845
1846	=over 4
1847
1848	=item B</+>
1849
1850	access menuBar top level
1851
1852	=item B<./+>
1853
1854	access current menu level
1855
1856	=item B<../+>
1857
1858	access parent menu (1 level up)
1859
1860	=item B<../../>
1861
1862	access parent menu (multiple levels up)
1863
1864	=item B<< I</path/>menu >>
1865
1866	add/access menu
1867
1868	=item B<< I</path/>menu/* >>
1869
1870	add/access menu and clear it if it exists
1871
1872	=item B<< I</path/>{-} >>
1873
1874	add separator
1875
1876	=item B<< I</path/>{item} >>
1877
1878	add B<item> as a label
1879
1880	=item B<< I</path/>{item} action >>
1881
1882	add/alter I<menuitem> with an associated I<action>
1883
1884	=item B<< I</path/>{item}{right-text} >>
1885
1886	add/alter I<menuitem> with B<right-text> as the right-justified text
1887	and as the associated I<action>
1888
1889	=item B<< I</path/>{item}{rtext} action >>
1890
1891	add/alter I<menuitem> with an associated I<action> and with B<rtext> as
1892	the right-justified text.
1893
1894	=back
1895
1896	=over 4
1897
1898	=item Special characters in I<action> must be backslash-escaped:
1899
1900	B<\a \b \E \e \n \r \t \octal>
1901
1902	=item or in control-character notation:
1903
1904	B<^@, ^A .. ^Z .. ^_, ^?>
1905
1906	=back
1907
1908	To send a string starting with a B<NUL> (B<^@>) character to the
1909	program, start I<action> with a pair of B<NUL> characters (B<^@^@>),
1910	the first of which will be stripped off and the balance directed to the
1911	program. Otherwise if I<action> begins with B<NUL> followed by
1912	non-+B<NUL> characters, the leading B<NUL> is stripped off and the
1913	balance is sent back to rxvt.
1914
1915	As a convenience for the many Emacs-type editors, I<action> may start
1916	with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be
1917	appended if missed from B<M-x> commands.
1918
1919	As a convenience for issuing XTerm B<ESC ]> sequences from a menubar (or
1920	quick arrow), a B<BEL> (B<^G>) will be appended if needed.
1921
1922	=over 4
1923
1924	=item For example,
1925
1926	B<M-xapropos> is equivalent to B<\Exapropos\r>
1927
1928	=item and
1929
1930	B<\E]703;mona;100> is equivalent to B<\E]703;mona;100\a>
1931
1932	=back
1933
1934	The option B<< {I<right-rtext>} >> will be right-justified. In the
1935	absence of a specified action, this text will be used as the I<action>
1936	as well.
1937
1938	=over 4
1939
1940	=item For example,
1941
1942	B</File/{Open}{^X^F}> is equivalent to B</File/{Open}{^X^F} ^X^F>
1943
1944	=back
1945
1946	The left label I<is> necessary, since it's used for matching, but
1947	implicitly hiding the left label (by using same name for both left and
1948	right labels), or explicitly hiding the left label (by preceeding it
1949	with a dot), makes it possible to have right-justified text only.
1950
1951	=over 4
1952
1953	=item For example,
1954
1955	B</File/{Open}{Open} Open-File-Action>
1956
1957	=item or hiding it
1958
1959	B</File/{.anylabel}{Open} Open-File-Action>
1960
1961	=back
1962
1963	X<menuBarRemove>
1964
1965	=head2 Removing menus
1966
1967	=over 4
1968
1969	=item B<< -/*+ >>
1970
1971	remove all menus from the menuBar, the same as B<[clear]>
1972
1973	=item B<< -+I</path>menu+ >>
1974
1975	remove menu
1976
1977	=item B<< -+I</path>{item}+ >>
1978
1979	remove item
1980
1981	=item B<< -+I</path>{-} >>
1982
1983	remove separator)
1984
1985	=item B<-/path/menu/*>
1986
1987	remove all items, separators and submenus from menu
1988
1989	=back
1990
1991	X<menuBarArrows>
1992
1993	=head2 Quick Arrows
1994
1995	The menus also provide a hook for I<quick arrows> to provide easier
1996	user access. If nothing has been explicitly set, the default is to
1997	emulate the curror keys. The syntax permits each arrow to be altered
1998	individually or all four at once without re-entering their common
1999	beginning/end text. For example, to explicitly associate cursor actions
2000	with the arrows, any of the following forms could be used:
2001
2002	=over 4
2003
2004	=item B<< <r>+I<Right> >>
2005
2006	=item B<< <l>+I<Left> >>
2007
2008	=item B<< <u>+I<Up> >>
2009
2010	=item B<< <d>+I<Down> >>
2011
2012	Define actions for the respective arrow buttons
2013
2014	=item B<< <b>+I<Begin> >>
2015
2016	=item B<< <e>+I<End> >>
2017
2018	Define common beginning/end parts for I<quick arrows> which used in
2019	conjunction with the above <r> <l> <u> <d> constructs
2020
2021	=back
2022
2023	=over 4
2024
2025	=item For example, define arrows individually,
2026
2027	<u>\E[A
2028
2029	<d>\E[B
2030
2031	<r>\E[C
2032
2033	<l>\E[D
2034
2035	=item or all at once
2036
2037	<u>\E[AZ<><d>\E[BZ<><r>\E[CZ<><l>\E[D
2038
2039	=item or more compactly (factoring out common parts)
2040
2041	<b>\E[<u>AZ<><d>BZ<><r>CZ<><l>D
2042
2043	=back
2044
2045	X<menuBarSummary>
2046
2047	=head2 Command Summary
2048
2049	A short summary of the most I<common> commands:
2050
2051	=over 4
2052
2053	=item [menu:name]
2054
2055	use an existing named menuBar or start a new one
2056
2057	=item [menu]
2058
2059	use the current menuBar
2060
2061	=item [title:string]
2062
2063	set menuBar title
2064
2065	=item [done]
2066
2067	set menu access to readonly and, if reading from a file, signal EOF
2068
2069	=item [done:name]
2070
2071	if reading from a file using [read:file;name] signal EOF
2072
2073	=item [rm:name]
2074
2075	remove named menuBar(s)
2076
2077	=item [rm] [rm:]
2078
2079	remove current menuBar
2080
2081	=item [rm] [rm:]
2082
2083	remove all menuBar(s)
2084
2085	=item [swap]
2086
2087	swap top two menuBars
2088
2089	=item [prev]
2090
2091	access the previous menuBar
2092
2093	=item [next]
2094
2095	access the next menuBar
2096
2097	=item [show]
2098
2099	map menuBar
2100
2101	=item [hide]
2102
2103	unmap menuBar
2104
2105	=item [pixmap;file]
2106
2107	=item [pixmap;file;scaling]
2108
2109	set a background pixmap
2110
2111	=item [read:file]
2112
2113	=item [read:file;name]
2114
2115	read in a menu from a file
2116
2117	=item [dump]
2118
2119	dump out all menuBars to /tmp/rxvt-PID
2120
2121	=item /
2122
2123	access menuBar top level
2124
2125	=item ./
2126
2127	=item ../
2128
2129	=item ../../
2130
2131	access current or parent menu level
2132
2133	=item /path/menu
2134
2135	add/access menu
2136
2137	=item /path/{-}
2138
2139	add separator
2140
2141	=item /path/{item}{rtext} action
2142
2143	add/alter menu item
2144
2145	=item -/*
2146
2147	remove all menus from the menuBar
2148
2149	=item -/path/menu
2150
2151	remove menu items, separators and submenus from menu
2152
2153	=item -/path/menu
2154
2155	remove menu
2156
2157	=item -/path/{item}
2158
2159	remove item
2160
2161	=item -/path/{-}
2162
2163	remove separator
2164
2165	=item <b>Begin<r>Right<l>Left<u>Up<d>Down<e>End
2166
2167	menu quick arrows
2168
2169	=back
2170	X<XPM>	1697	X<XPM>
2171		1698
2172	=head1 XPM	1699	=head1 XPM
2173		1700
2174	For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value	1701	For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value
…		…
2501		2028
2502	=item --enable-tinting (default: on)	2029	=item --enable-tinting (default: on)
2503		2030
2504	Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).	2031	Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2505		2032
2506	=item --enable-menubar (default: off) [DEPRECATED]
2507
2508	Add support for our menu bar system (this interacts badly with dynamic
2509	locale switching currently). This option is DEPRECATED and will be removed
2510	in the future.
2511
2512	=item --enable-rxvt-scroll (default: on)	2033	=item --enable-rxvt-scroll (default: on)
2513		2034
2514	Add support for the original rxvt scrollbar.	2035	Add support for the original rxvt scrollbar.
2515		2036
2516	=item --enable-next-scroll (default: on)	2037	=item --enable-next-scroll (default: on)
…		…
2525		2046
2526	Add support for a very unobtrusive, plain-looking scrollbar that	2047	Add support for a very unobtrusive, plain-looking scrollbar that
2527	is the favourite of the rxvt-unicode author, having used it for	2048	is the favourite of the rxvt-unicode author, having used it for
2528	many years.	2049	many years.
2529		2050
2530	=item --enable-half-shadow (default: off)
2531
2532	Make shadows on the scrollbar only half the normal width & height.
2533	only applicable to rxvt scrollbars.
2534
2535	=item --enable-ttygid (default: off)	2051	=item --enable-ttygid (default: off)
2536		2052
2537	Change tty device setting to group "tty" - only use this if	2053	Change tty device setting to group "tty" - only use this if
2538	your system uses this type of security.	2054	your system uses this type of security.
2539		2055
…		…
2547	do it.	2063	do it.
2548		2064
2549	=item --disable-resources	2065	=item --disable-resources
2550		2066
2551	Removes any support for resource checking.	2067	Removes any support for resource checking.
2552
2553	=item --enable-strings (default: off)
2554
2555	Add support for our possibly faster memset() function and other
2556	various routines, overriding your system's versions which may
2557	have been hand-crafted in assembly or may require extra libraries
2558	to link in. (this breaks ANSI-C rules and has problems on many
2559	GNU/Linux systems).
2560		2068
2561	=item --disable-swapscreen	2069	=item --disable-swapscreen
2562		2070
2563	Remove support for secondary/swap screen.	2071	Remove support for secondary/swap screen.
2564		2072

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents): Revision 1.79 by root, Thu Jan 12 23:11:23 2006 UTC vs. Revision 1.86 by root, Mon Jan 16 17:24:29 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents):
Revision 1.79 by root, Thu Jan 12 23:11:23 2006 UTC vs.
Revision 1.86 by root, Mon Jan 16 17:24:29 2006 UTC