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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.153 by root, Wed Dec 12 19:57:13 2007 UTC vs.
Revision 1.167 by root, Wed Oct 15 14:48:22 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
…		…
245	italic> >> characters are to be printed. See resource B<boldItalicFont>	250	italic> >> characters are to be printed. See resource B<boldItalicFont>
246	for details.	251	for details.
247		252
248	=item B<-is>\|B<+is>	253	=item B<-is>\|B<+is>
249		254
250	Compile I<font-styles>: Bold/Italic font styles imply high intensity	255	Compile I<font-styles>: Bold/Blink font styles imply high intensity
251	foreground/background (default). See resource B<intensityStyles> for	256	foreground/background (default). See resource B<intensityStyles> for
252	details.	257	details.
253		258
254	=item B<-name> I<name>	259	=item B<-name> I<name>
255		260
…		…
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
…		…
335		340
336	=item B<-bl>	341	=item B<-bl>
337		342
338	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	343	Compile I<frills>: Set MWM hints to request a borderless window, i.e.
339	if honoured by the WM, the rxvt-unicode window will not have window	344	if honoured by the WM, the rxvt-unicode window will not have window
340	decorations; resource B<borderLess>.	345	decorations; resource B<borderLess>. If the window manager does not
		346	support MWM hints (e.g. kwin), enables override-redirect mode.
341		347
342	=item B<-override-redirect>	348	=item B<-override-redirect>
343		349
344	Compile I<frills>: Sets override-redirect on the window; resource	350	Compile I<frills>: Sets override-redirect on the window; resource
345	B<override-redirect>.	351	B<override-redirect>.
…		…
449		455
450	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	456	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
451	will not immediately destroy its window when the program executed within	457	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	458	it exits. Instead, it will wait till it is being killed or closed by the
453	user; resource B<hold>.	459	user; resource B<hold>.
		460
		461	=item B<-cd> I<path>
		462
		463	Sets the working directory for the shell (or the command specified via
		464	B<-e>). The I<path> must be an absolute path and it must exist for
		465	@@RXVT_NAME@@ to start; resource B<chdir>.
454		466
455	=item B<-xrm> I<string>	467	=item B<-xrm> I<string>
456		468
457	Works like the X Toolkit option of the same name, by adding the I<string>	469	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	470	as if it were specified in a resource file. Resource values specified this
…		…
567	=item B<depth:> I<bitdepth>	579	=item B<depth:> I<bitdepth>
568		580
569	Compile I<xft>: Attempt to find a visual with the given bit depth;	581	Compile I<xft>: Attempt to find a visual with the given bit depth;
570	option B<-depth>.	582	option B<-depth>.
571		583
		584	=item B<buffered:> I<boolean>
		585
		586	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		587	On some card/driver combination enabling it slightly decreases
		588	performance, on most it greatly helps it. The slowdown is small, so it
		589	should normally be enabled.
		590
572	=item B<geometry:> I<geom>	591	=item B<geometry:> I<geom>
573		592
574	Create the window with the specified X window geometry [default 80x24];	593	Create the window with the specified X window geometry [default 80x24];
575	option B<-geometry>.	594	option B<-geometry>.
576		595
…		…
724	an integer number of images in that direction. No image will be magnified	743	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.	744	beyond 10 times its original size. The maximum permitted scale is 1000.
726	Additional operations can be specified after colon B<:op1:op2...>.	745	Additional operations can be specified after colon B<:op1:op2...>.
727	Supported operations are:	746	Supported operations are:
728		747
729	tile force background image to be tiled and not scaled. Equivalent to 0x0,	748	tile force background image to be tiled and not scaled. Equivalent to 0x0
730	propscale will scale image keeping proportions,	749	propscale will scale image keeping proportions
731	auto will scale image to match window size. Equivalent to 100x100;	750	auto will scale image to match window size. Equivalent to 100x100
732	hscale will scale image horizontally to the window size;	751	hscale will scale image horizontally to the window size
733	vscale will scale image vertically to the window size;	752	vscale will scale image vertically to the window size
734	scale will scale image to match window size;	753	scale will scale image to match window size
735	root will tile image as if it was a root window background, auto-adjusting	754	root will tile image as if it was a root window background, auto-adjusting
736	whenever terminal window moves.	755	whenever terminal window moves
737		756
738	If used in conjunction with B<-tr> option, the specified pixmap will be	757	If used in conjunction with B<-tr> option, the specified pixmap will be
739	blended over transparency image using either alpha-blending, or any	758	blended over transparency image using either alpha-blending, or any
740	other blending type, specified with B<-blt "type"> option.	759	other blending type, specified with B<-blt "type"> option.
741		760
…		…
806	text font will being used for the given style.	825	text font will being used for the given style.
807		826
808	=item B<intensityStyles:> I<boolean>	827	=item B<intensityStyles:> I<boolean>
809		828
810	When font styles are not enabled, or this option is enabled (B<True>,	829	When font styles are not enabled, or this option is enabled (B<True>,
811	option B<-is>, the default), bold and italic font styles imply high	830	option B<-is>, the default), bold/blink font styles imply high
812	intensity foreground/background colours. Disabling this option (B<False>,	831	intensity foreground/background colours. Disabling this option (B<False>,
813	option B<+is>) disables this behaviour, the high intensity colours are not	832	option B<+is>) disables this behaviour, the high intensity colours are not
814	reachable.	833	reachable.
815		834
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>	835	=item B<title:> I<string>
829		836
830	Set window title string, the default title is the command-line	837	Set window title string, the default title is the command-line
831	specified after the B<-e> option, if any, otherwise the application	838	specified after the B<-e> option, if any, otherwise the application
832	name; option B<-title>.	839	name; option B<-title>.
…		…
845	=item B<urgentOnBell:> I<boolean>	852	=item B<urgentOnBell:> I<boolean>
846		853
847	B<True>: set the urgency hint for the wm on receipt of a bell character.	854	B<True>: set the urgency hint for the wm on receipt of a bell character.
848	B<False>: do not set the urgency hint [default].	855	B<False>: do not set the urgency hint [default].
849		856
		857	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		858
850	=item B<visualBell:> I<boolean>	859	=item B<visualBell:> I<boolean>
851		860
852	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	861	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
853	B<False>: no visual bell [default]; option B<+vb>.	862	B<False>: no visual bell [default]; option B<+vb>.
854		863
…		…
876		885
877	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	886	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
878		887
879	This creates a new file in your home directory with the screen contents	888	This creates a new file in your home directory with the screen contents
880	every time you hit C<Print>.	889	every time you hit C<Print>.
		890
		891	=item B<scrollstyle:> I<mode>
		892
		893	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		894	the author's favourite.
881		895
882	=item B<scrollBar:> I<boolean>	896	=item B<scrollBar:> I<boolean>
883		897
884	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	898	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
885	disable the scrollbar; option B<+sb>.	899	disable the scrollbar; option B<+sb>.
…		…
1084		1098
1085	=item B<secondaryScroll:> I<boolean>	1099	=item B<secondaryScroll:> I<boolean>
1086		1100
1087	Turn on/off secondary screen scroll (default enabled). If this	1101	Turn on/off secondary screen scroll (default enabled). If this
1088	option is enabled, scrolls on the secondary screen will change the	1102	option is enabled, scrolls on the secondary screen will change the
1089	scrollback buffer and switching to/from the secondary screen will	1103	scrollback buffer and, when secondaryScreen is off, switching
1090	instead scroll the screen up.	1104	to/from the secondary screen will instead scroll the screen up.
1091		1105
1092	=item B<hold>: I<boolean>	1106	=item B<hold>: I<boolean>
1093		1107
1094	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1108	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1095	will not immediately destroy its window when the program executed within	1109	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	1110	it exits. Instead, it will wait till it is being killed or closed by the
1097	user.	1111	user.
		1112
		1113	=item B<chdir>: I<path>
		1114
		1115	Sets the working directory for the shell (or the command specified via
		1116	B<-e>). The I<path> must be an absolute path and it must exist for
		1117	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1118	directory will be used; option B<-cd>.
1098		1119
1099	=item B<keysym.>I<sym>: I<string>	1120	=item B<keysym.>I<sym>: I<string>
1100		1121
1101	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1122	Compile I<frills>: Associate I<string> with keysym I<sym>. The
1102	intervening resource name B<keysym.> cannot be omitted.	1123	intervening resource name B<keysym.> cannot be omitted.
…		…
1209	all instances, while B<perl-ext> is used for specific instances.	1230	all instances, while B<perl-ext> is used for specific instances.
1210		1231
1211	=item B<perl-eval>: I<string>	1232	=item B<perl-eval>: I<string>
1212		1233
1213	Perl code to be evaluated when all extensions have been registered. See	1234	Perl code to be evaluated when all extensions have been registered. See
1214	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource	1235	the @@RXVT_NAME@@perl(3) manpage.
1215	will be ignored when running setuid/setgid.
1216		1236
1217	=item B<perl-lib>: I<path>	1237	=item B<perl-lib>: I<path>
1218		1238
1219	Colon-separated list of additional directories that hold extension	1239	Colon-separated list of additional directories that hold extension
1220	scripts. When looking for extensions specified by the C<perl> resource,	1240	scripts. When looking for extensions specified by the C<perl> resource,
1221	@@RXVT_NAME@@ will first look in these directories and then in	1241	@@RXVT_NAME@@ will first look in these directories and then in
1222	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1242	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1223	will be ignored when running setuid/setgid.
1224		1243
1225	See the @@RXVT_NAME@@perl(3) manpage.	1244	See the @@RXVT_NAME@@perl(3) manpage.
1226		1245
1227	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1246	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1228		1247
…		…
1463	=back	1482	=back
1464		1483
1465	=head2 ALPHA CHANNEL SUPPORT	1484	=head2 ALPHA CHANNEL SUPPORT
1466		1485
1467	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1486	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>	1487	their act together, rxvt-unicode will do it's own alpha channel management:
1469	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1488
1470	in addition to the ones provided by X, where the additional A component	1489	You can prefix any color with an opaquenes percentage enclosed in
		1490	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1491	(0-100) that specifies the opacity of the color, where C<0> is completely
		1492	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1493	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1494	is the recommended format to specify transparency values, and works with
		1495	all ways to specify a colour.
		1496
		1497	For complete control, rxvt-unicode also supports
		1498	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1499	specifications, where the additional C<aaaa> component specifies opacity
1471	specifies opacity (alpha) values. The minimum value of C<0> is completely	1500	(alpha) values. The minimum value of C<0000> is completely transparent,
1472	transparent). You can also prefix any color with C<[percent]>, where	1501	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	1502	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	1503	C<rgba:0000/ff00/0000/f332>.
1475	opaque.
1476		1504
1477	You probably need to specify B<"-depth 32">, too, and have the luck that	1505	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	1506	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.	1507	layout, as X is far from just supporting ARGB visuals out of the box, and
		1508	rxvt-unicode just fudges around.
1480		1509
1481	For example, the following selects an almost completely transparent red	1510	For example, the following selects an almost completely transparent black
1482	background, and an almost opaque pink foreground:	1511	background, and an almost opaque pink foreground:
1483		1512
1484	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"	1513	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1485		1514
1486	I<Please note that transparency of any kind if completely unsupported by	1515	When not using a background image, then the interpretation of the
1487	the author. Don't bug him with installation questions!>	1516	alpha channel is up to your compositing manager (most interpret it as
		1517	transparency of course).
		1518
		1519	When using a background pixmap or pseudo-transparency, then the background
		1520	colour will always behave as if it were completely transparent (so the
		1521	background image shows instead), regardless of how it was specified, while
		1522	other colours will either be transparent as specified (the background
		1523	image will show through) on servers supporting the RENDER extension, or
		1524	fully opaque on servers not supporting the RENDER EXTENSION.
		1525
		1526	Please note that due to bugs in Xft, specifying alpha values might result
		1527	in garbage being displayed when the X-server does not support the RENDER
		1528	extension.
1488		1529
1489	=head1 ENVIRONMENT	1530	=head1 ENVIRONMENT
1490		1531
1491	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1532	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1492		1533
…		…
1526	C<--with-terminfo=PATH>.	1567	C<--with-terminfo=PATH>.
1527		1568
1528	=item B<DISPLAY>	1569	=item B<DISPLAY>
1529		1570
1530	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1571	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1531	display in its child processes.	1572	display in its child processes if C<-display> isn't used to override. It
		1573	defaults to C<:0> if it doesn't exist.
1532		1574
1533	=item B<SHELL>	1575	=item B<SHELL>
1534		1576
1535	The shell to be used for command execution, defaults to C</bin/sh>.	1577	The shell to be used for command execution, defaults to C</bin/sh>.
1536		1578

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.153 by root, Wed Dec 12 19:57:13 2007 UTC vs. Revision 1.167 by root, Wed Oct 15 14:48:22 2008 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.153 by root, Wed Dec 12 19:57:13 2007 UTC vs.
Revision 1.167 by root, Wed Oct 15 14:48:22 2008 UTC