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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.138 by sasha, Thu Sep 20 15:56:41 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>
…		…
114		122
115	=item B<-ss>\|B<+ss>	123	=item B<-ss>\|B<+ss>
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<-ip>\|B<+ip> \| B<-tr>\|B<+tr>	127	=item B<-tr>\|B<+tr>
120		128
121	Turn on/off inheriting parent window's pixmap. Alternative form is	129	Turn on/off illusion of a transparent window background; resource B<transparent>.
122	B<-tr>; resource B<inheritPixmap>.
123		130
		131	B<-ip> is still accepted as an obsolete alias but will be removed in
		132	future versions.
		133
124	I<Please address all transparency related issues to Sasha Vasko at	134	I<Please address all transparency related issues to Sasha Vasko at
125	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>	135	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
126		136
127	=item B<-fade> I<number>	137	=item B<-fade> I<number>
128		138
129	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
…		…
136	is opaque black. resource B<fadeColor>.	146	is opaque black. resource B<fadeColor>.
137		147
138	=item B<-tint> I<colour>	148	=item B<-tint> I<colour>
139		149
140	Tint the transparent background pixmap with the given colour when	150	Tint the transparent background pixmap with the given colour when
141	transparency is enabled with B<-tr> or B<-ip>. This only works for	151	transparency is enabled with B<-tr>. This only works for
142	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
143	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.
144	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,
145	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:
146	blue, red, green, cyan, magenta, yellow, and those close to them; resource	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
147	I<tintColor>. Example:	158	I<tintColor>. Example:
148		159
149	@@RXVT_NAME@@ -tr -tint blue -sh 40	160	@@RXVT_NAME@@ -tr -tint blue -sh 40
150		161
151	=item B<-sh> I<number>	162	=item B<-sh> I<number>
152		163
153	Darken (0 .. 100) or lighten (-1 .. -100) the transparent	164	Darken (0 .. 100) or lighten (100 .. 200) the transparent
154	background image in addition to (or instead of) tinting it;	165	background image in addition to (or instead of) tinting it;
155	resource I<shading>.	166	resource I<shading>.
156		167
157	=item B<-blt> I<string>	168	=item B<-blt> I<string>
158		169
…		…
160	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
161	transparency image, using method specified. Supported values are :	172	transparency image, using method specified. Supported values are :
162	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,	173	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
163	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>,
164	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
165	alpha-blending; resource I<blendType>.	176	alpha-blending. Compile I<afterimage>; resource I<blendType>.
166		177
167	=item B<-blr> I<HxV>	178	=item B<-blr> I<HxV>
168		179
169	Apply Gaussian Blur with the specified radii to the transparent	180	Apply Gaussian Blur with the specified radii to the transparent
170	background image. If single number is specified - both vertical and	181	background image. If single number is specified - both vertical and
171	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
172	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
173	on some backgrounds. Maximum radius value is 128; resource I<blurRadius>.	184	on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
		185	resource I<blurRadius>.
		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>.
174		192
175	=item B<-bg> I<colour>	193	=item B<-bg> I<colour>
176		194
177	Window background colour; resource B<background>.	195	Window background colour; resource B<background>.
178		196
179	=item B<-fg> I<colour>	197	=item B<-fg> I<colour>
180		198
181	Window foreground colour; resource B<foreground>.	199	Window foreground colour; resource B<foreground>.
182		200
183	=item B<-pixmap> I<file[;geom]>	201	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
184		202
185	Compile I<afterimage>: Specify image file for the background and also	203	Compile I<afterimage>: Specify image file for the background and also
186	optionally specify its scaling with a geometry string. Note you may need to	204	optionally specify its scaling with a geometry string. Note you may need to
187	add quotes to avoid special shell interpretation of the C<;> in the	205	add quotes to avoid special shell interpretation of the C<;> in the
188	command-line; for more details see resource B<backgroundPixmap>.	206	command-line; for more details see resource B<backgroundPixmap>.
189		207
190	=item B<-cr> I<colour>	208	=item B<-cr> I<colour>
…		…
238	italic> >> characters are to be printed. See resource B<boldItalicFont>	256	italic> >> characters are to be printed. See resource B<boldItalicFont>
239	for details.	257	for details.
240		258
241	=item B<-is>\|B<+is>	259	=item B<-is>\|B<+is>
242		260
243	Compile I<font-styles>: Bold/Italic font styles imply high intensity	261	Compile I<font-styles>: Bold/Blink font styles imply high intensity
244	foreground/background (default). See resource B<intensityStyles> for	262	foreground/background (default). See resource B<intensityStyles> for
245	details.	263	details.
246		264
247	=item B<-name> I<name>	265	=item B<-name> I<name>
248		266
…		…
266		284
267	=item B<-sb>\|B<+sb>	285	=item B<-sb>\|B<+sb>
268		286
269	Turn on/off scrollbar; resource B<scrollBar>.	287	Turn on/off scrollbar; resource B<scrollBar>.
270		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
271	=item B<-si>\|B<+si>	298	=item B<-si>\|B<+si>
272		299
273	Turn on/off scroll-to-bottom on TTY output inhibit; resource	300	Turn on/off scroll-to-bottom on TTY output inhibit; resource
274	B<scrollTtyOutput> has opposite effect.	301	B<scrollTtyOutput> has opposite effect.
275		302
…		…
281	=item B<-sw>\|B<+sw>	308	=item B<-sw>\|B<+sw>
282		309
283	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.
284	This only takes effect if B<-si> is also given; resource	311	This only takes effect if B<-si> is also given; resource
285	B<scrollWithBuffer>.	312	B<scrollWithBuffer>.
286
287	=item B<-sr>\|B<+sr>
288
289	Put scrollbar on right/left; resource B<scrollBar_right>.
290
291	=item B<-st>\|B<+st>
292
293	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
294	resource B<scrollBar_floating>.
295		313
296	=item B<-ptab>\|B<+ptab>	314	=item B<-ptab>\|B<+ptab>
297		315
298	If enabled (default), "Horizontal Tab" characters are being stored as	316	If enabled (default), "Horizontal Tab" characters are being stored as
299	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
…		…
328		346
329	=item B<-bl>	347	=item B<-bl>
330		348
331	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.
332	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
333	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.
334		353
335	=item B<-override-redirect>	354	=item B<-override-redirect>
336		355
337	Compile I<frills>: Sets override-redirect on the window; resource	356	Compile I<frills>: Sets override-redirect on the window; resource
338	B<override-redirect>.	357	B<override-redirect>.
…		…
347	=item B<-lsp> I<number>	366	=item B<-lsp> I<number>
348		367
349	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
350	the display. Useful to work around font rendering problems; resource	369	the display. Useful to work around font rendering problems; resource
351	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>.
352		378
353	=item B<-tn> I<termname>	379	=item B<-tn> I<termname>
354		380
355	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
356	B<TERM> environment variable. This terminal type must exist in the	382	B<TERM> environment variable. This terminal type must exist in the
…		…
411		437
412	=item B<-tcw>	438	=item B<-tcw>
413		439
414	Change the meaning of triple-click selection with the left mouse	440	Change the meaning of triple-click selection with the left mouse
415	button. Only effective when the original (non-perl) selection code is	441	button. Only effective when the original (non-perl) selection code is
416	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
417	end of the logical line only. resource B<tripleclickwords>.	443	the end of the logical line only. resource B<tripleclickwords>.
418		444
419	=item B<-insecure>	445	=item B<-insecure>
420		446
421	Enable "insecure" mode, which currently enables most of the escape	447	Enable "insecure" mode, which currently enables most of the escape
422	sequences that echo strings. See the resource B<insecure> for more	448	sequences that echo strings. See the resource B<insecure> for more
…		…
442		468
443	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@@
444	will not immediately destroy its window when the program executed within	470	will not immediately destroy its window when the program executed within
445	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
446	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.
447		492
448	=item B<-keysym.>I<sym> I<string>	493	=item B<-keysym.>I<sym> I<string>
449		494
450	Remap a key symbol. See resource B<keysym>.	495	Remap a key symbol. See resource B<keysym>.
451		496
…		…
486	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
487	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
488	yourself if you want that.	533	yourself if you want that.
489		534
490	As an extremely special case, specifying C<-1> will completely suppress	535	As an extremely special case, specifying C<-1> will completely suppress
491	pty/tty operations.	536	pty/tty operations, which is probably only useful in conjunction with some
		537	perl extension that manages the terminal.
492		538
493	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
494	longer example is in F<doc/pty-fd>):	540	longer example is in F<doc/pty-fd>):
495		541
496	use IO::Pty;	542	use IO::Pty;
…		…
510	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
511	this terminal instance. See resource B<perl-ext> for details.	557	this terminal instance. See resource B<perl-ext> for details.
512		558
513	=back	559	=back
514		560
515	=head1 RESOURCES (available also as long-options)	561	=head1 RESOURCES
516		562
517	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	563	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
518	options) compiled into your version.	564	options) compiled into your version. All resources are also available as
		565	long-options.
519		566
520	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
521	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
522	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	569	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
523	with later settings overwriting earlier ones:	570	with later settings overwriting earlier ones:
…		…
525	1. system-wide app-defaults file, either locale-dependent OR global	572	1. system-wide app-defaults file, either locale-dependent OR global
526	2. app-defaults file in $XAPPLRESDIR	573	2. app-defaults file in $XAPPLRESDIR
527	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	574	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
528	4. SCREEN_RESOURCES for the current screen	575	4. SCREEN_RESOURCES for the current screen
529	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	576	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		577	6. resources specified via -xrm on the commandline
530		578
531	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
532	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
533	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
534	configured, while the class name B<URxvt> allows resources unique to	582	configured, while the class name B<URxvt> allows resources unique to
…		…
544	=item B<depth:> I<bitdepth>	592	=item B<depth:> I<bitdepth>
545		593
546	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;
547	option B<-depth>.	595	option B<-depth>.
548		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
549	=item B<geometry:> I<geom>	604	=item B<geometry:> I<geom>
550		605
551	Create the window with the specified X window geometry [default 80x24];	606	Create the window with the specified X window geometry [default 80x24];
552	option B<-geometry>.	607	option B<-geometry>.
553		608
…		…
636		691
637	B<False>: specify that everything is to be displayed, even	692	B<False>: specify that everything is to be displayed, even
638	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
639	monitor to display anything); option B<+ss>.	694	monitor to display anything); option B<+ss>.
640		695
641	=item B<inheritPixmap:> I<boolean>	696	=item B<transparent:> I<boolean>
642		697
643	B<True>: make the background inherit the parent windows' pixmap, giving	698	Turn on/off illusion of a transparent window background.
644	artificial transparency. B<False>: do not inherit the parent windows'
645	pixmap.
646		699
647	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
648	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@@)!>
649		705
650	=item B<fading:> I<number>	706	=item B<fading:> I<number>
651		707
652	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>.
653		709
…		…
670		726
671	Specify background blending type; option B<-blt>.	727	Specify background blending type; option B<-blt>.
672		728
673	=item B<blurRadius:> I<number>	729	=item B<blurRadius:> I<number>
674		730
675	Apply Gaussian Blurr with the specified radius to the transparent	731	Apply gaussian blur with the specified radius to the transparent
676	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>.
677		737
678	=item B<scrollColor:> I<colour>	738	=item B<scrollColor:> I<colour>
679		739
680	Use the specified colour for the scrollbar [default #B2B2B2].	740	Use the specified colour for the scrollbar [default #B2B2B2].
681		741
…		…
687	=item B<borderColor:> I<colour>	747	=item B<borderColor:> I<colour>
688		748
689	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
690	and the text.	750	and the text.
691		751
692	=item B<backgroundPixmap:> I<file[;geom]>	752	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
693		753
694	Use the specified image file for the background and also optionally	754	Use the specified image file for the background and also
695	specify its scaling with a geometry string B<WxH+X+Y>,	755	optionally specify its scaling with a geometry string B<WxH+X+Y>,
696	in which B<"W" / "H"> specify the horizontal/vertical scale (percent),	756	(default C<0x0+50+50>) in which B<"W" / "H"> specify the
697	and B<"X" / "Y"> locate the image centre (percent).	757	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
698	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
699	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
700	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
701	10 times its original size. The maximum permitted scale is 1000.	761	beyond 10 times its original size. The maximum permitted scale is 1000.
702	Special string of B<"auto"> used as a geometry will cause image to be	762	Additional operations can be specified after colon B<:op1:op2...>.
703	automatically scaled to match window size.	763	Supported operations are:
		764
		765	tile force background image to be tiled and not scaled. Equivalent to 0x0
		766	propscale will scale image keeping proportions
		767	auto will scale image to match window size. Equivalent to 100x100
		768	hscale will scale image horizontally to the window size
		769	vscale will scale image vertically to the window size
		770	scale will scale image to match window size
		771	root will tile image as if it was a root window background, auto-adjusting
		772	whenever terminal window moves
		773
704	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
705	blended over transparency image using either alpha-blending, or any	775	blended over transparency image using either alpha-blending, or any
706	other blending type, specified with B<-blt "type"> option.	776	other blending type, specified with B<-blt "type"> option.
707	[default 0x0+50+50]
708		777
709	=item B<path:> I<path>	778	=item B<path:> I<path>
710		779
711	Specify the colon-delimited search path for finding background image files.	780	Specify the colon-delimited search path for finding background image files.
712		781
…		…
773	text font will being used for the given style.	842	text font will being used for the given style.
774		843
775	=item B<intensityStyles:> I<boolean>	844	=item B<intensityStyles:> I<boolean>
776		845
777	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>,
778	option B<-is>, the default), bold and italic font styles imply high	847	option B<-is>, the default), bold/blink font styles imply high
779	intensity foreground/background colours. Disabling this option (B<False>,	848	intensity foreground/background colours. Disabling this option (B<False>,
780	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
781	reachable.	850	reachable.
782		851
783	=item B<selectstyle:> I<mode>
784
785	Set mouse selection style to B<old> which is 2.20, B<oldword> which
786	is xterm style with 2.20 old word selection, or anything else which
787	gives xterm style selection. Only effective when the original (non-perl)
788	selection code is in use.
789
790	=item B<scrollstyle:> I<mode>
791
792	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
793	the author's favourite.
794
795	=item B<title:> I<string>	852	=item B<title:> I<string>
796		853
797	Set window title string, the default title is the command-line	854	Set window title string, the default title is the command-line
798	specified after the B<-e> option, if any, otherwise the application	855	specified after the B<-e> option, if any, otherwise the application
799	name; option B<-title>.	856	name; option B<-title>.
…		…
812	=item B<urgentOnBell:> I<boolean>	869	=item B<urgentOnBell:> I<boolean>
813		870
814	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.
815	B<False>: do not set the urgency hint [default].	872	B<False>: do not set the urgency hint [default].
816		873
		874	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		875
817	=item B<visualBell:> I<boolean>	876	=item B<visualBell:> I<boolean>
818		877
819	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>.
820	B<False>: no visual bell [default]; option B<+vb>.	879	B<False>: no visual bell [default]; option B<+vb>.
821		880
…		…
843		902
844	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	903	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
845		904
846	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
847	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.
848		912
849	=item B<scrollBar:> I<boolean>	913	=item B<scrollBar:> I<boolean>
850		914
851	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	915	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
852	disable the scrollbar; option B<+sb>.	916	disable the scrollbar; option B<+sb>.
…		…
985	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.
986		1050
987	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
988	be used. If not specified, the built-in default is used:	1052	be used. If not specified, the built-in default is used:
989		1053
990	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	1054	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
991		1055
992	=item B<preeditType:> I<style>	1056	=item B<preeditType:> I<style>
993		1057
994	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1058	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
995		1059
…		…
1051		1115
1052	=item B<secondaryScroll:> I<boolean>	1116	=item B<secondaryScroll:> I<boolean>
1053		1117
1054	Turn on/off secondary screen scroll (default enabled). If this	1118	Turn on/off secondary screen scroll (default enabled). If this
1055	option is enabled, scrolls on the secondary screen will change the	1119	option is enabled, scrolls on the secondary screen will change the
1056	scrollback buffer and switching to/from the secondary screen will	1120	scrollback buffer and, when secondaryScreen is off, switching
1057	instead scroll the screen up.	1121	to/from the secondary screen will instead scroll the screen up.
1058		1122
1059	=item B<hold>: I<boolean>	1123	=item B<hold>: I<boolean>
1060		1124
1061	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@@
1062	will not immediately destroy its window when the program executed within	1126	will not immediately destroy its window when the program executed within
1063	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
1064	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>.
1065		1136
1066	=item B<keysym.>I<sym>: I<string>	1137	=item B<keysym.>I<sym>: I<string>
1067		1138
1068	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1139	Compile I<frills>: Associate I<string> with keysym I<sym>. The
1069	intervening resource name B<keysym.> cannot be omitted.	1140	intervening resource name B<keysym.> cannot be omitted.
…		…
1083	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1154	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1084	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1155	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1085	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1156	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1086	performed in an exact manner; however, the closest match is assured.	1157	performed in an exact manner; however, the closest match is assured.
1087		1158
1088	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1159	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1089	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1160	number), see RESOURCES in C<man 7 X> for futher details.
1090	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1091	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1092	can start or end with whitespace. B<This feature is deprecated and will
1093	be removed>.
1094
1095	Please note that you need to double the C<\> in resource files, as
1096	Xlib itself does its own de-escaping (you can use C<\033> instead of
1097	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1098	processing).
1099		1161
1100	You can define a range of keysyms in one shot by providing a I<string>	1162	You can define a range of keysyms in one shot by providing a I<string>
1101	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1163	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1102	should be a character not used by the strings.	1164	should be a character not used by the strings.
1103		1165
…		…
1185	all instances, while B<perl-ext> is used for specific instances.	1247	all instances, while B<perl-ext> is used for specific instances.
1186		1248
1187	=item B<perl-eval>: I<string>	1249	=item B<perl-eval>: I<string>
1188		1250
1189	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
1190	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource	1252	the @@RXVT_NAME@@perl(3) manpage.
1191	will be ignored when running setuid/setgid.
1192		1253
1193	=item B<perl-lib>: I<path>	1254	=item B<perl-lib>: I<path>
1194		1255
1195	Colon-separated list of additional directories that hold extension	1256	Colon-separated list of additional directories that hold extension
1196	scripts. When looking for extensions specified by the C<perl> resource,	1257	scripts. When looking for extensions specified by the C<perl> resource,
1197	@@RXVT_NAME@@ will first look in these directories and then in	1258	@@RXVT_NAME@@ will first look in these directories and then in
1198	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1259	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1199	will be ignored when running setuid/setgid.
1200		1260
1201	See the @@RXVT_NAME@@perl(3) manpage.	1261	See the @@RXVT_NAME@@perl(3) manpage.
1202		1262
1203	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1263	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1204		1264
…		…
1439	=back	1499	=back
1440		1500
1441	=head2 ALPHA CHANNEL SUPPORT	1501	=head2 ALPHA CHANNEL SUPPORT
1442		1502
1443	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
1444	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:
1445	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1505
1446	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
1447	specifies opacity (alpha) values. The minimum value of C<0> is completely	1517	(alpha) values. The minimum value of C<0000> is completely transparent,
1448	transparent). You can also prefix any color with C<[percent]>, where	1518	while C<ffff> is completely opaque). The two example colours from
1449	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
1450	the color, where C<0> is completely transparent and C<100> is completelxy	1520	C<rgba:0000/ff00/0000/f332>.
1451	opaque.
1452		1521
1453	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
1454	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
1455	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.
1456		1526
1457	For example, the following selects an almost completely transparent red	1527	For example, the following selects an almost completely transparent black
1458	background, and an almost opaque pink foreground:	1528	background, and an almost opaque pink foreground:
1459		1529
1460	@@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"
1461		1531
1462	I<Please note that transparency of any kind if completely unsupported by	1532	When not using a background image, then the interpretation of the
1463	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.
1464		1546
1465	=head1 ENVIRONMENT	1547	=head1 ENVIRONMENT
1466		1548
1467	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1549	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1468		1550
…		…
1474	resources or on the command line.	1556	resources or on the command line.
1475		1557
1476	=item B<COLORTERM>	1558	=item B<COLORTERM>
1477		1559
1478	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was	1560	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1479	compiled with background image support, and optionally with the added	1561	compiled with background image support, and optionally with the added
1480	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome	1562	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1481	screen.	1563	screen.
1482		1564
1483	=item B<COLORFGBG>	1565	=item B<COLORFGBG>
1484		1566
1485	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1567	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1486	the colour code used as default foreground/text colour (or the string	1568	the colour code used as default foreground/text colour (or the string
1487	C<default> to indicate that the default-colour escape sequence is to be	1569	C<default> to indicate that the default-colour escape sequence is to be
1488	used), C<bg> is the colour code used as default background colour (or the	1570	used), C<bg> is the colour code used as default background colour (or the
1489	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1571	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1490	was compiled with background image support. Libraries like C<ncurses>	1572	was compiled with background image support. Libraries like C<ncurses>
1491	and C<slang> can (and do) use this information to optimize screen output.	1573	and C<slang> can (and do) use this information to optimize screen output.
1492		1574
1493	=item B<WINDOWID>	1575	=item B<WINDOWID>
1494		1576
1495	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1577	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
…		…
1502	C<--with-terminfo=PATH>.	1584	C<--with-terminfo=PATH>.
1503		1585
1504	=item B<DISPLAY>	1586	=item B<DISPLAY>
1505		1587
1506	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
1507	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.
1508		1591
1509	=item B<SHELL>	1592	=item B<SHELL>
1510		1593
1511	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>.
1512		1595
…		…
1587	Project Coordinator (changes.txt 2.21a to 2.4.5)	1670	Project Coordinator (changes.txt 2.21a to 2.4.5)
1588		1671
1589	=item Geoff Wing L<< <gcw@pobox.com> >>	1672	=item Geoff Wing L<< <gcw@pobox.com> >>
1590		1673
1591	Rewrote screen display and text selection routines.	1674	Rewrote screen display and text selection routines.
1592		1675
1593	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1676	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1594		1677
1595	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1678	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1596		1679
1597	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1680	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.138 by sasha, Thu Sep 20 15:56:41 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.138 by sasha, Thu Sep 20 15:56:41 2007 UTC vs.
Revision 1.170 by root, Sat May 30 08:51:23 2009 UTC