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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.144 by sasha, Thu Nov 15 18:40:10 2007 UTC vs.
Revision 1.170 by root, Sat May 30 08:51:23 2009 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
…		…
334		346
335	=item B<-bl>	347	=item B<-bl>
336		348
337	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	349	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	350	if honoured by the WM, the rxvt-unicode window will not have window
339	decorations; resource B<borderLess>.	351	decorations; resource B<borderLess>. If the window manager does not
		352	support MWM hints (e.g. kwin), enables override-redirect mode.
340		353
341	=item B<-override-redirect>	354	=item B<-override-redirect>
342		355
343	Compile I<frills>: Sets override-redirect on the window; resource	356	Compile I<frills>: Sets override-redirect on the window; resource
344	B<override-redirect>.	357	B<override-redirect>.
…		…
353	=item B<-lsp> I<number>	366	=item B<-lsp> I<number>
354		367
355	Compile I<frills>: Lines (pixel height) to insert between each row of	368	Compile I<frills>: Lines (pixel height) to insert between each row of
356	the display. Useful to work around font rendering problems; resource	369	the display. Useful to work around font rendering problems; resource
357	B<lineSpace>.	370	B<lineSpace>.
		371
		372	=item B<-letsp> I<number>
		373
		374	Compile I<frills>: Amount to adjust the computed character width by
		375	to control overall letter spacing. Negative values will tighten up the
		376	letter spacing, positive values will space letters out more. Useful to
		377	work around odd font metrics; resource B<letterSpace>.
358		378
359	=item B<-tn> I<termname>	379	=item B<-tn> I<termname>
360		380
361	This option specifies the name of the terminal type to be set in the	381	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	382	B<TERM> environment variable. This terminal type must exist in the
…		…
417		437
418	=item B<-tcw>	438	=item B<-tcw>
419		439
420	Change the meaning of triple-click selection with the left mouse	440	Change the meaning of triple-click selection with the left mouse
421	button. Only effective when the original (non-perl) selection code is	441	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	442	in-use. Instead of selecting a full line it will extend the selection to
423	end of the logical line only. resource B<tripleclickwords>.	443	the end of the logical line only. resource B<tripleclickwords>.
424		444
425	=item B<-insecure>	445	=item B<-insecure>
426		446
427	Enable "insecure" mode, which currently enables most of the escape	447	Enable "insecure" mode, which currently enables most of the escape
428	sequences that echo strings. See the resource B<insecure> for more	448	sequences that echo strings. See the resource B<insecure> for more
…		…
448		468
449	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	469	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
450	will not immediately destroy its window when the program executed within	470	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	471	it exits. Instead, it will wait till it is being killed or closed by the
452	user; resource B<hold>.	472	user; resource B<hold>.
		473
		474	=item B<-cd> I<path>
		475
		476	Sets the working directory for the shell (or the command specified via
		477	B<-e>). The I<path> must be an absolute path and it must exist for
		478	@@RXVT_NAME@@ to start; resource B<chdir>.
		479
		480	=item B<-xrm> I<string>
		481
		482	Works like the X Toolkit option of the same name, by adding the I<string>
		483	as if it were specified in a resource file. Resource values specified this
		484	way take precedence over all other resource specifications.
		485
		486	Note that you need to use the I<same> syntax as in the .Xdefaults file,
		487	e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
		488	options can be specified as long-options on the commandline, so use
		489	of B<-xrm> is mostly limited to cases where you want to specify other
		490	resources (e.g. for input methods) or for compatibility with other
		491	programs.
453		492
454	=item B<-keysym.>I<sym> I<string>	493	=item B<-keysym.>I<sym> I<string>
455		494
456	Remap a key symbol. See resource B<keysym>.	495	Remap a key symbol. See resource B<keysym>.
457		496
…		…
492	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	531	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
493	entries and will not tinker with pty/tty permissions - you have to do that	532	entries and will not tinker with pty/tty permissions - you have to do that
494	yourself if you want that.	533	yourself if you want that.
495		534
496	As an extremely special case, specifying C<-1> will completely suppress	535	As an extremely special case, specifying C<-1> will completely suppress
497	pty/tty operations.	536	pty/tty operations, which is probably only useful in conjunction with some
		537	perl extension that manages the terminal.
498		538
499	Here is a example in perl that illustrates how this option can be used (a	539	Here is a example in perl that illustrates how this option can be used (a
500	longer example is in F<doc/pty-fd>):	540	longer example is in F<doc/pty-fd>):
501		541
502	use IO::Pty;	542	use IO::Pty;
…		…
516	Comma-separated list of perl extension scripts to use (or not to use) in	556	Comma-separated list of perl extension scripts to use (or not to use) in
517	this terminal instance. See resource B<perl-ext> for details.	557	this terminal instance. See resource B<perl-ext> for details.
518		558
519	=back	559	=back
520		560
521	=head1 RESOURCES (available also as long-options)	561	=head1 RESOURCES
522		562
523	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	563	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
524	options) compiled into your version.	564	options) compiled into your version. All resources are also available as
		565	long-options.
525		566
526	You can set and change the resources using X11 tools like B<xrdb>. Many	567	You can set and change the resources using X11 tools like B<xrdb>. Many
527	distribution do also load settings from the B<~/.Xresources> file when X	568	distribution do also load settings from the B<~/.Xresources> file when X
528	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	569	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
529	with later settings overwriting earlier ones:	570	with later settings overwriting earlier ones:
…		…
531	1. system-wide app-defaults file, either locale-dependent OR global	572	1. system-wide app-defaults file, either locale-dependent OR global
532	2. app-defaults file in $XAPPLRESDIR	573	2. app-defaults file in $XAPPLRESDIR
533	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	574	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
534	4. SCREEN_RESOURCES for the current screen	575	4. SCREEN_RESOURCES for the current screen
535	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	576	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		577	6. resources specified via -xrm on the commandline
536		578
537	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	579	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
538	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources	580	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
539	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily	581	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
540	configured, while the class name B<URxvt> allows resources unique to	582	configured, while the class name B<URxvt> allows resources unique to
…		…
550	=item B<depth:> I<bitdepth>	592	=item B<depth:> I<bitdepth>
551		593
552	Compile I<xft>: Attempt to find a visual with the given bit depth;	594	Compile I<xft>: Attempt to find a visual with the given bit depth;
553	option B<-depth>.	595	option B<-depth>.
554		596
		597	=item B<buffered:> I<boolean>
		598
		599	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		600	On some card/driver combination enabling it slightly decreases
		601	performance, on most it greatly helps it. The slowdown is small, so it
		602	should normally be enabled.
		603
555	=item B<geometry:> I<geom>	604	=item B<geometry:> I<geom>
556		605
557	Create the window with the specified X window geometry [default 80x24];	606	Create the window with the specified X window geometry [default 80x24];
558	option B<-geometry>.	607	option B<-geometry>.
559		608
…		…
642		691
643	B<False>: specify that everything is to be displayed, even	692	B<False>: specify that everything is to be displayed, even
644	if the refresh is too fast for the human eye to read anything (or the	693	if the refresh is too fast for the human eye to read anything (or the
645	monitor to display anything); option B<+ss>.	694	monitor to display anything); option B<+ss>.
646		695
647	=item B<inheritPixmap:> I<boolean>	696	=item B<transparent:> I<boolean>
648		697
649	B<True>: make the background inherit the parent windows' pixmap, giving	698	Turn on/off illusion of a transparent window background.
650	artificial transparency. B<False>: do not inherit the parent windows'
651	pixmap.
652		699
653	I<Please note that transparency of any kind if completely unsupported by	700	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
654	the author. Don't bug him with installation questions!>	701	future versions.
		702
		703	I<Please address all transparency related issues to Sasha Vasko at
		704	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
655		705
656	=item B<fading:> I<number>	706	=item B<fading:> I<number>
657		707
658	Fade the text by the given percentage when focus is lost; option B<-fade>.	708	Fade the text by the given percentage when focus is lost; option B<-fade>.
659		709
…		…
676		726
677	Specify background blending type; option B<-blt>.	727	Specify background blending type; option B<-blt>.
678		728
679	=item B<blurRadius:> I<number>	729	=item B<blurRadius:> I<number>
680		730
681	Apply Gaussian Blurr with the specified radius to the transparent	731	Apply gaussian blur with the specified radius to the transparent
682	background image; option B<-blr>.	732	background image; option B<-blr>.
		733
		734	=item B<iconFile:> I<file>
		735
		736	Set the application icon pixmap; option B<-icon>.
683		737
684	=item B<scrollColor:> I<colour>	738	=item B<scrollColor:> I<colour>
685		739
686	Use the specified colour for the scrollbar [default #B2B2B2].	740	Use the specified colour for the scrollbar [default #B2B2B2].
687		741
…		…
695	The colour of the border around the text area and between the scrollbar	749	The colour of the border around the text area and between the scrollbar
696	and the text.	750	and the text.
697		751
698	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>	752	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
699		753
700	Use the specified image file for the background and also optionally	754	Use the specified image file for the background and also
701	specify its scaling with a geometry string B<WxH+X+Y>,	755	optionally specify its scaling with a geometry string B<WxH+X+Y>,
702	in which B<"W" / "H"> specify the horizontal/vertical scale (percent),	756	(default C<0x0+50+50>) in which B<"W" / "H"> specify the
703	and B<"X" / "Y"> locate the image centre (percent).	757	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
704	A scale of 0 displays the image with tiling. A scale of 1 displays the	758	centre (percent). A scale of 0 displays the image with tiling. A scale
705	image without any scaling. A scale of 2 to 9 specifies an integer	759	of 1 displays the image without any scaling. A scale of 2 to 9 specifies
706	number of images in that direction. No image will be magnified beyond	760	an integer number of images in that direction. No image will be magnified
707	10 times its original size. The maximum permitted scale is 1000.	761	beyond 10 times its original size. The maximum permitted scale is 1000.
708	Additional operations can be specified after colon B<:op1:op2...>.	762	Additional operations can be specified after colon B<:op1:op2...>.
709	Supported operations are:	763	Supported operations are:
		764
710	B<"tile"> - force background image to be tiled and not scaled. Equivalent to 0x0,	765	tile force background image to be tiled and not scaled. Equivalent to 0x0
711	B<"propscale"> - will scale image keeping proportions,	766	propscale will scale image keeping proportions
712	B<"auto"> - will scale image to match window size. Equivalent to 100x100;	767	auto will scale image to match window size. Equivalent to 100x100
713	B<"hscale"> - will scale image horizontally to the window size;	768	hscale will scale image horizontally to the window size
714	B<"vscale"> - will scale image vertically to the window size;	769	vscale will scale image vertically to the window size
715	B<"scale"> - will scale image to match window size;	770	scale will scale image to match window size
716	B<"root"> - will tile image as if it was a root window background, auto-adjusting	771	root will tile image as if it was a root window background, auto-adjusting
717	whenever terminal window moves.	772	whenever terminal window moves
718		773
719	If used in conjunction with B<-tr> option - specified pixmap will be	774	If used in conjunction with B<-tr> option, the specified pixmap will be
720	blended over transparency image using either alpha-blending, or any	775	blended over transparency image using either alpha-blending, or any
721	other blending type, specified with B<-blt "type"> option.	776	other blending type, specified with B<-blt "type"> option.
722	[default 0x0+50+50]
723		777
724	=item B<path:> I<path>	778	=item B<path:> I<path>
725		779
726	Specify the colon-delimited search path for finding background image files.	780	Specify the colon-delimited search path for finding background image files.
727		781
…		…
788	text font will being used for the given style.	842	text font will being used for the given style.
789		843
790	=item B<intensityStyles:> I<boolean>	844	=item B<intensityStyles:> I<boolean>
791		845
792	When font styles are not enabled, or this option is enabled (B<True>,	846	When font styles are not enabled, or this option is enabled (B<True>,
793	option B<-is>, the default), bold and italic font styles imply high	847	option B<-is>, the default), bold/blink font styles imply high
794	intensity foreground/background colours. Disabling this option (B<False>,	848	intensity foreground/background colours. Disabling this option (B<False>,
795	option B<+is>) disables this behaviour, the high intensity colours are not	849	option B<+is>) disables this behaviour, the high intensity colours are not
796	reachable.	850	reachable.
797		851
798	=item B<selectstyle:> I<mode>
799
800	Set mouse selection style to B<old> which is 2.20, B<oldword> which
801	is xterm style with 2.20 old word selection, or anything else which
802	gives xterm style selection. Only effective when the original (non-perl)
803	selection code is in use.
804
805	=item B<scrollstyle:> I<mode>
806
807	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
808	the author's favourite.
809
810	=item B<title:> I<string>	852	=item B<title:> I<string>
811		853
812	Set window title string, the default title is the command-line	854	Set window title string, the default title is the command-line
813	specified after the B<-e> option, if any, otherwise the application	855	specified after the B<-e> option, if any, otherwise the application
814	name; option B<-title>.	856	name; option B<-title>.
…		…
827	=item B<urgentOnBell:> I<boolean>	869	=item B<urgentOnBell:> I<boolean>
828		870
829	B<True>: set the urgency hint for the wm on receipt of a bell character.	871	B<True>: set the urgency hint for the wm on receipt of a bell character.
830	B<False>: do not set the urgency hint [default].	872	B<False>: do not set the urgency hint [default].
831		873
		874	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		875
832	=item B<visualBell:> I<boolean>	876	=item B<visualBell:> I<boolean>
833		877
834	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	878	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
835	B<False>: no visual bell [default]; option B<+vb>.	879	B<False>: no visual bell [default]; option B<+vb>.
836		880
…		…
858		902
859	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	903	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
860		904
861	This creates a new file in your home directory with the screen contents	905	This creates a new file in your home directory with the screen contents
862	every time you hit C<Print>.	906	every time you hit C<Print>.
		907
		908	=item B<scrollstyle:> I<mode>
		909
		910	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		911	the author's favourite.
863		912
864	=item B<scrollBar:> I<boolean>	913	=item B<scrollBar:> I<boolean>
865		914
866	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	915	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
867	disable the scrollbar; option B<+sb>.	916	disable the scrollbar; option B<+sb>.
…		…
1000	will be created). In this mode, characters outside ISO-8859-1 can be used.	1049	will be created). In this mode, characters outside ISO-8859-1 can be used.
1001		1050
1002	When the selection extension is not used, only ISO-8859-1 characters can	1051	When the selection extension is not used, only ISO-8859-1 characters can
1003	be used. If not specified, the built-in default is used:	1052	be used. If not specified, the built-in default is used:
1004		1053
1005	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	1054	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
1006		1055
1007	=item B<preeditType:> I<style>	1056	=item B<preeditType:> I<style>
1008		1057
1009	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1058	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
1010		1059
…		…
1066		1115
1067	=item B<secondaryScroll:> I<boolean>	1116	=item B<secondaryScroll:> I<boolean>
1068		1117
1069	Turn on/off secondary screen scroll (default enabled). If this	1118	Turn on/off secondary screen scroll (default enabled). If this
1070	option is enabled, scrolls on the secondary screen will change the	1119	option is enabled, scrolls on the secondary screen will change the
1071	scrollback buffer and switching to/from the secondary screen will	1120	scrollback buffer and, when secondaryScreen is off, switching
1072	instead scroll the screen up.	1121	to/from the secondary screen will instead scroll the screen up.
1073		1122
1074	=item B<hold>: I<boolean>	1123	=item B<hold>: I<boolean>
1075		1124
1076	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1125	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1077	will not immediately destroy its window when the program executed within	1126	will not immediately destroy its window when the program executed within
1078	it exits. Instead, it will wait till it is being killed or closed by the	1127	it exits. Instead, it will wait till it is being killed or closed by the
1079	user.	1128	user.
		1129
		1130	=item B<chdir>: I<path>
		1131
		1132	Sets the working directory for the shell (or the command specified via
		1133	B<-e>). The I<path> must be an absolute path and it must exist for
		1134	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1135	directory will be used; option B<-cd>.
1080		1136
1081	=item B<keysym.>I<sym>: I<string>	1137	=item B<keysym.>I<sym>: I<string>
1082		1138
1083	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1139	Compile I<frills>: Associate I<string> with keysym I<sym>. The
1084	intervening resource name B<keysym.> cannot be omitted.	1140	intervening resource name B<keysym.> cannot be omitted.
…		…
1191	all instances, while B<perl-ext> is used for specific instances.	1247	all instances, while B<perl-ext> is used for specific instances.
1192		1248
1193	=item B<perl-eval>: I<string>	1249	=item B<perl-eval>: I<string>
1194		1250
1195	Perl code to be evaluated when all extensions have been registered. See	1251	Perl code to be evaluated when all extensions have been registered. See
1196	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource	1252	the @@RXVT_NAME@@perl(3) manpage.
1197	will be ignored when running setuid/setgid.
1198		1253
1199	=item B<perl-lib>: I<path>	1254	=item B<perl-lib>: I<path>
1200		1255
1201	Colon-separated list of additional directories that hold extension	1256	Colon-separated list of additional directories that hold extension
1202	scripts. When looking for extensions specified by the C<perl> resource,	1257	scripts. When looking for extensions specified by the C<perl> resource,
1203	@@RXVT_NAME@@ will first look in these directories and then in	1258	@@RXVT_NAME@@ will first look in these directories and then in
1204	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1259	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1205	will be ignored when running setuid/setgid.
1206		1260
1207	See the @@RXVT_NAME@@perl(3) manpage.	1261	See the @@RXVT_NAME@@perl(3) manpage.
1208		1262
1209	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1263	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1210		1264
…		…
1445	=back	1499	=back
1446		1500
1447	=head2 ALPHA CHANNEL SUPPORT	1501	=head2 ALPHA CHANNEL SUPPORT
1448		1502
1449	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1503	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1450	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>	1504	their act together, rxvt-unicode will do it's own alpha channel management:
1451	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1505
1452	in addition to the ones provided by X, where the additional A component	1506	You can prefix any color with an opaquenes percentage enclosed in
		1507	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1508	(0-100) that specifies the opacity of the color, where C<0> is completely
		1509	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1510	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1511	is the recommended format to specify transparency values, and works with
		1512	all ways to specify a colour.
		1513
		1514	For complete control, rxvt-unicode also supports
		1515	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1516	specifications, where the additional C<aaaa> component specifies opacity
1453	specifies opacity (alpha) values. The minimum value of C<0> is completely	1517	(alpha) values. The minimum value of C<0000> is completely transparent,
1454	transparent). You can also prefix any color with C<[percent]>, where	1518	while C<ffff> is completely opaque). The two example colours from
1455	C<percent> is a decimal percentage (0-100) that specifies the opacity of	1519	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1456	the color, where C<0> is completely transparent and C<100> is completelxy	1520	C<rgba:0000/ff00/0000/f332>.
1457	opaque.
1458		1521
1459	You probably need to specify B<"-depth 32">, too, and have the luck that	1522	You probably need to specify B<"-depth 32">, too, to force a visual with
1460	your X-server uses ARGB pixel layout, as X is far from just supporting	1523	alpha channels, and have the luck that your X-server uses ARGB pixel
1461	ARGB visuals out of the box, and rxvt-unicode just fudges around.	1524	layout, as X is far from just supporting ARGB visuals out of the box, and
		1525	rxvt-unicode just fudges around.
1462		1526
1463	For example, the following selects an almost completely transparent red	1527	For example, the following selects an almost completely transparent black
1464	background, and an almost opaque pink foreground:	1528	background, and an almost opaque pink foreground:
1465		1529
1466	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"	1530	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1467		1531
1468	I<Please note that transparency of any kind if completely unsupported by	1532	When not using a background image, then the interpretation of the
1469	the author. Don't bug him with installation questions!>	1533	alpha channel is up to your compositing manager (most interpret it as
		1534	transparency of course).
		1535
		1536	When using a background pixmap or pseudo-transparency, then the background
		1537	colour will always behave as if it were completely transparent (so the
		1538	background image shows instead), regardless of how it was specified, while
		1539	other colours will either be transparent as specified (the background
		1540	image will show through) on servers supporting the RENDER extension, or
		1541	fully opaque on servers not supporting the RENDER EXTENSION.
		1542
		1543	Please note that due to bugs in Xft, specifying alpha values might result
		1544	in garbage being displayed when the X-server does not support the RENDER
		1545	extension.
1470		1546
1471	=head1 ENVIRONMENT	1547	=head1 ENVIRONMENT
1472		1548
1473	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1549	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1474		1550
…		…
1508	C<--with-terminfo=PATH>.	1584	C<--with-terminfo=PATH>.
1509		1585
1510	=item B<DISPLAY>	1586	=item B<DISPLAY>
1511		1587
1512	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1588	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1513	display in its child processes.	1589	display in its child processes if C<-display> isn't used to override. It
		1590	defaults to C<:0> if it doesn't exist.
1514		1591
1515	=item B<SHELL>	1592	=item B<SHELL>
1516		1593
1517	The shell to be used for command execution, defaults to C</bin/sh>.	1594	The shell to be used for command execution, defaults to C</bin/sh>.
1518		1595

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.144 by sasha, Thu Nov 15 18:40:10 2007 UTC vs. Revision 1.170 by root, Sat May 30 08:51:23 2009 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.144 by sasha, Thu Nov 15 18:40:10 2007 UTC vs.
Revision 1.170 by root, Sat May 30 08:51:23 2009 UTC