[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.161 by ayin, Sat Jan 26 14:24:42 2008 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
…		…
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>.
102		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]
		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
107	=item B<-rv>\|B<+rv>	115	=item B<-rv>\|B<+rv>
…		…
242	italic> >> characters are to be printed. See resource B<boldItalicFont>	250	italic> >> characters are to be printed. See resource B<boldItalicFont>
243	for details.	251	for details.
244		252
245	=item B<-is>\|B<+is>	253	=item B<-is>\|B<+is>
246		254
247	Compile I<font-styles>: Bold/Italic font styles imply high intensity	255	Compile I<font-styles>: Bold/Blink font styles imply high intensity
248	foreground/background (default). See resource B<intensityStyles> for	256	foreground/background (default). See resource B<intensityStyles> for
249	details.	257	details.
250		258
251	=item B<-name> I<name>	259	=item B<-name> I<name>
252		260
…		…
270		278
271	=item B<-sb>\|B<+sb>	279	=item B<-sb>\|B<+sb>
272		280
273	Turn on/off scrollbar; resource B<scrollBar>.	281	Turn on/off scrollbar; resource B<scrollBar>.
274		282
		283	=item B<-sr>\|B<+sr>
		284
		285	Put scrollbar on right/left; resource B<scrollBar_right>.
		286
		287	=item B<-st>\|B<+st>
		288
		289	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
		290	resource B<scrollBar_floating>.
		291
275	=item B<-si>\|B<+si>	292	=item B<-si>\|B<+si>
276		293
277	Turn on/off scroll-to-bottom on TTY output inhibit; resource	294	Turn on/off scroll-to-bottom on TTY output inhibit; resource
278	B<scrollTtyOutput> has opposite effect.	295	B<scrollTtyOutput> has opposite effect.
279		296
…		…
285	=item B<-sw>\|B<+sw>	302	=item B<-sw>\|B<+sw>
286		303
287	Turn on/off scrolling with the scrollback buffer as new lines appear.	304	Turn on/off scrolling with the scrollback buffer as new lines appear.
288	This only takes effect if B<-si> is also given; resource	305	This only takes effect if B<-si> is also given; resource
289	B<scrollWithBuffer>.	306	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		307
300	=item B<-ptab>\|B<+ptab>	308	=item B<-ptab>\|B<+ptab>
301		309
302	If enabled (default), "Horizontal Tab" characters are being stored as	310	If enabled (default), "Horizontal Tab" characters are being stored as
303	actual wide characters in the screen buffer, which makes it possible to	311	actual wide characters in the screen buffer, which makes it possible to
…		…
564	=item B<depth:> I<bitdepth>	572	=item B<depth:> I<bitdepth>
565		573
566	Compile I<xft>: Attempt to find a visual with the given bit depth;	574	Compile I<xft>: Attempt to find a visual with the given bit depth;
567	option B<-depth>.	575	option B<-depth>.
568		576
		577	=item B<buffered:> I<boolean>
		578
		579	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		580	On some card/driver combination enabling it slightly decreases
		581	performance, on most it greatly helps it. The slowdown is small, so it
		582	should normally be enabled.
		583
569	=item B<geometry:> I<geom>	584	=item B<geometry:> I<geom>
570		585
571	Create the window with the specified X window geometry [default 80x24];	586	Create the window with the specified X window geometry [default 80x24];
572	option B<-geometry>.	587	option B<-geometry>.
573		588
…		…
721	an integer number of images in that direction. No image will be magnified	736	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.	737	beyond 10 times its original size. The maximum permitted scale is 1000.
723	Additional operations can be specified after colon B<:op1:op2...>.	738	Additional operations can be specified after colon B<:op1:op2...>.
724	Supported operations are:	739	Supported operations are:
725		740
726	tile force background image to be tiled and not scaled. Equivalent to 0x0,	741	tile force background image to be tiled and not scaled. Equivalent to 0x0
727	propscale will scale image keeping proportions,	742	propscale will scale image keeping proportions
728	auto will scale image to match window size. Equivalent to 100x100;	743	auto will scale image to match window size. Equivalent to 100x100
729	hscale will scale image horizontally to the window size;	744	hscale will scale image horizontally to the window size
730	vscale will scale image vertically to the window size;	745	vscale will scale image vertically to the window size
731	scale will scale image to match window size;	746	scale will scale image to match window size
732	root will tile image as if it was a root window background, auto-adjusting	747	root will tile image as if it was a root window background, auto-adjusting
733	whenever terminal window moves.	748	whenever terminal window moves
734		749
735	If used in conjunction with B<-tr> option, the specified pixmap will be	750	If used in conjunction with B<-tr> option, the specified pixmap will be
736	blended over transparency image using either alpha-blending, or any	751	blended over transparency image using either alpha-blending, or any
737	other blending type, specified with B<-blt "type"> option.	752	other blending type, specified with B<-blt "type"> option.
738		753
…		…
803	text font will being used for the given style.	818	text font will being used for the given style.
804		819
805	=item B<intensityStyles:> I<boolean>	820	=item B<intensityStyles:> I<boolean>
806		821
807	When font styles are not enabled, or this option is enabled (B<True>,	822	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	823	option B<-is>, the default), bold/blink font styles imply high
809	intensity foreground/background colours. Disabling this option (B<False>,	824	intensity foreground/background colours. Disabling this option (B<False>,
810	option B<+is>) disables this behaviour, the high intensity colours are not	825	option B<+is>) disables this behaviour, the high intensity colours are not
811	reachable.	826	reachable.
812		827
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>	828	=item B<title:> I<string>
826		829
827	Set window title string, the default title is the command-line	830	Set window title string, the default title is the command-line
828	specified after the B<-e> option, if any, otherwise the application	831	specified after the B<-e> option, if any, otherwise the application
829	name; option B<-title>.	832	name; option B<-title>.
…		…
873		876
874	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	877	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
875		878
876	This creates a new file in your home directory with the screen contents	879	This creates a new file in your home directory with the screen contents
877	every time you hit C<Print>.	880	every time you hit C<Print>.
		881
		882	=item B<scrollstyle:> I<mode>
		883
		884	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		885	the author's favourite.
878		886
879	=item B<scrollBar:> I<boolean>	887	=item B<scrollBar:> I<boolean>
880		888
881	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	889	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
882	disable the scrollbar; option B<+sb>.	890	disable the scrollbar; option B<+sb>.
…		…
1460	=back	1468	=back
1461		1469
1462	=head2 ALPHA CHANNEL SUPPORT	1470	=head2 ALPHA CHANNEL SUPPORT
1463		1471
1464	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1472	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>	1473	their act together, rxvt-unicode will do it's own alpha channel management:
1466	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1474
1467	in addition to the ones provided by X, where the additional A component	1475	You can prefix any color with an opaquenes percentage enclosed in
		1476	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1477	(0-100) that specifies the opacity of the color, where C<0> is completely
		1478	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1479	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1480	is the recommended format to specify transparency values, and works with
		1481	all ways to specify a colour.
		1482
		1483	For complete control, rxvt-unicode also supports
		1484	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1485	specifications, where the additional C<aaaa> component specifies opacity
1468	specifies opacity (alpha) values. The minimum value of C<0> is completely	1486	(alpha) values. The minimum value of C<0000> is completely transparent,
1469	transparent). You can also prefix any color with C<[percent]>, where	1487	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	1488	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	1489	C<rgba:0000/ff00/0000/f332>.
1472	opaque.
1473		1490
1474	You probably need to specify B<"-depth 32">, too, and have the luck that	1491	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	1492	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.	1493	layout, as X is far from just supporting ARGB visuals out of the box, and
		1494	rxvt-unicode just fudges around.
1477		1495
1478	For example, the following selects an almost completely transparent red	1496	For example, the following selects an almost completely transparent black
1479	background, and an almost opaque pink foreground:	1497	background, and an almost opaque pink foreground:
1480		1498
1481	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"	1499	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1482		1500
1483	I<Please note that transparency of any kind if completely unsupported by	1501	When not using a background image, then the interpretation of the
1484	the author. Don't bug him with installation questions!>	1502	alpha channel is up to your compositing manager (most interpret it as
		1503	transparency of course).
		1504
		1505	When using a background pixmap or pseudo-transparency, then the background
		1506	colour will always behave as if it were completely transparent (so the
		1507	background image shows instead), regardless of how it was specified, while
		1508	other colours will either be transparent as specified (the background
		1509	image will show through) on servers supporting the RENDER extension, or
		1510	fully opaque on servers not supporting the RENDER EXTENSION.
		1511
		1512	Please note that due to bugs in Xft, specifying alpha values might result
		1513	in garbage being displayed when the X-server does not support the RENDER
		1514	extension.
1485		1515
1486	=head1 ENVIRONMENT	1516	=head1 ENVIRONMENT
1487		1517
1488	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1518	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1489		1519

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.161 by ayin, Sat Jan 26 14:24:42 2008 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.161 by ayin, Sat Jan 26 14:24:42 2008 UTC