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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.127 by ayin, Wed May 2 23:06:32 2007 UTC vs.
Revision 1.185 by sf-exg, Mon Oct 4 07:18:23 2010 UTC

…		…
12	emulator intended as an I<xterm>(1) replacement for users who do not	12	emulator intended as an I<xterm>(1) replacement for users who do not
13	require features such as Tektronix 4014 emulation and toolkit-style	13	require features such as Tektronix 4014 emulation and toolkit-style
14	configurability. As a result, B<rxvt-unicode> uses much less swap space --	14	configurability. As a result, B<rxvt-unicode> uses much less swap space --
15	a significant advantage on a machine serving many X sessions.	15	a significant advantage on a machine serving many X sessions.
16		16
		17	This document is also available on the World-Wide-Web at
		18	L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
		19
17	=head1 FREQUENTLY ASKED QUESTIONS	20	=head1 FREQUENTLY ASKED QUESTIONS
18		21
19	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of	22	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20	frequently asked questions and answer to them and some common	23	frequently asked questions and answer to them and some common
21	problems. That document is also accessible on the World-Wide-Web at	24	problems. That document is also accessible on the World-Wide-Web at
22	L<http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>.	25	L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
23		26
24	=head1 RXVT-UNICODE VS. RXVT	27	=head1 RXVT-UNICODE VS. RXVT
25		28
26	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode	29	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
27	internally. That means it can store and display most scripts in the	30	internally. That means it can store and display most scripts in the
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 colours 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>	162	=item B<-sh> I<number>
146		163
147	I<number> 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 tinting it (i.e. B<-tint> must be	165	background image in addition to (or instead of) tinting it;
149	specified, too, e.g. C<-tint white>); resource I<shading>.	166	resource I<shading>.
		167
		168	=item B<-blt> I<string>
		169
		170	Specify background blending type. If background pixmap is specified
		171	at the same time as transparency - such pixmap will be blended over
		172	transparency image, using method specified. Supported values are :
		173	B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
		174	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
		175	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
		176	alpha-blending. Compile I<afterimage>; resource I<blendType>.
		177
		178	=item B<-blr> I<HxV>
		179
		180	Apply Gaussian Blur with the specified radii to the transparent
		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>.
		186
		187	=item B<-icon> I<file>
		188
		189	Compile I<afterimage> or I<pixbuf>: 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>.
150		192
151	=item B<-bg> I<colour>	193	=item B<-bg> I<colour>
152		194
153	Window background colour; resource B<background>.	195	Window background colour; resource B<background>.
154		196
155	=item B<-fg> I<colour>	197	=item B<-fg> I<colour>
156		198
157	Window foreground colour; resource B<foreground>.	199	Window foreground colour; resource B<foreground>.
158		200
159	=item B<-pixmap> I<file[;geom]>	201	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
160		202
161	Compile I<XPM>: Specify XPM file for the background and also optionally	203	Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also
162	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
163	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
164	command-line; resource B<backgroundPixmap>.	206	command-line; for more details see resource B<backgroundPixmap>.
165		207
166	=item B<-cr> I<colour>	208	=item B<-cr> I<colour>
167		209
168	The cursor colour; resource B<cursorColor>.	210	The cursor colour; resource B<cursorColor>.
169		211
…		…
214	italic> >> characters are to be printed. See resource B<boldItalicFont>	256	italic> >> characters are to be printed. See resource B<boldItalicFont>
215	for details.	257	for details.
216		258
217	=item B<-is>\|B<+is>	259	=item B<-is>\|B<+is>
218		260
219	Compile I<font-styles>: Bold/Italic font styles imply high intensity	261	Compile I<font-styles>: Bold/Blink font styles imply high intensity
220	foreground/background (default). See resource B<intensityStyles> for	262	foreground/background (default). See resource B<intensityStyles> for
221	details.	263	details.
222		264
223	=item B<-name> I<name>	265	=item B<-name> I<name>
224		266
…		…
242		284
243	=item B<-sb>\|B<+sb>	285	=item B<-sb>\|B<+sb>
244		286
245	Turn on/off scrollbar; resource B<scrollBar>.	287	Turn on/off scrollbar; resource B<scrollBar>.
246		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
247	=item B<-si>\|B<+si>	298	=item B<-si>\|B<+si>
248		299
249	Turn on/off scroll-to-bottom on TTY output inhibit; resource	300	Turn on/off scroll-to-bottom on TTY output inhibit; resource
250	B<scrollTtyOutput> has opposite effect.	301	B<scrollTtyOutput> has opposite effect.
251		302
…		…
257	=item B<-sw>\|B<+sw>	308	=item B<-sw>\|B<+sw>
258		309
259	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.
260	This only takes effect if B<-si> is also given; resource	311	This only takes effect if B<-si> is also given; resource
261	B<scrollWithBuffer>.	312	B<scrollWithBuffer>.
262
263	=item B<-sr>\|B<+sr>
264
265	Put scrollbar on right/left; resource B<scrollBar_right>.
266
267	=item B<-st>\|B<+st>
268
269	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
270	resource B<scrollBar_floating>.
271		313
272	=item B<-ptab>\|B<+ptab>	314	=item B<-ptab>\|B<+ptab>
273		315
274	If enabled (default), "Horizontal Tab" characters are being stored as	316	If enabled (default), "Horizontal Tab" characters are being stored as
275	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
…		…
279		321
280	=item B<-bc>\|B<+bc>	322	=item B<-bc>\|B<+bc>
281		323
282	Blink the cursor; resource B<cursorBlink>.	324	Blink the cursor; resource B<cursorBlink>.
283		325
		326	=item B<-uc>\|B<+uc>
		327
		328	Make the cursor underlined; resource B<cursorUnderline>.
		329
284	=item B<-iconic>	330	=item B<-iconic>
285		331
286	Start iconified, if the window manager supports that option.	332	Start iconified, if the window manager supports that option.
287	Alternative form is B<-ic>.	333	Alternative form is B<-ic>.
288		334
…		…
304		350
305	=item B<-bl>	351	=item B<-bl>
306		352
307	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	353	Compile I<frills>: Set MWM hints to request a borderless window, i.e.
308	if honoured by the WM, the rxvt-unicode window will not have window	354	if honoured by the WM, the rxvt-unicode window will not have window
309	decorations; resource B<borderLess>.	355	decorations; resource B<borderLess>. If the window manager does not
		356	support MWM hints (e.g. kwin), enables override-redirect mode.
310		357
311	=item B<-override-redirect>	358	=item B<-override-redirect>
312		359
313	Compile I<frills>: Sets override-redirect on the window; resource	360	Compile I<frills>: Sets override-redirect on the window; resource
314	B<override-redirect>.	361	B<override-redirect>.
…		…
322		369
323	=item B<-lsp> I<number>	370	=item B<-lsp> I<number>
324		371
325	Compile I<frills>: Lines (pixel height) to insert between each row of	372	Compile I<frills>: Lines (pixel height) to insert between each row of
326	the display. Useful to work around font rendering problems; resource	373	the display. Useful to work around font rendering problems; resource
327	B<linespace>.	374	B<lineSpace>.
		375
		376	=item B<-letsp> I<number>
		377
		378	Compile I<frills>: Amount to adjust the computed character width by
		379	to control overall letter spacing. Negative values will tighten up the
		380	letter spacing, positive values will space letters out more. Useful to
		381	work around odd font metrics; resource B<letterSpace>.
328		382
329	=item B<-tn> I<termname>	383	=item B<-tn> I<termname>
330		384
331	This option specifies the name of the terminal type to be set in the	385	This option specifies the name of the terminal type to be set in the
332	B<TERM> environment variable. This terminal type must exist in the	386	B<TERM> environment variable. This terminal type must exist in the
…		…
386	for more info.	440	for more info.
387		441
388	=item B<-tcw>	442	=item B<-tcw>
389		443
390	Change the meaning of triple-click selection with the left mouse	444	Change the meaning of triple-click selection with the left mouse
		445	button. Only effective when the original (non-perl) selection code is
391	button. Instead of selecting a full line it will extend the selection the	446	in-use. Instead of selecting a full line it will extend the selection to
392	end of the logical line only. resource B<tripleclickwords>.	447	the end of the logical line only. resource B<tripleclickwords>.
393		448
394	=item B<-insecure>	449	=item B<-insecure>
395		450
396	Enable "insecure" mode, which currently enables most of the escape	451	Enable "insecure" mode, which currently enables most of the escape
397	sequences that echo strings. See the resource B<insecure> for more	452	sequences that echo strings. See the resource B<insecure> for more
…		…
417		472
418	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	473	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
419	will not immediately destroy its window when the program executed within	474	will not immediately destroy its window when the program executed within
420	it exits. Instead, it will wait till it is being killed or closed by the	475	it exits. Instead, it will wait till it is being killed or closed by the
421	user; resource B<hold>.	476	user; resource B<hold>.
		477
		478	=item B<-cd> I<path>
		479
		480	Sets the working directory for the shell (or the command specified via
		481	B<-e>). The I<path> must be an absolute path and it must exist for
		482	@@RXVT_NAME@@ to start; resource B<chdir>.
		483
		484	=item B<-xrm> I<string>
		485
		486	Works like the X Toolkit option of the same name, by adding the I<string>
		487	as if it were specified in a resource file. Resource values specified this
		488	way take precedence over all other resource specifications.
		489
		490	Note that you need to use the I<same> syntax as in the .Xdefaults file,
		491	e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
		492	options can be specified as long-options on the commandline, so use
		493	of B<-xrm> is mostly limited to cases where you want to specify other
		494	resources (e.g. for input methods) or for compatibility with other
		495	programs.
422		496
423	=item B<-keysym.>I<sym> I<string>	497	=item B<-keysym.>I<sym> I<string>
424		498
425	Remap a key symbol. See resource B<keysym>.	499	Remap a key symbol. See resource B<keysym>.
426		500
…		…
461	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	535	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
462	entries and will not tinker with pty/tty permissions - you have to do that	536	entries and will not tinker with pty/tty permissions - you have to do that
463	yourself if you want that.	537	yourself if you want that.
464		538
465	As an extremely special case, specifying C<-1> will completely suppress	539	As an extremely special case, specifying C<-1> will completely suppress
466	pty/tty operations.	540	pty/tty operations, which is probably only useful in conjunction with some
		541	perl extension that manages the terminal.
467		542
468	Here is a example in perl that illustrates how this option can be used (a	543	Here is a example in perl that illustrates how this option can be used (a
469	longer example is in F<doc/pty-fd>):	544	longer example is in F<doc/pty-fd>):
470		545
471	use IO::Pty;	546	use IO::Pty;
…		…
485	Comma-separated list of perl extension scripts to use (or not to use) in	560	Comma-separated list of perl extension scripts to use (or not to use) in
486	this terminal instance. See resource B<perl-ext> for details.	561	this terminal instance. See resource B<perl-ext> for details.
487		562
488	=back	563	=back
489		564
490	=head1 RESOURCES (available also as long-options)	565	=head1 RESOURCES
491		566
492	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	567	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
493	options) compiled into your version.	568	options) compiled into your version. All resources are also available as
		569	long-options.
494		570
495	You can set and change the resources using X11 tools like B<xrdb>. Many	571	You can set and change the resources using X11 tools like B<xrdb>. Many
496	distribution do also load settings from the B<~/.Xresources> file when X	572	distribution do also load settings from the B<~/.Xresources> file when X
497	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	573	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
498	with later settings overwriting earlier ones:	574	with later settings overwriting earlier ones:
…		…
500	1. system-wide app-defaults file, either locale-dependent OR global	576	1. system-wide app-defaults file, either locale-dependent OR global
501	2. app-defaults file in $XAPPLRESDIR	577	2. app-defaults file in $XAPPLRESDIR
502	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	578	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
503	4. SCREEN_RESOURCES for the current screen	579	4. SCREEN_RESOURCES for the current screen
504	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	580	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		581	6. resources specified via -xrm on the commandline
505		582
506	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	583	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
507	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources	584	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
508	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily	585	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
509	configured, while the class name B<URxvt> allows resources unique to	586	configured, while the class name B<URxvt> allows resources unique to
…		…
519	=item B<depth:> I<bitdepth>	596	=item B<depth:> I<bitdepth>
520		597
521	Compile I<xft>: Attempt to find a visual with the given bit depth;	598	Compile I<xft>: Attempt to find a visual with the given bit depth;
522	option B<-depth>.	599	option B<-depth>.
523		600
		601	=item B<buffered:> I<boolean>
		602
		603	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		604	On some card/driver combination enabling it slightly decreases
		605	performance, on most it greatly helps it. The slowdown is small, so it
		606	should normally be enabled.
		607
524	=item B<geometry:> I<geom>	608	=item B<geometry:> I<geom>
525		609
526	Create the window with the specified X window geometry [default 80x24];	610	Create the window with the specified X window geometry [default 80x24];
527	option B<-geometry>.	611	option B<-geometry>.
528		612
…		…
541	Use the specified colour for the colour value I<n>, where 0-7	625	Use the specified colour for the colour value I<n>, where 0-7
542	corresponds to low-intensity (normal) colours and 8-15 corresponds to	626	corresponds to low-intensity (normal) colours and 8-15 corresponds to
543	high-intensity (bold = bright foreground, blink = bright background)	627	high-intensity (bold = bright foreground, blink = bright background)
544	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	628	colours. The canonical names are as follows: 0=black, 1=red, 2=green,
545	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour	629	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
546	names used are listed in the B<COLORS AND GRAPHICS> section.	630	names used are listed in the B<COLOURS AND GRAPHICS> section.
547		631
548	Colours higher than 15 cannot be set using resources (yet), but can be	632	Colours higher than 15 cannot be set using resources (yet), but can be
549	changed using an escape command (see @@RXVT_NAME@@(7)).	633	changed using an escape command (see @@RXVT_NAME@@(7)).
550		634
551	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with	635	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
…		…
562	=item B<colorUL:> I<colour>	646	=item B<colorUL:> I<colour>
563		647
564	Use the specified colour to display underlined characters when the	648	Use the specified colour to display underlined characters when the
565	foreground colour is the default.	649	foreground colour is the default.
566		650
567	=item B<colorRV:> I<colour>
568
569	Use the specified colour as the background for reverse video characters
570	when OPTION_HC is disabled (--disable-frills).
571
572	=item B<underlineColor:> I<colour>	651	=item B<underlineColor:> I<colour>
573		652
574	If set, use the specified colour as the colour for the underline	653	If set, use the specified colour as the colour for the underline
575	itself. If unset, use the foreground colour.	654	itself. If unset, use the foreground colour.
		655
		656	=item B<highlightColor:> I<colour>
		657
		658	If set, use the specified colour as the background for highlighted
		659	characters. If unset, use reverse video.
		660
		661	=item B<highlightTextColor:> I<colour>
		662
		663	If set and highlightColor is set, use the specified colour as the
		664	foreground for highlighted characters.
576		665
577	=item B<cursorColor:> I<colour>	666	=item B<cursorColor:> I<colour>
578		667
579	Use the specified colour for the cursor. The default is to use the	668	Use the specified colour for the cursor. The default is to use the
580	foreground colour; option B<-cr>.	669	foreground colour; option B<-cr>.
…		…
587		676
588	=item B<reverseVideo:> I<boolean>	677	=item B<reverseVideo:> I<boolean>
589		678
590	B<True>: simulate reverse video by foreground and background colours;	679	B<True>: simulate reverse video by foreground and background colours;
591	option B<-rv>. B<False>: regular screen colours [default]; option	680	option B<-rv>. B<False>: regular screen colours [default]; option
592	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	681	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
593		682
594	=item B<jumpScroll:> I<boolean>	683	=item B<jumpScroll:> I<boolean>
595		684
596	B<True>: specify that jump scrolling should be used. When scrolling	685	B<True>: specify that jump scrolling should be used. When receiving lots
597	quickly, fewer screen updates are performed [default]; option B<-j>.	686	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
		687	has been read, resulting in fewer updates while still displaying every
		688	received line; option B<-j>.
		689
598	B<False>: specify that smooth scrolling should be used; option B<+j>.	690	B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
		691	force a screen refresh on each new line it received; option B<+j>.
599		692
600	=item B<inheritPixmap:> I<boolean>	693	=item B<skipScroll:> I<boolean>
601		694
602	B<True>: make the background inherit the parent windows' pixmap, giving	695	B<True>: (the default) specify that skip scrolling should be used. When
603	artificial transparency. B<False>: do not inherit the parent windows'	696	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
604	pixmap.	697	(around 60 times per second), resulting in far fewer updates. This can
		698	result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
		699	option B<-ss>.
605		700
606	I<Please note that transparency of any kind if completely unsupported by	701	B<False>: specify that everything is to be displayed, even
607	the author. Don't bug him with installation questions!>	702	if the refresh is too fast for the human eye to read anything (or the
		703	monitor to display anything); option B<+ss>.
		704
		705	=item B<transparent:> I<boolean>
		706
		707	Turn on/off illusion of a transparent window background.
		708
		709	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
		710	future versions.
		711
		712	I<Please address all transparency related issues to Sasha Vasko at
		713	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
608		714
609	=item B<fading:> I<number>	715	=item B<fading:> I<number>
610		716
611	Fade the text by the given percentage when focus is lost; option B<-fade>.	717	Fade the text by the given percentage when focus is lost; option B<-fade>.
612		718
…		…
623	=item B<shading:> I<number>	729	=item B<shading:> I<number>
624		730
625	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image	731	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
626	in addition to tinting it; option B<-sh>.	732	in addition to tinting it; option B<-sh>.
627		733
		734	=item B<blendType:> I<string>
		735
		736	Specify background blending type; option B<-blt>.
		737
		738	=item B<blurRadius:> I<number>
		739
		740	Apply gaussian blur with the specified radius to the transparent
		741	background image; option B<-blr>.
		742
		743	=item B<iconFile:> I<file>
		744
		745	Set the application icon pixmap; option B<-icon>.
		746
628	=item B<scrollColor:> I<colour>	747	=item B<scrollColor:> I<colour>
629		748
630	Use the specified colour for the scrollbar [default #B2B2B2].	749	Use the specified colour for the scrollbar [default #B2B2B2].
631		750
632	=item B<troughColor:> I<colour>	751	=item B<troughColor:> I<colour>
…		…
637	=item B<borderColor:> I<colour>	756	=item B<borderColor:> I<colour>
638		757
639	The colour of the border around the text area and between the scrollbar	758	The colour of the border around the text area and between the scrollbar
640	and the text.	759	and the text.
641		760
642	=item B<backgroundPixmap:> I<file[;geom]>	761	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
643		762
644	Use the specified XPM file (note the `.xpm' extension is optional) for	763	Use the specified image file for the background and also
645	the background and also optionally specify its scaling with a geometry	764	optionally specify its scaling with a geometry string B<WxH+X+Y>,
646	string B<WxH+X+Y>, in which B<"W" / "H"> specify the	765	(default C<100x100+50+50>) in which B<"W" / "H"> specify the
647	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image	766	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
648	centre (percent). A scale of 0 displays the image with tiling. A scale	767	centre (percent). A scale of 0 displays the image with tiling.
649	of 1 displays the image without any scaling. A scale of 2 to 9	768	The maximum permitted scale is 1000.
650	specifies an integer number of images in that direction. No image will	769	Additional operations can be specified after colon B<:op1:op2...>.
651	be magnified beyond 10 times its original size. The maximum permitted	770	Supported operations are:
652	scale is 1000. [default 0x0+50+50]	771
		772	tile force background image to be tiled and not scaled. Equivalent to 0x0
		773	propscale will scale image keeping proportions
		774	auto will scale image to match window size. Equivalent to 100x100
		775	hscale will scale image horizontally to the window size
		776	vscale will scale image vertically to the window size
		777	scale will scale image to match window size
		778	root will tile image as if it was a root window background, auto-adjusting
		779	whenever terminal window moves
		780
		781	If used in conjunction with B<-tr> option, the specified pixmap will be
		782	blended over transparency image using either alpha-blending, or any
		783	other blending type, specified with B<-blt "type"> option.
653		784
654	=item B<path:> I<path>	785	=item B<path:> I<path>
655		786
656	Specify the colon-delimited search path for finding XPM files.	787	Specify the colon-delimited search path for finding background image files.
657		788
658	=item B<font:> I<fontlist>	789	=item B<font:> I<fontlist>
659		790
660	Select the fonts to be used. This is a comma separated list of font names	791	Select the fonts to be used. This is a comma separated list of font names
661	that are checked in order when trying to find glyphs for characters. The	792	that are checked in order when trying to find glyphs for characters. The
…		…
684	it is named first) and thus defines the character cell grid to be 9 pixels	815	it is named first) and thus defines the character cell grid to be 9 pixels
685	wide and 15 pixels high.	816	wide and 15 pixels high.
686		817
687	The second font is just used to add additional unicode characters not in	818	The second font is just used to add additional unicode characters not in
688	the base font, likewise the third, which is unfortunately non-bold, but	819	the base font, likewise the third, which is unfortunately non-bold, but
689	the bold version of the font does contain less characters, so this is a	820	the bold version of the font does contain fewer characters, so this is a
690	useful supplement.	821	useful supplement.
691		822
692	The third font is an Xft font with aliasing turned off, and the characters	823	The third font is an Xft font with aliasing turned off, and the characters
693	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font	824	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
694	contains other characters, but we are not interested in them.	825	contains other characters, but we are not interested in them.
…		…
718	text font will being used for the given style.	849	text font will being used for the given style.
719		850
720	=item B<intensityStyles:> I<boolean>	851	=item B<intensityStyles:> I<boolean>
721		852
722	When font styles are not enabled, or this option is enabled (B<True>,	853	When font styles are not enabled, or this option is enabled (B<True>,
723	option B<-is>, the default), bold and italic font styles imply high	854	option B<-is>, the default), bold/blink font styles imply high
724	intensity foreground/background colours. Disabling this option (B<False>,	855	intensity foreground/background colours. Disabling this option (B<False>,
725	option B<+is>) disables this behaviour, the high intensity colours are not	856	option B<+is>) disables this behaviour, the high intensity colours are not
726	reachable.	857	reachable.
727		858
728	=item B<selectstyle:> I<mode>
729
730	Set mouse selection style to B<old> which is 2.20, B<oldword> which is
731	xterm style with 2.20 old word selection, or anything else which gives
732	xterm style selection.
733
734	=item B<scrollstyle:> I<mode>
735
736	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
737	the author's favourite.
738
739	=item B<title:> I<string>	859	=item B<title:> I<string>
740		860
741	Set window title string, the default title is the command-line	861	Set window title string, the default title is the command-line
742	specified after the B<-e> option, if any, otherwise the application	862	specified after the B<-e> option, if any, otherwise the application
743	name; option B<-title>.	863	name; option B<-title>.
…		…
756	=item B<urgentOnBell:> I<boolean>	876	=item B<urgentOnBell:> I<boolean>
757		877
758	B<True>: set the urgency hint for the wm on receipt of a bell character.	878	B<True>: set the urgency hint for the wm on receipt of a bell character.
759	B<False>: do not set the urgency hint [default].	879	B<False>: do not set the urgency hint [default].
760		880
		881	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		882
761	=item B<visualBell:> I<boolean>	883	=item B<visualBell:> I<boolean>
762		884
763	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	885	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
764	B<False>: no visual bell [default]; option B<+vb>.	886	B<False>: no visual bell [default]; option B<+vb>.
765		887
…		…
787		909
788	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	910	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
789		911
790	This creates a new file in your home directory with the screen contents	912	This creates a new file in your home directory with the screen contents
791	every time you hit C<Print>.	913	every time you hit C<Print>.
		914
		915	=item B<scrollstyle:> I<mode>
		916
		917	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		918	the author's favourite.
792		919
793	=item B<scrollBar:> I<boolean>	920	=item B<scrollBar:> I<boolean>
794		921
795	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	922	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
796	disable the scrollbar; option B<+sb>.	923	disable the scrollbar; option B<+sb>.
…		…
859	=item B<termName:> I<termname>	986	=item B<termName:> I<termname>
860		987
861	Specifies the terminal type name to be set in the B<TERM> environment	988	Specifies the terminal type name to be set in the B<TERM> environment
862	variable; option B<-tn>.	989	variable; option B<-tn>.
863		990
864	=item B<linespace:> I<number>	991	=item B<lineSpace:> I<number>
865		992
866	Specifies number of lines (pixel height) to insert between each row of	993	Specifies number of lines (pixel height) to insert between each row of
867	the display [default 0]; option B<-lsp>.	994	the display [default 0]; option B<-lsp>.
868		995
869	=item B<meta8:> I<boolean>	996	=item B<meta8:> I<boolean>
…		…
883		1010
884	=item B<cursorBlink:> I<boolean>	1011	=item B<cursorBlink:> I<boolean>
885		1012
886	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	1013	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
887	option B<-bc>.	1014	option B<-bc>.
		1015
		1016	=item B<cursorUnderline:> I<boolean>
		1017
		1018	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		1019	option B<-uc>.
888		1020
889	=item B<pointerBlank:> I<boolean>	1021	=item B<pointerBlank:> I<boolean>
890		1022
891	B<True>: blank the pointer when a key is pressed or after a set number	1023	B<True>: blank the pointer when a key is pressed or after a set number
892	of seconds of inactivity. B<False>: the pointer is always visible	1024	of seconds of inactivity. B<False>: the pointer is always visible
…		…
906	large number (e.g. C<987654321>) to effectively disable the timeout.	1038	large number (e.g. C<987654321>) to effectively disable the timeout.
907		1039
908	=item B<backspacekey:> I<string>	1040	=item B<backspacekey:> I<string>
909		1041
910	The string to send when the backspace key is pressed. If set to B<DEC>	1042	The string to send when the backspace key is pressed. If set to B<DEC>
911	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	1043	or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
912	(code 8) - which can be reversed with the appropriate DEC private mode	1044	(code 8) - which can be reversed with the appropriate DEC private mode
913	escape sequence.	1045	escape sequence.
914		1046
915	=item B<deletekey:> I<string>	1047	=item B<deletekey:> I<string>
916		1048
…		…
921	=item B<cutchars:> I<string>	1053	=item B<cutchars:> I<string>
922		1054
923	The characters used as delimiters for double-click word selection	1055	The characters used as delimiters for double-click word selection
924	(whitespace delimiting is added automatically if resource is given).	1056	(whitespace delimiting is added automatically if resource is given).
925		1057
926	When the selection extension is in use (the default if compiled in, see	1058	When the perl selection extension is in use (the default if compiled
927	the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters	1059	in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
928	will be created (if the resource exists, otherwise, no regex will be	1060	characters will be created (if the resource exists, otherwise, no regex
929	created). In this mode, characters outside ISO-8859-1 can be used.	1061	will be created). In this mode, characters outside ISO-8859-1 can be used.
930		1062
931	When the selection extension is not used, only ISO-8859-1 characters can	1063	When the selection extension is not used, only ISO-8859-1 characters can
932	be used. If not specified, the built-in default is used:	1064	be used. If not specified, the built-in default is used:
933		1065
934	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	1066	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
935		1067
936	=item B<preeditType:> I<style>	1068	=item B<preeditType:> I<style>
937		1069
938	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1070	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
939		1071
…		…
995		1127
996	=item B<secondaryScroll:> I<boolean>	1128	=item B<secondaryScroll:> I<boolean>
997		1129
998	Turn on/off secondary screen scroll (default enabled). If this	1130	Turn on/off secondary screen scroll (default enabled). If this
999	option is enabled, scrolls on the secondary screen will change the	1131	option is enabled, scrolls on the secondary screen will change the
1000	scrollback buffer and switching to/from the secondary screen will	1132	scrollback buffer and, when secondaryScreen is off, switching
1001	instead scroll the screen up.	1133	to/from the secondary screen will instead scroll the screen up.
1002		1134
1003	=item B<hold>: I<boolean>	1135	=item B<hold>: I<boolean>
1004		1136
1005	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1137	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1006	will not immediately destroy its window when the program executed within	1138	will not immediately destroy its window when the program executed within
1007	it exits. Instead, it will wait till it is being killed or closed by the	1139	it exits. Instead, it will wait till it is being killed or closed by the
1008	user.	1140	user.
		1141
		1142	=item B<chdir>: I<path>
		1143
		1144	Sets the working directory for the shell (or the command specified via
		1145	B<-e>). The I<path> must be an absolute path and it must exist for
		1146	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1147	directory will be used; option B<-cd>.
1009		1148
1010	=item B<keysym.>I<sym>: I<string>	1149	=item B<keysym.>I<sym>: I<string>
1011		1150
1012	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1151	Compile I<frills>: Associate I<string> with keysym I<sym>. The
1013	intervening resource name B<keysym.> cannot be omitted.	1152	intervening resource name B<keysym.> cannot be omitted.
…		…
1027	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1166	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1028	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1167	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1029	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1168	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1030	performed in an exact manner; however, the closest match is assured.	1169	performed in an exact manner; however, the closest match is assured.
1031		1170
1032	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1171	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1033	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1172	number), see RESOURCES in C<man 7 X> for further details.
1034	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1035	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1036	can start or end with whitespace. B<This feature is deprecated and will
1037	be removed>.
1038
1039	Please note that you need to double the C<\> in resource files, as
1040	Xlib itself does its own de-escaping (you can use C<\033> instead of
1041	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1042	processing).
1043		1173
1044	You can define a range of keysyms in one shot by providing a I<string>	1174	You can define a range of keysyms in one shot by providing a I<string>
1045	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1175	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1046	should be a character not used by the strings.	1176	should be a character not used by the strings.
1047		1177
…		…
1061	when Control-Meta-c is being pressed":	1191	when Control-Meta-c is being pressed":
1062		1192
1063	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1193	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1064		1194
1065	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1195	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1066	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)	1196	is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1067	manpage. For example, the F<selection> extension (activated via	1197	manpage. For example, the F<selection> extension (activated via
1068	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:	1198	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1069		1199
1070	URxvt.keysym.M-C-c: perl:selection:rot13	1200	URxvt.keysym.M-C-c: perl:selection:rot13
1071		1201
1072	Due the the large number of modifier combinations, a defined key mapping	1202	Due the the large number of modifier combinations, a defined key mapping
1073	will match if at I<at least> the specified identifiers are being set, and	1203	will match if I<at least> the specified identifiers are being set, and
1074	no other key mappings with those and more bits are being defined. That	1204	no other key mappings with those and more bits are being defined. That
1075	means that defining a key map for C<a> will automatically provide	1205	means that defining a key map for C<a> will automatically provide
1076	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined	1206	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1077	mappings themselves.	1207	mappings themselves.
1078		1208
…		…
1129	all instances, while B<perl-ext> is used for specific instances.	1259	all instances, while B<perl-ext> is used for specific instances.
1130		1260
1131	=item B<perl-eval>: I<string>	1261	=item B<perl-eval>: I<string>
1132		1262
1133	Perl code to be evaluated when all extensions have been registered. See	1263	Perl code to be evaluated when all extensions have been registered. See
1134	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource	1264	the @@RXVT_NAME@@perl(3) manpage.
1135	will be ignored when running setuid/setgid.
1136		1265
1137	=item B<perl-lib>: I<path>	1266	=item B<perl-lib>: I<path>
1138		1267
1139	Colon-separated list of additional directories that hold extension	1268	Colon-separated list of additional directories that hold extension
1140	scripts. When looking for extensions specified by the C<perl> resource,	1269	scripts. When looking for extensions specified by the C<perl> resource,
1141	@@RXVT_NAME@@ will first look in these directories and then in	1270	@@RXVT_NAME@@ will first look in these directories and then in
1142	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1271	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1143	will be ignored when running setuid/setgid.
1144		1272
1145	See the @@RXVT_NAME@@perl(3) manpage.	1273	See the @@RXVT_NAME@@perl(3) manpage.
1146		1274
1147	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1275	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1148		1276
…		…
1170		1298
1171	=item B<override-redirect>: I<boolean>	1299	=item B<override-redirect>: I<boolean>
1172		1300
1173	Compile I<frills>: Sets override-redirect for the terminal window, making	1301	Compile I<frills>: Sets override-redirect for the terminal window, making
1174	it almost invisible to window managers; option B<-override-redirect>.	1302	it almost invisible to window managers; option B<-override-redirect>.
		1303
		1304	=item B<iso14755:> I<boolean>
		1305
		1306	Turn on/off ISO 14755 (default enabled).
		1307
		1308	=item B<iso14755_52:> I<boolean>
		1309
		1310	Turn on/off ISO 14755 5.2 mode (default enabled).
1175		1311
1176	=back	1312	=back
1177		1313
1178	=head1 THE SCROLLBAR	1314	=head1 THE SCROLLBAR
1179		1315
…		…
1198	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>	1334	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1199	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the	1335	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1200	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),	1336	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1201	respectively.	1337	respectively.
1202		1338
1203	=head1 TEXT SELECTION AND INSERTION	1339	=head1 THE SELECTION: SELECTING AND PASTING TEXT
1204		1340
1205	The behaviour of text selection and insertion mechanism is similar to	1341	The behaviour of text selection and insertion/pasting mechanism is similar
1206	I<xterm>(1).	1342	to I<xterm>(1).
1207		1343
1208	=over 4	1344	=over 4
1209		1345
1210	=item B<Selection>:	1346	=item B<Selecting>:
1211		1347
1212	Left click at the beginning of the region, drag to the end of the region	1348	Left click at the beginning of the region, drag to the end of the region
1213	and release; Right click to extend the marked region; Left double-click	1349	and release; Right click to extend the marked region; Left double-click
1214	to select a word; Left triple-click to select the entire logical line	1350	to select a word; Left triple-click to select the entire logical line
1215	(which can span multiple screen lines), unless modified by resource	1351	(which can span multiple screen lines), unless modified by resource
…		…
1219	(Compile: I<frills>) will create a rectangular selection instead of a	1355	(Compile: I<frills>) will create a rectangular selection instead of a
1220	normal one. In this mode, every selected row becomes its own line in the	1356	normal one. In this mode, every selected row becomes its own line in the
1221	selection, and trailing whitespace is visually underlined and removed from	1357	selection, and trailing whitespace is visually underlined and removed from
1222	the selection.	1358	the selection.
1223		1359
1224	=item B<Insertion>:	1360	=item B<Pasting>:
1225		1361
1226	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>	1362	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1227	window causes the value of the PRIMARY selection (or CLIPBOARD with the	1363	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1228	Meta modifier) to be inserted as if it had been typed on the keyboard.	1364	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1229		1365
1230	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be	1366	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1231	inserted too.	1367	inserted too.
1232		1368
1233	=back	1369	=back
…		…
1250		1386
1251	=head1 ISO 14755 SUPPORT	1387	=head1 ISO 14755 SUPPORT
1252		1388
1253	ISO 14755 is a standard for entering and viewing unicode characters	1389	ISO 14755 is a standard for entering and viewing unicode characters
1254	and character codes using the keyboard. It consists of 4 parts. The	1390	and character codes using the keyboard. It consists of 4 parts. The
1255	first part is available rxvt-unicode has been compiled with	1391	first part is available if rxvt-unicode has been compiled with
1256	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1392	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1257	with C<--enable-iso14755>.	1393	with C<--enable-iso14755>.
1258		1394
1259	=over 4	1395	=over 4
1260		1396
…		…
1318	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1454	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1319	it can be seen via the I<who(1)> command, and can accept messages. To	1455	it can be seen via the I<who(1)> command, and can accept messages. To
1320	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root	1456	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1321	on some systems or setgid to root or to some other group on others.	1457	on some systems or setgid to root or to some other group on others.
1322		1458
1323	=head1 COLORS AND GRAPHICS	1459	=head1 COLOURS AND GRAPHICS
1324		1460
1325	In addition to the default foreground and background colours,	1461	In addition to the default foreground and background colours,
1326	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1462	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1327	high-intensity bold/blink versions of the same). Here is a list of the	1463	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1328	colours with their names.	1464	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1465	cube plus a 8 (24) colour greyscale ramp.
		1466
		1467	Here is a list of the ANSI colours with their names.
1329		1468
1330	=begin table	1469	=begin table
1331		1470
1332	B<color0> (black) = Black	1471	B<color0> (black) = Black
1333	B<color1> (red) = Red3	1472	B<color1> (red) = Red3
…		…
1353	It is also possible to specify the colour values of B<foreground>,	1492	It is also possible to specify the colour values of B<foreground>,
1354	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1493	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1355	a number 0-15, as a convenient shorthand to reference the colour name of	1494	a number 0-15, as a convenient shorthand to reference the colour name of
1356	color0-color15.	1495	color0-color15.
1357		1496
1358	In addition to the colours defined above, @@RXVT_NAME@@ offers an	1497	The following text gives values for the standard 88 colour mode (and
1359	additional 72 colours. The first 64 of those (with indices 16 to 79)	1498	values for the 256 colour mode in parentheses).
1360	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
1361	16>), followed by 8 additional shades of gray (with indices 80 to 87).
1362		1499
		1500	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1501
		1502	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1503	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
		1504
		1505	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1506	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1507	the RGB cube.
		1508
1363	Together, all those colours implement the 88 colour xterm colours. Only	1509	Together, all those colours implement the 88 (256) colour xterm
1364	the first 16 can be changed using resources currently, the rest can only	1510	colours. Only the first 16 can be changed using resources currently, the
1365	be changed via command sequences ("escape codes").	1511	rest can only be changed via command sequences ("escape codes").
		1512
		1513	Applications are advised to use terminfo or command sequences to discover
		1514	number and RGB values of all colours (yes, you can query this...).
1366		1515
1367	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1516	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1368	always swapping the foreground/background colours. This is in contrast to	1517	always swapping the foreground/background colours. This is in contrast to
1369	I<xterm>(1) where the colours are only swapped if they have not otherwise	1518	I<xterm>(1) where the colours are only swapped if they have not otherwise
1370	been specified. For example,	1519	been specified. For example,
1371		1520
1372	=over 4
1373
1374	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1521	@@RXVT_NAME@@ -fg Black -bg White -rv
1375		1522
1376	would yield White on Black, while on I<xterm>(1) it would yield Black	1523	would yield White on Black, while on I<xterm>(1) it would yield Black on
1377	on White.	1524	White.
1378
1379	=back
1380		1525
1381	=head2 ALPHA CHANNEL SUPPORT	1526	=head2 ALPHA CHANNEL SUPPORT
1382		1527
1383	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1528	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1384	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>	1529	their act together, rxvt-unicode will do it's own alpha channel management:
1385	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1530
1386	in addition to the ones provided by X, where the additional A component	1531	You can prefix any colour with an opaqueness percentage enclosed in
		1532	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1533	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1534	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1535	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1536	is the recommended format to specify transparency values, and works with
		1537	all ways to specify a colour.
		1538
		1539	For complete control, rxvt-unicode also supports
		1540	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1541	specifications, where the additional C<aaaa> component specifies opacity
1387	specifies opacity (alpha) values. The minimum value of C<0> is completely	1542	(alpha) values. The minimum value of C<0000> is completely transparent,
1388	transparent). You can also prefix any color with C<[percent]>, where	1543	while C<ffff> is completely opaque). The two example colours from
1389	C<percent> is a decimal percentage (0-100) that specifies the opacity of	1544	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1390	the color, where C<0> is completely transparent and C<100> is completelxy	1545	C<rgba:0000/ff00/0000/f332>.
1391	opaque.
1392		1546
1393	You probably need to specify B<"-depth 32">, too, and have the luck that	1547	You probably need to specify B<"-depth 32">, too, to force a visual with
1394	your X-server uses ARGB pixel layout, as X is far from just supporting	1548	alpha channels, and have the luck that your X-server uses ARGB pixel
1395	ARGB visuals out of the box, and rxvt-unicode just fudges around.	1549	layout, as X is far from just supporting ARGB visuals out of the box, and
		1550	rxvt-unicode just fudges around.
1396		1551
1397	For example, the following selects an almost completely transparent red	1552	For example, the following selects an almost completely transparent black
1398	background, and an almost opaque pink foreground:	1553	background, and an almost opaque pink foreground:
1399		1554
1400	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"	1555	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1401		1556
1402	I<Please note that transparency of any kind if completely unsupported by	1557	When not using a background image, then the interpretation of the
1403	the author. Don't bug him with installation questions!>	1558	alpha channel is up to your compositing manager (most interpret it as
		1559	transparency of course).
		1560
		1561	When using a background pixmap or pseudo-transparency, then the background
		1562	colour will always behave as if it were completely transparent (so the
		1563	background image shows instead), regardless of how it was specified, while
		1564	other colours will either be transparent as specified (the background
		1565	image will show through) on servers supporting the RENDER extension, or
		1566	fully opaque on servers not supporting the RENDER EXTENSION.
		1567
		1568	Please note that due to bugs in Xft, specifying alpha values might result
		1569	in garbage being displayed when the X-server does not support the RENDER
		1570	extension.
1404		1571
1405	=head1 ENVIRONMENT	1572	=head1 ENVIRONMENT
1406		1573
1407	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1574	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1408		1575
…		…
1414	resources or on the command line.	1581	resources or on the command line.
1415		1582
1416	=item B<COLORTERM>	1583	=item B<COLORTERM>
1417		1584
1418	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was	1585	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1419	compiled with XPM support, and optionally with the added extension	1586	compiled with background image support, and optionally with the added
1420	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1587	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1588	screen.
1421		1589
1422	=item B<COLORFGBG>	1590	=item B<COLORFGBG>
1423		1591
1424	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1592	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1425	the colour code used as default foreground/text colour (or the string	1593	the colour code used as default foreground/text colour (or the string
1426	C<default> to indicate that the default-colour escape sequence is to be	1594	C<default> to indicate that the default-colour escape sequence is to be
1427	used), C<bg> is the colour code used as default background colour (or the	1595	used), C<bg> is the colour code used as default background colour (or the
1428	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1596	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1429	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can	1597	was compiled with background image support. Libraries like C<ncurses>
1430	(and do) use this information to optimize screen output.	1598	and C<slang> can (and do) use this information to optimize screen output.
1431		1599
1432	=item B<WINDOWID>	1600	=item B<WINDOWID>
1433		1601
1434	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1602	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1435	window, which usually has subwindows for the scrollbar, the terminal	1603	window, which usually has subwindows for the scrollbar, the terminal
…		…
1441	C<--with-terminfo=PATH>.	1609	C<--with-terminfo=PATH>.
1442		1610
1443	=item B<DISPLAY>	1611	=item B<DISPLAY>
1444		1612
1445	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1613	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1446	display in its child processes.	1614	display in its child processes if C<-display> isn't used to override. It
		1615	defaults to C<:0> if it doesn't exist.
1447		1616
1448	=item B<SHELL>	1617	=item B<SHELL>
1449		1618
1450	The shell to be used for command execution, defaults to C</bin/sh>.	1619	The shell to be used for command execution, defaults to C</bin/sh>.
1451		1620
…		…
1477		1646
1478	=over 4	1647	=over 4
1479		1648
1480	=item B</usr/lib/X11/rgb.txt>	1649	=item B</usr/lib/X11/rgb.txt>
1481		1650
1482	Color names.	1651	Colour names.
1483		1652
1484	=back	1653	=back
1485		1654
1486	=head1 SEE ALSO	1655	=head1 SEE ALSO
1487		1656
…		…
1526	Project Coordinator (changes.txt 2.21a to 2.4.5)	1695	Project Coordinator (changes.txt 2.21a to 2.4.5)
1527		1696
1528	=item Geoff Wing L<< <gcw@pobox.com> >>	1697	=item Geoff Wing L<< <gcw@pobox.com> >>
1529		1698
1530	Rewrote screen display and text selection routines.	1699	Rewrote screen display and text selection routines.
1531		1700
1532	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1701	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1533		1702
1534	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1703	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1535		1704
1536	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1705	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.127 by ayin, Wed May 2 23:06:32 2007 UTC vs. Revision 1.185 by sf-exg, Mon Oct 4 07:18:23 2010 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.127 by ayin, Wed May 2 23:06:32 2007 UTC vs.
Revision 1.185 by sf-exg, Mon Oct 4 07:18:23 2010 UTC