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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.139 by ayin, Wed Oct 17 13:53:42 2007 UTC vs.
Revision 1.161 by ayin, Sat Jan 26 14:24:42 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
…		…
30	like mongolian or scripts requiring extremely complex combining rules,	33	like mongolian or scripts requiring extremely complex combining rules,
31	like tibetan or devanagari. Don't expect pretty output when using these	34	like tibetan or devanagari. Don't expect pretty output when using these
32	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work	35	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
33	fine, though. A somewhat difficult case are right-to-left scripts, such	36	fine, though. A somewhat difficult case are right-to-left scripts, such
34	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms	37	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
35	belong into the application, not the terminal emulator (too many things --	38	belong in the application, not the terminal emulator (too many things --
36	such as cursor-movement while editing -- break otherwise), but that might	39	such as cursor-movement while editing -- break otherwise), but that might
37	change.	40	change.
38		41
39	If you are looking for a terminal that supports more exotic scripts, let	42	If you are looking for a terminal that supports more exotic scripts, let
40	me recommend C<mlterm>, which is a very user friendly, lean and clean	43	me recommend C<mlterm>, which is a very user friendly, lean and clean
…		…
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>
…		…
114		122
115	=item B<-ss>\|B<+ss>	123	=item B<-ss>\|B<+ss>
116		124
117	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.	125	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
118		126
119	=item B<-ip>\|B<+ip> \| B<-tr>\|B<+tr>	127	=item B<-tr>\|B<+tr>
120		128
121	Turn on/off inheriting parent window's pixmap. Alternative form is	129	Turn on/off illusion of a transparent window background; resource B<transparent>.
122	B<-tr>; resource B<inheritPixmap>.
123		130
		131	B<-ip> is still accepted as an obsolete alias but will be removed in
		132	future versions.
		133
124	I<Please address all transparency related issues to Sasha Vasko at	134	I<Please address all transparency related issues to Sasha Vasko at
125	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>	135	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
126		136
127	=item B<-fade> I<number>	137	=item B<-fade> I<number>
128		138
129	Fade the text by the given percentage when focus is lost. Small values	139	Fade the text by the given percentage when focus is lost. Small values
…		…
136	is opaque black. resource B<fadeColor>.	146	is opaque black. resource B<fadeColor>.
137		147
138	=item B<-tint> I<colour>	148	=item B<-tint> I<colour>
139		149
140	Tint the transparent background pixmap with the given colour when	150	Tint the transparent background pixmap with the given colour when
141	transparency is enabled with B<-tr> or B<-ip>. This only works for	151	transparency is enabled with B<-tr>. This only works for
142	non-tiled backgrounds, currently. See also the B<-sh> option that can be	152	non-tiled backgrounds, currently. See also the B<-sh> option that can be
143	used to brighten or darken the image in addition to tinting it.	153	used to brighten or darken the image in addition to tinting it.
144	Please note that certain tint colours can be applied on the server-side,	154	Please note that certain tint colours can be applied on the server-side,
145	thus yielding performance gain of two orders of magnitude. These colours are:	155	thus yielding performance gain of two orders of magnitude. These colours are:
146	blue, red, green, cyan, magenta, yellow, and those close to them; resource	156	blue, red, green, cyan, magenta, yellow, and those close to them. Also
		157	pure black and pure white colors essentially mean no tinting; resource
147	I<tintColor>. Example:	158	I<tintColor>. Example:
148		159
149	@@RXVT_NAME@@ -tr -tint blue -sh 40	160	@@RXVT_NAME@@ -tr -tint blue -sh 40
150		161
151	=item B<-sh> I<number>	162	=item B<-sh> I<number>
152		163
153	Darken (0 .. 100) or lighten (-1 .. -100) the transparent	164	Darken (0 .. 100) or lighten (100 .. 200) the transparent
154	background image in addition to (or instead of) tinting it;	165	background image in addition to (or instead of) tinting it;
155	resource I<shading>.	166	resource I<shading>.
156		167
157	=item B<-blt> I<string>	168	=item B<-blt> I<string>
158		169
…		…
160	at the same time as transparency - such pixmap will be blended over	171	at the same time as transparency - such pixmap will be blended over
161	transparency image, using method specified. Supported values are :	172	transparency image, using method specified. Supported values are :
162	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,	173	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
163	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,	174	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
164	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is	175	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
165	alpha-blending; resource I<blendType>.	176	alpha-blending. Compile I<afterimage>; resource I<blendType>.
166		177
167	=item B<-blr> I<HxV>	178	=item B<-blr> I<HxV>
168		179
169	Apply Gaussian Blur with the specified radii to the transparent	180	Apply Gaussian Blur with the specified radii to the transparent
170	background image. If single number is specified - both vertical and	181	background image. If single number is specified - both vertical and
171	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
172	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
173	on some backgrounds. Maximum radius value is 128; resource I<blurRadius>.	184	on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
		185	resource I<blurRadius>.
174		186
175	=item B<-bg> I<colour>	187	=item B<-bg> I<colour>
176		188
177	Window background colour; resource B<background>.	189	Window background colour; resource B<background>.
178		190
179	=item B<-fg> I<colour>	191	=item B<-fg> I<colour>
180		192
181	Window foreground colour; resource B<foreground>.	193	Window foreground colour; resource B<foreground>.
182		194
183	=item B<-pixmap> I<file[;geom]>	195	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
184		196
185	Compile I<afterimage>: Specify image file for the background and also	197	Compile I<afterimage>: Specify image file for the background and also
186	optionally specify its scaling with a geometry string. Note you may need to	198	optionally specify its scaling with a geometry string. Note you may need to
187	add quotes to avoid special shell interpretation of the C<;> in the	199	add quotes to avoid special shell interpretation of the C<;> in the
188	command-line; for more details see resource B<backgroundPixmap>.	200	command-line; for more details see resource B<backgroundPixmap>.
189		201
190	=item B<-cr> I<colour>	202	=item B<-cr> I<colour>
…		…
238	italic> >> characters are to be printed. See resource B<boldItalicFont>	250	italic> >> characters are to be printed. See resource B<boldItalicFont>
239	for details.	251	for details.
240		252
241	=item B<-is>\|B<+is>	253	=item B<-is>\|B<+is>
242		254
243	Compile I<font-styles>: Bold/Italic font styles imply high intensity	255	Compile I<font-styles>: Bold/Blink font styles imply high intensity
244	foreground/background (default). See resource B<intensityStyles> for	256	foreground/background (default). See resource B<intensityStyles> for
245	details.	257	details.
246		258
247	=item B<-name> I<name>	259	=item B<-name> I<name>
248		260
…		…
266		278
267	=item B<-sb>\|B<+sb>	279	=item B<-sb>\|B<+sb>
268		280
269	Turn on/off scrollbar; resource B<scrollBar>.	281	Turn on/off scrollbar; resource B<scrollBar>.
270		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
271	=item B<-si>\|B<+si>	292	=item B<-si>\|B<+si>
272		293
273	Turn on/off scroll-to-bottom on TTY output inhibit; resource	294	Turn on/off scroll-to-bottom on TTY output inhibit; resource
274	B<scrollTtyOutput> has opposite effect.	295	B<scrollTtyOutput> has opposite effect.
275		296
…		…
281	=item B<-sw>\|B<+sw>	302	=item B<-sw>\|B<+sw>
282		303
283	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.
284	This only takes effect if B<-si> is also given; resource	305	This only takes effect if B<-si> is also given; resource
285	B<scrollWithBuffer>.	306	B<scrollWithBuffer>.
286
287	=item B<-sr>\|B<+sr>
288
289	Put scrollbar on right/left; resource B<scrollBar_right>.
290
291	=item B<-st>\|B<+st>
292
293	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
294	resource B<scrollBar_floating>.
295		307
296	=item B<-ptab>\|B<+ptab>	308	=item B<-ptab>\|B<+ptab>
297		309
298	If enabled (default), "Horizontal Tab" characters are being stored as	310	If enabled (default), "Horizontal Tab" characters are being stored as
299	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
…		…
411		423
412	=item B<-tcw>	424	=item B<-tcw>
413		425
414	Change the meaning of triple-click selection with the left mouse	426	Change the meaning of triple-click selection with the left mouse
415	button. Only effective when the original (non-perl) selection code is	427	button. Only effective when the original (non-perl) selection code is
416	in-use. Instead of selecting a full line it will extend the selection the	428	in-use. Instead of selecting a full line it will extend the selection to
417	end of the logical line only. resource B<tripleclickwords>.	429	the end of the logical line only. resource B<tripleclickwords>.
418		430
419	=item B<-insecure>	431	=item B<-insecure>
420		432
421	Enable "insecure" mode, which currently enables most of the escape	433	Enable "insecure" mode, which currently enables most of the escape
422	sequences that echo strings. See the resource B<insecure> for more	434	sequences that echo strings. See the resource B<insecure> for more
…		…
442		454
443	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@@
444	will not immediately destroy its window when the program executed within	456	will not immediately destroy its window when the program executed within
445	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
446	user; resource B<hold>.	458	user; resource B<hold>.
		459
		460	=item B<-xrm> I<string>
		461
		462	Works like the X Toolkit option of the same name, by adding the I<string>
		463	as if it were specified in a resource file. Resource values specified this
		464	way take precedence over all other resource specifications.
		465
		466	Note that you need to use the I<same> syntax as in the .Xdefaults file,
		467	e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
		468	options can be specified as long-options on the commandline, so use
		469	of B<-xrm> is mostly limited to cases where you want to specify other
		470	resources (e.g. for input methods) or for compatibility with other
		471	programs.
447		472
448	=item B<-keysym.>I<sym> I<string>	473	=item B<-keysym.>I<sym> I<string>
449		474
450	Remap a key symbol. See resource B<keysym>.	475	Remap a key symbol. See resource B<keysym>.
451		476
…		…
486	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	511	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
487	entries and will not tinker with pty/tty permissions - you have to do that	512	entries and will not tinker with pty/tty permissions - you have to do that
488	yourself if you want that.	513	yourself if you want that.
489		514
490	As an extremely special case, specifying C<-1> will completely suppress	515	As an extremely special case, specifying C<-1> will completely suppress
491	pty/tty operations.	516	pty/tty operations, which is probably only useful in conjunction with some
		517	perl extension that manages the terminal.
492		518
493	Here is a example in perl that illustrates how this option can be used (a	519	Here is a example in perl that illustrates how this option can be used (a
494	longer example is in F<doc/pty-fd>):	520	longer example is in F<doc/pty-fd>):
495		521
496	use IO::Pty;	522	use IO::Pty;
…		…
510	Comma-separated list of perl extension scripts to use (or not to use) in	536	Comma-separated list of perl extension scripts to use (or not to use) in
511	this terminal instance. See resource B<perl-ext> for details.	537	this terminal instance. See resource B<perl-ext> for details.
512		538
513	=back	539	=back
514		540
515	=head1 RESOURCES (available also as long-options)	541	=head1 RESOURCES
516		542
517	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	543	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
518	options) compiled into your version.	544	options) compiled into your version. All resources are also available as
		545	long-options.
519		546
520	You can set and change the resources using X11 tools like B<xrdb>. Many	547	You can set and change the resources using X11 tools like B<xrdb>. Many
521	distribution do also load settings from the B<~/.Xresources> file when X	548	distribution do also load settings from the B<~/.Xresources> file when X
522	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	549	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
523	with later settings overwriting earlier ones:	550	with later settings overwriting earlier ones:
…		…
525	1. system-wide app-defaults file, either locale-dependent OR global	552	1. system-wide app-defaults file, either locale-dependent OR global
526	2. app-defaults file in $XAPPLRESDIR	553	2. app-defaults file in $XAPPLRESDIR
527	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	554	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
528	4. SCREEN_RESOURCES for the current screen	555	4. SCREEN_RESOURCES for the current screen
529	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	556	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		557	6. resources specified via -xrm on the commandline
530		558
531	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	559	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
532	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources	560	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
533	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily	561	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
534	configured, while the class name B<URxvt> allows resources unique to	562	configured, while the class name B<URxvt> allows resources unique to
…		…
544	=item B<depth:> I<bitdepth>	572	=item B<depth:> I<bitdepth>
545		573
546	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;
547	option B<-depth>.	575	option B<-depth>.
548		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
549	=item B<geometry:> I<geom>	584	=item B<geometry:> I<geom>
550		585
551	Create the window with the specified X window geometry [default 80x24];	586	Create the window with the specified X window geometry [default 80x24];
552	option B<-geometry>.	587	option B<-geometry>.
553		588
…		…
636		671
637	B<False>: specify that everything is to be displayed, even	672	B<False>: specify that everything is to be displayed, even
638	if the refresh is too fast for the human eye to read anything (or the	673	if the refresh is too fast for the human eye to read anything (or the
639	monitor to display anything); option B<+ss>.	674	monitor to display anything); option B<+ss>.
640		675
641	=item B<inheritPixmap:> I<boolean>	676	=item B<transparent:> I<boolean>
642		677
643	B<True>: make the background inherit the parent windows' pixmap, giving	678	Turn on/off illusion of a transparent window background.
644	artificial transparency. B<False>: do not inherit the parent windows'
645	pixmap.
646		679
647	I<Please note that transparency of any kind if completely unsupported by	680	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
648	the author. Don't bug him with installation questions!>	681	future versions.
		682
		683	I<Please address all transparency related issues to Sasha Vasko at
		684	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
649		685
650	=item B<fading:> I<number>	686	=item B<fading:> I<number>
651		687
652	Fade the text by the given percentage when focus is lost; option B<-fade>.	688	Fade the text by the given percentage when focus is lost; option B<-fade>.
653		689
…		…
670		706
671	Specify background blending type; option B<-blt>.	707	Specify background blending type; option B<-blt>.
672		708
673	=item B<blurRadius:> I<number>	709	=item B<blurRadius:> I<number>
674		710
675	Apply Gaussian Blurr with the specified radius to the transparent	711	Apply Gaussian Blurr with the specified radius to the transparent
676	background image; option B<-blr>.	712	background image; option B<-blr>.
677		713
678	=item B<scrollColor:> I<colour>	714	=item B<scrollColor:> I<colour>
679		715
680	Use the specified colour for the scrollbar [default #B2B2B2].	716	Use the specified colour for the scrollbar [default #B2B2B2].
…		…
687	=item B<borderColor:> I<colour>	723	=item B<borderColor:> I<colour>
688		724
689	The colour of the border around the text area and between the scrollbar	725	The colour of the border around the text area and between the scrollbar
690	and the text.	726	and the text.
691		727
692	=item B<backgroundPixmap:> I<file[;geom]>	728	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
693		729
694	Use the specified image file for the background and also optionally	730	Use the specified image file for the background and also
695	specify its scaling with a geometry string B<WxH+X+Y>,	731	optionally specify its scaling with a geometry string B<WxH+X+Y>,
696	in which B<"W" / "H"> specify the horizontal/vertical scale (percent),	732	(default C<0x0+50+50>) in which B<"W" / "H"> specify the
697	and B<"X" / "Y"> locate the image centre (percent).	733	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
698	A scale of 0 displays the image with tiling. A scale of 1 displays the	734	centre (percent). A scale of 0 displays the image with tiling. A scale
699	image without any scaling. A scale of 2 to 9 specifies an integer	735	of 1 displays the image without any scaling. A scale of 2 to 9 specifies
700	number of images in that direction. No image will be magnified beyond	736	an integer number of images in that direction. No image will be magnified
701	10 times its original size. The maximum permitted scale is 1000.	737	beyond 10 times its original size. The maximum permitted scale is 1000.
702	Special string of B<"auto"> used as a geometry will cause image to be	738	Additional operations can be specified after colon B<:op1:op2...>.
703	automatically scaled to match window size.	739	Supported operations are:
		740
		741	tile force background image to be tiled and not scaled. Equivalent to 0x0
		742	propscale will scale image keeping proportions
		743	auto will scale image to match window size. Equivalent to 100x100
		744	hscale will scale image horizontally to the window size
		745	vscale will scale image vertically to the window size
		746	scale will scale image to match window size
		747	root will tile image as if it was a root window background, auto-adjusting
		748	whenever terminal window moves
		749
704	If used in conjunction with B<-tr> option - specified pixmap will be	750	If used in conjunction with B<-tr> option, the specified pixmap will be
705	blended over transparency image using either alpha-blending, or any	751	blended over transparency image using either alpha-blending, or any
706	other blending type, specified with B<-blt "type"> option.	752	other blending type, specified with B<-blt "type"> option.
707	[default 0x0+50+50]
708		753
709	=item B<path:> I<path>	754	=item B<path:> I<path>
710		755
711	Specify the colon-delimited search path for finding background image files.	756	Specify the colon-delimited search path for finding background image files.
712		757
…		…
773	text font will being used for the given style.	818	text font will being used for the given style.
774		819
775	=item B<intensityStyles:> I<boolean>	820	=item B<intensityStyles:> I<boolean>
776		821
777	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>,
778	option B<-is>, the default), bold and italic font styles imply high	823	option B<-is>, the default), bold/blink font styles imply high
779	intensity foreground/background colours. Disabling this option (B<False>,	824	intensity foreground/background colours. Disabling this option (B<False>,
780	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
781	reachable.	826	reachable.
782		827
783	=item B<selectstyle:> I<mode>
784
785	Set mouse selection style to B<old> which is 2.20, B<oldword> which
786	is xterm style with 2.20 old word selection, or anything else which
787	gives xterm style selection. Only effective when the original (non-perl)
788	selection code is in use.
789
790	=item B<scrollstyle:> I<mode>
791
792	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
793	the author's favourite.
794
795	=item B<title:> I<string>	828	=item B<title:> I<string>
796		829
797	Set window title string, the default title is the command-line	830	Set window title string, the default title is the command-line
798	specified after the B<-e> option, if any, otherwise the application	831	specified after the B<-e> option, if any, otherwise the application
799	name; option B<-title>.	832	name; option B<-title>.
…		…
843		876
844	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	877	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
845		878
846	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
847	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.
848		886
849	=item B<scrollBar:> I<boolean>	887	=item B<scrollBar:> I<boolean>
850		888
851	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	889	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
852	disable the scrollbar; option B<+sb>.	890	disable the scrollbar; option B<+sb>.
…		…
985	will be created). In this mode, characters outside ISO-8859-1 can be used.	1023	will be created). In this mode, characters outside ISO-8859-1 can be used.
986		1024
987	When the selection extension is not used, only ISO-8859-1 characters can	1025	When the selection extension is not used, only ISO-8859-1 characters can
988	be used. If not specified, the built-in default is used:	1026	be used. If not specified, the built-in default is used:
989		1027
990	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	1028	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
991		1029
992	=item B<preeditType:> I<style>	1030	=item B<preeditType:> I<style>
993		1031
994	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1032	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
995		1033
…		…
1430	=back	1468	=back
1431		1469
1432	=head2 ALPHA CHANNEL SUPPORT	1470	=head2 ALPHA CHANNEL SUPPORT
1433		1471
1434	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
1435	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:
1436	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1474
1437	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
1438	specifies opacity (alpha) values. The minimum value of C<0> is completely	1486	(alpha) values. The minimum value of C<0000> is completely transparent,
1439	transparent). You can also prefix any color with C<[percent]>, where	1487	while C<ffff> is completely opaque). The two example colours from
1440	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
1441	the color, where C<0> is completely transparent and C<100> is completelxy	1489	C<rgba:0000/ff00/0000/f332>.
1442	opaque.
1443		1490
1444	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
1445	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
1446	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.
1447		1495
1448	For example, the following selects an almost completely transparent red	1496	For example, the following selects an almost completely transparent black
1449	background, and an almost opaque pink foreground:	1497	background, and an almost opaque pink foreground:
1450		1498
1451	@@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"
1452		1500
1453	I<Please note that transparency of any kind if completely unsupported by	1501	When not using a background image, then the interpretation of the
1454	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.
1455		1515
1456	=head1 ENVIRONMENT	1516	=head1 ENVIRONMENT
1457		1517
1458	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1518	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1459		1519
…		…
1465	resources or on the command line.	1525	resources or on the command line.
1466		1526
1467	=item B<COLORTERM>	1527	=item B<COLORTERM>
1468		1528
1469	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was	1529	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1470	compiled with background image support, and optionally with the added	1530	compiled with background image support, and optionally with the added
1471	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome	1531	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1472	screen.	1532	screen.
1473		1533
1474	=item B<COLORFGBG>	1534	=item B<COLORFGBG>
1475		1535
1476	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1536	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1477	the colour code used as default foreground/text colour (or the string	1537	the colour code used as default foreground/text colour (or the string
1478	C<default> to indicate that the default-colour escape sequence is to be	1538	C<default> to indicate that the default-colour escape sequence is to be
1479	used), C<bg> is the colour code used as default background colour (or the	1539	used), C<bg> is the colour code used as default background colour (or the
1480	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1540	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1481	was compiled with background image support. Libraries like C<ncurses>	1541	was compiled with background image support. Libraries like C<ncurses>
1482	and C<slang> can (and do) use this information to optimize screen output.	1542	and C<slang> can (and do) use this information to optimize screen output.
1483		1543
1484	=item B<WINDOWID>	1544	=item B<WINDOWID>
1485		1545
1486	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1546	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
…		…
1578	Project Coordinator (changes.txt 2.21a to 2.4.5)	1638	Project Coordinator (changes.txt 2.21a to 2.4.5)
1579		1639
1580	=item Geoff Wing L<< <gcw@pobox.com> >>	1640	=item Geoff Wing L<< <gcw@pobox.com> >>
1581		1641
1582	Rewrote screen display and text selection routines.	1642	Rewrote screen display and text selection routines.
1583		1643
1584	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1644	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1585		1645
1586	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1646	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1587		1647
1588	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1648	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.139 by ayin, Wed Oct 17 13:53:42 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.139 by ayin, Wed Oct 17 13:53:42 2007 UTC vs.
Revision 1.161 by ayin, Sat Jan 26 14:24:42 2008 UTC