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

Diff Legend

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