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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.125 by root, Fri Jan 19 23:45:03 2007 UTC vs.
Revision 1.244 by sf-exg, Tue Jun 16 11:58:26 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>
…		…
386	for more info.	402	for more info.
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
		407	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	408	in-use. Instead of selecting a full line it will extend the selection to
392	end of the logical line only. resource B<tripleclickwords>.	409	the end of the logical line only. resource B<tripleclickwords>.
393		410
394	=item B<-insecure>	411	=item B<-insecure>
395		412
396	Enable "insecure" mode, which currently enables most of the escape	413	Enable "insecure" mode, which currently enables most of the escape
397	sequences that echo strings. See the resource B<insecure> for more	414	sequences that echo strings. See the resource B<insecure> for more
…		…
417		434
418	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@@
419	will not immediately destroy its window when the program executed within	436	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	437	it exits. Instead, it will wait till it is being killed or closed by the
421	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.
422		458
423	=item B<-keysym.>I<sym> I<string>	459	=item B<-keysym.>I<sym> I<string>
424		460
425	Remap a key symbol. See resource B<keysym>.	461	Remap a key symbol. See resource B<keysym>.
426		462
…		…
461	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
462	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
463	yourself if you want that.	499	yourself if you want that.
464		500
465	As an extremely special case, specifying C<-1> will completely suppress	501	As an extremely special case, specifying C<-1> will completely suppress
466	pty/tty operations.	502	pty/tty operations, which is probably only useful in conjunction with some
		503	perl extension that manages the terminal.
467		504
468	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
469	longer example is in F<doc/pty-fd>):	506	longer example is in F<doc/pty-fd>):
470		507
471	use IO::Pty;	508	use IO::Pty;
…		…
485	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
486	this terminal instance. See resource B<perl-ext> for details.	523	this terminal instance. See resource B<perl-ext> for details.
487		524
488	=back	525	=back
489		526
490	=head1 RESOURCES (available also as long-options)	527	=head1 RESOURCES
491		528
492	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	529	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
493	options) compiled into your version.	530	options) compiled into your version. All resources are also available as
		531	long-options.
494		532
495	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
496	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
497	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	535	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
498	with later settings overwriting earlier ones:	536	with later settings overwriting earlier ones:
499		537
500	1. system-wide app-defaults file, either locale-dependent OR global
501	2. app-defaults file in $XAPPLRESDIR	538	1. app-defaults file in $XAPPLRESDIR
		539	2. $HOME/.Xdefaults
502	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	540	3. RESOURCE_MANAGER property on root-window of screen 0
503	4. SCREEN_RESOURCES for the current screen	541	4. SCREEN_RESOURCES property on root-window of the current screen
504	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	542	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		543	6. resources specified via -xrm on the commandline
505		544
506	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
507	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
508	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
509	configured, while the class name B<URxvt> allows resources unique to	548	configured, while the class name B<URxvt> allows resources unique to
…		…
519	=item B<depth:> I<bitdepth>	558	=item B<depth:> I<bitdepth>
520		559
521	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;
522	option B<-depth>.	561	option B<-depth>.
523		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
524	=item B<geometry:> I<geom>	570	=item B<geometry:> I<geom>
525		571
526	Create the window with the specified X window geometry [default 80x24];	572	Create the window with the specified X window geometry [default 80x24];
527	option B<-geometry>.	573	option B<-geometry>.
528		574
…		…
541	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
542	corresponds to low-intensity (normal) colours and 8-15 corresponds to	588	corresponds to low-intensity (normal) colours and 8-15 corresponds to
543	high-intensity (bold = bright foreground, blink = bright background)	589	high-intensity (bold = bright foreground, blink = bright background)
544	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,
545	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
546	names used are listed in the B<COLORS AND GRAPHICS> section.	592	names used are listed in the B<COLOURS AND GRAPHICS> section.
547		593
548	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
549	changed using an escape command (see @@RXVT_NAME@@(7)).	595	changed using an escape command (see @@RXVT_NAME@@(7)).
550		596
551	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
…		…
562	=item B<colorUL:> I<colour>	608	=item B<colorUL:> I<colour>
563		609
564	Use the specified colour to display underlined characters when the	610	Use the specified colour to display underlined characters when the
565	foreground colour is the default.	611	foreground colour is the default.
566		612
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>	613	=item B<underlineColor:> I<colour>
573		614
574	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
575	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.
576		627
577	=item B<cursorColor:> I<colour>	628	=item B<cursorColor:> I<colour>
578		629
579	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
580	foreground colour; option B<-cr>.	631	foreground colour; option B<-cr>.
…		…
587		638
588	=item B<reverseVideo:> I<boolean>	639	=item B<reverseVideo:> I<boolean>
589		640
590	B<True>: simulate reverse video by foreground and background colours;	641	B<True>: simulate reverse video by foreground and background colours;
591	option B<-rv>. B<False>: regular screen colours [default]; option	642	option B<-rv>. B<False>: regular screen colours [default]; option
592	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	643	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
593		644
594	=item B<jumpScroll:> I<boolean>	645	=item B<jumpScroll:> I<boolean>
595		646
596	B<True>: specify that jump scrolling should be used. When scrolling	647	B<True>: specify that jump scrolling should be used. When receiving lots
597	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
598	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>.
599		654
600	=item B<inheritPixmap:> I<boolean>	655	=item B<skipScroll:> I<boolean>
601		656
602	B<True>: make the background inherit the parent windows' pixmap, giving	657	B<True>: (the default) specify that skip scrolling should be used. When
603	artificial transparency. B<False>: do not inherit the parent windows'	658	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
604	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>.
605		662
606	I<Please note that transparency of any kind if completely unsupported by	663	B<False>: specify that everything is to be displayed, even
607	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>.
608		666
609	=item B<fading:> I<number>	667	=item B<fading:> I<number>
610		668
611	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>.
612		670
613	=item B<fadeColor:> I<colour>	671	=item B<fadeColor:> I<colour>
614		672
615	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
616	colour is black; option B<-fadecolor>.	674	colour is black; option B<-fadecolor>.
617		675
618	=item B<tintColor:> I<colour>	676	=item B<iconFile:> I<file>
619		677
620	Tint the transparent background pixmap with the given colour; option	678	Set the application icon pixmap; option B<-icon>.
621	B<-tint>.
622
623	=item B<shading:> I<number>
624
625	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
626	in addition to tinting it; option B<-sh>.
627		679
628	=item B<scrollColor:> I<colour>	680	=item B<scrollColor:> I<colour>
629		681
630	Use the specified colour for the scrollbar [default #B2B2B2].	682	Use the specified colour for the scrollbar [default #B2B2B2].
631		683
…		…
636		688
637	=item B<borderColor:> I<colour>	689	=item B<borderColor:> I<colour>
638		690
639	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
640	and the text.	692	and the text.
641
642	=item B<backgroundPixmap:> I<file[;geom]>
643
644	Use the specified XPM file (note the `.xpm' extension is optional) for
645	the background and also optionally specify its scaling with a geometry
646	string B<WxH+X+Y>, in which B<"W" / "H"> specify the
647	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
649	of 1 displays the image without any scaling. A scale of 2 to 9
650	specifies an integer number of images in that direction. No image will
651	be magnified beyond 10 times its original size. The maximum permitted
652	scale is 1000. [default 0x0+50+50]
653
654	=item B<path:> I<path>
655
656	Specify the colon-delimited search path for finding XPM files.
657		693
658	=item B<font:> I<fontlist>	694	=item B<font:> I<fontlist>
659		695
660	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
661	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
…		…
684	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
685	wide and 15 pixels high.	721	wide and 15 pixels high.
686		722
687	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
688	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
689	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
690	useful supplement.	726	useful supplement.
691		727
692	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
693	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
694	contains other characters, but we are not interested in them.	730	contains other characters, but we are not interested in them.
…		…
718	text font will being used for the given style.	754	text font will being used for the given style.
719		755
720	=item B<intensityStyles:> I<boolean>	756	=item B<intensityStyles:> I<boolean>
721		757
722	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>,
723	option B<-is>, the default), bold and italic font styles imply high	759	option B<-is>, the default), bold/blink font styles imply high
724	intensity foreground/background colours. Disabling this option (B<False>,	760	intensity foreground/background colours. Disabling this option (B<False>,
725	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
726	reachable.	762	reachable.
727		763
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>	764	=item B<title:> I<string>
740		765
741	Set window title string, the default title is the command-line	766	Set window title string, the default title is the command-line
742	specified after the B<-e> option, if any, otherwise the application	767	specified after the B<-e> option, if any, otherwise the application
743	name; option B<-title>.	768	name; option B<-title>.
…		…
751	=item B<mapAlert:> I<boolean>	776	=item B<mapAlert:> I<boolean>
752		777
753	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no	778	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
754	de-iconify (map) on receipt of a bell character [default].	779	de-iconify (map) on receipt of a bell character [default].
755		780
		781	=item B<urgentOnBell:> I<boolean>
		782
		783	B<True>: set the urgency hint for the wm on receipt of a bell character.
		784	B<False>: do not set the urgency hint [default].
		785
		786	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		787
756	=item B<visualBell:> I<boolean>	788	=item B<visualBell:> I<boolean>
757		789
758	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>.
759	B<False>: no visual bell [default]; option B<+vb>.	791	B<False>: no visual bell [default]; option B<+vb>.
760		792
…		…
762		794
763	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
764	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
765	[default]; option B<+ls>.	797	[default]; option B<+ls>.
766		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
767	=item B<utmpInhibit:> I<boolean>	804	=item B<utmpInhibit:> I<boolean>
768		805
769	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>;
770	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>
771	[default]; option B<+ut>.	808	[default]; option B<+ut>.
…		…
783	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	820	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
784		821
785	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
786	every time you hit C<Print>.	823	every time you hit C<Print>.
787		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
788	=item B<scrollBar:> I<boolean>	834	=item B<scrollBar:> I<boolean>
789		835
790	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	836	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
791	disable the scrollbar; option B<+sb>.	837	disable the scrollbar; option B<+sb>.
792		838
…		…
811	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
812	B<+si>.	858	B<+si>.
813		859
814	=item B<scrollWithBuffer:> I<boolean>	860	=item B<scrollWithBuffer:> I<boolean>
815		861
816	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.
817	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
818	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>.
819		866
820	=item B<scrollTtyKeypress:> I<boolean>	867	=item B<scrollTtyKeypress:> I<boolean>
821		868
822	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
823	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
…		…
854	=item B<termName:> I<termname>	901	=item B<termName:> I<termname>
855		902
856	Specifies the terminal type name to be set in the B<TERM> environment	903	Specifies the terminal type name to be set in the B<TERM> environment
857	variable; option B<-tn>.	904	variable; option B<-tn>.
858		905
859	=item B<linespace:> I<number>	906	=item B<lineSpace:> I<number>
860		907
861	Specifies number of lines (pixel height) to insert between each row of	908	Specifies number of lines (pixel height) to insert between each row of
862	the display [default 0]; option B<-lsp>.	909	the display [default 0]; option B<-lsp>.
863		910
864	=item B<meta8:> I<boolean>	911	=item B<meta8:> I<boolean>
…		…
878		925
879	=item B<cursorBlink:> I<boolean>	926	=item B<cursorBlink:> I<boolean>
880		927
881	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	928	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
882	option B<-bc>.	929	option B<-bc>.
		930
		931	=item B<cursorUnderline:> I<boolean>
		932
		933	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		934	option B<-uc>.
883		935
884	=item B<pointerBlank:> I<boolean>	936	=item B<pointerBlank:> I<boolean>
885		937
886	B<True>: blank the pointer when a key is pressed or after a set number	938	B<True>: blank the pointer when a key is pressed or after a set number
887	of seconds of inactivity. B<False>: the pointer is always visible	939	of seconds of inactivity. B<False>: the pointer is always visible
…		…
893		945
894	=item B<pointerColor2:> I<colour>	946	=item B<pointerColor2:> I<colour>
895		947
896	Mouse pointer background colour.	948	Mouse pointer background colour.
897		949
		950	=item B<pointerShape:> I<string>
		951
		952	Compile I<frills>: Specifies the name of the mouse pointer shape
		953	[default B<xterm>]. See the macros in the B<X11/cursorfont.h> include
		954	file for possible values (omit the C<XC_> prefix).
		955
898	=item B<pointerBlankDelay:> I<number>	956	=item B<pointerBlankDelay:> I<number>
899		957
900	Specifies number of seconds before blanking the pointer [default 2]. Use a	958	Specifies number of seconds before blanking the pointer [default 2]. Use a
901	large number (e.g. C<987654321>) to effectively disable the timeout.	959	large number (e.g. C<987654321>) to effectively disable the timeout.
902		960
903	=item B<backspacekey:> I<string>	961	=item B<backspacekey:> I<string>
904		962
905	The string to send when the backspace key is pressed. If set to B<DEC>	963	The string to send when the backspace key is pressed. If set to B<DEC>
906	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	964	or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
907	(code 8) - which can be reversed with the appropriate DEC private mode	965	(code 8) - which can be reversed with the appropriate DEC private mode
908	escape sequence.	966	escape sequence.
909		967
910	=item B<deletekey:> I<string>	968	=item B<deletekey:> I<string>
911		969
…		…
916	=item B<cutchars:> I<string>	974	=item B<cutchars:> I<string>
917		975
918	The characters used as delimiters for double-click word selection	976	The characters used as delimiters for double-click word selection
919	(whitespace delimiting is added automatically if resource is given).	977	(whitespace delimiting is added automatically if resource is given).
920		978
921	When the selection extension is in use (the default if compiled in, see	979	When the perl selection extension is in use (the default if compiled
922	the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters	980	in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
923	will be created (if the resource exists, otherwise, no regex will be	981	characters will be created (if the resource exists, otherwise, no regex
924	created). In this mode, characters outside ISO-8859-1 can be used.	982	will be created). In this mode, characters outside ISO-8859-1 can be used.
925		983
926	When the selection extension is not used, only ISO-8859-1 characters can	984	When the selection extension is not used, only ISO-8859-1 characters can
927	be used. If not specified, the built-in default is used:	985	be used. If not specified, the built-in default is used:
928		986
929	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	987	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
930		988
931	=item B<preeditType:> I<style>	989	=item B<preeditType:> I<style>
932		990
933	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	991	B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
934		992
935	=item B<inputMethod:> I<name>	993	=item B<inputMethod:> I<name>
936		994
937	I<name> of inputMethod to use; option B<-im>.	995	I<name> of inputMethod to use; option B<-im>.
938		996
…		…
988		1046
989	Turn on/off secondary screen (default enabled).	1047	Turn on/off secondary screen (default enabled).
990		1048
991	=item B<secondaryScroll:> I<boolean>	1049	=item B<secondaryScroll:> I<boolean>
992		1050
993	Turn on/off secondary screen scroll (default enabled). If the this	1051	Turn on/off secondary screen scroll (default enabled). If this
994	option is enabled, scrolls on the secondary screen will change the	1052	option is enabled, scrolls on the secondary screen will change the
995	scrollback buffer and switching to/from the secondary screen will	1053	scrollback buffer and, when secondaryScreen is off, switching
996	instead scroll the screen up.	1054	to/from the secondary screen will instead scroll the screen up.
997		1055
998	=item B<hold>: I<boolean>	1056	=item B<hold>: I<boolean>
999		1057
1000	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1058	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1001	will not immediately destroy its window when the program executed within	1059	will not immediately destroy its window when the program executed within
1002	it exits. Instead, it will wait till it is being killed or closed by the	1060	it exits. Instead, it will wait till it is being killed or closed by the
1003	user.	1061	user.
1004		1062
		1063	=item B<chdir>: I<path>
		1064
		1065	Sets the working directory for the shell (or the command specified via
		1066	B<-e>). The I<path> must be an absolute path and it must exist for
		1067	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1068	directory will be used; option B<-cd>.
		1069
1005	=item B<keysym.>I<sym>: I<string>	1070	=item B<keysym.>I<sym>: I<action>
1006		1071
1007	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1072	Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1008	intervening resource name B<keysym.> cannot be omitted.	1073	resource name B<keysym.> cannot be omitted.
1009		1074
1010	The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be	1075	Using this resource, you can map key combinations such as
1011	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,	1076	C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1012	B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,	1077	string than would normally result from that combination, making the
1013	and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,	1078	terminal scroll up or down the way you want it, or any other thing an
1014	B<2>, B<3>, B<4>, B<5>.	1079	extension might provide.
		1080
		1081	The key combination that triggers the action, I<sym>, has the following format:
		1082
		1083	(modifiers-)key
		1084
		1085	Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>,
		1086	B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>,
		1087	B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>,
		1088	B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>.
1015		1089
1016	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to	1090	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1017	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr	1091	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1018	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the	1092	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1019	current application keymap mode state.	1093	current application keymap mode state.
1020		1094
1021	The spellings of I<key> can be obtained by using B<xev>(1) command or	1095	Due the the large number of modifier combinations, a key mapping will
1022	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1096	match if I<at least> the specified identifiers are being set, and no other
		1097	key mappings with those and more bits are being defined. That means that
		1098	defining a mapping for C<a> will automatically provide definitions for
		1099	C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
		1100	themselves. See the C<builtin:> action, below, for a way to work around
		1101	this when this is a problem.
		1102
		1103	The spelling of I<key> depends on your implementation of X. An easy way to
		1104	find a key name is to use the B<xev>(1) command. You can find a list by
		1105	looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit
1023	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1106	the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym
1024	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1107	value (B<0x0000 - 0xFFFF>).
1025	performed in an exact manner; however, the closest match is assured.
1026		1108
1027	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1109	As with any resource value, the I<action> string may contain backslash
1028	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1110	escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1029	C<\000>: octal number) or verbatim control characters (C<^?>: delete,	1111	number), see RESOURCES in C<man 7 X> for further details.
1030	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1031	can start or end with whitespace. B<This feature is deprecated and will
1032	be removed>.
1033		1112
1034	Please note that you need to double the C<\> in resource files, as	1113	An action starts with an action prefix that selects a certain type
1035	Xlib itself does its own de-escaping (you can use C<\033> instead of	1114	of action, followed by a colon. An action string without colons is
1036	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own	1115	interpreted as a literal string to pass to the tty (as if it was
1037	processing).	1116	prefixed with C<string:>).
1038		1117
1039	You can define a range of keysyms in one shot by providing a I<string>	1118	The following action prefixes are known - extensions can provide
1040	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1119	additional prefixes:
		1120
		1121	=over 4
		1122
		1123	=item string:STRING
		1124
		1125	If the I<action> starts with C<string:> (or otherwise contains no colons),
		1126	then the remaining C<STRING> will be passed to the program running in the
		1127	terminal. For example, you could replace whatever Shift-Tab outputs by the
		1128	string C<echo rm -rf /> followed by a newline:
		1129
		1130	URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
		1131
		1132	This could in theory be used to completely redefine your keymap.
		1133
		1134	In addition, for actions of this type, you can define a range of
		1135	keysyms in one shot by loading the C<keysym-list> perl extension and
		1136	providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
1041	should be a character not used by the strings.	1137	the delimiter `/' should be a character not used by the strings.
1042		1138
1043	Its usage can be demonstrated by an example:	1139	Its usage can be demonstrated by an example:
1044		1140
1045	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1141	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1046		1142
1047	The above line is equivalent to the following three lines:	1143	The above line is equivalent to the following three lines:
1048		1144
1049	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1145	URxvt.keysym.Meta-Control-0x61: string:\033<a>
1050	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1146	URxvt.keysym.Meta-Control-0x62: string:\033<b>
1051	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1147	URxvt.keysym.Meta-Control-0x63: string:\033<c>
1052		1148
		1149	=item command:STRING
		1150
1053	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1151	If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1054	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1152	is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
		1153	the opposite of C<string:> - instead of sending it to the program running
		1154	in the terminal, it will be treated as if it were program output). This is
		1155	most useful to feed command sequences into @@RXVT_NAME@@.
		1156
1055	example the following means "change the current locale to C<zh_CN.GBK>	1157	For example the following means "change the current locale to C<zh_CN.GBK>
1056	when Control-Meta-c is being pressed":	1158	when Control-Meta-c is being pressed":
1057		1159
1058	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1160	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1059		1161
1060	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1162	The following example will map Control-Meta-1 and Control-Meta-2 to
1061	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)	1163	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1062	manpage. For example, the F<selection> extension (activated via	1164	font-switching at runtime:
1063	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1064		1165
1065	URxvt.keysym.M-C-c: perl:selection:rot13	1166	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
		1167	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1066		1168
1067	Due the the large number of modifier combinations, a defined key mapping	1169	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1068	will match if at I<at least> the specified identifiers are being set, and	1170	info):
1069	no other key mappings with those and more bits are being defined. That
1070	means that defining a key map for C<a> will automatically provide
1071	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1072	mappings themselves.
1073		1171
1074	Unfortunately, this will override built-in key mappings. For example	1172	URxvt.keysym.M-C-3: command:\033[8;25;80t
		1173	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1174
		1175	=item builtin:
		1176
		1177	The builtin action is the action that @@RXVT_NAME@@ would execute if no
		1178	key binding existed for the key combination. The obvious use is to undo
		1179	the effect of existing bindings. The not so obvious use is to reinstate
		1180	bindings when another binding overrides too many modifiers.
		1181
1075	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s	1182	For example if you overwrite the C<Insert> key you will disable
1076	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the	1183	@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1077	user-defined keymap using the C<builtin:> replacement:	1184	"holes" into the user-defined keymap using the C<builtin:> replacement:
1078		1185
1079	URxvt.keysym.Insert: <my insert key sequence>	1186	URxvt.keysym.Insert: <my insert key sequence>
1080	URxvt.keysym.S-Insert: builtin:	1187	URxvt.keysym.S-Insert: builtin:
1081		1188
1082	The first line defines a mapping for C<Insert> and I<any> combination	1189	The first line defines a mapping for C<Insert> and I<any> combination
1083	of modifiers. The second line re-establishes the default mapping for	1190	of modifiers. The second line re-establishes the default mapping for
1084	C<Shift-Insert>.	1191	C<Shift-Insert>.
1085		1192
1086	The following example will map Control-Meta-1 and Control-Meta-2 to	1193	=item builtin-string:
1087	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1088	font-switching at runtime:
1089		1194
1090	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007	1195	This action is mainly useful to restore string mappings for keys that
1091	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007	1196	have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
		1197	difficult to explain - basically, this action will send the string to the
		1198	application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
		1199	action for it.
1092		1200
1093	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more	1201	An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1094	info):	1202	selection when you press C<Shift-Insert>. With the following bindings, it
		1203	would instead emit the (undocumented, but what applications running in the
		1204	terminal might expect) sequence C<ESC [ 2 $> instead:
1095		1205
1096	URxvt.keysym.M-C-3: command:\033[8;25;80t	1206	URxvt.keysym.S-Insert: builtin-string:
1097	URxvt.keysym.M-C-4: command:\033[8;48;110t	1207	URxvt.keysym.C-S-Insert: builtin:
		1208
		1209	The first line disables the paste functionality for that key
		1210	combination, and the second reinstates the default behaviour for
		1211	C<Control-Shift-Insert>, which would otherwise be overridden.
		1212
		1213	Similarly, to let applications gain access to the C<C-M-c> (copy to
		1214	clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
		1215	this:
		1216
		1217	URxvt.keysym.C-M-c: builtin-string:
		1218	URxvt.keysym.C-M-v: builtin-string:
		1219
		1220	=item EXTENSION:STRING
		1221
		1222	An action of this form invokes the action B<STRING>, if any, provided
		1223	by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
		1224	be loaded automatically if necessary.
		1225
		1226	Not all extensions define actions, but popular extensions that do
		1227	include the I<selection> and I<matcher> extensions (documented in their
		1228	own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
		1229	respectively).
		1230
		1231	From the silly examples department, this will rot13-"encrypt"
		1232	@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
		1233	keyboards:
		1234
		1235	URxvt.keysym.M-C-c: selection:rot13
		1236
		1237	=item perl:STRING DEPRECATED
		1238
		1239	This is a deprecated way of invoking commands provided by perl
		1240	extensions. It is still supported, but should not be used anymore.
		1241
		1242	=back
1098		1243
1099	=item B<perl-ext-common>: I<string>	1244	=item B<perl-ext-common>: I<string>
1100		1245
1101	=item B<perl-ext>: I<string>	1246	=item B<perl-ext>: I<string>
1102		1247
…		…
1104	use in this terminal instance; option B<-pe>.	1249	use in this terminal instance; option B<-pe>.
1105		1250
1106	Extension names can be prefixed with a C<-> sign to prohibit using	1251	Extension names can be prefixed with a C<-> sign to prohibit using
1107	them. This can be useful to selectively disable some extensions loaded	1252	them. This can be useful to selectively disable some extensions loaded
1108	by default, or specified via the C<perl-ext-common> resource. For	1253	by default, or specified via the C<perl-ext-common> resource. For
1109	example, C<default,-selection> will use all the default extension except	1254	example, C<default,-selection> will use all the default extensions except
1110	C<selection>.	1255	C<selection>.
1111		1256
1112	Extension names can also be followed by an argument in angle brackets	1257	The default set includes the C<selection>, C<option-popup>,
1113	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for	1258	C<selection-popup>, C<readline> and C<searchable-scrollback>
1114	searchable scrollback to Alt/Meta-s). Mentioning the same extension	1259	extensions, and extensions which are mentioned in B<keysym> resources.
1115	multiple times with different arguments will pass multiple arguments to	1260
1116	the extension.	1261	Any extension such that a corresponding resource is given on the
		1262	command line is automatically appended to B<perl-ext>.
1117		1263
1118	Each extension is looked up in the library directories, loaded if	1264	Each extension is looked up in the library directories, loaded if
1119	necessary, and bound to the current terminal instance.	1265	necessary, and bound to the current terminal instance. When the library
		1266	search path contains multiple extension files of the same name, then the
		1267	first one found will be used.
1120		1268
1121	If both of these resources are the empty string, then the perl	1269	If both of these resources are the empty string, then the perl interpreter
1122	interpreter will not be initialized. The idea behind two options is that	1270	will not be initialized. The rationale for having two options is that
1123	B<perl-ext-common> will be used for extensions that should be available to	1271	B<perl-ext-common> will be used for extensions that should be available to
1124	all instances, while B<perl-ext> is used for specific instances.	1272	all instances, while B<perl-ext> is used for specific instances.
1125		1273
1126	=item B<perl-eval>: I<string>	1274	=item B<perl-eval>: I<string>
1127		1275
1128	Perl code to be evaluated when all extensions have been registered. See	1276	Perl code to be evaluated when all extensions have been registered. See
1129	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource	1277	the @@RXVT_NAME@@perl(3) manpage.
1130	will be ignored when running setuid/setgid.
1131		1278
1132	=item B<perl-lib>: I<path>	1279	=item B<perl-lib>: I<path>
1133		1280
1134	Colon-separated list of additional directories that hold extension	1281	Colon-separated list of additional directories that hold extension
1135	scripts. When looking for extensions specified by the C<perl> resource,	1282	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1136	@@RXVT_NAME@@ will first look in these directories and then in	1283	in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1137	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1284	lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1138	will be ignored when running setuid/setgid.
1139		1285
1140	See the @@RXVT_NAME@@perl(3) manpage.	1286	See the @@RXVT_NAME@@perl(3) manpage.
1141		1287
1142	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1288	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1143		1289
…		…
1147	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>	1293	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1148		1294
1149	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage	1295	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1150	for details.	1296	for details.
1151		1297
1152	=item B<searchable-scrollback:> I<keysym>	1298	=item B<searchable-scrollback:> I<keysym> DEPRECATED
1153		1299
1154	Sets the hotkey that starts the incremental scrollback buffer search	1300	This resource is deprecated and will be removed. Use a B<keysym> resource
1155	(default: C<M-s>).	1301	instead, e.g.:
1156		1302
		1303	URxvt.keysym.M-s: searchable-scrollback:start
		1304
1157	=item B<urlLauncher>: I<string>	1305	=item B<url-launcher>: I<string>
1158		1306
1159	Specifies the program to be started with a URL argument. Used by the	1307	Specifies the program to be started with a URL argument. Used by the
1160	C<selection-popup> and C<matcher> perl extensions.	1308	C<selection-popup> and C<matcher> perl extensions.
1161		1309
1162	=item B<transient-for>: I<windowid>	1310	=item B<transient-for>: I<windowid>
…		…
1165		1313
1166	=item B<override-redirect>: I<boolean>	1314	=item B<override-redirect>: I<boolean>
1167		1315
1168	Compile I<frills>: Sets override-redirect for the terminal window, making	1316	Compile I<frills>: Sets override-redirect for the terminal window, making
1169	it almost invisible to window managers; option B<-override-redirect>.	1317	it almost invisible to window managers; option B<-override-redirect>.
		1318
		1319	=item B<iso14755:> I<boolean>
		1320
		1321	Turn on/off ISO 14755 (default enabled).
		1322
		1323	=item B<iso14755_52:> I<boolean>
		1324
		1325	Turn on/off ISO 14755 5.2 mode (default enabled).
		1326
		1327	=back
		1328
		1329	=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
		1330
		1331	=over 4
		1332
		1333	=item B<-pixmap> I<file[;oplist]>
		1334
		1335	=item B<backgroundPixmap:> I<file[;oplist]>
		1336
		1337	Compile I<pixbuf>: Use the specified image file as the window's
		1338	background and also optionally specify a colon separated list of
		1339	operations to modify it. Note that you may need to quote the C<;>
		1340	character when using the command line option, as C<;> is usually a
		1341	metacharacter in shells. Supported operations are:
		1342
		1343	=over 4
		1344
		1345	=item B<WxH+X+Y>
		1346
		1347	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
		1348	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
		1349	scale of 0 disables scaling.
		1350
		1351	=item B<op=tile>
		1352
		1353	enables tiling
		1354
		1355	=item B<op=keep-aspect>
		1356
		1357	maintain the image aspect ratio when scaling
		1358
		1359	=item B<op=root-align>
		1360
		1361	use the position of the terminal window relative to the root window as
		1362	the image offset, simulating a root window background
		1363
		1364	=back
		1365
		1366	The default scale and position setting is C<100x100+50+50>.
		1367	Alternatively, a predefined set of templates can be used to achieve
		1368	the most common setups:
		1369
		1370	=over 4
		1371
		1372	=item B<style=tiled>
		1373
		1374	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
		1375
		1376	=item B<style=aspect-stretched>
		1377
		1378	the image is scaled to fill the whole window maintaining the aspect
		1379	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
		1380
		1381	=item B<style=stretched>
		1382
		1383	the image is scaled to fill the whole window. Equivalent to 100x100
		1384
		1385	=item B<style=centered>
		1386
		1387	the image is centered with no scaling. Equivalent to 0x0+50+50
		1388
		1389	=item B<style=root-tiled>
		1390
		1391	the image is tiled with no scaling and using 'root' positioning.
		1392	Equivalent to 0x0:op=tile:op=root-align
		1393
		1394	=back
		1395
		1396	If multiple templates are specified the last one wins. Note that a
		1397	template overrides all the scale, position and operations settings.
		1398
		1399	If used in conjunction with pseudo-transparency, the specified pixmap
		1400	will be blended over the transparent background using alpha-blending.
		1401
		1402	=item B<-tr>\|B<+tr>
		1403
		1404	=item B<transparent:> I<boolean>
		1405
		1406	Turn on/off pseudo-transparency by using the root pixmap as background.
		1407
		1408	B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
		1409	will be removed in future versions.
		1410
		1411	=item B<-tint> I<colour>
		1412
		1413	=item B<tintColor:> I<colour>
		1414
		1415	Tint the transparent background with the given colour. Note that a
		1416	black tint yields a completely black image while a white tint yields
		1417	the image unchanged.
		1418
		1419	=item B<-sh> I<number>
		1420
		1421	=item B<shading:> I<number>
		1422
		1423	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
		1424	A value of 100 means no shading.
		1425
		1426	=item B<-blr> I<HxV>
		1427
		1428	=item B<blurRadius:> I<HxV>
		1429
		1430	Apply gaussian blur with the specified radius to the transparent
		1431	background. If a single number is specified, the vertical and
		1432	horizontal radii are considered to be the same. Setting one of the
		1433	radii to 1 and the other to a large number creates interesting effects
		1434	on some backgrounds. The maximum radius value is 128. An horizontal or
		1435	vertical radius of 0 disables blurring.
		1436
		1437	=item B<path:> I<path>
		1438
		1439	Specify the colon-delimited search path for finding background image files.
1170		1440
1171	=back	1441	=back
1172		1442
1173	=head1 THE SCROLLBAR	1443	=head1 THE SCROLLBAR
1174		1444
…		…
1193	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>	1463	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1194	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the	1464	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1195	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),	1465	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1196	respectively.	1466	respectively.
1197		1467
1198	=head1 TEXT SELECTION AND INSERTION	1468	=head1 THE SELECTION: SELECTING AND PASTING TEXT
1199		1469
1200	The behaviour of text selection and insertion mechanism is similar to	1470	The behaviour of text selection and insertion/pasting mechanism is similar
1201	I<xterm>(1).	1471	to I<xterm>(1).
1202		1472
1203	=over 4	1473	=over 4
1204		1474
1205	=item B<Selection>:	1475	=item B<Selecting>:
1206		1476
1207	Left click at the beginning of the region, drag to the end of the region	1477	Left click at the beginning of the region, drag to the end of the region
1208	and release; Right click to extend the marked region; Left double-click	1478	and release; Right click to extend the marked region; Left double-click
1209	to select a word; Left triple-click to select the entire logical line	1479	to select a word; Left triple-click to select the entire logical line
1210	(which can span multiple screen lines), unless modified by resource	1480	(which can span multiple screen lines), unless modified by resource
…		…
1214	(Compile: I<frills>) will create a rectangular selection instead of a	1484	(Compile: I<frills>) will create a rectangular selection instead of a
1215	normal one. In this mode, every selected row becomes its own line in the	1485	normal one. In this mode, every selected row becomes its own line in the
1216	selection, and trailing whitespace is visually underlined and removed from	1486	selection, and trailing whitespace is visually underlined and removed from
1217	the selection.	1487	the selection.
1218		1488
1219	=item B<Insertion>:	1489	=item B<Pasting>:
1220		1490
1221	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>	1491	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1222	window causes the value of the PRIMARY selection (or CLIPBOARD with the	1492	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1223	Meta modifier) to be inserted as if it had been typed on the keyboard.	1493	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1224		1494
1225	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be	1495	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1226	inserted too.	1496	inserted too.
1227		1497
		1498	rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
		1499	<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
		1500	binding causes the value of the internal selection to be copied to the
		1501	CLIPBOARD selection, while the second binding causes the value of the
		1502	CLIPBOARD selection to be inserted.
		1503
1228	=back	1504	=back
1229		1505
1230	=head1 CHANGING FONTS	1506	=head1 CHANGING FONTS
1231		1507
1232	Changing fonts (or font sizes, respectively) via the keypad is not yet	1508	Changing fonts (or font sizes, respectively) via the keypad is not yet
…		…
1245		1521
1246	=head1 ISO 14755 SUPPORT	1522	=head1 ISO 14755 SUPPORT
1247		1523
1248	ISO 14755 is a standard for entering and viewing unicode characters	1524	ISO 14755 is a standard for entering and viewing unicode characters
1249	and character codes using the keyboard. It consists of 4 parts. The	1525	and character codes using the keyboard. It consists of 4 parts. The
1250	first part is available rxvt-unicode has been compiled with	1526	first part is available if rxvt-unicode has been compiled with
1251	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1527	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1252	with C<--enable-iso14755>.	1528	with C<--enable-iso14755>.
1253		1529
1254	=over 4	1530	=over 4
1255		1531
…		…
1313	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1589	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1314	it can be seen via the I<who(1)> command, and can accept messages. To	1590	it can be seen via the I<who(1)> command, and can accept messages. To
1315	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root	1591	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1316	on some systems or setgid to root or to some other group on others.	1592	on some systems or setgid to root or to some other group on others.
1317		1593
1318	=head1 COLORS AND GRAPHICS	1594	=head1 COLOURS AND GRAPHICS
1319		1595
1320	In addition to the default foreground and background colours,	1596	In addition to the default foreground and background colours,
1321	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1597	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1322	high-intensity bold/blink versions of the same). Here is a list of the	1598	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1323	colours with their names.	1599	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1600	cube plus a 8 (24) colour greyscale ramp.
		1601
		1602	Here is a list of the ANSI colours with their names.
1324		1603
1325	=begin table	1604	=begin table
1326		1605
1327	B<color0> (black) = Black	1606	B<color0> (black) = Black
1328	B<color1> (red) = Red3	1607	B<color1> (red) = Red3
…		…
1348	It is also possible to specify the colour values of B<foreground>,	1627	It is also possible to specify the colour values of B<foreground>,
1349	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1628	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1350	a number 0-15, as a convenient shorthand to reference the colour name of	1629	a number 0-15, as a convenient shorthand to reference the colour name of
1351	color0-color15.	1630	color0-color15.
1352		1631
1353	In addition to the colours defined above, @@RXVT_NAME@@ offers an	1632	The following text gives values for the standard 88 colour mode (and
1354	additional 72 colours. The first 64 of those (with indices 16 to 79)	1633	values for the 256 colour mode in parentheses).
1355	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
1356	16>), followed by 8 additional shades of gray (with indices 80 to 87).
1357		1634
		1635	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1636
		1637	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1638	index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
		1639
		1640	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1641	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1642	the RGB cube.
		1643
1358	Together, all those colours implement the 88 colour xterm colours. Only	1644	Together, all those colours implement the 88 (256) colour xterm
1359	the first 16 can be changed using resources currently, the rest can only	1645	colours. Only the first 16 can be changed using resources currently, the
1360	be changed via command sequences ("escape codes").	1646	rest can only be changed via command sequences ("escape codes").
		1647
		1648	Applications are advised to use terminfo or command sequences to discover
		1649	number and RGB values of all colours (yes, you can query this...).
1361		1650
1362	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1651	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1363	always swapping the foreground/background colours. This is in contrast to	1652	always swapping the foreground/background colours. This is in contrast to
1364	I<xterm>(1) where the colours are only swapped if they have not otherwise	1653	I<xterm>(1) where the colours are only swapped if they have not otherwise
1365	been specified. For example,	1654	been specified. For example,
1366		1655
1367	=over 4
1368
1369	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1656	@@RXVT_NAME@@ -fg Black -bg White -rv
1370		1657
1371	would yield White on Black, while on I<xterm>(1) it would yield Black	1658	would yield White on Black, while on I<xterm>(1) it would yield Black on
1372	on White.	1659	White.
1373
1374	=back
1375		1660
1376	=head2 ALPHA CHANNEL SUPPORT	1661	=head2 ALPHA CHANNEL SUPPORT
1377		1662
1378	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1663	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1379	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>	1664	their act together, rxvt-unicode will do its own alpha channel management:
1380	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1665
1381	in addition to the ones provided by X, where the additional A component	1666	You can prefix any colour with an opaqueness percentage enclosed in
		1667	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1668	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1669	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1670	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1671	is the recommended format to specify transparency values, and works with
		1672	all ways to specify a colour.
		1673
		1674	For complete control, rxvt-unicode also supports
		1675	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1676	specifications, where the additional C<aaaa> component specifies opacity
1382	specifies opacity (alpha) values. The minimum value of C<0> is completely	1677	(alpha) values. The minimum value of C<0000> is completely transparent,
1383	transparent). You can also prefix any color with C<[percent]>, where	1678	while C<ffff> is completely opaque). The two example colours from
1384	C<percent> is a decimal percentage (0-100) that specifies the opacity of	1679	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1385	the color, where C<0> is completely transparent and C<100> is completelxy	1680	C<rgba:0000/ff00/0000/f332>.
1386	opaque.
1387		1681
1388	You probably need to specify B<"-depth 32">, too, and have the luck that	1682	You probably need to specify B<"-depth 32">, too, to force a visual with
1389	your X-server uses ARGB pixel layout, as X is far from just supporting	1683	alpha channels, and have the luck that your X-server uses ARGB pixel
1390	ARGB visuals out of the box, and rxvt-unicode just fudges around.	1684	layout, as X is far from just supporting ARGB visuals out of the box, and
		1685	rxvt-unicode just fudges around.
1391		1686
1392	For example, the following selects an almost completely transparent red	1687	For example, the following selects an almost completely transparent black
1393	background, and an almost opaque pink foreground:	1688	background, and an almost opaque pink foreground:
1394		1689
1395	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"	1690	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1396		1691
1397	I<Please note that transparency of any kind if completely unsupported by	1692	When not using a background image, then the interpretation of the
1398	the author. Don't bug him with installation questions!>	1693	alpha channel is up to your compositing manager (most interpret it as
		1694	transparency of course).
		1695
		1696	When using a background pixmap or pseudo-transparency, then the background
		1697	colour will always behave as if it were completely transparent (so the
		1698	background image shows instead), regardless of how it was specified, while
		1699	other colours will either be transparent as specified (the background
		1700	image will show through) on servers supporting the RENDER extension, or
		1701	fully opaque on servers not supporting the RENDER EXTENSION.
		1702
		1703	Please note that due to bugs in Xft, specifying alpha values might result
		1704	in garbage being displayed when the X-server does not support the RENDER
		1705	extension.
1399		1706
1400	=head1 ENVIRONMENT	1707	=head1 ENVIRONMENT
1401		1708
1402	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1709	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1403		1710
…		…
1409	resources or on the command line.	1716	resources or on the command line.
1410		1717
1411	=item B<COLORTERM>	1718	=item B<COLORTERM>
1412		1719
1413	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was	1720	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1414	compiled with XPM support, and optionally with the added extension	1721	compiled with background image support, and optionally with the added
1415	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1722	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1723	screen.
1416		1724
1417	=item B<COLORFGBG>	1725	=item B<COLORFGBG>
1418		1726
1419	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1727	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1420	the colour code used as default foreground/text colour (or the string	1728	the colour code used as default foreground/text colour (or the string
1421	C<default> to indicate that the default-colour escape sequence is to be	1729	C<default> to indicate that the default-colour escape sequence is to be
1422	used), C<bg> is the colour code used as default background colour (or the	1730	used), C<bg> is the colour code used as default background colour (or the
1423	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1731	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1424	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can	1732	was compiled with background image support. Libraries like C<ncurses>
1425	(and do) use this information to optimize screen output.	1733	and C<slang> can (and do) use this information to optimize screen output.
1426		1734
1427	=item B<WINDOWID>	1735	=item B<WINDOWID>
1428		1736
1429	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1737	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1430	window, which usually has subwindows for the scrollbar, the terminal	1738	window, which usually has subwindows for the scrollbar, the terminal
…		…
1436	C<--with-terminfo=PATH>.	1744	C<--with-terminfo=PATH>.
1437		1745
1438	=item B<DISPLAY>	1746	=item B<DISPLAY>
1439		1747
1440	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1748	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1441	display in its child processes.	1749	display in its child processes if C<-display> isn't used to override. It
		1750	defaults to C<:0> if it doesn't exist.
1442		1751
1443	=item B<SHELL>	1752	=item B<SHELL>
1444		1753
1445	The shell to be used for command execution, defaults to C</bin/sh>.	1754	The shell to be used for command execution, defaults to C</bin/sh>.
1446		1755
1447	=item B<RXVT_SOCKET>	1756	=item B<RXVT_SOCKET> [I<sic>]
1448		1757
1449	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1758	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1450	@@RXVT_NAME@@d(1).	1759	@@RXVT_NAME@@d(1).
1451		1760
1452	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1761	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
		1762
		1763	=item B<URXVT_PERL_LIB>
		1764
		1765	Additional F<:>-separated library search path for perl extensions. Will be
		1766	searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
		1767	directory.
		1768
		1769	=item B<URXVT_PERL_VERBOSITY>
		1770
		1771	See L<@@RXVT_NAME@@perl>(3).
1453		1772
1454	=item B<HOME>	1773	=item B<HOME>
1455		1774
1456	Used to locate the default directory for the unix domain socket for	1775	Used to locate the default directory for the unix domain socket for
1457	daemon communications and to locate various resource files (such as	1776	daemon communications and to locate various resource files (such as
1458	C<.Xdefaults>)	1777	C<.Xdefaults>)
1459		1778
1460	=item B<XAPPLRESDIR>	1779	=item B<XAPPLRESDIR>
1461		1780
1462	Directory where various X resource files are being located.	1781	Directory where application-specific X resource files are located.
1463		1782
1464	=item B<XENVIRONMENT>	1783	=item B<XENVIRONMENT>
1465		1784
1466	If set and accessible, gives the name of a X resource file to be loaded by	1785	If set and accessible, gives the name of a X resource file to be loaded by
1467	@@RXVT_NAME@@.	1786	@@RXVT_NAME@@.
…		…
1472		1791
1473	=over 4	1792	=over 4
1474		1793
1475	=item B</usr/lib/X11/rgb.txt>	1794	=item B</usr/lib/X11/rgb.txt>
1476		1795
1477	Color names.	1796	Colour names.
1478		1797
1479	=back	1798	=back
1480		1799
1481	=head1 SEE ALSO	1800	=head1 SEE ALSO
1482		1801
		1802	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1483	@@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)	1803	@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1484		1804
1485	=head1 CURRENT PROJECT COORDINATOR	1805	=head1 CURRENT PROJECT COORDINATOR
1486		1806
1487	=over 4	1807	=over 4
1488		1808
1489	=item Project Coordinator	1809	=item Project Coordinator
1490		1810
1491	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1811	Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1492		1812
1493	L<http://software.schmorp.de/pkg/rxvt-unicode.html>	1813	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1494		1814
1495	=back	1815	=back
1496		1816
…		…
1500		1820
1501	=item John Bovey	1821	=item John Bovey
1502		1822
1503	University of Kent, 1992, wrote the original Xvt.	1823	University of Kent, 1992, wrote the original Xvt.
1504		1824
1505	=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >>	1825	=item Rob Nation <nation@rocket.sanders.lockheed.com>
1506		1826
1507	very heavily modified Xvt and came up with Rxvt	1827	very heavily modified Xvt and came up with Rxvt
1508		1828
1509	=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >>	1829	=item Angelo Haritsis <ah@doc.ic.ac.uk>
1510		1830
1511	wrote the Greek Keyboard Input (no longer in code)	1831	wrote the Greek Keyboard Input (no longer in code)
1512		1832
1513	=item mj olesen L<< <olesen@me.QueensU.CA> >>	1833	=item mj olesen <olesen@me.QueensU.CA>
1514		1834
1515	Wrote the menu system.	1835	Wrote the menu system.
1516		1836
1517	Project Coordinator (changes.txt 2.11 to 2.21)	1837	Project Coordinator (changes.txt 2.11 to 2.21)
1518		1838
1519	=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >>	1839	=item Oezguer Kesim <kesim@math.fu-berlin.de>
1520		1840
1521	Project Coordinator (changes.txt 2.21a to 2.4.5)	1841	Project Coordinator (changes.txt 2.21a to 2.4.5)
1522		1842
1523	=item Geoff Wing L<< <gcw@pobox.com> >>	1843	=item Geoff Wing <gcw@pobox.com>
1524		1844
1525	Rewrote screen display and text selection routines.	1845	Rewrote screen display and text selection routines.
1526		1846
1527	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1847	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1528		1848
1529	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1849	=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1530		1850
1531	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1851	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1532	extension, random hacks, numerous bugfixes and extensions.	1852	extension, random hacks, numerous bugfixes and extensions.
1533		1853
1534	Project Coordinator (Changes 1.0 -)	1854	Project Coordinator (Changes 1.0 -)
1535		1855
1536	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1856	=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1537		1857
1538	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.	1858	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1539		1859
1540	=back	1860	=back
1541		1861

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.125 by root, Fri Jan 19 23:45:03 2007 UTC vs. Revision 1.244 by sf-exg, Tue Jun 16 11:58:26 2015 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.125 by root, Fri Jan 19 23:45:03 2007 UTC vs.
Revision 1.244 by sf-exg, Tue Jun 16 11:58:26 2015 UTC