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

Diff Legend

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