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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.154 by ayin, Fri Dec 14 09:06:36 2007 UTC vs.
Revision 1.164 by root, Sun Jun 15 13:54:15 2008 UTC

…		…
92		92
93	Print out a message describing available options.	93	Print out a message describing available options.
94		94
95	=item B<-display> I<displayname>	95	=item B<-display> I<displayname>
96		96
97	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>
98	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
99	B<DISPLAY> environment variable is used.	99	display specified by the B<DISPLAY> environment variable is used.
100		100
101	=item B<-depth> I<bitdepth>	101	=item B<-depth> I<bitdepth>
102		102
103	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;
104	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]
105		110
106	=item B<-geometry> I<geom>	111	=item B<-geometry> I<geom>
107		112
108	Window geometry (B<-g> still respected); resource B<geometry>.	113	Window geometry (B<-g> still respected); resource B<geometry>.
109		114
…		…
273		278
274	=item B<-sb>\|B<+sb>	279	=item B<-sb>\|B<+sb>
275		280
276	Turn on/off scrollbar; resource B<scrollBar>.	281	Turn on/off scrollbar; resource B<scrollBar>.
277		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
278	=item B<-si>\|B<+si>	292	=item B<-si>\|B<+si>
279		293
280	Turn on/off scroll-to-bottom on TTY output inhibit; resource	294	Turn on/off scroll-to-bottom on TTY output inhibit; resource
281	B<scrollTtyOutput> has opposite effect.	295	B<scrollTtyOutput> has opposite effect.
282		296
…		…
288	=item B<-sw>\|B<+sw>	302	=item B<-sw>\|B<+sw>
289		303
290	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.
291	This only takes effect if B<-si> is also given; resource	305	This only takes effect if B<-si> is also given; resource
292	B<scrollWithBuffer>.	306	B<scrollWithBuffer>.
293
294	=item B<-sr>\|B<+sr>
295
296	Put scrollbar on right/left; resource B<scrollBar_right>.
297
298	=item B<-st>\|B<+st>
299
300	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
301	resource B<scrollBar_floating>.
302		307
303	=item B<-ptab>\|B<+ptab>	308	=item B<-ptab>\|B<+ptab>
304		309
305	If enabled (default), "Horizontal Tab" characters are being stored as	310	If enabled (default), "Horizontal Tab" characters are being stored as
306	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
…		…
449		454
450	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	455	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
451	will not immediately destroy its window when the program executed within	456	will not immediately destroy its window when the program executed within
452	it exits. Instead, it will wait till it is being killed or closed by the	457	it exits. Instead, it will wait till it is being killed or closed by the
453	user; resource B<hold>.	458	user; resource B<hold>.
		459
		460	=item B<-cd> I<path>
		461
		462	Sets the working directory for the shell (or the command specified via
		463	B<-e>). The I<path> must be an absolute path and it must exist for
		464	@@RXVT_NAME@@ to start; resource B<chdir>.
454		465
455	=item B<-xrm> I<string>	466	=item B<-xrm> I<string>
456		467
457	Works like the X Toolkit option of the same name, by adding the I<string>	468	Works like the X Toolkit option of the same name, by adding the I<string>
458	as if it were specified in a resource file. Resource values specified this	469	as if it were specified in a resource file. Resource values specified this
…		…
567	=item B<depth:> I<bitdepth>	578	=item B<depth:> I<bitdepth>
568		579
569	Compile I<xft>: Attempt to find a visual with the given bit depth;	580	Compile I<xft>: Attempt to find a visual with the given bit depth;
570	option B<-depth>.	581	option B<-depth>.
571		582
		583	=item B<buffered:> I<boolean>
		584
		585	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		586	On some card/driver combination enabling it slightly decreases
		587	performance, on most it greatly helps it. The slowdown is small, so it
		588	should normally be enabled.
		589
572	=item B<geometry:> I<geom>	590	=item B<geometry:> I<geom>
573		591
574	Create the window with the specified X window geometry [default 80x24];	592	Create the window with the specified X window geometry [default 80x24];
575	option B<-geometry>.	593	option B<-geometry>.
576		594
…		…
724	an integer number of images in that direction. No image will be magnified	742	an integer number of images in that direction. No image will be magnified
725	beyond 10 times its original size. The maximum permitted scale is 1000.	743	beyond 10 times its original size. The maximum permitted scale is 1000.
726	Additional operations can be specified after colon B<:op1:op2...>.	744	Additional operations can be specified after colon B<:op1:op2...>.
727	Supported operations are:	745	Supported operations are:
728		746
729	tile force background image to be tiled and not scaled. Equivalent to 0x0,	747	tile force background image to be tiled and not scaled. Equivalent to 0x0
730	propscale will scale image keeping proportions,	748	propscale will scale image keeping proportions
731	auto will scale image to match window size. Equivalent to 100x100;	749	auto will scale image to match window size. Equivalent to 100x100
732	hscale will scale image horizontally to the window size;	750	hscale will scale image horizontally to the window size
733	vscale will scale image vertically to the window size;	751	vscale will scale image vertically to the window size
734	scale will scale image to match window size;	752	scale will scale image to match window size
735	root will tile image as if it was a root window background, auto-adjusting	753	root will tile image as if it was a root window background, auto-adjusting
736	whenever terminal window moves.	754	whenever terminal window moves
737		755
738	If used in conjunction with B<-tr> option, the specified pixmap will be	756	If used in conjunction with B<-tr> option, the specified pixmap will be
739	blended over transparency image using either alpha-blending, or any	757	blended over transparency image using either alpha-blending, or any
740	other blending type, specified with B<-blt "type"> option.	758	other blending type, specified with B<-blt "type"> option.
741		759
…		…
811	option B<-is>, the default), bold/blink font styles imply high	829	option B<-is>, the default), bold/blink font styles imply high
812	intensity foreground/background colours. Disabling this option (B<False>,	830	intensity foreground/background colours. Disabling this option (B<False>,
813	option B<+is>) disables this behaviour, the high intensity colours are not	831	option B<+is>) disables this behaviour, the high intensity colours are not
814	reachable.	832	reachable.
815		833
816	=item B<selectstyle:> I<mode>
817
818	Set mouse selection style to B<old> which is 2.20, B<oldword> which
819	is xterm style with 2.20 old word selection, or anything else which
820	gives xterm style selection. Only effective when the original (non-perl)
821	selection code is in use.
822
823	=item B<scrollstyle:> I<mode>
824
825	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
826	the author's favourite.
827
828	=item B<title:> I<string>	834	=item B<title:> I<string>
829		835
830	Set window title string, the default title is the command-line	836	Set window title string, the default title is the command-line
831	specified after the B<-e> option, if any, otherwise the application	837	specified after the B<-e> option, if any, otherwise the application
832	name; option B<-title>.	838	name; option B<-title>.
…		…
876		882
877	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	883	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
878		884
879	This creates a new file in your home directory with the screen contents	885	This creates a new file in your home directory with the screen contents
880	every time you hit C<Print>.	886	every time you hit C<Print>.
		887
		888	=item B<scrollstyle:> I<mode>
		889
		890	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		891	the author's favourite.
881		892
882	=item B<scrollBar:> I<boolean>	893	=item B<scrollBar:> I<boolean>
883		894
884	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	895	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
885	disable the scrollbar; option B<+sb>.	896	disable the scrollbar; option B<+sb>.
…		…
1084		1095
1085	=item B<secondaryScroll:> I<boolean>	1096	=item B<secondaryScroll:> I<boolean>
1086		1097
1087	Turn on/off secondary screen scroll (default enabled). If this	1098	Turn on/off secondary screen scroll (default enabled). If this
1088	option is enabled, scrolls on the secondary screen will change the	1099	option is enabled, scrolls on the secondary screen will change the
1089	scrollback buffer and switching to/from the secondary screen will	1100	scrollback buffer and, when secondaryScreen is off, switching
1090	instead scroll the screen up.	1101	to/from the secondary screen will instead scroll the screen up.
1091		1102
1092	=item B<hold>: I<boolean>	1103	=item B<hold>: I<boolean>
1093		1104
1094	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1105	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1095	will not immediately destroy its window when the program executed within	1106	will not immediately destroy its window when the program executed within
1096	it exits. Instead, it will wait till it is being killed or closed by the	1107	it exits. Instead, it will wait till it is being killed or closed by the
1097	user.	1108	user.
		1109
		1110	=item B<chdir>: I<path>
		1111
		1112	Sets the working directory for the shell (or the command specified via
		1113	B<-e>). The I<path> must be an absolute path and it must exist for
		1114	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1115	directory will be used; option B<-cd>.
1098		1116
1099	=item B<keysym.>I<sym>: I<string>	1117	=item B<keysym.>I<sym>: I<string>
1100		1118
1101	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1119	Compile I<frills>: Associate I<string> with keysym I<sym>. The
1102	intervening resource name B<keysym.> cannot be omitted.	1120	intervening resource name B<keysym.> cannot be omitted.
…		…
1463	=back	1481	=back
1464		1482
1465	=head2 ALPHA CHANNEL SUPPORT	1483	=head2 ALPHA CHANNEL SUPPORT
1466		1484
1467	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1485	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1468	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>	1486	their act together, rxvt-unicode will do it's own alpha channel management:
1469	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1487
1470	in addition to the ones provided by X, where the additional A component	1488	You can prefix any color with an opaquenes percentage enclosed in
		1489	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1490	(0-100) that specifies the opacity of the color, where C<0> is completely
		1491	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1492	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1493	is the recommended format to specify transparency values, and works with
		1494	all ways to specify a colour.
		1495
		1496	For complete control, rxvt-unicode also supports
		1497	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1498	specifications, where the additional C<aaaa> component specifies opacity
1471	specifies opacity (alpha) values. The minimum value of C<0> is completely	1499	(alpha) values. The minimum value of C<0000> is completely transparent,
1472	transparent). You can also prefix any color with C<[percent]>, where	1500	while C<ffff> is completely opaque). The two example colours from
1473	C<percent> is a decimal percentage (0-100) that specifies the opacity of	1501	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1474	the color, where C<0> is completely transparent and C<100> is completelxy	1502	C<rgba:0000/ff00/0000/f332>.
1475	opaque.
1476		1503
1477	You probably need to specify B<"-depth 32">, too, and have the luck that	1504	You probably need to specify B<"-depth 32">, too, to force a visual with
1478	your X-server uses ARGB pixel layout, as X is far from just supporting	1505	alpha channels, and have the luck that your X-server uses ARGB pixel
1479	ARGB visuals out of the box, and rxvt-unicode just fudges around.	1506	layout, as X is far from just supporting ARGB visuals out of the box, and
		1507	rxvt-unicode just fudges around.
1480		1508
1481	For example, the following selects an almost completely transparent red	1509	For example, the following selects an almost completely transparent black
1482	background, and an almost opaque pink foreground:	1510	background, and an almost opaque pink foreground:
1483		1511
1484	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"	1512	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1485		1513
1486	I<Please note that transparency of any kind if completely unsupported by	1514	When not using a background image, then the interpretation of the
1487	the author. Don't bug him with installation questions!>	1515	alpha channel is up to your compositing manager (most interpret it as
		1516	transparency of course).
		1517
		1518	When using a background pixmap or pseudo-transparency, then the background
		1519	colour will always behave as if it were completely transparent (so the
		1520	background image shows instead), regardless of how it was specified, while
		1521	other colours will either be transparent as specified (the background
		1522	image will show through) on servers supporting the RENDER extension, or
		1523	fully opaque on servers not supporting the RENDER EXTENSION.
		1524
		1525	Please note that due to bugs in Xft, specifying alpha values might result
		1526	in garbage being displayed when the X-server does not support the RENDER
		1527	extension.
1488		1528
1489	=head1 ENVIRONMENT	1529	=head1 ENVIRONMENT
1490		1530
1491	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1531	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1492		1532
…		…
1526	C<--with-terminfo=PATH>.	1566	C<--with-terminfo=PATH>.
1527		1567
1528	=item B<DISPLAY>	1568	=item B<DISPLAY>
1529		1569
1530	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1570	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1531	display in its child processes.	1571	display in its child processes if C<-display> isn't used to override. It
		1572	defaults to C<:0> if it doesn't exist.
1532		1573
1533	=item B<SHELL>	1574	=item B<SHELL>
1534		1575
1535	The shell to be used for command execution, defaults to C</bin/sh>.	1576	The shell to be used for command execution, defaults to C</bin/sh>.
1536		1577

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.154 by ayin, Fri Dec 14 09:06:36 2007 UTC vs. Revision 1.164 by root, Sun Jun 15 13:54:15 2008 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.154 by ayin, Fri Dec 14 09:06:36 2007 UTC vs.
Revision 1.164 by root, Sun Jun 15 13:54:15 2008 UTC