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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.129 by root, Mon May 28 20:34:56 2007 UTC vs.
Revision 1.245 by root, Wed Jun 17 11:59:37 2015 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<frills>: 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
		111	=item B<-visual> I<visualID>
		112
		113	Compile I<frills>: Use the given visual (see e.g. C<xdpyinfo> for
		114	possible visual ids) instead of the default, and also allocate a private
		115	colormap. All visual types except for DirectColor are supported.
		116
103	=item B<-geometry> I<geom>	117	=item B<-geometry> I<geom>
104		118
105	Window geometry (B<-g> still respected); resource B<geometry>.	119	Window geometry (B<-g> still respected); resource B<geometry>.
106		120
107	=item B<-rv>\|B<+rv>	121	=item B<-rv>\|B<+rv>
108		122
109	Turn on/off simulated reverse video; resource B<reverseVideo>.	123	Turn on/off simulated reverse video; resource B<reverseVideo>.
110		124
111	=item B<-j>\|B<+j>	125	=item B<-j>\|B<+j>
112		126
113	Turn on/off jump scrolling; resource B<jumpScroll>.	127	Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
114		128
115	=item B<-ip>\|B<+ip> \| B<-tr>\|B<+tr>	129	=item B<-ss>\|B<+ss>
116		130
117	Turn on/off inheriting parent window's pixmap. Alternative form is	131	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
118	B<-tr>; resource B<inheritPixmap>.
119
120	I<Please note that transparency of any kind if completely unsupported by
121	the author. Don't bug him with installation questions! Read the FAQ (man 7
122	@@RXVT_NAME@@)!>
123		132
124	=item B<-fade> I<number>	133	=item B<-fade> I<number>
125		134
126	Fade the text by the given percentage when focus is lost. Small values	135	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	136	fade a little only, 100 completely replaces all colours by the fade
…		…
130	=item B<-fadecolor> I<colour>	139	=item B<-fadecolor> I<colour>
131		140
132	Fade to this colour when fading is used (see B<-fade>). The default colour	141	Fade to this colour when fading is used (see B<-fade>). The default colour
133	is opaque black. resource B<fadeColor>.	142	is opaque black. resource B<fadeColor>.
134		143
135	=item B<-tint> I<colour>	144	=item B<-icon> I<file>
136		145
137	Tint the transparent background pixmap with the given colour when	146	Compile I<pixbuf>: Use the specified image as application icon. This
138	transparency is enabled with B<-tr> or B<-ip>. This only works for	147	is used by many window managers, taskbars and pagers to represent the
139	non-tiled backgrounds, currently. See also the B<-sh> option that can be	148	application window; resource I<iconFile>.
140	used to brighten or darken the image in addition to tinting it; resource
141	I<tintColor>. Example:
142
143	@@RXVT_NAME@@ -tr -tint blue -sh 40
144
145	=item B<-sh>
146
147	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent
148	background image in addition to tinting it (i.e. B<-tint> must be
149	specified, too, e.g. C<-tint white>); resource I<shading>.
150		149
151	=item B<-bg> I<colour>	150	=item B<-bg> I<colour>
152		151
153	Window background colour; resource B<background>.	152	Window background colour; resource B<background>.
154		153
155	=item B<-fg> I<colour>	154	=item B<-fg> I<colour>
156		155
157	Window foreground colour; resource B<foreground>.	156	Window foreground colour; resource B<foreground>.
158
159	=item B<-pixmap> I<file[;geom]>
160
161	Compile I<XPM>: Specify XPM file for the background and also optionally
162	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
164	command-line; resource B<backgroundPixmap>.
165		157
166	=item B<-cr> I<colour>	158	=item B<-cr> I<colour>
167		159
168	The cursor colour; resource B<cursorColor>.	160	The cursor colour; resource B<cursorColor>.
169		161
…		…
214	italic> >> characters are to be printed. See resource B<boldItalicFont>	206	italic> >> characters are to be printed. See resource B<boldItalicFont>
215	for details.	207	for details.
216		208
217	=item B<-is>\|B<+is>	209	=item B<-is>\|B<+is>
218		210
219	Compile I<font-styles>: Bold/Italic font styles imply high intensity	211	Compile I<font-styles>: Bold/Blink font styles imply high intensity
220	foreground/background (default). See resource B<intensityStyles> for	212	foreground/background (default). See resource B<intensityStyles> for
221	details.	213	details.
222		214
223	=item B<-name> I<name>	215	=item B<-name> I<name>
224		216
…		…
228		220
229	=item B<-ls>\|B<+ls>	221	=item B<-ls>\|B<+ls>
230		222
231	Start as a login-shell/sub-shell; resource B<loginShell>.	223	Start as a login-shell/sub-shell; resource B<loginShell>.
232		224
		225	=item B<-mc> I<milliseconds>
		226
		227	Specify the maximum time between multi-click selections.
		228
233	=item B<-ut>\|B<+ut>	229	=item B<-ut>\|B<+ut>
234		230
235	Compile I<utmp>: Inhibit/enable writing a utmp entry; resource	231	Compile I<utmp>: Inhibit/enable writing a utmp entry; resource
236	B<utmpInhibit>.	232	B<utmpInhibit>.
237		233
…		…
241	B<visualBell>.	237	B<visualBell>.
242		238
243	=item B<-sb>\|B<+sb>	239	=item B<-sb>\|B<+sb>
244		240
245	Turn on/off scrollbar; resource B<scrollBar>.	241	Turn on/off scrollbar; resource B<scrollBar>.
		242
		243	=item B<-sr>\|B<+sr>
		244
		245	Put scrollbar on right/left; resource B<scrollBar_right>.
		246
		247	=item B<-st>\|B<+st>
		248
		249	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
		250	resource B<scrollBar_floating>.
246		251
247	=item B<-si>\|B<+si>	252	=item B<-si>\|B<+si>
248		253
249	Turn on/off scroll-to-bottom on TTY output inhibit; resource	254	Turn on/off scroll-to-bottom on TTY output inhibit; resource
250	B<scrollTtyOutput> has opposite effect.	255	B<scrollTtyOutput> has opposite effect.
…		…
257	=item B<-sw>\|B<+sw>	262	=item B<-sw>\|B<+sw>
258		263
259	Turn on/off scrolling with the scrollback buffer as new lines appear.	264	Turn on/off scrolling with the scrollback buffer as new lines appear.
260	This only takes effect if B<-si> is also given; resource	265	This only takes effect if B<-si> is also given; resource
261	B<scrollWithBuffer>.	266	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		267
272	=item B<-ptab>\|B<+ptab>	268	=item B<-ptab>\|B<+ptab>
273		269
274	If enabled (default), "Horizontal Tab" characters are being stored as	270	If enabled (default), "Horizontal Tab" characters are being stored as
275	actual wide characters in the screen buffer, which makes it possible to	271	actual wide characters in the screen buffer, which makes it possible to
…		…
279		275
280	=item B<-bc>\|B<+bc>	276	=item B<-bc>\|B<+bc>
281		277
282	Blink the cursor; resource B<cursorBlink>.	278	Blink the cursor; resource B<cursorBlink>.
283		279
		280	=item B<-uc>\|B<+uc>
		281
		282	Make the cursor underlined; resource B<cursorUnderline>.
		283
284	=item B<-iconic>	284	=item B<-iconic>
285		285
286	Start iconified, if the window manager supports that option.	286	Start iconified, if the window manager supports that option.
287	Alternative form is B<-ic>.	287	Alternative form is B<-ic>.
288		288
…		…
304		304
305	=item B<-bl>	305	=item B<-bl>
306		306
307	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	307	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	308	if honoured by the WM, the rxvt-unicode window will not have window
309	decorations; resource B<borderLess>.	309	decorations; resource B<borderLess>. If the window manager does not
		310	support MWM hints (e.g. kwin), enables override-redirect mode.
310		311
311	=item B<-override-redirect>	312	=item B<-override-redirect>
312		313
313	Compile I<frills>: Sets override-redirect on the window; resource	314	Compile I<frills>: Sets override-redirect on the window; resource
314	B<override-redirect>.	315	B<override-redirect>.
		316
		317	=item B<-dockapp>
		318
		319	Sets the initial state of the window to WithdrawnState, which makes
		320	window managers that support this extension treat it as a dockapp.
315		321
316	=item B<-sbg>	322	=item B<-sbg>
317		323
318	Compile I<frills>: Disable the usage of the built-in block graphics/line	324	Compile I<frills>: Disable the usage of the built-in block graphics/line
319	drawing characters and just rely on what the specified fonts provide. Use	325	drawing characters and just rely on what the specified fonts provide. Use
…		…
322		328
323	=item B<-lsp> I<number>	329	=item B<-lsp> I<number>
324		330
325	Compile I<frills>: Lines (pixel height) to insert between each row of	331	Compile I<frills>: Lines (pixel height) to insert between each row of
326	the display. Useful to work around font rendering problems; resource	332	the display. Useful to work around font rendering problems; resource
327	B<linespace>.	333	B<lineSpace>.
		334
		335	=item B<-letsp> I<number>
		336
		337	Compile I<frills>: Amount to adjust the computed character width by
		338	to control overall letter spacing. Negative values will tighten up the
		339	letter spacing, positive values will space letters out more. Useful to
		340	work around odd font metrics; resource B<letterSpace>.
328		341
329	=item B<-tn> I<termname>	342	=item B<-tn> I<termname>
330		343
331	This option specifies the name of the terminal type to be set in the	344	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	345	B<TERM> environment variable. This terminal type must exist in the
…		…
367	=item B<-pt> I<style>	380	=item B<-pt> I<style>
368		381
369	Compile I<XIM>: input style for input method; B<OverTheSpot>,	382	Compile I<XIM>: input style for input method; B<OverTheSpot>,
370	B<OffTheSpot>, B<Root>; resource B<preeditType>.	383	B<OffTheSpot>, B<Root>; resource B<preeditType>.
371		384
		385	If the perl extension C<xim-onthespot> is used (which is the default),
		386	then additionally the C<OnTheSpot> preedit type is available.
		387
372	=item B<-im> I<text>	388	=item B<-im> I<text>
373		389
374	Compile I<XIM>: input method name. resource B<inputMethod>.	390	Compile I<XIM>: input method name. resource B<inputMethod>.
375		391
376	=item B<-imlocale> I<string>	392	=item B<-imlocale> I<string>
…		…
387		403
388	=item B<-tcw>	404	=item B<-tcw>
389		405
390	Change the meaning of triple-click selection with the left mouse	406	Change the meaning of triple-click selection with the left mouse
391	button. Only effective when the original (non-perl) selection code is	407	button. Only effective when the original (non-perl) selection code is
392	in-use. Instead of selecting a full line it will extend the selection the	408	in-use. Instead of selecting a full line it will extend the selection to
393	end of the logical line only. resource B<tripleclickwords>.	409	the end of the logical line only. resource B<tripleclickwords>.
394		410
395	=item B<-insecure>	411	=item B<-insecure>
396		412
397	Enable "insecure" mode, which currently enables most of the escape	413	Enable "insecure" mode, which currently enables most of the escape
398	sequences that echo strings. See the resource B<insecure> for more	414	sequences that echo strings. See the resource B<insecure> for more
…		…
418		434
419	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	435	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
420	will not immediately destroy its window when the program executed within	436	will not immediately destroy its window when the program executed within
421	it exits. Instead, it will wait till it is being killed or closed by the	437	it exits. Instead, it will wait till it is being killed or closed by the
422	user; resource B<hold>.	438	user; resource B<hold>.
		439
		440	=item B<-cd> I<path>
		441
		442	Sets the working directory for the shell (or the command specified via
		443	B<-e>). The I<path> must be an absolute path and it must exist for
		444	@@RXVT_NAME@@ to start; resource B<chdir>.
		445
		446	=item B<-xrm> I<string>
		447
		448	Works like the X Toolkit option of the same name, by adding the I<string>
		449	as if it were specified in a resource file. Resource values specified this
		450	way take precedence over all other resource specifications.
		451
		452	Note that you need to use the I<same> syntax as in the .Xdefaults file,
		453	e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
		454	options can be specified as long-options on the commandline, so use
		455	of B<-xrm> is mostly limited to cases where you want to specify other
		456	resources (e.g. for input methods) or for compatibility with other
		457	programs.
423		458
424	=item B<-keysym.>I<sym> I<string>	459	=item B<-keysym.>I<sym> I<string>
425		460
426	Remap a key symbol. See resource B<keysym>.	461	Remap a key symbol. See resource B<keysym>.
427		462
…		…
462	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	497	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
463	entries and will not tinker with pty/tty permissions - you have to do that	498	entries and will not tinker with pty/tty permissions - you have to do that
464	yourself if you want that.	499	yourself if you want that.
465		500
466	As an extremely special case, specifying C<-1> will completely suppress	501	As an extremely special case, specifying C<-1> will completely suppress
467	pty/tty operations.	502	pty/tty operations, which is probably only useful in conjunction with some
		503	perl extension that manages the terminal.
468		504
469	Here is a example in perl that illustrates how this option can be used (a	505	Here is a example in perl that illustrates how this option can be used (a
470	longer example is in F<doc/pty-fd>):	506	longer example is in F<doc/pty-fd>):
471		507
472	use IO::Pty;	508	use IO::Pty;
…		…
486	Comma-separated list of perl extension scripts to use (or not to use) in	522	Comma-separated list of perl extension scripts to use (or not to use) in
487	this terminal instance. See resource B<perl-ext> for details.	523	this terminal instance. See resource B<perl-ext> for details.
488		524
489	=back	525	=back
490		526
491	=head1 RESOURCES (available also as long-options)	527	=head1 RESOURCES
492		528
493	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	529	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
494	options) compiled into your version.	530	options) compiled into your version. All resources are also available as
		531	long-options.
495		532
496	You can set and change the resources using X11 tools like B<xrdb>. Many	533	You can set and change the resources using X11 tools like B<xrdb>. Many
497	distribution do also load settings from the B<~/.Xresources> file when X	534	distribution do also load settings from the B<~/.Xresources> file when X
498	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	535	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
499	with later settings overwriting earlier ones:	536	with later settings overwriting earlier ones:
500		537
501	1. system-wide app-defaults file, either locale-dependent OR global
502	2. app-defaults file in $XAPPLRESDIR	538	1. app-defaults file in $XAPPLRESDIR
		539	2. $HOME/.Xdefaults
503	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	540	3. RESOURCE_MANAGER property on root-window of screen 0
504	4. SCREEN_RESOURCES for the current screen	541	4. SCREEN_RESOURCES property on root-window of the current screen
505	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	542	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		543	6. resources specified via -xrm on the commandline
506		544
507	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	545	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
508	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources	546	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
509	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily	547	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
510	configured, while the class name B<URxvt> allows resources unique to	548	configured, while the class name B<URxvt> allows resources unique to
…		…
520	=item B<depth:> I<bitdepth>	558	=item B<depth:> I<bitdepth>
521		559
522	Compile I<xft>: Attempt to find a visual with the given bit depth;	560	Compile I<xft>: Attempt to find a visual with the given bit depth;
523	option B<-depth>.	561	option B<-depth>.
524		562
		563	=item B<buffered:> I<boolean>
		564
		565	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		566	On some card/driver combination enabling it slightly decreases
		567	performance, on most it greatly helps it. The slowdown is small, so it
		568	should normally be enabled.
		569
525	=item B<geometry:> I<geom>	570	=item B<geometry:> I<geom>
526		571
527	Create the window with the specified X window geometry [default 80x24];	572	Create the window with the specified X window geometry [default 80x24];
528	option B<-geometry>.	573	option B<-geometry>.
529		574
…		…
542	Use the specified colour for the colour value I<n>, where 0-7	587	Use the specified colour for the colour value I<n>, where 0-7
543	corresponds to low-intensity (normal) colours and 8-15 corresponds to	588	corresponds to low-intensity (normal) colours and 8-15 corresponds to
544	high-intensity (bold = bright foreground, blink = bright background)	589	high-intensity (bold = bright foreground, blink = bright background)
545	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	590	colours. The canonical names are as follows: 0=black, 1=red, 2=green,
546	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour	591	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
547	names used are listed in the B<COLORS AND GRAPHICS> section.	592	names used are listed in the B<COLOURS AND GRAPHICS> section.
548		593
549	Colours higher than 15 cannot be set using resources (yet), but can be	594	Colours higher than 15 cannot be set using resources (yet), but can be
550	changed using an escape command (see @@RXVT_NAME@@(7)).	595	changed using an escape command (see @@RXVT_NAME@@(7)).
551		596
552	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with	597	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
…		…
563	=item B<colorUL:> I<colour>	608	=item B<colorUL:> I<colour>
564		609
565	Use the specified colour to display underlined characters when the	610	Use the specified colour to display underlined characters when the
566	foreground colour is the default.	611	foreground colour is the default.
567		612
568	=item B<colorRV:> I<colour>
569
570	Use the specified colour as the background for reverse video characters
571	when OPTION_HC is disabled (--disable-frills).
572
573	=item B<underlineColor:> I<colour>	613	=item B<underlineColor:> I<colour>
574		614
575	If set, use the specified colour as the colour for the underline	615	If set, use the specified colour as the colour for the underline
576	itself. If unset, use the foreground colour.	616	itself. If unset, use the foreground colour.
		617
		618	=item B<highlightColor:> I<colour>
		619
		620	If set, use the specified colour as the background for highlighted
		621	characters. If unset, use reverse video.
		622
		623	=item B<highlightTextColor:> I<colour>
		624
		625	If set and highlightColor is set, use the specified colour as the
		626	foreground for highlighted characters.
577		627
578	=item B<cursorColor:> I<colour>	628	=item B<cursorColor:> I<colour>
579		629
580	Use the specified colour for the cursor. The default is to use the	630	Use the specified colour for the cursor. The default is to use the
581	foreground colour; option B<-cr>.	631	foreground colour; option B<-cr>.
…		…
588		638
589	=item B<reverseVideo:> I<boolean>	639	=item B<reverseVideo:> I<boolean>
590		640
591	B<True>: simulate reverse video by foreground and background colours;	641	B<True>: simulate reverse video by foreground and background colours;
592	option B<-rv>. B<False>: regular screen colours [default]; option	642	option B<-rv>. B<False>: regular screen colours [default]; option
593	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	643	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
594		644
595	=item B<jumpScroll:> I<boolean>	645	=item B<jumpScroll:> I<boolean>
596		646
597	B<True>: specify that jump scrolling should be used. When scrolling	647	B<True>: specify that jump scrolling should be used. When receiving lots
598	quickly, fewer screen updates are performed [default]; option B<-j>.	648	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
		649	has been read, resulting in fewer updates while still displaying every
		650	received line; option B<-j>.
		651
599	B<False>: specify that smooth scrolling should be used; option B<+j>.	652	B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
		653	force a screen refresh on each new line it received; option B<+j>.
600		654
601	=item B<inheritPixmap:> I<boolean>	655	=item B<skipScroll:> I<boolean>
602		656
603	B<True>: make the background inherit the parent windows' pixmap, giving	657	B<True>: (the default) specify that skip scrolling should be used. When
604	artificial transparency. B<False>: do not inherit the parent windows'	658	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
605	pixmap.	659	(around 60 times per second), resulting in far fewer updates. This can
		660	result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
		661	option B<-ss>.
606		662
607	I<Please note that transparency of any kind if completely unsupported by	663	B<False>: specify that everything is to be displayed, even
608	the author. Don't bug him with installation questions!>	664	if the refresh is too fast for the human eye to read anything (or the
		665	monitor to display anything); option B<+ss>.
609		666
610	=item B<fading:> I<number>	667	=item B<fading:> I<number>
611		668
612	Fade the text by the given percentage when focus is lost; option B<-fade>.	669	Fade the text by the given percentage when focus is lost; option B<-fade>.
613		670
614	=item B<fadeColor:> I<colour>	671	=item B<fadeColor:> I<colour>
615		672
616	Fade to this colour, when fading is used (see B<fading:>). The default	673	Fade to this colour, when fading is used (see B<fading:>). The default
617	colour is black; option B<-fadecolor>.	674	colour is black; option B<-fadecolor>.
618		675
619	=item B<tintColor:> I<colour>	676	=item B<iconFile:> I<file>
620		677
621	Tint the transparent background pixmap with the given colour; option	678	Set the application icon pixmap; option B<-icon>.
622	B<-tint>.
623
624	=item B<shading:> I<number>
625
626	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
627	in addition to tinting it; option B<-sh>.
628		679
629	=item B<scrollColor:> I<colour>	680	=item B<scrollColor:> I<colour>
630		681
631	Use the specified colour for the scrollbar [default #B2B2B2].	682	Use the specified colour for the scrollbar [default #B2B2B2].
632		683
…		…
637		688
638	=item B<borderColor:> I<colour>	689	=item B<borderColor:> I<colour>
639		690
640	The colour of the border around the text area and between the scrollbar	691	The colour of the border around the text area and between the scrollbar
641	and the text.	692	and the text.
642
643	=item B<backgroundPixmap:> I<file[;geom]>
644
645	Use the specified XPM file (note the `.xpm' extension is optional) for
646	the background and also optionally specify its scaling with a geometry
647	string B<WxH+X+Y>, in which B<"W" / "H"> specify the
648	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image
649	centre (percent). A scale of 0 displays the image with tiling. A scale
650	of 1 displays the image without any scaling. A scale of 2 to 9
651	specifies an integer number of images in that direction. No image will
652	be magnified beyond 10 times its original size. The maximum permitted
653	scale is 1000. [default 0x0+50+50]
654
655	=item B<path:> I<path>
656
657	Specify the colon-delimited search path for finding XPM files.
658		693
659	=item B<font:> I<fontlist>	694	=item B<font:> I<fontlist>
660		695
661	Select the fonts to be used. This is a comma separated list of font names	696	Select the fonts to be used. This is a comma separated list of font names
662	that are checked in order when trying to find glyphs for characters. The	697	that are checked in order when trying to find glyphs for characters. The
…		…
685	it is named first) and thus defines the character cell grid to be 9 pixels	720	it is named first) and thus defines the character cell grid to be 9 pixels
686	wide and 15 pixels high.	721	wide and 15 pixels high.
687		722
688	The second font is just used to add additional unicode characters not in	723	The second font is just used to add additional unicode characters not in
689	the base font, likewise the third, which is unfortunately non-bold, but	724	the base font, likewise the third, which is unfortunately non-bold, but
690	the bold version of the font does contain less characters, so this is a	725	the bold version of the font does contain fewer characters, so this is a
691	useful supplement.	726	useful supplement.
692		727
693	The third font is an Xft font with aliasing turned off, and the characters	728	The third font is an Xft font with aliasing turned off, and the characters
694	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font	729	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
695	contains other characters, but we are not interested in them.	730	contains other characters, but we are not interested in them.
…		…
719	text font will being used for the given style.	754	text font will being used for the given style.
720		755
721	=item B<intensityStyles:> I<boolean>	756	=item B<intensityStyles:> I<boolean>
722		757
723	When font styles are not enabled, or this option is enabled (B<True>,	758	When font styles are not enabled, or this option is enabled (B<True>,
724	option B<-is>, the default), bold and italic font styles imply high	759	option B<-is>, the default), bold/blink font styles imply high
725	intensity foreground/background colours. Disabling this option (B<False>,	760	intensity foreground/background colours. Disabling this option (B<False>,
726	option B<+is>) disables this behaviour, the high intensity colours are not	761	option B<+is>) disables this behaviour, the high intensity colours are not
727	reachable.	762	reachable.
728		763
729	=item B<selectstyle:> I<mode>
730
731	Set mouse selection style to B<old> which is 2.20, B<oldword> which
732	is xterm style with 2.20 old word selection, or anything else which
733	gives xterm style selection. Only effective when the original (non-perl)
734	selection code is in use.
735
736	=item B<scrollstyle:> I<mode>
737
738	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
739	the author's favourite.
740
741	=item B<title:> I<string>	764	=item B<title:> I<string>
742		765
743	Set window title string, the default title is the command-line	766	Set window title string, the default title is the command-line
744	specified after the B<-e> option, if any, otherwise the application	767	specified after the B<-e> option, if any, otherwise the application
745	name; option B<-title>.	768	name; option B<-title>.
…		…
758	=item B<urgentOnBell:> I<boolean>	781	=item B<urgentOnBell:> I<boolean>
759		782
760	B<True>: set the urgency hint for the wm on receipt of a bell character.	783	B<True>: set the urgency hint for the wm on receipt of a bell character.
761	B<False>: do not set the urgency hint [default].	784	B<False>: do not set the urgency hint [default].
762		785
		786	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		787
763	=item B<visualBell:> I<boolean>	788	=item B<visualBell:> I<boolean>
764		789
765	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	790	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
766	B<False>: no visual bell [default]; option B<+vb>.	791	B<False>: no visual bell [default]; option B<+vb>.
767		792
…		…
769		794
770	B<True>: start as a login shell by prepending a `-' to B<argv[0]> of	795	B<True>: start as a login shell by prepending a `-' to B<argv[0]> of
771	the shell; option B<-ls>. B<False>: start as a normal sub-shell	796	the shell; option B<-ls>. B<False>: start as a normal sub-shell
772	[default]; option B<+ls>.	797	[default]; option B<+ls>.
773		798
		799	=item B<multiClickTime:> I<number>
		800
		801	Specify the maximum time in milliseconds between multi-click select
		802	events. The default is 500 milliseconds; option B<-mc>.
		803
774	=item B<utmpInhibit:> I<boolean>	804	=item B<utmpInhibit:> I<boolean>
775		805
776	B<True>: inhibit writing record into the system log file B<utmp>;	806	B<True>: inhibit writing record into the system log file B<utmp>;
777	option B<-ut>. B<False>: write record into the system log file B<utmp>	807	option B<-ut>. B<False>: write record into the system log file B<utmp>
778	[default]; option B<+ut>.	808	[default]; option B<+ut>.
…		…
790	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	820	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
791		821
792	This creates a new file in your home directory with the screen contents	822	This creates a new file in your home directory with the screen contents
793	every time you hit C<Print>.	823	every time you hit C<Print>.
794		824
		825	=item B<scrollstyle:> I<mode>
		826
		827	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		828	the author's favourite.
		829
		830	=item B<thickness:> I<number>
		831
		832	Set the scrollbar width in pixels.
		833
795	=item B<scrollBar:> I<boolean>	834	=item B<scrollBar:> I<boolean>
796		835
797	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	836	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
798	disable the scrollbar; option B<+sb>.	837	disable the scrollbar; option B<+sb>.
799		838
…		…
818	B<False>: do not scroll to bottom when tty receives output; option	857	B<False>: do not scroll to bottom when tty receives output; option
819	B<+si>.	858	B<+si>.
820		859
821	=item B<scrollWithBuffer:> I<boolean>	860	=item B<scrollWithBuffer:> I<boolean>
822		861
823	B<True>: scroll with scrollback buffer when tty receives new lines (and	862	B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
824	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	863	try to show the same lines) and B<scrollTtyOutput> is False; option
825	with scrollback buffer when tty receives new lines; option B<+sw>.	864	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		865	new lines; option B<+sw>.
826		866
827	=item B<scrollTtyKeypress:> I<boolean>	867	=item B<scrollTtyKeypress:> I<boolean>
828		868
829	B<True>: scroll to bottom when a non-special key is pressed. Special keys	869	B<True>: scroll to bottom when a non-special key is pressed. Special keys
830	are those which are intercepted by rxvt-unicode for special handling and	870	are those which are intercepted by rxvt-unicode for special handling and
831	are not passed onto the shell; option B<-sk>. B<False>: do not scroll to	871	are not passed onto the shell; option B<-sk>. B<False>: do not scroll to
832	bottom when a non-special key is pressed; option B<+sk>.	872	bottom when a non-special key is pressed; option B<+sk>.
833		873
834	=item B<saveLines:> I<number>	874	=item B<saveLines:> I<number>
835		875
836	Save I<number> lines in the scrollback buffer [default 64]. This	876	Save I<number> lines in the scrollback buffer [default 1000]; option B<-sl>.
837	resource is limited on most machines to 65535; option B<-sl>.
838		877
839	=item B<internalBorder:> I<number>	878	=item B<internalBorder:> I<number>
840		879
841	Internal border of I<number> pixels. This resource is limited to 100;	880	Internal border of I<number> pixels. This resource is limited to 100;
842	option B<-b>.	881	option B<-b>.
…		…
861	=item B<termName:> I<termname>	900	=item B<termName:> I<termname>
862		901
863	Specifies the terminal type name to be set in the B<TERM> environment	902	Specifies the terminal type name to be set in the B<TERM> environment
864	variable; option B<-tn>.	903	variable; option B<-tn>.
865		904
866	=item B<linespace:> I<number>	905	=item B<lineSpace:> I<number>
867		906
868	Specifies number of lines (pixel height) to insert between each row of	907	Specifies number of lines (pixel height) to insert between each row of
869	the display [default 0]; option B<-lsp>.	908	the display [default 0]; option B<-lsp>.
870		909
871	=item B<meta8:> I<boolean>	910	=item B<meta8:> I<boolean>
…		…
885		924
886	=item B<cursorBlink:> I<boolean>	925	=item B<cursorBlink:> I<boolean>
887		926
888	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	927	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
889	option B<-bc>.	928	option B<-bc>.
		929
		930	=item B<cursorUnderline:> I<boolean>
		931
		932	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		933	option B<-uc>.
890		934
891	=item B<pointerBlank:> I<boolean>	935	=item B<pointerBlank:> I<boolean>
892		936
893	B<True>: blank the pointer when a key is pressed or after a set number	937	B<True>: blank the pointer when a key is pressed or after a set number
894	of seconds of inactivity. B<False>: the pointer is always visible	938	of seconds of inactivity. B<False>: the pointer is always visible
…		…
900		944
901	=item B<pointerColor2:> I<colour>	945	=item B<pointerColor2:> I<colour>
902		946
903	Mouse pointer background colour.	947	Mouse pointer background colour.
904		948
		949	=item B<pointerShape:> I<string>
		950
		951	Compile I<frills>: Specifies the name of the mouse pointer shape
		952	[default B<xterm>]. See the macros in the B<X11/cursorfont.h> include
		953	file for possible values (omit the C<XC_> prefix).
		954
905	=item B<pointerBlankDelay:> I<number>	955	=item B<pointerBlankDelay:> I<number>
906		956
907	Specifies number of seconds before blanking the pointer [default 2]. Use a	957	Specifies number of seconds before blanking the pointer [default 2]. Use a
908	large number (e.g. C<987654321>) to effectively disable the timeout.	958	large number (e.g. C<987654321>) to effectively disable the timeout.
909		959
910	=item B<backspacekey:> I<string>	960	=item B<backspacekey:> I<string>
911		961
912	The string to send when the backspace key is pressed. If set to B<DEC>	962	The string to send when the backspace key is pressed. If set to B<DEC>
913	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	963	or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
914	(code 8) - which can be reversed with the appropriate DEC private mode	964	(code 8) - which can be reversed with the appropriate DEC private mode
915	escape sequence.	965	escape sequence.
916		966
917	=item B<deletekey:> I<string>	967	=item B<deletekey:> I<string>
918		968
…		…
931	will be created). In this mode, characters outside ISO-8859-1 can be used.	981	will be created). In this mode, characters outside ISO-8859-1 can be used.
932		982
933	When the selection extension is not used, only ISO-8859-1 characters can	983	When the selection extension is not used, only ISO-8859-1 characters can
934	be used. If not specified, the built-in default is used:	984	be used. If not specified, the built-in default is used:
935		985
936	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	986	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
937		987
938	=item B<preeditType:> I<style>	988	=item B<preeditType:> I<style>
939		989
940	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	990	B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
941		991
942	=item B<inputMethod:> I<name>	992	=item B<inputMethod:> I<name>
943		993
944	I<name> of inputMethod to use; option B<-im>.	994	I<name> of inputMethod to use; option B<-im>.
945		995
…		…
997		1047
998	=item B<secondaryScroll:> I<boolean>	1048	=item B<secondaryScroll:> I<boolean>
999		1049
1000	Turn on/off secondary screen scroll (default enabled). If this	1050	Turn on/off secondary screen scroll (default enabled). If this
1001	option is enabled, scrolls on the secondary screen will change the	1051	option is enabled, scrolls on the secondary screen will change the
1002	scrollback buffer and switching to/from the secondary screen will	1052	scrollback buffer and, when secondaryScreen is off, switching
1003	instead scroll the screen up.	1053	to/from the secondary screen will instead scroll the screen up.
1004		1054
1005	=item B<hold>: I<boolean>	1055	=item B<hold>: I<boolean>
1006		1056
1007	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1057	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1008	will not immediately destroy its window when the program executed within	1058	will not immediately destroy its window when the program executed within
1009	it exits. Instead, it will wait till it is being killed or closed by the	1059	it exits. Instead, it will wait till it is being killed or closed by the
1010	user.	1060	user.
1011		1061
		1062	=item B<chdir>: I<path>
		1063
		1064	Sets the working directory for the shell (or the command specified via
		1065	B<-e>). The I<path> must be an absolute path and it must exist for
		1066	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1067	directory will be used; option B<-cd>.
		1068
1012	=item B<keysym.>I<sym>: I<string>	1069	=item B<keysym.>I<sym>: I<action>
1013		1070
1014	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1071	Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1015	intervening resource name B<keysym.> cannot be omitted.	1072	resource name B<keysym.> cannot be omitted.
1016		1073
1017	The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be	1074	Using this resource, you can map key combinations such as
1018	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,	1075	C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1019	B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,	1076	string than would normally result from that combination, making the
1020	and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,	1077	terminal scroll up or down the way you want it, or any other thing an
1021	B<2>, B<3>, B<4>, B<5>.	1078	extension might provide.
		1079
		1080	The key combination that triggers the action, I<sym>, has the following format:
		1081
		1082	(modifiers-)key
		1083
		1084	Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>,
		1085	B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>,
		1086	B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>,
		1087	B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>.
1022		1088
1023	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to	1089	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1024	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr	1090	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1025	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the	1091	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1026	current application keymap mode state.	1092	current application keymap mode state.
1027		1093
1028	The spellings of I<key> can be obtained by using B<xev>(1) command or	1094	Due the the large number of modifier combinations, a key mapping will
1029	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1095	match if I<at least> the specified identifiers are being set, and no other
		1096	key mappings with those and more bits are being defined. That means that
		1097	defining a mapping for C<a> will automatically provide definitions for
		1098	C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
		1099	themselves. See the C<builtin:> action, below, for a way to work around
		1100	this when this is a problem.
		1101
		1102	The spelling of I<key> depends on your implementation of X. An easy way to
		1103	find a key name is to use the B<xev>(1) command. You can find a list by
		1104	looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit
1030	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1105	the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym
1031	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1106	value (B<0x0000 - 0xFFFF>).
1032	performed in an exact manner; however, the closest match is assured.
1033		1107
1034	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1108	As with any resource value, the I<action> string may contain backslash
1035	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1109	escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1036	C<\000>: octal number) or verbatim control characters (C<^?>: delete,	1110	number), see RESOURCES in C<man 7 X> for further details.
1037	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1038	can start or end with whitespace. B<This feature is deprecated and will
1039	be removed>.
1040		1111
1041	Please note that you need to double the C<\> in resource files, as	1112	An action starts with an action prefix that selects a certain type
1042	Xlib itself does its own de-escaping (you can use C<\033> instead of	1113	of action, followed by a colon. An action string without colons is
1043	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own	1114	interpreted as a literal string to pass to the tty (as if it was
1044	processing).	1115	prefixed with C<string:>).
1045		1116
1046	You can define a range of keysyms in one shot by providing a I<string>	1117	The following action prefixes are known - extensions can provide
1047	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1118	additional prefixes:
		1119
		1120	=over 4
		1121
		1122	=item string:STRING
		1123
		1124	If the I<action> starts with C<string:> (or otherwise contains no colons),
		1125	then the remaining C<STRING> will be passed to the program running in the
		1126	terminal. For example, you could replace whatever Shift-Tab outputs by the
		1127	string C<echo rm -rf /> followed by a newline:
		1128
		1129	URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
		1130
		1131	This could in theory be used to completely redefine your keymap.
		1132
		1133	In addition, for actions of this type, you can define a range of
		1134	keysyms in one shot by loading the C<keysym-list> perl extension and
		1135	providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
1048	should be a character not used by the strings.	1136	the delimiter `/' should be a character not used by the strings.
1049		1137
1050	Its usage can be demonstrated by an example:	1138	Its usage can be demonstrated by an example:
1051		1139
1052	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1140	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1053		1141
1054	The above line is equivalent to the following three lines:	1142	The above line is equivalent to the following three lines:
1055		1143
1056	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1144	URxvt.keysym.Meta-Control-0x61: string:\033<a>
1057	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1145	URxvt.keysym.Meta-Control-0x62: string:\033<b>
1058	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1146	URxvt.keysym.Meta-Control-0x63: string:\033<c>
1059		1147
		1148	=item command:STRING
		1149
1060	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1150	If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1061	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1151	is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
		1152	the opposite of C<string:> - instead of sending it to the program running
		1153	in the terminal, it will be treated as if it were program output). This is
		1154	most useful to feed command sequences into @@RXVT_NAME@@.
		1155
1062	example the following means "change the current locale to C<zh_CN.GBK>	1156	For example the following means "change the current locale to C<zh_CN.GBK>
1063	when Control-Meta-c is being pressed":	1157	when Control-Meta-c is being pressed":
1064		1158
1065	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1159	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1066		1160
1067	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1161	The following example will map Control-Meta-1 and Control-Meta-2 to
1068	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)	1162	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1069	manpage. For example, the F<selection> extension (activated via	1163	font-switching at runtime:
1070	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1071		1164
1072	URxvt.keysym.M-C-c: perl:selection:rot13	1165	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
		1166	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1073		1167
1074	Due the the large number of modifier combinations, a defined key mapping	1168	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1075	will match if at I<at least> the specified identifiers are being set, and	1169	info):
1076	no other key mappings with those and more bits are being defined. That
1077	means that defining a key map for C<a> will automatically provide
1078	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1079	mappings themselves.
1080		1170
1081	Unfortunately, this will override built-in key mappings. For example	1171	URxvt.keysym.M-C-3: command:\033[8;25;80t
		1172	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1173
		1174	=item builtin:
		1175
		1176	The builtin action is the action that @@RXVT_NAME@@ would execute if no
		1177	key binding existed for the key combination. The obvious use is to undo
		1178	the effect of existing bindings. The not so obvious use is to reinstate
		1179	bindings when another binding overrides too many modifiers.
		1180
1082	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s	1181	For example if you overwrite the C<Insert> key you will disable
1083	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the	1182	@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1084	user-defined keymap using the C<builtin:> replacement:	1183	"holes" into the user-defined keymap using the C<builtin:> replacement:
1085		1184
1086	URxvt.keysym.Insert: <my insert key sequence>	1185	URxvt.keysym.Insert: <my insert key sequence>
1087	URxvt.keysym.S-Insert: builtin:	1186	URxvt.keysym.S-Insert: builtin:
1088		1187
1089	The first line defines a mapping for C<Insert> and I<any> combination	1188	The first line defines a mapping for C<Insert> and I<any> combination
1090	of modifiers. The second line re-establishes the default mapping for	1189	of modifiers. The second line re-establishes the default mapping for
1091	C<Shift-Insert>.	1190	C<Shift-Insert>.
1092		1191
1093	The following example will map Control-Meta-1 and Control-Meta-2 to	1192	=item builtin-string:
1094	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1095	font-switching at runtime:
1096		1193
1097	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007	1194	This action is mainly useful to restore string mappings for keys that
1098	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007	1195	have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
		1196	difficult to explain - basically, this action will send the string to the
		1197	application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
		1198	action for it.
1099		1199
1100	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more	1200	An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1101	info):	1201	selection when you press C<Shift-Insert>. With the following bindings, it
		1202	would instead emit the (undocumented, but what applications running in the
		1203	terminal might expect) sequence C<ESC [ 2 $> instead:
1102		1204
1103	URxvt.keysym.M-C-3: command:\033[8;25;80t	1205	URxvt.keysym.S-Insert: builtin-string:
1104	URxvt.keysym.M-C-4: command:\033[8;48;110t	1206	URxvt.keysym.C-S-Insert: builtin:
		1207
		1208	The first line disables the paste functionality for that key
		1209	combination, and the second reinstates the default behaviour for
		1210	C<Control-Shift-Insert>, which would otherwise be overridden.
		1211
		1212	Similarly, to let applications gain access to the C<C-M-c> (copy to
		1213	clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
		1214	this:
		1215
		1216	URxvt.keysym.C-M-c: builtin-string:
		1217	URxvt.keysym.C-M-v: builtin-string:
		1218
		1219	=item EXTENSION:STRING
		1220
		1221	An action of this form invokes the action B<STRING>, if any, provided
		1222	by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
		1223	be loaded automatically if necessary.
		1224
		1225	Not all extensions define actions, but popular extensions that do
		1226	include the I<selection> and I<matcher> extensions (documented in their
		1227	own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
		1228	respectively).
		1229
		1230	From the silly examples department, this will rot13-"encrypt"
		1231	@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
		1232	keyboards:
		1233
		1234	URxvt.keysym.M-C-c: selection:rot13
		1235
		1236	=item perl:STRING DEPRECATED
		1237
		1238	This is a deprecated way of invoking commands provided by perl
		1239	extensions. It is still supported, but should not be used anymore.
		1240
		1241	=back
1105		1242
1106	=item B<perl-ext-common>: I<string>	1243	=item B<perl-ext-common>: I<string>
1107		1244
1108	=item B<perl-ext>: I<string>	1245	=item B<perl-ext>: I<string>
1109		1246
…		…
1111	use in this terminal instance; option B<-pe>.	1248	use in this terminal instance; option B<-pe>.
1112		1249
1113	Extension names can be prefixed with a C<-> sign to prohibit using	1250	Extension names can be prefixed with a C<-> sign to prohibit using
1114	them. This can be useful to selectively disable some extensions loaded	1251	them. This can be useful to selectively disable some extensions loaded
1115	by default, or specified via the C<perl-ext-common> resource. For	1252	by default, or specified via the C<perl-ext-common> resource. For
1116	example, C<default,-selection> will use all the default extension except	1253	example, C<default,-selection> will use all the default extensions except
1117	C<selection>.	1254	C<selection>.
1118		1255
1119	Extension names can also be followed by an argument in angle brackets	1256	The default set includes the C<selection>, C<option-popup>,
1120	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for	1257	C<selection-popup>, C<readline> and C<searchable-scrollback>
1121	searchable scrollback to Alt/Meta-s). Mentioning the same extension	1258	extensions, and extensions which are mentioned in B<keysym> resources.
1122	multiple times with different arguments will pass multiple arguments to	1259
1123	the extension.	1260	Any extension such that a corresponding resource is given on the
		1261	command line is automatically appended to B<perl-ext>.
1124		1262
1125	Each extension is looked up in the library directories, loaded if	1263	Each extension is looked up in the library directories, loaded if
1126	necessary, and bound to the current terminal instance.	1264	necessary, and bound to the current terminal instance. When the library
		1265	search path contains multiple extension files of the same name, then the
		1266	first one found will be used.
1127		1267
1128	If both of these resources are the empty string, then the perl	1268	If both of these resources are the empty string, then the perl interpreter
1129	interpreter will not be initialized. The idea behind two options is that	1269	will not be initialized. The rationale for having two options is that
1130	B<perl-ext-common> will be used for extensions that should be available to	1270	B<perl-ext-common> will be used for extensions that should be available to
1131	all instances, while B<perl-ext> is used for specific instances.	1271	all instances, while B<perl-ext> is used for specific instances.
1132		1272
1133	=item B<perl-eval>: I<string>	1273	=item B<perl-eval>: I<string>
1134		1274
1135	Perl code to be evaluated when all extensions have been registered. See	1275	Perl code to be evaluated when all extensions have been registered. See
1136	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource	1276	the @@RXVT_NAME@@perl(3) manpage.
1137	will be ignored when running setuid/setgid.
1138		1277
1139	=item B<perl-lib>: I<path>	1278	=item B<perl-lib>: I<path>
1140		1279
1141	Colon-separated list of additional directories that hold extension	1280	Colon-separated list of additional directories that hold extension
1142	scripts. When looking for extensions specified by the C<perl> resource,	1281	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1143	@@RXVT_NAME@@ will first look in these directories and then in	1282	in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1144	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1283	lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1145	will be ignored when running setuid/setgid.
1146		1284
1147	See the @@RXVT_NAME@@perl(3) manpage.	1285	See the @@RXVT_NAME@@perl(3) manpage.
1148		1286
1149	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1287	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1150		1288
…		…
1154	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>	1292	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1155		1293
1156	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage	1294	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1157	for details.	1295	for details.
1158		1296
1159	=item B<searchable-scrollback:> I<keysym>	1297	=item B<searchable-scrollback:> I<keysym> DEPRECATED
1160		1298
1161	Sets the hotkey that starts the incremental scrollback buffer search	1299	This resource is deprecated and will be removed. Use a B<keysym> resource
1162	(default: C<M-s>).	1300	instead, e.g.:
1163		1301
		1302	URxvt.keysym.M-s: searchable-scrollback:start
		1303
1164	=item B<urlLauncher>: I<string>	1304	=item B<url-launcher>: I<string>
1165		1305
1166	Specifies the program to be started with a URL argument. Used by the	1306	Specifies the program to be started with a URL argument. Used by the
1167	C<selection-popup> and C<matcher> perl extensions.	1307	C<selection-popup> and C<matcher> perl extensions.
1168		1308
1169	=item B<transient-for>: I<windowid>	1309	=item B<transient-for>: I<windowid>
…		…
1172		1312
1173	=item B<override-redirect>: I<boolean>	1313	=item B<override-redirect>: I<boolean>
1174		1314
1175	Compile I<frills>: Sets override-redirect for the terminal window, making	1315	Compile I<frills>: Sets override-redirect for the terminal window, making
1176	it almost invisible to window managers; option B<-override-redirect>.	1316	it almost invisible to window managers; option B<-override-redirect>.
		1317
		1318	=item B<iso14755:> I<boolean>
		1319
		1320	Turn on/off ISO 14755 (default enabled).
		1321
		1322	=item B<iso14755_52:> I<boolean>
		1323
		1324	Turn on/off ISO 14755 5.2 mode (default enabled).
		1325
		1326	=back
		1327
		1328	=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
		1329
		1330	=over 4
		1331
		1332	=item B<-pixmap> I<file[;oplist]>
		1333
		1334	=item B<backgroundPixmap:> I<file[;oplist]>
		1335
		1336	Compile I<pixbuf>: Use the specified image file as the window's
		1337	background and also optionally specify a colon separated list of
		1338	operations to modify it. Note that you may need to quote the C<;>
		1339	character when using the command line option, as C<;> is usually a
		1340	metacharacter in shells. Supported operations are:
		1341
		1342	=over 4
		1343
		1344	=item B<WxH+X+Y>
		1345
		1346	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
		1347	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
		1348	scale of 0 disables scaling.
		1349
		1350	=item B<op=tile>
		1351
		1352	enables tiling
		1353
		1354	=item B<op=keep-aspect>
		1355
		1356	maintain the image aspect ratio when scaling
		1357
		1358	=item B<op=root-align>
		1359
		1360	use the position of the terminal window relative to the root window as
		1361	the image offset, simulating a root window background
		1362
		1363	=back
		1364
		1365	The default scale and position setting is C<100x100+50+50>.
		1366	Alternatively, a predefined set of templates can be used to achieve
		1367	the most common setups:
		1368
		1369	=over 4
		1370
		1371	=item B<style=tiled>
		1372
		1373	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
		1374
		1375	=item B<style=aspect-stretched>
		1376
		1377	the image is scaled to fill the whole window maintaining the aspect
		1378	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
		1379
		1380	=item B<style=stretched>
		1381
		1382	the image is scaled to fill the whole window. Equivalent to 100x100
		1383
		1384	=item B<style=centered>
		1385
		1386	the image is centered with no scaling. Equivalent to 0x0+50+50
		1387
		1388	=item B<style=root-tiled>
		1389
		1390	the image is tiled with no scaling and using 'root' positioning.
		1391	Equivalent to 0x0:op=tile:op=root-align
		1392
		1393	=back
		1394
		1395	If multiple templates are specified the last one wins. Note that a
		1396	template overrides all the scale, position and operations settings.
		1397
		1398	If used in conjunction with pseudo-transparency, the specified pixmap
		1399	will be blended over the transparent background using alpha-blending.
		1400
		1401	=item B<-tr>\|B<+tr>
		1402
		1403	=item B<transparent:> I<boolean>
		1404
		1405	Turn on/off pseudo-transparency by using the root pixmap as background.
		1406
		1407	B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
		1408	will be removed in future versions.
		1409
		1410	=item B<-tint> I<colour>
		1411
		1412	=item B<tintColor:> I<colour>
		1413
		1414	Tint the transparent background with the given colour. Note that a
		1415	black tint yields a completely black image while a white tint yields
		1416	the image unchanged.
		1417
		1418	=item B<-sh> I<number>
		1419
		1420	=item B<shading:> I<number>
		1421
		1422	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
		1423	A value of 100 means no shading.
		1424
		1425	=item B<-blr> I<HxV>
		1426
		1427	=item B<blurRadius:> I<HxV>
		1428
		1429	Apply gaussian blur with the specified radius to the transparent
		1430	background. If a single number is specified, the vertical and
		1431	horizontal radii are considered to be the same. Setting one of the
		1432	radii to 1 and the other to a large number creates interesting effects
		1433	on some backgrounds. The maximum radius value is 128. An horizontal or
		1434	vertical radius of 0 disables blurring.
		1435
		1436	=item B<path:> I<path>
		1437
		1438	Specify the colon-delimited search path for finding background image files.
1177		1439
1178	=back	1440	=back
1179		1441
1180	=head1 THE SCROLLBAR	1442	=head1 THE SCROLLBAR
1181		1443
…		…
1230	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.	1492	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1231		1493
1232	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be	1494	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1233	inserted too.	1495	inserted too.
1234		1496
		1497	rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
		1498	<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
		1499	binding causes the value of the internal selection to be copied to the
		1500	CLIPBOARD selection, while the second binding causes the value of the
		1501	CLIPBOARD selection to be inserted.
		1502
1235	=back	1503	=back
1236		1504
1237	=head1 CHANGING FONTS	1505	=head1 CHANGING FONTS
1238		1506
1239	Changing fonts (or font sizes, respectively) via the keypad is not yet	1507	Changing fonts (or font sizes, respectively) via the keypad is not yet
…		…
1252		1520
1253	=head1 ISO 14755 SUPPORT	1521	=head1 ISO 14755 SUPPORT
1254		1522
1255	ISO 14755 is a standard for entering and viewing unicode characters	1523	ISO 14755 is a standard for entering and viewing unicode characters
1256	and character codes using the keyboard. It consists of 4 parts. The	1524	and character codes using the keyboard. It consists of 4 parts. The
1257	first part is available rxvt-unicode has been compiled with	1525	first part is available if rxvt-unicode has been compiled with
1258	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1526	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1259	with C<--enable-iso14755>.	1527	with C<--enable-iso14755>.
1260		1528
1261	=over 4	1529	=over 4
1262		1530
…		…
1320	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1588	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1321	it can be seen via the I<who(1)> command, and can accept messages. To	1589	it can be seen via the I<who(1)> command, and can accept messages. To
1322	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root	1590	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1323	on some systems or setgid to root or to some other group on others.	1591	on some systems or setgid to root or to some other group on others.
1324		1592
1325	=head1 COLORS AND GRAPHICS	1593	=head1 COLOURS AND GRAPHICS
1326		1594
1327	In addition to the default foreground and background colours,	1595	In addition to the default foreground and background colours,
1328	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1596	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1329	high-intensity bold/blink versions of the same). Here is a list of the	1597	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1330	colours with their names.	1598	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1599	cube plus a 8 (24) colour greyscale ramp.
		1600
		1601	Here is a list of the ANSI colours with their names.
1331		1602
1332	=begin table	1603	=begin table
1333		1604
1334	B<color0> (black) = Black	1605	B<color0> (black) = Black
1335	B<color1> (red) = Red3	1606	B<color1> (red) = Red3
…		…
1355	It is also possible to specify the colour values of B<foreground>,	1626	It is also possible to specify the colour values of B<foreground>,
1356	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1627	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1357	a number 0-15, as a convenient shorthand to reference the colour name of	1628	a number 0-15, as a convenient shorthand to reference the colour name of
1358	color0-color15.	1629	color0-color15.
1359		1630
1360	In addition to the colours defined above, @@RXVT_NAME@@ offers an	1631	The following text gives values for the standard 88 colour mode (and
1361	additional 72 colours. The first 64 of those (with indices 16 to 79)	1632	values for the 256 colour mode in parentheses).
1362	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
1363	16>), followed by 8 additional shades of gray (with indices 80 to 87).
1364		1633
		1634	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1635
		1636	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1637	index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
		1638
		1639	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1640	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1641	the RGB cube.
		1642
1365	Together, all those colours implement the 88 colour xterm colours. Only	1643	Together, all those colours implement the 88 (256) colour xterm
1366	the first 16 can be changed using resources currently, the rest can only	1644	colours. Only the first 16 can be changed using resources currently, the
1367	be changed via command sequences ("escape codes").	1645	rest can only be changed via command sequences ("escape codes").
		1646
		1647	Applications are advised to use terminfo or command sequences to discover
		1648	number and RGB values of all colours (yes, you can query this...).
1368		1649
1369	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1650	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1370	always swapping the foreground/background colours. This is in contrast to	1651	always swapping the foreground/background colours. This is in contrast to
1371	I<xterm>(1) where the colours are only swapped if they have not otherwise	1652	I<xterm>(1) where the colours are only swapped if they have not otherwise
1372	been specified. For example,	1653	been specified. For example,
1373		1654
1374	=over 4
1375
1376	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1655	@@RXVT_NAME@@ -fg Black -bg White -rv
1377		1656
1378	would yield White on Black, while on I<xterm>(1) it would yield Black	1657	would yield White on Black, while on I<xterm>(1) it would yield Black on
1379	on White.	1658	White.
1380
1381	=back
1382		1659
1383	=head2 ALPHA CHANNEL SUPPORT	1660	=head2 ALPHA CHANNEL SUPPORT
1384		1661
1385	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1662	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1386	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>	1663	their act together, rxvt-unicode will do its own alpha channel management:
1387	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1664
1388	in addition to the ones provided by X, where the additional A component	1665	You can prefix any colour with an opaqueness percentage enclosed in
		1666	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1667	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1668	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1669	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1670	is the recommended format to specify transparency values, and works with
		1671	all ways to specify a colour.
		1672
		1673	For complete control, rxvt-unicode also supports
		1674	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1675	specifications, where the additional C<aaaa> component specifies opacity
1389	specifies opacity (alpha) values. The minimum value of C<0> is completely	1676	(alpha) values. The minimum value of C<0000> is completely transparent,
1390	transparent). You can also prefix any color with C<[percent]>, where	1677	while C<ffff> is completely opaque). The two example colours from
1391	C<percent> is a decimal percentage (0-100) that specifies the opacity of	1678	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1392	the color, where C<0> is completely transparent and C<100> is completelxy	1679	C<rgba:0000/ff00/0000/f332>.
1393	opaque.
1394		1680
1395	You probably need to specify B<"-depth 32">, too, and have the luck that	1681	You probably need to specify B<"-depth 32">, too, to force a visual with
1396	your X-server uses ARGB pixel layout, as X is far from just supporting	1682	alpha channels, and have the luck that your X-server uses ARGB pixel
1397	ARGB visuals out of the box, and rxvt-unicode just fudges around.	1683	layout, as X is far from just supporting ARGB visuals out of the box, and
		1684	rxvt-unicode just fudges around.
1398		1685
1399	For example, the following selects an almost completely transparent red	1686	For example, the following selects an almost completely transparent black
1400	background, and an almost opaque pink foreground:	1687	background, and an almost opaque pink foreground:
1401		1688
1402	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"	1689	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1403		1690
1404	I<Please note that transparency of any kind if completely unsupported by	1691	When not using a background image, then the interpretation of the
1405	the author. Don't bug him with installation questions!>	1692	alpha channel is up to your compositing manager (most interpret it as
		1693	transparency of course).
		1694
		1695	When using a background pixmap or pseudo-transparency, then the background
		1696	colour will always behave as if it were completely transparent (so the
		1697	background image shows instead), regardless of how it was specified, while
		1698	other colours will either be transparent as specified (the background
		1699	image will show through) on servers supporting the RENDER extension, or
		1700	fully opaque on servers not supporting the RENDER EXTENSION.
		1701
		1702	Please note that due to bugs in Xft, specifying alpha values might result
		1703	in garbage being displayed when the X-server does not support the RENDER
		1704	extension.
1406		1705
1407	=head1 ENVIRONMENT	1706	=head1 ENVIRONMENT
1408		1707
1409	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1708	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1410		1709
…		…
1416	resources or on the command line.	1715	resources or on the command line.
1417		1716
1418	=item B<COLORTERM>	1717	=item B<COLORTERM>
1419		1718
1420	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was	1719	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1421	compiled with XPM support, and optionally with the added extension	1720	compiled with background image support, and optionally with the added
1422	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1721	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1722	screen.
1423		1723
1424	=item B<COLORFGBG>	1724	=item B<COLORFGBG>
1425		1725
1426	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1726	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1427	the colour code used as default foreground/text colour (or the string	1727	the colour code used as default foreground/text colour (or the string
1428	C<default> to indicate that the default-colour escape sequence is to be	1728	C<default> to indicate that the default-colour escape sequence is to be
1429	used), C<bg> is the colour code used as default background colour (or the	1729	used), C<bg> is the colour code used as default background colour (or the
1430	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1730	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1431	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can	1731	was compiled with background image support. Libraries like C<ncurses>
1432	(and do) use this information to optimize screen output.	1732	and C<slang> can (and do) use this information to optimize screen output.
1433		1733
1434	=item B<WINDOWID>	1734	=item B<WINDOWID>
1435		1735
1436	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1736	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1437	window, which usually has subwindows for the scrollbar, the terminal	1737	window, which usually has subwindows for the scrollbar, the terminal
…		…
1443	C<--with-terminfo=PATH>.	1743	C<--with-terminfo=PATH>.
1444		1744
1445	=item B<DISPLAY>	1745	=item B<DISPLAY>
1446		1746
1447	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1747	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1448	display in its child processes.	1748	display in its child processes if C<-display> isn't used to override. It
		1749	defaults to C<:0> if it doesn't exist.
1449		1750
1450	=item B<SHELL>	1751	=item B<SHELL>
1451		1752
1452	The shell to be used for command execution, defaults to C</bin/sh>.	1753	The shell to be used for command execution, defaults to C</bin/sh>.
1453		1754
1454	=item B<RXVT_SOCKET>	1755	=item B<RXVT_SOCKET> [I<sic>]
1455		1756
1456	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1757	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1457	@@RXVT_NAME@@d(1).	1758	@@RXVT_NAME@@d(1).
1458		1759
1459	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1760	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
		1761
		1762	=item B<URXVT_PERL_LIB>
		1763
		1764	Additional F<:>-separated library search path for perl extensions. Will be
		1765	searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
		1766	directory.
		1767
		1768	=item B<URXVT_PERL_VERBOSITY>
		1769
		1770	See L<@@RXVT_NAME@@perl>(3).
1460		1771
1461	=item B<HOME>	1772	=item B<HOME>
1462		1773
1463	Used to locate the default directory for the unix domain socket for	1774	Used to locate the default directory for the unix domain socket for
1464	daemon communications and to locate various resource files (such as	1775	daemon communications and to locate various resource files (such as
1465	C<.Xdefaults>)	1776	C<.Xdefaults>)
1466		1777
1467	=item B<XAPPLRESDIR>	1778	=item B<XAPPLRESDIR>
1468		1779
1469	Directory where various X resource files are being located.	1780	Directory where application-specific X resource files are located.
1470		1781
1471	=item B<XENVIRONMENT>	1782	=item B<XENVIRONMENT>
1472		1783
1473	If set and accessible, gives the name of a X resource file to be loaded by	1784	If set and accessible, gives the name of a X resource file to be loaded by
1474	@@RXVT_NAME@@.	1785	@@RXVT_NAME@@.
…		…
1479		1790
1480	=over 4	1791	=over 4
1481		1792
1482	=item B</usr/lib/X11/rgb.txt>	1793	=item B</usr/lib/X11/rgb.txt>
1483		1794
1484	Color names.	1795	Colour names.
1485		1796
1486	=back	1797	=back
1487		1798
1488	=head1 SEE ALSO	1799	=head1 SEE ALSO
1489		1800
		1801	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1490	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)	1802	@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1491		1803
1492	=head1 CURRENT PROJECT COORDINATOR	1804	=head1 CURRENT PROJECT COORDINATOR
1493		1805
1494	=over 4	1806	=over 4
1495		1807
1496	=item Project Coordinator	1808	=item Project Coordinator
1497		1809
1498	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1810	Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1499		1811
1500	L<http://software.schmorp.de/pkg/rxvt-unicode.html>	1812	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1501		1813
1502	=back	1814	=back
1503		1815
…		…
1507		1819
1508	=item John Bovey	1820	=item John Bovey
1509		1821
1510	University of Kent, 1992, wrote the original Xvt.	1822	University of Kent, 1992, wrote the original Xvt.
1511		1823
1512	=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >>	1824	=item Rob Nation <nation@rocket.sanders.lockheed.com>
1513		1825
1514	very heavily modified Xvt and came up with Rxvt	1826	very heavily modified Xvt and came up with Rxvt
1515		1827
1516	=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >>	1828	=item Angelo Haritsis <ah@doc.ic.ac.uk>
1517		1829
1518	wrote the Greek Keyboard Input (no longer in code)	1830	wrote the Greek Keyboard Input (no longer in code)
1519		1831
1520	=item mj olesen L<< <olesen@me.QueensU.CA> >>	1832	=item mj olesen <olesen@me.QueensU.CA>
1521		1833
1522	Wrote the menu system.	1834	Wrote the menu system.
1523		1835
1524	Project Coordinator (changes.txt 2.11 to 2.21)	1836	Project Coordinator (changes.txt 2.11 to 2.21)
1525		1837
1526	=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >>	1838	=item Oezguer Kesim <kesim@math.fu-berlin.de>
1527		1839
1528	Project Coordinator (changes.txt 2.21a to 2.4.5)	1840	Project Coordinator (changes.txt 2.21a to 2.4.5)
1529		1841
1530	=item Geoff Wing L<< <gcw@pobox.com> >>	1842	=item Geoff Wing <gcw@pobox.com>
1531		1843
1532	Rewrote screen display and text selection routines.	1844	Rewrote screen display and text selection routines.
1533		1845
1534	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1846	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1535		1847
1536	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1848	=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1537		1849
1538	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1850	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1539	extension, random hacks, numerous bugfixes and extensions.	1851	extension, random hacks, numerous bugfixes and extensions.
1540		1852
1541	Project Coordinator (Changes 1.0 -)	1853	Project Coordinator (Changes 1.0 -)
1542		1854
1543	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1855	=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1544		1856
1545	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.	1857	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1546		1858
1547	=back	1859	=back
1548		1860

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.129 by root, Mon May 28 20:34:56 2007 UTC vs. Revision 1.245 by root, Wed Jun 17 11:59:37 2015 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.129 by root, Mon May 28 20:34:56 2007 UTC vs.
Revision 1.245 by root, Wed Jun 17 11:59:37 2015 UTC