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

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents):
Revision 1.64 by root, Sat Dec 24 12:55:17 2005 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
		26	=head2 The new selection selects pieces that are too big, how can I select
		27	single words?
		28
		29	Yes. For example, if you want to select alphanumeric words, you can use
		30	the following resource:
		31
		32	URxvt.selection.pattern-0: ([[:word:]]+)
		33
		34	If you click more than twice, the selection will be extended
		35	more and more.
		36
		37	To get a selection that is very similar to the old code, try this pattern:
		38
		39	URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{\|})]+)
		40
		41	Please also note that the I<LeftClick Shift-LeftClik> combination also
		42	selects words like the old code.
		43
27	=over 4	44	=over 4
		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 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.
28		151
29	=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?
30		153
31	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
32	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
…		…
62	memory.	185	memory.
63		186
64	Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this	187	Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this
65	still fares rather well. And compared to some monsters like gnome-terminal	188	still fares rather well. And compared to some monsters like gnome-terminal
66	(21152k + extra 4204k in separate processes) or konsole (22200k + extra	189	(21152k + extra 4204k in separate processes) or konsole (22200k + extra
67	43180k in daemons that stay around after exit, plus half aminute of	190	43180k in daemons that stay around after exit, plus half a minute of
68	startup time, including the hundreds of warnings it spits out), it fares	191	startup time, including the hundreds of warnings it spits out), it fares
69	extremely well g.	192	extremely well g.
70		193
71	=item Why C++, isn't that unportable/bloated/uncool?	194	=item Why C++, isn't that unportable/bloated/uncool?
72		195
…		…
102	No large bloated libraries (of course, none were linked in statically),	225	No large bloated libraries (of course, none were linked in statically),
103	except maybe libX11 :)	226	except maybe libX11 :)
104		227
105	=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?
106		229
107	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
108	tabbing functionality of many window managers or similar tabbing programs,	231	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,	232	give you tabs:
110	as witnessed by F<doc/rxvt-tabbed> or the upcoming C<Gtk2::URxvt> perl	233
111	module, which features a tabbed urxvt (murxvt) terminal as an example	234	@@RXVT_NAME@@ -pe tabbed
112	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.
113		243
114	=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?
115		245
116	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
117	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
…		…
119	daemon.	249	daemon.
120		250
121	=item I am using Debian GNU/Linux and have a problem...	251	=item I am using Debian GNU/Linux and have a problem...
122		252
123	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
124	patches that considerably change the behaviour of rxvt-unicode. Before	254	patches that considerably change the behaviour of rxvt-unicode (but
125	reporting a bug to the original rxvt-unicode author please download and	255	unfortunately this notice has been removed). Before reporting a bug to
126	install the genuine version (L<http://software.schmorp.de#rxvt-unicode>)	256	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	257	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	258	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	259	Debian GNU/Linux, in which case it should be reported via the Debian Bug
130	the bug).	260	Tracking System (use C<reportbug> to report the bug).
131		261
132	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
133	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
134	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
135	might encounter the same issue.	265	might encounter the same issue.
		266
		267	=item I am maintaining rxvt-unicode for distribution/OS XXX, any
		268	recommendation?
		269
		270	You should build one binary with the default options. F<configure>
		271	now enables most useful options, and the trend goes to making them
		272	runtime-switchable, too, so there is usually no drawback to enbaling them,
		273	except higher disk and possibly memory usage. The perl interpreter should
		274	be enabled, as important functionality (menus, selection, likely more in
		275	the future) depends on it.
		276
		277	You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources
		278	system-wide (except maybe with C<defaults>). This will result in useful
		279	behaviour. If your distribution aims at low memory, add an empty
		280	C<perl-ext-common> resource to the app-defaults file. This will keep the
		281	perl interpreter disabled until the user enables it.
		282
		283	If you can/want build more binaries, I recommend building a minimal
		284	one with C<--disable-everything> (very useful) and a maximal one with
		285	C<--enable-everything> (less useful, it will be very big due to a lot of
		286	encodings built-in that increase download times and are rarely used).
		287
		288	=item I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?
		289
		290	It should be, starting with release 7.1. You are encouraged to properly
		291	install urxvt with privileges necessary for your OS now.
		292
		293	When rxvt-unicode detects that it runs setuid or setgid, it will fork
		294	into a helper process for privileged operations (pty handling on some
		295	systems, utmp/wtmp/lastlog handling on others) and drop privileges
		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).
		299
		300	This forking is done as the very first within main(), which is very early
		301	and reduces possible bugs to initialisation code run before main(), or
		302	things like the dynamic loader of your system, which should result in very
		303	little risk.
136		304
137	=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?
138		306
139	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
140	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).
…		…
537	=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?
538		706
539	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
540	terminal, using the resource C<imlocale>:	708	terminal, using the resource C<imlocale>:
541		709
542	URxvt*imlocale: ja_JP.EUC-JP	710	URxvt.imlocale: ja_JP.EUC-JP
543		711
544	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
545	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
546	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
547	method limits you.	715	method limits you.
…		…
593		761
594	Make sure that mouse reporting is actually turned off since killing	762	Make sure that mouse reporting is actually turned off since killing
595	some editors prematurely may leave the mouse in mouse report mode. I've	763	some editors prematurely may leave the mouse in mouse report mode. I've
596	heard that tcsh may use mouse reporting unless it otherwise specified. A	764	heard that tcsh may use mouse reporting unless it otherwise specified. A
597	quick check is to see if cut/paste works when the Alt or Shift keys are	765	quick check is to see if cut/paste works when the Alt or Shift keys are
598	depressed. See @@RXVT_NAME@@(7)	766	depressed.
599		767
600	=item What's with this bold/blink stuff?	768	=item What's with this bold/blink stuff?
601		769
602	If no bold colour is set via C<colorBD:>, bold will invert text using the	770	If no bold colour is set via C<colorBD:>, bold will invert text using the
603	standard foreground colour.	771	standard foreground colour.
…		…
692		860
693	# use Backspace = ^?	861	# use Backspace = ^?
694	$ stty erase ^?	862	$ stty erase ^?
695	$ @@RXVT_NAME@@	863	$ @@RXVT_NAME@@
696		864
697	Toggle with C<ESC [ 36 h> / C<ESC [ 36 l> as documented in @@RXVT_NAME@@(7).	865	Toggle with C<ESC [ 36 h> / C<ESC [ 36 l>.
698		866
699	For an existing rxvt-unicode:	867	For an existing rxvt-unicode:
700		868
701	# use Backspace = ^H	869	# use Backspace = ^H
702	$ stty erase ^H	870	$ stty erase ^H
…		…
820		988
821	=head1 DESCRIPTION	989	=head1 DESCRIPTION
822		990
823	The rest of this document describes various technical aspects of	991	The rest of this document describes various technical aspects of
824	B<rxvt-unicode>. First the description of supported command sequences,	992	B<rxvt-unicode>. First the description of supported command sequences,
825	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
826	features selectable at C<configure> time.	994	selectable at C<configure> time.
827		995
828	=head1 Definitions	996	=head1 Definitions
829		997
830	=over 4	998	=over 4
831		999
…		…
1399	B<< C<h> >> Send Mouse X & Y on button press.	1567	B<< C<h> >> Send Mouse X & Y on button press.
1400	B<< C<l> >> No mouse reporting.	1568	B<< C<l> >> No mouse reporting.
1401		1569
1402	=end table	1570	=end table
1403		1571
1404	=item B<< C<Ps = 10> >> (B<rxvt>)
1405
1406	=begin table
1407
1408	B<< C<h> >> menuBar visible
1409	B<< C<l> >> menuBar invisible
1410
1411	=end table
1412
1413	=item B<< C<Ps = 25> >>	1572	=item B<< C<Ps = 25> >>
1414		1573
1415	=begin table	1574	=begin table
1416		1575
1417	B<< C<h> >> Visible cursor {cnorm/cvvis}	1576	B<< C<h> >> Visible cursor {cnorm/cvvis}
…		…
1530		1689
1531	=begin table	1690	=begin table
1532		1691
1533	B<< C<h> >> Scroll to bottom when a key is pressed	1692	B<< C<h> >> Scroll to bottom when a key is pressed
1534	B<< C<l> >> Don't scroll to bottom when a key is pressed	1693	B<< C<l> >> Don't scroll to bottom when a key is pressed
		1694
		1695	=end table
		1696
		1697	=item B<< C<Ps = 1021> >> (B<rxvt>)
		1698
		1699	=begin table
		1700
		1701	B<< C<h> >> Bold/italic implies high intensity (see option B<-is>)
		1702	B<< C<l> >> Font styles have no effect on intensity (Compile styles)
1535		1703
1536	=end table	1704	=end table
1537		1705
1538	=item B<< C<Ps = 1047> >>	1706	=item B<< C<Ps = 1047> >>
1539		1707
…		…
1588	B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)>	1756	B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)>
1589	B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)>	1757	B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)>
1590	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> >>
1591	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> >>
1592	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> >>
1593	B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >>	1761	B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706]
1594	B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >>	1762	B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
1595	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).
1596	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> >>.
1597	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>
1598	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> >>.
1599	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> >>
1600	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> >>
1601	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).
1602	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>.
1603	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> >>
1604	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).
		1773	B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >>
		1774	B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >>
1605	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>.
1606	B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).	1776	B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1607	B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).	1777	B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1608	B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).	1778	B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1609	B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).	1779	B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1610	B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).	1780	B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
		1781	B<< C<Ps = 777> >> Call the perl extension with the given string, which should be of the form C<extension:parameters> (Compile perl).
1611		1782
1612	=end table	1783	=end table
1613		1784
1614	=back	1785	=back
1615		1786
1616	X<menuBar>
1617
1618	=head1 menuBar
1619
1620	B<< The exact syntax used is I<almost> solidified. >>
1621	In the menus, B<DON'T> try to use menuBar commands that add or remove a
1622	menuBar.
1623
1624	Note that in all of the commands, the B<< I</path/> >> I<cannot> be
1625	omitted: use B<./> to specify a menu relative to the current menu.
1626
1627	=head2 Overview of menuBar operation
1628
1629	For the menuBar XTerm escape sequence C<ESC ] 703 ; Pt ST>, the syntax
1630	of C<Pt> can be used for a variety of tasks:
1631
1632	At the top level is the current menuBar which is a member of a circular
1633	linked-list of other such menuBars.
1634
1635	The menuBar acts as a parent for the various drop-down menus, which in
1636	turn, may have labels, separator lines, menuItems and subMenus.
1637
1638	The menuItems are the useful bits: you can use them to mimic keyboard
1639	input or even to send text or escape sequences back to rxvt.
1640
1641	The menuBar syntax is intended to provide a simple yet robust method of
1642	constructing and manipulating menus and navigating through the
1643	menuBars.
1644
1645	The first step is to use the tag B<< [menu:I<name>] >> which creates
1646	the menuBar called I<name> and allows access. You may now or menus,
1647	subMenus, and menuItems. Finally, use the tag B<[done]> to set the
1648	menuBar access as B<readonly> to prevent accidental corruption of the
1649	menus. To re-access the current menuBar for alterations, use the tag
1650	B<[menu]>, make the alterations and then use B<[done]>
1651
1652	X<menuBarCommands>
1653
1654	=head2 Commands
1655
1656	=over 4
1657
1658	=item B<< [menu:+I<name>] >>
1659
1660	access the named menuBar for creation or alteration. If a new menuBar
1661	is created, it is called I<name> (max of 15 chars) and the current
1662	menuBar is pushed onto the stack
1663
1664	=item B<[menu]>
1665
1666	access the current menuBar for alteration
1667
1668	=item B<< [title:+I<string>] >>
1669
1670	set the current menuBar's title to I<string>, which may contain the
1671	following format specifiers:
1672
1673	B<%n> rxvt name (as per the B<-name> command-line option)
1674	B<%v> rxvt version
1675	B<%%> literal B<%> character
1676
1677	=item B<[done]>
1678
1679	set menuBar access as B<readonly>.
1680	End-of-file tag for B<< [read:+I<file>] >> operations.
1681
1682	=item B<< [read:+I<file>] >>
1683
1684	read menu commands directly from I<file> (extension ".menu" will be
1685	appended if required.) Start reading at a line with B<[menu]> or B<<
1686	[menu:+I<name> >> and continuing until B<[done]> is encountered.
1687
1688	Blank and comment lines (starting with B<#>) are ignored. Actually,
1689	since any invalid menu commands are also ignored, almost anything could
1690	be construed as a comment line, but this may be tightened up in the
1691	future ... so don't count on it!.
1692
1693	=item B<< [read:+I<file>;+I<name>] >>
1694
1695	The same as B<< [read:+I<file>] >>, but start reading at a line with
1696	B<< [menu:+I<name>] >> and continuing until B<< [done:+I<name>] >> or
1697	B<[done]> is encountered.
1698
1699	=item B<[dump]>
1700
1701	dump all menuBars to the file B</tmp/rxvt-PID> in a format suitable for
1702	later rereading.
1703
1704	=item B<[rm:name]>
1705
1706	remove the named menuBar
1707
1708	=item B<[rm] [rm:]>
1709
1710	remove the current menuBar
1711
1712	=item B<[rm] [rm:]>
1713
1714	remove all menuBars
1715
1716	=item B<[swap]>
1717
1718	swap the top two menuBars
1719
1720	=item B<[prev]>
1721
1722	access the previous menuBar
1723
1724	=item B<[next]>
1725
1726	access the next menuBar
1727
1728	=item B<[show]>
1729
1730	Enable display of the menuBar
1731
1732	=item B<[hide]>
1733
1734	Disable display of the menuBar
1735
1736	=item B<< [pixmap:+I<name>] >>
1737
1738	=item B<< [pixmap:+I<name>;I<scaling>] >>
1739
1740	(set the background pixmap globally
1741
1742	B<< A Future implementation I<may> make this local to the menubar >>)
1743
1744	=item B<< [:+I<command>:] >>
1745
1746	ignore the menu readonly status and issue a I<command> to or a menu or
1747	menuitem or change the ; a useful shortcut for setting the quick arrows
1748	from a menuBar.
1749
1750	=back
1751
1752	X<menuBarAdd>
1753
1754	=head2 Adding and accessing menus
1755
1756	The following commands may also be B<+> prefixed.
1757
1758	=over 4
1759
1760	=item B</+>
1761
1762	access menuBar top level
1763
1764	=item B<./+>
1765
1766	access current menu level
1767
1768	=item B<../+>
1769
1770	access parent menu (1 level up)
1771
1772	=item B<../../>
1773
1774	access parent menu (multiple levels up)
1775
1776	=item B<< I</path/>menu >>
1777
1778	add/access menu
1779
1780	=item B<< I</path/>menu/* >>
1781
1782	add/access menu and clear it if it exists
1783
1784	=item B<< I</path/>{-} >>
1785
1786	add separator
1787
1788	=item B<< I</path/>{item} >>
1789
1790	add B<item> as a label
1791
1792	=item B<< I</path/>{item} action >>
1793
1794	add/alter I<menuitem> with an associated I<action>
1795
1796	=item B<< I</path/>{item}{right-text} >>
1797
1798	add/alter I<menuitem> with B<right-text> as the right-justified text
1799	and as the associated I<action>
1800
1801	=item B<< I</path/>{item}{rtext} action >>
1802
1803	add/alter I<menuitem> with an associated I<action> and with B<rtext> as
1804	the right-justified text.
1805
1806	=back
1807
1808	=over 4
1809
1810	=item Special characters in I<action> must be backslash-escaped:
1811
1812	B<\a \b \E \e \n \r \t \octal>
1813
1814	=item or in control-character notation:
1815
1816	B<^@, ^A .. ^Z .. ^_, ^?>
1817
1818	=back
1819
1820	To send a string starting with a B<NUL> (B<^@>) character to the
1821	program, start I<action> with a pair of B<NUL> characters (B<^@^@>),
1822	the first of which will be stripped off and the balance directed to the
1823	program. Otherwise if I<action> begins with B<NUL> followed by
1824	non-+B<NUL> characters, the leading B<NUL> is stripped off and the
1825	balance is sent back to rxvt.
1826
1827	As a convenience for the many Emacs-type editors, I<action> may start
1828	with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be
1829	appended if missed from B<M-x> commands.
1830
1831	As a convenience for issuing XTerm B<ESC ]> sequences from a menubar (or
1832	quick arrow), a B<BEL> (B<^G>) will be appended if needed.
1833
1834	=over 4
1835
1836	=item For example,
1837
1838	B<M-xapropos> is equivalent to B<\Exapropos\r>
1839
1840	=item and
1841
1842	B<\E]703;mona;100> is equivalent to B<\E]703;mona;100\a>
1843
1844	=back
1845
1846	The option B<< {I<right-rtext>} >> will be right-justified. In the
1847	absence of a specified action, this text will be used as the I<action>
1848	as well.
1849
1850	=over 4
1851
1852	=item For example,
1853
1854	B</File/{Open}{^X^F}> is equivalent to B</File/{Open}{^X^F} ^X^F>
1855
1856	=back
1857
1858	The left label I<is> necessary, since it's used for matching, but
1859	implicitly hiding the left label (by using same name for both left and
1860	right labels), or explicitly hiding the left label (by preceeding it
1861	with a dot), makes it possible to have right-justified text only.
1862
1863	=over 4
1864
1865	=item For example,
1866
1867	B</File/{Open}{Open} Open-File-Action>
1868
1869	=item or hiding it
1870
1871	B</File/{.anylabel}{Open} Open-File-Action>
1872
1873	=back
1874
1875	X<menuBarRemove>
1876
1877	=head2 Removing menus
1878
1879	=over 4
1880
1881	=item B<< -/*+ >>
1882
1883	remove all menus from the menuBar, the same as B<[clear]>
1884
1885	=item B<< -+I</path>menu+ >>
1886
1887	remove menu
1888
1889	=item B<< -+I</path>{item}+ >>
1890
1891	remove item
1892
1893	=item B<< -+I</path>{-} >>
1894
1895	remove separator)
1896
1897	=item B<-/path/menu/*>
1898
1899	remove all items, separators and submenus from menu
1900
1901	=back
1902
1903	X<menuBarArrows>
1904
1905	=head2 Quick Arrows
1906
1907	The menus also provide a hook for I<quick arrows> to provide easier
1908	user access. If nothing has been explicitly set, the default is to
1909	emulate the curror keys. The syntax permits each arrow to be altered
1910	individually or all four at once without re-entering their common
1911	beginning/end text. For example, to explicitly associate cursor actions
1912	with the arrows, any of the following forms could be used:
1913
1914	=over 4
1915
1916	=item B<< <r>+I<Right> >>
1917
1918	=item B<< <l>+I<Left> >>
1919
1920	=item B<< <u>+I<Up> >>
1921
1922	=item B<< <d>+I<Down> >>
1923
1924	Define actions for the respective arrow buttons
1925
1926	=item B<< <b>+I<Begin> >>
1927
1928	=item B<< <e>+I<End> >>
1929
1930	Define common beginning/end parts for I<quick arrows> which used in
1931	conjunction with the above <r> <l> <u> <d> constructs
1932
1933	=back
1934
1935	=over 4
1936
1937	=item For example, define arrows individually,
1938
1939	<u>\E[A
1940
1941	<d>\E[B
1942
1943	<r>\E[C
1944
1945	<l>\E[D
1946
1947	=item or all at once
1948
1949	<u>\E[AZ<><d>\E[BZ<><r>\E[CZ<><l>\E[D
1950
1951	=item or more compactly (factoring out common parts)
1952
1953	<b>\E[<u>AZ<><d>BZ<><r>CZ<><l>D
1954
1955	=back
1956
1957	X<menuBarSummary>
1958
1959	=head2 Command Summary
1960
1961	A short summary of the most I<common> commands:
1962
1963	=over 4
1964
1965	=item [menu:name]
1966
1967	use an existing named menuBar or start a new one
1968
1969	=item [menu]
1970
1971	use the current menuBar
1972
1973	=item [title:string]
1974
1975	set menuBar title
1976
1977	=item [done]
1978
1979	set menu access to readonly and, if reading from a file, signal EOF
1980
1981	=item [done:name]
1982
1983	if reading from a file using [read:file;name] signal EOF
1984
1985	=item [rm:name]
1986
1987	remove named menuBar(s)
1988
1989	=item [rm] [rm:]
1990
1991	remove current menuBar
1992
1993	=item [rm] [rm:]
1994
1995	remove all menuBar(s)
1996
1997	=item [swap]
1998
1999	swap top two menuBars
2000
2001	=item [prev]
2002
2003	access the previous menuBar
2004
2005	=item [next]
2006
2007	access the next menuBar
2008
2009	=item [show]
2010
2011	map menuBar
2012
2013	=item [hide]
2014
2015	unmap menuBar
2016
2017	=item [pixmap;file]
2018
2019	=item [pixmap;file;scaling]
2020
2021	set a background pixmap
2022
2023	=item [read:file]
2024
2025	=item [read:file;name]
2026
2027	read in a menu from a file
2028
2029	=item [dump]
2030
2031	dump out all menuBars to /tmp/rxvt-PID
2032
2033	=item /
2034
2035	access menuBar top level
2036
2037	=item ./
2038
2039	=item ../
2040
2041	=item ../../
2042
2043	access current or parent menu level
2044
2045	=item /path/menu
2046
2047	add/access menu
2048
2049	=item /path/{-}
2050
2051	add separator
2052
2053	=item /path/{item}{rtext} action
2054
2055	add/alter menu item
2056
2057	=item -/*
2058
2059	remove all menus from the menuBar
2060
2061	=item -/path/menu
2062
2063	remove menu items, separators and submenus from menu
2064
2065	=item -/path/menu
2066
2067	remove menu
2068
2069	=item -/path/{item}
2070
2071	remove item
2072
2073	=item -/path/{-}
2074
2075	remove separator
2076
2077	=item <b>Begin<r>Right<l>Left<u>Up<d>Down<e>End
2078
2079	menu quick arrows
2080
2081	=back
2082	X<XPM>	1787	X<XPM>
2083		1788
2084	=head1 XPM	1789	=head1 XPM
2085		1790
2086	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
…		…
2333	alternative input methods (e.g. kinput2) and will also correctly	2038	alternative input methods (e.g. kinput2) and will also correctly
2334	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.
2335		2040
2336	=item --enable-unicode3 (default: off)	2041	=item --enable-unicode3 (default: off)
2337		2042
		2043	Recommended to stay off unless you really need non-BMP characters.
		2044
2338	Enable direct support for displaying unicode codepoints above	2045	Enable direct support for displaying unicode codepoints above
2339	65535 (the basic multilingual page). This increases storage	2046	65535 (the basic multilingual page). This increases storage
2340	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
2341	support these extra characters, but Xft does.	2048	support these extra characters, but Xft does.
2342		2049
…		…
2352	composite characters. This is required for proper viewing of text	2059	composite characters. This is required for proper viewing of text
2353	where accents are encoded as seperate unicode characters. This is	2060	where accents are encoded as seperate unicode characters. This is
2354	done by using precomposited characters when available or creating	2061	done by using precomposited characters when available or creating
2355	new pseudo-characters when no precomposed form exists.	2062	new pseudo-characters when no precomposed form exists.
2356		2063
2357	Without --enable-unicode3, the number of additional precomposed characters	2064	Without --enable-unicode3, the number of additional precomposed
2358	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
2359	private use area, extending the number of combinations to 8448). With
2360	--enable-unicode3, no practical limit exists.	2066	(ab-)used). With --enable-unicode3, no practical limit exists.
2361		2067
2362	This option will also enable storage (but not display) of characters	2068	This option will also enable storage (but not display) of characters
2363	beyond plane 0 (>65535) when --enable-unicode3 was not specified.	2069	beyond plane 0 (>65535) when --enable-unicode3 was not specified.
2364		2070
2365	The combining table also contains entries for arabic presentation forms,	2071	The combining table also contains entries for arabic presentation forms,
2366	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
2367	tell me how these are to be used...).	2073	tell me how these are to be used...).
2368		2074
2369	=item --enable-fallback(=CLASS) (default: Rxvt)	2075	=item --enable-fallback(=CLASS) (default: Rxvt)
2370		2076
2371	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.
2372		2079
2373	=item --with-res-name=NAME (default: urxvt)	2080	=item --with-res-name=NAME (default: urxvt)
2374		2081
2375	Use the given name as default application name when	2082	Use the given name as default application name when
2376	reading resources. Specify --with-res-name=rxvt to replace rxvt.	2083	reading resources. Specify --with-res-name=rxvt to replace rxvt.
…		…
2396		2103
2397	Write user and tty to lastlog file (used by programs like	2104	Write user and tty to lastlog file (used by programs like
2398	F<lastlogin>) at start of rxvt execution. This option requires	2105	F<lastlogin>) at start of rxvt execution. This option requires
2399	--enable-utmp to also be specified.	2106	--enable-utmp to also be specified.
2400		2107
2401	=item --enable-xpm-background (default: off)	2108	=item --enable-xpm-background (default: on)
2402		2109
2403	Add support for XPM background pixmaps.	2110	Add support for XPM background pixmaps.
2404		2111
2405	=item --enable-transparency (default: off)	2112	=item --enable-transparency (default: on)
2406		2113
2407	Add support for inheriting parent backgrounds thus giving a fake	2114	Add support for inheriting parent backgrounds thus giving a fake
2408	transparency to the term.	2115	transparency to the term.
2409		2116
2410	=item --enable-fading (default: on)	2117	=item --enable-fading (default: on)
…		…
2412	Add support for fading the text when focus is lost (requires C<--enable-transparency>).	2119	Add support for fading the text when focus is lost (requires C<--enable-transparency>).
2413		2120
2414	=item --enable-tinting (default: on)	2121	=item --enable-tinting (default: on)
2415		2122
2416	Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).	2123	Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2417
2418	=item --enable-menubar (default: off)
2419
2420	Add support for our menu bar system (this interacts badly with
2421	dynamic locale switching currently).
2422		2124
2423	=item --enable-rxvt-scroll (default: on)	2125	=item --enable-rxvt-scroll (default: on)
2424		2126
2425	Add support for the original rxvt scrollbar.	2127	Add support for the original rxvt scrollbar.
2426		2128
…		…
2436		2138
2437	Add support for a very unobtrusive, plain-looking scrollbar that	2139	Add support for a very unobtrusive, plain-looking scrollbar that
2438	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
2439	many years.	2141	many years.
2440		2142
2441	=item --enable-half-shadow (default: off)
2442
2443	Make shadows on the scrollbar only half the normal width & height.
2444	only applicable to rxvt scrollbars.
2445
2446	=item --enable-ttygid (default: off)	2143	=item --enable-ttygid (default: off)
2447		2144
2448	Change tty device setting to group "tty" - only use this if	2145	Change tty device setting to group "tty" - only use this if
2449	your system uses this type of security.	2146	your system uses this type of security.
2450		2147
…		…
2458	do it.	2155	do it.
2459		2156
2460	=item --disable-resources	2157	=item --disable-resources
2461		2158
2462	Removes any support for resource checking.	2159	Removes any support for resource checking.
2463
2464	=item --enable-xgetdefault
2465
2466	Make resources checking via XGetDefault() instead of our small
2467	version which only checks ~/.Xdefaults, or if that doesn't exist then
2468	~/.Xresources.
2469
2470	Please note that nowadays, things like XIM will automatically pull in and
2471	use the full X resource manager, so the overhead of using it might be very
2472	small, if nonexistant.
2473
2474	=item --enable-strings (default: off)
2475
2476	Add support for our possibly faster memset() function and other
2477	various routines, overriding your system's versions which may
2478	have been hand-crafted in assembly or may require extra libraries
2479	to link in. (this breaks ANSI-C rules and has problems on many
2480	GNU/Linux systems).
2481		2160
2482	=item --disable-swapscreen	2161	=item --disable-swapscreen
2483		2162
2484	Remove support for secondary/swap screen.	2163	Remove support for secondary/swap screen.
2485		2164
…		…
2492	A non-exhaustive list of features enabled by C<--enable-frills> (possibly	2171	A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2493	in combination with other switches) is:	2172	in combination with other switches) is:
2494		2173
2495	MWM-hints	2174	MWM-hints
2496	EWMH-hints (pid, utf8 names) and protocols (ping)	2175	EWMH-hints (pid, utf8 names) and protocols (ping)
2497	seperate underline colour	2176	seperate underline colour (-underlineColor)
2498	settable border widths and borderless switch	2177	settable border widths and borderless switch (-w, -b, -bl)
		2178	visual depth selection (-depth)
2499	settable extra linespacing	2179	settable extra linespacing /-lsp)
2500	iso-14755-2 and -3, and visual feedback	2180	iso-14755-2 and -3, and visual feedback
		2181	tripleclickwords (-tcw)
		2182	settable insecure mode (-insecure)
		2183	keysym remapping support
		2184	cursor blinking and underline cursor (-cb, -uc)
		2185	XEmbed support (-embed)
		2186	user-pty (-pty-fd)
		2187	hold on exit (-hold)
		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
		2195	sgr modes 90..97 and 100..107
2501	backindex and forwardindex escape sequence	2196	backindex and forwardindex escape sequences
		2197	view change/zero scorllback esacpe sequences
		2198	locale switching escape sequence
2502	window op and some xterm/OSC escape sequences	2199	window op and some xterm/OSC escape sequences
2503	tripleclickwords	2200	rectangular selections
2504	settable insecure mode	2201	trailing space removal for selections
2505	keysym remapping support	2202	verbose X error handling
2506	cursor blinking and underline cursor
2507	-embed, -pty-fd and -hold options
2508		2203
2509	=item --enable-iso14755 (default: on)	2204	=item --enable-iso14755 (default: on)
2510		2205
2511	Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or	2206	Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
2512	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
…		…
2555		2250
2556	=item --enable-pointer-blank (default: on)	2251	=item --enable-pointer-blank (default: on)
2557		2252
2558	Add support to have the pointer disappear when typing or inactive.	2253	Add support to have the pointer disappear when typing or inactive.
2559		2254
		2255	=item --enable-perl (default: on)
		2256
		2257	Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
		2258	manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files
		2259	in F<src/perl-ext/> for the extensions that are installed by default. The
		2260	perl interpreter that is used can be specified via the C<PERL> environment
		2261	variable when running configure.
		2262
2560	=item --with-name=NAME (default: urxvt)	2263	=item --with-name=NAME (default: urxvt)
2561		2264
2562	Set the basename for the installed binaries, resulting	2265	Set the basename for the installed binaries, resulting
2563	in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with	2266	in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2564	C<rxvt>.	2267	C<rxvt>.

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents): Revision 1.64 by root, Sat Dec 24 12:55:17 2005 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.64 by root, Sat Dec 24 12:55:17 2005 UTC vs.
Revision 1.98 by root, Tue Jan 31 00:56:07 2006 UTC