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

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents):
Revision 1.76 by root, Wed Jan 11 19:55: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.
		45
		46	=item I don't like the new selection/popups/hotkeys/perl, how do I
		47	change/disable it?
		48
		49	You can disable the perl extension completely by setting the
		50	B<perl-ext-common> resource to the empty string, which also keeps
		51	rxvt-unicode from initialising perl, saving memory.
		52
		53	If you only want to disable specific features, you first have to
		54	identify which perl extension is responsible. For this, read the section
		55	B<PREPACKAGED EXTENSIONS> in the @@RXVT_NAME@@perl(3) manpage. For
		56	example, to disable the B<selection-popup> and B<option-popup>, specify
		57	this B<perl-ext-common> resource:
		58
		59	URxvt.perl-ext-common: default,-selection-popup,-option-popup
		60
		61	This will keep the default extensions, but disable the two popup
		62	extensions. Some extensions can also be configured, for example,
		63	scrollback search mode is triggered by B<M-s>. You can move it to any
		64	other combination either by setting the B<searchable-scrollback> resource:
		65
		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.
28		134
29	=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?
30		136
31	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
32	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
…		…
102	No large bloated libraries (of course, none were linked in statically),	208	No large bloated libraries (of course, none were linked in statically),
103	except maybe libX11 :)	209	except maybe libX11 :)
104		210
105	=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?
106		212
107	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
108	tabbing functionality of many window managers or similar tabbing programs,	214	simple tabbed terminal. It is installed by default, so any of these should
109	and its embedding-features allow it to be embedded into other programs,	215	give you tabs:
110	as witnessed by F<doc/rxvt-tabbed> or the upcoming C<Gtk2::URxvt> perl	216
111	module, which features a tabbed urxvt (murxvt) terminal as an example	217	@@RXVT_NAME@@ -pe tabbed
112	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.
113		226
114	=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?
115		228
116	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
117	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
…		…
119	daemon.	232	daemon.
120		233
121	=item I am using Debian GNU/Linux and have a problem...	234	=item I am using Debian GNU/Linux and have a problem...
122		235
123	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
124	patches that considerably change the behaviour of rxvt-unicode. Before	237	patches that considerably change the behaviour of rxvt-unicode (but
125	reporting a bug to the original rxvt-unicode author please download and	238	unfortunately this notice has been removed). Before reporting a bug to
126	install the genuine version (L<http://software.schmorp.de#rxvt-unicode>)	239	the original rxvt-unicode author please download and install the genuine
127	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
128	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
129	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
130	the bug).	243	Tracking System (use C<reportbug> to report the bug).
131		244
132	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
133	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
134	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
135	might encounter the same issue.	248	might encounter the same issue.
136		249
137	=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?
138		252
139	You should build one binary with the default options. F<configure>	253	You should build one binary with the default options. F<configure>
140	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
141	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,
142	except higher disk and possibly memory usage. The perl interpreter should	256	except higher disk and possibly memory usage. The perl interpreter should
…		…
154	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
155	encodings built-in that increase download times and are rarely used).	269	encodings built-in that increase download times and are rarely used).
156		270
157	=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?
158		272
159	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
160	bad at it, I think it is simply unreasonable to expect all of freetype	274	install urxvt with privileges necessary for your OS now.
161	+ fontconfig + xft + xlib + perl + ... + rxvt-unicode itself to all be
162	secure. Also, rxvt-unicode disables some options when it detects that it
163	runs setuid or setgid, which is not nice. Besides, with the embedded perl
164	interpreter the possibility for security problems easily multiplies.
165		275
166	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
167	systems (for example, GNU/Linux doesn't need any extra privileges for	277	into a helper process for privileged operations (pty handling on some
168	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
169	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).
170		282
171	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
172	typical single-user-no-other-logins unix desktop, always remember that	284	and reduces possible bugs to initialisation code run before main(), or
173	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
174	regularly.	286	little risk.
175		287
176	=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?
177		289
178	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
179	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).
…		…
576	=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?
577		689
578	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
579	terminal, using the resource C<imlocale>:	691	terminal, using the resource C<imlocale>:
580		692
581	URxvt*imlocale: ja_JP.EUC-JP	693	URxvt.imlocale: ja_JP.EUC-JP
582		694
583	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
584	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
585	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
586	method limits you.	698	method limits you.
…		…
632		744
633	Make sure that mouse reporting is actually turned off since killing	745	Make sure that mouse reporting is actually turned off since killing
634	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
635	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
636	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
637	depressed. See @@RXVT_NAME@@(7)	749	depressed.
638		750
639	=item What's with this bold/blink stuff?	751	=item What's with this bold/blink stuff?
640		752
641	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
642	standard foreground colour.	754	standard foreground colour.
…		…
731		843
732	# use Backspace = ^?	844	# use Backspace = ^?
733	$ stty erase ^?	845	$ stty erase ^?
734	$ @@RXVT_NAME@@	846	$ @@RXVT_NAME@@
735		847
736	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>.
737		849
738	For an existing rxvt-unicode:	850	For an existing rxvt-unicode:
739		851
740	# use Backspace = ^H	852	# use Backspace = ^H
741	$ stty erase ^H	853	$ stty erase ^H
…		…
859		971
860	=head1 DESCRIPTION	972	=head1 DESCRIPTION
861		973
862	The rest of this document describes various technical aspects of	974	The rest of this document describes various technical aspects of
863	B<rxvt-unicode>. First the description of supported command sequences,	975	B<rxvt-unicode>. First the description of supported command sequences,
864	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
865	features selectable at C<configure> time.	977	selectable at C<configure> time.
866		978
867	=head1 Definitions	979	=head1 Definitions
868		980
869	=over 4	981	=over 4
870		982
…		…
1438	B<< C<h> >> Send Mouse X & Y on button press.	1550	B<< C<h> >> Send Mouse X & Y on button press.
1439	B<< C<l> >> No mouse reporting.	1551	B<< C<l> >> No mouse reporting.
1440		1552
1441	=end table	1553	=end table
1442		1554
1443	=item B<< C<Ps = 10> >> (B<rxvt>)
1444
1445	=begin table
1446
1447	B<< C<h> >> menuBar visible
1448	B<< C<l> >> menuBar invisible
1449
1450	=end table
1451
1452	=item B<< C<Ps = 25> >>	1555	=item B<< C<Ps = 25> >>
1453		1556
1454	=begin table	1557	=begin table
1455		1558
1456	B<< C<h> >> Visible cursor {cnorm/cvvis}	1559	B<< C<h> >> Visible cursor {cnorm/cvvis}
…		…
1638	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> >>
1639	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> >>
1640	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> >>
1641	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]
1642	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]
1643	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).
1644	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> >>.
1645	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>
1646	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> >>.
1647	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> >>
1648	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> >>
1649	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).
1650	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>.
1651	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> >>
1652	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).
1653	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> >>
1654	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> >>
1655	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>.
…		…
1662		1765
1663	=end table	1766	=end table
1664		1767
1665	=back	1768	=back
1666		1769
1667	X<menuBar>
1668
1669	=head1 menuBar
1670
1671	B<< The exact syntax used is I<almost> solidified. >>
1672	In the menus, B<DON'T> try to use menuBar commands that add or remove a
1673	menuBar.
1674
1675	Note that in all of the commands, the B<< I</path/> >> I<cannot> be
1676	omitted: use B<./> to specify a menu relative to the current menu.
1677
1678	=head2 Overview of menuBar operation
1679
1680	For the menuBar XTerm escape sequence C<ESC ] 703 ; Pt ST>, the syntax
1681	of C<Pt> can be used for a variety of tasks:
1682
1683	At the top level is the current menuBar which is a member of a circular
1684	linked-list of other such menuBars.
1685
1686	The menuBar acts as a parent for the various drop-down menus, which in
1687	turn, may have labels, separator lines, menuItems and subMenus.
1688
1689	The menuItems are the useful bits: you can use them to mimic keyboard
1690	input or even to send text or escape sequences back to rxvt.
1691
1692	The menuBar syntax is intended to provide a simple yet robust method of
1693	constructing and manipulating menus and navigating through the
1694	menuBars.
1695
1696	The first step is to use the tag B<< [menu:I<name>] >> which creates
1697	the menuBar called I<name> and allows access. You may now or menus,
1698	subMenus, and menuItems. Finally, use the tag B<[done]> to set the
1699	menuBar access as B<readonly> to prevent accidental corruption of the
1700	menus. To re-access the current menuBar for alterations, use the tag
1701	B<[menu]>, make the alterations and then use B<[done]>
1702
1703	X<menuBarCommands>
1704
1705	=head2 Commands
1706
1707	=over 4
1708
1709	=item B<< [menu:+I<name>] >>
1710
1711	access the named menuBar for creation or alteration. If a new menuBar
1712	is created, it is called I<name> (max of 15 chars) and the current
1713	menuBar is pushed onto the stack
1714
1715	=item B<[menu]>
1716
1717	access the current menuBar for alteration
1718
1719	=item B<< [title:+I<string>] >>
1720
1721	set the current menuBar's title to I<string>, which may contain the
1722	following format specifiers:
1723
1724	B<%n> rxvt name (as per the B<-name> command-line option)
1725	B<%v> rxvt version
1726	B<%%> literal B<%> character
1727
1728	=item B<[done]>
1729
1730	set menuBar access as B<readonly>.
1731	End-of-file tag for B<< [read:+I<file>] >> operations.
1732
1733	=item B<< [read:+I<file>] >>
1734
1735	read menu commands directly from I<file> (extension ".menu" will be
1736	appended if required.) Start reading at a line with B<[menu]> or B<<
1737	[menu:+I<name> >> and continuing until B<[done]> is encountered.
1738
1739	Blank and comment lines (starting with B<#>) are ignored. Actually,
1740	since any invalid menu commands are also ignored, almost anything could
1741	be construed as a comment line, but this may be tightened up in the
1742	future ... so don't count on it!.
1743
1744	=item B<< [read:+I<file>;+I<name>] >>
1745
1746	The same as B<< [read:+I<file>] >>, but start reading at a line with
1747	B<< [menu:+I<name>] >> and continuing until B<< [done:+I<name>] >> or
1748	B<[done]> is encountered.
1749
1750	=item B<[dump]>
1751
1752	dump all menuBars to the file B</tmp/rxvt-PID> in a format suitable for
1753	later rereading.
1754
1755	=item B<[rm:name]>
1756
1757	remove the named menuBar
1758
1759	=item B<[rm] [rm:]>
1760
1761	remove the current menuBar
1762
1763	=item B<[rm] [rm:]>
1764
1765	remove all menuBars
1766
1767	=item B<[swap]>
1768
1769	swap the top two menuBars
1770
1771	=item B<[prev]>
1772
1773	access the previous menuBar
1774
1775	=item B<[next]>
1776
1777	access the next menuBar
1778
1779	=item B<[show]>
1780
1781	Enable display of the menuBar
1782
1783	=item B<[hide]>
1784
1785	Disable display of the menuBar
1786
1787	=item B<< [pixmap:+I<name>] >>
1788
1789	=item B<< [pixmap:+I<name>;I<scaling>] >>
1790
1791	(set the background pixmap globally
1792
1793	B<< A Future implementation I<may> make this local to the menubar >>)
1794
1795	=item B<< [:+I<command>:] >>
1796
1797	ignore the menu readonly status and issue a I<command> to or a menu or
1798	menuitem or change the ; a useful shortcut for setting the quick arrows
1799	from a menuBar.
1800
1801	=back
1802
1803	X<menuBarAdd>
1804
1805	=head2 Adding and accessing menus
1806
1807	The following commands may also be B<+> prefixed.
1808
1809	=over 4
1810
1811	=item B</+>
1812
1813	access menuBar top level
1814
1815	=item B<./+>
1816
1817	access current menu level
1818
1819	=item B<../+>
1820
1821	access parent menu (1 level up)
1822
1823	=item B<../../>
1824
1825	access parent menu (multiple levels up)
1826
1827	=item B<< I</path/>menu >>
1828
1829	add/access menu
1830
1831	=item B<< I</path/>menu/* >>
1832
1833	add/access menu and clear it if it exists
1834
1835	=item B<< I</path/>{-} >>
1836
1837	add separator
1838
1839	=item B<< I</path/>{item} >>
1840
1841	add B<item> as a label
1842
1843	=item B<< I</path/>{item} action >>
1844
1845	add/alter I<menuitem> with an associated I<action>
1846
1847	=item B<< I</path/>{item}{right-text} >>
1848
1849	add/alter I<menuitem> with B<right-text> as the right-justified text
1850	and as the associated I<action>
1851
1852	=item B<< I</path/>{item}{rtext} action >>
1853
1854	add/alter I<menuitem> with an associated I<action> and with B<rtext> as
1855	the right-justified text.
1856
1857	=back
1858
1859	=over 4
1860
1861	=item Special characters in I<action> must be backslash-escaped:
1862
1863	B<\a \b \E \e \n \r \t \octal>
1864
1865	=item or in control-character notation:
1866
1867	B<^@, ^A .. ^Z .. ^_, ^?>
1868
1869	=back
1870
1871	To send a string starting with a B<NUL> (B<^@>) character to the
1872	program, start I<action> with a pair of B<NUL> characters (B<^@^@>),
1873	the first of which will be stripped off and the balance directed to the
1874	program. Otherwise if I<action> begins with B<NUL> followed by
1875	non-+B<NUL> characters, the leading B<NUL> is stripped off and the
1876	balance is sent back to rxvt.
1877
1878	As a convenience for the many Emacs-type editors, I<action> may start
1879	with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be
1880	appended if missed from B<M-x> commands.
1881
1882	As a convenience for issuing XTerm B<ESC ]> sequences from a menubar (or
1883	quick arrow), a B<BEL> (B<^G>) will be appended if needed.
1884
1885	=over 4
1886
1887	=item For example,
1888
1889	B<M-xapropos> is equivalent to B<\Exapropos\r>
1890
1891	=item and
1892
1893	B<\E]703;mona;100> is equivalent to B<\E]703;mona;100\a>
1894
1895	=back
1896
1897	The option B<< {I<right-rtext>} >> will be right-justified. In the
1898	absence of a specified action, this text will be used as the I<action>
1899	as well.
1900
1901	=over 4
1902
1903	=item For example,
1904
1905	B</File/{Open}{^X^F}> is equivalent to B</File/{Open}{^X^F} ^X^F>
1906
1907	=back
1908
1909	The left label I<is> necessary, since it's used for matching, but
1910	implicitly hiding the left label (by using same name for both left and
1911	right labels), or explicitly hiding the left label (by preceeding it
1912	with a dot), makes it possible to have right-justified text only.
1913
1914	=over 4
1915
1916	=item For example,
1917
1918	B</File/{Open}{Open} Open-File-Action>
1919
1920	=item or hiding it
1921
1922	B</File/{.anylabel}{Open} Open-File-Action>
1923
1924	=back
1925
1926	X<menuBarRemove>
1927
1928	=head2 Removing menus
1929
1930	=over 4
1931
1932	=item B<< -/*+ >>
1933
1934	remove all menus from the menuBar, the same as B<[clear]>
1935
1936	=item B<< -+I</path>menu+ >>
1937
1938	remove menu
1939
1940	=item B<< -+I</path>{item}+ >>
1941
1942	remove item
1943
1944	=item B<< -+I</path>{-} >>
1945
1946	remove separator)
1947
1948	=item B<-/path/menu/*>
1949
1950	remove all items, separators and submenus from menu
1951
1952	=back
1953
1954	X<menuBarArrows>
1955
1956	=head2 Quick Arrows
1957
1958	The menus also provide a hook for I<quick arrows> to provide easier
1959	user access. If nothing has been explicitly set, the default is to
1960	emulate the curror keys. The syntax permits each arrow to be altered
1961	individually or all four at once without re-entering their common
1962	beginning/end text. For example, to explicitly associate cursor actions
1963	with the arrows, any of the following forms could be used:
1964
1965	=over 4
1966
1967	=item B<< <r>+I<Right> >>
1968
1969	=item B<< <l>+I<Left> >>
1970
1971	=item B<< <u>+I<Up> >>
1972
1973	=item B<< <d>+I<Down> >>
1974
1975	Define actions for the respective arrow buttons
1976
1977	=item B<< <b>+I<Begin> >>
1978
1979	=item B<< <e>+I<End> >>
1980
1981	Define common beginning/end parts for I<quick arrows> which used in
1982	conjunction with the above <r> <l> <u> <d> constructs
1983
1984	=back
1985
1986	=over 4
1987
1988	=item For example, define arrows individually,
1989
1990	<u>\E[A
1991
1992	<d>\E[B
1993
1994	<r>\E[C
1995
1996	<l>\E[D
1997
1998	=item or all at once
1999
2000	<u>\E[AZ<><d>\E[BZ<><r>\E[CZ<><l>\E[D
2001
2002	=item or more compactly (factoring out common parts)
2003
2004	<b>\E[<u>AZ<><d>BZ<><r>CZ<><l>D
2005
2006	=back
2007
2008	X<menuBarSummary>
2009
2010	=head2 Command Summary
2011
2012	A short summary of the most I<common> commands:
2013
2014	=over 4
2015
2016	=item [menu:name]
2017
2018	use an existing named menuBar or start a new one
2019
2020	=item [menu]
2021
2022	use the current menuBar
2023
2024	=item [title:string]
2025
2026	set menuBar title
2027
2028	=item [done]
2029
2030	set menu access to readonly and, if reading from a file, signal EOF
2031
2032	=item [done:name]
2033
2034	if reading from a file using [read:file;name] signal EOF
2035
2036	=item [rm:name]
2037
2038	remove named menuBar(s)
2039
2040	=item [rm] [rm:]
2041
2042	remove current menuBar
2043
2044	=item [rm] [rm:]
2045
2046	remove all menuBar(s)
2047
2048	=item [swap]
2049
2050	swap top two menuBars
2051
2052	=item [prev]
2053
2054	access the previous menuBar
2055
2056	=item [next]
2057
2058	access the next menuBar
2059
2060	=item [show]
2061
2062	map menuBar
2063
2064	=item [hide]
2065
2066	unmap menuBar
2067
2068	=item [pixmap;file]
2069
2070	=item [pixmap;file;scaling]
2071
2072	set a background pixmap
2073
2074	=item [read:file]
2075
2076	=item [read:file;name]
2077
2078	read in a menu from a file
2079
2080	=item [dump]
2081
2082	dump out all menuBars to /tmp/rxvt-PID
2083
2084	=item /
2085
2086	access menuBar top level
2087
2088	=item ./
2089
2090	=item ../
2091
2092	=item ../../
2093
2094	access current or parent menu level
2095
2096	=item /path/menu
2097
2098	add/access menu
2099
2100	=item /path/{-}
2101
2102	add separator
2103
2104	=item /path/{item}{rtext} action
2105
2106	add/alter menu item
2107
2108	=item -/*
2109
2110	remove all menus from the menuBar
2111
2112	=item -/path/menu
2113
2114	remove menu items, separators and submenus from menu
2115
2116	=item -/path/menu
2117
2118	remove menu
2119
2120	=item -/path/{item}
2121
2122	remove item
2123
2124	=item -/path/{-}
2125
2126	remove separator
2127
2128	=item <b>Begin<r>Right<l>Left<u>Up<d>Down<e>End
2129
2130	menu quick arrows
2131
2132	=back
2133	X<XPM>	1770	X<XPM>
2134		1771
2135	=head1 XPM	1772	=head1 XPM
2136		1773
2137	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
…		…
2384	alternative input methods (e.g. kinput2) and will also correctly	2021	alternative input methods (e.g. kinput2) and will also correctly
2385	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.
2386		2023
2387	=item --enable-unicode3 (default: off)	2024	=item --enable-unicode3 (default: off)
2388		2025
		2026	Recommended to stay off unless you really need non-BMP characters.
		2027
2389	Enable direct support for displaying unicode codepoints above	2028	Enable direct support for displaying unicode codepoints above
2390	65535 (the basic multilingual page). This increases storage	2029	65535 (the basic multilingual page). This increases storage
2391	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
2392	support these extra characters, but Xft does.	2031	support these extra characters, but Xft does.
2393		2032
…		…
2403	composite characters. This is required for proper viewing of text	2042	composite characters. This is required for proper viewing of text
2404	where accents are encoded as seperate unicode characters. This is	2043	where accents are encoded as seperate unicode characters. This is
2405	done by using precomposited characters when available or creating	2044	done by using precomposited characters when available or creating
2406	new pseudo-characters when no precomposed form exists.	2045	new pseudo-characters when no precomposed form exists.
2407		2046
2408	Without --enable-unicode3, the number of additional precomposed characters	2047	Without --enable-unicode3, the number of additional precomposed
2409	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
2410	private use area, extending the number of combinations to 8448). With
2411	--enable-unicode3, no practical limit exists.	2049	(ab-)used). With --enable-unicode3, no practical limit exists.
2412		2050
2413	This option will also enable storage (but not display) of characters	2051	This option will also enable storage (but not display) of characters
2414	beyond plane 0 (>65535) when --enable-unicode3 was not specified.	2052	beyond plane 0 (>65535) when --enable-unicode3 was not specified.
2415		2053
2416	The combining table also contains entries for arabic presentation forms,	2054	The combining table also contains entries for arabic presentation forms,
2417	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
2418	tell me how these are to be used...).	2056	tell me how these are to be used...).
2419		2057
2420	=item --enable-fallback(=CLASS) (default: Rxvt)	2058	=item --enable-fallback(=CLASS) (default: Rxvt)
2421		2059
2422	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.
2423		2062
2424	=item --with-res-name=NAME (default: urxvt)	2063	=item --with-res-name=NAME (default: urxvt)
2425		2064
2426	Use the given name as default application name when	2065	Use the given name as default application name when
2427	reading resources. Specify --with-res-name=rxvt to replace rxvt.	2066	reading resources. Specify --with-res-name=rxvt to replace rxvt.
…		…
2464		2103
2465	=item --enable-tinting (default: on)	2104	=item --enable-tinting (default: on)
2466		2105
2467	Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).	2106	Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2468		2107
2469	=item --enable-menubar (default: off) [DEPRECATED]
2470
2471	Add support for our menu bar system (this interacts badly with dynamic
2472	locale switching currently). This option is DEPRECATED and will be removed
2473	in the future.
2474
2475	=item --enable-rxvt-scroll (default: on)	2108	=item --enable-rxvt-scroll (default: on)
2476		2109
2477	Add support for the original rxvt scrollbar.	2110	Add support for the original rxvt scrollbar.
2478		2111
2479	=item --enable-next-scroll (default: on)	2112	=item --enable-next-scroll (default: on)
…		…
2488		2121
2489	Add support for a very unobtrusive, plain-looking scrollbar that	2122	Add support for a very unobtrusive, plain-looking scrollbar that
2490	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
2491	many years.	2124	many years.
2492		2125
2493	=item --enable-half-shadow (default: off)
2494
2495	Make shadows on the scrollbar only half the normal width & height.
2496	only applicable to rxvt scrollbars.
2497
2498	=item --enable-ttygid (default: off)	2126	=item --enable-ttygid (default: off)
2499		2127
2500	Change tty device setting to group "tty" - only use this if	2128	Change tty device setting to group "tty" - only use this if
2501	your system uses this type of security.	2129	your system uses this type of security.
2502		2130
…		…
2510	do it.	2138	do it.
2511		2139
2512	=item --disable-resources	2140	=item --disable-resources
2513		2141
2514	Removes any support for resource checking.	2142	Removes any support for resource checking.
2515
2516	=item --enable-xgetdefault
2517
2518	Make resources checking via XGetDefault() instead of our small
2519	version which only checks ~/.Xdefaults, or if that doesn't exist then
2520	~/.Xresources.
2521
2522	Please note that nowadays, things like XIM will automatically pull in and
2523	use the full X resource manager, so the overhead of using it might be very
2524	small, if nonexistant.
2525
2526	=item --enable-strings (default: off)
2527
2528	Add support for our possibly faster memset() function and other
2529	various routines, overriding your system's versions which may
2530	have been hand-crafted in assembly or may require extra libraries
2531	to link in. (this breaks ANSI-C rules and has problems on many
2532	GNU/Linux systems).
2533		2143
2534	=item --disable-swapscreen	2144	=item --disable-swapscreen
2535		2145
2536	Remove support for secondary/swap screen.	2146	Remove support for secondary/swap screen.
2537		2147
…		…
2546		2156
2547	MWM-hints	2157	MWM-hints
2548	EWMH-hints (pid, utf8 names) and protocols (ping)	2158	EWMH-hints (pid, utf8 names) and protocols (ping)
2549	seperate underline colour (-underlineColor)	2159	seperate underline colour (-underlineColor)
2550	settable border widths and borderless switch (-w, -b, -bl)	2160	settable border widths and borderless switch (-w, -b, -bl)
		2161	visual depth selection (-depth)
2551	settable extra linespacing /-lsp)	2162	settable extra linespacing /-lsp)
2552	iso-14755-2 and -3, and visual feedback	2163	iso-14755-2 and -3, and visual feedback
2553	backindex and forwardindex escape sequence
2554	window op and some xterm/OSC escape sequences
2555	tripleclickwords (-tcw)	2164	tripleclickwords (-tcw)
2556	settable insecure mode (-insecure)	2165	settable insecure mode (-insecure)
2557	keysym remapping support	2166	keysym remapping support
2558	cursor blinking and underline cursor (-cb, -uc)	2167	cursor blinking and underline cursor (-cb, -uc)
2559	XEmbed support (-embed)	2168	XEmbed support (-embed)
2560	user-pty (-pty-fd)	2169	user-pty (-pty-fd)
2561	hold on exit (-hold)	2170	hold on exit (-hold)
2562	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
2563	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
2564		2186
2565	=item --enable-iso14755 (default: on)	2187	=item --enable-iso14755 (default: on)
2566		2188
2567	Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or	2189	Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
2568	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
…		…
2611		2233
2612	=item --enable-pointer-blank (default: on)	2234	=item --enable-pointer-blank (default: on)
2613		2235
2614	Add support to have the pointer disappear when typing or inactive.	2236	Add support to have the pointer disappear when typing or inactive.
2615		2237
2616	=item --enable-perl (default: off)	2238	=item --enable-perl (default: on)
2617		2239
2618	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)>
2619	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
2620	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
2621	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.76 by root, Wed Jan 11 19:55: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.76 by root, Wed Jan 11 19:55:34 2006 UTC vs.
Revision 1.96 by root, Tue Jan 31 00:25:16 2006 UTC