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

Diff Legend

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