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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.130 by sasha, Fri Jun 8 20:04:12 2007 UTC vs.
Revision 1.160 by root, Fri Jan 25 18:42:23 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
28	world. Being a terminal emulator, however, some things are very difficult,	31	world. Being a terminal emulator, however, some things are very difficult,
29	especially cursive scripts such as arabic, vertically written scripts	32	especially cursive scripts such as arabic, vertically written scripts
30	like mongolian or scripts requiring extremely complex combining rules,	33	like mongolian or scripts requiring extremely complex combining rules,
31	like tibetan or devenagari. 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>
108		116
109	Turn on/off simulated reverse video; resource B<reverseVideo>.	117	Turn on/off simulated reverse video; resource B<reverseVideo>.
110		118
111	=item B<-j>\|B<+j>	119	=item B<-j>\|B<+j>
112		120
113	Turn on/off jump scrolling; resource B<jumpScroll>.	121	Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
114		122
115	=item B<-ip>\|B<+ip> \| B<-tr>\|B<+tr>	123	=item B<-ss>\|B<+ss>
116		124
117	Turn on/off inheriting parent window's pixmap. Alternative form is	125	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
118	B<-tr>; resource B<inheritPixmap>.
119		126
120	I<Please note that transparency of any kind if completely unsupported by	127	=item B<-tr>\|B<+tr>
121	the author. Don't bug him with installation questions! Read the FAQ (man 7	128
122	@@RXVT_NAME@@)!>	129	Turn on/off illusion of a transparent window background; resource B<transparent>.
		130
		131	B<-ip> is still accepted as an obsolete alias but will be removed in
		132	future versions.
		133
		134	I<Please address all transparency related issues to Sasha Vasko at
		135	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
123		136
124	=item B<-fade> I<number>	137	=item B<-fade> I<number>
125		138
126	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
127	fade a little only, 100 completely replaces all colours by the fade	140	fade a little only, 100 completely replaces all colours by the fade
…		…
133	is opaque black. resource B<fadeColor>.	146	is opaque black. resource B<fadeColor>.
134		147
135	=item B<-tint> I<colour>	148	=item B<-tint> I<colour>
136		149
137	Tint the transparent background pixmap with the given colour when	150	Tint the transparent background pixmap with the given colour when
138	transparency is enabled with B<-tr> or B<-ip>. This only works for	151	transparency is enabled with B<-tr>. This only works for
139	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
140	used to brighten or darken the image in addition to tinting it; resource	153	used to brighten or darken the image in addition to tinting it.
		154	Please note that certain tint colours can be applied on the server-side,
		155	thus yielding performance gain of two orders of magnitude. These colours are:
		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
141	I<tintColor>. Example:	158	I<tintColor>. Example:
142		159
143	@@RXVT_NAME@@ -tr -tint blue -sh 40	160	@@RXVT_NAME@@ -tr -tint blue -sh 40
144		161
145	=item B<-sh> I<number>	162	=item B<-sh> I<number>
146		163
147	Darken (0 .. 100) or lighten (-1 .. -100) the transparent	164	Darken (0 .. 100) or lighten (100 .. 200) the transparent
148	background image in addition to (or instead of) tinting it;	165	background image in addition to (or instead of) tinting it;
149	resource I<shading>.	166	resource I<shading>.
150		167
151	=item B<-blt> I<string>	168	=item B<-blt> I<string>
152		169
153	Specify background blending type. If background pixmap is specified	170	Specify background blending type. If background pixmap is specified
154	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
155	transparency image, using method specified. Supported values are :	172	transparency image, using method specified. Supported values are :
156	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,	173	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
157	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>,
158	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
159	alpha-blending; resource I<blendType>.	176	alpha-blending. Compile I<afterimage>; resource I<blendType>.
160		177
161	=item B<-blr> I<number>	178	=item B<-blr> I<HxV>
162		179
163	Apply Gaussian Blur with the specified radius to the transparent	180	Apply Gaussian Blur with the specified radii to the transparent
164	background image; resource I<blurRadius>.	181	background image. If single number is specified - both vertical and
		182	horizontal radii are considered to be the same. Setting one of the
		183	radii to 1 and another to a large number creates interesting effects
		184	on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
		185	resource I<blurRadius>.
165		186
166	=item B<-bg> I<colour>	187	=item B<-bg> I<colour>
167		188
168	Window background colour; resource B<background>.	189	Window background colour; resource B<background>.
169		190
170	=item B<-fg> I<colour>	191	=item B<-fg> I<colour>
171		192
172	Window foreground colour; resource B<foreground>.	193	Window foreground colour; resource B<foreground>.
173		194
174	=item B<-pixmap> I<file[;geom]>	195	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
175		196
176	Compile I<afterimage>: Specify image file for the background and also	197	Compile I<afterimage>: Specify image file for the background and also
177	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
178	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
179	command-line; for more details see resource B<backgroundPixmap>.	200	command-line; for more details see resource B<backgroundPixmap>.
180		201
181	=item B<-cr> I<colour>	202	=item B<-cr> I<colour>
…		…
229	italic> >> characters are to be printed. See resource B<boldItalicFont>	250	italic> >> characters are to be printed. See resource B<boldItalicFont>
230	for details.	251	for details.
231		252
232	=item B<-is>\|B<+is>	253	=item B<-is>\|B<+is>
233		254
234	Compile I<font-styles>: Bold/Italic font styles imply high intensity	255	Compile I<font-styles>: Bold/Blink font styles imply high intensity
235	foreground/background (default). See resource B<intensityStyles> for	256	foreground/background (default). See resource B<intensityStyles> for
236	details.	257	details.
237		258
238	=item B<-name> I<name>	259	=item B<-name> I<name>
239		260
…		…
257		278
258	=item B<-sb>\|B<+sb>	279	=item B<-sb>\|B<+sb>
259		280
260	Turn on/off scrollbar; resource B<scrollBar>.	281	Turn on/off scrollbar; resource B<scrollBar>.
261		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
262	=item B<-si>\|B<+si>	292	=item B<-si>\|B<+si>
263		293
264	Turn on/off scroll-to-bottom on TTY output inhibit; resource	294	Turn on/off scroll-to-bottom on TTY output inhibit; resource
265	B<scrollTtyOutput> has opposite effect.	295	B<scrollTtyOutput> has opposite effect.
266		296
…		…
272	=item B<-sw>\|B<+sw>	302	=item B<-sw>\|B<+sw>
273		303
274	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.
275	This only takes effect if B<-si> is also given; resource	305	This only takes effect if B<-si> is also given; resource
276	B<scrollWithBuffer>.	306	B<scrollWithBuffer>.
277
278	=item B<-sr>\|B<+sr>
279
280	Put scrollbar on right/left; resource B<scrollBar_right>.
281
282	=item B<-st>\|B<+st>
283
284	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
285	resource B<scrollBar_floating>.
286		307
287	=item B<-ptab>\|B<+ptab>	308	=item B<-ptab>\|B<+ptab>
288		309
289	If enabled (default), "Horizontal Tab" characters are being stored as	310	If enabled (default), "Horizontal Tab" characters are being stored as
290	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
…		…
337		358
338	=item B<-lsp> I<number>	359	=item B<-lsp> I<number>
339		360
340	Compile I<frills>: Lines (pixel height) to insert between each row of	361	Compile I<frills>: Lines (pixel height) to insert between each row of
341	the display. Useful to work around font rendering problems; resource	362	the display. Useful to work around font rendering problems; resource
342	B<linespace>.	363	B<lineSpace>.
343		364
344	=item B<-tn> I<termname>	365	=item B<-tn> I<termname>
345		366
346	This option specifies the name of the terminal type to be set in the	367	This option specifies the name of the terminal type to be set in the
347	B<TERM> environment variable. This terminal type must exist in the	368	B<TERM> environment variable. This terminal type must exist in the
…		…
402		423
403	=item B<-tcw>	424	=item B<-tcw>
404		425
405	Change the meaning of triple-click selection with the left mouse	426	Change the meaning of triple-click selection with the left mouse
406	button. Only effective when the original (non-perl) selection code is	427	button. Only effective when the original (non-perl) selection code is
407	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
408	end of the logical line only. resource B<tripleclickwords>.	429	the end of the logical line only. resource B<tripleclickwords>.
409		430
410	=item B<-insecure>	431	=item B<-insecure>
411		432
412	Enable "insecure" mode, which currently enables most of the escape	433	Enable "insecure" mode, which currently enables most of the escape
413	sequences that echo strings. See the resource B<insecure> for more	434	sequences that echo strings. See the resource B<insecure> for more
…		…
433		454
434	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@@
435	will not immediately destroy its window when the program executed within	456	will not immediately destroy its window when the program executed within
436	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
437	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.
438		472
439	=item B<-keysym.>I<sym> I<string>	473	=item B<-keysym.>I<sym> I<string>
440		474
441	Remap a key symbol. See resource B<keysym>.	475	Remap a key symbol. See resource B<keysym>.
442		476
…		…
477	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
478	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
479	yourself if you want that.	513	yourself if you want that.
480		514
481	As an extremely special case, specifying C<-1> will completely suppress	515	As an extremely special case, specifying C<-1> will completely suppress
482	pty/tty operations.	516	pty/tty operations, which is probably only useful in conjunction with some
		517	perl extension that manages the terminal.
483		518
484	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
485	longer example is in F<doc/pty-fd>):	520	longer example is in F<doc/pty-fd>):
486		521
487	use IO::Pty;	522	use IO::Pty;
…		…
501	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
502	this terminal instance. See resource B<perl-ext> for details.	537	this terminal instance. See resource B<perl-ext> for details.
503		538
504	=back	539	=back
505		540
506	=head1 RESOURCES (available also as long-options)	541	=head1 RESOURCES
507		542
508	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	543	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
509	options) compiled into your version.	544	options) compiled into your version. All resources are also available as
		545	long-options.
510		546
511	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
512	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
513	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	549	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
514	with later settings overwriting earlier ones:	550	with later settings overwriting earlier ones:
…		…
516	1. system-wide app-defaults file, either locale-dependent OR global	552	1. system-wide app-defaults file, either locale-dependent OR global
517	2. app-defaults file in $XAPPLRESDIR	553	2. app-defaults file in $XAPPLRESDIR
518	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	554	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
519	4. SCREEN_RESOURCES for the current screen	555	4. SCREEN_RESOURCES for the current screen
520	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	556	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		557	6. resources specified via -xrm on the commandline
521		558
522	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
523	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
524	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
525	configured, while the class name B<URxvt> allows resources unique to	562	configured, while the class name B<URxvt> allows resources unique to
…		…
607	option B<-rv>. B<False>: regular screen colours [default]; option	644	option B<-rv>. B<False>: regular screen colours [default]; option
608	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	645	B<+rv>. See note in B<COLORS AND GRAPHICS> section.
609		646
610	=item B<jumpScroll:> I<boolean>	647	=item B<jumpScroll:> I<boolean>
611		648
612	B<True>: specify that jump scrolling should be used. When scrolling	649	B<True>: specify that jump scrolling should be used. When receiving lots
613	quickly, fewer screen updates are performed [default]; option B<-j>.	650	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
		651	has been read, resulting in fewer updates while still displaying every
		652	received line; option B<-j>.
		653
614	B<False>: specify that smooth scrolling should be used; option B<+j>.	654	B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
		655	force a screen refresh on each new line it received; option B<+j>.
615		656
616	=item B<inheritPixmap:> I<boolean>	657	=item B<skipScroll:> I<boolean>
617		658
618	B<True>: make the background inherit the parent windows' pixmap, giving	659	B<True>: (the default) specify that skip scrolling should be used. When
619	artificial transparency. B<False>: do not inherit the parent windows'	660	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
620	pixmap.	661	(around 60 times per second), resulting in far fewer updates. This can
		662	result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
		663	option B<-ss>.
621		664
622	I<Please note that transparency of any kind if completely unsupported by	665	B<False>: specify that everything is to be displayed, even
623	the author. Don't bug him with installation questions!>	666	if the refresh is too fast for the human eye to read anything (or the
		667	monitor to display anything); option B<+ss>.
		668
		669	=item B<transparent:> I<boolean>
		670
		671	Turn on/off illusion of a transparent window background.
		672
		673	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
		674	future versions.
		675
		676	I<Please address all transparency related issues to Sasha Vasko at
		677	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
624		678
625	=item B<fading:> I<number>	679	=item B<fading:> I<number>
626		680
627	Fade the text by the given percentage when focus is lost; option B<-fade>.	681	Fade the text by the given percentage when focus is lost; option B<-fade>.
628		682
…		…
645		699
646	Specify background blending type; option B<-blt>.	700	Specify background blending type; option B<-blt>.
647		701
648	=item B<blurRadius:> I<number>	702	=item B<blurRadius:> I<number>
649		703
650	Apply Gaussian Blurr with the specified radius to the transparent	704	Apply Gaussian Blurr with the specified radius to the transparent
651	background image; option B<-blr>.	705	background image; option B<-blr>.
652		706
653	=item B<scrollColor:> I<colour>	707	=item B<scrollColor:> I<colour>
654		708
655	Use the specified colour for the scrollbar [default #B2B2B2].	709	Use the specified colour for the scrollbar [default #B2B2B2].
…		…
662	=item B<borderColor:> I<colour>	716	=item B<borderColor:> I<colour>
663		717
664	The colour of the border around the text area and between the scrollbar	718	The colour of the border around the text area and between the scrollbar
665	and the text.	719	and the text.
666		720
667	=item B<backgroundPixmap:> I<file[;geom]>	721	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
668		722
669	Use the specified image file for the background and also optionally	723	Use the specified image file for the background and also
670	specify its scaling with a geometry string B<WxH+X+Y>,	724	optionally specify its scaling with a geometry string B<WxH+X+Y>,
671	in which B<"W" / "H"> specify the horizontal/vertical scale (percent),	725	(default C<0x0+50+50>) in which B<"W" / "H"> specify the
672	and B<"X" / "Y"> locate the image centre (percent).	726	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
673	A scale of 0 displays the image with tiling. A scale of 1 displays the	727	centre (percent). A scale of 0 displays the image with tiling. A scale
674	image without any scaling. A scale of 2 to 9 specifies an integer	728	of 1 displays the image without any scaling. A scale of 2 to 9 specifies
675	number of images in that direction. No image will be magnified beyond	729	an integer number of images in that direction. No image will be magnified
676	10 times its original size. The maximum permitted scale is 1000.	730	beyond 10 times its original size. The maximum permitted scale is 1000.
677	Special string of B<"auto"> used as a geometry will cause image to be	731	Additional operations can be specified after colon B<:op1:op2...>.
678	automatically scaled to match window size.	732	Supported operations are:
		733
		734	tile force background image to be tiled and not scaled. Equivalent to 0x0
		735	propscale will scale image keeping proportions
		736	auto will scale image to match window size. Equivalent to 100x100
		737	hscale will scale image horizontally to the window size
		738	vscale will scale image vertically to the window size
		739	scale will scale image to match window size
		740	root will tile image as if it was a root window background, auto-adjusting
		741	whenever terminal window moves
		742
679	If used in conjunction with B<-tr> option - specified pixmap will be	743	If used in conjunction with B<-tr> option, the specified pixmap will be
680	blended over transparency image using either alpha-blending, or any	744	blended over transparency image using either alpha-blending, or any
681	other blending type, specified with B<-blt "type"> option.	745	other blending type, specified with B<-blt "type"> option.
682	[default 0x0+50+50]
683		746
684	=item B<path:> I<path>	747	=item B<path:> I<path>
685		748
686	Specify the colon-delimited search path for finding XPM files.	749	Specify the colon-delimited search path for finding background image files.
687		750
688	=item B<font:> I<fontlist>	751	=item B<font:> I<fontlist>
689		752
690	Select the fonts to be used. This is a comma separated list of font names	753	Select the fonts to be used. This is a comma separated list of font names
691	that are checked in order when trying to find glyphs for characters. The	754	that are checked in order when trying to find glyphs for characters. The
…		…
748	text font will being used for the given style.	811	text font will being used for the given style.
749		812
750	=item B<intensityStyles:> I<boolean>	813	=item B<intensityStyles:> I<boolean>
751		814
752	When font styles are not enabled, or this option is enabled (B<True>,	815	When font styles are not enabled, or this option is enabled (B<True>,
753	option B<-is>, the default), bold and italic font styles imply high	816	option B<-is>, the default), bold/blink font styles imply high
754	intensity foreground/background colours. Disabling this option (B<False>,	817	intensity foreground/background colours. Disabling this option (B<False>,
755	option B<+is>) disables this behaviour, the high intensity colours are not	818	option B<+is>) disables this behaviour, the high intensity colours are not
756	reachable.	819	reachable.
757		820
758	=item B<selectstyle:> I<mode>
759
760	Set mouse selection style to B<old> which is 2.20, B<oldword> which
761	is xterm style with 2.20 old word selection, or anything else which
762	gives xterm style selection. Only effective when the original (non-perl)
763	selection code is in use.
764
765	=item B<scrollstyle:> I<mode>
766
767	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
768	the author's favourite.
769
770	=item B<title:> I<string>	821	=item B<title:> I<string>
771		822
772	Set window title string, the default title is the command-line	823	Set window title string, the default title is the command-line
773	specified after the B<-e> option, if any, otherwise the application	824	specified after the B<-e> option, if any, otherwise the application
774	name; option B<-title>.	825	name; option B<-title>.
…		…
818		869
819	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	870	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
820		871
821	This creates a new file in your home directory with the screen contents	872	This creates a new file in your home directory with the screen contents
822	every time you hit C<Print>.	873	every time you hit C<Print>.
		874
		875	=item B<scrollstyle:> I<mode>
		876
		877	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		878	the author's favourite.
823		879
824	=item B<scrollBar:> I<boolean>	880	=item B<scrollBar:> I<boolean>
825		881
826	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	882	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
827	disable the scrollbar; option B<+sb>.	883	disable the scrollbar; option B<+sb>.
…		…
890	=item B<termName:> I<termname>	946	=item B<termName:> I<termname>
891		947
892	Specifies the terminal type name to be set in the B<TERM> environment	948	Specifies the terminal type name to be set in the B<TERM> environment
893	variable; option B<-tn>.	949	variable; option B<-tn>.
894		950
895	=item B<linespace:> I<number>	951	=item B<lineSpace:> I<number>
896		952
897	Specifies number of lines (pixel height) to insert between each row of	953	Specifies number of lines (pixel height) to insert between each row of
898	the display [default 0]; option B<-lsp>.	954	the display [default 0]; option B<-lsp>.
899		955
900	=item B<meta8:> I<boolean>	956	=item B<meta8:> I<boolean>
…		…
960	will be created). In this mode, characters outside ISO-8859-1 can be used.	1016	will be created). In this mode, characters outside ISO-8859-1 can be used.
961		1017
962	When the selection extension is not used, only ISO-8859-1 characters can	1018	When the selection extension is not used, only ISO-8859-1 characters can
963	be used. If not specified, the built-in default is used:	1019	be used. If not specified, the built-in default is used:
964		1020
965	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	1021	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
966		1022
967	=item B<preeditType:> I<style>	1023	=item B<preeditType:> I<style>
968		1024
969	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1025	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
970		1026
…		…
1058	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1114	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1059	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1115	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1060	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1116	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1061	performed in an exact manner; however, the closest match is assured.	1117	performed in an exact manner; however, the closest match is assured.
1062		1118
1063	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1119	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1064	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1120	number), see RESOURCES in C<man 7 X> for futher details.
1065	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1066	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1067	can start or end with whitespace. B<This feature is deprecated and will
1068	be removed>.
1069
1070	Please note that you need to double the C<\> in resource files, as
1071	Xlib itself does its own de-escaping (you can use C<\033> instead of
1072	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1073	processing).
1074		1121
1075	You can define a range of keysyms in one shot by providing a I<string>	1122	You can define a range of keysyms in one shot by providing a I<string>
1076	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1123	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1077	should be a character not used by the strings.	1124	should be a character not used by the strings.
1078		1125
…		…
1202	=item B<override-redirect>: I<boolean>	1249	=item B<override-redirect>: I<boolean>
1203		1250
1204	Compile I<frills>: Sets override-redirect for the terminal window, making	1251	Compile I<frills>: Sets override-redirect for the terminal window, making
1205	it almost invisible to window managers; option B<-override-redirect>.	1252	it almost invisible to window managers; option B<-override-redirect>.
1206		1253
		1254	=item B<iso14755_52:> I<boolean>
		1255
		1256	Turn on/off ISO 14755 5.2 mode (default enabled).
		1257
1207	=back	1258	=back
1208		1259
1209	=head1 THE SCROLLBAR	1260	=head1 THE SCROLLBAR
1210		1261
1211	Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window	1262	Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window
…		…
1281		1332
1282	=head1 ISO 14755 SUPPORT	1333	=head1 ISO 14755 SUPPORT
1283		1334
1284	ISO 14755 is a standard for entering and viewing unicode characters	1335	ISO 14755 is a standard for entering and viewing unicode characters
1285	and character codes using the keyboard. It consists of 4 parts. The	1336	and character codes using the keyboard. It consists of 4 parts. The
1286	first part is available rxvt-unicode has been compiled with	1337	first part is available if rxvt-unicode has been compiled with
1287	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1338	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1288	with C<--enable-iso14755>.	1339	with C<--enable-iso14755>.
1289		1340
1290	=over 4	1341	=over 4
1291		1342
…		…
1410	=back	1461	=back
1411		1462
1412	=head2 ALPHA CHANNEL SUPPORT	1463	=head2 ALPHA CHANNEL SUPPORT
1413		1464
1414	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1465	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1415	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>	1466	their act together, rxvt-unicode will do it's own alpha channel management:
1416	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1467
1417	in addition to the ones provided by X, where the additional A component	1468	You can prefix any color with an opaquenes percentage enclosed in
		1469	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1470	(0-100) that specifies the opacity of the color, where C<0> is completely
		1471	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1472	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1473	is the recommended format to specify transparency values, and works with
		1474	all ways to specify a colour.
		1475
		1476	For complete control, rxvt-unicode also supports
		1477	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1478	specifications, where the additional C<aaaa> component specifies opacity
1418	specifies opacity (alpha) values. The minimum value of C<0> is completely	1479	(alpha) values. The minimum value of C<0000> is completely transparent,
1419	transparent). You can also prefix any color with C<[percent]>, where	1480	while C<ffff> is completely opaque). The two example colours from
1420	C<percent> is a decimal percentage (0-100) that specifies the opacity of	1481	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1421	the color, where C<0> is completely transparent and C<100> is completelxy	1482	C<rgba:0000/ff00/0000/f332>.
1422	opaque.
1423		1483
1424	You probably need to specify B<"-depth 32">, too, and have the luck that	1484	You probably need to specify B<"-depth 32">, too, to force a visual with
1425	your X-server uses ARGB pixel layout, as X is far from just supporting	1485	alpha channels, and have the luck that your X-server uses ARGB pixel
1426	ARGB visuals out of the box, and rxvt-unicode just fudges around.	1486	layout, as X is far from just supporting ARGB visuals out of the box, and
		1487	rxvt-unicode just fudges around.
1427		1488
1428	For example, the following selects an almost completely transparent red	1489	For example, the following selects an almost completely transparent black
1429	background, and an almost opaque pink foreground:	1490	background, and an almost opaque pink foreground:
1430		1491
1431	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"	1492	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1432		1493
1433	I<Please note that transparency of any kind if completely unsupported by	1494	When not using a background image, then the interpretation of the
1434	the author. Don't bug him with installation questions!>	1495	alpha channel is up to your compositing manager (most interpret it as
		1496	transparency of course).
		1497
		1498	When using a background pixmap or pseudo-transparency, then the background
		1499	colour will always behave as if it were completely transparent (so the
		1500	background image shows instead), regardless of how it was specified, while
		1501	other colours will either be transparent as specified (the background
		1502	image will show through) on servers supporting the RENDER extension, or
		1503	fully opaque on servers not supporting the RENDER EXTENSION.
		1504
		1505	Please note that due to bugs in Xft, specifying alpha values might result
		1506	in garbage being displayed when the X-server does not support the RENDER
		1507	extension.
1435		1508
1436	=head1 ENVIRONMENT	1509	=head1 ENVIRONMENT
1437		1510
1438	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1511	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1439		1512
…		…
1445	resources or on the command line.	1518	resources or on the command line.
1446		1519
1447	=item B<COLORTERM>	1520	=item B<COLORTERM>
1448		1521
1449	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was	1522	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1450	compiled with XPM support, and optionally with the added extension	1523	compiled with background image support, and optionally with the added
1451	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1524	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1525	screen.
1452		1526
1453	=item B<COLORFGBG>	1527	=item B<COLORFGBG>
1454		1528
1455	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1529	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1456	the colour code used as default foreground/text colour (or the string	1530	the colour code used as default foreground/text colour (or the string
1457	C<default> to indicate that the default-colour escape sequence is to be	1531	C<default> to indicate that the default-colour escape sequence is to be
1458	used), C<bg> is the colour code used as default background colour (or the	1532	used), C<bg> is the colour code used as default background colour (or the
1459	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1533	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1460	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can	1534	was compiled with background image support. Libraries like C<ncurses>
1461	(and do) use this information to optimize screen output.	1535	and C<slang> can (and do) use this information to optimize screen output.
1462		1536
1463	=item B<WINDOWID>	1537	=item B<WINDOWID>
1464		1538
1465	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1539	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1466	window, which usually has subwindows for the scrollbar, the terminal	1540	window, which usually has subwindows for the scrollbar, the terminal
…		…
1557	Project Coordinator (changes.txt 2.21a to 2.4.5)	1631	Project Coordinator (changes.txt 2.21a to 2.4.5)
1558		1632
1559	=item Geoff Wing L<< <gcw@pobox.com> >>	1633	=item Geoff Wing L<< <gcw@pobox.com> >>
1560		1634
1561	Rewrote screen display and text selection routines.	1635	Rewrote screen display and text selection routines.
1562		1636
1563	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1637	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1564		1638
1565	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1639	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1566		1640
1567	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1641	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.130 by sasha, Fri Jun 8 20:04:12 2007 UTC vs. Revision 1.160 by root, Fri Jan 25 18:42:23 2008 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.130 by sasha, Fri Jun 8 20:04:12 2007 UTC vs.
Revision 1.160 by root, Fri Jan 25 18:42:23 2008 UTC