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

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

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

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents): Revision 1.78 by root, Thu Jan 12 05:37:34 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.78 by root, Thu Jan 12 05:37:34 2006 UTC vs.
Revision 1.86 by root, Mon Jan 16 17:24:29 2006 UTC