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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.141 by sasha, Mon Oct 29 13:40:41 2007 UTC vs.
Revision 1.165 by root, Thu Oct 2 17:06:50 2008 UTC

…		…
12	emulator intended as an I<xterm>(1) replacement for users who do not	12	emulator intended as an I<xterm>(1) replacement for users who do not
13	require features such as Tektronix 4014 emulation and toolkit-style	13	require features such as Tektronix 4014 emulation and toolkit-style
14	configurability. As a result, B<rxvt-unicode> uses much less swap space --	14	configurability. As a result, B<rxvt-unicode> uses much less swap space --
15	a significant advantage on a machine serving many X sessions.	15	a significant advantage on a machine serving many X sessions.
16		16
		17	This document is also available on the World-Wide-Web at
		18	L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
		19
17	=head1 FREQUENTLY ASKED QUESTIONS	20	=head1 FREQUENTLY ASKED QUESTIONS
18		21
19	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of	22	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20	frequently asked questions and answer to them and some common	23	frequently asked questions and answer to them and some common
21	problems. That document is also accessible on the World-Wide-Web at	24	problems. That document is also accessible on the World-Wide-Web at
22	L<http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>.	25	L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
23		26
24	=head1 RXVT-UNICODE VS. RXVT	27	=head1 RXVT-UNICODE VS. RXVT
25		28
26	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode	29	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
27	internally. That means it can store and display most scripts in the	30	internally. That means it can store and display most scripts in the
…		…
30	like mongolian or scripts requiring extremely complex combining rules,	33	like mongolian or scripts requiring extremely complex combining rules,
31	like tibetan or devanagari. Don't expect pretty output when using these	34	like tibetan or devanagari. Don't expect pretty output when using these
32	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work	35	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
33	fine, though. A somewhat difficult case are right-to-left scripts, such	36	fine, though. A somewhat difficult case are right-to-left scripts, such
34	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms	37	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
35	belong into the application, not the terminal emulator (too many things --	38	belong in the application, not the terminal emulator (too many things --
36	such as cursor-movement while editing -- break otherwise), but that might	39	such as cursor-movement while editing -- break otherwise), but that might
37	change.	40	change.
38		41
39	If you are looking for a terminal that supports more exotic scripts, let	42	If you are looking for a terminal that supports more exotic scripts, let
40	me recommend C<mlterm>, which is a very user friendly, lean and clean	43	me recommend C<mlterm>, which is a very user friendly, lean and clean
…		…
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>
132		138
133	Fade the text by the given percentage when focus is lost. Small values	139	Fade the text by the given percentage when focus is lost. Small values
…		…
145	transparency is enabled with B<-tr>. This only works for	151	transparency is enabled with B<-tr>. This only works for
146	non-tiled backgrounds, currently. See also the B<-sh> option that can be	152	non-tiled backgrounds, currently. See also the B<-sh> option that can be
147	used to brighten or darken the image in addition to tinting it.	153	used to brighten or darken the image in addition to tinting it.
148	Please note that certain tint colours can be applied on the server-side,	154	Please note that certain tint colours can be applied on the server-side,
149	thus yielding performance gain of two orders of magnitude. These colours are:	155	thus yielding performance gain of two orders of magnitude. These colours are:
150	blue, red, green, cyan, magenta, yellow, and those close to them. Also	156	blue, red, green, cyan, magenta, yellow, and those close to them. Also
151	pure black and pure white colors essentialy mean no tinting; resource	157	pure black and pure white colors essentially mean no tinting; resource
152	I<tintColor>. Example:	158	I<tintColor>. Example:
153		159
154	@@RXVT_NAME@@ -tr -tint blue -sh 40	160	@@RXVT_NAME@@ -tr -tint blue -sh 40
155		161
156	=item B<-sh> I<number>	162	=item B<-sh> I<number>
…		…
184		190
185	=item B<-fg> I<colour>	191	=item B<-fg> I<colour>
186		192
187	Window foreground colour; resource B<foreground>.	193	Window foreground colour; resource B<foreground>.
188		194
189	=item B<-pixmap> I<file[;geom]>	195	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
190		196
191	Compile I<afterimage>: Specify image file for the background and also	197	Compile I<afterimage>: Specify image file for the background and also
192	optionally specify its scaling with a geometry string. Note you may need to	198	optionally specify its scaling with a geometry string. Note you may need to
193	add quotes to avoid special shell interpretation of the C<;> in the	199	add quotes to avoid special shell interpretation of the C<;> in the
194	command-line; for more details see resource B<backgroundPixmap>.	200	command-line; for more details see resource B<backgroundPixmap>.
195		201
196	=item B<-cr> I<colour>	202	=item B<-cr> I<colour>
…		…
244	italic> >> characters are to be printed. See resource B<boldItalicFont>	250	italic> >> characters are to be printed. See resource B<boldItalicFont>
245	for details.	251	for details.
246		252
247	=item B<-is>\|B<+is>	253	=item B<-is>\|B<+is>
248		254
249	Compile I<font-styles>: Bold/Italic font styles imply high intensity	255	Compile I<font-styles>: Bold/Blink font styles imply high intensity
250	foreground/background (default). See resource B<intensityStyles> for	256	foreground/background (default). See resource B<intensityStyles> for
251	details.	257	details.
252		258
253	=item B<-name> I<name>	259	=item B<-name> I<name>
254		260
…		…
272		278
273	=item B<-sb>\|B<+sb>	279	=item B<-sb>\|B<+sb>
274		280
275	Turn on/off scrollbar; resource B<scrollBar>.	281	Turn on/off scrollbar; resource B<scrollBar>.
276		282
		283	=item B<-sr>\|B<+sr>
		284
		285	Put scrollbar on right/left; resource B<scrollBar_right>.
		286
		287	=item B<-st>\|B<+st>
		288
		289	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
		290	resource B<scrollBar_floating>.
		291
277	=item B<-si>\|B<+si>	292	=item B<-si>\|B<+si>
278		293
279	Turn on/off scroll-to-bottom on TTY output inhibit; resource	294	Turn on/off scroll-to-bottom on TTY output inhibit; resource
280	B<scrollTtyOutput> has opposite effect.	295	B<scrollTtyOutput> has opposite effect.
281		296
…		…
287	=item B<-sw>\|B<+sw>	302	=item B<-sw>\|B<+sw>
288		303
289	Turn on/off scrolling with the scrollback buffer as new lines appear.	304	Turn on/off scrolling with the scrollback buffer as new lines appear.
290	This only takes effect if B<-si> is also given; resource	305	This only takes effect if B<-si> is also given; resource
291	B<scrollWithBuffer>.	306	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		307
302	=item B<-ptab>\|B<+ptab>	308	=item B<-ptab>\|B<+ptab>
303		309
304	If enabled (default), "Horizontal Tab" characters are being stored as	310	If enabled (default), "Horizontal Tab" characters are being stored as
305	actual wide characters in the screen buffer, which makes it possible to	311	actual wide characters in the screen buffer, which makes it possible to
…		…
334		340
335	=item B<-bl>	341	=item B<-bl>
336		342
337	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	343	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	344	if honoured by the WM, the rxvt-unicode window will not have window
339	decorations; resource B<borderLess>.	345	decorations; resource B<borderLess>. If the window manager does not
		346	support MWM hints (e.g. kwin), enables override-redirect mode.
340		347
341	=item B<-override-redirect>	348	=item B<-override-redirect>
342		349
343	Compile I<frills>: Sets override-redirect on the window; resource	350	Compile I<frills>: Sets override-redirect on the window; resource
344	B<override-redirect>.	351	B<override-redirect>.
…		…
417		424
418	=item B<-tcw>	425	=item B<-tcw>
419		426
420	Change the meaning of triple-click selection with the left mouse	427	Change the meaning of triple-click selection with the left mouse
421	button. Only effective when the original (non-perl) selection code is	428	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	429	in-use. Instead of selecting a full line it will extend the selection to
423	end of the logical line only. resource B<tripleclickwords>.	430	the end of the logical line only. resource B<tripleclickwords>.
424		431
425	=item B<-insecure>	432	=item B<-insecure>
426		433
427	Enable "insecure" mode, which currently enables most of the escape	434	Enable "insecure" mode, which currently enables most of the escape
428	sequences that echo strings. See the resource B<insecure> for more	435	sequences that echo strings. See the resource B<insecure> for more
…		…
448		455
449	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	456	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
450	will not immediately destroy its window when the program executed within	457	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	458	it exits. Instead, it will wait till it is being killed or closed by the
452	user; resource B<hold>.	459	user; resource B<hold>.
		460
		461	=item B<-cd> I<path>
		462
		463	Sets the working directory for the shell (or the command specified via
		464	B<-e>). The I<path> must be an absolute path and it must exist for
		465	@@RXVT_NAME@@ to start; resource B<chdir>.
		466
		467	=item B<-xrm> I<string>
		468
		469	Works like the X Toolkit option of the same name, by adding the I<string>
		470	as if it were specified in a resource file. Resource values specified this
		471	way take precedence over all other resource specifications.
		472
		473	Note that you need to use the I<same> syntax as in the .Xdefaults file,
		474	e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
		475	options can be specified as long-options on the commandline, so use
		476	of B<-xrm> is mostly limited to cases where you want to specify other
		477	resources (e.g. for input methods) or for compatibility with other
		478	programs.
453		479
454	=item B<-keysym.>I<sym> I<string>	480	=item B<-keysym.>I<sym> I<string>
455		481
456	Remap a key symbol. See resource B<keysym>.	482	Remap a key symbol. See resource B<keysym>.
457		483
…		…
492	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	518	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	519	entries and will not tinker with pty/tty permissions - you have to do that
494	yourself if you want that.	520	yourself if you want that.
495		521
496	As an extremely special case, specifying C<-1> will completely suppress	522	As an extremely special case, specifying C<-1> will completely suppress
497	pty/tty operations.	523	pty/tty operations, which is probably only useful in conjunction with some
		524	perl extension that manages the terminal.
498		525
499	Here is a example in perl that illustrates how this option can be used (a	526	Here is a example in perl that illustrates how this option can be used (a
500	longer example is in F<doc/pty-fd>):	527	longer example is in F<doc/pty-fd>):
501		528
502	use IO::Pty;	529	use IO::Pty;
…		…
516	Comma-separated list of perl extension scripts to use (or not to use) in	543	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.	544	this terminal instance. See resource B<perl-ext> for details.
518		545
519	=back	546	=back
520		547
521	=head1 RESOURCES (available also as long-options)	548	=head1 RESOURCES
522		549
523	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	550	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
524	options) compiled into your version.	551	options) compiled into your version. All resources are also available as
		552	long-options.
525		553
526	You can set and change the resources using X11 tools like B<xrdb>. Many	554	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	555	distribution do also load settings from the B<~/.Xresources> file when X
528	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	556	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
529	with later settings overwriting earlier ones:	557	with later settings overwriting earlier ones:
…		…
531	1. system-wide app-defaults file, either locale-dependent OR global	559	1. system-wide app-defaults file, either locale-dependent OR global
532	2. app-defaults file in $XAPPLRESDIR	560	2. app-defaults file in $XAPPLRESDIR
533	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	561	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
534	4. SCREEN_RESOURCES for the current screen	562	4. SCREEN_RESOURCES for the current screen
535	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	563	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		564	6. resources specified via -xrm on the commandline
536		565
537	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	566	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	567	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	568	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	569	configured, while the class name B<URxvt> allows resources unique to
…		…
550	=item B<depth:> I<bitdepth>	579	=item B<depth:> I<bitdepth>
551		580
552	Compile I<xft>: Attempt to find a visual with the given bit depth;	581	Compile I<xft>: Attempt to find a visual with the given bit depth;
553	option B<-depth>.	582	option B<-depth>.
554		583
		584	=item B<buffered:> I<boolean>
		585
		586	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		587	On some card/driver combination enabling it slightly decreases
		588	performance, on most it greatly helps it. The slowdown is small, so it
		589	should normally be enabled.
		590
555	=item B<geometry:> I<geom>	591	=item B<geometry:> I<geom>
556		592
557	Create the window with the specified X window geometry [default 80x24];	593	Create the window with the specified X window geometry [default 80x24];
558	option B<-geometry>.	594	option B<-geometry>.
559		595
…		…
642		678
643	B<False>: specify that everything is to be displayed, even	679	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	680	if the refresh is too fast for the human eye to read anything (or the
645	monitor to display anything); option B<+ss>.	681	monitor to display anything); option B<+ss>.
646		682
647	=item B<inheritPixmap:> I<boolean>	683	=item B<transparent:> I<boolean>
648		684
649	B<True>: make the background inherit the parent windows' pixmap, giving	685	Turn on/off illusion of a transparent window background.
650	artificial transparency. B<False>: do not inherit the parent windows'
651	pixmap.
652		686
653	I<Please note that transparency of any kind if completely unsupported by	687	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
654	the author. Don't bug him with installation questions!>	688	future versions.
		689
		690	I<Please address all transparency related issues to Sasha Vasko at
		691	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
655		692
656	=item B<fading:> I<number>	693	=item B<fading:> I<number>
657		694
658	Fade the text by the given percentage when focus is lost; option B<-fade>.	695	Fade the text by the given percentage when focus is lost; option B<-fade>.
659		696
…		…
676		713
677	Specify background blending type; option B<-blt>.	714	Specify background blending type; option B<-blt>.
678		715
679	=item B<blurRadius:> I<number>	716	=item B<blurRadius:> I<number>
680		717
681	Apply Gaussian Blurr with the specified radius to the transparent	718	Apply Gaussian Blurr with the specified radius to the transparent
682	background image; option B<-blr>.	719	background image; option B<-blr>.
683		720
684	=item B<scrollColor:> I<colour>	721	=item B<scrollColor:> I<colour>
685		722
686	Use the specified colour for the scrollbar [default #B2B2B2].	723	Use the specified colour for the scrollbar [default #B2B2B2].
…		…
693	=item B<borderColor:> I<colour>	730	=item B<borderColor:> I<colour>
694		731
695	The colour of the border around the text area and between the scrollbar	732	The colour of the border around the text area and between the scrollbar
696	and the text.	733	and the text.
697		734
698	=item B<backgroundPixmap:> I<file[;geom]>	735	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
699		736
700	Use the specified image file for the background and also optionally	737	Use the specified image file for the background and also
701	specify its scaling with a geometry string B<WxH+X+Y>,	738	optionally specify its scaling with a geometry string B<WxH+X+Y>,
702	in which B<"W" / "H"> specify the horizontal/vertical scale (percent),	739	(default C<0x0+50+50>) in which B<"W" / "H"> specify the
703	and B<"X" / "Y"> locate the image centre (percent).	740	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	741	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	742	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	743	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.	744	beyond 10 times its original size. The maximum permitted scale is 1000.
708	Special string of B<"auto"> used as a geometry will cause image to be	745	Additional operations can be specified after colon B<:op1:op2...>.
709	automatically scaled to match window size.	746	Supported operations are:
		747
		748	tile force background image to be tiled and not scaled. Equivalent to 0x0
		749	propscale will scale image keeping proportions
		750	auto will scale image to match window size. Equivalent to 100x100
		751	hscale will scale image horizontally to the window size
		752	vscale will scale image vertically to the window size
		753	scale will scale image to match window size
		754	root will tile image as if it was a root window background, auto-adjusting
		755	whenever terminal window moves
		756
710	If used in conjunction with B<-tr> option - specified pixmap will be	757	If used in conjunction with B<-tr> option, the specified pixmap will be
711	blended over transparency image using either alpha-blending, or any	758	blended over transparency image using either alpha-blending, or any
712	other blending type, specified with B<-blt "type"> option.	759	other blending type, specified with B<-blt "type"> option.
713	[default 0x0+50+50]
714		760
715	=item B<path:> I<path>	761	=item B<path:> I<path>
716		762
717	Specify the colon-delimited search path for finding background image files.	763	Specify the colon-delimited search path for finding background image files.
718		764
…		…
779	text font will being used for the given style.	825	text font will being used for the given style.
780		826
781	=item B<intensityStyles:> I<boolean>	827	=item B<intensityStyles:> I<boolean>
782		828
783	When font styles are not enabled, or this option is enabled (B<True>,	829	When font styles are not enabled, or this option is enabled (B<True>,
784	option B<-is>, the default), bold and italic font styles imply high	830	option B<-is>, the default), bold/blink font styles imply high
785	intensity foreground/background colours. Disabling this option (B<False>,	831	intensity foreground/background colours. Disabling this option (B<False>,
786	option B<+is>) disables this behaviour, the high intensity colours are not	832	option B<+is>) disables this behaviour, the high intensity colours are not
787	reachable.	833	reachable.
788		834
789	=item B<selectstyle:> I<mode>
790
791	Set mouse selection style to B<old> which is 2.20, B<oldword> which
792	is xterm style with 2.20 old word selection, or anything else which
793	gives xterm style selection. Only effective when the original (non-perl)
794	selection code is in use.
795
796	=item B<scrollstyle:> I<mode>
797
798	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
799	the author's favourite.
800
801	=item B<title:> I<string>	835	=item B<title:> I<string>
802		836
803	Set window title string, the default title is the command-line	837	Set window title string, the default title is the command-line
804	specified after the B<-e> option, if any, otherwise the application	838	specified after the B<-e> option, if any, otherwise the application
805	name; option B<-title>.	839	name; option B<-title>.
…		…
849		883
850	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	884	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
851		885
852	This creates a new file in your home directory with the screen contents	886	This creates a new file in your home directory with the screen contents
853	every time you hit C<Print>.	887	every time you hit C<Print>.
		888
		889	=item B<scrollstyle:> I<mode>
		890
		891	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		892	the author's favourite.
854		893
855	=item B<scrollBar:> I<boolean>	894	=item B<scrollBar:> I<boolean>
856		895
857	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	896	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
858	disable the scrollbar; option B<+sb>.	897	disable the scrollbar; option B<+sb>.
…		…
991	will be created). In this mode, characters outside ISO-8859-1 can be used.	1030	will be created). In this mode, characters outside ISO-8859-1 can be used.
992		1031
993	When the selection extension is not used, only ISO-8859-1 characters can	1032	When the selection extension is not used, only ISO-8859-1 characters can
994	be used. If not specified, the built-in default is used:	1033	be used. If not specified, the built-in default is used:
995		1034
996	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	1035	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
997		1036
998	=item B<preeditType:> I<style>	1037	=item B<preeditType:> I<style>
999		1038
1000	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1039	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
1001		1040
…		…
1057		1096
1058	=item B<secondaryScroll:> I<boolean>	1097	=item B<secondaryScroll:> I<boolean>
1059		1098
1060	Turn on/off secondary screen scroll (default enabled). If this	1099	Turn on/off secondary screen scroll (default enabled). If this
1061	option is enabled, scrolls on the secondary screen will change the	1100	option is enabled, scrolls on the secondary screen will change the
1062	scrollback buffer and switching to/from the secondary screen will	1101	scrollback buffer and, when secondaryScreen is off, switching
1063	instead scroll the screen up.	1102	to/from the secondary screen will instead scroll the screen up.
1064		1103
1065	=item B<hold>: I<boolean>	1104	=item B<hold>: I<boolean>
1066		1105
1067	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1106	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1068	will not immediately destroy its window when the program executed within	1107	will not immediately destroy its window when the program executed within
1069	it exits. Instead, it will wait till it is being killed or closed by the	1108	it exits. Instead, it will wait till it is being killed or closed by the
1070	user.	1109	user.
		1110
		1111	=item B<chdir>: I<path>
		1112
		1113	Sets the working directory for the shell (or the command specified via
		1114	B<-e>). The I<path> must be an absolute path and it must exist for
		1115	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1116	directory will be used; option B<-cd>.
1071		1117
1072	=item B<keysym.>I<sym>: I<string>	1118	=item B<keysym.>I<sym>: I<string>
1073		1119
1074	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1120	Compile I<frills>: Associate I<string> with keysym I<sym>. The
1075	intervening resource name B<keysym.> cannot be omitted.	1121	intervening resource name B<keysym.> cannot be omitted.
…		…
1436	=back	1482	=back
1437		1483
1438	=head2 ALPHA CHANNEL SUPPORT	1484	=head2 ALPHA CHANNEL SUPPORT
1439		1485
1440	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1486	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1441	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>	1487	their act together, rxvt-unicode will do it's own alpha channel management:
1442	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1488
1443	in addition to the ones provided by X, where the additional A component	1489	You can prefix any color with an opaquenes percentage enclosed in
		1490	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1491	(0-100) that specifies the opacity of the color, where C<0> is completely
		1492	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1493	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1494	is the recommended format to specify transparency values, and works with
		1495	all ways to specify a colour.
		1496
		1497	For complete control, rxvt-unicode also supports
		1498	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1499	specifications, where the additional C<aaaa> component specifies opacity
1444	specifies opacity (alpha) values. The minimum value of C<0> is completely	1500	(alpha) values. The minimum value of C<0000> is completely transparent,
1445	transparent). You can also prefix any color with C<[percent]>, where	1501	while C<ffff> is completely opaque). The two example colours from
1446	C<percent> is a decimal percentage (0-100) that specifies the opacity of	1502	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1447	the color, where C<0> is completely transparent and C<100> is completelxy	1503	C<rgba:0000/ff00/0000/f332>.
1448	opaque.
1449		1504
1450	You probably need to specify B<"-depth 32">, too, and have the luck that	1505	You probably need to specify B<"-depth 32">, too, to force a visual with
1451	your X-server uses ARGB pixel layout, as X is far from just supporting	1506	alpha channels, and have the luck that your X-server uses ARGB pixel
1452	ARGB visuals out of the box, and rxvt-unicode just fudges around.	1507	layout, as X is far from just supporting ARGB visuals out of the box, and
		1508	rxvt-unicode just fudges around.
1453		1509
1454	For example, the following selects an almost completely transparent red	1510	For example, the following selects an almost completely transparent black
1455	background, and an almost opaque pink foreground:	1511	background, and an almost opaque pink foreground:
1456		1512
1457	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"	1513	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1458		1514
1459	I<Please note that transparency of any kind if completely unsupported by	1515	When not using a background image, then the interpretation of the
1460	the author. Don't bug him with installation questions!>	1516	alpha channel is up to your compositing manager (most interpret it as
		1517	transparency of course).
		1518
		1519	When using a background pixmap or pseudo-transparency, then the background
		1520	colour will always behave as if it were completely transparent (so the
		1521	background image shows instead), regardless of how it was specified, while
		1522	other colours will either be transparent as specified (the background
		1523	image will show through) on servers supporting the RENDER extension, or
		1524	fully opaque on servers not supporting the RENDER EXTENSION.
		1525
		1526	Please note that due to bugs in Xft, specifying alpha values might result
		1527	in garbage being displayed when the X-server does not support the RENDER
		1528	extension.
1461		1529
1462	=head1 ENVIRONMENT	1530	=head1 ENVIRONMENT
1463		1531
1464	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1532	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1465		1533
…		…
1471	resources or on the command line.	1539	resources or on the command line.
1472		1540
1473	=item B<COLORTERM>	1541	=item B<COLORTERM>
1474		1542
1475	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was	1543	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1476	compiled with background image support, and optionally with the added	1544	compiled with background image support, and optionally with the added
1477	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome	1545	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1478	screen.	1546	screen.
1479		1547
1480	=item B<COLORFGBG>	1548	=item B<COLORFGBG>
1481		1549
1482	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1550	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1483	the colour code used as default foreground/text colour (or the string	1551	the colour code used as default foreground/text colour (or the string
1484	C<default> to indicate that the default-colour escape sequence is to be	1552	C<default> to indicate that the default-colour escape sequence is to be
1485	used), C<bg> is the colour code used as default background colour (or the	1553	used), C<bg> is the colour code used as default background colour (or the
1486	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1554	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1487	was compiled with background image support. Libraries like C<ncurses>	1555	was compiled with background image support. Libraries like C<ncurses>
1488	and C<slang> can (and do) use this information to optimize screen output.	1556	and C<slang> can (and do) use this information to optimize screen output.
1489		1557
1490	=item B<WINDOWID>	1558	=item B<WINDOWID>
1491		1559
1492	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1560	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
…		…
1499	C<--with-terminfo=PATH>.	1567	C<--with-terminfo=PATH>.
1500		1568
1501	=item B<DISPLAY>	1569	=item B<DISPLAY>
1502		1570
1503	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1571	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1504	display in its child processes.	1572	display in its child processes if C<-display> isn't used to override. It
		1573	defaults to C<:0> if it doesn't exist.
1505		1574
1506	=item B<SHELL>	1575	=item B<SHELL>
1507		1576
1508	The shell to be used for command execution, defaults to C</bin/sh>.	1577	The shell to be used for command execution, defaults to C</bin/sh>.
1509		1578
…		…
1584	Project Coordinator (changes.txt 2.21a to 2.4.5)	1653	Project Coordinator (changes.txt 2.21a to 2.4.5)
1585		1654
1586	=item Geoff Wing L<< <gcw@pobox.com> >>	1655	=item Geoff Wing L<< <gcw@pobox.com> >>
1587		1656
1588	Rewrote screen display and text selection routines.	1657	Rewrote screen display and text selection routines.
1589		1658
1590	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1659	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1591		1660
1592	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1661	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1593		1662
1594	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1663	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.141 by sasha, Mon Oct 29 13:40:41 2007 UTC vs. Revision 1.165 by root, Thu Oct 2 17:06:50 2008 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.141 by sasha, Mon Oct 29 13:40:41 2007 UTC vs.
Revision 1.165 by root, Thu Oct 2 17:06:50 2008 UTC