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

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.98 by root, Tue Jan 31 00:56:07 2006 UTC

…		…
16	=head1 DESCRIPTION	16	=head1 DESCRIPTION
17		17
18	This document contains the FAQ, the RXVT TECHNICAL REFERENCE documenting	18	This document contains the FAQ, the RXVT TECHNICAL REFERENCE documenting
19	all escape sequences, and other background information.	19	all escape sequences, and other background information.
20		20
21	The newest version of this document is	21	The newest version of this document is also available on the World Wide Web at
22	also available on the World Wide Web at
23	L<http://cvs.schmorp.de/browse/checkout/rxvt-unicode/doc/rxvt.7.html>.	22	L<http://cvs.schmorp.de/browse/checkout/rxvt-unicode/doc/rxvt.7.html>.
24		23
25	=head1 FREQUENTLY ASKED QUESTIONS	24	=head1 FREQUENTLY ASKED QUESTIONS
26		25
27	=over 4
28
29	=item The new selection selects pieces that are too big, how can I select	26	=head2 The new selection selects pieces that are too big, how can I select
30	single words?	27	single words?
31		28
32	Yes. For example, if you want to select alphanumeric words, you can use	29	Yes. For example, if you want to select alphanumeric words, you can use
33	the following resource:	30	the following resource:
34		31
…		…
41		38
42	URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{\|})]+)	39	URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{\|})]+)
43		40
44	Please also note that the I<LeftClick Shift-LeftClik> combination also	41	Please also note that the I<LeftClick Shift-LeftClik> combination also
45	selects words like the old code.	42	selects words like the old code.
		43
		44	=over 4
46		45
47	=item I don't like the new selection/popups/hotkeys/perl, how do I	46	=item I don't like the new selection/popups/hotkeys/perl, how do I
48	change/disable it?	47	change/disable it?
49		48
50	You can disable the perl extension completely by setting the	49	You can disable the perl extension completely by setting the
…		…
63	extensions. Some extensions can also be configured, for example,	62	extensions. Some extensions can also be configured, for example,
64	scrollback search mode is triggered by B<M-s>. You can move it to any	63	scrollback search mode is triggered by B<M-s>. You can move it to any
65	other combination either by setting the B<searchable-scrollback> resource:	64	other combination either by setting the B<searchable-scrollback> resource:
66		65
67	URxvt.searchable-scrollback: CM-s	66	URxvt.searchable-scrollback: CM-s
		67
		68	=item The cursor moves when selecting text in the current input line, how
		69	do I switch this off?
		70
		71	=item During rlogin/ssh/telnet/etc. sessions, clicking near the cursor
		72	outputs strange escape sequences, how do I fix this?
		73
		74	These are caused by the C<readline> perl extension. Under normal
		75	circumstances, it will move your cursor around when you click into the
		76	line that contains it. It tries hard not to do this at the wrong moment,
		77	but when running a program that doesn't parse cursor movements or in some
		78	cases during rlogin sessions, it fails to detect this properly.
		79
		80	You can permamently switch this feature off by disabling the C<readline>
		81	extension:
		82
		83	URxvt.perl-ext-common: default,-readline
		84
		85	=item Why doesn't rxvt-unicode read my resources?
		86
		87	Well, why, indeed? It does, in a way very similar to other X
		88	applications. Most importantly, this means that if you or your OS loads
		89	resources into the X display (the right way to do it), rxvt-unicode will
		90	ignore any resource files in your home directory. It will only read
		91	F<$HOME/.Xdefaults> when no resources are attached to the display.
		92
		93	If you have or use an F<$HOME/.Xresources> file, chances are that
		94	resources are loaded into your X-server. In this case, you have to
		95	re-login after every change (or run F<xrdb -merge $HOME/.Xresources>).
		96
		97	Also consider the form resources have to use:
		98
		99	URxvt.resource: value
		100
		101	If you want to use another form (there are lots of different ways of
		102	specifying resources), make sure you understand wether and why it
		103	works. If unsure, use the form above.
		104
		105	=item I can't get transparency working, what am I doing wrong?
		106
		107	First of all, transparency isn't officially supported in rxvt-unicode, so
		108	you are mostly on your own. Do not bug the author about it (but you may
		109	bug everybody else). Also, if you can't get it working consider it a rite
		110	of passage: ... and you failed.
		111
		112	Here are four ways to get transparency. B<Do> read the manpage and option
		113	descriptions for the programs mentioned and rxvt-unicode. Really, do it!
		114
		115	1. Use inheritPixmap:
		116
		117	Esetroot wallpaper.jpg
		118	@@RXVT_NAME@@ -ip -tint red -sh 40
		119
		120	That works. If you think it doesn't, you lack transparency and tinting
		121	support, or you are unable to read.
		122
		123	2. Use a simple pixmap and emulate pseudo-transparency. This enables you
		124	to use effects other than tinting and shading: Just shade/tint/whatever
		125	your picture with gimp:
		126
		127	convert wallpaper.jpg -blur 20x20 -modulate 30 background.xpm
		128	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
		129
		130	That works. If you think it doesn't, you lack XPM and Perl support, or you
		131	are unable to read.
		132
		133	3. Use an ARGB visual:
		134
		135	@@RXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc
		136
		137	This requires XFT support, and the support of your X-server. If that
		138	doesn't work for you, blame Xorg and Keith Packard. ARGB visuals aren't
		139	there yet, no matter what they claim. Rxvt-Unicode contains the neccessary
		140	bugfixes and workarounds for Xft and Xlib to make it work, but that
		141	doesn't mean that your WM has the required kludges in place.
		142
		143	4. Use xcompmgr and let it do the job:
		144
		145	xprop -frame -f _NET_WM_WINDOW_OPACITY 32c \
		146	-set _NET_WM_WINDOW_OPACITY 0xc0000000
		147
		148	Then click on a window you want to make transparent. Replace C<0xc0000000>
		149	by other values to change the degree of opacity. If it doesn't work and
		150	your server crashes, you got to keep the pieces.
68		151
69	=item Isn't rxvt supposed to be small? Don't all those features bloat?	152	=item Isn't rxvt supposed to be small? Don't all those features bloat?
70		153
71	I often get asked about this, and I think, no, they didn't cause extra	154	I often get asked about this, and I think, no, they didn't cause extra
72	bloat. If you compare a minimal rxvt and a minimal urxvt, you can see	155	bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
…		…
142	No large bloated libraries (of course, none were linked in statically),	225	No large bloated libraries (of course, none were linked in statically),
143	except maybe libX11 :)	226	except maybe libX11 :)
144		227
145	=item Does it support tabs, can I have a tabbed rxvt-unicode?	228	=item Does it support tabs, can I have a tabbed rxvt-unicode?
146		229
147	rxvt-unicode does not directly support tabs. It will work fine with	230	Beginning with version 7.3, there is a perl extension that implements a
148	tabbing functionality of many window managers or similar tabbing programs,	231	simple tabbed terminal. It is installed by default, so any of these should
149	and its embedding-features allow it to be embedded into other programs,	232	give you tabs:
150	as witnessed by F<doc/rxvt-tabbed> or the upcoming C<Gtk2::URxvt> perl	233
151	module, which features a tabbed urxvt (murxvt) terminal as an example	234	@@RXVT_NAME@@ -pe tabbed
152	embedding application.	235
		236	URxvt.perl-ext-common: default,tabbed
		237
		238	It will also work fine with tabbing functionality of many window managers
		239	or similar tabbing programs, and its embedding-features allow it to be
		240	embedded into other programs, as witnessed by F<doc/rxvt-tabbed> or
		241	the upcoming C<Gtk2::URxvt> perl module, which features a tabbed urxvt
		242	(murxvt) terminal as an example embedding application.
153		243
154	=item How do I know which rxvt-unicode version I'm using?	244	=item How do I know which rxvt-unicode version I'm using?
155		245
156	The version number is displayed with the usage (-h). Also the escape	246	The version number is displayed with the usage (-h). Also the escape
157	sequence C<ESC [ 8 n> sets the window title to the version number. When	247	sequence C<ESC [ 8 n> sets the window title to the version number. When
…		…
159	daemon.	249	daemon.
160		250
161	=item I am using Debian GNU/Linux and have a problem...	251	=item I am using Debian GNU/Linux and have a problem...
162		252
163	The Debian GNU/Linux package of rxvt-unicode in sarge contains large	253	The Debian GNU/Linux package of rxvt-unicode in sarge contains large
164	patches that considerably change the behaviour of rxvt-unicode. Before	254	patches that considerably change the behaviour of rxvt-unicode (but
165	reporting a bug to the original rxvt-unicode author please download and	255	unfortunately this notice has been removed). Before reporting a bug to
166	install the genuine version (L<http://software.schmorp.de#rxvt-unicode>)	256	the original rxvt-unicode author please download and install the genuine
167	and try to reproduce the problem. If you cannot, chances are that the	257	version (L<http://software.schmorp.de#rxvt-unicode>) and try to reproduce
168	problems are specific to Debian GNU/Linux, in which case it should be	258	the problem. If you cannot, chances are that the problems are specific to
169	reported via the Debian Bug Tracking System (use C<reportbug> to report	259	Debian GNU/Linux, in which case it should be reported via the Debian Bug
170	the bug).	260	Tracking System (use C<reportbug> to report the bug).
171		261
172	For other problems that also affect the Debian package, you can and	262	For other problems that also affect the Debian package, you can and
173	probably should use the Debian BTS, too, because, after all, it's also a	263	probably should use the Debian BTS, too, because, after all, it's also a
174	bug in the Debian version and it serves as a reminder for other users that	264	bug in the Debian version and it serves as a reminder for other users that
175	might encounter the same issue.	265	might encounter the same issue.
176		266
177	=item I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?	267	=item I am maintaining rxvt-unicode for distribution/OS XXX, any
		268	recommendation?
178		269
179	You should build one binary with the default options. F<configure>	270	You should build one binary with the default options. F<configure>
180	now enables most useful options, and the trend goes to making them	271	now enables most useful options, and the trend goes to making them
181	runtime-switchable, too, so there is usually no drawback to enbaling them,	272	runtime-switchable, too, so there is usually no drawback to enbaling them,
182	except higher disk and possibly memory usage. The perl interpreter should	273	except higher disk and possibly memory usage. The perl interpreter should
…		…
194	C<--enable-everything> (less useful, it will be very big due to a lot of	285	C<--enable-everything> (less useful, it will be very big due to a lot of
195	encodings built-in that increase download times and are rarely used).	286	encodings built-in that increase download times and are rarely used).
196		287
197	=item I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?	288	=item I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?
198		289
199	Likely not. While I honestly try to make it secure, and am probably not	290	It should be, starting with release 7.1. You are encouraged to properly
200	bad at it, I think it is simply unreasonable to expect all of freetype	291	install urxvt with privileges necessary for your OS now.
201	+ fontconfig + xft + xlib + perl + ... + rxvt-unicode itself to all be
202	secure. Also, rxvt-unicode disables some options when it detects that it
203	runs setuid or setgid, which is not nice. Besides, with the embedded perl
204	interpreter the possibility for security problems easily multiplies.
205		292
206	Elevated privileges are only required for utmp and pty operations on some	293	When rxvt-unicode detects that it runs setuid or setgid, it will fork
207	systems (for example, GNU/Linux doesn't need any extra privileges for	294	into a helper process for privileged operations (pty handling on some
208	ptys, but some need it for utmp support). It is planned to mvoe this into	295	systems, utmp/wtmp/lastlog handling on others) and drop privileges
209	a forked handler process, but this is not yet done.	296	immediately. This is much safer than most other terminals that keep
		297	privileges while running (but is more relevant to urxvt, as it contains
		298	things as perl interpreters, which might be "helpful" to attackers).
210		299
211	So, while setuid/setgid operation is supported and not a problem on your	300	This forking is done as the very first within main(), which is very early
212	typical single-user-no-other-logins unix desktop, always remember that	301	and reduces possible bugs to initialisation code run before main(), or
213	its an awful lot of code, most of which isn't checked for security issues	302	things like the dynamic loader of your system, which should result in very
214	regularly.	303	little risk.
215		304
216	=item When I log-in to another system it tells me about missing terminfo data?	305	=item When I log-in to another system it tells me about missing terminfo data?
217		306
218	The terminal description used by rxvt-unicode is not as widely available	307	The terminal description used by rxvt-unicode is not as widely available
219	as that for xterm, or even rxvt (for which the same problem often arises).	308	as that for xterm, or even rxvt (for which the same problem often arises).
…		…
616	=item My input method wants <some encoding> but I want UTF-8, what can I do?	705	=item My input method wants <some encoding> but I want UTF-8, what can I do?
617		706
618	You can specify separate locales for the input method and the rest of the	707	You can specify separate locales for the input method and the rest of the
619	terminal, using the resource C<imlocale>:	708	terminal, using the resource C<imlocale>:
620		709
621	URxvt*imlocale: ja_JP.EUC-JP	710	URxvt.imlocale: ja_JP.EUC-JP
622		711
623	Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still	712	Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
624	use your input method. Please note, however, that you will not be able to	713	use your input method. Please note, however, that you will not be able to
625	input characters outside C<EUC-JP> in a normal way then, as your input	714	input characters outside C<EUC-JP> in a normal way then, as your input
626	method limits you.	715	method limits you.
…		…
899		988
900	=head1 DESCRIPTION	989	=head1 DESCRIPTION
901		990
902	The rest of this document describes various technical aspects of	991	The rest of this document describes various technical aspects of
903	B<rxvt-unicode>. First the description of supported command sequences,	992	B<rxvt-unicode>. First the description of supported command sequences,
904	followed by menu and pixmap support and last by a description of all	993	followed by pixmap support and last by a description of all features
905	features selectable at C<configure> time.	994	selectable at C<configure> time.
906		995
907	=head1 Definitions	996	=head1 Definitions
908		997
909	=over 4	998	=over 4
910		999
…		…
1478	B<< C<h> >> Send Mouse X & Y on button press.	1567	B<< C<h> >> Send Mouse X & Y on button press.
1479	B<< C<l> >> No mouse reporting.	1568	B<< C<l> >> No mouse reporting.
1480		1569
1481	=end table	1570	=end table
1482		1571
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> >>	1572	=item B<< C<Ps = 25> >>
1493		1573
1494	=begin table	1574	=begin table
1495		1575
1496	B<< C<h> >> Visible cursor {cnorm/cvvis}	1576	B<< C<h> >> Visible cursor {cnorm/cvvis}
…		…
1678	B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>	1758	B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>
1679	B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>	1759	B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
1680	B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>	1760	B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>
1681	B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706]	1761	B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706]
1682	B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]	1762	B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
1683	B<< C<Ps = 20> >> Change default background to B<< C<Pt> >>	1763	B<< C<Ps = 20> >> Change background pixmap parameters (see section XPM) (Compile XPM).
1684	B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>.	1764	B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>.
1685	B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>	1765	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> >>.	1766	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> >>	1767	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> >>	1768	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).	1769	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).	1770	B<< C<Ps = 702> >> Request version if B<< C<Pt> >> is B<< C<?> >>, returning C<rxvt-unicode>, the resource name, the major and minor version numbers, e.g. C<ESC ] 702 ; rxvt-unicode ; urxvt ; 7 ; 4 ST>.
1691	B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>	1771	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).	1772	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> >>	1773	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> >>	1774	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>.	1775	B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
…		…
1702		1782
1703	=end table	1783	=end table
1704		1784
1705	=back	1785	=back
1706		1786
1707	X<menuBar>
1708
1709	=head1 menuBar
1710
1711	B<< The exact syntax used is I<almost> solidified. >>
1712	In the menus, B<DON'T> try to use menuBar commands that add or remove a
1713	menuBar.
1714
1715	Note that in all of the commands, the B<< I</path/> >> I<cannot> be
1716	omitted: use B<./> to specify a menu relative to the current menu.
1717
1718	=head2 Overview of menuBar operation
1719
1720	For the menuBar XTerm escape sequence C<ESC ] 703 ; Pt ST>, the syntax
1721	of C<Pt> can be used for a variety of tasks:
1722
1723	At the top level is the current menuBar which is a member of a circular
1724	linked-list of other such menuBars.
1725
1726	The menuBar acts as a parent for the various drop-down menus, which in
1727	turn, may have labels, separator lines, menuItems and subMenus.
1728
1729	The menuItems are the useful bits: you can use them to mimic keyboard
1730	input or even to send text or escape sequences back to rxvt.
1731
1732	The menuBar syntax is intended to provide a simple yet robust method of
1733	constructing and manipulating menus and navigating through the
1734	menuBars.
1735
1736	The first step is to use the tag B<< [menu:I<name>] >> which creates
1737	the menuBar called I<name> and allows access. You may now or menus,
1738	subMenus, and menuItems. Finally, use the tag B<[done]> to set the
1739	menuBar access as B<readonly> to prevent accidental corruption of the
1740	menus. To re-access the current menuBar for alterations, use the tag
1741	B<[menu]>, make the alterations and then use B<[done]>
1742
1743	X<menuBarCommands>
1744
1745	=head2 Commands
1746
1747	=over 4
1748
1749	=item B<< [menu:+I<name>] >>
1750
1751	access the named menuBar for creation or alteration. If a new menuBar
1752	is created, it is called I<name> (max of 15 chars) and the current
1753	menuBar is pushed onto the stack
1754
1755	=item B<[menu]>
1756
1757	access the current menuBar for alteration
1758
1759	=item B<< [title:+I<string>] >>
1760
1761	set the current menuBar's title to I<string>, which may contain the
1762	following 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
1770	set menuBar access as B<readonly>.
1771	End-of-file tag for B<< [read:+I<file>] >> operations.
1772
1773	=item B<< [read:+I<file>] >>
1774
1775	read menu commands directly from I<file> (extension ".menu" will be
1776	appended if required.) Start reading at a line with B<[menu]> or B<<
1777	[menu:+I<name> >> and continuing until B<[done]> is encountered.
1778
1779	Blank and comment lines (starting with B<#>) are ignored. Actually,
1780	since any invalid menu commands are also ignored, almost anything could
1781	be construed as a comment line, but this may be tightened up in the
1782	future ... so don't count on it!.
1783
1784	=item B<< [read:+I<file>;+I<name>] >>
1785
1786	The same as B<< [read:+I<file>] >>, but start reading at a line with
1787	B<< [menu:+I<name>] >> and continuing until B<< [done:+I<name>] >> or
1788	B<[done]> is encountered.
1789
1790	=item B<[dump]>
1791
1792	dump all menuBars to the file B</tmp/rxvt-PID> in a format suitable for
1793	later rereading.
1794
1795	=item B<[rm:name]>
1796
1797	remove the named menuBar
1798
1799	=item B<[rm] [rm:]>
1800
1801	remove the current menuBar
1802
1803	=item B<[rm] [rm:]>
1804
1805	remove all menuBars
1806
1807	=item B<[swap]>
1808
1809	swap the top two menuBars
1810
1811	=item B<[prev]>
1812
1813	access the previous menuBar
1814
1815	=item B<[next]>
1816
1817	access the next menuBar
1818
1819	=item B<[show]>
1820
1821	Enable display of the menuBar
1822
1823	=item B<[hide]>
1824
1825	Disable 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
1833	B<< A Future implementation I<may> make this local to the menubar >>)
1834
1835	=item B<< [:+I<command>:] >>
1836
1837	ignore the menu readonly status and issue a I<command> to or a menu or
1838	menuitem or change the ; a useful shortcut for setting the quick arrows
1839	from a menuBar.
1840
1841	=back
1842
1843	X<menuBarAdd>
1844
1845	=head2 Adding and accessing menus
1846
1847	The following commands may also be B<+> prefixed.
1848
1849	=over 4
1850
1851	=item B</+>
1852
1853	access menuBar top level
1854
1855	=item B<./+>
1856
1857	access current menu level
1858
1859	=item B<../+>
1860
1861	access parent menu (1 level up)
1862
1863	=item B<../../>
1864
1865	access parent menu (multiple levels up)
1866
1867	=item B<< I</path/>menu >>
1868
1869	add/access menu
1870
1871	=item B<< I</path/>menu/* >>
1872
1873	add/access menu and clear it if it exists
1874
1875	=item B<< I</path/>{-} >>
1876
1877	add separator
1878
1879	=item B<< I</path/>{item} >>
1880
1881	add B<item> as a label
1882
1883	=item B<< I</path/>{item} action >>
1884
1885	add/alter I<menuitem> with an associated I<action>
1886
1887	=item B<< I</path/>{item}{right-text} >>
1888
1889	add/alter I<menuitem> with B<right-text> as the right-justified text
1890	and as the associated I<action>
1891
1892	=item B<< I</path/>{item}{rtext} action >>
1893
1894	add/alter I<menuitem> with an associated I<action> and with B<rtext> as
1895	the right-justified text.
1896
1897	=back
1898
1899	=over 4
1900
1901	=item Special characters in I<action> must be backslash-escaped:
1902
1903	B<\a \b \E \e \n \r \t \octal>
1904
1905	=item or in control-character notation:
1906
1907	B<^@, ^A .. ^Z .. ^_, ^?>
1908
1909	=back
1910
1911	To send a string starting with a B<NUL> (B<^@>) character to the
1912	program, start I<action> with a pair of B<NUL> characters (B<^@^@>),
1913	the first of which will be stripped off and the balance directed to the
1914	program. Otherwise if I<action> begins with B<NUL> followed by
1915	non-+B<NUL> characters, the leading B<NUL> is stripped off and the
1916	balance is sent back to rxvt.
1917
1918	As a convenience for the many Emacs-type editors, I<action> may start
1919	with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be
1920	appended if missed from B<M-x> commands.
1921
1922	As a convenience for issuing XTerm B<ESC ]> sequences from a menubar (or
1923	quick arrow), a B<BEL> (B<^G>) will be appended if needed.
1924
1925	=over 4
1926
1927	=item For example,
1928
1929	B<M-xapropos> is equivalent to B<\Exapropos\r>
1930
1931	=item and
1932
1933	B<\E]703;mona;100> is equivalent to B<\E]703;mona;100\a>
1934
1935	=back
1936
1937	The option B<< {I<right-rtext>} >> will be right-justified. In the
1938	absence of a specified action, this text will be used as the I<action>
1939	as well.
1940
1941	=over 4
1942
1943	=item For example,
1944
1945	B</File/{Open}{^X^F}> is equivalent to B</File/{Open}{^X^F} ^X^F>
1946
1947	=back
1948
1949	The left label I<is> necessary, since it's used for matching, but
1950	implicitly hiding the left label (by using same name for both left and
1951	right labels), or explicitly hiding the left label (by preceeding it
1952	with a dot), makes it possible to have right-justified text only.
1953
1954	=over 4
1955
1956	=item For example,
1957
1958	B</File/{Open}{Open} Open-File-Action>
1959
1960	=item or hiding it
1961
1962	B</File/{.anylabel}{Open} Open-File-Action>
1963
1964	=back
1965
1966	X<menuBarRemove>
1967
1968	=head2 Removing menus
1969
1970	=over 4
1971
1972	=item B<< -/*+ >>
1973
1974	remove all menus from the menuBar, the same as B<[clear]>
1975
1976	=item B<< -+I</path>menu+ >>
1977
1978	remove menu
1979
1980	=item B<< -+I</path>{item}+ >>
1981
1982	remove item
1983
1984	=item B<< -+I</path>{-} >>
1985
1986	remove separator)
1987
1988	=item B<-/path/menu/*>
1989
1990	remove all items, separators and submenus from menu
1991
1992	=back
1993
1994	X<menuBarArrows>
1995
1996	=head2 Quick Arrows
1997
1998	The menus also provide a hook for I<quick arrows> to provide easier
1999	user access. If nothing has been explicitly set, the default is to
2000	emulate the curror keys. The syntax permits each arrow to be altered
2001	individually or all four at once without re-entering their common
2002	beginning/end text. For example, to explicitly associate cursor actions
2003	with 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
2015	Define actions for the respective arrow buttons
2016
2017	=item B<< <b>+I<Begin> >>
2018
2019	=item B<< <e>+I<End> >>
2020
2021	Define common beginning/end parts for I<quick arrows> which used in
2022	conjunction 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
2048	X<menuBarSummary>
2049
2050	=head2 Command Summary
2051
2052	A short summary of the most I<common> commands:
2053
2054	=over 4
2055
2056	=item [menu:name]
2057
2058	use an existing named menuBar or start a new one
2059
2060	=item [menu]
2061
2062	use the current menuBar
2063
2064	=item [title:string]
2065
2066	set menuBar title
2067
2068	=item [done]
2069
2070	set menu access to readonly and, if reading from a file, signal EOF
2071
2072	=item [done:name]
2073
2074	if reading from a file using [read:file;name] signal EOF
2075
2076	=item [rm:name]
2077
2078	remove named menuBar(s)
2079
2080	=item [rm] [rm:]
2081
2082	remove current menuBar
2083
2084	=item [rm] [rm:]
2085
2086	remove all menuBar(s)
2087
2088	=item [swap]
2089
2090	swap top two menuBars
2091
2092	=item [prev]
2093
2094	access the previous menuBar
2095
2096	=item [next]
2097
2098	access the next menuBar
2099
2100	=item [show]
2101
2102	map menuBar
2103
2104	=item [hide]
2105
2106	unmap menuBar
2107
2108	=item [pixmap;file]
2109
2110	=item [pixmap;file;scaling]
2111
2112	set a background pixmap
2113
2114	=item [read:file]
2115
2116	=item [read:file;name]
2117
2118	read in a menu from a file
2119
2120	=item [dump]
2121
2122	dump out all menuBars to /tmp/rxvt-PID
2123
2124	=item /
2125
2126	access menuBar top level
2127
2128	=item ./
2129
2130	=item ../
2131
2132	=item ../../
2133
2134	access current or parent menu level
2135
2136	=item /path/menu
2137
2138	add/access menu
2139
2140	=item /path/{-}
2141
2142	add separator
2143
2144	=item /path/{item}{rtext} action
2145
2146	add/alter menu item
2147
2148	=item -/*
2149
2150	remove all menus from the menuBar
2151
2152	=item -/path/menu
2153
2154	remove menu items, separators and submenus from menu
2155
2156	=item -/path/menu
2157
2158	remove menu
2159
2160	=item -/path/{item}
2161
2162	remove item
2163
2164	=item -/path/{-}
2165
2166	remove separator
2167
2168	=item <b>Begin<r>Right<l>Left<u>Up<d>Down<e>End
2169
2170	menu quick arrows
2171
2172	=back
2173	X<XPM>	1787	X<XPM>
2174		1788
2175	=head1 XPM	1789	=head1 XPM
2176		1790
2177	For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value	1791	For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value
…		…
2424	alternative input methods (e.g. kinput2) and will also correctly	2038	alternative input methods (e.g. kinput2) and will also correctly
2425	set up the input for people using dead keys or compose keys.	2039	set up the input for people using dead keys or compose keys.
2426		2040
2427	=item --enable-unicode3 (default: off)	2041	=item --enable-unicode3 (default: off)
2428		2042
		2043	Recommended to stay off unless you really need non-BMP characters.
		2044
2429	Enable direct support for displaying unicode codepoints above	2045	Enable direct support for displaying unicode codepoints above
2430	65535 (the basic multilingual page). This increases storage	2046	65535 (the basic multilingual page). This increases storage
2431	requirements per character from 2 to 4 bytes. X11 fonts do not yet	2047	requirements per character from 2 to 4 bytes. X11 fonts do not yet
2432	support these extra characters, but Xft does.	2048	support these extra characters, but Xft does.
2433		2049
…		…
2443	composite characters. This is required for proper viewing of text	2059	composite characters. This is required for proper viewing of text
2444	where accents are encoded as seperate unicode characters. This is	2060	where accents are encoded as seperate unicode characters. This is
2445	done by using precomposited characters when available or creating	2061	done by using precomposited characters when available or creating
2446	new pseudo-characters when no precomposed form exists.	2062	new pseudo-characters when no precomposed form exists.
2447		2063
2448	Without --enable-unicode3, the number of additional precomposed characters	2064	Without --enable-unicode3, the number of additional precomposed
2449	is rather limited (2048, if this is full, rxvt-unicode will use the	2065	characters is somewhat limited (the 6400 private use characters will be
2450	private use area, extending the number of combinations to 8448). With
2451	--enable-unicode3, no practical limit exists.	2066	(ab-)used). With --enable-unicode3, no practical limit exists.
2452		2067
2453	This option will also enable storage (but not display) of characters	2068	This option will also enable storage (but not display) of characters
2454	beyond plane 0 (>65535) when --enable-unicode3 was not specified.	2069	beyond plane 0 (>65535) when --enable-unicode3 was not specified.
2455		2070
2456	The combining table also contains entries for arabic presentation forms,	2071	The combining table also contains entries for arabic presentation forms,
2457	but these are not currently used. Bug me if you want these to be used (and	2072	but these are not currently used. Bug me if you want these to be used (and
2458	tell me how these are to be used...).	2073	tell me how these are to be used...).
2459		2074
2460	=item --enable-fallback(=CLASS) (default: Rxvt)	2075	=item --enable-fallback(=CLASS) (default: Rxvt)
2461		2076
2462	When reading resource settings, also read settings for class CLASS. To disable resource fallback use --disable-fallback.	2077	When reading resource settings, also read settings for class CLASS. To
		2078	disable resource fallback use --disable-fallback.
2463		2079
2464	=item --with-res-name=NAME (default: urxvt)	2080	=item --with-res-name=NAME (default: urxvt)
2465		2081
2466	Use the given name as default application name when	2082	Use the given name as default application name when
2467	reading resources. Specify --with-res-name=rxvt to replace rxvt.	2083	reading resources. Specify --with-res-name=rxvt to replace rxvt.
…		…
2504		2120
2505	=item --enable-tinting (default: on)	2121	=item --enable-tinting (default: on)
2506		2122
2507	Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).	2123	Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2508		2124
2509	=item --enable-menubar (default: off) [DEPRECATED]
2510
2511	Add support for our menu bar system (this interacts badly with dynamic
2512	locale switching currently). This option is DEPRECATED and will be removed
2513	in the future.
2514
2515	=item --enable-rxvt-scroll (default: on)	2125	=item --enable-rxvt-scroll (default: on)
2516		2126
2517	Add support for the original rxvt scrollbar.	2127	Add support for the original rxvt scrollbar.
2518		2128
2519	=item --enable-next-scroll (default: on)	2129	=item --enable-next-scroll (default: on)
…		…
2528		2138
2529	Add support for a very unobtrusive, plain-looking scrollbar that	2139	Add support for a very unobtrusive, plain-looking scrollbar that
2530	is the favourite of the rxvt-unicode author, having used it for	2140	is the favourite of the rxvt-unicode author, having used it for
2531	many years.	2141	many years.
2532		2142
2533	=item --enable-half-shadow (default: off)
2534
2535	Make shadows on the scrollbar only half the normal width & height.
2536	only applicable to rxvt scrollbars.
2537
2538	=item --enable-ttygid (default: off)	2143	=item --enable-ttygid (default: off)
2539		2144
2540	Change tty device setting to group "tty" - only use this if	2145	Change tty device setting to group "tty" - only use this if
2541	your system uses this type of security.	2146	your system uses this type of security.
2542		2147
…		…
2550	do it.	2155	do it.
2551		2156
2552	=item --disable-resources	2157	=item --disable-resources
2553		2158
2554	Removes any support for resource checking.	2159	Removes any support for resource checking.
2555
2556	=item --enable-strings (default: off)
2557
2558	Add support for our possibly faster memset() function and other
2559	various routines, overriding your system's versions which may
2560	have been hand-crafted in assembly or may require extra libraries
2561	to link in. (this breaks ANSI-C rules and has problems on many
2562	GNU/Linux systems).
2563		2160
2564	=item --disable-swapscreen	2161	=item --disable-swapscreen
2565		2162
2566	Remove support for secondary/swap screen.	2163	Remove support for secondary/swap screen.
2567		2164
…		…
2576		2173
2577	MWM-hints	2174	MWM-hints
2578	EWMH-hints (pid, utf8 names) and protocols (ping)	2175	EWMH-hints (pid, utf8 names) and protocols (ping)
2579	seperate underline colour (-underlineColor)	2176	seperate underline colour (-underlineColor)
2580	settable border widths and borderless switch (-w, -b, -bl)	2177	settable border widths and borderless switch (-w, -b, -bl)
		2178	visual depth selection (-depth)
2581	settable extra linespacing /-lsp)	2179	settable extra linespacing /-lsp)
2582	iso-14755-2 and -3, and visual feedback	2180	iso-14755-2 and -3, and visual feedback
2583	backindex and forwardindex escape sequence
2584	window op and some xterm/OSC escape sequences
2585	tripleclickwords (-tcw)	2181	tripleclickwords (-tcw)
2586	settable insecure mode (-insecure)	2182	settable insecure mode (-insecure)
2587	keysym remapping support	2183	keysym remapping support
2588	cursor blinking and underline cursor (-cb, -uc)	2184	cursor blinking and underline cursor (-cb, -uc)
2589	XEmbed support (-embed)	2185	XEmbed support (-embed)
2590	user-pty (-pty-fd)	2186	user-pty (-pty-fd)
2591	hold on exit (-hold)	2187	hold on exit (-hold)
2592	skip builtin block graphics (-sbg)	2188	skip builtin block graphics (-sbg)
		2189
		2190	It also enabled some non-essential features otherwise disabled, such as:
		2191
		2192	some round-trip time optimisations
		2193	nearest color allocation on pseudocolor screens
		2194	UTF8_STRING supporr for selection
2593	sgr modes 90..97 and 100..107	2195	sgr modes 90..97 and 100..107
		2196	backindex and forwardindex escape sequences
		2197	view change/zero scorllback esacpe sequences
		2198	locale switching escape sequence
		2199	window op and some xterm/OSC escape sequences
		2200	rectangular selections
		2201	trailing space removal for selections
		2202	verbose X error handling
2594		2203
2595	=item --enable-iso14755 (default: on)	2204	=item --enable-iso14755 (default: on)
2596		2205
2597	Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or	2206	Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
2598	F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by	2207	F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by
…		…
2641		2250
2642	=item --enable-pointer-blank (default: on)	2251	=item --enable-pointer-blank (default: on)
2643		2252
2644	Add support to have the pointer disappear when typing or inactive.	2253	Add support to have the pointer disappear when typing or inactive.
2645		2254
2646	=item --enable-perl (default: off)	2255	=item --enable-perl (default: on)
2647		2256
2648	Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>	2257	Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2649	manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files	2258	manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files
2650	in F<src/perl-ext/> for the extensions that are installed by default. The	2259	in F<src/perl-ext/> for the extensions that are installed by default. The
2651	perl interpreter that is used can be specified via the C<PERL> environment	2260	perl interpreter that is used can be specified via the C<PERL> environment

Diff Legend

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

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.98 by root, Tue Jan 31 00:56:07 2006 UTC

Diff Legend

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.98 by root, Tue Jan 31 00:56:07 2006 UTC