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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.151 by root, Wed Dec 12 19:55:55 2007 UTC vs.
Revision 1.169 by root, Wed Nov 5 00:14:18 2008 UTC

…		…
12	emulator intended as an I<xterm>(1) replacement for users who do not	12	emulator intended as an I<xterm>(1) replacement for users who do not
13	require features such as Tektronix 4014 emulation and toolkit-style	13	require features such as Tektronix 4014 emulation and toolkit-style
14	configurability. As a result, B<rxvt-unicode> uses much less swap space --	14	configurability. As a result, B<rxvt-unicode> uses much less swap space --
15	a significant advantage on a machine serving many X sessions.	15	a significant advantage on a machine serving many X sessions.
16		16
		17	This document is also available on the World-Wide-Web at
		18	L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
		19
17	=head1 FREQUENTLY ASKED QUESTIONS	20	=head1 FREQUENTLY ASKED QUESTIONS
18		21
19	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of	22	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20	frequently asked questions and answer to them and some common	23	frequently asked questions and answer to them and some common
21	problems. That document is also accessible on the World-Wide-Web at	24	problems. That document is also accessible on the World-Wide-Web at
22	L<http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>.	25	L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
23		26
24	=head1 RXVT-UNICODE VS. RXVT	27	=head1 RXVT-UNICODE VS. RXVT
25		28
26	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode	29	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
27	internally. That means it can store and display most scripts in the	30	internally. That means it can store and display most scripts in the
…		…
89		92
90	Print out a message describing available options.	93	Print out a message describing available options.
91		94
92	=item B<-display> I<displayname>	95	=item B<-display> I<displayname>
93		96
94	Attempt to open a window on the named X display (B<-d> still	97	Attempt to open a window on the named X display (the older form B<-d>
95	respected). In the absence of this option, the display specified by the	98	is still respected. but deprecated). In the absence of this option, the
96	B<DISPLAY> environment variable is used.	99	display specified by the B<DISPLAY> environment variable is used.
97		100
98	=item B<-depth> I<bitdepth>	101	=item B<-depth> I<bitdepth>
99		102
100	Compile I<xft>: Attempt to find a visual with the given bit depth;	103	Compile I<xft>: Attempt to find a visual with the given bit depth;
101	resource B<depth>.	104	resource B<depth>.
		105
		106	[Please note that many X servers (and libXft) are buggy with
		107	respect to C<-depth 32> and/or alpha channels, and will cause all sorts
		108	of graphical corruption. This is harmless, but we can't do anything about
		109	this, so watch out]
102		110
103	=item B<-geometry> I<geom>	111	=item B<-geometry> I<geom>
104		112
105	Window geometry (B<-g> still respected); resource B<geometry>.	113	Window geometry (B<-g> still respected); resource B<geometry>.
106		114
…		…
174	horizontal radii are considered to be the same. Setting one of the	182	horizontal radii are considered to be the same. Setting one of the
175	radii to 1 and another to a large number creates interesting effects	183	radii to 1 and another to a large number creates interesting effects
176	on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;	184	on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
177	resource I<blurRadius>.	185	resource I<blurRadius>.
178		186
		187	=item B<-icon> I<file>
		188
		189	Compile I<afterimage>: Use the specified image as application icon. This
		190	is used by many window managers, taskbars and pagers to represent the
		191	application window; resource I<iconFile>.
		192
179	=item B<-bg> I<colour>	193	=item B<-bg> I<colour>
180		194
181	Window background colour; resource B<background>.	195	Window background colour; resource B<background>.
182		196
183	=item B<-fg> I<colour>	197	=item B<-fg> I<colour>
…		…
242	italic> >> characters are to be printed. See resource B<boldItalicFont>	256	italic> >> characters are to be printed. See resource B<boldItalicFont>
243	for details.	257	for details.
244		258
245	=item B<-is>\|B<+is>	259	=item B<-is>\|B<+is>
246		260
247	Compile I<font-styles>: Bold/Italic font styles imply high intensity	261	Compile I<font-styles>: Bold/Blink font styles imply high intensity
248	foreground/background (default). See resource B<intensityStyles> for	262	foreground/background (default). See resource B<intensityStyles> for
249	details.	263	details.
250		264
251	=item B<-name> I<name>	265	=item B<-name> I<name>
252		266
…		…
270		284
271	=item B<-sb>\|B<+sb>	285	=item B<-sb>\|B<+sb>
272		286
273	Turn on/off scrollbar; resource B<scrollBar>.	287	Turn on/off scrollbar; resource B<scrollBar>.
274		288
		289	=item B<-sr>\|B<+sr>
		290
		291	Put scrollbar on right/left; resource B<scrollBar_right>.
		292
		293	=item B<-st>\|B<+st>
		294
		295	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
		296	resource B<scrollBar_floating>.
		297
275	=item B<-si>\|B<+si>	298	=item B<-si>\|B<+si>
276		299
277	Turn on/off scroll-to-bottom on TTY output inhibit; resource	300	Turn on/off scroll-to-bottom on TTY output inhibit; resource
278	B<scrollTtyOutput> has opposite effect.	301	B<scrollTtyOutput> has opposite effect.
279		302
…		…
285	=item B<-sw>\|B<+sw>	308	=item B<-sw>\|B<+sw>
286		309
287	Turn on/off scrolling with the scrollback buffer as new lines appear.	310	Turn on/off scrolling with the scrollback buffer as new lines appear.
288	This only takes effect if B<-si> is also given; resource	311	This only takes effect if B<-si> is also given; resource
289	B<scrollWithBuffer>.	312	B<scrollWithBuffer>.
290
291	=item B<-sr>\|B<+sr>
292
293	Put scrollbar on right/left; resource B<scrollBar_right>.
294
295	=item B<-st>\|B<+st>
296
297	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
298	resource B<scrollBar_floating>.
299		313
300	=item B<-ptab>\|B<+ptab>	314	=item B<-ptab>\|B<+ptab>
301		315
302	If enabled (default), "Horizontal Tab" characters are being stored as	316	If enabled (default), "Horizontal Tab" characters are being stored as
303	actual wide characters in the screen buffer, which makes it possible to	317	actual wide characters in the screen buffer, which makes it possible to
…		…
332		346
333	=item B<-bl>	347	=item B<-bl>
334		348
335	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	349	Compile I<frills>: Set MWM hints to request a borderless window, i.e.
336	if honoured by the WM, the rxvt-unicode window will not have window	350	if honoured by the WM, the rxvt-unicode window will not have window
337	decorations; resource B<borderLess>.	351	decorations; resource B<borderLess>. If the window manager does not
		352	support MWM hints (e.g. kwin), enables override-redirect mode.
338		353
339	=item B<-override-redirect>	354	=item B<-override-redirect>
340		355
341	Compile I<frills>: Sets override-redirect on the window; resource	356	Compile I<frills>: Sets override-redirect on the window; resource
342	B<override-redirect>.	357	B<override-redirect>.
…		…
446		461
447	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	462	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
448	will not immediately destroy its window when the program executed within	463	will not immediately destroy its window when the program executed within
449	it exits. Instead, it will wait till it is being killed or closed by the	464	it exits. Instead, it will wait till it is being killed or closed by the
450	user; resource B<hold>.	465	user; resource B<hold>.
		466
		467	=item B<-cd> I<path>
		468
		469	Sets the working directory for the shell (or the command specified via
		470	B<-e>). The I<path> must be an absolute path and it must exist for
		471	@@RXVT_NAME@@ to start; resource B<chdir>.
451		472
452	=item B<-xrm> I<string>	473	=item B<-xrm> I<string>
453		474
454	Works like the X Toolkit option of the same name, by adding the I<string>	475	Works like the X Toolkit option of the same name, by adding the I<string>
455	as if it were specified in a resource file. Resource values specified this	476	as if it were specified in a resource file. Resource values specified this
…		…
564	=item B<depth:> I<bitdepth>	585	=item B<depth:> I<bitdepth>
565		586
566	Compile I<xft>: Attempt to find a visual with the given bit depth;	587	Compile I<xft>: Attempt to find a visual with the given bit depth;
567	option B<-depth>.	588	option B<-depth>.
568		589
		590	=item B<buffered:> I<boolean>
		591
		592	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		593	On some card/driver combination enabling it slightly decreases
		594	performance, on most it greatly helps it. The slowdown is small, so it
		595	should normally be enabled.
		596
569	=item B<geometry:> I<geom>	597	=item B<geometry:> I<geom>
570		598
571	Create the window with the specified X window geometry [default 80x24];	599	Create the window with the specified X window geometry [default 80x24];
572	option B<-geometry>.	600	option B<-geometry>.
573		601
…		…
691		719
692	Specify background blending type; option B<-blt>.	720	Specify background blending type; option B<-blt>.
693		721
694	=item B<blurRadius:> I<number>	722	=item B<blurRadius:> I<number>
695		723
696	Apply Gaussian Blurr with the specified radius to the transparent	724	Apply gaussian blur with the specified radius to the transparent
697	background image; option B<-blr>.	725	background image; option B<-blr>.
		726
		727	=item B<iconFile:> I<file>
		728
		729	Set the application icon pixmap; option B<-icon>.
698		730
699	=item B<scrollColor:> I<colour>	731	=item B<scrollColor:> I<colour>
700		732
701	Use the specified colour for the scrollbar [default #B2B2B2].	733	Use the specified colour for the scrollbar [default #B2B2B2].
702		734
…		…
721	an integer number of images in that direction. No image will be magnified	753	an integer number of images in that direction. No image will be magnified
722	beyond 10 times its original size. The maximum permitted scale is 1000.	754	beyond 10 times its original size. The maximum permitted scale is 1000.
723	Additional operations can be specified after colon B<:op1:op2...>.	755	Additional operations can be specified after colon B<:op1:op2...>.
724	Supported operations are:	756	Supported operations are:
725		757
726	tile force background image to be tiled and not scaled. Equivalent to 0x0,	758	tile force background image to be tiled and not scaled. Equivalent to 0x0
727	propscale will scale image keeping proportions,	759	propscale will scale image keeping proportions
728	auto will scale image to match window size. Equivalent to 100x100;	760	auto will scale image to match window size. Equivalent to 100x100
729	hscale will scale image horizontally to the window size;	761	hscale will scale image horizontally to the window size
730	vscale will scale image vertically to the window size;	762	vscale will scale image vertically to the window size
731	scale will scale image to match window size;	763	scale will scale image to match window size
732	root will tile image as if it was a root window background, auto-adjusting	764	root will tile image as if it was a root window background, auto-adjusting
733	whenever terminal window moves.	765	whenever terminal window moves
734		766
735	If used in conjunction with B<-tr> option, the specified pixmap will be	767	If used in conjunction with B<-tr> option, the specified pixmap will be
736	blended over transparency image using either alpha-blending, or any	768	blended over transparency image using either alpha-blending, or any
737	other blending type, specified with B<-blt "type"> option.	769	other blending type, specified with B<-blt "type"> option.
738		770
…		…
803	text font will being used for the given style.	835	text font will being used for the given style.
804		836
805	=item B<intensityStyles:> I<boolean>	837	=item B<intensityStyles:> I<boolean>
806		838
807	When font styles are not enabled, or this option is enabled (B<True>,	839	When font styles are not enabled, or this option is enabled (B<True>,
808	option B<-is>, the default), bold and italic font styles imply high	840	option B<-is>, the default), bold/blink font styles imply high
809	intensity foreground/background colours. Disabling this option (B<False>,	841	intensity foreground/background colours. Disabling this option (B<False>,
810	option B<+is>) disables this behaviour, the high intensity colours are not	842	option B<+is>) disables this behaviour, the high intensity colours are not
811	reachable.	843	reachable.
812		844
813	=item B<selectstyle:> I<mode>
814
815	Set mouse selection style to B<old> which is 2.20, B<oldword> which
816	is xterm style with 2.20 old word selection, or anything else which
817	gives xterm style selection. Only effective when the original (non-perl)
818	selection code is in use.
819
820	=item B<scrollstyle:> I<mode>
821
822	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
823	the author's favourite.
824
825	=item B<title:> I<string>	845	=item B<title:> I<string>
826		846
827	Set window title string, the default title is the command-line	847	Set window title string, the default title is the command-line
828	specified after the B<-e> option, if any, otherwise the application	848	specified after the B<-e> option, if any, otherwise the application
829	name; option B<-title>.	849	name; option B<-title>.
…		…
842	=item B<urgentOnBell:> I<boolean>	862	=item B<urgentOnBell:> I<boolean>
843		863
844	B<True>: set the urgency hint for the wm on receipt of a bell character.	864	B<True>: set the urgency hint for the wm on receipt of a bell character.
845	B<False>: do not set the urgency hint [default].	865	B<False>: do not set the urgency hint [default].
846		866
		867	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		868
847	=item B<visualBell:> I<boolean>	869	=item B<visualBell:> I<boolean>
848		870
849	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	871	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
850	B<False>: no visual bell [default]; option B<+vb>.	872	B<False>: no visual bell [default]; option B<+vb>.
851		873
…		…
873		895
874	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	896	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
875		897
876	This creates a new file in your home directory with the screen contents	898	This creates a new file in your home directory with the screen contents
877	every time you hit C<Print>.	899	every time you hit C<Print>.
		900
		901	=item B<scrollstyle:> I<mode>
		902
		903	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		904	the author's favourite.
878		905
879	=item B<scrollBar:> I<boolean>	906	=item B<scrollBar:> I<boolean>
880		907
881	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	908	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
882	disable the scrollbar; option B<+sb>.	909	disable the scrollbar; option B<+sb>.
…		…
1081		1108
1082	=item B<secondaryScroll:> I<boolean>	1109	=item B<secondaryScroll:> I<boolean>
1083		1110
1084	Turn on/off secondary screen scroll (default enabled). If this	1111	Turn on/off secondary screen scroll (default enabled). If this
1085	option is enabled, scrolls on the secondary screen will change the	1112	option is enabled, scrolls on the secondary screen will change the
1086	scrollback buffer and switching to/from the secondary screen will	1113	scrollback buffer and, when secondaryScreen is off, switching
1087	instead scroll the screen up.	1114	to/from the secondary screen will instead scroll the screen up.
1088		1115
1089	=item B<hold>: I<boolean>	1116	=item B<hold>: I<boolean>
1090		1117
1091	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1118	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1092	will not immediately destroy its window when the program executed within	1119	will not immediately destroy its window when the program executed within
1093	it exits. Instead, it will wait till it is being killed or closed by the	1120	it exits. Instead, it will wait till it is being killed or closed by the
1094	user.	1121	user.
		1122
		1123	=item B<chdir>: I<path>
		1124
		1125	Sets the working directory for the shell (or the command specified via
		1126	B<-e>). The I<path> must be an absolute path and it must exist for
		1127	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1128	directory will be used; option B<-cd>.
1095		1129
1096	=item B<keysym.>I<sym>: I<string>	1130	=item B<keysym.>I<sym>: I<string>
1097		1131
1098	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1132	Compile I<frills>: Associate I<string> with keysym I<sym>. The
1099	intervening resource name B<keysym.> cannot be omitted.	1133	intervening resource name B<keysym.> cannot be omitted.
…		…
1206	all instances, while B<perl-ext> is used for specific instances.	1240	all instances, while B<perl-ext> is used for specific instances.
1207		1241
1208	=item B<perl-eval>: I<string>	1242	=item B<perl-eval>: I<string>
1209		1243
1210	Perl code to be evaluated when all extensions have been registered. See	1244	Perl code to be evaluated when all extensions have been registered. See
1211	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource	1245	the @@RXVT_NAME@@perl(3) manpage.
1212	will be ignored when running setuid/setgid.
1213		1246
1214	=item B<perl-lib>: I<path>	1247	=item B<perl-lib>: I<path>
1215		1248
1216	Colon-separated list of additional directories that hold extension	1249	Colon-separated list of additional directories that hold extension
1217	scripts. When looking for extensions specified by the C<perl> resource,	1250	scripts. When looking for extensions specified by the C<perl> resource,
1218	@@RXVT_NAME@@ will first look in these directories and then in	1251	@@RXVT_NAME@@ will first look in these directories and then in
1219	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1252	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1220	will be ignored when running setuid/setgid.
1221		1253
1222	See the @@RXVT_NAME@@perl(3) manpage.	1254	See the @@RXVT_NAME@@perl(3) manpage.
1223		1255
1224	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1256	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1225		1257
…		…
1460	=back	1492	=back
1461		1493
1462	=head2 ALPHA CHANNEL SUPPORT	1494	=head2 ALPHA CHANNEL SUPPORT
1463		1495
1464	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1496	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1465	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>	1497	their act together, rxvt-unicode will do it's own alpha channel management:
1466	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1498
1467	in addition to the ones provided by X, where the additional A component	1499	You can prefix any color with an opaquenes percentage enclosed in
		1500	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1501	(0-100) that specifies the opacity of the color, where C<0> is completely
		1502	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1503	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1504	is the recommended format to specify transparency values, and works with
		1505	all ways to specify a colour.
		1506
		1507	For complete control, rxvt-unicode also supports
		1508	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1509	specifications, where the additional C<aaaa> component specifies opacity
1468	specifies opacity (alpha) values. The minimum value of C<0> is completely	1510	(alpha) values. The minimum value of C<0000> is completely transparent,
1469	transparent). You can also prefix any color with C<[percent]>, where	1511	while C<ffff> is completely opaque). The two example colours from
1470	C<percent> is a decimal percentage (0-100) that specifies the opacity of	1512	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1471	the color, where C<0> is completely transparent and C<100> is completelxy	1513	C<rgba:0000/ff00/0000/f332>.
1472	opaque.
1473		1514
1474	You probably need to specify B<"-depth 32">, too, and have the luck that	1515	You probably need to specify B<"-depth 32">, too, to force a visual with
1475	your X-server uses ARGB pixel layout, as X is far from just supporting	1516	alpha channels, and have the luck that your X-server uses ARGB pixel
1476	ARGB visuals out of the box, and rxvt-unicode just fudges around.	1517	layout, as X is far from just supporting ARGB visuals out of the box, and
		1518	rxvt-unicode just fudges around.
1477		1519
1478	For example, the following selects an almost completely transparent red	1520	For example, the following selects an almost completely transparent black
1479	background, and an almost opaque pink foreground:	1521	background, and an almost opaque pink foreground:
1480		1522
1481	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"	1523	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1482		1524
1483	I<Please note that transparency of any kind if completely unsupported by	1525	When not using a background image, then the interpretation of the
1484	the author. Don't bug him with installation questions!>	1526	alpha channel is up to your compositing manager (most interpret it as
		1527	transparency of course).
		1528
		1529	When using a background pixmap or pseudo-transparency, then the background
		1530	colour will always behave as if it were completely transparent (so the
		1531	background image shows instead), regardless of how it was specified, while
		1532	other colours will either be transparent as specified (the background
		1533	image will show through) on servers supporting the RENDER extension, or
		1534	fully opaque on servers not supporting the RENDER EXTENSION.
		1535
		1536	Please note that due to bugs in Xft, specifying alpha values might result
		1537	in garbage being displayed when the X-server does not support the RENDER
		1538	extension.
1485		1539
1486	=head1 ENVIRONMENT	1540	=head1 ENVIRONMENT
1487		1541
1488	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1542	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1489		1543
…		…
1523	C<--with-terminfo=PATH>.	1577	C<--with-terminfo=PATH>.
1524		1578
1525	=item B<DISPLAY>	1579	=item B<DISPLAY>
1526		1580
1527	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1581	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1528	display in its child processes.	1582	display in its child processes if C<-display> isn't used to override. It
		1583	defaults to C<:0> if it doesn't exist.
1529		1584
1530	=item B<SHELL>	1585	=item B<SHELL>
1531		1586
1532	The shell to be used for command execution, defaults to C</bin/sh>.	1587	The shell to be used for command execution, defaults to C</bin/sh>.
1533		1588

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.151 by root, Wed Dec 12 19:55:55 2007 UTC vs. Revision 1.169 by root, Wed Nov 5 00:14:18 2008 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.151 by root, Wed Dec 12 19:55:55 2007 UTC vs.
Revision 1.169 by root, Wed Nov 5 00:14:18 2008 UTC