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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.135 by ayin, Wed Aug 1 01:45:06 2007 UTC vs.
Revision 1.158 by root, Wed Jan 23 14:33: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
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
…		…
114		117
115	=item B<-ss>\|B<+ss>	118	=item B<-ss>\|B<+ss>
116		119
117	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.	120	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
118		121
119	=item B<-ip>\|B<+ip> \| B<-tr>\|B<+tr>	122	=item B<-tr>\|B<+tr>
120		123
121	Turn on/off inheriting parent window's pixmap. Alternative form is	124	Turn on/off illusion of a transparent window background; resource B<transparent>.
122	B<-tr>; resource B<inheritPixmap>.
123		125
124	I<Please note that transparency of any kind if completely unsupported by	126	B<-ip> is still accepted as an obsolete alias but will be removed in
125	the author. Don't bug him with installation questions! Read the FAQ (man 7	127	future versions.
126	@@RXVT_NAME@@)!>	128
		129	I<Please address all transparency related issues to Sasha Vasko at
		130	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
127		131
128	=item B<-fade> I<number>	132	=item B<-fade> I<number>
129		133
130	Fade the text by the given percentage when focus is lost. Small values	134	Fade the text by the given percentage when focus is lost. Small values
131	fade a little only, 100 completely replaces all colours by the fade	135	fade a little only, 100 completely replaces all colours by the fade
…		…
137	is opaque black. resource B<fadeColor>.	141	is opaque black. resource B<fadeColor>.
138		142
139	=item B<-tint> I<colour>	143	=item B<-tint> I<colour>
140		144
141	Tint the transparent background pixmap with the given colour when	145	Tint the transparent background pixmap with the given colour when
142	transparency is enabled with B<-tr> or B<-ip>. This only works for	146	transparency is enabled with B<-tr>. This only works for
143	non-tiled backgrounds, currently. See also the B<-sh> option that can be	147	non-tiled backgrounds, currently. See also the B<-sh> option that can be
144	used to brighten or darken the image in addition to tinting it.	148	used to brighten or darken the image in addition to tinting it.
145	Please note that certain tint colours can be applied on the server-side,	149	Please note that certain tint colours can be applied on the server-side,
146	thus yielding performance gain of two orders of magnitude. These colours are:	150	thus yielding performance gain of two orders of magnitude. These colours are:
147	blue, red, green, cyan, magenta, yellow, and those close to them; resource	151	blue, red, green, cyan, magenta, yellow, and those close to them. Also
		152	pure black and pure white colors essentially mean no tinting; resource
148	I<tintColor>. Example:	153	I<tintColor>. Example:
149		154
150	@@RXVT_NAME@@ -tr -tint blue -sh 40	155	@@RXVT_NAME@@ -tr -tint blue -sh 40
151		156
152	=item B<-sh> I<number>	157	=item B<-sh> I<number>
153		158
154	Darken (0 .. 100) or lighten (-1 .. -100) the transparent	159	Darken (0 .. 100) or lighten (100 .. 200) the transparent
155	background image in addition to (or instead of) tinting it;	160	background image in addition to (or instead of) tinting it;
156	resource I<shading>.	161	resource I<shading>.
157		162
158	=item B<-blt> I<string>	163	=item B<-blt> I<string>
159		164
…		…
161	at the same time as transparency - such pixmap will be blended over	166	at the same time as transparency - such pixmap will be blended over
162	transparency image, using method specified. Supported values are :	167	transparency image, using method specified. Supported values are :
163	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,	168	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
164	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,	169	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
165	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is	170	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
166	alpha-blending; resource I<blendType>.	171	alpha-blending. Compile I<afterimage>; resource I<blendType>.
167		172
168	=item B<-blr> I<HxV>	173	=item B<-blr> I<HxV>
169		174
170	Apply Gaussian Blur with the specified radii to the transparent	175	Apply Gaussian Blur with the specified radii to the transparent
171	background image. If single number is specified - both vertical and	176	background image. If single number is specified - both vertical and
172	horizontal radii are considered to be the same. Setting one of the	177	horizontal radii are considered to be the same. Setting one of the
173	radii to 1 and another to a large number creates interesting effects	178	radii to 1 and another to a large number creates interesting effects
174	on some backgrounds. Maximum radius value is 128; resource I<blurRadius>.	179	on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
		180	resource I<blurRadius>.
175		181
176	=item B<-bg> I<colour>	182	=item B<-bg> I<colour>
177		183
178	Window background colour; resource B<background>.	184	Window background colour; resource B<background>.
179		185
180	=item B<-fg> I<colour>	186	=item B<-fg> I<colour>
181		187
182	Window foreground colour; resource B<foreground>.	188	Window foreground colour; resource B<foreground>.
183		189
184	=item B<-pixmap> I<file[;geom]>	190	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
185		191
186	Compile I<afterimage>: Specify image file for the background and also	192	Compile I<afterimage>: Specify image file for the background and also
187	optionally specify its scaling with a geometry string. Note you may need to	193	optionally specify its scaling with a geometry string. Note you may need to
188	add quotes to avoid special shell interpretation of the C<;> in the	194	add quotes to avoid special shell interpretation of the C<;> in the
189	command-line; for more details see resource B<backgroundPixmap>.	195	command-line; for more details see resource B<backgroundPixmap>.
190		196
191	=item B<-cr> I<colour>	197	=item B<-cr> I<colour>
…		…
239	italic> >> characters are to be printed. See resource B<boldItalicFont>	245	italic> >> characters are to be printed. See resource B<boldItalicFont>
240	for details.	246	for details.
241		247
242	=item B<-is>\|B<+is>	248	=item B<-is>\|B<+is>
243		249
244	Compile I<font-styles>: Bold/Italic font styles imply high intensity	250	Compile I<font-styles>: Bold/Blink font styles imply high intensity
245	foreground/background (default). See resource B<intensityStyles> for	251	foreground/background (default). See resource B<intensityStyles> for
246	details.	252	details.
247		253
248	=item B<-name> I<name>	254	=item B<-name> I<name>
249		255
…		…
267		273
268	=item B<-sb>\|B<+sb>	274	=item B<-sb>\|B<+sb>
269		275
270	Turn on/off scrollbar; resource B<scrollBar>.	276	Turn on/off scrollbar; resource B<scrollBar>.
271		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
272	=item B<-si>\|B<+si>	287	=item B<-si>\|B<+si>
273		288
274	Turn on/off scroll-to-bottom on TTY output inhibit; resource	289	Turn on/off scroll-to-bottom on TTY output inhibit; resource
275	B<scrollTtyOutput> has opposite effect.	290	B<scrollTtyOutput> has opposite effect.
276		291
…		…
282	=item B<-sw>\|B<+sw>	297	=item B<-sw>\|B<+sw>
283		298
284	Turn on/off scrolling with the scrollback buffer as new lines appear.	299	Turn on/off scrolling with the scrollback buffer as new lines appear.
285	This only takes effect if B<-si> is also given; resource	300	This only takes effect if B<-si> is also given; resource
286	B<scrollWithBuffer>.	301	B<scrollWithBuffer>.
287
288	=item B<-sr>\|B<+sr>
289
290	Put scrollbar on right/left; resource B<scrollBar_right>.
291
292	=item B<-st>\|B<+st>
293
294	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
295	resource B<scrollBar_floating>.
296		302
297	=item B<-ptab>\|B<+ptab>	303	=item B<-ptab>\|B<+ptab>
298		304
299	If enabled (default), "Horizontal Tab" characters are being stored as	305	If enabled (default), "Horizontal Tab" characters are being stored as
300	actual wide characters in the screen buffer, which makes it possible to	306	actual wide characters in the screen buffer, which makes it possible to
…		…
347		353
348	=item B<-lsp> I<number>	354	=item B<-lsp> I<number>
349		355
350	Compile I<frills>: Lines (pixel height) to insert between each row of	356	Compile I<frills>: Lines (pixel height) to insert between each row of
351	the display. Useful to work around font rendering problems; resource	357	the display. Useful to work around font rendering problems; resource
352	B<linespace>.	358	B<lineSpace>.
353		359
354	=item B<-tn> I<termname>	360	=item B<-tn> I<termname>
355		361
356	This option specifies the name of the terminal type to be set in the	362	This option specifies the name of the terminal type to be set in the
357	B<TERM> environment variable. This terminal type must exist in the	363	B<TERM> environment variable. This terminal type must exist in the
…		…
412		418
413	=item B<-tcw>	419	=item B<-tcw>
414		420
415	Change the meaning of triple-click selection with the left mouse	421	Change the meaning of triple-click selection with the left mouse
416	button. Only effective when the original (non-perl) selection code is	422	button. Only effective when the original (non-perl) selection code is
417	in-use. Instead of selecting a full line it will extend the selection the	423	in-use. Instead of selecting a full line it will extend the selection to
418	end of the logical line only. resource B<tripleclickwords>.	424	the end of the logical line only. resource B<tripleclickwords>.
419		425
420	=item B<-insecure>	426	=item B<-insecure>
421		427
422	Enable "insecure" mode, which currently enables most of the escape	428	Enable "insecure" mode, which currently enables most of the escape
423	sequences that echo strings. See the resource B<insecure> for more	429	sequences that echo strings. See the resource B<insecure> for more
…		…
443		449
444	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	450	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
445	will not immediately destroy its window when the program executed within	451	will not immediately destroy its window when the program executed within
446	it exits. Instead, it will wait till it is being killed or closed by the	452	it exits. Instead, it will wait till it is being killed or closed by the
447	user; resource B<hold>.	453	user; resource B<hold>.
		454
		455	=item B<-xrm> I<string>
		456
		457	Works like the X Toolkit option of the same name, by adding the I<string>
		458	as if it were specified in a resource file. Resource values specified this
		459	way take precedence over all other resource specifications.
		460
		461	Note that you need to use the I<same> syntax as in the .Xdefaults file,
		462	e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
		463	options can be specified as long-options on the commandline, so use
		464	of B<-xrm> is mostly limited to cases where you want to specify other
		465	resources (e.g. for input methods) or for compatibility with other
		466	programs.
448		467
449	=item B<-keysym.>I<sym> I<string>	468	=item B<-keysym.>I<sym> I<string>
450		469
451	Remap a key symbol. See resource B<keysym>.	470	Remap a key symbol. See resource B<keysym>.
452		471
…		…
487	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	506	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
488	entries and will not tinker with pty/tty permissions - you have to do that	507	entries and will not tinker with pty/tty permissions - you have to do that
489	yourself if you want that.	508	yourself if you want that.
490		509
491	As an extremely special case, specifying C<-1> will completely suppress	510	As an extremely special case, specifying C<-1> will completely suppress
492	pty/tty operations.	511	pty/tty operations, which is probably only useful in conjunction with some
		512	perl extension that manages the terminal.
493		513
494	Here is a example in perl that illustrates how this option can be used (a	514	Here is a example in perl that illustrates how this option can be used (a
495	longer example is in F<doc/pty-fd>):	515	longer example is in F<doc/pty-fd>):
496		516
497	use IO::Pty;	517	use IO::Pty;
…		…
511	Comma-separated list of perl extension scripts to use (or not to use) in	531	Comma-separated list of perl extension scripts to use (or not to use) in
512	this terminal instance. See resource B<perl-ext> for details.	532	this terminal instance. See resource B<perl-ext> for details.
513		533
514	=back	534	=back
515		535
516	=head1 RESOURCES (available also as long-options)	536	=head1 RESOURCES
517		537
518	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	538	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
519	options) compiled into your version.	539	options) compiled into your version. All resources are also available as
		540	long-options.
520		541
521	You can set and change the resources using X11 tools like B<xrdb>. Many	542	You can set and change the resources using X11 tools like B<xrdb>. Many
522	distribution do also load settings from the B<~/.Xresources> file when X	543	distribution do also load settings from the B<~/.Xresources> file when X
523	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	544	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
524	with later settings overwriting earlier ones:	545	with later settings overwriting earlier ones:
…		…
526	1. system-wide app-defaults file, either locale-dependent OR global	547	1. system-wide app-defaults file, either locale-dependent OR global
527	2. app-defaults file in $XAPPLRESDIR	548	2. app-defaults file in $XAPPLRESDIR
528	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	549	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
529	4. SCREEN_RESOURCES for the current screen	550	4. SCREEN_RESOURCES for the current screen
530	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	551	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		552	6. resources specified via -xrm on the commandline
531		553
532	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	554	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
533	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources	555	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
534	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily	556	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
535	configured, while the class name B<URxvt> allows resources unique to	557	configured, while the class name B<URxvt> allows resources unique to
…		…
637		659
638	B<False>: specify that everything is to be displayed, even	660	B<False>: specify that everything is to be displayed, even
639	if the refresh is too fast for the human eye to read anything (or the	661	if the refresh is too fast for the human eye to read anything (or the
640	monitor to display anything); option B<+ss>.	662	monitor to display anything); option B<+ss>.
641		663
642	=item B<inheritPixmap:> I<boolean>	664	=item B<transparent:> I<boolean>
643		665
644	B<True>: make the background inherit the parent windows' pixmap, giving	666	Turn on/off illusion of a transparent window background.
645	artificial transparency. B<False>: do not inherit the parent windows'
646	pixmap.
647		667
648	I<Please note that transparency of any kind if completely unsupported by	668	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
649	the author. Don't bug him with installation questions!>	669	future versions.
		670
		671	I<Please address all transparency related issues to Sasha Vasko at
		672	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
650		673
651	=item B<fading:> I<number>	674	=item B<fading:> I<number>
652		675
653	Fade the text by the given percentage when focus is lost; option B<-fade>.	676	Fade the text by the given percentage when focus is lost; option B<-fade>.
654		677
…		…
671		694
672	Specify background blending type; option B<-blt>.	695	Specify background blending type; option B<-blt>.
673		696
674	=item B<blurRadius:> I<number>	697	=item B<blurRadius:> I<number>
675		698
676	Apply Gaussian Blurr with the specified radius to the transparent	699	Apply Gaussian Blurr with the specified radius to the transparent
677	background image; option B<-blr>.	700	background image; option B<-blr>.
678		701
679	=item B<scrollColor:> I<colour>	702	=item B<scrollColor:> I<colour>
680		703
681	Use the specified colour for the scrollbar [default #B2B2B2].	704	Use the specified colour for the scrollbar [default #B2B2B2].
…		…
688	=item B<borderColor:> I<colour>	711	=item B<borderColor:> I<colour>
689		712
690	The colour of the border around the text area and between the scrollbar	713	The colour of the border around the text area and between the scrollbar
691	and the text.	714	and the text.
692		715
693	=item B<backgroundPixmap:> I<file[;geom]>	716	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
694		717
695	Use the specified image file for the background and also optionally	718	Use the specified image file for the background and also
696	specify its scaling with a geometry string B<WxH+X+Y>,	719	optionally specify its scaling with a geometry string B<WxH+X+Y>,
697	in which B<"W" / "H"> specify the horizontal/vertical scale (percent),	720	(default C<0x0+50+50>) in which B<"W" / "H"> specify the
698	and B<"X" / "Y"> locate the image centre (percent).	721	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
699	A scale of 0 displays the image with tiling. A scale of 1 displays the	722	centre (percent). A scale of 0 displays the image with tiling. A scale
700	image without any scaling. A scale of 2 to 9 specifies an integer	723	of 1 displays the image without any scaling. A scale of 2 to 9 specifies
701	number of images in that direction. No image will be magnified beyond	724	an integer number of images in that direction. No image will be magnified
702	10 times its original size. The maximum permitted scale is 1000.	725	beyond 10 times its original size. The maximum permitted scale is 1000.
703	Special string of B<"auto"> used as a geometry will cause image to be	726	Additional operations can be specified after colon B<:op1:op2...>.
704	automatically scaled to match window size.	727	Supported operations are:
		728
		729	tile force background image to be tiled and not scaled. Equivalent to 0x0
		730	propscale will scale image keeping proportions
		731	auto will scale image to match window size. Equivalent to 100x100
		732	hscale will scale image horizontally to the window size
		733	vscale will scale image vertically to the window size
		734	scale will scale image to match window size
		735	root will tile image as if it was a root window background, auto-adjusting
		736	whenever terminal window moves
		737
705	If used in conjunction with B<-tr> option - specified pixmap will be	738	If used in conjunction with B<-tr> option, the specified pixmap will be
706	blended over transparency image using either alpha-blending, or any	739	blended over transparency image using either alpha-blending, or any
707	other blending type, specified with B<-blt "type"> option.	740	other blending type, specified with B<-blt "type"> option.
708	[default 0x0+50+50]
709		741
710	=item B<path:> I<path>	742	=item B<path:> I<path>
711		743
712	Specify the colon-delimited search path for finding XPM files.	744	Specify the colon-delimited search path for finding background image files.
713		745
714	=item B<font:> I<fontlist>	746	=item B<font:> I<fontlist>
715		747
716	Select the fonts to be used. This is a comma separated list of font names	748	Select the fonts to be used. This is a comma separated list of font names
717	that are checked in order when trying to find glyphs for characters. The	749	that are checked in order when trying to find glyphs for characters. The
…		…
774	text font will being used for the given style.	806	text font will being used for the given style.
775		807
776	=item B<intensityStyles:> I<boolean>	808	=item B<intensityStyles:> I<boolean>
777		809
778	When font styles are not enabled, or this option is enabled (B<True>,	810	When font styles are not enabled, or this option is enabled (B<True>,
779	option B<-is>, the default), bold and italic font styles imply high	811	option B<-is>, the default), bold/blink font styles imply high
780	intensity foreground/background colours. Disabling this option (B<False>,	812	intensity foreground/background colours. Disabling this option (B<False>,
781	option B<+is>) disables this behaviour, the high intensity colours are not	813	option B<+is>) disables this behaviour, the high intensity colours are not
782	reachable.	814	reachable.
783		815
784	=item B<selectstyle:> I<mode>
785
786	Set mouse selection style to B<old> which is 2.20, B<oldword> which
787	is xterm style with 2.20 old word selection, or anything else which
788	gives xterm style selection. Only effective when the original (non-perl)
789	selection code is in use.
790
791	=item B<scrollstyle:> I<mode>
792
793	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
794	the author's favourite.
795
796	=item B<title:> I<string>	816	=item B<title:> I<string>
797		817
798	Set window title string, the default title is the command-line	818	Set window title string, the default title is the command-line
799	specified after the B<-e> option, if any, otherwise the application	819	specified after the B<-e> option, if any, otherwise the application
800	name; option B<-title>.	820	name; option B<-title>.
…		…
844		864
845	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	865	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
846		866
847	This creates a new file in your home directory with the screen contents	867	This creates a new file in your home directory with the screen contents
848	every time you hit C<Print>.	868	every time you hit C<Print>.
		869
		870	=item B<scrollstyle:> I<mode>
		871
		872	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		873	the author's favourite.
849		874
850	=item B<scrollBar:> I<boolean>	875	=item B<scrollBar:> I<boolean>
851		876
852	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	877	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
853	disable the scrollbar; option B<+sb>.	878	disable the scrollbar; option B<+sb>.
…		…
916	=item B<termName:> I<termname>	941	=item B<termName:> I<termname>
917		942
918	Specifies the terminal type name to be set in the B<TERM> environment	943	Specifies the terminal type name to be set in the B<TERM> environment
919	variable; option B<-tn>.	944	variable; option B<-tn>.
920		945
921	=item B<linespace:> I<number>	946	=item B<lineSpace:> I<number>
922		947
923	Specifies number of lines (pixel height) to insert between each row of	948	Specifies number of lines (pixel height) to insert between each row of
924	the display [default 0]; option B<-lsp>.	949	the display [default 0]; option B<-lsp>.
925		950
926	=item B<meta8:> I<boolean>	951	=item B<meta8:> I<boolean>
…		…
986	will be created). In this mode, characters outside ISO-8859-1 can be used.	1011	will be created). In this mode, characters outside ISO-8859-1 can be used.
987		1012
988	When the selection extension is not used, only ISO-8859-1 characters can	1013	When the selection extension is not used, only ISO-8859-1 characters can
989	be used. If not specified, the built-in default is used:	1014	be used. If not specified, the built-in default is used:
990		1015
991	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	1016	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
992		1017
993	=item B<preeditType:> I<style>	1018	=item B<preeditType:> I<style>
994		1019
995	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1020	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
996		1021
…		…
1084	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1109	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1085	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1110	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1086	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1111	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1087	performed in an exact manner; however, the closest match is assured.	1112	performed in an exact manner; however, the closest match is assured.
1088		1113
1089	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1114	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1090	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1115	number), see RESOURCES in C<man 7 X> for futher details.
1091	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1092	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1093	can start or end with whitespace. B<This feature is deprecated and will
1094	be removed>.
1095
1096	Please note that you need to double the C<\> in resource files, as
1097	Xlib itself does its own de-escaping (you can use C<\033> instead of
1098	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1099	processing).
1100		1116
1101	You can define a range of keysyms in one shot by providing a I<string>	1117	You can define a range of keysyms in one shot by providing a I<string>
1102	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1118	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1103	should be a character not used by the strings.	1119	should be a character not used by the strings.
1104		1120
…		…
1437	would yield White on Black, while on I<xterm>(1) it would yield Black	1453	would yield White on Black, while on I<xterm>(1) it would yield Black
1438	on White.	1454	on White.
1439		1455
1440	=back	1456	=back
1441		1457
1442	=head2 ALPHA CHANNEL SUPPORT	1458	=head2 ALPHA CHANNEL SUPPORT / TRANSPARENT COLOURS
1443		1459
1444	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1460	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1445	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>	1461	their act together, rxvt-unicode will do it's own alpha channel management:
1446	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1462
1447	in addition to the ones provided by X, where the additional A component	1463	You can prefix any color with an opaquenes percentage enclosed in
		1464	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1465	(0-100) that specifies the opacity of the color, where C<0> is completely
		1466	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1467	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1468	is the recommended format to specify transparency values, and works with
		1469	all ways to specify a colour.
		1470
		1471	For complete control, rxvt-unicode also supports
		1472	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1473	specifications, where the additional C<aaaa> component specifies opacity
1448	specifies opacity (alpha) values. The minimum value of C<0> is completely	1474	(alpha) values. The minimum value of C<0000> is completely transparent,
1449	transparent). You can also prefix any color with C<[percent]>, where	1475	while C<ffff> is completely opaque). The two example colours from
1450	C<percent> is a decimal percentage (0-100) that specifies the opacity of	1476	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1451	the color, where C<0> is completely transparent and C<100> is completelxy	1477	C<rgba:0000/ff00/0000/f332>.
1452	opaque.
1453		1478
1454	You probably need to specify B<"-depth 32">, too, and have the luck that	1479	You probably need to specify B<"-depth 32">, too, to force a visual with
1455	your X-server uses ARGB pixel layout, as X is far from just supporting	1480	alpha channels, and have the luck that your X-server uses ARGB pixel
1456	ARGB visuals out of the box, and rxvt-unicode just fudges around.	1481	layout, as X is far from just supporting ARGB visuals out of the box, and
		1482	rxvt-unicode just fudges around.
1457		1483
1458	For example, the following selects an almost completely transparent red	1484	For example, the following selects an almost completely transparent black
1459	background, and an almost opaque pink foreground:	1485	background, and an almost opaque pink foreground:
1460		1486
1461	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"	1487	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1462		1488
1463	I<Please note that transparency of any kind if completely unsupported by	1489	When not using a background image, then the interpretation of the
1464	the author. Don't bug him with installation questions!>	1490	alpha channel is up to your compositing manager (most interpret it as
		1491	transparency of course).
		1492
		1493	When using a background pixmap or pseudo-transparency, then the background
		1494	colour will always behave as if it were completely transparent (so the
		1495	background image shows instead), regardless of how it was specified, while
		1496	other colours will either be transparent as specified (the background
		1497	image will show through) on servers supporting the RENDER extension, or
		1498	fully opaque on servers not supporting the RENDER EXTENSION.
		1499
		1500	Please note that due to bugs in Xft, specifying alpha values might result
		1501	in garbage being displayed when the X-server does not support the RENDER
		1502	extension.
1465		1503
1466	=head1 ENVIRONMENT	1504	=head1 ENVIRONMENT
1467		1505
1468	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1506	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1469		1507
…		…
1475	resources or on the command line.	1513	resources or on the command line.
1476		1514
1477	=item B<COLORTERM>	1515	=item B<COLORTERM>
1478		1516
1479	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was	1517	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1480	compiled with XPM support, and optionally with the added extension	1518	compiled with background image support, and optionally with the added
1481	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1519	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1520	screen.
1482		1521
1483	=item B<COLORFGBG>	1522	=item B<COLORFGBG>
1484		1523
1485	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1524	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1486	the colour code used as default foreground/text colour (or the string	1525	the colour code used as default foreground/text colour (or the string
1487	C<default> to indicate that the default-colour escape sequence is to be	1526	C<default> to indicate that the default-colour escape sequence is to be
1488	used), C<bg> is the colour code used as default background colour (or the	1527	used), C<bg> is the colour code used as default background colour (or the
1489	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1528	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1490	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can	1529	was compiled with background image support. Libraries like C<ncurses>
1491	(and do) use this information to optimize screen output.	1530	and C<slang> can (and do) use this information to optimize screen output.
1492		1531
1493	=item B<WINDOWID>	1532	=item B<WINDOWID>
1494		1533
1495	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1534	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1496	window, which usually has subwindows for the scrollbar, the terminal	1535	window, which usually has subwindows for the scrollbar, the terminal
…		…
1587	Project Coordinator (changes.txt 2.21a to 2.4.5)	1626	Project Coordinator (changes.txt 2.21a to 2.4.5)
1588		1627
1589	=item Geoff Wing L<< <gcw@pobox.com> >>	1628	=item Geoff Wing L<< <gcw@pobox.com> >>
1590		1629
1591	Rewrote screen display and text selection routines.	1630	Rewrote screen display and text selection routines.
1592		1631
1593	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1632	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1594		1633
1595	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1634	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1596		1635
1597	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1636	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.135 by ayin, Wed Aug 1 01:45:06 2007 UTC vs. Revision 1.158 by root, Wed Jan 23 14:33:42 2008 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.135 by ayin, Wed Aug 1 01:45:06 2007 UTC vs.
Revision 1.158 by root, Wed Jan 23 14:33:42 2008 UTC