[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.165 by root, Thu Oct 2 17:06:50 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
…		…
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
…		…
332		340
333	=item B<-bl>	341	=item B<-bl>
334		342
335	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.
336	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
337	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.
338		347
339	=item B<-override-redirect>	348	=item B<-override-redirect>
340		349
341	Compile I<frills>: Sets override-redirect on the window; resource	350	Compile I<frills>: Sets override-redirect on the window; resource
342	B<override-redirect>.	351	B<override-redirect>.
…		…
446		455
447	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@@
448	will not immediately destroy its window when the program executed within	457	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	458	it exits. Instead, it will wait till it is being killed or closed by the
450	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>.
451		466
452	=item B<-xrm> I<string>	467	=item B<-xrm> I<string>
453		468
454	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>
455	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
…		…
564	=item B<depth:> I<bitdepth>	579	=item B<depth:> I<bitdepth>
565		580
566	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;
567	option B<-depth>.	582	option B<-depth>.
568		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
569	=item B<geometry:> I<geom>	591	=item B<geometry:> I<geom>
570		592
571	Create the window with the specified X window geometry [default 80x24];	593	Create the window with the specified X window geometry [default 80x24];
572	option B<-geometry>.	594	option B<-geometry>.
573		595
…		…
721	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
722	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.
723	Additional operations can be specified after colon B<:op1:op2...>.	745	Additional operations can be specified after colon B<:op1:op2...>.
724	Supported operations are:	746	Supported operations are:
725		747
726	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
727	propscale will scale image keeping proportions,	749	propscale will scale image keeping proportions
728	auto will scale image to match window size. Equivalent to 100x100;	750	auto will scale image to match window size. Equivalent to 100x100
729	hscale will scale image horizontally to the window size;	751	hscale will scale image horizontally to the window size
730	vscale will scale image vertically to the window size;	752	vscale will scale image vertically to the window size
731	scale will scale image to match window size;	753	scale will scale image to match window size
732	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
733	whenever terminal window moves.	755	whenever terminal window moves
734		756
735	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
736	blended over transparency image using either alpha-blending, or any	758	blended over transparency image using either alpha-blending, or any
737	other blending type, specified with B<-blt "type"> option.	759	other blending type, specified with B<-blt "type"> option.
738		760
…		…
803	text font will being used for the given style.	825	text font will being used for the given style.
804		826
805	=item B<intensityStyles:> I<boolean>	827	=item B<intensityStyles:> I<boolean>
806		828
807	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>,
808	option B<-is>, the default), bold and italic font styles imply high	830	option B<-is>, the default), bold/blink font styles imply high
809	intensity foreground/background colours. Disabling this option (B<False>,	831	intensity foreground/background colours. Disabling this option (B<False>,
810	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
811	reachable.	833	reachable.
812		834
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>	835	=item B<title:> I<string>
826		836
827	Set window title string, the default title is the command-line	837	Set window title string, the default title is the command-line
828	specified after the B<-e> option, if any, otherwise the application	838	specified after the B<-e> option, if any, otherwise the application
829	name; option B<-title>.	839	name; option B<-title>.
…		…
873		883
874	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	884	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
875		885
876	This creates a new file in your home directory with the screen contents	886	This creates a new file in your home directory with the screen contents
877	every time you hit C<Print>.	887	every time you hit C<Print>.
		888
		889	=item B<scrollstyle:> I<mode>
		890
		891	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		892	the author's favourite.
878		893
879	=item B<scrollBar:> I<boolean>	894	=item B<scrollBar:> I<boolean>
880		895
881	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	896	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
882	disable the scrollbar; option B<+sb>.	897	disable the scrollbar; option B<+sb>.
…		…
1081		1096
1082	=item B<secondaryScroll:> I<boolean>	1097	=item B<secondaryScroll:> I<boolean>
1083		1098
1084	Turn on/off secondary screen scroll (default enabled). If this	1099	Turn on/off secondary screen scroll (default enabled). If this
1085	option is enabled, scrolls on the secondary screen will change the	1100	option is enabled, scrolls on the secondary screen will change the
1086	scrollback buffer and switching to/from the secondary screen will	1101	scrollback buffer and, when secondaryScreen is off, switching
1087	instead scroll the screen up.	1102	to/from the secondary screen will instead scroll the screen up.
1088		1103
1089	=item B<hold>: I<boolean>	1104	=item B<hold>: I<boolean>
1090		1105
1091	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1106	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1092	will not immediately destroy its window when the program executed within	1107	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	1108	it exits. Instead, it will wait till it is being killed or closed by the
1094	user.	1109	user.
		1110
		1111	=item B<chdir>: I<path>
		1112
		1113	Sets the working directory for the shell (or the command specified via
		1114	B<-e>). The I<path> must be an absolute path and it must exist for
		1115	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1116	directory will be used; option B<-cd>.
1095		1117
1096	=item B<keysym.>I<sym>: I<string>	1118	=item B<keysym.>I<sym>: I<string>
1097		1119
1098	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1120	Compile I<frills>: Associate I<string> with keysym I<sym>. The
1099	intervening resource name B<keysym.> cannot be omitted.	1121	intervening resource name B<keysym.> cannot be omitted.
…		…
1460	=back	1482	=back
1461		1483
1462	=head2 ALPHA CHANNEL SUPPORT	1484	=head2 ALPHA CHANNEL SUPPORT
1463		1485
1464	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
1465	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:
1466	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1488
1467	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
1468	specifies opacity (alpha) values. The minimum value of C<0> is completely	1500	(alpha) values. The minimum value of C<0000> is completely transparent,
1469	transparent). You can also prefix any color with C<[percent]>, where	1501	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	1502	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	1503	C<rgba:0000/ff00/0000/f332>.
1472	opaque.
1473		1504
1474	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
1475	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
1476	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.
1477		1509
1478	For example, the following selects an almost completely transparent red	1510	For example, the following selects an almost completely transparent black
1479	background, and an almost opaque pink foreground:	1511	background, and an almost opaque pink foreground:
1480		1512
1481	@@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"
1482		1514
1483	I<Please note that transparency of any kind if completely unsupported by	1515	When not using a background image, then the interpretation of the
1484	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.
1485		1529
1486	=head1 ENVIRONMENT	1530	=head1 ENVIRONMENT
1487		1531
1488	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1532	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1489		1533
…		…
1523	C<--with-terminfo=PATH>.	1567	C<--with-terminfo=PATH>.
1524		1568
1525	=item B<DISPLAY>	1569	=item B<DISPLAY>
1526		1570
1527	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
1528	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.
1529		1574
1530	=item B<SHELL>	1575	=item B<SHELL>
1531		1576
1532	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>.
1533		1578

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.165 by root, Thu Oct 2 17:06:50 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.165 by root, Thu Oct 2 17:06:50 2008 UTC