ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/rxvt-unicode/doc/rxvt.1.pod

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

Diff Legend

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