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.2 by root, Thu Aug 12 21:30:14 2004 UTC vs.
Revision 1.152 by root, Wed Dec 12 19:56:37 2007 UTC

…		…
6		6
7	B<@@RXVT_NAME@@> [options] [-e command [ args ]]	7	B<@@RXVT_NAME@@> [options] [-e command [ args ]]
8		8
9	=head1 DESCRIPTION	9	=head1 DESCRIPTION
10		10
11	B<rxvt-unicode>, version B<@@RXVTVERSION@@>, is a colour vt102 terminal	11	B<rxvt-unicode>, version B<@@RXVT_VERSION@@>, is a colour vt102 terminal
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	See also @@RXVT_NAME@@(7) for technical reference documentation (escape	17	=head1 FREQUENTLY ASKED QUESTIONS
18	sequences etc.).	18
		19	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
		21	problems. That document is also accessible on the World-Wide-Web at
		22	L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
		23
		24	=head1 RXVT-UNICODE VS. RXVT
		25
		26	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
		28	world. Being a terminal emulator, however, some things are very difficult,
		29	especially cursive scripts such as arabic, vertically written scripts
		30	like mongolian or scripts requiring extremely complex combining rules,
		31	like tibetan or devanagari. Don't expect pretty output when using these
		32	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
		33	fine, though. A somewhat difficult case are right-to-left scripts, such
		34	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
		35	belong in the application, not the terminal emulator (too many things --
		36	such as cursor-movement while editing -- break otherwise), but that might
		37	change.
		38
		39	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
		41	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
		43	another for japanese.
		44
		45	Therefore another design rationale was the use of multiple fonts to
		46	display characters: The idea of a single unicode font which many other
		47	programs force onto its users never made sense to me: You should be able
		48	to choose any font for any script freely.
		49
		50	Apart from that, rxvt-unicode is also much better internationalised than
		51	its predecessor, supports things such as XFT and ISO 14755 that are handy
		52	in i18n-environments, is faster, and has a lot bugs less than the original
		53	rxvt. This all in addition to dozens of other small improvements.
		54
		55	It is still faithfully following the original rxvt idea of being lean
		56	and nice on resources: for example, you can still configure rxvt-unicode
		57	without most of its features to get a lean binary. It also comes with
		58	a client/daemon pair that lets you open any number of terminal windows
		59	from within a single process, which makes startup time very fast and
		60	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
		61	@@RXVT_NAME@@c(1) (client).
		62
		63	It also makes technical information about escape sequences (which have
		64	been extended) more accessible: see @@RXVT_NAME@@(7) for technical
		65	reference documentation (escape sequences etc.).
19		66
20	=head1 OPTIONS	67	=head1 OPTIONS
21		68
22	The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed	69	The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed
23	below. In keeping with the smaller-is-better philosophy, options may be	70	below. In keeping with the smaller-is-better philosophy, options may be
24	eliminated or default values chosen at compile-time, so options and	71	eliminated or default values chosen at compile-time, so options and
25	defaults listed may not accurately reflect the version installed on	72	defaults listed may not accurately reflect the version installed on
26	your system. `rxvt -h' gives a list of major compile-time options on	73	your system. `@@RXVT_NAME@@ -h' gives a list of major compile-time options on
27	the I<Options> line. Option descriptions may be prefixed with which	74	the I<Options> line. Option descriptions may be prefixed with which
28	compile option each is dependent upon. e.g. `Compile I<XIM>:' requires	75	compile option each is dependent upon. e.g. `Compile I<XIM>:' requires
29	I<XIM> on the I<Options> line. Note: `rxvt -help' gives a list of all	76	I<XIM> on the I<Options> line. Note: `@@RXVT_NAME@@ -help' gives a list of all
30	command-line options compiled into your version.	77	command-line options compiled into your version.
31		78
32	Note that B<@@RXVT_NAME@@> permits the resource name to be used as a	79	Note that B<@@RXVT_NAME@@> permits the resource name to be used as a
33	long-option (--/++ option) so the potential command-line options are	80	long-option (--/++ option) so the potential command-line options are
34	far greater than those listed. For example: `rxvt --loginShell --color1	81	far greater than those listed. For example: `@@RXVT_NAME@@ --loginShell --color1
35	Orange'.	82	Orange'.
36		83
37	The following options are available:	84	The following options are available:
38		85
39	=over 4	86	=over 4
…		…
46		93
47	Attempt to open a window on the named X display (B<-d> still	94	Attempt to open a window on the named X display (B<-d> still
48	respected). In the absence of this option, the display specified by the	95	respected). In the absence of this option, the display specified by the
49	B<DISPLAY> environment variable is used.	96	B<DISPLAY> environment variable is used.
50		97
		98	=item B<-depth> I<bitdepth>
		99
		100	Compile I<xft>: Attempt to find a visual with the given bit depth;
		101	resource B<depth>.
		102
51	=item B<-geometry> I<geom>	103	=item B<-geometry> I<geom>
52		104
53	Window geometry (B<-g> still respected); resource B<geometry>.	105	Window geometry (B<-g> still respected); resource B<geometry>.
54		106
55	=item B<-rv>|B<+rv>	107	=item B<-rv>|B<+rv>
56		108
57	Turn on/off simulated reverse video; resource B<reverseVideo>.	109	Turn on/off simulated reverse video; resource B<reverseVideo>.
58		110
59	=item B<-j>|B<+j>	111	=item B<-j>|B<+j>
60		112
61	Turn on/off jump scrolling; resource B<jumpScroll>.	113	Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
62		114
63	=item B<-ip>|B<+ip>	115	=item B<-ss>|B<+ss>
64		116
65	Turn on/off inheriting parent window's pixmap. Alternative form is	117	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
66	B<-tr>; resource B<inheritPixmap>.	118
		119	=item B<-tr>|B<+tr>
		120
		121	Turn on/off illusion of a transparent window background; resource B<transparent>.
		122
		123	B<-ip> is still accepted as an obsolete alias but will be removed in
		124	future versions.
		125
		126	I<Please address all transparency related issues to Sasha Vasko at
		127	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
67		128
68	=item B<-fade> I<number>	129	=item B<-fade> I<number>
69		130
70	Fade the text by the given percentage when focus is lost.	131	Fade the text by the given percentage when focus is lost. Small values
		132	fade a little only, 100 completely replaces all colours by the fade
		133	colour; resource B<fading>.
		134
		135	=item B<-fadecolor> I<colour>
		136
		137	Fade to this colour when fading is used (see B<-fade>). The default colour
		138	is opaque black. resource B<fadeColor>.
71		139
72	=item B<-tint> I<colour>	140	=item B<-tint> I<colour>
73		141
74	Tint the transparent background pixmap with the given colour when	142	Tint the transparent background pixmap with the given colour when
75	transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh>	143	transparency is enabled with B<-tr>. This only works for
		144	non-tiled backgrounds, currently. See also the B<-sh> option that can be
76	option that can be used to brighten or darken the image in addition to	145	used to brighten or darken the image in addition to tinting it.
77	tinting it.	146	Please note that certain tint colours can be applied on the server-side,
		147	thus yielding performance gain of two orders of magnitude. These colours are:
		148	blue, red, green, cyan, magenta, yellow, and those close to them. Also
		149	pure black and pure white colors essentially mean no tinting; resource
		150	I<tintColor>. Example:
78		151
79	=item B<-sh>	152	@@RXVT_NAME@@ -tr -tint blue -sh 40
80		153
		154	=item B<-sh> I<number>
		155
81	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	156	Darken (0 .. 100) or lighten (100 .. 200) the transparent
82	background image in addition to tinting it (i.e. B<-tint> must be	157	background image in addition to (or instead of) tinting it;
83	specified, too).	158	resource I<shading>.
		159
		160	=item B<-blt> I<string>
		161
		162	Specify background blending type. If background pixmap is specified
		163	at the same time as transparency - such pixmap will be blended over
		164	transparency image, using method specified. Supported values are :
		165	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
		166	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
		167	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
		168	alpha-blending. Compile I<afterimage>; resource I<blendType>.
		169
		170	=item B<-blr> I<HxV>
		171
		172	Apply Gaussian Blur with the specified radii to the transparent
		173	background image. If single number is specified - both vertical and
		174	horizontal radii are considered to be the same. Setting one of the
		175	radii to 1 and another to a large number creates interesting effects
		176	on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
		177	resource I<blurRadius>.
84		178
85	=item B<-bg> I<colour>	179	=item B<-bg> I<colour>
86		180
87	Window background colour; resource B<background>.	181	Window background colour; resource B<background>.
88		182
89	=item B<-fg> I<colour>	183	=item B<-fg> I<colour>
90		184
91	Window foreground colour; resource B<foreground>.	185	Window foreground colour; resource B<foreground>.
92		186
93	=item B<-pixmap> I<file[;geom]>	187	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
94		188
95	Compile I<XPM>: Specify XPM file for the background and also optionally	189	Compile I<afterimage>: Specify image file for the background and also
96	specify its scaling with a geometry string. Note you may need to add	190	optionally specify its scaling with a geometry string. Note you may need to
97	quotes to avoid special shell interpretation of the `;' in the	191	add quotes to avoid special shell interpretation of the C<;> in the
98	command-line; resource B<backgroundPixmap>.	192	command-line; for more details see resource B<backgroundPixmap>.
99		193
100	=item B<-cr> I<colour>	194	=item B<-cr> I<colour>
101		195
102	The cursor colour; resource B<cursorColor>.	196	The cursor colour; resource B<cursorColor>.
103		197
…		…
109		203
110	The mouse pointer background colour; resource B<pointerColor2>.	204	The mouse pointer background colour; resource B<pointerColor2>.
111		205
112	=item B<-bd> I<colour>	206	=item B<-bd> I<colour>
113		207
114	The colour of the border between the xterm scrollbar and the text;	208	The colour of the border around the text area and between the scrollbar and the text;
115	resource B<borderColor>.	209	resource B<borderColor>.
116		210
117	=item B<-fn> I<fontname>	211	=item B<-fn> I<fontlist>
118		212
119	Select the fonts to be used. This is a comma seperated list of font	213	Select the fonts to be used. This is a comma separated list of font names
120	names that are used in turn when trying to display Unicode characters.	214	that are checked in order when trying to find glyphs for characters. The
121	The first font defines the cell size for characters; other fonts might	215	first font defines the cell size for characters; other fonts might be
122	be smaller, but not larger. A reasonable default font list is always	216	smaller, but not (in general) larger. A (hopefully) reasonable default
123	appended to it. resource B<font>.	217	font list is always appended to it. See resource B<font> for more details.
124		218
		219	In short, to specify an X11 core font, just specify its name or prefix it
		220	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
		221	e.g.:
		222
		223	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
		224	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
		225
		226	See also the question "How does rxvt-unicode choose fonts?" in the FAQ
		227	section of @@RXVT_NAME@@(7).
		228
		229	=item B<-fb> I<fontlist>
		230
		231	Compile I<font-styles>: The bold font list to use when B<bold> characters
		232	are to be printed. See resource B<boldFont> for details.
		233
		234	=item B<-fi> I<fontlist>
		235
		236	Compile I<font-styles>: The italic font list to use when I<italic>
		237	characters are to be printed. See resource B<italicFont> for details.
		238
		239	=item B<-fbi> I<fontlist>
		240
		241	Compile I<font-styles>: The bold italic font list to use when B<< I<bold
		242	italic> >> characters are to be printed. See resource B<boldItalicFont>
		243	for details.
		244
125	=item B<-rb>|B<+rb>	245	=item B<-is>|B<+is>
126		246
127	Enable "real bold" support. When this option is on, bold text will be	247	Compile I<font-styles>: Bold/Italic font styles imply high intensity
128	displayed using the first available bold font in the font list. Bold	248	foreground/background (default). See resource B<intensityStyles> for
129	fonts should thus be specified in the font list after their	249	details.
130	corresponding regular fonts. If no bold font can be found, a regular
131	font will be used. resource B<realBold>.
132		250
133	=item B<-name> I<name>	251	=item B<-name> I<name>
134		252
135	Specify the application name under which resources are to be obtained,	253	Specify the application name under which resources are to be obtained,
136	rather than the default executable file name. Name should not contain	254	rather than the default executable file name. Name should not contain
…		…
174		292
175	Put scrollbar on right/left; resource B<scrollBar_right>.	293	Put scrollbar on right/left; resource B<scrollBar_right>.
176		294
177	=item B<-st>|B<+st>	295	=item B<-st>|B<+st>
178		296
179	Display normal (non XTerm/NeXT) scrollbar without/with a trough;	297	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
180	resource B<scrollBar_floating>.	298	resource B<scrollBar_floating>.
		299
		300	=item B<-ptab>|B<+ptab>
		301
		302	If enabled (default), "Horizontal Tab" characters are being stored as
		303	actual wide characters in the screen buffer, which makes it possible to
		304	select and paste them. Since a horizontal tab is a cursor movement and
		305	not an actual glyph, this can sometimes be visually annoying as the cursor
		306	on a tab character is displayed as a wide cursor; resource B<pastableTabs>.
181		307
182	=item B<-bc>|B<+bc>	308	=item B<-bc>|B<+bc>
183		309
184	Blink the cursor; resource B<cursorBlink>.	310	Blink the cursor; resource B<cursorBlink>.
185		311
…		…
205	B<externalBorder>.	331	B<externalBorder>.
206		332
207	=item B<-bl>	333	=item B<-bl>
208		334
209	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	335	Compile I<frills>: Set MWM hints to request a borderless window, i.e.
210	if honoured by the WM, the rxvt window will not have window	336	if honoured by the WM, the rxvt-unicode window will not have window
211	decorations; resource B<borderLess>.	337	decorations; resource B<borderLess>.
212		338
		339	=item B<-override-redirect>
		340
		341	Compile I<frills>: Sets override-redirect on the window; resource
		342	B<override-redirect>.
		343
		344	=item B<-sbg>
		345
		346	Compile I<frills>: Disable the usage of the built-in block graphics/line
		347	drawing characters and just rely on what the specified fonts provide. Use
		348	this if you have a good font and want to use its block graphic glyphs;
		349	resource B<skipBuiltinGlyphs>.
		350
213	=item B<-lsp> I<number>	351	=item B<-lsp> I<number>
214		352
215	Compile I<linespace>: Lines (pixel height) to insert between each row	353	Compile I<frills>: Lines (pixel height) to insert between each row of
216	of the display; resource B<linespace>.	354	the display. Useful to work around font rendering problems; resource
		355	B<lineSpace>.
217		356
218	=item B<-tn> I<termname>	357	=item B<-tn> I<termname>
219		358
220	This option specifies the name of the terminal type to be set in the	359	This option specifies the name of the terminal type to be set in the
221	B<TERM> environment variable. This terminal type must exist in the	360	B<TERM> environment variable. This terminal type must exist in the
…		…
230	given on the command line. If this option is used, it must be the last	369	given on the command line. If this option is used, it must be the last
231	on the command-line. If there is no B<-e> option then the default is to	370	on the command-line. If there is no B<-e> option then the default is to
232	run the program specified by the B<SHELL> environment variable or,	371	run the program specified by the B<SHELL> environment variable or,
233	failing that, I<sh(1)>.	372	failing that, I<sh(1)>.
234		373
		374	Please note that you must specify a program with arguments. If you want to
		375	run shell commands, you have to specify the shell, like this:
		376
		377	@@RXVT_NAME@@ -e sh -c "shell commands"
		378
235	=item B<-title> I<text>	379	=item B<-title> I<text>
236		380
237	Window title (B<-T> still respected); the default title is the basename	381	Window title (B<-T> still respected); the default title is the basename
238	of the program specified after the B<-e> option, if any, otherwise the	382	of the program specified after the B<-e> option, if any, otherwise the
239	application name; resource B<title>.	383	application name; resource B<title>.
…		…
257		401
258	Compile I<XIM>: input method name. resource B<inputMethod>.	402	Compile I<XIM>: input method name. resource B<inputMethod>.
259		403
260	=item B<-imlocale> I<string>	404	=item B<-imlocale> I<string>
261		405
262	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.	406	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
263	de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input	407	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
264	extension to be able to input japanese characters while staying in	408	input extension to be able to input japanese characters while staying in
265	another locale.	409	another locale. resource B<imLocale>.
		410
		411	=item B<-imfont> I<fontset>
		412
		413	Set the font set to use for the X Input Method, see resource B<imFont>
		414	for more info.
		415
		416	=item B<-tcw>
		417
		418	Change the meaning of triple-click selection with the left mouse
		419	button. Only effective when the original (non-perl) selection code is
		420	in-use. Instead of selecting a full line it will extend the selection to
		421	the end of the logical line only. resource B<tripleclickwords>.
266		422
267	=item B<-insecure>	423	=item B<-insecure>
268		424
269	Enable "insecure" mode, which currently enables most of the escape	425	Enable "insecure" mode, which currently enables most of the escape
270	sequences that echo strings. See the resource B<insecure> for more	426	sequences that echo strings. See the resource B<insecure> for more
…		…
284	=item B<-ssr>|B<+ssr>	440	=item B<-ssr>|B<+ssr>
285		441
286	Turn on/off secondary screen scroll (default enabled); resource	442	Turn on/off secondary screen scroll (default enabled); resource
287	B<secondaryScroll>.	443	B<secondaryScroll>.
288		444
		445	=item B<-hold>|B<+hold>
		446
		447	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		448	will not immediately destroy its window when the program executed within
		449	it exits. Instead, it will wait till it is being killed or closed by the
		450	user; resource B<hold>.
		451
289	=item B<-xrm> I<resourcestring>	452	=item B<-xrm> I<string>
290		453
291	No effect on rxvt. Simply passes through an argument to be made	454	Works like the X Toolkit option of the same name, by adding the I<string>
292	available in the instance's argument list. Appears in I<WM_COMMAND> in	455	as if it were specified in a resource file. Resource values specified this
293	some window managers.	456	way take precedence over all other resource specifications.
		457
		458	Note that you need to use the I<same> syntax as in the .Xdefaults file,
		459	e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
		460	options can be specified as long-options on the commandline, so use
		461	of B<-xrm> is mostly limited to cases where you want to specify other
		462	resources (e.g. for input methods) or for compatibility with other
		463	programs.
		464
		465	=item B<-keysym.>I<sym> I<string>
		466
		467	Remap a key symbol. See resource B<keysym>.
		468
		469	=item B<-embed> I<windowid>
		470
		471	Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
		472	which enables applications to easily embed a terminal.
		473
		474	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
		475	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
		476	quite a bit, so don't expect it to keep some specific state. It's best to
		477	create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
		478
		479	The window will not be destroyed when @@RXVT_NAME@@ exits.
		480
		481	It might be useful to know that @@RXVT_NAME@@ will not close file
		482	descriptors passed to it (except for stdin/out/err, of course), so you
		483	can use file descriptors to communicate with the programs within the
		484	terminal. This works regardless of whether the C<-embed> option was used or
		485	not.
		486
		487	Here is a short Gtk2-perl snippet that illustrates how this option can be
		488	used (a longer example is in F<doc/embed>):
		489
		490	my $rxvt = new Gtk2::Socket;
		491	$rxvt->signal_connect_after (realize => sub {
		492	my $xid = $_[0]->window->get_xid;
		493	system "@@RXVT_NAME@@ -embed $xid &";
		494	});
		495
		496	=item B<-pty-fd> I<file descriptor>
		497
		498	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
		499	pair but instead use the given file descriptor as the tty master. This is
		500	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
		501	without having to run a program within it.
		502
		503	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
		504	entries and will not tinker with pty/tty permissions - you have to do that
		505	yourself if you want that.
		506
		507	As an extremely special case, specifying C<-1> will completely suppress
		508	pty/tty operations, which is probably only useful in conjunction with some
		509	perl extension that manages the terminal.
		510
		511	Here is a example in perl that illustrates how this option can be used (a
		512	longer example is in F<doc/pty-fd>):
		513
		514	use IO::Pty;
		515	use Fcntl;
		516
		517	my $pty = new IO::Pty;
		518	fcntl $pty, F_SETFD, 0; # clear close-on-exec
		519	system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
		520	close $pty;
		521
		522	# now communicate with rxvt
		523	my $slave = $pty->slave;
		524	while (<$slave>) { print $slave "got <$_>\n" }
		525
		526	=item B<-pe> I<string>
		527
		528	Comma-separated list of perl extension scripts to use (or not to use) in
		529	this terminal instance. See resource B<perl-ext> for details.
294		530
295	=back	531	=back
296		532
297	=head1 RESOURCES (available also as long-options)	533	=head1 RESOURCES
298		534
299	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	535	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
300	options) compiled into your version.	536	options) compiled into your version. All resources are also available as
		537	long-options.
301		538
302	There are two different methods that @@RXVT_NAME@@ can use to get the	539	You can set and change the resources using X11 tools like B<xrdb>. Many
303	Xresource data: using the X libraries (Xrm*-functions) or internal	540	distribution do also load settings from the B<~/.Xresources> file when X
304	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	541	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
305	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	542	with later settings overwriting earlier ones:
306	resources using X11 tools like B<xset>. Many distribution do also load
307	settings from the B<~/.Xresources> file when X starts.
308		543
309	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>	544	1. system-wide app-defaults file, either locale-dependent OR global
310	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults	545	2. app-defaults file in $XAPPLRESDIR
311	set in XAPPLOADDIR/URxvt (compile-time defined: usually	546	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
312	B</usr/lib/X11/app-defaults/URxvt>) and resources set in	547	4. SCREEN_RESOURCES for the current screen
313	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.	548	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		549	6. resources specified via -xrm on the commandline
		550
314	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two	551	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
315	class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows	552	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
316	resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be	553	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
317	easily configured, while the class name B<URxvt> allows resources	554	configured, while the class name B<URxvt> allows resources unique to
318	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be	555	B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
319	shared between different B<@@RXVT_NAME@@> configurations. If no	556	configurations. If no resources are specified, suitable defaults will
320	resources are specified, suitable defaults will be used. Command-line	557	be used. Command-line arguments can be used to override resource
321	arguments can be used to override resource settings. The following	558	settings. The following resources are supported (you might want to
322	resources are allowed:	559	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
		560	extensions not documented here):
323		561
324	=over 4	562	=over 4
		563
		564	=item B<depth:> I<bitdepth>
		565
		566	Compile I<xft>: Attempt to find a visual with the given bit depth;
		567	option B<-depth>.
325		568
326	=item B<geometry:> I<geom>	569	=item B<geometry:> I<geom>
327		570
328	Create the window with the specified X window geometry [default 80x24];	571	Create the window with the specified X window geometry [default 80x24];
329	option B<-geometry>.	572	option B<-geometry>.
…		…
345	high-intensity (bold = bright foreground, blink = bright background)	588	high-intensity (bold = bright foreground, blink = bright background)
346	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	589	colours. The canonical names are as follows: 0=black, 1=red, 2=green,
347	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour	590	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
348	names used are listed in the B<COLORS AND GRAPHICS> section.	591	names used are listed in the B<COLORS AND GRAPHICS> section.
349		592
		593	Colours higher than 15 cannot be set using resources (yet), but can be
		594	changed using an escape command (see @@RXVT_NAME@@(7)).
		595
		596	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
		597	88 colour support). Colours 80-87 are evenly spaces grey steps.
		598
350	=item B<colorBD:> I<colour>	599	=item B<colorBD:> I<colour>
351		600
		601	=item B<colorIT:> I<colour>
		602
352	Use the specified colour to display bold characters when the foreground	603	Use the specified colour to display bold or italic characters when the
353	colour is the default. This option will be ignored if B<realBold> is	604	foreground colour is the default. If font styles are not available
354	enabled.	605	(Compile I<styles>) and this option is unset, reverse video is used instead.
355		606
356	=item B<colorUL:> I<colour>	607	=item B<colorUL:> I<colour>
357		608
358	Use the specified colour to display underlined characters when the	609	Use the specified colour to display underlined characters when the
359	foreground colour is the default.	610	foreground colour is the default.
360		611
361	=item B<colorRV:> I<colour>	612	=item B<colorRV:> I<colour>
362		613
363	Use the specified colour as the background for reverse video	614	Use the specified colour as the background for reverse video characters
364	characters.	615	when OPTION_HC is disabled (--disable-frills).
		616
		617	=item B<underlineColor:> I<colour>
		618
		619	If set, use the specified colour as the colour for the underline
		620	itself. If unset, use the foreground colour.
365		621
366	=item B<cursorColor:> I<colour>	622	=item B<cursorColor:> I<colour>
367		623
368	Use the specified colour for the cursor. The default is to use the	624	Use the specified colour for the cursor. The default is to use the
369	foreground colour; option B<-cr>.	625	foreground colour; option B<-cr>.
…		…
380	option B<-rv>. B<False>: regular screen colours [default]; option	636	option B<-rv>. B<False>: regular screen colours [default]; option
381	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	637	B<+rv>. See note in B<COLORS AND GRAPHICS> section.
382		638
383	=item B<jumpScroll:> I<boolean>	639	=item B<jumpScroll:> I<boolean>
384		640
385	B<True>: specify that jump scrolling should be used. When scrolling	641	B<True>: specify that jump scrolling should be used. When receiving lots
386	quickly, fewer screen updates are performed [default]; option B<-j>.	642	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
		643	has been read, resulting in fewer updates while still displaying every
		644	received line; option B<-j>.
		645
387	B<False>: specify that smooth scrolling should be used; option B<+j>.	646	B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
		647	force a screen refresh on each new line it received; option B<+j>.
388		648
389	=item B<inheritPixmap:> I<boolean>	649	=item B<skipScroll:> I<boolean>
390		650
391	B<True>: make the background inherit the parent windows' pixmap, giving	651	B<True>: (the default) specify that skip scrolling should be used. When
392	artificial transparency. B<False>: do not inherit the parent windows'	652	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
393	pixmap.	653	(around 60 times per second), resulting in far fewer updates. This can
		654	result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
		655	option B<-ss>.
		656
		657	B<False>: specify that everything is to be displayed, even
		658	if the refresh is too fast for the human eye to read anything (or the
		659	monitor to display anything); option B<+ss>.
		660
		661	=item B<transparent:> I<boolean>
		662
		663	Turn on/off illusion of a transparent window background.
		664
		665	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
		666	future versions.
		667
		668	I<Please address all transparency related issues to Sasha Vasko at
		669	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
394		670
395	=item B<fading:> I<number>	671	=item B<fading:> I<number>
396		672
397	Fade the text by the given percentage when focus is lost.	673	Fade the text by the given percentage when focus is lost; option B<-fade>.
		674
		675	=item B<fadeColor:> I<colour>
		676
		677	Fade to this colour, when fading is used (see B<fading:>). The default
		678	colour is black; option B<-fadecolor>.
398		679
399	=item B<tintColor:> I<colour>	680	=item B<tintColor:> I<colour>
400		681
401	Tint the transparent background pixmap with the given colour.	682	Tint the transparent background pixmap with the given colour; option
		683	B<-tint>.
402		684
403	=item B<shading:> I<number>	685	=item B<shading:> I<number>
404		686
405	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	687	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
406	image in addition to tinting it.	688	in addition to tinting it; option B<-sh>.
407		689
		690	=item B<blendType:> I<string>
		691
		692	Specify background blending type; option B<-blt>.
		693
408	=item B<fading:> I<number>	694	=item B<blurRadius:> I<number>
409		695
410	Scale the tint colour by the given percentage.	696	Apply Gaussian Blurr with the specified radius to the transparent
		697	background image; option B<-blr>.
411		698
412	=item B<scrollColor:> I<colour>	699	=item B<scrollColor:> I<colour>
413		700
414	Use the specified colour for the scrollbar [default #B2B2B2].	701	Use the specified colour for the scrollbar [default #B2B2B2].
415		702
416	=item B<troughColor:> I<colour>	703	=item B<troughColor:> I<colour>
417		704
418	Use the specified colour for the scrollbar's trough area [default	705	Use the specified colour for the scrollbar's trough area [default
419	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.	706	#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
420		707
		708	=item B<borderColor:> I<colour>
		709
		710	The colour of the border around the text area and between the scrollbar
		711	and the text.
		712
421	=item B<backgroundPixmap:> I<file[;geom]>	713	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
422		714
423	Use the specified XPM file (note the `.xpm' extension is optional) for	715	Use the specified image file for the background and also
424	the background and also optionally specify its scaling with a geometry	716	optionally specify its scaling with a geometry string B<WxH+X+Y>,
425	string B<WxH+X+Y>, in which B<"W" / "H"> specify the	717	(default C<0x0+50+50>) in which B<"W" / "H"> specify the
426	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image	718	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
427	centre (percent). A scale of 0 displays the image with tiling. A scale	719	centre (percent). A scale of 0 displays the image with tiling. A scale
428	of 1 displays the image without any scaling. A scale of 2 to 9	720	of 1 displays the image without any scaling. A scale of 2 to 9 specifies
429	specifies an integer number of images in that direction. No image will	721	an integer number of images in that direction. No image will be magnified
430	be magnified beyond 10 times its original size. The maximum permitted	722	beyond 10 times its original size. The maximum permitted scale is 1000.
431	scale is 1000. [default 0x0+50+50]	723	Additional operations can be specified after colon B<:op1:op2...>.
		724	Supported operations are:
432		725
433	=item B<menu:> I<file[;tag]>	726	tile force background image to be tiled and not scaled. Equivalent to 0x0,
		727	propscale will scale image keeping proportions,
		728	auto will scale image to match window size. Equivalent to 100x100;
		729	hscale will scale image horizontally to the window size;
		730	vscale will scale image vertically to the window size;
		731	scale will scale image to match window size;
		732	root will tile image as if it was a root window background, auto-adjusting
		733	whenever terminal window moves.
434		734
435	Read in the specified menu file (note the `.menu' extension is	735	If used in conjunction with B<-tr> option, the specified pixmap will be
436	optional) and also optionally specify a starting tag to find. See the	736	blended over transparency image using either alpha-blending, or any
437	reference documentation for details on the syntax for the menuBar.	737	other blending type, specified with B<-blt "type"> option.
438		738
439	=item B<path:> I<path>	739	=item B<path:> I<path>
440		740
441	Specify the colon-delimited search path for finding files (XPM and	741	Specify the colon-delimited search path for finding background image files.
442	menus), in addition to the paths specified by the B<RXVTPATH> and
443	B<PATH> environment variables.
444		742
445	=item B<font:> I<fontname>	743	=item B<font:> I<fontlist>
446		744
447	Select the fonts to be used. This is a comma seperated list of font	745	Select the fonts to be used. This is a comma separated list of font names
448	names that are used in turn when trying to display Unicode characters.	746	that are checked in order when trying to find glyphs for characters. The
449	The first font defines the cell size for characters; other fonts might	747	first font defines the cell size for characters; other fonts might be
450	be smaller, but not larger. A reasonable default font list is always	748	smaller, but not (in general) larger. A (hopefully) reasonable default
451	appended to it. option B<-fn>.	749	font list is always appended to it; option B<-fn>.
452		750
453	=item B<realBold:> I<boolean>	751	Each font can either be a standard X11 core font (XLFD) name, with
		752	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
454		753
455	B<True>: Enable "real bold" support. When this option is on, bold text	754	In addition, each font can be prefixed with additional hints and
456	will be displayed using the first available bold font in the font list.	755	specifications enclosed in square brackets (C<[]>). The only available
457	Bold fonts should thus be specified in the font list after their	756	hint currently is C<codeset=codeset-name>, and this is only used for Xft
458	corresponding regular fonts. If no bold font can be found, a regular	757	fonts.
459	font will be used. option B<-rb>. B<False>: Display bold text in a	758
460	regular font, using the color specified with B<colorBD>; option B<+rb>.	759	For example, this font resource
		760
		761	URxvt.font: 9x15bold,\
		762	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
		763	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
		764	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
		765	xft:Code2000:antialias=false
		766
		767	specifies five fonts to be used. The first one is C<9x15bold> (actually
		768	the iso8859-1 version of the second font), which is the base font (because
		769	it is named first) and thus defines the character cell grid to be 9 pixels
		770	wide and 15 pixels high.
		771
		772	The second font is just used to add additional unicode characters not in
		773	the base font, likewise the third, which is unfortunately non-bold, but
		774	the bold version of the font does contain less characters, so this is a
		775	useful supplement.
		776
		777	The third font is an Xft font with aliasing turned off, and the characters
		778	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
		779	contains other characters, but we are not interested in them.
		780
		781	The last font is a useful catch-all font that supplies most of the
		782	remaining unicode characters.
		783
		784	=item B<boldFont:> I<fontlist>
		785
		786	=item B<italicFont:> I<fontlist>
		787
		788	=item B<boldItalicFont:> I<fontlist>
		789
		790	The font list to use for displaying B<bold>, I<italic> or B<< I<bold
		791	italic> >> characters, respectively.
		792
		793	If specified and non-empty, then the syntax is the same as for the
		794	B<font>-resource, and the given font list will be used as is, which makes
		795	it possible to substitute completely different font styles for bold and
		796	italic.
		797
		798	If unset (the default), a suitable font list will be synthesized by
		799	"morphing" the normal text font list into the desired shape. If that is
		800	not possible, replacement fonts of the desired shape will be tried.
		801
		802	If set, but empty, then this specific style is disabled and the normal
		803	text font will being used for the given style.
		804
		805	=item B<intensityStyles:> I<boolean>
		806
		807	When font styles are not enabled, or this option is enabled (B<True>,
		808	option B<-is>, the default), bold and italic font styles imply high
		809	intensity foreground/background colours. Disabling this option (B<False>,
		810	option B<+is>) disables this behaviour, the high intensity colours are not
		811	reachable.
461		812
462	=item B<selectstyle:> I<mode>	813	=item B<selectstyle:> I<mode>
463		814
464	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	815	Set mouse selection style to B<old> which is 2.20, B<oldword> which
465	xterm style with 2.20 old word selection, or anything else which gives	816	is xterm style with 2.20 old word selection, or anything else which
466	xterm style selection.	817	gives xterm style selection. Only effective when the original (non-perl)
		818	selection code is in use.
467		819
468	=item B<scrollstyle:> I<mode>	820	=item B<scrollstyle:> I<mode>
469		821
470	Set scrollbar style to B<@@RXVT_NAME@@>, B<rxvt>, B<plain>, B<next> or	822	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
471	B<xterm>	823	the author's favourite.
472		824
473	=item B<title:> I<string>	825	=item B<title:> I<string>
474		826
475	Set window title string, the default title is the command-line	827	Set window title string, the default title is the command-line
476	specified after the B<-e> option, if any, otherwise the application	828	specified after the B<-e> option, if any, otherwise the application
…		…
485	=item B<mapAlert:> I<boolean>	837	=item B<mapAlert:> I<boolean>
486		838
487	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no	839	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
488	de-iconify (map) on receipt of a bell character [default].	840	de-iconify (map) on receipt of a bell character [default].
489		841
		842	=item B<urgentOnBell:> I<boolean>
		843
		844	B<True>: set the urgency hint for the wm on receipt of a bell character.
		845	B<False>: do not set the urgency hint [default].
		846
490	=item B<visualBell:> I<boolean>	847	=item B<visualBell:> I<boolean>
491		848
492	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	849	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
493	B<False>: no visual bell [default]; option B<+vb>.	850	B<False>: no visual bell [default]; option B<+vb>.
494		851
…		…
508		865
509	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use	866	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
510	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or	867	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
511	B<Shift-Print> to include the scrollback as well.	868	B<Shift-Print> to include the scrollback as well.
512		869
		870	The string will be interpreted as if typed into the shell as-is.
		871
		872	Example:
		873
		874	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
		875
		876	This creates a new file in your home directory with the screen contents
		877	every time you hit C<Print>.
		878
513	=item B<scrollBar:> I<boolean>	879	=item B<scrollBar:> I<boolean>
514		880
515	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	881	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
516	disable the scrollbar; option B<+sb>.	882	disable the scrollbar; option B<+sb>.
517		883
…		…
530	Align the B<top>, B<bottom> or B<centre> [default] of the scrollbar	896	Align the B<top>, B<bottom> or B<centre> [default] of the scrollbar
531	thumb with the pointer on middle button press/drag.	897	thumb with the pointer on middle button press/drag.
532		898
533	=item B<scrollTtyOutput:> I<boolean>	899	=item B<scrollTtyOutput:> I<boolean>
534		900
535	B<True>: scroll to bottom when tty receives output; option B<+si>.	901	B<True>: scroll to bottom when tty receives output; option B<-si>.
536	B<False>: do not scroll to bottom when tty receives output; option	902	B<False>: do not scroll to bottom when tty receives output; option
537	B<-si>.	903	B<+si>.
538		904
539	=item B<scrollWithBuffer:> I<boolean>	905	=item B<scrollWithBuffer:> I<boolean>
540		906
541	B<True>: scroll with scrollback buffer when tty recieves new lines (and	907	B<True>: scroll with scrollback buffer when tty receives new lines (and
542	B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll	908	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
543	with scrollback buffer when tty recieves new lines; option B<-sw>.	909	with scrollback buffer when tty receives new lines; option B<+sw>.
544		910
545	=item B<scrollTtyKeypress:> I<boolean>	911	=item B<scrollTtyKeypress:> I<boolean>
546		912
547	B<True>: scroll to bottom when a non-special key is pressed. Special	913	B<True>: scroll to bottom when a non-special key is pressed. Special keys
548	keys are those which are intercepted by rxvt for special handling and	914	are those which are intercepted by rxvt-unicode for special handling and
549	are not passed onto the shell; option B<-sk>. B<False>: do not scroll	915	are not passed onto the shell; option B<-sk>. B<False>: do not scroll to
550	to bottom when a non-special key is pressed; option B<+sk>.	916	bottom when a non-special key is pressed; option B<+sk>.
551
552	=item B<smallfont_key:> I<keysym>
553
554	If enabled, use B<@@HOTKEY@@->I<keysym> to toggle to a smaller font
555	[default B<@@HOTKEY@@-@@SMALLFONT@@>]
556
557	=item B<bigfont_key:> I<keysym>
558
559	If enabled, use B<@@HOTKEY@@->I<keysym> to toggle to a bigger font
560	[default B<@@HOTKEY@@-@@BIGFONT@@>]
561		917
562	=item B<saveLines:> I<number>	918	=item B<saveLines:> I<number>
563		919
564	Save I<number> lines in the scrollback buffer [default 64]. This	920	Save I<number> lines in the scrollback buffer [default 64]. This
565	resource is limited on most machines to 65535; option B<-sl>.	921	resource is limited on most machines to 65535; option B<-sl>.
…		…
575	option B<-w>, B<-bw>, B<-borderwidth>.	931	option B<-w>, B<-bw>, B<-borderwidth>.
576		932
577	=item B<borderLess:> I<boolean>	933	=item B<borderLess:> I<boolean>
578		934
579	Set MWM hints to request a borderless window, i.e. if honoured by the	935	Set MWM hints to request a borderless window, i.e. if honoured by the
580	WM, the rxvt window will not have window decorations; option B<-bl>.	936	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
		937
		938	=item B<skipBuiltinGlyphs:> I<boolean>
		939
		940	Compile I<frills>: Disable the usage of the built-in block graphics/line
		941	drawing characters and just rely on what the specified fonts provide. Use
		942	this if you have a good font and want to use its block graphic glyphs;
		943	option B<-sbg>.
581		944
582	=item B<termName:> I<termname>	945	=item B<termName:> I<termname>
583		946
584	Specifies the terminal type name to be set in the B<TERM> environment	947	Specifies the terminal type name to be set in the B<TERM> environment
585	variable; option B<-tn>.	948	variable; option B<-tn>.
586		949
587	=item B<linespace:> I<number>	950	=item B<lineSpace:> I<number>
588		951
589	Specifies number of lines (pixel height) to insert between each row of	952	Specifies number of lines (pixel height) to insert between each row of
590	the display [default 0]; option B<-lsp>.	953	the display [default 0]; option B<-lsp>.
591		954
592	=item B<meta8:> I<boolean>	955	=item B<meta8:> I<boolean>
…		…
596		959
597	=item B<mouseWheelScrollPage:> I<boolean>	960	=item B<mouseWheelScrollPage:> I<boolean>
598		961
599	B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel	962	B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel
600	scrolls five lines [default].	963	scrolls five lines [default].
		964
		965	=item B<pastableTabs:> I<boolean>
		966
		967	B<True>: store tabs as wide characters. B<False>: interpret tabs as cursor
		968	movement only; option C<-ptab>.
601		969
602	=item B<cursorBlink:> I<boolean>	970	=item B<cursorBlink:> I<boolean>
603		971
604	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	972	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
605	option B<-bc>.	973	option B<-bc>.
…		…
618		986
619	Mouse pointer background colour.	987	Mouse pointer background colour.
620		988
621	=item B<pointerBlankDelay:> I<number>	989	=item B<pointerBlankDelay:> I<number>
622		990
623	Specifies number of seconds before blanking the pointer [default 2].	991	Specifies number of seconds before blanking the pointer [default 2]. Use a
		992	large number (e.g. C<987654321>) to effectively disable the timeout.
624		993
625	=item B<backspacekey:> I<string>	994	=item B<backspacekey:> I<string>
626		995
627	The string to send when the backspace key is pressed. If set to B<DEC>	996	The string to send when the backspace key is pressed. If set to B<DEC>
628	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	997	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
…		…
635	pressed. If unset it will send the sequence traditionally associated	1004	pressed. If unset it will send the sequence traditionally associated
636	with the B<Execute> key.	1005	with the B<Execute> key.
637		1006
638	=item B<cutchars:> I<string>	1007	=item B<cutchars:> I<string>
639		1008
640	The characters used as delimiters for double-click word selection. The	1009	The characters used as delimiters for double-click word selection
641	built-in default:	1010	(whitespace delimiting is added automatically if resource is given).
642		1011
		1012	When the perl selection extension is in use (the default if compiled
		1013	in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
		1014	characters will be created (if the resource exists, otherwise, no regex
		1015	will be created). In this mode, characters outside ISO-8859-1 can be used.
		1016
		1017	When the selection extension is not used, only ISO-8859-1 characters can
		1018	be used. If not specified, the built-in default is used:
		1019
643	B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>	1020	B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
644		1021
645	=item B<preeditType:> I<style>	1022	=item B<preeditType:> I<style>
646		1023
647	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1024	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
648		1025
…		…
650		1027
651	I<name> of inputMethod to use; option B<-im>.	1028	I<name> of inputMethod to use; option B<-im>.
652		1029
653	=item B<imLocale:> I<name>	1030	=item B<imLocale:> I<name>
654		1031
655	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.	1032	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
656	de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input	1033	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
657	extension to be able to input japanese characters while staying in	1034	input extension to be able to input japanese characters while staying in
658	another locale. option B<-imlocale>.	1035	another locale; option B<-imlocale>.
659		1036
660	=item B<insecure>	1037	=item B<imFont:> I<fontset>
		1038
		1039	Specify the font-set used for XIM styles C<OverTheSpot> or
		1040	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
		1041	by commas), i.e. it's not in the same format as the other font lists used
		1042	in @@RXVT_NAME@@. The default will be set-up to chose *any* suitable found
		1043	found, preferably one or two pixels differing in size to the base font.
		1044	option B<-imfont>.
		1045
		1046	=item B<tripleclickwords:> I<boolean>
		1047
		1048	Change the meaning of triple-click selection with the left mouse
		1049	button. Instead of selecting a full line it will extend the selection to
		1050	the end of the logical line only; option B<-tcw>.
		1051
		1052	=item B<insecure:> I<boolean>
661		1053
662	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	1054	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
663	echo arbitrary strings like the icon name or the locale. This could be	1055	echo arbitrary strings like the icon name or the locale. This could be
664	abused if somebody gets 8-bit-clean access to your display, wether	1056	abused if somebody gets 8-bit-clean access to your display, whether
665	throuh a mail client displaying mail bodies unfiltered or though	1057	through a mail client displaying mail bodies unfiltered or through
666	write(1). Therefore, these sequences are disabled by default. (Note	1058	write(1) or any other means. Therefore, these sequences are disabled by
667	that other terminals, including xterm, have these sequences	1059	default. (Note that many other terminals, including xterm, have these
668	enabled by default). You can enable them by setting this boolean	1060	sequences enabled by default, which doesn't make it safer, though).
669	resource or specifying B<-insecure> as an option. At the moment, this	1061
670	enabled display-answer, locale, findfont, icon label and window title	1062	You can enable them by setting this boolean resource or specifying
671	requests as well as dynamic menubar dispatch.	1063	B<-insecure> as an option. At the moment, this enables display-answer,
		1064	locale, findfont, icon label and window title requests.
672		1065
673	=item B<modifier:> I<modifier>	1066	=item B<modifier:> I<modifier>
674		1067
675	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	1068	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
676	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option	1069	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
677	B<-mod>.	1070	B<-mod>.
678		1071
679	=item B<answerbackString:> I<string>	1072	=item B<answerbackString:> I<string>
680		1073
681	Specify the reply rxvt sends to the shell when an ENQ (control-E)	1074	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
682	character is passed through. It may contain escape values as described	1075	character is passed through. It may contain escape values as described
683	in the entry on B<keysym> following.	1076	in the entry on B<keysym> following.
684		1077
685	=item B<secondaryScreen:> I<bool>	1078	=item B<secondaryScreen:> I<boolean>
686		1079
687	Turn on/off secondary screen (default enabled).	1080	Turn on/off secondary screen (default enabled).
688		1081
689	=item B<secondaryScroll:> I<bool>	1082	=item B<secondaryScroll:> I<boolean>
690		1083
691	Turn on/off secondary screen scroll (default enabled). If the this	1084	Turn on/off secondary screen scroll (default enabled). If this
692	option is enabled, scrolls on the secondary screen will change the	1085	option is enabled, scrolls on the secondary screen will change the
693	scrollback buffer and switching to/from the secondary screen will	1086	scrollback buffer and switching to/from the secondary screen will
694	instead scroll the screen up.	1087	instead scroll the screen up.
695		1088
		1089	=item B<hold>: I<boolean>
		1090
		1091	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		1092	will not immediately destroy its window when the program executed within
		1093	it exits. Instead, it will wait till it is being killed or closed by the
		1094	user.
		1095
696	=item B<keysym.>I<sym>: I<string>	1096	=item B<keysym.>I<sym>: I<string>
697		1097
698	Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may	1098	Compile I<frills>: Associate I<string> with keysym I<sym>. The
699	contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n:
700	newline, \r: return, \t:
701	tab, \000: octal number) or control characters (^?: delete, ^@: null,
702	^A ...) and may enclosed with double quotes so that it can start or end
703	with whitespace. The intervening resource name B<keysym.> cannot be	1099	intervening resource name B<keysym.> cannot be omitted.
704	omitted. This resource is only available when compiled with	1100
705	KEYSYM_RESOURCE.	1101	The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be
		1102	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,
		1103	B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,
		1104	and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,
		1105	B<2>, B<3>, B<4>, B<5>.
		1106
		1107	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
		1108	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
		1109	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
		1110	current application keymap mode state.
		1111
		1112	The spellings of I<key> can be obtained by using B<xev>(1) command or
		1113	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
		1114	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
		1115	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
		1116	performed in an exact manner; however, the closest match is assured.
		1117
		1118	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
		1119	number), see RESOURCES in C<man 7 X> for futher details.
		1120
		1121	You can define a range of keysyms in one shot by providing a I<string>
		1122	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
		1123	should be a character not used by the strings.
		1124
		1125	Its usage can be demonstrated by an example:
		1126
		1127	URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
		1128
		1129	The above line is equivalent to the following three lines:
		1130
		1131	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
		1132	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
		1133	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
		1134
		1135	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
		1136	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
		1137	example the following means "change the current locale to C<zh_CN.GBK>
		1138	when Control-Meta-c is being pressed":
		1139
		1140	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
		1141
		1142	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
		1143	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
		1144	manpage. For example, the F<selection> extension (activated via
		1145	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
		1146
		1147	URxvt.keysym.M-C-c: perl:selection:rot13
		1148
		1149	Due the the large number of modifier combinations, a defined key mapping
		1150	will match if at I<at least> the specified identifiers are being set, and
		1151	no other key mappings with those and more bits are being defined. That
		1152	means that defining a key map for C<a> will automatically provide
		1153	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
		1154	mappings themselves.
		1155
		1156	Unfortunately, this will override built-in key mappings. For example
		1157	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
		1158	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
		1159	user-defined keymap using the C<builtin:> replacement:
		1160
		1161	URxvt.keysym.Insert: <my insert key sequence>
		1162	URxvt.keysym.S-Insert: builtin:
		1163
		1164	The first line defines a mapping for C<Insert> and I<any> combination
		1165	of modifiers. The second line re-establishes the default mapping for
		1166	C<Shift-Insert>.
		1167
		1168	The following example will map Control-Meta-1 and Control-Meta-2 to
		1169	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
		1170	font-switching at runtime:
		1171
		1172	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
		1173	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
		1174
		1175	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
		1176	info):
		1177
		1178	URxvt.keysym.M-C-3: command:\033[8;25;80t
		1179	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1180
		1181	=item B<perl-ext-common>: I<string>
		1182
		1183	=item B<perl-ext>: I<string>
		1184
		1185	Comma-separated list(s) of perl extension scripts (default: C<default>) to
		1186	use in this terminal instance; option B<-pe>.
		1187
		1188	Extension names can be prefixed with a C<-> sign to prohibit using
		1189	them. This can be useful to selectively disable some extensions loaded
		1190	by default, or specified via the C<perl-ext-common> resource. For
		1191	example, C<default,-selection> will use all the default extension except
		1192	C<selection>.
		1193
		1194	Extension names can also be followed by an argument in angle brackets
		1195	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
		1196	searchable scrollback to Alt/Meta-s). Mentioning the same extension
		1197	multiple times with different arguments will pass multiple arguments to
		1198	the extension.
		1199
		1200	Each extension is looked up in the library directories, loaded if
		1201	necessary, and bound to the current terminal instance.
		1202
		1203	If both of these resources are the empty string, then the perl
		1204	interpreter will not be initialized. The idea behind two options is that
		1205	B<perl-ext-common> will be used for extensions that should be available to
		1206	all instances, while B<perl-ext> is used for specific instances.
		1207
		1208	=item B<perl-eval>: I<string>
		1209
		1210	Perl code to be evaluated when all extensions have been registered. See
		1211	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
		1212	will be ignored when running setuid/setgid.
		1213
		1214	=item B<perl-lib>: I<path>
		1215
		1216	Colon-separated list of additional directories that hold extension
		1217	scripts. When looking for extensions specified by the C<perl> resource,
		1218	@@RXVT_NAME@@ will first look in these directories and then in
		1219	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
		1220	will be ignored when running setuid/setgid.
		1221
		1222	See the @@RXVT_NAME@@perl(3) manpage.
		1223
		1224	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
		1225
		1226	Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
		1227	details.
		1228
		1229	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
		1230
		1231	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
		1232	for details.
		1233
		1234	=item B<searchable-scrollback:> I<keysym>
		1235
		1236	Sets the hotkey that starts the incremental scrollback buffer search
		1237	(default: C<M-s>).
		1238
		1239	=item B<urlLauncher>: I<string>
		1240
		1241	Specifies the program to be started with a URL argument. Used by the
		1242	C<selection-popup> and C<matcher> perl extensions.
		1243
		1244	=item B<transient-for>: I<windowid>
		1245
		1246	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
		1247
		1248	=item B<override-redirect>: I<boolean>
		1249
		1250	Compile I<frills>: Sets override-redirect for the terminal window, making
		1251	it almost invisible to window managers; option B<-override-redirect>.
		1252
		1253	=item B<iso14755_52:> I<boolean>
		1254
		1255	Turn on/off ISO 14755 5.2 mode (default enabled).
706		1256
707	=back	1257	=back
708		1258
709	=head1 THE SCROLLBAR	1259	=head1 THE SCROLLBAR
710		1260
…		…
724	the normal text selection/insertion, hold either the Shift or the Meta	1274	the normal text selection/insertion, hold either the Shift or the Meta
725	(Alt) key while performing the desired mouse action.	1275	(Alt) key while performing the desired mouse action.
726		1276
727	If mouse reporting mode is active, the normal scrollbar actions are	1277	If mouse reporting mode is active, the normal scrollbar actions are
728	disabled -- on the assumption that we are using a fullscreen	1278	disabled -- on the assumption that we are using a fullscreen
729	application. Instead, pressing Button1 and Button3 sends B<ESC[6~>	1279	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
730	(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the	1280	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
731	up and down arrows sends B<ESC[A> (Up) and B<ESC[B> (Down),	1281	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
732	respectively.	1282	respectively.
733		1283
734	=head1 TEXT SELECTION AND INSERTION	1284	=head1 THE SELECTION: SELECTING AND PASTING TEXT
735		1285
736	The behaviour of text selection and insertion mechanism is similar to	1286	The behaviour of text selection and insertion/pasting mechanism is similar
737	I<xterm>(1).	1287	to I<xterm>(1).
738		1288
739	=over 4	1289	=over 4
740		1290
741	=item B<Selection>:	1291	=item B<Selecting>:
742		1292
743	Left click at the beginning of the region, drag to the end of the	1293	Left click at the beginning of the region, drag to the end of the region
744	region and release; Right click to extend the marked region; Left	1294	and release; Right click to extend the marked region; Left double-click
745	double-click to select a word; Left triple-click to select the entire	1295	to select a word; Left triple-click to select the entire logical line
746	line.	1296	(which can span multiple screen lines), unless modified by resource
		1297	B<tripleclickwords>.
747		1298
		1299	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
		1300	(Compile: I<frills>) will create a rectangular selection instead of a
		1301	normal one. In this mode, every selected row becomes its own line in the
		1302	selection, and trailing whitespace is visually underlined and removed from
		1303	the selection.
		1304
748	=item B<Insertion>:	1305	=item B<Pasting>:
749		1306
750	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1307	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
751	an B<@@RXVT_NAME@@> window causes the current text selection to be	1308	window causes the value of the PRIMARY selection (or CLIPBOARD with the
752	inserted as if it had been typed on the keyboard.	1309	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
		1310
		1311	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
		1312	inserted too.
753		1313
754	=back	1314	=back
755		1315
756	=head1 CHANGING FONTS	1316	=head1 CHANGING FONTS
757		1317
758	You can change fonts on-the-fly, which is to say cycle through the	1318	Changing fonts (or font sizes, respectively) via the keypad is not yet
759	default font and others of various sizes, by using B<Shift-KP_Add> and	1319	supported in rxvt-unicode. Bug me if you need this.
760	B<Shift-KP_Subtract>. Or, alternatively (if enabled) with	1320
761	B<@@HOTKEY@@-@@BIGFONT@@> and B<@@HOTKEY@@-@@SMALLFONT@@>, where the	1321	You can, however, switch fonts at runtime using escape sequences, e.g.:
762	actual key can be selected using resources	1322
763	B<smallfont_key>/B<bigfont_key>.	1323	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
		1324
		1325	You can use keyboard shortcuts, too:
		1326
		1327	URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
		1328	URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
		1329
		1330	rxvt-unicode will automatically re-apply these fonts to the output so far.
764		1331
765	=head1 ISO 14755 SUPPORT	1332	=head1 ISO 14755 SUPPORT
766		1333
767	Partial ISO 14755-support is implemented. that means that pressing	1334	ISO 14755 is a standard for entering and viewing unicode characters
		1335	and character codes using the keyboard. It consists of 4 parts. The
		1336	first part is available if rxvt-unicode has been compiled with
		1337	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
		1338	with C<--enable-iso14755>.
768		1339
769	Section 5.1: Control and Shift together enters unicode input	1340	=over 4
770	mode. Entering hex digits composes a Unicode character, pressing space or
771	releasing the modifiers commits the keycode and every other key cancels
772	the current input character.
773		1341
774	Section 5.2: Pressing and immediately releasing Control and Shift together	1342	=item * 5.1: Basic method
775	enters keycap entry mode for the next key: pressing a function key (tab,	1343
776	return etc..) will enter the unicode character corresponding to the given	1344	This allows you to enter unicode characters using their hexcode.
777	key.	1345
		1346	Start by pressing and holding both C<Control> and C<Shift>, then enter
		1347	hex-digits (between one and six). Releasing C<Control> and C<Shift> will
		1348	commit the character as if it were typed directly. While holding down
		1349	C<Control> and C<Shift> you can also enter multiple characters by pressing
		1350	C<Space>, which will commit the current character and lets you start a new
		1351	one.
		1352
		1353	As an example of use, imagine a business card with a japanese e-mail
		1354	address, which you cannot type. Fortunately, the card has the e-mail
		1355	address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily
		1356	by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
		1357	followed by releasing the modifier keys.
		1358
		1359	=item * 5.2: Keyboard symbols entry method
		1360
		1361	This mode lets you input characters representing the keycap symbols of
		1362	your keyboard, if representable in the current locale encoding.
		1363
		1364	Start by pressing C<Control> and C<Shift> together, then releasing
		1365	them. The next special key (cursor keys, home etc.) you enter will not
		1366	invoke its usual function but instead will insert the corresponding
		1367	keycap symbol. The symbol will only be entered when the key has been
		1368	released, otherwise pressing e.g. C<Shift> would enter the symbol for
		1369	C<ISO Level 2 Switch>, although your intention might have been to enter a
		1370	reverse tab (Shift-Tab).
		1371
		1372	=item * 5.3: Screen-selection entry method
		1373
		1374	While this is implemented already (it's basically the selection
		1375	mechanism), it could be extended by displaying a unicode character map.
		1376
		1377	=item * 5.4: Feedback method for identifying displayed characters for later input
		1378
		1379	This method lets you display the unicode character code associated with
		1380	characters already displayed.
		1381
		1382	You enter this mode by holding down C<Control> and C<Shift> together, then
		1383	pressing and holding the left mouse button and moving around. The unicode
		1384	hex code(s) (it might be a combining character) of the character under the
		1385	pointer is displayed until you release C<Control> and C<Shift>.
		1386
		1387	In addition to the hex codes it will display the font used to draw this
		1388	character - due to implementation reasons, characters combined with
		1389	combining characters, line drawing characters and unknown characters will
		1390	always be drawn using the built-in support font.
		1391
		1392	=back
		1393
		1394	With respect to conformance, rxvt-unicode is supposed to be compliant to
		1395	both scenario A and B of ISO 14755, including part 5.2.
778		1396
779	=head1 LOGIN STAMP	1397	=head1 LOGIN STAMP
780		1398
781	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so	1399	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
782	that it can be seen via the I<who(1)> command, and can accept messages.	1400	it can be seen via the I<who(1)> command, and can accept messages. To
783	To allow this feature, B<@@RXVT_NAME@@> must be installed setuid root on	1401	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
784	some systems.	1402	on some systems or setgid to root or to some other group on others.
785		1403
786	=head1 COLORS AND GRAPHICS	1404	=head1 COLORS AND GRAPHICS
787		1405
788	In addition to the default foreground and background colours,	1406	In addition to the default foreground and background colours,
789	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1407	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
790	high-intensity bold/blink versions of the same). Here is a list of the	1408	high-intensity bold/blink versions of the same). Here is a list of the
791	colours with their B<rgb.txt> names.	1409	colours with their names.
792		1410
793	=begin table	1411	=begin table
794		1412
795	B<color0> (black) = Black	1413	B<color0> (black) = Black
796	B<color1> (red) = Red3	1414	B<color1> (red) = Red3
…		…
816	It is also possible to specify the colour values of B<foreground>,	1434	It is also possible to specify the colour values of B<foreground>,
817	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1435	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
818	a number 0-15, as a convenient shorthand to reference the colour name of	1436	a number 0-15, as a convenient shorthand to reference the colour name of
819	color0-color15.	1437	color0-color15.
820		1438
		1439	In addition to the colours defined above, @@RXVT_NAME@@ offers an
		1440	additional 72 colours. The first 64 of those (with indices 16 to 79)
		1441	consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
		1442	16>), followed by 8 additional shades of gray (with indices 80 to 87).
		1443
		1444	Together, all those colours implement the 88 colour xterm colours. Only
		1445	the first 16 can be changed using resources currently, the rest can only
		1446	be changed via command sequences ("escape codes").
		1447
821	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1448	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
822	always swapping the foreground/background colours. This is in contrast to	1449	always swapping the foreground/background colours. This is in contrast to
823	I<xterm>(1) where the colours are only swapped if they have not otherwise	1450	I<xterm>(1) where the colours are only swapped if they have not otherwise
824	been specified. For example,	1451	been specified. For example,
825		1452
826	=over 4	1453	=over 4
827		1454
828	=item B<rxvt -fg Black -bg White -rv>	1455	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>
829		1456
830	would yield White on Black, while on I<xterm>(1) it would yield Black	1457	would yield White on Black, while on I<xterm>(1) it would yield Black
831	on White.	1458	on White.
832		1459
833	=back	1460	=back
834		1461
		1462	=head2 ALPHA CHANNEL SUPPORT
		1463
		1464	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
		1465	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
		1466	(recommended, but B<MUST> have 4 digits/component) colour specifications,
		1467	in addition to the ones provided by X, where the additional A component
		1468	specifies opacity (alpha) values. The minimum value of C<0> is completely
		1469	transparent). You can also prefix any color with C<[percent]>, where
		1470	C<percent> is a decimal percentage (0-100) that specifies the opacity of
		1471	the color, where C<0> is completely transparent and C<100> is completelxy
		1472	opaque.
		1473
		1474	You probably need to specify B<"-depth 32">, too, and have the luck that
		1475	your X-server uses ARGB pixel layout, as X is far from just supporting
		1476	ARGB visuals out of the box, and rxvt-unicode just fudges around.
		1477
		1478	For example, the following selects an almost completely transparent red
		1479	background, and an almost opaque pink foreground:
		1480
		1481	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
		1482
		1483	I<Please note that transparency of any kind if completely unsupported by
		1484	the author. Don't bug him with installation questions!>
		1485
835	=head1 ENVIRONMENT	1486	=head1 ENVIRONMENT
836		1487
837	B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM>	1488	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
838	and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X	1489
839	window id number of the B<@@RXVT_NAME@@> window and it also uses and	1490	=over 4
840	sets the environment variable B<DISPLAY> to specify which display	1491
841	terminal to use. B<@@RXVT_NAME@@> uses the environment variables	1492	=item B<TERM>
842	B<RXVTPATH> and B<PATH> to find XPM files.	1493
		1494	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
		1495	resources or on the command line.
		1496
		1497	=item B<COLORTERM>
		1498
		1499	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
		1500	compiled with background image support, and optionally with the added
		1501	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1502	screen.
		1503
		1504	=item B<COLORFGBG>
		1505
		1506	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
		1507	the colour code used as default foreground/text colour (or the string
		1508	C<default> to indicate that the default-colour escape sequence is to be
		1509	used), C<bg> is the colour code used as default background colour (or the
		1510	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
		1511	was compiled with background image support. Libraries like C<ncurses>
		1512	and C<slang> can (and do) use this information to optimize screen output.
		1513
		1514	=item B<WINDOWID>
		1515
		1516	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
		1517	window, which usually has subwindows for the scrollbar, the terminal
		1518	window and so on).
		1519
		1520	=item B<TERMINFO>
		1521
		1522	Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
		1523	C<--with-terminfo=PATH>.
		1524
		1525	=item B<DISPLAY>
		1526
		1527	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
		1528	display in its child processes.
		1529
		1530	=item B<SHELL>
		1531
		1532	The shell to be used for command execution, defaults to C</bin/sh>.
		1533
		1534	=item B<RXVT_SOCKET>
		1535
		1536	The unix domain socket path used by @@RXVT_NAME@@c(1) and
		1537	@@RXVT_NAME@@d(1).
		1538
		1539	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
		1540
		1541	=item B<HOME>
		1542
		1543	Used to locate the default directory for the unix domain socket for
		1544	daemon communications and to locate various resource files (such as
		1545	C<.Xdefaults>)
		1546
		1547	=item B<XAPPLRESDIR>
		1548
		1549	Directory where various X resource files are being located.
		1550
		1551	=item B<XENVIRONMENT>
		1552
		1553	If set and accessible, gives the name of a X resource file to be loaded by
		1554	@@RXVT_NAME@@.
		1555
		1556	=back
843		1557
844	=head1 FILES	1558	=head1 FILES
845		1559
846	=over 4	1560	=over 4
847		1561
848	=item B</etc/utmp>
849
850	System file for login records.
851
852	=item B</usr/lib/X11/rgb.txt>	1562	=item B</usr/lib/X11/rgb.txt>
853		1563
854	Color names.	1564	Color names.
855		1565
856	=back	1566	=back
857		1567
858	=head1 SEEALSO	1568	=head1 SEE ALSO
859		1569
860	I<xterm>(1), I<sh>(1), I<resize>(1), I<X>(1), I<pty>(4), I<tty>(4), I<utmp>(5)	1570	@@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)
861
862	See rxvtRef.html rxvtRef.txt for detailed information on recognized escape sequences and menuBar syntax, etc.
863
864	=head1 BUGS
865
866	Check the BUGS file for an up-to-date list.
867
868	Cursor change support is not yet implemented.
869
870	Click-and-drag doesn't work with X11 mouse report overriding.
871		1571
872	=head1 CURRENT PROJECT COORDINATOR	1572	=head1 CURRENT PROJECT COORDINATOR
873		1573
874	=over 4	1574	=over 4
875		1575
876	=item Project Coordinator	1576	=item Project Coordinator
877		1577
878	@@RXVTMAINT@@ L<@@RXVT_MAINTEMAIL@@>	1578	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
879		1579
880	=item Web page maintainter	1580	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
881
882	@@RXVTWEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
883
884	L<@@RXVT_WEBPAGE@@>
885		1581
886	=back	1582	=back
887		1583
888	=head1 AUTHORS	1584	=head1 AUTHORS
889		1585
…		…
911		1607
912	Project Coordinator (changes.txt 2.21a to 2.4.5)	1608	Project Coordinator (changes.txt 2.21a to 2.4.5)
913		1609
914	=item Geoff Wing L<< <gcw@pobox.com> >>	1610	=item Geoff Wing L<< <gcw@pobox.com> >>
915		1611
916	Rewrote screen display and text selection routines. Project Coordinator	1612	Rewrote screen display and text selection routines.
		1613
917	(changes.txt 2.4.6 - rxvt-unicode)	1614	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
918		1615
919	=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >>	1616	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
920		1617
921	Forked rxvt-unicode, rewrote most of the display code and internal	1618	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
922	character handling to store text in unicode, improve xterm	1619	extension, random hacks, numerous bugfixes and extensions.
923	compatibility and apply numerous other bugfixes and extensions.
924		1620
925	Project Coordinator (Changes 1.0 -)	1621	Project Coordinator (Changes 1.0 -)
926		1622
		1623	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
		1624
		1625	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
		1626
927	=back	1627	=back
928		1628

Diff Legend

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