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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.130 by sasha, Fri Jun 8 20:04:12 2007 UTC vs.
Revision 1.164 by root, Sun Jun 15 13:54:15 2008 UTC

…		…
12	emulator intended as an I<xterm>(1) replacement for users who do not	12	emulator intended as an I<xterm>(1) replacement for users who do not
13	require features such as Tektronix 4014 emulation and toolkit-style	13	require features such as Tektronix 4014 emulation and toolkit-style
14	configurability. As a result, B<rxvt-unicode> uses much less swap space --	14	configurability. As a result, B<rxvt-unicode> uses much less swap space --
15	a significant advantage on a machine serving many X sessions.	15	a significant advantage on a machine serving many X sessions.
16		16
		17	This document is also available on the World-Wide-Web at
		18	L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
		19
17	=head1 FREQUENTLY ASKED QUESTIONS	20	=head1 FREQUENTLY ASKED QUESTIONS
18		21
19	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of	22	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20	frequently asked questions and answer to them and some common	23	frequently asked questions and answer to them and some common
21	problems. That document is also accessible on the World-Wide-Web at	24	problems. That document is also accessible on the World-Wide-Web at
22	L<http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>.	25	L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
23		26
24	=head1 RXVT-UNICODE VS. RXVT	27	=head1 RXVT-UNICODE VS. RXVT
25		28
26	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode	29	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
27	internally. That means it can store and display most scripts in the	30	internally. That means it can store and display most scripts in the
28	world. Being a terminal emulator, however, some things are very difficult,	31	world. Being a terminal emulator, however, some things are very difficult,
29	especially cursive scripts such as arabic, vertically written scripts	32	especially cursive scripts such as arabic, vertically written scripts
30	like mongolian or scripts requiring extremely complex combining rules,	33	like mongolian or scripts requiring extremely complex combining rules,
31	like tibetan or devenagari. Don't expect pretty output when using these	34	like tibetan or devanagari. Don't expect pretty output when using these
32	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work	35	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
33	fine, though. A somewhat difficult case are right-to-left scripts, such	36	fine, though. A somewhat difficult case are right-to-left scripts, such
34	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms	37	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
35	belong into the application, not the terminal emulator (too many things --	38	belong in the application, not the terminal emulator (too many things --
36	such as cursor-movement while editing -- break otherwise), but that might	39	such as cursor-movement while editing -- break otherwise), but that might
37	change.	40	change.
38		41
39	If you are looking for a terminal that supports more exotic scripts, let	42	If you are looking for a terminal that supports more exotic scripts, let
40	me recommend C<mlterm>, which is a very user friendly, lean and clean	43	me recommend C<mlterm>, which is a very user friendly, lean and clean
…		…
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>
108		116
109	Turn on/off simulated reverse video; resource B<reverseVideo>.	117	Turn on/off simulated reverse video; resource B<reverseVideo>.
110		118
111	=item B<-j>\|B<+j>	119	=item B<-j>\|B<+j>
112		120
113	Turn on/off jump scrolling; resource B<jumpScroll>.	121	Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
114		122
115	=item B<-ip>\|B<+ip> \| B<-tr>\|B<+tr>	123	=item B<-ss>\|B<+ss>
116		124
117	Turn on/off inheriting parent window's pixmap. Alternative form is	125	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
118	B<-tr>; resource B<inheritPixmap>.
119		126
120	I<Please note that transparency of any kind if completely unsupported by	127	=item B<-tr>\|B<+tr>
121	the author. Don't bug him with installation questions! Read the FAQ (man 7	128
122	@@RXVT_NAME@@)!>	129	Turn on/off illusion of a transparent window background; resource B<transparent>.
		130
		131	B<-ip> is still accepted as an obsolete alias but will be removed in
		132	future versions.
		133
		134	I<Please address all transparency related issues to Sasha Vasko at
		135	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
123		136
124	=item B<-fade> I<number>	137	=item B<-fade> I<number>
125		138
126	Fade the text by the given percentage when focus is lost. Small values	139	Fade the text by the given percentage when focus is lost. Small values
127	fade a little only, 100 completely replaces all colours by the fade	140	fade a little only, 100 completely replaces all colours by the fade
…		…
133	is opaque black. resource B<fadeColor>.	146	is opaque black. resource B<fadeColor>.
134		147
135	=item B<-tint> I<colour>	148	=item B<-tint> I<colour>
136		149
137	Tint the transparent background pixmap with the given colour when	150	Tint the transparent background pixmap with the given colour when
138	transparency is enabled with B<-tr> or B<-ip>. This only works for	151	transparency is enabled with B<-tr>. This only works for
139	non-tiled backgrounds, currently. See also the B<-sh> option that can be	152	non-tiled backgrounds, currently. See also the B<-sh> option that can be
140	used to brighten or darken the image in addition to tinting it; resource	153	used to brighten or darken the image in addition to tinting it.
		154	Please note that certain tint colours can be applied on the server-side,
		155	thus yielding performance gain of two orders of magnitude. These colours are:
		156	blue, red, green, cyan, magenta, yellow, and those close to them. Also
		157	pure black and pure white colors essentially mean no tinting; resource
141	I<tintColor>. Example:	158	I<tintColor>. Example:
142		159
143	@@RXVT_NAME@@ -tr -tint blue -sh 40	160	@@RXVT_NAME@@ -tr -tint blue -sh 40
144		161
145	=item B<-sh> I<number>	162	=item B<-sh> I<number>
146		163
147	Darken (0 .. 100) or lighten (-1 .. -100) the transparent	164	Darken (0 .. 100) or lighten (100 .. 200) the transparent
148	background image in addition to (or instead of) tinting it;	165	background image in addition to (or instead of) tinting it;
149	resource I<shading>.	166	resource I<shading>.
150		167
151	=item B<-blt> I<string>	168	=item B<-blt> I<string>
152		169
153	Specify background blending type. If background pixmap is specified	170	Specify background blending type. If background pixmap is specified
154	at the same time as transparency - such pixmap will be blended over	171	at the same time as transparency - such pixmap will be blended over
155	transparency image, using method specified. Supported values are :	172	transparency image, using method specified. Supported values are :
156	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,	173	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
157	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,	174	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
158	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is	175	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
159	alpha-blending; resource I<blendType>.	176	alpha-blending. Compile I<afterimage>; resource I<blendType>.
160		177
161	=item B<-blr> I<number>	178	=item B<-blr> I<HxV>
162		179
163	Apply Gaussian Blur with the specified radius to the transparent	180	Apply Gaussian Blur with the specified radii to the transparent
164	background image; resource I<blurRadius>.	181	background image. If single number is specified - both vertical and
		182	horizontal radii are considered to be the same. Setting one of the
		183	radii to 1 and another to a large number creates interesting effects
		184	on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
		185	resource I<blurRadius>.
165		186
166	=item B<-bg> I<colour>	187	=item B<-bg> I<colour>
167		188
168	Window background colour; resource B<background>.	189	Window background colour; resource B<background>.
169		190
170	=item B<-fg> I<colour>	191	=item B<-fg> I<colour>
171		192
172	Window foreground colour; resource B<foreground>.	193	Window foreground colour; resource B<foreground>.
173		194
174	=item B<-pixmap> I<file[;geom]>	195	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
175		196
176	Compile I<afterimage>: Specify image file for the background and also	197	Compile I<afterimage>: Specify image file for the background and also
177	optionally specify its scaling with a geometry string. Note you may need to	198	optionally specify its scaling with a geometry string. Note you may need to
178	add quotes to avoid special shell interpretation of the C<;> in the	199	add quotes to avoid special shell interpretation of the C<;> in the
179	command-line; for more details see resource B<backgroundPixmap>.	200	command-line; for more details see resource B<backgroundPixmap>.
180		201
181	=item B<-cr> I<colour>	202	=item B<-cr> I<colour>
…		…
229	italic> >> characters are to be printed. See resource B<boldItalicFont>	250	italic> >> characters are to be printed. See resource B<boldItalicFont>
230	for details.	251	for details.
231		252
232	=item B<-is>\|B<+is>	253	=item B<-is>\|B<+is>
233		254
234	Compile I<font-styles>: Bold/Italic font styles imply high intensity	255	Compile I<font-styles>: Bold/Blink font styles imply high intensity
235	foreground/background (default). See resource B<intensityStyles> for	256	foreground/background (default). See resource B<intensityStyles> for
236	details.	257	details.
237		258
238	=item B<-name> I<name>	259	=item B<-name> I<name>
239		260
…		…
257		278
258	=item B<-sb>\|B<+sb>	279	=item B<-sb>\|B<+sb>
259		280
260	Turn on/off scrollbar; resource B<scrollBar>.	281	Turn on/off scrollbar; resource B<scrollBar>.
261		282
		283	=item B<-sr>\|B<+sr>
		284
		285	Put scrollbar on right/left; resource B<scrollBar_right>.
		286
		287	=item B<-st>\|B<+st>
		288
		289	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
		290	resource B<scrollBar_floating>.
		291
262	=item B<-si>\|B<+si>	292	=item B<-si>\|B<+si>
263		293
264	Turn on/off scroll-to-bottom on TTY output inhibit; resource	294	Turn on/off scroll-to-bottom on TTY output inhibit; resource
265	B<scrollTtyOutput> has opposite effect.	295	B<scrollTtyOutput> has opposite effect.
266		296
…		…
272	=item B<-sw>\|B<+sw>	302	=item B<-sw>\|B<+sw>
273		303
274	Turn on/off scrolling with the scrollback buffer as new lines appear.	304	Turn on/off scrolling with the scrollback buffer as new lines appear.
275	This only takes effect if B<-si> is also given; resource	305	This only takes effect if B<-si> is also given; resource
276	B<scrollWithBuffer>.	306	B<scrollWithBuffer>.
277
278	=item B<-sr>\|B<+sr>
279
280	Put scrollbar on right/left; resource B<scrollBar_right>.
281
282	=item B<-st>\|B<+st>
283
284	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
285	resource B<scrollBar_floating>.
286		307
287	=item B<-ptab>\|B<+ptab>	308	=item B<-ptab>\|B<+ptab>
288		309
289	If enabled (default), "Horizontal Tab" characters are being stored as	310	If enabled (default), "Horizontal Tab" characters are being stored as
290	actual wide characters in the screen buffer, which makes it possible to	311	actual wide characters in the screen buffer, which makes it possible to
…		…
337		358
338	=item B<-lsp> I<number>	359	=item B<-lsp> I<number>
339		360
340	Compile I<frills>: Lines (pixel height) to insert between each row of	361	Compile I<frills>: Lines (pixel height) to insert between each row of
341	the display. Useful to work around font rendering problems; resource	362	the display. Useful to work around font rendering problems; resource
342	B<linespace>.	363	B<lineSpace>.
343		364
344	=item B<-tn> I<termname>	365	=item B<-tn> I<termname>
345		366
346	This option specifies the name of the terminal type to be set in the	367	This option specifies the name of the terminal type to be set in the
347	B<TERM> environment variable. This terminal type must exist in the	368	B<TERM> environment variable. This terminal type must exist in the
…		…
402		423
403	=item B<-tcw>	424	=item B<-tcw>
404		425
405	Change the meaning of triple-click selection with the left mouse	426	Change the meaning of triple-click selection with the left mouse
406	button. Only effective when the original (non-perl) selection code is	427	button. Only effective when the original (non-perl) selection code is
407	in-use. Instead of selecting a full line it will extend the selection the	428	in-use. Instead of selecting a full line it will extend the selection to
408	end of the logical line only. resource B<tripleclickwords>.	429	the end of the logical line only. resource B<tripleclickwords>.
409		430
410	=item B<-insecure>	431	=item B<-insecure>
411		432
412	Enable "insecure" mode, which currently enables most of the escape	433	Enable "insecure" mode, which currently enables most of the escape
413	sequences that echo strings. See the resource B<insecure> for more	434	sequences that echo strings. See the resource B<insecure> for more
…		…
433		454
434	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	455	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
435	will not immediately destroy its window when the program executed within	456	will not immediately destroy its window when the program executed within
436	it exits. Instead, it will wait till it is being killed or closed by the	457	it exits. Instead, it will wait till it is being killed or closed by the
437	user; resource B<hold>.	458	user; resource B<hold>.
		459
		460	=item B<-cd> I<path>
		461
		462	Sets the working directory for the shell (or the command specified via
		463	B<-e>). The I<path> must be an absolute path and it must exist for
		464	@@RXVT_NAME@@ to start; resource B<chdir>.
		465
		466	=item B<-xrm> I<string>
		467
		468	Works like the X Toolkit option of the same name, by adding the I<string>
		469	as if it were specified in a resource file. Resource values specified this
		470	way take precedence over all other resource specifications.
		471
		472	Note that you need to use the I<same> syntax as in the .Xdefaults file,
		473	e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
		474	options can be specified as long-options on the commandline, so use
		475	of B<-xrm> is mostly limited to cases where you want to specify other
		476	resources (e.g. for input methods) or for compatibility with other
		477	programs.
438		478
439	=item B<-keysym.>I<sym> I<string>	479	=item B<-keysym.>I<sym> I<string>
440		480
441	Remap a key symbol. See resource B<keysym>.	481	Remap a key symbol. See resource B<keysym>.
442		482
…		…
477	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	517	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
478	entries and will not tinker with pty/tty permissions - you have to do that	518	entries and will not tinker with pty/tty permissions - you have to do that
479	yourself if you want that.	519	yourself if you want that.
480		520
481	As an extremely special case, specifying C<-1> will completely suppress	521	As an extremely special case, specifying C<-1> will completely suppress
482	pty/tty operations.	522	pty/tty operations, which is probably only useful in conjunction with some
		523	perl extension that manages the terminal.
483		524
484	Here is a example in perl that illustrates how this option can be used (a	525	Here is a example in perl that illustrates how this option can be used (a
485	longer example is in F<doc/pty-fd>):	526	longer example is in F<doc/pty-fd>):
486		527
487	use IO::Pty;	528	use IO::Pty;
…		…
501	Comma-separated list of perl extension scripts to use (or not to use) in	542	Comma-separated list of perl extension scripts to use (or not to use) in
502	this terminal instance. See resource B<perl-ext> for details.	543	this terminal instance. See resource B<perl-ext> for details.
503		544
504	=back	545	=back
505		546
506	=head1 RESOURCES (available also as long-options)	547	=head1 RESOURCES
507		548
508	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	549	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
509	options) compiled into your version.	550	options) compiled into your version. All resources are also available as
		551	long-options.
510		552
511	You can set and change the resources using X11 tools like B<xrdb>. Many	553	You can set and change the resources using X11 tools like B<xrdb>. Many
512	distribution do also load settings from the B<~/.Xresources> file when X	554	distribution do also load settings from the B<~/.Xresources> file when X
513	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	555	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
514	with later settings overwriting earlier ones:	556	with later settings overwriting earlier ones:
…		…
516	1. system-wide app-defaults file, either locale-dependent OR global	558	1. system-wide app-defaults file, either locale-dependent OR global
517	2. app-defaults file in $XAPPLRESDIR	559	2. app-defaults file in $XAPPLRESDIR
518	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	560	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
519	4. SCREEN_RESOURCES for the current screen	561	4. SCREEN_RESOURCES for the current screen
520	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	562	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		563	6. resources specified via -xrm on the commandline
521		564
522	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	565	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
523	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources	566	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
524	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily	567	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
525	configured, while the class name B<URxvt> allows resources unique to	568	configured, while the class name B<URxvt> allows resources unique to
…		…
535	=item B<depth:> I<bitdepth>	578	=item B<depth:> I<bitdepth>
536		579
537	Compile I<xft>: Attempt to find a visual with the given bit depth;	580	Compile I<xft>: Attempt to find a visual with the given bit depth;
538	option B<-depth>.	581	option B<-depth>.
539		582
		583	=item B<buffered:> I<boolean>
		584
		585	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		586	On some card/driver combination enabling it slightly decreases
		587	performance, on most it greatly helps it. The slowdown is small, so it
		588	should normally be enabled.
		589
540	=item B<geometry:> I<geom>	590	=item B<geometry:> I<geom>
541		591
542	Create the window with the specified X window geometry [default 80x24];	592	Create the window with the specified X window geometry [default 80x24];
543	option B<-geometry>.	593	option B<-geometry>.
544		594
…		…
607	option B<-rv>. B<False>: regular screen colours [default]; option	657	option B<-rv>. B<False>: regular screen colours [default]; option
608	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	658	B<+rv>. See note in B<COLORS AND GRAPHICS> section.
609		659
610	=item B<jumpScroll:> I<boolean>	660	=item B<jumpScroll:> I<boolean>
611		661
612	B<True>: specify that jump scrolling should be used. When scrolling	662	B<True>: specify that jump scrolling should be used. When receiving lots
613	quickly, fewer screen updates are performed [default]; option B<-j>.	663	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
		664	has been read, resulting in fewer updates while still displaying every
		665	received line; option B<-j>.
		666
614	B<False>: specify that smooth scrolling should be used; option B<+j>.	667	B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
		668	force a screen refresh on each new line it received; option B<+j>.
615		669
616	=item B<inheritPixmap:> I<boolean>	670	=item B<skipScroll:> I<boolean>
617		671
618	B<True>: make the background inherit the parent windows' pixmap, giving	672	B<True>: (the default) specify that skip scrolling should be used. When
619	artificial transparency. B<False>: do not inherit the parent windows'	673	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
620	pixmap.	674	(around 60 times per second), resulting in far fewer updates. This can
		675	result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
		676	option B<-ss>.
621		677
622	I<Please note that transparency of any kind if completely unsupported by	678	B<False>: specify that everything is to be displayed, even
623	the author. Don't bug him with installation questions!>	679	if the refresh is too fast for the human eye to read anything (or the
		680	monitor to display anything); option B<+ss>.
		681
		682	=item B<transparent:> I<boolean>
		683
		684	Turn on/off illusion of a transparent window background.
		685
		686	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
		687	future versions.
		688
		689	I<Please address all transparency related issues to Sasha Vasko at
		690	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
624		691
625	=item B<fading:> I<number>	692	=item B<fading:> I<number>
626		693
627	Fade the text by the given percentage when focus is lost; option B<-fade>.	694	Fade the text by the given percentage when focus is lost; option B<-fade>.
628		695
…		…
645		712
646	Specify background blending type; option B<-blt>.	713	Specify background blending type; option B<-blt>.
647		714
648	=item B<blurRadius:> I<number>	715	=item B<blurRadius:> I<number>
649		716
650	Apply Gaussian Blurr with the specified radius to the transparent	717	Apply Gaussian Blurr with the specified radius to the transparent
651	background image; option B<-blr>.	718	background image; option B<-blr>.
652		719
653	=item B<scrollColor:> I<colour>	720	=item B<scrollColor:> I<colour>
654		721
655	Use the specified colour for the scrollbar [default #B2B2B2].	722	Use the specified colour for the scrollbar [default #B2B2B2].
…		…
662	=item B<borderColor:> I<colour>	729	=item B<borderColor:> I<colour>
663		730
664	The colour of the border around the text area and between the scrollbar	731	The colour of the border around the text area and between the scrollbar
665	and the text.	732	and the text.
666		733
667	=item B<backgroundPixmap:> I<file[;geom]>	734	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
668		735
669	Use the specified image file for the background and also optionally	736	Use the specified image file for the background and also
670	specify its scaling with a geometry string B<WxH+X+Y>,	737	optionally specify its scaling with a geometry string B<WxH+X+Y>,
671	in which B<"W" / "H"> specify the horizontal/vertical scale (percent),	738	(default C<0x0+50+50>) in which B<"W" / "H"> specify the
672	and B<"X" / "Y"> locate the image centre (percent).	739	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
673	A scale of 0 displays the image with tiling. A scale of 1 displays the	740	centre (percent). A scale of 0 displays the image with tiling. A scale
674	image without any scaling. A scale of 2 to 9 specifies an integer	741	of 1 displays the image without any scaling. A scale of 2 to 9 specifies
675	number of images in that direction. No image will be magnified beyond	742	an integer number of images in that direction. No image will be magnified
676	10 times its original size. The maximum permitted scale is 1000.	743	beyond 10 times its original size. The maximum permitted scale is 1000.
677	Special string of B<"auto"> used as a geometry will cause image to be	744	Additional operations can be specified after colon B<:op1:op2...>.
678	automatically scaled to match window size.	745	Supported operations are:
		746
		747	tile force background image to be tiled and not scaled. Equivalent to 0x0
		748	propscale will scale image keeping proportions
		749	auto will scale image to match window size. Equivalent to 100x100
		750	hscale will scale image horizontally to the window size
		751	vscale will scale image vertically to the window size
		752	scale will scale image to match window size
		753	root will tile image as if it was a root window background, auto-adjusting
		754	whenever terminal window moves
		755
679	If used in conjunction with B<-tr> option - specified pixmap will be	756	If used in conjunction with B<-tr> option, the specified pixmap will be
680	blended over transparency image using either alpha-blending, or any	757	blended over transparency image using either alpha-blending, or any
681	other blending type, specified with B<-blt "type"> option.	758	other blending type, specified with B<-blt "type"> option.
682	[default 0x0+50+50]
683		759
684	=item B<path:> I<path>	760	=item B<path:> I<path>
685		761
686	Specify the colon-delimited search path for finding XPM files.	762	Specify the colon-delimited search path for finding background image files.
687		763
688	=item B<font:> I<fontlist>	764	=item B<font:> I<fontlist>
689		765
690	Select the fonts to be used. This is a comma separated list of font names	766	Select the fonts to be used. This is a comma separated list of font names
691	that are checked in order when trying to find glyphs for characters. The	767	that are checked in order when trying to find glyphs for characters. The
…		…
748	text font will being used for the given style.	824	text font will being used for the given style.
749		825
750	=item B<intensityStyles:> I<boolean>	826	=item B<intensityStyles:> I<boolean>
751		827
752	When font styles are not enabled, or this option is enabled (B<True>,	828	When font styles are not enabled, or this option is enabled (B<True>,
753	option B<-is>, the default), bold and italic font styles imply high	829	option B<-is>, the default), bold/blink font styles imply high
754	intensity foreground/background colours. Disabling this option (B<False>,	830	intensity foreground/background colours. Disabling this option (B<False>,
755	option B<+is>) disables this behaviour, the high intensity colours are not	831	option B<+is>) disables this behaviour, the high intensity colours are not
756	reachable.	832	reachable.
757		833
758	=item B<selectstyle:> I<mode>
759
760	Set mouse selection style to B<old> which is 2.20, B<oldword> which
761	is xterm style with 2.20 old word selection, or anything else which
762	gives xterm style selection. Only effective when the original (non-perl)
763	selection code is in use.
764
765	=item B<scrollstyle:> I<mode>
766
767	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
768	the author's favourite.
769
770	=item B<title:> I<string>	834	=item B<title:> I<string>
771		835
772	Set window title string, the default title is the command-line	836	Set window title string, the default title is the command-line
773	specified after the B<-e> option, if any, otherwise the application	837	specified after the B<-e> option, if any, otherwise the application
774	name; option B<-title>.	838	name; option B<-title>.
…		…
818		882
819	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	883	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
820		884
821	This creates a new file in your home directory with the screen contents	885	This creates a new file in your home directory with the screen contents
822	every time you hit C<Print>.	886	every time you hit C<Print>.
		887
		888	=item B<scrollstyle:> I<mode>
		889
		890	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		891	the author's favourite.
823		892
824	=item B<scrollBar:> I<boolean>	893	=item B<scrollBar:> I<boolean>
825		894
826	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	895	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
827	disable the scrollbar; option B<+sb>.	896	disable the scrollbar; option B<+sb>.
…		…
890	=item B<termName:> I<termname>	959	=item B<termName:> I<termname>
891		960
892	Specifies the terminal type name to be set in the B<TERM> environment	961	Specifies the terminal type name to be set in the B<TERM> environment
893	variable; option B<-tn>.	962	variable; option B<-tn>.
894		963
895	=item B<linespace:> I<number>	964	=item B<lineSpace:> I<number>
896		965
897	Specifies number of lines (pixel height) to insert between each row of	966	Specifies number of lines (pixel height) to insert between each row of
898	the display [default 0]; option B<-lsp>.	967	the display [default 0]; option B<-lsp>.
899		968
900	=item B<meta8:> I<boolean>	969	=item B<meta8:> I<boolean>
…		…
960	will be created). In this mode, characters outside ISO-8859-1 can be used.	1029	will be created). In this mode, characters outside ISO-8859-1 can be used.
961		1030
962	When the selection extension is not used, only ISO-8859-1 characters can	1031	When the selection extension is not used, only ISO-8859-1 characters can
963	be used. If not specified, the built-in default is used:	1032	be used. If not specified, the built-in default is used:
964		1033
965	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	1034	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
966		1035
967	=item B<preeditType:> I<style>	1036	=item B<preeditType:> I<style>
968		1037
969	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1038	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
970		1039
…		…
1026		1095
1027	=item B<secondaryScroll:> I<boolean>	1096	=item B<secondaryScroll:> I<boolean>
1028		1097
1029	Turn on/off secondary screen scroll (default enabled). If this	1098	Turn on/off secondary screen scroll (default enabled). If this
1030	option is enabled, scrolls on the secondary screen will change the	1099	option is enabled, scrolls on the secondary screen will change the
1031	scrollback buffer and switching to/from the secondary screen will	1100	scrollback buffer and, when secondaryScreen is off, switching
1032	instead scroll the screen up.	1101	to/from the secondary screen will instead scroll the screen up.
1033		1102
1034	=item B<hold>: I<boolean>	1103	=item B<hold>: I<boolean>
1035		1104
1036	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1105	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1037	will not immediately destroy its window when the program executed within	1106	will not immediately destroy its window when the program executed within
1038	it exits. Instead, it will wait till it is being killed or closed by the	1107	it exits. Instead, it will wait till it is being killed or closed by the
1039	user.	1108	user.
		1109
		1110	=item B<chdir>: I<path>
		1111
		1112	Sets the working directory for the shell (or the command specified via
		1113	B<-e>). The I<path> must be an absolute path and it must exist for
		1114	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1115	directory will be used; option B<-cd>.
1040		1116
1041	=item B<keysym.>I<sym>: I<string>	1117	=item B<keysym.>I<sym>: I<string>
1042		1118
1043	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1119	Compile I<frills>: Associate I<string> with keysym I<sym>. The
1044	intervening resource name B<keysym.> cannot be omitted.	1120	intervening resource name B<keysym.> cannot be omitted.
…		…
1058	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1134	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1059	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1135	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1060	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1136	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1061	performed in an exact manner; however, the closest match is assured.	1137	performed in an exact manner; however, the closest match is assured.
1062		1138
1063	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1139	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1064	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1140	number), see RESOURCES in C<man 7 X> for futher details.
1065	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1066	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1067	can start or end with whitespace. B<This feature is deprecated and will
1068	be removed>.
1069
1070	Please note that you need to double the C<\> in resource files, as
1071	Xlib itself does its own de-escaping (you can use C<\033> instead of
1072	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1073	processing).
1074		1141
1075	You can define a range of keysyms in one shot by providing a I<string>	1142	You can define a range of keysyms in one shot by providing a I<string>
1076	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1143	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1077	should be a character not used by the strings.	1144	should be a character not used by the strings.
1078		1145
…		…
1202	=item B<override-redirect>: I<boolean>	1269	=item B<override-redirect>: I<boolean>
1203		1270
1204	Compile I<frills>: Sets override-redirect for the terminal window, making	1271	Compile I<frills>: Sets override-redirect for the terminal window, making
1205	it almost invisible to window managers; option B<-override-redirect>.	1272	it almost invisible to window managers; option B<-override-redirect>.
1206		1273
		1274	=item B<iso14755_52:> I<boolean>
		1275
		1276	Turn on/off ISO 14755 5.2 mode (default enabled).
		1277
1207	=back	1278	=back
1208		1279
1209	=head1 THE SCROLLBAR	1280	=head1 THE SCROLLBAR
1210		1281
1211	Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window	1282	Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window
…		…
1281		1352
1282	=head1 ISO 14755 SUPPORT	1353	=head1 ISO 14755 SUPPORT
1283		1354
1284	ISO 14755 is a standard for entering and viewing unicode characters	1355	ISO 14755 is a standard for entering and viewing unicode characters
1285	and character codes using the keyboard. It consists of 4 parts. The	1356	and character codes using the keyboard. It consists of 4 parts. The
1286	first part is available rxvt-unicode has been compiled with	1357	first part is available if rxvt-unicode has been compiled with
1287	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1358	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1288	with C<--enable-iso14755>.	1359	with C<--enable-iso14755>.
1289		1360
1290	=over 4	1361	=over 4
1291		1362
…		…
1410	=back	1481	=back
1411		1482
1412	=head2 ALPHA CHANNEL SUPPORT	1483	=head2 ALPHA CHANNEL SUPPORT
1413		1484
1414	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1485	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1415	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>	1486	their act together, rxvt-unicode will do it's own alpha channel management:
1416	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1487
1417	in addition to the ones provided by X, where the additional A component	1488	You can prefix any color with an opaquenes percentage enclosed in
		1489	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1490	(0-100) that specifies the opacity of the color, where C<0> is completely
		1491	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1492	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1493	is the recommended format to specify transparency values, and works with
		1494	all ways to specify a colour.
		1495
		1496	For complete control, rxvt-unicode also supports
		1497	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1498	specifications, where the additional C<aaaa> component specifies opacity
1418	specifies opacity (alpha) values. The minimum value of C<0> is completely	1499	(alpha) values. The minimum value of C<0000> is completely transparent,
1419	transparent). You can also prefix any color with C<[percent]>, where	1500	while C<ffff> is completely opaque). The two example colours from
1420	C<percent> is a decimal percentage (0-100) that specifies the opacity of	1501	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1421	the color, where C<0> is completely transparent and C<100> is completelxy	1502	C<rgba:0000/ff00/0000/f332>.
1422	opaque.
1423		1503
1424	You probably need to specify B<"-depth 32">, too, and have the luck that	1504	You probably need to specify B<"-depth 32">, too, to force a visual with
1425	your X-server uses ARGB pixel layout, as X is far from just supporting	1505	alpha channels, and have the luck that your X-server uses ARGB pixel
1426	ARGB visuals out of the box, and rxvt-unicode just fudges around.	1506	layout, as X is far from just supporting ARGB visuals out of the box, and
		1507	rxvt-unicode just fudges around.
1427		1508
1428	For example, the following selects an almost completely transparent red	1509	For example, the following selects an almost completely transparent black
1429	background, and an almost opaque pink foreground:	1510	background, and an almost opaque pink foreground:
1430		1511
1431	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"	1512	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1432		1513
1433	I<Please note that transparency of any kind if completely unsupported by	1514	When not using a background image, then the interpretation of the
1434	the author. Don't bug him with installation questions!>	1515	alpha channel is up to your compositing manager (most interpret it as
		1516	transparency of course).
		1517
		1518	When using a background pixmap or pseudo-transparency, then the background
		1519	colour will always behave as if it were completely transparent (so the
		1520	background image shows instead), regardless of how it was specified, while
		1521	other colours will either be transparent as specified (the background
		1522	image will show through) on servers supporting the RENDER extension, or
		1523	fully opaque on servers not supporting the RENDER EXTENSION.
		1524
		1525	Please note that due to bugs in Xft, specifying alpha values might result
		1526	in garbage being displayed when the X-server does not support the RENDER
		1527	extension.
1435		1528
1436	=head1 ENVIRONMENT	1529	=head1 ENVIRONMENT
1437		1530
1438	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1531	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1439		1532
…		…
1445	resources or on the command line.	1538	resources or on the command line.
1446		1539
1447	=item B<COLORTERM>	1540	=item B<COLORTERM>
1448		1541
1449	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was	1542	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1450	compiled with XPM support, and optionally with the added extension	1543	compiled with background image support, and optionally with the added
1451	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1544	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1545	screen.
1452		1546
1453	=item B<COLORFGBG>	1547	=item B<COLORFGBG>
1454		1548
1455	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1549	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1456	the colour code used as default foreground/text colour (or the string	1550	the colour code used as default foreground/text colour (or the string
1457	C<default> to indicate that the default-colour escape sequence is to be	1551	C<default> to indicate that the default-colour escape sequence is to be
1458	used), C<bg> is the colour code used as default background colour (or the	1552	used), C<bg> is the colour code used as default background colour (or the
1459	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1553	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1460	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can	1554	was compiled with background image support. Libraries like C<ncurses>
1461	(and do) use this information to optimize screen output.	1555	and C<slang> can (and do) use this information to optimize screen output.
1462		1556
1463	=item B<WINDOWID>	1557	=item B<WINDOWID>
1464		1558
1465	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1559	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1466	window, which usually has subwindows for the scrollbar, the terminal	1560	window, which usually has subwindows for the scrollbar, the terminal
…		…
1472	C<--with-terminfo=PATH>.	1566	C<--with-terminfo=PATH>.
1473		1567
1474	=item B<DISPLAY>	1568	=item B<DISPLAY>
1475		1569
1476	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1570	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1477	display in its child processes.	1571	display in its child processes if C<-display> isn't used to override. It
		1572	defaults to C<:0> if it doesn't exist.
1478		1573
1479	=item B<SHELL>	1574	=item B<SHELL>
1480		1575
1481	The shell to be used for command execution, defaults to C</bin/sh>.	1576	The shell to be used for command execution, defaults to C</bin/sh>.
1482		1577
…		…
1557	Project Coordinator (changes.txt 2.21a to 2.4.5)	1652	Project Coordinator (changes.txt 2.21a to 2.4.5)
1558		1653
1559	=item Geoff Wing L<< <gcw@pobox.com> >>	1654	=item Geoff Wing L<< <gcw@pobox.com> >>
1560		1655
1561	Rewrote screen display and text selection routines.	1656	Rewrote screen display and text selection routines.
1562		1657
1563	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1658	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1564		1659
1565	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1660	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1566		1661
1567	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1662	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.130 by sasha, Fri Jun 8 20:04:12 2007 UTC vs. Revision 1.164 by root, Sun Jun 15 13:54:15 2008 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.130 by sasha, Fri Jun 8 20:04:12 2007 UTC vs.
Revision 1.164 by root, Sun Jun 15 13:54:15 2008 UTC