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

Diff Legend

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