[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.96 by root, Tue Jan 31 00:25:16 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	26	=over 4
		27
		28	=item The new selection selects pieces that are too big, how can I select
		29	single words?
		30
		31	Yes. For example, if you want to select alphanumeric words, you can use
		32	the following resource:
		33
		34	URxvt.selection.pattern-0: ([[:word:]]+)
		35
		36	If you click more than twice, the selection will be extended
		37	more and more.
		38
		39	To get a selection that is very similar to the old code, try this pattern:
		40
		41	URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{\|})]+)
		42
		43	Please also note that the I<LeftClick Shift-LeftClik> combination also
		44	selects words like the old code.
28		45
29	=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
30	change/disable it?	47	change/disable it?
31		48
32	You can disable the perl extension completely by setting the	49	You can disable the perl extension completely by setting the
…		…
45	extensions. Some extensions can also be configured, for example,	62	extensions. Some extensions can also be configured, for example,
46	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
47	other combination either by setting the B<searchable-scrollback> resource:	64	other combination either by setting the B<searchable-scrollback> resource:
48		65
49	URxvt.searchable-scrollback: CM-s	66	URxvt.searchable-scrollback: CM-s
		67
		68	=item Why doesn't rxvt-unicode read my resources?
		69
		70	Well, why, indeed? It does, in a way very similar to other X
		71	applications. Most importantly, this means that if you or your OS loads
		72	resources into the X display (the right way to do it), rxvt-unicode will
		73	ignore any resource files in your home directory. It will only read
		74	F<$HOME/.Xdefaults> when no resources are attached to the display.
		75
		76	If you have or use an F<$HOME/.Xresources> file, chances are that
		77	resources are loaded into your X-server. In this case, you have to
		78	re-login after every change (or run F<xrdb -merge $HOME/.Xresources>).
		79
		80	Also consider the form resources have to use:
		81
		82	URxvt.resource: value
		83
		84	If you want to use another form (there are lots of different ways of
		85	specifying resources), make sure you understand wether and why it
		86	works. If unsure, use the form above.
		87
		88	=item I can't get transparency working, what am I doing wrong?
		89
		90	First of all, transparency isn't officially supported in rxvt-unicode, so
		91	you are mostly on your own. Do not bug the author about it (but you may
		92	bug everybody else). Also, if you can't get it working consider it a rite
		93	of passage: ... and you failed.
		94
		95	Here are four ways to get transparency. B<Do> read the manpage and option
		96	descriptions for the programs mentioned and rxvt-unicode. Really, do it!
		97
		98	1. Use inheritPixmap:
		99
		100	Esetroot wallpaper.jpg
		101	@@RXVT_NAME@@ -ip -tint red -sh 40
		102
		103	That works. If you think it doesn't, you lack transparency and tinting
		104	support, or you are unable to read.
		105
		106	2. Use a simple pixmap and emulate pseudo-transparency. This enables you
		107	to use effects other than tinting and shading: Just shade/tint/whatever
		108	your picture with gimp:
		109
		110	convert wallpaper.jpg -blur 20x20 -modulate 30 background.xpm
		111	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
		112
		113	That works. If you think it doesn't, you lack XPM and Perl support, or you
		114	are unable to read.
		115
		116	3. Use an ARGB visual:
		117
		118	@@RXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc
		119
		120	This requires XFT support, and the support of your X-server. If that
		121	doesn't work for you, blame Xorg and Keith Packard. ARGB visuals aren't
		122	there yet, no matter what they claim. Rxvt-Unicode contains the neccessary
		123	bugfixes and workarounds for Xft and Xlib to make it work, but that
		124	doesn't mean that your WM has the required kludges in place.
		125
		126	4. Use xcompmgr and let it do the job:
		127
		128	xprop -frame -f _NET_WM_WINDOW_OPACITY 32c \
		129	-set _NET_WM_WINDOW_OPACITY 0xc0000000
		130
		131	Then click on a window you want to make transparent. Replace C<0xc0000000>
		132	by other values to change the degree of opacity. If it doesn't work and
		133	your server crashes, you got to keep the pieces.
50		134
51	=item Isn't rxvt supposed to be small? Don't all those features bloat?	135	=item Isn't rxvt supposed to be small? Don't all those features bloat?
52		136
53	I often get asked about this, and I think, no, they didn't cause extra	137	I often get asked about this, and I think, no, they didn't cause extra
54	bloat. If you compare a minimal rxvt and a minimal urxvt, you can see	138	bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
…		…
124	No large bloated libraries (of course, none were linked in statically),	208	No large bloated libraries (of course, none were linked in statically),
125	except maybe libX11 :)	209	except maybe libX11 :)
126		210
127	=item Does it support tabs, can I have a tabbed rxvt-unicode?	211	=item Does it support tabs, can I have a tabbed rxvt-unicode?
128		212
129	rxvt-unicode does not directly support tabs. It will work fine with	213	Beginning with version 7.3, there is a perl extension that implements a
130	tabbing functionality of many window managers or similar tabbing programs,	214	simple tabbed terminal. It is installed by default, so any of these should
131	and its embedding-features allow it to be embedded into other programs,	215	give you tabs:
132	as witnessed by F<doc/rxvt-tabbed> or the upcoming C<Gtk2::URxvt> perl	216
133	module, which features a tabbed urxvt (murxvt) terminal as an example	217	@@RXVT_NAME@@ -pe tabbed
134	embedding application.	218
		219	URxvt.perl-ext-common: default,tabbed
		220
		221	It will also work fine with tabbing functionality of many window managers
		222	or similar tabbing programs, and its embedding-features allow it to be
		223	embedded into other programs, as witnessed by F<doc/rxvt-tabbed> or
		224	the upcoming C<Gtk2::URxvt> perl module, which features a tabbed urxvt
		225	(murxvt) terminal as an example embedding application.
135		226
136	=item How do I know which rxvt-unicode version I'm using?	227	=item How do I know which rxvt-unicode version I'm using?
137		228
138	The version number is displayed with the usage (-h). Also the escape	229	The version number is displayed with the usage (-h). Also the escape
139	sequence C<ESC [ 8 n> sets the window title to the version number. When	230	sequence C<ESC [ 8 n> sets the window title to the version number. When
…		…
141	daemon.	232	daemon.
142		233
143	=item I am using Debian GNU/Linux and have a problem...	234	=item I am using Debian GNU/Linux and have a problem...
144		235
145	The Debian GNU/Linux package of rxvt-unicode in sarge contains large	236	The Debian GNU/Linux package of rxvt-unicode in sarge contains large
146	patches that considerably change the behaviour of rxvt-unicode. Before	237	patches that considerably change the behaviour of rxvt-unicode (but
147	reporting a bug to the original rxvt-unicode author please download and	238	unfortunately this notice has been removed). Before reporting a bug to
148	install the genuine version (L<http://software.schmorp.de#rxvt-unicode>)	239	the original rxvt-unicode author please download and install the genuine
149	and try to reproduce the problem. If you cannot, chances are that the	240	version (L<http://software.schmorp.de#rxvt-unicode>) and try to reproduce
150	problems are specific to Debian GNU/Linux, in which case it should be	241	the problem. If you cannot, chances are that the problems are specific to
151	reported via the Debian Bug Tracking System (use C<reportbug> to report	242	Debian GNU/Linux, in which case it should be reported via the Debian Bug
152	the bug).	243	Tracking System (use C<reportbug> to report the bug).
153		244
154	For other problems that also affect the Debian package, you can and	245	For other problems that also affect the Debian package, you can and
155	probably should use the Debian BTS, too, because, after all, it's also a	246	probably should use the Debian BTS, too, because, after all, it's also a
156	bug in the Debian version and it serves as a reminder for other users that	247	bug in the Debian version and it serves as a reminder for other users that
157	might encounter the same issue.	248	might encounter the same issue.
158		249
159	=item I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?	250	=item I am maintaining rxvt-unicode for distribution/OS XXX, any
		251	recommendation?
160		252
161	You should build one binary with the default options. F<configure>	253	You should build one binary with the default options. F<configure>
162	now enables most useful options, and the trend goes to making them	254	now enables most useful options, and the trend goes to making them
163	runtime-switchable, too, so there is usually no drawback to enbaling them,	255	runtime-switchable, too, so there is usually no drawback to enbaling them,
164	except higher disk and possibly memory usage. The perl interpreter should	256	except higher disk and possibly memory usage. The perl interpreter should
…		…
176	C<--enable-everything> (less useful, it will be very big due to a lot of	268	C<--enable-everything> (less useful, it will be very big due to a lot of
177	encodings built-in that increase download times and are rarely used).	269	encodings built-in that increase download times and are rarely used).
178		270
179	=item I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?	271	=item I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?
180		272
181	Likely not. While I honestly try to make it secure, and am probably not	273	It should be, starting with release 7.1. You are encouraged to properly
182	bad at it, I think it is simply unreasonable to expect all of freetype	274	install urxvt with privileges necessary for your OS now.
183	+ fontconfig + xft + xlib + perl + ... + rxvt-unicode itself to all be
184	secure. Also, rxvt-unicode disables some options when it detects that it
185	runs setuid or setgid, which is not nice. Besides, with the embedded perl
186	interpreter the possibility for security problems easily multiplies.
187		275
188	Elevated privileges are only required for utmp and pty operations on some	276	When rxvt-unicode detects that it runs setuid or setgid, it will fork
189	systems (for example, GNU/Linux doesn't need any extra privileges for	277	into a helper process for privileged operations (pty handling on some
190	ptys, but some need it for utmp support). It is planned to mvoe this into	278	systems, utmp/wtmp/lastlog handling on others) and drop privileges
191	a forked handler process, but this is not yet done.	279	immediately. This is much safer than most other terminals that keep
		280	privileges while running (but is more relevant to urxvt, as it contains
		281	things as perl interpreters, which might be "helpful" to attackers).
192		282
193	So, while setuid/setgid operation is supported and not a problem on your	283	This forking is done as the very first within main(), which is very early
194	typical single-user-no-other-logins unix desktop, always remember that	284	and reduces possible bugs to initialisation code run before main(), or
195	its an awful lot of code, most of which isn't checked for security issues	285	things like the dynamic loader of your system, which should result in very
196	regularly.	286	little risk.
197		287
198	=item When I log-in to another system it tells me about missing terminfo data?	288	=item When I log-in to another system it tells me about missing terminfo data?
199		289
200	The terminal description used by rxvt-unicode is not as widely available	290	The terminal description used by rxvt-unicode is not as widely available
201	as that for xterm, or even rxvt (for which the same problem often arises).	291	as that for xterm, or even rxvt (for which the same problem often arises).
…		…
598	=item My input method wants <some encoding> but I want UTF-8, what can I do?	688	=item My input method wants <some encoding> but I want UTF-8, what can I do?
599		689
600	You can specify separate locales for the input method and the rest of the	690	You can specify separate locales for the input method and the rest of the
601	terminal, using the resource C<imlocale>:	691	terminal, using the resource C<imlocale>:
602		692
603	URxvt*imlocale: ja_JP.EUC-JP	693	URxvt.imlocale: ja_JP.EUC-JP
604		694
605	Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still	695	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	696	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	697	input characters outside C<EUC-JP> in a normal way then, as your input
608	method limits you.	698	method limits you.
…		…
654		744
655	Make sure that mouse reporting is actually turned off since killing	745	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	746	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	747	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	748	quick check is to see if cut/paste works when the Alt or Shift keys are
659	depressed. See @@RXVT_NAME@@(7)	749	depressed.
660		750
661	=item What's with this bold/blink stuff?	751	=item What's with this bold/blink stuff?
662		752
663	If no bold colour is set via C<colorBD:>, bold will invert text using the	753	If no bold colour is set via C<colorBD:>, bold will invert text using the
664	standard foreground colour.	754	standard foreground colour.
…		…
753		843
754	# use Backspace = ^?	844	# use Backspace = ^?
755	$ stty erase ^?	845	$ stty erase ^?
756	$ @@RXVT_NAME@@	846	$ @@RXVT_NAME@@
757		847
758	Toggle with C<ESC [ 36 h> / C<ESC [ 36 l> as documented in @@RXVT_NAME@@(7).	848	Toggle with C<ESC [ 36 h> / C<ESC [ 36 l>.
759		849
760	For an existing rxvt-unicode:	850	For an existing rxvt-unicode:
761		851
762	# use Backspace = ^H	852	# use Backspace = ^H
763	$ stty erase ^H	853	$ stty erase ^H
…		…
881		971
882	=head1 DESCRIPTION	972	=head1 DESCRIPTION
883		973
884	The rest of this document describes various technical aspects of	974	The rest of this document describes various technical aspects of
885	B<rxvt-unicode>. First the description of supported command sequences,	975	B<rxvt-unicode>. First the description of supported command sequences,
886	followed by menu and pixmap support and last by a description of all	976	followed by pixmap support and last by a description of all features
887	features selectable at C<configure> time.	977	selectable at C<configure> time.
888		978
889	=head1 Definitions	979	=head1 Definitions
890		980
891	=over 4	981	=over 4
892		982
…		…
1460	B<< C<h> >> Send Mouse X & Y on button press.	1550	B<< C<h> >> Send Mouse X & Y on button press.
1461	B<< C<l> >> No mouse reporting.	1551	B<< C<l> >> No mouse reporting.
1462		1552
1463	=end table	1553	=end table
1464		1554
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> >>	1555	=item B<< C<Ps = 25> >>
1475		1556
1476	=begin table	1557	=begin table
1477		1558
1478	B<< C<h> >> Visible cursor {cnorm/cvvis}	1559	B<< C<h> >> Visible cursor {cnorm/cvvis}
…		…
1660	B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>	1741	B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>
1661	B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>	1742	B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
1662	B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>	1743	B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>
1663	B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706]	1744	B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706]
1664	B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]	1745	B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
1665	B<< C<Ps = 20> >> Change default background to B<< C<Pt> >>	1746	B<< C<Ps = 20> >> Change background pixmap parameters (see section XPM) (Compile XPM).
1666	B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>.	1747	B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>.
1667	B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>	1748	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> >>.	1749	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> >>	1750	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> >>	1751	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).	1752	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).	1753	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>.
1673	B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>	1754	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).	1755	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> >>	1756	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> >>	1757	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>.	1758	B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
…		…
1684		1765
1685	=end table	1766	=end table
1686		1767
1687	=back	1768	=back
1688		1769
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>	1770	X<XPM>
2156		1771
2157	=head1 XPM	1772	=head1 XPM
2158		1773
2159	For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value	1774	For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value
…		…
2406	alternative input methods (e.g. kinput2) and will also correctly	2021	alternative input methods (e.g. kinput2) and will also correctly
2407	set up the input for people using dead keys or compose keys.	2022	set up the input for people using dead keys or compose keys.
2408		2023
2409	=item --enable-unicode3 (default: off)	2024	=item --enable-unicode3 (default: off)
2410		2025
		2026	Recommended to stay off unless you really need non-BMP characters.
		2027
2411	Enable direct support for displaying unicode codepoints above	2028	Enable direct support for displaying unicode codepoints above
2412	65535 (the basic multilingual page). This increases storage	2029	65535 (the basic multilingual page). This increases storage
2413	requirements per character from 2 to 4 bytes. X11 fonts do not yet	2030	requirements per character from 2 to 4 bytes. X11 fonts do not yet
2414	support these extra characters, but Xft does.	2031	support these extra characters, but Xft does.
2415		2032
…		…
2425	composite characters. This is required for proper viewing of text	2042	composite characters. This is required for proper viewing of text
2426	where accents are encoded as seperate unicode characters. This is	2043	where accents are encoded as seperate unicode characters. This is
2427	done by using precomposited characters when available or creating	2044	done by using precomposited characters when available or creating
2428	new pseudo-characters when no precomposed form exists.	2045	new pseudo-characters when no precomposed form exists.
2429		2046
2430	Without --enable-unicode3, the number of additional precomposed characters	2047	Without --enable-unicode3, the number of additional precomposed
2431	is rather limited (2048, if this is full, rxvt-unicode will use the	2048	characters is somewhat limited (the 6400 private use characters will be
2432	private use area, extending the number of combinations to 8448). With
2433	--enable-unicode3, no practical limit exists.	2049	(ab-)used). With --enable-unicode3, no practical limit exists.
2434		2050
2435	This option will also enable storage (but not display) of characters	2051	This option will also enable storage (but not display) of characters
2436	beyond plane 0 (>65535) when --enable-unicode3 was not specified.	2052	beyond plane 0 (>65535) when --enable-unicode3 was not specified.
2437		2053
2438	The combining table also contains entries for arabic presentation forms,	2054	The combining table also contains entries for arabic presentation forms,
2439	but these are not currently used. Bug me if you want these to be used (and	2055	but these are not currently used. Bug me if you want these to be used (and
2440	tell me how these are to be used...).	2056	tell me how these are to be used...).
2441		2057
2442	=item --enable-fallback(=CLASS) (default: Rxvt)	2058	=item --enable-fallback(=CLASS) (default: Rxvt)
2443		2059
2444	When reading resource settings, also read settings for class CLASS. To disable resource fallback use --disable-fallback.	2060	When reading resource settings, also read settings for class CLASS. To
		2061	disable resource fallback use --disable-fallback.
2445		2062
2446	=item --with-res-name=NAME (default: urxvt)	2063	=item --with-res-name=NAME (default: urxvt)
2447		2064
2448	Use the given name as default application name when	2065	Use the given name as default application name when
2449	reading resources. Specify --with-res-name=rxvt to replace rxvt.	2066	reading resources. Specify --with-res-name=rxvt to replace rxvt.
…		…
2486		2103
2487	=item --enable-tinting (default: on)	2104	=item --enable-tinting (default: on)
2488		2105
2489	Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).	2106	Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2490		2107
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)	2108	=item --enable-rxvt-scroll (default: on)
2498		2109
2499	Add support for the original rxvt scrollbar.	2110	Add support for the original rxvt scrollbar.
2500		2111
2501	=item --enable-next-scroll (default: on)	2112	=item --enable-next-scroll (default: on)
…		…
2510		2121
2511	Add support for a very unobtrusive, plain-looking scrollbar that	2122	Add support for a very unobtrusive, plain-looking scrollbar that
2512	is the favourite of the rxvt-unicode author, having used it for	2123	is the favourite of the rxvt-unicode author, having used it for
2513	many years.	2124	many years.
2514		2125
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)	2126	=item --enable-ttygid (default: off)
2521		2127
2522	Change tty device setting to group "tty" - only use this if	2128	Change tty device setting to group "tty" - only use this if
2523	your system uses this type of security.	2129	your system uses this type of security.
2524		2130
…		…
2532	do it.	2138	do it.
2533		2139
2534	=item --disable-resources	2140	=item --disable-resources
2535		2141
2536	Removes any support for resource checking.	2142	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		2143
2546	=item --disable-swapscreen	2144	=item --disable-swapscreen
2547		2145
2548	Remove support for secondary/swap screen.	2146	Remove support for secondary/swap screen.
2549		2147
…		…
2558		2156
2559	MWM-hints	2157	MWM-hints
2560	EWMH-hints (pid, utf8 names) and protocols (ping)	2158	EWMH-hints (pid, utf8 names) and protocols (ping)
2561	seperate underline colour (-underlineColor)	2159	seperate underline colour (-underlineColor)
2562	settable border widths and borderless switch (-w, -b, -bl)	2160	settable border widths and borderless switch (-w, -b, -bl)
		2161	visual depth selection (-depth)
2563	settable extra linespacing /-lsp)	2162	settable extra linespacing /-lsp)
2564	iso-14755-2 and -3, and visual feedback	2163	iso-14755-2 and -3, and visual feedback
2565	backindex and forwardindex escape sequence
2566	window op and some xterm/OSC escape sequences
2567	tripleclickwords (-tcw)	2164	tripleclickwords (-tcw)
2568	settable insecure mode (-insecure)	2165	settable insecure mode (-insecure)
2569	keysym remapping support	2166	keysym remapping support
2570	cursor blinking and underline cursor (-cb, -uc)	2167	cursor blinking and underline cursor (-cb, -uc)
2571	XEmbed support (-embed)	2168	XEmbed support (-embed)
2572	user-pty (-pty-fd)	2169	user-pty (-pty-fd)
2573	hold on exit (-hold)	2170	hold on exit (-hold)
2574	skip builtin block graphics (-sbg)	2171	skip builtin block graphics (-sbg)
		2172
		2173	It also enabled some non-essential features otherwise disabled, such as:
		2174
		2175	some round-trip time optimisations
		2176	nearest color allocation on pseudocolor screens
		2177	UTF8_STRING supporr for selection
2575	sgr modes 90..97 and 100..107	2178	sgr modes 90..97 and 100..107
		2179	backindex and forwardindex escape sequences
		2180	view change/zero scorllback esacpe sequences
		2181	locale switching escape sequence
		2182	window op and some xterm/OSC escape sequences
		2183	rectangular selections
		2184	trailing space removal for selections
		2185	verbose X error handling
2576		2186
2577	=item --enable-iso14755 (default: on)	2187	=item --enable-iso14755 (default: on)
2578		2188
2579	Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or	2189	Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
2580	F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by	2190	F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by
…		…
2623		2233
2624	=item --enable-pointer-blank (default: on)	2234	=item --enable-pointer-blank (default: on)
2625		2235
2626	Add support to have the pointer disappear when typing or inactive.	2236	Add support to have the pointer disappear when typing or inactive.
2627		2237
2628	=item --enable-perl (default: off)	2238	=item --enable-perl (default: on)
2629		2239
2630	Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>	2240	Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2631	manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files	2241	manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files
2632	in F<src/perl-ext/> for the extensions that are installed by default. The	2242	in F<src/perl-ext/> for the extensions that are installed by default. The
2633	perl interpreter that is used can be specified via the C<PERL> environment	2243	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.78 by root, Thu Jan 12 05:37:34 2006 UTC vs. Revision 1.96 by root, Tue Jan 31 00:25:16 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.96 by root, Tue Jan 31 00:25:16 2006 UTC