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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.147 by root, Fri Nov 23 11:18:04 2007 UTC vs.
Revision 1.176 by sf-exg, Sat Apr 17 23:00:45 2010 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
…		…
89		92
90	Print out a message describing available options.	93	Print out a message describing available options.
91		94
92	=item B<-display> I<displayname>	95	=item B<-display> I<displayname>
93		96
94	Attempt to open a window on the named X display (B<-d> still	97	Attempt to open a window on the named X display (the older form B<-d>
95	respected). In the absence of this option, the display specified by the	98	is still respected. but deprecated). In the absence of this option, the
96	B<DISPLAY> environment variable is used.	99	display specified by the B<DISPLAY> environment variable is used.
97		100
98	=item B<-depth> I<bitdepth>	101	=item B<-depth> I<bitdepth>
99		102
100	Compile I<xft>: Attempt to find a visual with the given bit depth;	103	Compile I<xft>: Attempt to find a visual with the given bit depth;
101	resource B<depth>.	104	resource B<depth>.
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>
…		…
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<-tr>\|B<+tr>	127	=item B<-tr>\|B<+tr>
120		128
121	Turn on/off illusion of a transparent window background. Obsolete form of it is	129	Turn on/off illusion of a transparent window background; resource B<transparent>.
122	B<-ip> and it should not be used anymore; resource B<transparent>.
123		130
124	I<Please note that old resource name of B<inheritPixmap> is obsolete and should be	131	B<-ip> is still accepted as an obsolete alias but will be removed in
125	changed to B<transparent>. Backwards compatibility support for B<inheritPixmap> will	132	future versions.
126	be phased out in future versions of rxvt!>
127		133
128	I<Please address all transparency related issues to Sasha Vasko at	134	I<Please address all transparency related issues to Sasha Vasko at
129	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>	135	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
130		136
131	=item B<-fade> I<number>	137	=item B<-fade> I<number>
…		…
176	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
177	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
178	on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;	184	on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
179	resource I<blurRadius>.	185	resource I<blurRadius>.
180		186
		187	=item B<-icon> I<file>
		188
		189	Compile I<afterimage>: Use the specified image as application icon. This
		190	is used by many window managers, taskbars and pagers to represent the
		191	application window; resource I<iconFile>.
		192
181	=item B<-bg> I<colour>	193	=item B<-bg> I<colour>
182		194
183	Window background colour; resource B<background>.	195	Window background colour; resource B<background>.
184		196
185	=item B<-fg> I<colour>	197	=item B<-fg> I<colour>
…		…
244	italic> >> characters are to be printed. See resource B<boldItalicFont>	256	italic> >> characters are to be printed. See resource B<boldItalicFont>
245	for details.	257	for details.
246		258
247	=item B<-is>\|B<+is>	259	=item B<-is>\|B<+is>
248		260
249	Compile I<font-styles>: Bold/Italic font styles imply high intensity	261	Compile I<font-styles>: Bold/Blink font styles imply high intensity
250	foreground/background (default). See resource B<intensityStyles> for	262	foreground/background (default). See resource B<intensityStyles> for
251	details.	263	details.
252		264
253	=item B<-name> I<name>	265	=item B<-name> I<name>
254		266
…		…
272		284
273	=item B<-sb>\|B<+sb>	285	=item B<-sb>\|B<+sb>
274		286
275	Turn on/off scrollbar; resource B<scrollBar>.	287	Turn on/off scrollbar; resource B<scrollBar>.
276		288
		289	=item B<-sr>\|B<+sr>
		290
		291	Put scrollbar on right/left; resource B<scrollBar_right>.
		292
		293	=item B<-st>\|B<+st>
		294
		295	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
		296	resource B<scrollBar_floating>.
		297
277	=item B<-si>\|B<+si>	298	=item B<-si>\|B<+si>
278		299
279	Turn on/off scroll-to-bottom on TTY output inhibit; resource	300	Turn on/off scroll-to-bottom on TTY output inhibit; resource
280	B<scrollTtyOutput> has opposite effect.	301	B<scrollTtyOutput> has opposite effect.
281		302
…		…
287	=item B<-sw>\|B<+sw>	308	=item B<-sw>\|B<+sw>
288		309
289	Turn on/off scrolling with the scrollback buffer as new lines appear.	310	Turn on/off scrolling with the scrollback buffer as new lines appear.
290	This only takes effect if B<-si> is also given; resource	311	This only takes effect if B<-si> is also given; resource
291	B<scrollWithBuffer>.	312	B<scrollWithBuffer>.
292
293	=item B<-sr>\|B<+sr>
294
295	Put scrollbar on right/left; resource B<scrollBar_right>.
296
297	=item B<-st>\|B<+st>
298
299	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
300	resource B<scrollBar_floating>.
301		313
302	=item B<-ptab>\|B<+ptab>	314	=item B<-ptab>\|B<+ptab>
303		315
304	If enabled (default), "Horizontal Tab" characters are being stored as	316	If enabled (default), "Horizontal Tab" characters are being stored as
305	actual wide characters in the screen buffer, which makes it possible to	317	actual wide characters in the screen buffer, which makes it possible to
…		…
309		321
310	=item B<-bc>\|B<+bc>	322	=item B<-bc>\|B<+bc>
311		323
312	Blink the cursor; resource B<cursorBlink>.	324	Blink the cursor; resource B<cursorBlink>.
313		325
		326	=item B<-uc>\|B<+uc>
		327
		328	Make the cursor underlined; resource B<cursorUnderline>.
		329
314	=item B<-iconic>	330	=item B<-iconic>
315		331
316	Start iconified, if the window manager supports that option.	332	Start iconified, if the window manager supports that option.
317	Alternative form is B<-ic>.	333	Alternative form is B<-ic>.
318		334
…		…
334		350
335	=item B<-bl>	351	=item B<-bl>
336		352
337	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	353	Compile I<frills>: Set MWM hints to request a borderless window, i.e.
338	if honoured by the WM, the rxvt-unicode window will not have window	354	if honoured by the WM, the rxvt-unicode window will not have window
339	decorations; resource B<borderLess>.	355	decorations; resource B<borderLess>. If the window manager does not
		356	support MWM hints (e.g. kwin), enables override-redirect mode.
340		357
341	=item B<-override-redirect>	358	=item B<-override-redirect>
342		359
343	Compile I<frills>: Sets override-redirect on the window; resource	360	Compile I<frills>: Sets override-redirect on the window; resource
344	B<override-redirect>.	361	B<override-redirect>.
…		…
353	=item B<-lsp> I<number>	370	=item B<-lsp> I<number>
354		371
355	Compile I<frills>: Lines (pixel height) to insert between each row of	372	Compile I<frills>: Lines (pixel height) to insert between each row of
356	the display. Useful to work around font rendering problems; resource	373	the display. Useful to work around font rendering problems; resource
357	B<lineSpace>.	374	B<lineSpace>.
		375
		376	=item B<-letsp> I<number>
		377
		378	Compile I<frills>: Amount to adjust the computed character width by
		379	to control overall letter spacing. Negative values will tighten up the
		380	letter spacing, positive values will space letters out more. Useful to
		381	work around odd font metrics; resource B<letterSpace>.
358		382
359	=item B<-tn> I<termname>	383	=item B<-tn> I<termname>
360		384
361	This option specifies the name of the terminal type to be set in the	385	This option specifies the name of the terminal type to be set in the
362	B<TERM> environment variable. This terminal type must exist in the	386	B<TERM> environment variable. This terminal type must exist in the
…		…
417		441
418	=item B<-tcw>	442	=item B<-tcw>
419		443
420	Change the meaning of triple-click selection with the left mouse	444	Change the meaning of triple-click selection with the left mouse
421	button. Only effective when the original (non-perl) selection code is	445	button. Only effective when the original (non-perl) selection code is
422	in-use. Instead of selecting a full line it will extend the selection the	446	in-use. Instead of selecting a full line it will extend the selection to
423	end of the logical line only. resource B<tripleclickwords>.	447	the end of the logical line only. resource B<tripleclickwords>.
424		448
425	=item B<-insecure>	449	=item B<-insecure>
426		450
427	Enable "insecure" mode, which currently enables most of the escape	451	Enable "insecure" mode, which currently enables most of the escape
428	sequences that echo strings. See the resource B<insecure> for more	452	sequences that echo strings. See the resource B<insecure> for more
…		…
448		472
449	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	473	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
450	will not immediately destroy its window when the program executed within	474	will not immediately destroy its window when the program executed within
451	it exits. Instead, it will wait till it is being killed or closed by the	475	it exits. Instead, it will wait till it is being killed or closed by the
452	user; resource B<hold>.	476	user; resource B<hold>.
		477
		478	=item B<-cd> I<path>
		479
		480	Sets the working directory for the shell (or the command specified via
		481	B<-e>). The I<path> must be an absolute path and it must exist for
		482	@@RXVT_NAME@@ to start; resource B<chdir>.
453		483
454	=item B<-xrm> I<string>	484	=item B<-xrm> I<string>
455		485
456	Works like the X Toolkit option of the same name, by adding the I<string>	486	Works like the X Toolkit option of the same name, by adding the I<string>
457	as if it were specified in a resource file. Resource values specified this	487	as if it were specified in a resource file. Resource values specified this
…		…
505	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	535	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
506	entries and will not tinker with pty/tty permissions - you have to do that	536	entries and will not tinker with pty/tty permissions - you have to do that
507	yourself if you want that.	537	yourself if you want that.
508		538
509	As an extremely special case, specifying C<-1> will completely suppress	539	As an extremely special case, specifying C<-1> will completely suppress
510	pty/tty operations.	540	pty/tty operations, which is probably only useful in conjunction with some
		541	perl extension that manages the terminal.
511		542
512	Here is a example in perl that illustrates how this option can be used (a	543	Here is a example in perl that illustrates how this option can be used (a
513	longer example is in F<doc/pty-fd>):	544	longer example is in F<doc/pty-fd>):
514		545
515	use IO::Pty;	546	use IO::Pty;
…		…
529	Comma-separated list of perl extension scripts to use (or not to use) in	560	Comma-separated list of perl extension scripts to use (or not to use) in
530	this terminal instance. See resource B<perl-ext> for details.	561	this terminal instance. See resource B<perl-ext> for details.
531		562
532	=back	563	=back
533		564
534	=head1 RESOURCES (available also as long-options)	565	=head1 RESOURCES
535		566
536	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	567	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
537	options) compiled into your version.	568	options) compiled into your version. All resources are also available as
		569	long-options.
538		570
539	You can set and change the resources using X11 tools like B<xrdb>. Many	571	You can set and change the resources using X11 tools like B<xrdb>. Many
540	distribution do also load settings from the B<~/.Xresources> file when X	572	distribution do also load settings from the B<~/.Xresources> file when X
541	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	573	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
542	with later settings overwriting earlier ones:	574	with later settings overwriting earlier ones:
…		…
564	=item B<depth:> I<bitdepth>	596	=item B<depth:> I<bitdepth>
565		597
566	Compile I<xft>: Attempt to find a visual with the given bit depth;	598	Compile I<xft>: Attempt to find a visual with the given bit depth;
567	option B<-depth>.	599	option B<-depth>.
568		600
		601	=item B<buffered:> I<boolean>
		602
		603	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		604	On some card/driver combination enabling it slightly decreases
		605	performance, on most it greatly helps it. The slowdown is small, so it
		606	should normally be enabled.
		607
569	=item B<geometry:> I<geom>	608	=item B<geometry:> I<geom>
570		609
571	Create the window with the specified X window geometry [default 80x24];	610	Create the window with the specified X window geometry [default 80x24];
572	option B<-geometry>.	611	option B<-geometry>.
573		612
…		…
607	=item B<colorUL:> I<colour>	646	=item B<colorUL:> I<colour>
608		647
609	Use the specified colour to display underlined characters when the	648	Use the specified colour to display underlined characters when the
610	foreground colour is the default.	649	foreground colour is the default.
611		650
612	=item B<colorRV:> I<colour>
613
614	Use the specified colour as the background for reverse video characters
615	when OPTION_HC is disabled (--disable-frills).
616
617	=item B<underlineColor:> I<colour>	651	=item B<underlineColor:> I<colour>
618		652
619	If set, use the specified colour as the colour for the underline	653	If set, use the specified colour as the colour for the underline
620	itself. If unset, use the foreground colour.	654	itself. If unset, use the foreground colour.
		655
		656	=item B<highlightColor:> I<colour>
		657
		658	If set, use the specified colour as the background for highlighted
		659	characters. If unset, use reverse video.
		660
		661	=item B<highlightTextColor:> I<colour>
		662
		663	If set and highlightColor is set, use the specified colour as the
		664	foreground for highlighted characters.
621		665
622	=item B<cursorColor:> I<colour>	666	=item B<cursorColor:> I<colour>
623		667
624	Use the specified colour for the cursor. The default is to use the	668	Use the specified colour for the cursor. The default is to use the
625	foreground colour; option B<-cr>.	669	foreground colour; option B<-cr>.
…		…
656		700
657	B<False>: specify that everything is to be displayed, even	701	B<False>: specify that everything is to be displayed, even
658	if the refresh is too fast for the human eye to read anything (or the	702	if the refresh is too fast for the human eye to read anything (or the
659	monitor to display anything); option B<+ss>.	703	monitor to display anything); option B<+ss>.
660		704
661	=item B<inheritPixmap:> I<boolean>	705	=item B<transparent:> I<boolean>
662		706
663	B<True>: make the background inherit the parent windows' pixmap, giving	707	Turn on/off illusion of a transparent window background.
664	artificial transparency. B<False>: do not inherit the parent windows'
665	pixmap.
666		708
667	I<Please note that transparency of any kind if completely unsupported by	709	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
668	the author. Don't bug him with installation questions!>	710	future versions.
		711
		712	I<Please address all transparency related issues to Sasha Vasko at
		713	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
669		714
670	=item B<fading:> I<number>	715	=item B<fading:> I<number>
671		716
672	Fade the text by the given percentage when focus is lost; option B<-fade>.	717	Fade the text by the given percentage when focus is lost; option B<-fade>.
673		718
…		…
690		735
691	Specify background blending type; option B<-blt>.	736	Specify background blending type; option B<-blt>.
692		737
693	=item B<blurRadius:> I<number>	738	=item B<blurRadius:> I<number>
694		739
695	Apply Gaussian Blurr with the specified radius to the transparent	740	Apply gaussian blur with the specified radius to the transparent
696	background image; option B<-blr>.	741	background image; option B<-blr>.
		742
		743	=item B<iconFile:> I<file>
		744
		745	Set the application icon pixmap; option B<-icon>.
697		746
698	=item B<scrollColor:> I<colour>	747	=item B<scrollColor:> I<colour>
699		748
700	Use the specified colour for the scrollbar [default #B2B2B2].	749	Use the specified colour for the scrollbar [default #B2B2B2].
701		750
…		…
720	an integer number of images in that direction. No image will be magnified	769	an integer number of images in that direction. No image will be magnified
721	beyond 10 times its original size. The maximum permitted scale is 1000.	770	beyond 10 times its original size. The maximum permitted scale is 1000.
722	Additional operations can be specified after colon B<:op1:op2...>.	771	Additional operations can be specified after colon B<:op1:op2...>.
723	Supported operations are:	772	Supported operations are:
724		773
725	tile force background image to be tiled and not scaled. Equivalent to 0x0,	774	tile force background image to be tiled and not scaled. Equivalent to 0x0
726	propscale will scale image keeping proportions,	775	propscale will scale image keeping proportions
727	auto will scale image to match window size. Equivalent to 100x100;	776	auto will scale image to match window size. Equivalent to 100x100
728	hscale will scale image horizontally to the window size;	777	hscale will scale image horizontally to the window size
729	vscale will scale image vertically to the window size;	778	vscale will scale image vertically to the window size
730	scale will scale image to match window size;	779	scale will scale image to match window size
731	root will tile image as if it was a root window background, auto-adjusting	780	root will tile image as if it was a root window background, auto-adjusting
732	whenever terminal window moves.	781	whenever terminal window moves
733		782
734	If used in conjunction with B<-tr> option, the specified pixmap will be	783	If used in conjunction with B<-tr> option, the specified pixmap will be
735	blended over transparency image using either alpha-blending, or any	784	blended over transparency image using either alpha-blending, or any
736	other blending type, specified with B<-blt "type"> option.	785	other blending type, specified with B<-blt "type"> option.
737		786
…		…
768	it is named first) and thus defines the character cell grid to be 9 pixels	817	it is named first) and thus defines the character cell grid to be 9 pixels
769	wide and 15 pixels high.	818	wide and 15 pixels high.
770		819
771	The second font is just used to add additional unicode characters not in	820	The second font is just used to add additional unicode characters not in
772	the base font, likewise the third, which is unfortunately non-bold, but	821	the base font, likewise the third, which is unfortunately non-bold, but
773	the bold version of the font does contain less characters, so this is a	822	the bold version of the font does contain fewer characters, so this is a
774	useful supplement.	823	useful supplement.
775		824
776	The third font is an Xft font with aliasing turned off, and the characters	825	The third font is an Xft font with aliasing turned off, and the characters
777	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font	826	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
778	contains other characters, but we are not interested in them.	827	contains other characters, but we are not interested in them.
…		…
802	text font will being used for the given style.	851	text font will being used for the given style.
803		852
804	=item B<intensityStyles:> I<boolean>	853	=item B<intensityStyles:> I<boolean>
805		854
806	When font styles are not enabled, or this option is enabled (B<True>,	855	When font styles are not enabled, or this option is enabled (B<True>,
807	option B<-is>, the default), bold and italic font styles imply high	856	option B<-is>, the default), bold/blink font styles imply high
808	intensity foreground/background colours. Disabling this option (B<False>,	857	intensity foreground/background colours. Disabling this option (B<False>,
809	option B<+is>) disables this behaviour, the high intensity colours are not	858	option B<+is>) disables this behaviour, the high intensity colours are not
810	reachable.	859	reachable.
811		860
812	=item B<selectstyle:> I<mode>
813
814	Set mouse selection style to B<old> which is 2.20, B<oldword> which
815	is xterm style with 2.20 old word selection, or anything else which
816	gives xterm style selection. Only effective when the original (non-perl)
817	selection code is in use.
818
819	=item B<scrollstyle:> I<mode>
820
821	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
822	the author's favourite.
823
824	=item B<title:> I<string>	861	=item B<title:> I<string>
825		862
826	Set window title string, the default title is the command-line	863	Set window title string, the default title is the command-line
827	specified after the B<-e> option, if any, otherwise the application	864	specified after the B<-e> option, if any, otherwise the application
828	name; option B<-title>.	865	name; option B<-title>.
…		…
841	=item B<urgentOnBell:> I<boolean>	878	=item B<urgentOnBell:> I<boolean>
842		879
843	B<True>: set the urgency hint for the wm on receipt of a bell character.	880	B<True>: set the urgency hint for the wm on receipt of a bell character.
844	B<False>: do not set the urgency hint [default].	881	B<False>: do not set the urgency hint [default].
845		882
		883	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		884
846	=item B<visualBell:> I<boolean>	885	=item B<visualBell:> I<boolean>
847		886
848	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	887	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
849	B<False>: no visual bell [default]; option B<+vb>.	888	B<False>: no visual bell [default]; option B<+vb>.
850		889
…		…
872		911
873	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	912	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
874		913
875	This creates a new file in your home directory with the screen contents	914	This creates a new file in your home directory with the screen contents
876	every time you hit C<Print>.	915	every time you hit C<Print>.
		916
		917	=item B<scrollstyle:> I<mode>
		918
		919	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		920	the author's favourite.
877		921
878	=item B<scrollBar:> I<boolean>	922	=item B<scrollBar:> I<boolean>
879		923
880	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	924	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
881	disable the scrollbar; option B<+sb>.	925	disable the scrollbar; option B<+sb>.
…		…
968		1012
969	=item B<cursorBlink:> I<boolean>	1013	=item B<cursorBlink:> I<boolean>
970		1014
971	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	1015	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
972	option B<-bc>.	1016	option B<-bc>.
		1017
		1018	=item B<cursorUnderline:> I<boolean>
		1019
		1020	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		1021	option B<-uc>.
973		1022
974	=item B<pointerBlank:> I<boolean>	1023	=item B<pointerBlank:> I<boolean>
975		1024
976	B<True>: blank the pointer when a key is pressed or after a set number	1025	B<True>: blank the pointer when a key is pressed or after a set number
977	of seconds of inactivity. B<False>: the pointer is always visible	1026	of seconds of inactivity. B<False>: the pointer is always visible
…		…
1080		1129
1081	=item B<secondaryScroll:> I<boolean>	1130	=item B<secondaryScroll:> I<boolean>
1082		1131
1083	Turn on/off secondary screen scroll (default enabled). If this	1132	Turn on/off secondary screen scroll (default enabled). If this
1084	option is enabled, scrolls on the secondary screen will change the	1133	option is enabled, scrolls on the secondary screen will change the
1085	scrollback buffer and switching to/from the secondary screen will	1134	scrollback buffer and, when secondaryScreen is off, switching
1086	instead scroll the screen up.	1135	to/from the secondary screen will instead scroll the screen up.
1087		1136
1088	=item B<hold>: I<boolean>	1137	=item B<hold>: I<boolean>
1089		1138
1090	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1139	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1091	will not immediately destroy its window when the program executed within	1140	will not immediately destroy its window when the program executed within
1092	it exits. Instead, it will wait till it is being killed or closed by the	1141	it exits. Instead, it will wait till it is being killed or closed by the
1093	user.	1142	user.
		1143
		1144	=item B<chdir>: I<path>
		1145
		1146	Sets the working directory for the shell (or the command specified via
		1147	B<-e>). The I<path> must be an absolute path and it must exist for
		1148	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1149	directory will be used; option B<-cd>.
1094		1150
1095	=item B<keysym.>I<sym>: I<string>	1151	=item B<keysym.>I<sym>: I<string>
1096		1152
1097	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1153	Compile I<frills>: Associate I<string> with keysym I<sym>. The
1098	intervening resource name B<keysym.> cannot be omitted.	1154	intervening resource name B<keysym.> cannot be omitted.
…		…
1137	when Control-Meta-c is being pressed":	1193	when Control-Meta-c is being pressed":
1138		1194
1139	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1195	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1140		1196
1141	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1197	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1142	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)	1198	is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1143	manpage. For example, the F<selection> extension (activated via	1199	manpage. For example, the F<selection> extension (activated via
1144	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:	1200	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1145		1201
1146	URxvt.keysym.M-C-c: perl:selection:rot13	1202	URxvt.keysym.M-C-c: perl:selection:rot13
1147		1203
…		…
1205	all instances, while B<perl-ext> is used for specific instances.	1261	all instances, while B<perl-ext> is used for specific instances.
1206		1262
1207	=item B<perl-eval>: I<string>	1263	=item B<perl-eval>: I<string>
1208		1264
1209	Perl code to be evaluated when all extensions have been registered. See	1265	Perl code to be evaluated when all extensions have been registered. See
1210	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource	1266	the @@RXVT_NAME@@perl(3) manpage.
1211	will be ignored when running setuid/setgid.
1212		1267
1213	=item B<perl-lib>: I<path>	1268	=item B<perl-lib>: I<path>
1214		1269
1215	Colon-separated list of additional directories that hold extension	1270	Colon-separated list of additional directories that hold extension
1216	scripts. When looking for extensions specified by the C<perl> resource,	1271	scripts. When looking for extensions specified by the C<perl> resource,
1217	@@RXVT_NAME@@ will first look in these directories and then in	1272	@@RXVT_NAME@@ will first look in these directories and then in
1218	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1273	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1219	will be ignored when running setuid/setgid.
1220		1274
1221	See the @@RXVT_NAME@@perl(3) manpage.	1275	See the @@RXVT_NAME@@perl(3) manpage.
1222		1276
1223	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1277	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1224		1278
…		…
1246		1300
1247	=item B<override-redirect>: I<boolean>	1301	=item B<override-redirect>: I<boolean>
1248		1302
1249	Compile I<frills>: Sets override-redirect for the terminal window, making	1303	Compile I<frills>: Sets override-redirect for the terminal window, making
1250	it almost invisible to window managers; option B<-override-redirect>.	1304	it almost invisible to window managers; option B<-override-redirect>.
		1305
		1306	=item B<iso14755:> I<boolean>
		1307
		1308	Turn on/off ISO 14755 (default enabled).
1251		1309
1252	=item B<iso14755_52:> I<boolean>	1310	=item B<iso14755_52:> I<boolean>
1253		1311
1254	Turn on/off ISO 14755 5.2 mode (default enabled).	1312	Turn on/off ISO 14755 5.2 mode (default enabled).
1255		1313
…		…
1447	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1505	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1448	always swapping the foreground/background colours. This is in contrast to	1506	always swapping the foreground/background colours. This is in contrast to
1449	I<xterm>(1) where the colours are only swapped if they have not otherwise	1507	I<xterm>(1) where the colours are only swapped if they have not otherwise
1450	been specified. For example,	1508	been specified. For example,
1451		1509
1452	=over 4
1453
1454	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1510	@@RXVT_NAME@@ -fg Black -bg White -rv
1455		1511
1456	would yield White on Black, while on I<xterm>(1) it would yield Black	1512	would yield White on Black, while on I<xterm>(1) it would yield Black on
1457	on White.	1513	White.
1458
1459	=back
1460		1514
1461	=head2 ALPHA CHANNEL SUPPORT	1515	=head2 ALPHA CHANNEL SUPPORT
1462		1516
1463	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1517	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1464	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>	1518	their act together, rxvt-unicode will do it's own alpha channel management:
1465	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1519
1466	in addition to the ones provided by X, where the additional A component	1520	You can prefix any color with an opaquenes percentage enclosed in
		1521	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1522	(0-100) that specifies the opacity of the color, where C<0> is completely
		1523	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1524	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1525	is the recommended format to specify transparency values, and works with
		1526	all ways to specify a colour.
		1527
		1528	For complete control, rxvt-unicode also supports
		1529	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1530	specifications, where the additional C<aaaa> component specifies opacity
1467	specifies opacity (alpha) values. The minimum value of C<0> is completely	1531	(alpha) values. The minimum value of C<0000> is completely transparent,
1468	transparent). You can also prefix any color with C<[percent]>, where	1532	while C<ffff> is completely opaque). The two example colours from
1469	C<percent> is a decimal percentage (0-100) that specifies the opacity of	1533	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1470	the color, where C<0> is completely transparent and C<100> is completelxy	1534	C<rgba:0000/ff00/0000/f332>.
1471	opaque.
1472		1535
1473	You probably need to specify B<"-depth 32">, too, and have the luck that	1536	You probably need to specify B<"-depth 32">, too, to force a visual with
1474	your X-server uses ARGB pixel layout, as X is far from just supporting	1537	alpha channels, and have the luck that your X-server uses ARGB pixel
1475	ARGB visuals out of the box, and rxvt-unicode just fudges around.	1538	layout, as X is far from just supporting ARGB visuals out of the box, and
		1539	rxvt-unicode just fudges around.
1476		1540
1477	For example, the following selects an almost completely transparent red	1541	For example, the following selects an almost completely transparent black
1478	background, and an almost opaque pink foreground:	1542	background, and an almost opaque pink foreground:
1479		1543
1480	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"	1544	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1481		1545
1482	I<Please note that transparency of any kind if completely unsupported by	1546	When not using a background image, then the interpretation of the
1483	the author. Don't bug him with installation questions!>	1547	alpha channel is up to your compositing manager (most interpret it as
		1548	transparency of course).
		1549
		1550	When using a background pixmap or pseudo-transparency, then the background
		1551	colour will always behave as if it were completely transparent (so the
		1552	background image shows instead), regardless of how it was specified, while
		1553	other colours will either be transparent as specified (the background
		1554	image will show through) on servers supporting the RENDER extension, or
		1555	fully opaque on servers not supporting the RENDER EXTENSION.
		1556
		1557	Please note that due to bugs in Xft, specifying alpha values might result
		1558	in garbage being displayed when the X-server does not support the RENDER
		1559	extension.
1484		1560
1485	=head1 ENVIRONMENT	1561	=head1 ENVIRONMENT
1486		1562
1487	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1563	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1488		1564
…		…
1522	C<--with-terminfo=PATH>.	1598	C<--with-terminfo=PATH>.
1523		1599
1524	=item B<DISPLAY>	1600	=item B<DISPLAY>
1525		1601
1526	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1602	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1527	display in its child processes.	1603	display in its child processes if C<-display> isn't used to override. It
		1604	defaults to C<:0> if it doesn't exist.
1528		1605
1529	=item B<SHELL>	1606	=item B<SHELL>
1530		1607
1531	The shell to be used for command execution, defaults to C</bin/sh>.	1608	The shell to be used for command execution, defaults to C</bin/sh>.
1532		1609

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.147 by root, Fri Nov 23 11:18:04 2007 UTC vs. Revision 1.176 by sf-exg, Sat Apr 17 23:00:45 2010 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.147 by root, Fri Nov 23 11:18:04 2007 UTC vs.
Revision 1.176 by sf-exg, Sat Apr 17 23:00:45 2010 UTC