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.1 by root, Thu Aug 12 20:42:12 2004 UTC vs.
Revision 1.131 by ayin, Sat Jun 9 09:05:38 2007 UTC

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

Diff Legend

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