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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.152 by root, Wed Dec 12 19:56:37 2007 UTC vs.
Revision 1.170 by root, Sat May 30 08:51:23 2009 UTC

…		…
11	B<rxvt-unicode>, version B<@@RXVT_VERSION@@>, is a colour vt102 terminal	11	B<rxvt-unicode>, version B<@@RXVT_VERSION@@>, is a colour vt102 terminal
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
		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>.
16		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
…		…
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>.
…		…
351	=item B<-lsp> I<number>	366	=item B<-lsp> I<number>
352		367
353	Compile I<frills>: Lines (pixel height) to insert between each row of	368	Compile I<frills>: Lines (pixel height) to insert between each row of
354	the display. Useful to work around font rendering problems; resource	369	the display. Useful to work around font rendering problems; resource
355	B<lineSpace>.	370	B<lineSpace>.
		371
		372	=item B<-letsp> I<number>
		373
		374	Compile I<frills>: Amount to adjust the computed character width by
		375	to control overall letter spacing. Negative values will tighten up the
		376	letter spacing, positive values will space letters out more. Useful to
		377	work around odd font metrics; resource B<letterSpace>.
356		378
357	=item B<-tn> I<termname>	379	=item B<-tn> I<termname>
358		380
359	This option specifies the name of the terminal type to be set in the	381	This option specifies the name of the terminal type to be set in the
360	B<TERM> environment variable. This terminal type must exist in the	382	B<TERM> environment variable. This terminal type must exist in the
…		…
446		468
447	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	469	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
448	will not immediately destroy its window when the program executed within	470	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	471	it exits. Instead, it will wait till it is being killed or closed by the
450	user; resource B<hold>.	472	user; resource B<hold>.
		473
		474	=item B<-cd> I<path>
		475
		476	Sets the working directory for the shell (or the command specified via
		477	B<-e>). The I<path> must be an absolute path and it must exist for
		478	@@RXVT_NAME@@ to start; resource B<chdir>.
451		479
452	=item B<-xrm> I<string>	480	=item B<-xrm> I<string>
453		481
454	Works like the X Toolkit option of the same name, by adding the I<string>	482	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	483	as if it were specified in a resource file. Resource values specified this
…		…
564	=item B<depth:> I<bitdepth>	592	=item B<depth:> I<bitdepth>
565		593
566	Compile I<xft>: Attempt to find a visual with the given bit depth;	594	Compile I<xft>: Attempt to find a visual with the given bit depth;
567	option B<-depth>.	595	option B<-depth>.
568		596
		597	=item B<buffered:> I<boolean>
		598
		599	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		600	On some card/driver combination enabling it slightly decreases
		601	performance, on most it greatly helps it. The slowdown is small, so it
		602	should normally be enabled.
		603
569	=item B<geometry:> I<geom>	604	=item B<geometry:> I<geom>
570		605
571	Create the window with the specified X window geometry [default 80x24];	606	Create the window with the specified X window geometry [default 80x24];
572	option B<-geometry>.	607	option B<-geometry>.
573		608
…		…
691		726
692	Specify background blending type; option B<-blt>.	727	Specify background blending type; option B<-blt>.
693		728
694	=item B<blurRadius:> I<number>	729	=item B<blurRadius:> I<number>
695		730
696	Apply Gaussian Blurr with the specified radius to the transparent	731	Apply gaussian blur with the specified radius to the transparent
697	background image; option B<-blr>.	732	background image; option B<-blr>.
		733
		734	=item B<iconFile:> I<file>
		735
		736	Set the application icon pixmap; option B<-icon>.
698		737
699	=item B<scrollColor:> I<colour>	738	=item B<scrollColor:> I<colour>
700		739
701	Use the specified colour for the scrollbar [default #B2B2B2].	740	Use the specified colour for the scrollbar [default #B2B2B2].
702		741
…		…
721	an integer number of images in that direction. No image will be magnified	760	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.	761	beyond 10 times its original size. The maximum permitted scale is 1000.
723	Additional operations can be specified after colon B<:op1:op2...>.	762	Additional operations can be specified after colon B<:op1:op2...>.
724	Supported operations are:	763	Supported operations are:
725		764
726	tile force background image to be tiled and not scaled. Equivalent to 0x0,	765	tile force background image to be tiled and not scaled. Equivalent to 0x0
727	propscale will scale image keeping proportions,	766	propscale will scale image keeping proportions
728	auto will scale image to match window size. Equivalent to 100x100;	767	auto will scale image to match window size. Equivalent to 100x100
729	hscale will scale image horizontally to the window size;	768	hscale will scale image horizontally to the window size
730	vscale will scale image vertically to the window size;	769	vscale will scale image vertically to the window size
731	scale will scale image to match window size;	770	scale will scale image to match window size
732	root will tile image as if it was a root window background, auto-adjusting	771	root will tile image as if it was a root window background, auto-adjusting
733	whenever terminal window moves.	772	whenever terminal window moves
734		773
735	If used in conjunction with B<-tr> option, the specified pixmap will be	774	If used in conjunction with B<-tr> option, the specified pixmap will be
736	blended over transparency image using either alpha-blending, or any	775	blended over transparency image using either alpha-blending, or any
737	other blending type, specified with B<-blt "type"> option.	776	other blending type, specified with B<-blt "type"> option.
738		777
…		…
803	text font will being used for the given style.	842	text font will being used for the given style.
804		843
805	=item B<intensityStyles:> I<boolean>	844	=item B<intensityStyles:> I<boolean>
806		845
807	When font styles are not enabled, or this option is enabled (B<True>,	846	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	847	option B<-is>, the default), bold/blink font styles imply high
809	intensity foreground/background colours. Disabling this option (B<False>,	848	intensity foreground/background colours. Disabling this option (B<False>,
810	option B<+is>) disables this behaviour, the high intensity colours are not	849	option B<+is>) disables this behaviour, the high intensity colours are not
811	reachable.	850	reachable.
812		851
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>	852	=item B<title:> I<string>
826		853
827	Set window title string, the default title is the command-line	854	Set window title string, the default title is the command-line
828	specified after the B<-e> option, if any, otherwise the application	855	specified after the B<-e> option, if any, otherwise the application
829	name; option B<-title>.	856	name; option B<-title>.
…		…
842	=item B<urgentOnBell:> I<boolean>	869	=item B<urgentOnBell:> I<boolean>
843		870
844	B<True>: set the urgency hint for the wm on receipt of a bell character.	871	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].	872	B<False>: do not set the urgency hint [default].
846		873
		874	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		875
847	=item B<visualBell:> I<boolean>	876	=item B<visualBell:> I<boolean>
848		877
849	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	878	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
850	B<False>: no visual bell [default]; option B<+vb>.	879	B<False>: no visual bell [default]; option B<+vb>.
851		880
…		…
873		902
874	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	903	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
875		904
876	This creates a new file in your home directory with the screen contents	905	This creates a new file in your home directory with the screen contents
877	every time you hit C<Print>.	906	every time you hit C<Print>.
		907
		908	=item B<scrollstyle:> I<mode>
		909
		910	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		911	the author's favourite.
878		912
879	=item B<scrollBar:> I<boolean>	913	=item B<scrollBar:> I<boolean>
880		914
881	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	915	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
882	disable the scrollbar; option B<+sb>.	916	disable the scrollbar; option B<+sb>.
…		…
1081		1115
1082	=item B<secondaryScroll:> I<boolean>	1116	=item B<secondaryScroll:> I<boolean>
1083		1117
1084	Turn on/off secondary screen scroll (default enabled). If this	1118	Turn on/off secondary screen scroll (default enabled). If this
1085	option is enabled, scrolls on the secondary screen will change the	1119	option is enabled, scrolls on the secondary screen will change the
1086	scrollback buffer and switching to/from the secondary screen will	1120	scrollback buffer and, when secondaryScreen is off, switching
1087	instead scroll the screen up.	1121	to/from the secondary screen will instead scroll the screen up.
1088		1122
1089	=item B<hold>: I<boolean>	1123	=item B<hold>: I<boolean>
1090		1124
1091	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1125	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1092	will not immediately destroy its window when the program executed within	1126	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	1127	it exits. Instead, it will wait till it is being killed or closed by the
1094	user.	1128	user.
		1129
		1130	=item B<chdir>: I<path>
		1131
		1132	Sets the working directory for the shell (or the command specified via
		1133	B<-e>). The I<path> must be an absolute path and it must exist for
		1134	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1135	directory will be used; option B<-cd>.
1095		1136
1096	=item B<keysym.>I<sym>: I<string>	1137	=item B<keysym.>I<sym>: I<string>
1097		1138
1098	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1139	Compile I<frills>: Associate I<string> with keysym I<sym>. The
1099	intervening resource name B<keysym.> cannot be omitted.	1140	intervening resource name B<keysym.> cannot be omitted.
…		…
1206	all instances, while B<perl-ext> is used for specific instances.	1247	all instances, while B<perl-ext> is used for specific instances.
1207		1248
1208	=item B<perl-eval>: I<string>	1249	=item B<perl-eval>: I<string>
1209		1250
1210	Perl code to be evaluated when all extensions have been registered. See	1251	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	1252	the @@RXVT_NAME@@perl(3) manpage.
1212	will be ignored when running setuid/setgid.
1213		1253
1214	=item B<perl-lib>: I<path>	1254	=item B<perl-lib>: I<path>
1215		1255
1216	Colon-separated list of additional directories that hold extension	1256	Colon-separated list of additional directories that hold extension
1217	scripts. When looking for extensions specified by the C<perl> resource,	1257	scripts. When looking for extensions specified by the C<perl> resource,
1218	@@RXVT_NAME@@ will first look in these directories and then in	1258	@@RXVT_NAME@@ will first look in these directories and then in
1219	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1259	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1220	will be ignored when running setuid/setgid.
1221		1260
1222	See the @@RXVT_NAME@@perl(3) manpage.	1261	See the @@RXVT_NAME@@perl(3) manpage.
1223		1262
1224	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1263	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1225		1264
…		…
1460	=back	1499	=back
1461		1500
1462	=head2 ALPHA CHANNEL SUPPORT	1501	=head2 ALPHA CHANNEL SUPPORT
1463		1502
1464	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1503	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>	1504	their act together, rxvt-unicode will do it's own alpha channel management:
1466	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1505
1467	in addition to the ones provided by X, where the additional A component	1506	You can prefix any color with an opaquenes percentage enclosed in
		1507	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1508	(0-100) that specifies the opacity of the color, where C<0> is completely
		1509	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1510	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1511	is the recommended format to specify transparency values, and works with
		1512	all ways to specify a colour.
		1513
		1514	For complete control, rxvt-unicode also supports
		1515	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1516	specifications, where the additional C<aaaa> component specifies opacity
1468	specifies opacity (alpha) values. The minimum value of C<0> is completely	1517	(alpha) values. The minimum value of C<0000> is completely transparent,
1469	transparent). You can also prefix any color with C<[percent]>, where	1518	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	1519	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	1520	C<rgba:0000/ff00/0000/f332>.
1472	opaque.
1473		1521
1474	You probably need to specify B<"-depth 32">, too, and have the luck that	1522	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	1523	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.	1524	layout, as X is far from just supporting ARGB visuals out of the box, and
		1525	rxvt-unicode just fudges around.
1477		1526
1478	For example, the following selects an almost completely transparent red	1527	For example, the following selects an almost completely transparent black
1479	background, and an almost opaque pink foreground:	1528	background, and an almost opaque pink foreground:
1480		1529
1481	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"	1530	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1482		1531
1483	I<Please note that transparency of any kind if completely unsupported by	1532	When not using a background image, then the interpretation of the
1484	the author. Don't bug him with installation questions!>	1533	alpha channel is up to your compositing manager (most interpret it as
		1534	transparency of course).
		1535
		1536	When using a background pixmap or pseudo-transparency, then the background
		1537	colour will always behave as if it were completely transparent (so the
		1538	background image shows instead), regardless of how it was specified, while
		1539	other colours will either be transparent as specified (the background
		1540	image will show through) on servers supporting the RENDER extension, or
		1541	fully opaque on servers not supporting the RENDER EXTENSION.
		1542
		1543	Please note that due to bugs in Xft, specifying alpha values might result
		1544	in garbage being displayed when the X-server does not support the RENDER
		1545	extension.
1485		1546
1486	=head1 ENVIRONMENT	1547	=head1 ENVIRONMENT
1487		1548
1488	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1549	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1489		1550
…		…
1523	C<--with-terminfo=PATH>.	1584	C<--with-terminfo=PATH>.
1524		1585
1525	=item B<DISPLAY>	1586	=item B<DISPLAY>
1526		1587
1527	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1588	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1528	display in its child processes.	1589	display in its child processes if C<-display> isn't used to override. It
		1590	defaults to C<:0> if it doesn't exist.
1529		1591
1530	=item B<SHELL>	1592	=item B<SHELL>
1531		1593
1532	The shell to be used for command execution, defaults to C</bin/sh>.	1594	The shell to be used for command execution, defaults to C</bin/sh>.
1533		1595

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.152 by root, Wed Dec 12 19:56:37 2007 UTC vs. Revision 1.170 by root, Sat May 30 08:51:23 2009 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.152 by root, Wed Dec 12 19:56:37 2007 UTC vs.
Revision 1.170 by root, Sat May 30 08:51:23 2009 UTC