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.12 by root, Mon Aug 16 02:09:28 2004 UTC vs.
Revision 1.156 by ayin, Sun Dec 30 22:43:40 2007 UTC

…		…
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	This document is also available on the World-Wide-Web at
		18	L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
		19
		20	=head1 FREQUENTLY ASKED QUESTIONS
		21
		22	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
		23	frequently asked questions and answer to them and some common
		24	problems. That document is also accessible on the World-Wide-Web at
		25	L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
		26
17	=head1 RXVT-UNICODE VS. RXVT	27	=head1 RXVT-UNICODE VS. RXVT
18		28
19	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode	29	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
20	internally. That means it can store and display most scripts in the	30	internally. That means it can store and display most scripts in the
21	world. Being a terminal emulator, however, some things are very difficult,	31	world. Being a terminal emulator, however, some things are very difficult,
22	especially cursive scripts such as arabic, vertically written scripts	32	especially cursive scripts such as arabic, vertically written scripts
23	like mongolian or scripts requiring extremely complex combining rules,	33	like mongolian or scripts requiring extremely complex combining rules,
24	like tibetan or devenagari. Don't expect pretty output when using these	34	like tibetan or devanagari. Don't expect pretty output when using these
25	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work	35	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
26	fine, though. A somewhat difficult case are left-to-right scripts, such	36	fine, though. A somewhat difficult case are right-to-left scripts, such
27	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms	37	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
28	belong into the application, not the terminal emulator (too many things --	38	belong in the application, not the terminal emulator (too many things --
29	such as cursor-movement while editing -- break othwerwise), but that might	39	such as cursor-movement while editing -- break otherwise), but that might
30	change.	40	change.
31		41
32	If you are looking for a terminal that supports more exotic scripts, let	42	If you are looking for a terminal that supports more exotic scripts, let
33	me recommend C<mlterm>, which is a very userfriendly, lean and clean	43	me recommend C<mlterm>, which is a very user friendly, lean and clean
34	terminal emulator. In fact, the reason rxvt-unicode was born was solely	44	terminal emulator. In fact, the reason rxvt-unicode was born was solely
35	because the author couldn't get C<mlterm> to use one font for latin1 and	45	because the author couldn't get C<mlterm> to use one font for latin1 and
36	another for japanese.	46	another for japanese.
37		47
38	Therefore another design rationale was the use of multiple fonts to	48	Therefore another design rationale was the use of multiple fonts to
39	display characters: The idea of a single unicode font which many other	49	display characters: The idea of a single unicode font which many other
40	programs force onto it's users never made sense to me: You should be able	50	programs force onto its users never made sense to me: You should be able
41	to choose any font for any script freely.	51	to choose any font for any script freely.
42		52
43	Apart from that, rxvt-unicode is also much better internationalised than	53	Apart from that, rxvt-unicode is also much better internationalised than
44	it's predecessor, supports things such as XFT and ISO 14755 that are handy	54	its predecessor, supports things such as XFT and ISO 14755 that are handy
45	in i18n-environments, is faster, and has a lot less bugs than the original	55	in i18n-environments, is faster, and has a lot bugs less than the original
46	rxvt. This all in addition to dozens of other small improvements.	56	rxvt. This all in addition to dozens of other small improvements.
47		57
48	It is still faithfully following the original rxvt idea of being lean	58	It is still faithfully following the original rxvt idea of being lean
49	and nice on resources: for example, you can still configure rxvt-unicode	59	and nice on resources: for example, you can still configure rxvt-unicode
50	without most of it's features to get a lean binary. It also comes with	60	without most of its features to get a lean binary. It also comes with
51	a client/daemon pair that lets you open any number of terminal windows	61	a client/daemon pair that lets you open any number of terminal windows
52	from within a single process, which makes startup time very fast and	62	from within a single process, which makes startup time very fast and
53	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and	63	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
54	@@RXVT_NAME@@c(1) (client).	64	@@RXVT_NAME@@c(1) (client).
55		65
56	It also makes technical information about escape sequences (which have	66	It also makes technical information about escape sequences (which have
57	been extended) easier accessible: see @@RXVT_NAME@@(7) for technical	67	been extended) more accessible: see @@RXVT_NAME@@(7) for technical
58	reference documentation (escape sequences etc.) and the FAQ section at the	68	reference documentation (escape sequences etc.).
59	end of this document.
60		69
61	=head1 OPTIONS	70	=head1 OPTIONS
62		71
63	The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed	72	The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed
64	below. In keeping with the smaller-is-better philosophy, options may be	73	below. In keeping with the smaller-is-better philosophy, options may be
…		…
87		96
88	Attempt to open a window on the named X display (B<-d> still	97	Attempt to open a window on the named X display (B<-d> still
89	respected). In the absence of this option, the display specified by the	98	respected). In the absence of this option, the display specified by the
90	B<DISPLAY> environment variable is used.	99	B<DISPLAY> environment variable is used.
91		100
		101	=item B<-depth> I<bitdepth>
		102
		103	Compile I<xft>: Attempt to find a visual with the given bit depth;
		104	resource B<depth>.
		105
92	=item B<-geometry> I<geom>	106	=item B<-geometry> I<geom>
93		107
94	Window geometry (B<-g> still respected); resource B<geometry>.	108	Window geometry (B<-g> still respected); resource B<geometry>.
95		109
96	=item B<-rv>|B<+rv>	110	=item B<-rv>|B<+rv>
97		111
98	Turn on/off simulated reverse video; resource B<reverseVideo>.	112	Turn on/off simulated reverse video; resource B<reverseVideo>.
99		113
100	=item B<-j>|B<+j>	114	=item B<-j>|B<+j>
101		115
102	Turn on/off jump scrolling; resource B<jumpScroll>.	116	Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
103		117
104	=item B<-ip>|B<+ip>	118	=item B<-ss>|B<+ss>
105		119
106	Turn on/off inheriting parent window's pixmap. Alternative form is	120	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
107	B<-tr>; resource B<inheritPixmap>.	121
		122	=item B<-tr>|B<+tr>
		123
		124	Turn on/off illusion of a transparent window background; resource B<transparent>.
		125
		126	B<-ip> is still accepted as an obsolete alias but will be removed in
		127	future versions.
		128
		129	I<Please address all transparency related issues to Sasha Vasko at
		130	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
108		131
109	=item B<-fade> I<number>	132	=item B<-fade> I<number>
110		133
111	Fade the text by the given percentage when focus is lost.	134	Fade the text by the given percentage when focus is lost. Small values
		135	fade a little only, 100 completely replaces all colours by the fade
		136	colour; resource B<fading>.
		137
		138	=item B<-fadecolor> I<colour>
		139
		140	Fade to this colour when fading is used (see B<-fade>). The default colour
		141	is opaque black. resource B<fadeColor>.
112		142
113	=item B<-tint> I<colour>	143	=item B<-tint> I<colour>
114		144
115	Tint the transparent background pixmap with the given colour when	145	Tint the transparent background pixmap with the given colour when
116	transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh>	146	transparency is enabled with B<-tr>. This only works for
		147	non-tiled backgrounds, currently. See also the B<-sh> option that can be
117	option that can be used to brighten or darken the image in addition to	148	used to brighten or darken the image in addition to tinting it.
118	tinting it.	149	Please note that certain tint colours can be applied on the server-side,
		150	thus yielding performance gain of two orders of magnitude. These colours are:
		151	blue, red, green, cyan, magenta, yellow, and those close to them. Also
		152	pure black and pure white colors essentially mean no tinting; resource
		153	I<tintColor>. Example:
119		154
120	=item B<-sh>	155	@@RXVT_NAME@@ -tr -tint blue -sh 40
121		156
		157	=item B<-sh> I<number>
		158
122	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	159	Darken (0 .. 100) or lighten (100 .. 200) the transparent
123	background image in addition to tinting it (i.e. B<-tint> must be	160	background image in addition to (or instead of) tinting it;
124	specified, too).	161	resource I<shading>.
		162
		163	=item B<-blt> I<string>
		164
		165	Specify background blending type. If background pixmap is specified
		166	at the same time as transparency - such pixmap will be blended over
		167	transparency image, using method specified. Supported values are :
		168	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
		169	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
		170	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
		171	alpha-blending. Compile I<afterimage>; resource I<blendType>.
		172
		173	=item B<-blr> I<HxV>
		174
		175	Apply Gaussian Blur with the specified radii to the transparent
		176	background image. If single number is specified - both vertical and
		177	horizontal radii are considered to be the same. Setting one of the
		178	radii to 1 and another to a large number creates interesting effects
		179	on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
		180	resource I<blurRadius>.
125		181
126	=item B<-bg> I<colour>	182	=item B<-bg> I<colour>
127		183
128	Window background colour; resource B<background>.	184	Window background colour; resource B<background>.
129		185
130	=item B<-fg> I<colour>	186	=item B<-fg> I<colour>
131		187
132	Window foreground colour; resource B<foreground>.	188	Window foreground colour; resource B<foreground>.
133		189
134	=item B<-pixmap> I<file[;geom]>	190	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
135		191
136	Compile I<XPM>: Specify XPM file for the background and also optionally	192	Compile I<afterimage>: Specify image file for the background and also
137	specify its scaling with a geometry string. Note you may need to add	193	optionally specify its scaling with a geometry string. Note you may need to
138	quotes to avoid special shell interpretation of the `;' in the	194	add quotes to avoid special shell interpretation of the C<;> in the
139	command-line; resource B<backgroundPixmap>.	195	command-line; for more details see resource B<backgroundPixmap>.
140		196
141	=item B<-cr> I<colour>	197	=item B<-cr> I<colour>
142		198
143	The cursor colour; resource B<cursorColor>.	199	The cursor colour; resource B<cursorColor>.
144		200
…		…
150		206
151	The mouse pointer background colour; resource B<pointerColor2>.	207	The mouse pointer background colour; resource B<pointerColor2>.
152		208
153	=item B<-bd> I<colour>	209	=item B<-bd> I<colour>
154		210
155	The colour of the border between the xterm scrollbar and the text;	211	The colour of the border around the text area and between the scrollbar and the text;
156	resource B<borderColor>.	212	resource B<borderColor>.
157		213
158	=item B<-fn> I<fontname>	214	=item B<-fn> I<fontlist>
159		215
160	Select the fonts to be used. This is a comma seperated list of font	216	Select the fonts to be used. This is a comma separated list of font names
161	names that are used in turn when trying to display Unicode characters.	217	that are checked in order when trying to find glyphs for characters. The
162	The first font defines the cell size for characters; other fonts might	218	first font defines the cell size for characters; other fonts might be
163	be smaller, but not larger. A reasonable default font list is always	219	smaller, but not (in general) larger. A (hopefully) reasonable default
164	appended to it. resource B<font>.	220	font list is always appended to it. See resource B<font> for more details.
		221
		222	In short, to specify an X11 core font, just specify its name or prefix it
		223	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
		224	e.g.:
		225
		226	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
		227	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
165		228
166	See also the question "How does rxvt-unicode choose fonts?" in the FAQ	229	See also the question "How does rxvt-unicode choose fonts?" in the FAQ
167	section.	230	section of @@RXVT_NAME@@(7).
168		231
		232	=item B<-fb> I<fontlist>
		233
		234	Compile I<font-styles>: The bold font list to use when B<bold> characters
		235	are to be printed. See resource B<boldFont> for details.
		236
		237	=item B<-fi> I<fontlist>
		238
		239	Compile I<font-styles>: The italic font list to use when I<italic>
		240	characters are to be printed. See resource B<italicFont> for details.
		241
		242	=item B<-fbi> I<fontlist>
		243
		244	Compile I<font-styles>: The bold italic font list to use when B<< I<bold
		245	italic> >> characters are to be printed. See resource B<boldItalicFont>
		246	for details.
		247
169	=item B<-rb>|B<+rb>	248	=item B<-is>|B<+is>
170		249
171	Enable "real bold" support. When this option is on, bold text will be	250	Compile I<font-styles>: Bold/Blink font styles imply high intensity
172	displayed using the first available bold font in the font list. Bold	251	foreground/background (default). See resource B<intensityStyles> for
173	fonts should thus be specified in the font list after their	252	details.
174	corresponding regular fonts. If no bold font can be found, a regular
175	font will be used. resource B<realBold>.
176		253
177	=item B<-name> I<name>	254	=item B<-name> I<name>
178		255
179	Specify the application name under which resources are to be obtained,	256	Specify the application name under which resources are to be obtained,
180	rather than the default executable file name. Name should not contain	257	rather than the default executable file name. Name should not contain
…		…
218		295
219	Put scrollbar on right/left; resource B<scrollBar_right>.	296	Put scrollbar on right/left; resource B<scrollBar_right>.
220		297
221	=item B<-st>|B<+st>	298	=item B<-st>|B<+st>
222		299
223	Display normal (non XTerm/NeXT) scrollbar without/with a trough;	300	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
224	resource B<scrollBar_floating>.	301	resource B<scrollBar_floating>.
		302
		303	=item B<-ptab>|B<+ptab>
		304
		305	If enabled (default), "Horizontal Tab" characters are being stored as
		306	actual wide characters in the screen buffer, which makes it possible to
		307	select and paste them. Since a horizontal tab is a cursor movement and
		308	not an actual glyph, this can sometimes be visually annoying as the cursor
		309	on a tab character is displayed as a wide cursor; resource B<pastableTabs>.
225		310
226	=item B<-bc>|B<+bc>	311	=item B<-bc>|B<+bc>
227		312
228	Blink the cursor; resource B<cursorBlink>.	313	Blink the cursor; resource B<cursorBlink>.
229		314
…		…
252		337
253	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	338	Compile I<frills>: Set MWM hints to request a borderless window, i.e.
254	if honoured by the WM, the rxvt-unicode window will not have window	339	if honoured by the WM, the rxvt-unicode window will not have window
255	decorations; resource B<borderLess>.	340	decorations; resource B<borderLess>.
256		341
		342	=item B<-override-redirect>
		343
		344	Compile I<frills>: Sets override-redirect on the window; resource
		345	B<override-redirect>.
		346
		347	=item B<-sbg>
		348
		349	Compile I<frills>: Disable the usage of the built-in block graphics/line
		350	drawing characters and just rely on what the specified fonts provide. Use
		351	this if you have a good font and want to use its block graphic glyphs;
		352	resource B<skipBuiltinGlyphs>.
		353
257	=item B<-lsp> I<number>	354	=item B<-lsp> I<number>
258		355
259	Compile I<linespace>: Lines (pixel height) to insert between each row	356	Compile I<frills>: Lines (pixel height) to insert between each row of
260	of the display; resource B<linespace>.	357	the display. Useful to work around font rendering problems; resource
		358	B<lineSpace>.
261		359
262	=item B<-tn> I<termname>	360	=item B<-tn> I<termname>
263		361
264	This option specifies the name of the terminal type to be set in the	362	This option specifies the name of the terminal type to be set in the
265	B<TERM> environment variable. This terminal type must exist in the	363	B<TERM> environment variable. This terminal type must exist in the
…		…
274	given on the command line. If this option is used, it must be the last	372	given on the command line. If this option is used, it must be the last
275	on the command-line. If there is no B<-e> option then the default is to	373	on the command-line. If there is no B<-e> option then the default is to
276	run the program specified by the B<SHELL> environment variable or,	374	run the program specified by the B<SHELL> environment variable or,
277	failing that, I<sh(1)>.	375	failing that, I<sh(1)>.
278		376
		377	Please note that you must specify a program with arguments. If you want to
		378	run shell commands, you have to specify the shell, like this:
		379
		380	@@RXVT_NAME@@ -e sh -c "shell commands"
		381
279	=item B<-title> I<text>	382	=item B<-title> I<text>
280		383
281	Window title (B<-T> still respected); the default title is the basename	384	Window title (B<-T> still respected); the default title is the basename
282	of the program specified after the B<-e> option, if any, otherwise the	385	of the program specified after the B<-e> option, if any, otherwise the
283	application name; resource B<title>.	386	application name; resource B<title>.
…		…
301		404
302	Compile I<XIM>: input method name. resource B<inputMethod>.	405	Compile I<XIM>: input method name. resource B<inputMethod>.
303		406
304	=item B<-imlocale> I<string>	407	=item B<-imlocale> I<string>
305		408
306	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.	409	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
307	de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input	410	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
308	extension to be able to input japanese characters while staying in	411	input extension to be able to input japanese characters while staying in
309	another locale.	412	another locale. resource B<imLocale>.
		413
		414	=item B<-imfont> I<fontset>
		415
		416	Set the font set to use for the X Input Method, see resource B<imFont>
		417	for more info.
		418
		419	=item B<-tcw>
		420
		421	Change the meaning of triple-click selection with the left mouse
		422	button. Only effective when the original (non-perl) selection code is
		423	in-use. Instead of selecting a full line it will extend the selection to
		424	the end of the logical line only. resource B<tripleclickwords>.
310		425
311	=item B<-insecure>	426	=item B<-insecure>
312		427
313	Enable "insecure" mode, which currently enables most of the escape	428	Enable "insecure" mode, which currently enables most of the escape
314	sequences that echo strings. See the resource B<insecure> for more	429	sequences that echo strings. See the resource B<insecure> for more
…		…
328	=item B<-ssr>|B<+ssr>	443	=item B<-ssr>|B<+ssr>
329		444
330	Turn on/off secondary screen scroll (default enabled); resource	445	Turn on/off secondary screen scroll (default enabled); resource
331	B<secondaryScroll>.	446	B<secondaryScroll>.
332		447
		448	=item B<-hold>|B<+hold>
		449
		450	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		451	will not immediately destroy its window when the program executed within
		452	it exits. Instead, it will wait till it is being killed or closed by the
		453	user; resource B<hold>.
		454
333	=item B<-xrm> I<resourcestring>	455	=item B<-xrm> I<string>
334		456
335	No effect on rxvt-unicode. Simply passes through an argument to be made	457	Works like the X Toolkit option of the same name, by adding the I<string>
336	available in the instance's argument list. Appears in I<WM_COMMAND> in	458	as if it were specified in a resource file. Resource values specified this
337	some window managers.	459	way take precedence over all other resource specifications.
		460
		461	Note that you need to use the I<same> syntax as in the .Xdefaults file,
		462	e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
		463	options can be specified as long-options on the commandline, so use
		464	of B<-xrm> is mostly limited to cases where you want to specify other
		465	resources (e.g. for input methods) or for compatibility with other
		466	programs.
		467
		468	=item B<-keysym.>I<sym> I<string>
		469
		470	Remap a key symbol. See resource B<keysym>.
		471
		472	=item B<-embed> I<windowid>
		473
		474	Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
		475	which enables applications to easily embed a terminal.
		476
		477	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
		478	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
		479	quite a bit, so don't expect it to keep some specific state. It's best to
		480	create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
		481
		482	The window will not be destroyed when @@RXVT_NAME@@ exits.
		483
		484	It might be useful to know that @@RXVT_NAME@@ will not close file
		485	descriptors passed to it (except for stdin/out/err, of course), so you
		486	can use file descriptors to communicate with the programs within the
		487	terminal. This works regardless of whether the C<-embed> option was used or
		488	not.
		489
		490	Here is a short Gtk2-perl snippet that illustrates how this option can be
		491	used (a longer example is in F<doc/embed>):
		492
		493	my $rxvt = new Gtk2::Socket;
		494	$rxvt->signal_connect_after (realize => sub {
		495	my $xid = $_[0]->window->get_xid;
		496	system "@@RXVT_NAME@@ -embed $xid &";
		497	});
		498
		499	=item B<-pty-fd> I<file descriptor>
		500
		501	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
		502	pair but instead use the given file descriptor as the tty master. This is
		503	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
		504	without having to run a program within it.
		505
		506	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
		507	entries and will not tinker with pty/tty permissions - you have to do that
		508	yourself if you want that.
		509
		510	As an extremely special case, specifying C<-1> will completely suppress
		511	pty/tty operations, which is probably only useful in conjunction with some
		512	perl extension that manages the terminal.
		513
		514	Here is a example in perl that illustrates how this option can be used (a
		515	longer example is in F<doc/pty-fd>):
		516
		517	use IO::Pty;
		518	use Fcntl;
		519
		520	my $pty = new IO::Pty;
		521	fcntl $pty, F_SETFD, 0; # clear close-on-exec
		522	system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
		523	close $pty;
		524
		525	# now communicate with rxvt
		526	my $slave = $pty->slave;
		527	while (<$slave>) { print $slave "got <$_>\n" }
		528
		529	=item B<-pe> I<string>
		530
		531	Comma-separated list of perl extension scripts to use (or not to use) in
		532	this terminal instance. See resource B<perl-ext> for details.
338		533
339	=back	534	=back
340		535
341	=head1 RESOURCES (available also as long-options)	536	=head1 RESOURCES
342		537
343	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	538	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
344	options) compiled into your version.	539	options) compiled into your version. All resources are also available as
		540	long-options.
345		541
346	There are two different methods that @@RXVT_NAME@@ can use to get the	542	You can set and change the resources using X11 tools like B<xrdb>. Many
347	Xresource data: using the X libraries (Xrm*-functions) or internal	543	distribution do also load settings from the B<~/.Xresources> file when X
348	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	544	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
349	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	545	with later settings overwriting earlier ones:
350	resources using X11 tools like B<xset>. Many distribution do also load
351	settings from the B<~/.Xresources> file when X starts.
352		546
353	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>	547	1. system-wide app-defaults file, either locale-dependent OR global
354	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults	548	2. app-defaults file in $XAPPLRESDIR
355	set in XAPPLOADDIR/URxvt (compile-time defined: usually	549	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
356	B</usr/lib/X11/app-defaults/URxvt>) and resources set in	550	4. SCREEN_RESOURCES for the current screen
357	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.	551	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		552	6. resources specified via -xrm on the commandline
		553
358	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two	554	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
359	class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows	555	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
360	resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be	556	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
361	easily configured, while the class name B<URxvt> allows resources	557	configured, while the class name B<URxvt> allows resources unique to
362	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be	558	B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
363	shared between different B<@@RXVT_NAME@@> configurations. If no	559	configurations. If no resources are specified, suitable defaults will
364	resources are specified, suitable defaults will be used. Command-line	560	be used. Command-line arguments can be used to override resource
365	arguments can be used to override resource settings. The following	561	settings. The following resources are supported (you might want to
366	resources are allowed:	562	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
		563	extensions not documented here):
367		564
368	=over 4	565	=over 4
		566
		567	=item B<depth:> I<bitdepth>
		568
		569	Compile I<xft>: Attempt to find a visual with the given bit depth;
		570	option B<-depth>.
369		571
370	=item B<geometry:> I<geom>	572	=item B<geometry:> I<geom>
371		573
372	Create the window with the specified X window geometry [default 80x24];	574	Create the window with the specified X window geometry [default 80x24];
373	option B<-geometry>.	575	option B<-geometry>.
…		…
389	high-intensity (bold = bright foreground, blink = bright background)	591	high-intensity (bold = bright foreground, blink = bright background)
390	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	592	colours. The canonical names are as follows: 0=black, 1=red, 2=green,
391	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour	593	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
392	names used are listed in the B<COLORS AND GRAPHICS> section.	594	names used are listed in the B<COLORS AND GRAPHICS> section.
393		595
		596	Colours higher than 15 cannot be set using resources (yet), but can be
		597	changed using an escape command (see @@RXVT_NAME@@(7)).
		598
		599	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
		600	88 colour support). Colours 80-87 are evenly spaces grey steps.
		601
394	=item B<colorBD:> I<colour>	602	=item B<colorBD:> I<colour>
395		603
		604	=item B<colorIT:> I<colour>
		605
396	Use the specified colour to display bold characters when the foreground	606	Use the specified colour to display bold or italic characters when the
397	colour is the default. This option will be ignored if B<realBold> is	607	foreground colour is the default. If font styles are not available
398	enabled.	608	(Compile I<styles>) and this option is unset, reverse video is used instead.
399		609
400	=item B<colorUL:> I<colour>	610	=item B<colorUL:> I<colour>
401		611
402	Use the specified colour to display underlined characters when the	612	Use the specified colour to display underlined characters when the
403	foreground colour is the default.	613	foreground colour is the default.
404		614
405	=item B<colorRV:> I<colour>	615	=item B<colorRV:> I<colour>
406		616
407	Use the specified colour as the background for reverse video	617	Use the specified colour as the background for reverse video characters
408	characters.	618	when OPTION_HC is disabled (--disable-frills).
		619
		620	=item B<underlineColor:> I<colour>
		621
		622	If set, use the specified colour as the colour for the underline
		623	itself. If unset, use the foreground colour.
409		624
410	=item B<cursorColor:> I<colour>	625	=item B<cursorColor:> I<colour>
411		626
412	Use the specified colour for the cursor. The default is to use the	627	Use the specified colour for the cursor. The default is to use the
413	foreground colour; option B<-cr>.	628	foreground colour; option B<-cr>.
…		…
424	option B<-rv>. B<False>: regular screen colours [default]; option	639	option B<-rv>. B<False>: regular screen colours [default]; option
425	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	640	B<+rv>. See note in B<COLORS AND GRAPHICS> section.
426		641
427	=item B<jumpScroll:> I<boolean>	642	=item B<jumpScroll:> I<boolean>
428		643
429	B<True>: specify that jump scrolling should be used. When scrolling	644	B<True>: specify that jump scrolling should be used. When receiving lots
430	quickly, fewer screen updates are performed [default]; option B<-j>.	645	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
		646	has been read, resulting in fewer updates while still displaying every
		647	received line; option B<-j>.
		648
431	B<False>: specify that smooth scrolling should be used; option B<+j>.	649	B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
		650	force a screen refresh on each new line it received; option B<+j>.
432		651
433	=item B<inheritPixmap:> I<boolean>	652	=item B<skipScroll:> I<boolean>
434		653
435	B<True>: make the background inherit the parent windows' pixmap, giving	654	B<True>: (the default) specify that skip scrolling should be used. When
436	artificial transparency. B<False>: do not inherit the parent windows'	655	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
437	pixmap.	656	(around 60 times per second), resulting in far fewer updates. This can
		657	result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
		658	option B<-ss>.
		659
		660	B<False>: specify that everything is to be displayed, even
		661	if the refresh is too fast for the human eye to read anything (or the
		662	monitor to display anything); option B<+ss>.
		663
		664	=item B<transparent:> I<boolean>
		665
		666	Turn on/off illusion of a transparent window background.
		667
		668	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
		669	future versions.
		670
		671	I<Please address all transparency related issues to Sasha Vasko at
		672	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
438		673
439	=item B<fading:> I<number>	674	=item B<fading:> I<number>
440		675
441	Fade the text by the given percentage when focus is lost.	676	Fade the text by the given percentage when focus is lost; option B<-fade>.
		677
		678	=item B<fadeColor:> I<colour>
		679
		680	Fade to this colour, when fading is used (see B<fading:>). The default
		681	colour is black; option B<-fadecolor>.
442		682
443	=item B<tintColor:> I<colour>	683	=item B<tintColor:> I<colour>
444		684
445	Tint the transparent background pixmap with the given colour.	685	Tint the transparent background pixmap with the given colour; option
		686	B<-tint>.
446		687
447	=item B<shading:> I<number>	688	=item B<shading:> I<number>
448		689
449	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	690	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
450	image in addition to tinting it.	691	in addition to tinting it; option B<-sh>.
451		692
		693	=item B<blendType:> I<string>
		694
		695	Specify background blending type; option B<-blt>.
		696
452	=item B<fading:> I<number>	697	=item B<blurRadius:> I<number>
453		698
454	Scale the tint colour by the given percentage.	699	Apply Gaussian Blurr with the specified radius to the transparent
		700	background image; option B<-blr>.
455		701
456	=item B<scrollColor:> I<colour>	702	=item B<scrollColor:> I<colour>
457		703
458	Use the specified colour for the scrollbar [default #B2B2B2].	704	Use the specified colour for the scrollbar [default #B2B2B2].
459		705
460	=item B<troughColor:> I<colour>	706	=item B<troughColor:> I<colour>
461		707
462	Use the specified colour for the scrollbar's trough area [default	708	Use the specified colour for the scrollbar's trough area [default
463	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.	709	#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
464		710
		711	=item B<borderColor:> I<colour>
		712
		713	The colour of the border around the text area and between the scrollbar
		714	and the text.
		715
465	=item B<backgroundPixmap:> I<file[;geom]>	716	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
466		717
467	Use the specified XPM file (note the `.xpm' extension is optional) for	718	Use the specified image file for the background and also
468	the background and also optionally specify its scaling with a geometry	719	optionally specify its scaling with a geometry string B<WxH+X+Y>,
469	string B<WxH+X+Y>, in which B<"W" / "H"> specify the	720	(default C<0x0+50+50>) in which B<"W" / "H"> specify the
470	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image	721	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
471	centre (percent). A scale of 0 displays the image with tiling. A scale	722	centre (percent). A scale of 0 displays the image with tiling. A scale
472	of 1 displays the image without any scaling. A scale of 2 to 9	723	of 1 displays the image without any scaling. A scale of 2 to 9 specifies
473	specifies an integer number of images in that direction. No image will	724	an integer number of images in that direction. No image will be magnified
474	be magnified beyond 10 times its original size. The maximum permitted	725	beyond 10 times its original size. The maximum permitted scale is 1000.
475	scale is 1000. [default 0x0+50+50]	726	Additional operations can be specified after colon B<:op1:op2...>.
		727	Supported operations are:
476		728
477	=item B<menu:> I<file[;tag]>	729	tile force background image to be tiled and not scaled. Equivalent to 0x0
		730	propscale will scale image keeping proportions
		731	auto will scale image to match window size. Equivalent to 100x100
		732	hscale will scale image horizontally to the window size
		733	vscale will scale image vertically to the window size
		734	scale will scale image to match window size
		735	root will tile image as if it was a root window background, auto-adjusting
		736	whenever terminal window moves
478		737
479	Read in the specified menu file (note the `.menu' extension is	738	If used in conjunction with B<-tr> option, the specified pixmap will be
480	optional) and also optionally specify a starting tag to find. See the	739	blended over transparency image using either alpha-blending, or any
481	reference documentation for details on the syntax for the menuBar.	740	other blending type, specified with B<-blt "type"> option.
482		741
483	=item B<path:> I<path>	742	=item B<path:> I<path>
484		743
485	Specify the colon-delimited search path for finding files (XPM and	744	Specify the colon-delimited search path for finding background image files.
486	menus), in addition to the paths specified by the B<RXVTPATH> and
487	B<PATH> environment variables.
488		745
489	=item B<font:> I<fontname>	746	=item B<font:> I<fontlist>
490		747
491	Select the fonts to be used. This is a comma seperated list of font	748	Select the fonts to be used. This is a comma separated list of font names
492	names that are used in turn when trying to display Unicode characters.	749	that are checked in order when trying to find glyphs for characters. The
493	The first font defines the cell size for characters; other fonts might	750	first font defines the cell size for characters; other fonts might be
494	be smaller, but not larger. A reasonable default font list is always	751	smaller, but not (in general) larger. A (hopefully) reasonable default
495	appended to it. option B<-fn>.	752	font list is always appended to it; option B<-fn>.
496		753
497	=item B<realBold:> I<boolean>	754	Each font can either be a standard X11 core font (XLFD) name, with
		755	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
498		756
499	B<True>: Enable "real bold" support. When this option is on, bold text	757	In addition, each font can be prefixed with additional hints and
500	will be displayed using the first available bold font in the font list.	758	specifications enclosed in square brackets (C<[]>). The only available
501	Bold fonts should thus be specified in the font list after their	759	hint currently is C<codeset=codeset-name>, and this is only used for Xft
502	corresponding regular fonts. If no bold font can be found, a regular	760	fonts.
503	font will be used. option B<-rb>. B<False>: Display bold text in a
504	regular font, using the color specified with B<colorBD>; option B<+rb>.
505		761
506	=item B<selectstyle:> I<mode>	762	For example, this font resource
507		763
508	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	764	URxvt.font: 9x15bold,\
509	xterm style with 2.20 old word selection, or anything else which gives	765	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
510	xterm style selection.	766	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
		767	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
		768	xft:Code2000:antialias=false
		769
		770	specifies five fonts to be used. The first one is C<9x15bold> (actually
		771	the iso8859-1 version of the second font), which is the base font (because
		772	it is named first) and thus defines the character cell grid to be 9 pixels
		773	wide and 15 pixels high.
		774
		775	The second font is just used to add additional unicode characters not in
		776	the base font, likewise the third, which is unfortunately non-bold, but
		777	the bold version of the font does contain less characters, so this is a
		778	useful supplement.
		779
		780	The third font is an Xft font with aliasing turned off, and the characters
		781	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
		782	contains other characters, but we are not interested in them.
		783
		784	The last font is a useful catch-all font that supplies most of the
		785	remaining unicode characters.
		786
		787	=item B<boldFont:> I<fontlist>
		788
		789	=item B<italicFont:> I<fontlist>
		790
		791	=item B<boldItalicFont:> I<fontlist>
		792
		793	The font list to use for displaying B<bold>, I<italic> or B<< I<bold
		794	italic> >> characters, respectively.
		795
		796	If specified and non-empty, then the syntax is the same as for the
		797	B<font>-resource, and the given font list will be used as is, which makes
		798	it possible to substitute completely different font styles for bold and
		799	italic.
		800
		801	If unset (the default), a suitable font list will be synthesized by
		802	"morphing" the normal text font list into the desired shape. If that is
		803	not possible, replacement fonts of the desired shape will be tried.
		804
		805	If set, but empty, then this specific style is disabled and the normal
		806	text font will being used for the given style.
		807
		808	=item B<intensityStyles:> I<boolean>
		809
		810	When font styles are not enabled, or this option is enabled (B<True>,
		811	option B<-is>, the default), bold/blink font styles imply high
		812	intensity foreground/background colours. Disabling this option (B<False>,
		813	option B<+is>) disables this behaviour, the high intensity colours are not
		814	reachable.
511		815
512	=item B<scrollstyle:> I<mode>	816	=item B<scrollstyle:> I<mode>
513		817
514	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	818	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
515	the author's favourite..	819	the author's favourite.
516		820
517	=item B<title:> I<string>	821	=item B<title:> I<string>
518		822
519	Set window title string, the default title is the command-line	823	Set window title string, the default title is the command-line
520	specified after the B<-e> option, if any, otherwise the application	824	specified after the B<-e> option, if any, otherwise the application
…		…
529	=item B<mapAlert:> I<boolean>	833	=item B<mapAlert:> I<boolean>
530		834
531	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no	835	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
532	de-iconify (map) on receipt of a bell character [default].	836	de-iconify (map) on receipt of a bell character [default].
533		837
		838	=item B<urgentOnBell:> I<boolean>
		839
		840	B<True>: set the urgency hint for the wm on receipt of a bell character.
		841	B<False>: do not set the urgency hint [default].
		842
534	=item B<visualBell:> I<boolean>	843	=item B<visualBell:> I<boolean>
535		844
536	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	845	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
537	B<False>: no visual bell [default]; option B<+vb>.	846	B<False>: no visual bell [default]; option B<+vb>.
538		847
…		…
552		861
553	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use	862	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
554	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or	863	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
555	B<Shift-Print> to include the scrollback as well.	864	B<Shift-Print> to include the scrollback as well.
556		865
		866	The string will be interpreted as if typed into the shell as-is.
		867
		868	Example:
		869
		870	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
		871
		872	This creates a new file in your home directory with the screen contents
		873	every time you hit C<Print>.
		874
557	=item B<scrollBar:> I<boolean>	875	=item B<scrollBar:> I<boolean>
558		876
559	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	877	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
560	disable the scrollbar; option B<+sb>.	878	disable the scrollbar; option B<+sb>.
561		879
…		…
580	B<False>: do not scroll to bottom when tty receives output; option	898	B<False>: do not scroll to bottom when tty receives output; option
581	B<+si>.	899	B<+si>.
582		900
583	=item B<scrollWithBuffer:> I<boolean>	901	=item B<scrollWithBuffer:> I<boolean>
584		902
585	B<True>: scroll with scrollback buffer when tty recieves new lines (and	903	B<True>: scroll with scrollback buffer when tty receives new lines (and
586	B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll	904	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
587	with scrollback buffer when tty recieves new lines; option B<-sw>.	905	with scrollback buffer when tty receives new lines; option B<+sw>.
588		906
589	=item B<scrollTtyKeypress:> I<boolean>	907	=item B<scrollTtyKeypress:> I<boolean>
590		908
591	B<True>: scroll to bottom when a non-special key is pressed. Special keys	909	B<True>: scroll to bottom when a non-special key is pressed. Special keys
592	are those which are intercepted by rxvt-unicode for special handling and	910	are those which are intercepted by rxvt-unicode for special handling and
…		…
611	=item B<borderLess:> I<boolean>	929	=item B<borderLess:> I<boolean>
612		930
613	Set MWM hints to request a borderless window, i.e. if honoured by the	931	Set MWM hints to request a borderless window, i.e. if honoured by the
614	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.	932	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
615		933
		934	=item B<skipBuiltinGlyphs:> I<boolean>
		935
		936	Compile I<frills>: Disable the usage of the built-in block graphics/line
		937	drawing characters and just rely on what the specified fonts provide. Use
		938	this if you have a good font and want to use its block graphic glyphs;
		939	option B<-sbg>.
		940
616	=item B<termName:> I<termname>	941	=item B<termName:> I<termname>
617		942
618	Specifies the terminal type name to be set in the B<TERM> environment	943	Specifies the terminal type name to be set in the B<TERM> environment
619	variable; option B<-tn>.	944	variable; option B<-tn>.
620		945
621	=item B<linespace:> I<number>	946	=item B<lineSpace:> I<number>
622		947
623	Specifies number of lines (pixel height) to insert between each row of	948	Specifies number of lines (pixel height) to insert between each row of
624	the display [default 0]; option B<-lsp>.	949	the display [default 0]; option B<-lsp>.
625		950
626	=item B<meta8:> I<boolean>	951	=item B<meta8:> I<boolean>
…		…
630		955
631	=item B<mouseWheelScrollPage:> I<boolean>	956	=item B<mouseWheelScrollPage:> I<boolean>
632		957
633	B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel	958	B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel
634	scrolls five lines [default].	959	scrolls five lines [default].
		960
		961	=item B<pastableTabs:> I<boolean>
		962
		963	B<True>: store tabs as wide characters. B<False>: interpret tabs as cursor
		964	movement only; option C<-ptab>.
635		965
636	=item B<cursorBlink:> I<boolean>	966	=item B<cursorBlink:> I<boolean>
637		967
638	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	968	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
639	option B<-bc>.	969	option B<-bc>.
…		…
652		982
653	Mouse pointer background colour.	983	Mouse pointer background colour.
654		984
655	=item B<pointerBlankDelay:> I<number>	985	=item B<pointerBlankDelay:> I<number>
656		986
657	Specifies number of seconds before blanking the pointer [default 2].	987	Specifies number of seconds before blanking the pointer [default 2]. Use a
		988	large number (e.g. C<987654321>) to effectively disable the timeout.
658		989
659	=item B<backspacekey:> I<string>	990	=item B<backspacekey:> I<string>
660		991
661	The string to send when the backspace key is pressed. If set to B<DEC>	992	The string to send when the backspace key is pressed. If set to B<DEC>
662	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	993	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
…		…
669	pressed. If unset it will send the sequence traditionally associated	1000	pressed. If unset it will send the sequence traditionally associated
670	with the B<Execute> key.	1001	with the B<Execute> key.
671		1002
672	=item B<cutchars:> I<string>	1003	=item B<cutchars:> I<string>
673		1004
674	The characters used as delimiters for double-click word selection. The	1005	The characters used as delimiters for double-click word selection
675	built-in default:	1006	(whitespace delimiting is added automatically if resource is given).
676		1007
		1008	When the perl selection extension is in use (the default if compiled
		1009	in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
		1010	characters will be created (if the resource exists, otherwise, no regex
		1011	will be created). In this mode, characters outside ISO-8859-1 can be used.
		1012
		1013	When the selection extension is not used, only ISO-8859-1 characters can
		1014	be used. If not specified, the built-in default is used:
		1015
677	B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>	1016	B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
678		1017
679	=item B<preeditType:> I<style>	1018	=item B<preeditType:> I<style>
680		1019
681	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1020	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
682		1021
…		…
684		1023
685	I<name> of inputMethod to use; option B<-im>.	1024	I<name> of inputMethod to use; option B<-im>.
686		1025
687	=item B<imLocale:> I<name>	1026	=item B<imLocale:> I<name>
688		1027
689	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.	1028	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
690	de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input	1029	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
691	extension to be able to input japanese characters while staying in	1030	input extension to be able to input japanese characters while staying in
692	another locale. option B<-imlocale>.	1031	another locale; option B<-imlocale>.
693		1032
694	=item B<insecure>	1033	=item B<imFont:> I<fontset>
		1034
		1035	Specify the font-set used for XIM styles C<OverTheSpot> or
		1036	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
		1037	by commas), i.e. it's not in the same format as the other font lists used
		1038	in @@RXVT_NAME@@. The default will be set-up to chose *any* suitable found
		1039	found, preferably one or two pixels differing in size to the base font.
		1040	option B<-imfont>.
		1041
		1042	=item B<tripleclickwords:> I<boolean>
		1043
		1044	Change the meaning of triple-click selection with the left mouse
		1045	button. Instead of selecting a full line it will extend the selection to
		1046	the end of the logical line only; option B<-tcw>.
		1047
		1048	=item B<insecure:> I<boolean>
695		1049
696	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	1050	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
697	echo arbitrary strings like the icon name or the locale. This could be	1051	echo arbitrary strings like the icon name or the locale. This could be
698	abused if somebody gets 8-bit-clean access to your display, wether	1052	abused if somebody gets 8-bit-clean access to your display, whether
699	throuh a mail client displaying mail bodies unfiltered or though	1053	through a mail client displaying mail bodies unfiltered or through
700	write(1). Therefore, these sequences are disabled by default. (Note	1054	write(1) or any other means. Therefore, these sequences are disabled by
701	that other terminals, including xterm, have these sequences	1055	default. (Note that many other terminals, including xterm, have these
702	enabled by default). You can enable them by setting this boolean	1056	sequences enabled by default, which doesn't make it safer, though).
703	resource or specifying B<-insecure> as an option. At the moment, this	1057
704	enabled display-answer, locale, findfont, icon label and window title	1058	You can enable them by setting this boolean resource or specifying
705	requests as well as dynamic menubar dispatch.	1059	B<-insecure> as an option. At the moment, this enables display-answer,
		1060	locale, findfont, icon label and window title requests.
706		1061
707	=item B<modifier:> I<modifier>	1062	=item B<modifier:> I<modifier>
708		1063
709	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	1064	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
710	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option	1065	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
714		1069
715	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)	1070	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
716	character is passed through. It may contain escape values as described	1071	character is passed through. It may contain escape values as described
717	in the entry on B<keysym> following.	1072	in the entry on B<keysym> following.
718		1073
719	=item B<secondaryScreen:> I<bool>	1074	=item B<secondaryScreen:> I<boolean>
720		1075
721	Turn on/off secondary screen (default enabled).	1076	Turn on/off secondary screen (default enabled).
722		1077
723	=item B<secondaryScroll:> I<bool>	1078	=item B<secondaryScroll:> I<boolean>
724		1079
725	Turn on/off secondary screen scroll (default enabled). If the this	1080	Turn on/off secondary screen scroll (default enabled). If this
726	option is enabled, scrolls on the secondary screen will change the	1081	option is enabled, scrolls on the secondary screen will change the
727	scrollback buffer and switching to/from the secondary screen will	1082	scrollback buffer and switching to/from the secondary screen will
728	instead scroll the screen up.	1083	instead scroll the screen up.
729		1084
		1085	=item B<hold>: I<boolean>
		1086
		1087	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		1088	will not immediately destroy its window when the program executed within
		1089	it exits. Instead, it will wait till it is being killed or closed by the
		1090	user.
		1091
730	=item B<keysym.>I<sym>: I<string>	1092	=item B<keysym.>I<sym>: I<string>
731		1093
732	Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may	1094	Compile I<frills>: Associate I<string> with keysym I<sym>. The
733	contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n:
734	newline, \r: return, \t:
735	tab, \000: octal number) or control characters (^?: delete, ^@: null,
736	^A ...) and may enclosed with double quotes so that it can start or end
737	with whitespace. The intervening resource name B<keysym.> cannot be	1095	intervening resource name B<keysym.> cannot be omitted.
738	omitted. This resource is only available when compiled with	1096
739	KEYSYM_RESOURCE.	1097	The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be
		1098	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,
		1099	B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,
		1100	and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,
		1101	B<2>, B<3>, B<4>, B<5>.
		1102
		1103	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
		1104	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
		1105	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
		1106	current application keymap mode state.
		1107
		1108	The spellings of I<key> can be obtained by using B<xev>(1) command or
		1109	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
		1110	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
		1111	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
		1112	performed in an exact manner; however, the closest match is assured.
		1113
		1114	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
		1115	number), see RESOURCES in C<man 7 X> for futher details.
		1116
		1117	You can define a range of keysyms in one shot by providing a I<string>
		1118	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
		1119	should be a character not used by the strings.
		1120
		1121	Its usage can be demonstrated by an example:
		1122
		1123	URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
		1124
		1125	The above line is equivalent to the following three lines:
		1126
		1127	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
		1128	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
		1129	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
		1130
		1131	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
		1132	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
		1133	example the following means "change the current locale to C<zh_CN.GBK>
		1134	when Control-Meta-c is being pressed":
		1135
		1136	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
		1137
		1138	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
		1139	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
		1140	manpage. For example, the F<selection> extension (activated via
		1141	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
		1142
		1143	URxvt.keysym.M-C-c: perl:selection:rot13
		1144
		1145	Due the the large number of modifier combinations, a defined key mapping
		1146	will match if at I<at least> the specified identifiers are being set, and
		1147	no other key mappings with those and more bits are being defined. That
		1148	means that defining a key map for C<a> will automatically provide
		1149	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
		1150	mappings themselves.
		1151
		1152	Unfortunately, this will override built-in key mappings. For example
		1153	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
		1154	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
		1155	user-defined keymap using the C<builtin:> replacement:
		1156
		1157	URxvt.keysym.Insert: <my insert key sequence>
		1158	URxvt.keysym.S-Insert: builtin:
		1159
		1160	The first line defines a mapping for C<Insert> and I<any> combination
		1161	of modifiers. The second line re-establishes the default mapping for
		1162	C<Shift-Insert>.
		1163
		1164	The following example will map Control-Meta-1 and Control-Meta-2 to
		1165	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
		1166	font-switching at runtime:
		1167
		1168	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
		1169	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
		1170
		1171	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
		1172	info):
		1173
		1174	URxvt.keysym.M-C-3: command:\033[8;25;80t
		1175	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1176
		1177	=item B<perl-ext-common>: I<string>
		1178
		1179	=item B<perl-ext>: I<string>
		1180
		1181	Comma-separated list(s) of perl extension scripts (default: C<default>) to
		1182	use in this terminal instance; option B<-pe>.
		1183
		1184	Extension names can be prefixed with a C<-> sign to prohibit using
		1185	them. This can be useful to selectively disable some extensions loaded
		1186	by default, or specified via the C<perl-ext-common> resource. For
		1187	example, C<default,-selection> will use all the default extension except
		1188	C<selection>.
		1189
		1190	Extension names can also be followed by an argument in angle brackets
		1191	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
		1192	searchable scrollback to Alt/Meta-s). Mentioning the same extension
		1193	multiple times with different arguments will pass multiple arguments to
		1194	the extension.
		1195
		1196	Each extension is looked up in the library directories, loaded if
		1197	necessary, and bound to the current terminal instance.
		1198
		1199	If both of these resources are the empty string, then the perl
		1200	interpreter will not be initialized. The idea behind two options is that
		1201	B<perl-ext-common> will be used for extensions that should be available to
		1202	all instances, while B<perl-ext> is used for specific instances.
		1203
		1204	=item B<perl-eval>: I<string>
		1205
		1206	Perl code to be evaluated when all extensions have been registered. See
		1207	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
		1208	will be ignored when running setuid/setgid.
		1209
		1210	=item B<perl-lib>: I<path>
		1211
		1212	Colon-separated list of additional directories that hold extension
		1213	scripts. When looking for extensions specified by the C<perl> resource,
		1214	@@RXVT_NAME@@ will first look in these directories and then in
		1215	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
		1216	will be ignored when running setuid/setgid.
		1217
		1218	See the @@RXVT_NAME@@perl(3) manpage.
		1219
		1220	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
		1221
		1222	Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
		1223	details.
		1224
		1225	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
		1226
		1227	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
		1228	for details.
		1229
		1230	=item B<searchable-scrollback:> I<keysym>
		1231
		1232	Sets the hotkey that starts the incremental scrollback buffer search
		1233	(default: C<M-s>).
		1234
		1235	=item B<urlLauncher>: I<string>
		1236
		1237	Specifies the program to be started with a URL argument. Used by the
		1238	C<selection-popup> and C<matcher> perl extensions.
		1239
		1240	=item B<transient-for>: I<windowid>
		1241
		1242	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
		1243
		1244	=item B<override-redirect>: I<boolean>
		1245
		1246	Compile I<frills>: Sets override-redirect for the terminal window, making
		1247	it almost invisible to window managers; option B<-override-redirect>.
		1248
		1249	=item B<iso14755_52:> I<boolean>
		1250
		1251	Turn on/off ISO 14755 5.2 mode (default enabled).
740		1252
741	=back	1253	=back
742		1254
743	=head1 THE SCROLLBAR	1255	=head1 THE SCROLLBAR
744		1256
…		…
758	the normal text selection/insertion, hold either the Shift or the Meta	1270	the normal text selection/insertion, hold either the Shift or the Meta
759	(Alt) key while performing the desired mouse action.	1271	(Alt) key while performing the desired mouse action.
760		1272
761	If mouse reporting mode is active, the normal scrollbar actions are	1273	If mouse reporting mode is active, the normal scrollbar actions are
762	disabled -- on the assumption that we are using a fullscreen	1274	disabled -- on the assumption that we are using a fullscreen
763	application. Instead, pressing Button1 and Button3 sends B<ESC[6~>	1275	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
764	(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the	1276	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
765	up and down arrows sends B<ESC[A> (Up) and B<ESC[B> (Down),	1277	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
766	respectively.	1278	respectively.
767		1279
768	=head1 TEXT SELECTION AND INSERTION	1280	=head1 THE SELECTION: SELECTING AND PASTING TEXT
769		1281
770	The behaviour of text selection and insertion mechanism is similar to	1282	The behaviour of text selection and insertion/pasting mechanism is similar
771	I<xterm>(1).	1283	to I<xterm>(1).
772		1284
773	=over 4	1285	=over 4
774		1286
775	=item B<Selection>:	1287	=item B<Selecting>:
776		1288
777	Left click at the beginning of the region, drag to the end of the	1289	Left click at the beginning of the region, drag to the end of the region
778	region and release; Right click to extend the marked region; Left	1290	and release; Right click to extend the marked region; Left double-click
779	double-click to select a word; Left triple-click to select the entire	1291	to select a word; Left triple-click to select the entire logical line
780	line.	1292	(which can span multiple screen lines), unless modified by resource
		1293	B<tripleclickwords>.
781		1294
		1295	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
		1296	(Compile: I<frills>) will create a rectangular selection instead of a
		1297	normal one. In this mode, every selected row becomes its own line in the
		1298	selection, and trailing whitespace is visually underlined and removed from
		1299	the selection.
		1300
782	=item B<Insertion>:	1301	=item B<Pasting>:
783		1302
784	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1303	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
785	an B<@@RXVT_NAME@@> window causes the current text selection to be	1304	window causes the value of the PRIMARY selection (or CLIPBOARD with the
786	inserted as if it had been typed on the keyboard.	1305	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
		1306
		1307	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
		1308	inserted too.
787		1309
788	=back	1310	=back
789		1311
790	=head1 CHANGING FONTS	1312	=head1 CHANGING FONTS
791		1313
792	Changing fonts (or font sizes, respectively) via the keypad is not yet	1314	Changing fonts (or font sizes, respectively) via the keypad is not yet
793	supported in rxvt-unicode. Bug me if you need this.	1315	supported in rxvt-unicode. Bug me if you need this.
794		1316
795	You can, however, switch fonts at runtime using escape sequences (and	1317	You can, however, switch fonts at runtime using escape sequences, e.g.:
796	therefore using the menubar), e.g.:
797		1318
798	printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic"	1319	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
		1320
		1321	You can use keyboard shortcuts, too:
		1322
		1323	URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
		1324	URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
799		1325
800	rxvt-unicode will automatically re-apply these fonts to the output so far.	1326	rxvt-unicode will automatically re-apply these fonts to the output so far.
801		1327
802	=head1 ISO 14755 SUPPORT	1328	=head1 ISO 14755 SUPPORT
803		1329
804	ISO 14755 is a standard for entering and viewing unicode characters	1330	ISO 14755 is a standard for entering and viewing unicode characters
805	and character codes using the keyboard. It consists of 4 parts. The	1331	and character codes using the keyboard. It consists of 4 parts. The
806	first part is available rxvt-unicode has been compiled with	1332	first part is available if rxvt-unicode has been compiled with
807	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1333	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
808	with C<--enable-iso14755>.	1334	with C<--enable-iso14755>.
809		1335
810	=over 4	1336	=over 4
811		1337
812	=item 5.1: Basic method	1338	=item * 5.1: Basic method
813		1339
814	This allows you to enter unicode characters using their hexcode.	1340	This allows you to enter unicode characters using their hexcode.
815		1341
816	Start by pressing and holding both C<Control> and C<Shift>, then enter	1342	Start by pressing and holding both C<Control> and C<Shift>, then enter
817	hex-digits (between one and six). Releasing C<Control> and C<Shift> will	1343	hex-digits (between one and six). Releasing C<Control> and C<Shift> will
…		…
824	address, which you cannot type. Fortunately, the card has the e-mail	1350	address, which you cannot type. Fortunately, the card has the e-mail
825	address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily	1351	address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily
826	by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,	1352	by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
827	followed by releasing the modifier keys.	1353	followed by releasing the modifier keys.
828		1354
829	=item 5.2: Keyboard symbols entry method	1355	=item * 5.2: Keyboard symbols entry method
830		1356
831	This mode lets you input characters representing the keycap symbols of	1357	This mode lets you input characters representing the keycap symbols of
832	your keyboard, if representable in the current locale encoding.	1358	your keyboard, if representable in the current locale encoding.
833		1359
834	Start by pressing C<Control> and C<Shift> together, then releasing	1360	Start by pressing C<Control> and C<Shift> together, then releasing
835	them. The next special key (cursor keys, home etc.) you enter will not	1361	them. The next special key (cursor keys, home etc.) you enter will not
836	invoke it's usual function but instead will insert the corresponding	1362	invoke its usual function but instead will insert the corresponding
837	keycap symbol. The symbol will only be entered when the key has been	1363	keycap symbol. The symbol will only be entered when the key has been
838	released, otherwise pressing e.g. C<Shift> would enter the symbol for	1364	released, otherwise pressing e.g. C<Shift> would enter the symbol for
839	C<ISO Level 2 Switch>, although your intention might have beenm to enter a	1365	C<ISO Level 2 Switch>, although your intention might have been to enter a
840	reverse tab (Shift-Tab).	1366	reverse tab (Shift-Tab).
841		1367
842	=item 5.3: Screen-selection entry method	1368	=item * 5.3: Screen-selection entry method
843		1369
844	While this is implemented already (it's basically the selection	1370	While this is implemented already (it's basically the selection
845	mechanism), it could be extended by displaying a unicode character map.	1371	mechanism), it could be extended by displaying a unicode character map.
846		1372
847	=item 5.4: Feedback method for identifying displayed characters for later input	1373	=item * 5.4: Feedback method for identifying displayed characters for later input
848		1374
849	This method lets you display the unicode character code associated with	1375	This method lets you display the unicode character code associated with
850	characters already displayed.	1376	characters already displayed.
851		1377
852	You enter this mode by holding down C<Control> and C<Shift> together, then	1378	You enter this mode by holding down C<Control> and C<Shift> together, then
853	pressing and holding the left mouse button and moving around. The unicode	1379	pressing and holding the left mouse button and moving around. The unicode
854	hex code(s) (it might be a combining character) of the character under the	1380	hex code(s) (it might be a combining character) of the character under the
855	pointer is displayed until you release C<Control> and C<Shift>.	1381	pointer is displayed until you release C<Control> and C<Shift>.
856		1382
		1383	In addition to the hex codes it will display the font used to draw this
		1384	character - due to implementation reasons, characters combined with
		1385	combining characters, line drawing characters and unknown characters will
		1386	always be drawn using the built-in support font.
		1387
857	=back	1388	=back
858		1389
859	With respect to conformance, rxvt-unicode is supposed to be compliant to	1390	With respect to conformance, rxvt-unicode is supposed to be compliant to
860	both scenario A and B of ISO 14755, including part 5.2.	1391	both scenario A and B of ISO 14755, including part 5.2.
861		1392
862	=head1 LOGIN STAMP	1393	=head1 LOGIN STAMP
863		1394
864	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so	1395	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
865	that it can be seen via the I<who(1)> command, and can accept messages.	1396	it can be seen via the I<who(1)> command, and can accept messages. To
866	To allow this feature, B<@@RXVT_NAME@@> must be installed setuid root on	1397	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
867	some systems.	1398	on some systems or setgid to root or to some other group on others.
868		1399
869	=head1 COLORS AND GRAPHICS	1400	=head1 COLORS AND GRAPHICS
870		1401
871	In addition to the default foreground and background colours,	1402	In addition to the default foreground and background colours,
872	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1403	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
873	high-intensity bold/blink versions of the same). Here is a list of the	1404	high-intensity bold/blink versions of the same). Here is a list of the
874	colours with their B<rgb.txt> names.	1405	colours with their names.
875		1406
876	=begin table	1407	=begin table
877		1408
878	B<color0> (black) = Black	1409	B<color0> (black) = Black
879	B<color1> (red) = Red3	1410	B<color1> (red) = Red3
…		…
899	It is also possible to specify the colour values of B<foreground>,	1430	It is also possible to specify the colour values of B<foreground>,
900	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1431	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
901	a number 0-15, as a convenient shorthand to reference the colour name of	1432	a number 0-15, as a convenient shorthand to reference the colour name of
902	color0-color15.	1433	color0-color15.
903		1434
		1435	In addition to the colours defined above, @@RXVT_NAME@@ offers an
		1436	additional 72 colours. The first 64 of those (with indices 16 to 79)
		1437	consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
		1438	16>), followed by 8 additional shades of gray (with indices 80 to 87).
		1439
		1440	Together, all those colours implement the 88 colour xterm colours. Only
		1441	the first 16 can be changed using resources currently, the rest can only
		1442	be changed via command sequences ("escape codes").
		1443
904	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1444	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
905	always swapping the foreground/background colours. This is in contrast to	1445	always swapping the foreground/background colours. This is in contrast to
906	I<xterm>(1) where the colours are only swapped if they have not otherwise	1446	I<xterm>(1) where the colours are only swapped if they have not otherwise
907	been specified. For example,	1447	been specified. For example,
908		1448
…		…
913	would yield White on Black, while on I<xterm>(1) it would yield Black	1453	would yield White on Black, while on I<xterm>(1) it would yield Black
914	on White.	1454	on White.
915		1455
916	=back	1456	=back
917		1457
918	=head1 FREQUENTLY ASKED QUESTIONS (FAQ)	1458	=head2 ALPHA CHANNEL SUPPORT
		1459
		1460	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
		1461	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
		1462	(recommended, but B<MUST> have 4 digits/component) colour specifications,
		1463	in addition to the ones provided by X, where the additional A component
		1464	specifies opacity (alpha) values. The minimum value of C<0> is completely
		1465	transparent). You can also prefix any color with C<[percent]>, where
		1466	C<percent> is a decimal percentage (0-100) that specifies the opacity of
		1467	the color, where C<0> is completely transparent and C<100> is completelxy
		1468	opaque.
		1469
		1470	You probably need to specify B<"-depth 32">, too, and have the luck that
		1471	your X-server uses ARGB pixel layout, as X is far from just supporting
		1472	ARGB visuals out of the box, and rxvt-unicode just fudges around.
		1473
		1474	For example, the following selects an almost completely transparent red
		1475	background, and an almost opaque pink foreground:
		1476
		1477	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
		1478
		1479	I<Please note that transparency of any kind if completely unsupported by
		1480	the author. Don't bug him with installation questions!>
		1481
		1482	=head1 ENVIRONMENT
		1483
		1484	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
919		1485
920	=over 4	1486	=over 4
921		1487
922	=item How do I know which rxvt-unicode version I'm using?	1488	=item B<TERM>
923		1489
924	The version number is displayed with the usage (-h). For rxvt-unicode	1490	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
925	version 2.14 and later, the escape sequence C<ESC[8n> sets the window	1491	resources or on the command line.
926	title to the version number.
927		1492
928	=item Rxvt-unicode does not seem to understand the selected encoding?	1493	=item B<COLORTERM>
929		1494
930	=item Unicode does not seem to work?	1495	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
		1496	compiled with background image support, and optionally with the added
		1497	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1498	screen.
931		1499
932	If you encounter strange problems like typing an accented character but	1500	=item B<COLORFGBG>
933	getting two unrelated other characters or similar, or if program output is
934	subtly garbled, then you should check your locale settings.
935		1501
936	Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the	1502	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
937	programs. Often rxvt-unicode is started in the C<C> locale, while the	1503	the colour code used as default foreground/text colour (or the string
938	login script running within the rxvt-unicode window changes the locale to	1504	C<default> to indicate that the default-colour escape sequence is to be
939	sth. else, e.h. C<en_GB.UTF-8>. Needless to say, this is not going to work.	1505	used), C<bg> is the colour code used as default background colour (or the
		1506	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
		1507	was compiled with background image support. Libraries like C<ncurses>
		1508	and C<slang> can (and do) use this information to optimize screen output.
940		1509
941	The best thing is to fix your startup environment, as you will likely run	1510	=item B<WINDOWID>
942	into other problems. If nothing works you can try this in your .profile.
943		1511
944	printf '\e]701;%s\007' "$LC_CTYPE"	1512	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
		1513	window, which usually has subwindows for the scrollbar, the terminal
		1514	window and so on).
945		1515
946	If this doesn't work, then maybe you use a C<LC_CTYPE> specification not	1516	=item B<TERMINFO>
947	supported on your systems. Some systems have a C<locale> comamnd which
948	displays this. If it displays sth. like:
949		1517
950	locale: Cannot set LC_CTYPE to default locale: ...	1518	Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
		1519	C<--with-terminfo=PATH>.
951		1520
952	Then the locale you specified is not supported on your system.	1521	=item B<DISPLAY>
953		1522
954	If nothing works and you are sure that everything is set correctly then	1523	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
955	you will need to remember a little known fact: Some programs just don't	1524	display in its child processes.
956	support locales :(
957		1525
958	=item Why do the characters look ugly?	1526	=item B<SHELL>
959		1527
960	=item How does rxvt-unicode choose fonts?	1528	The shell to be used for command execution, defaults to C</bin/sh>.
961		1529
962	Most fonts do not contain the full range of Unicode, which is	1530	=item B<RXVT_SOCKET>
963	fine. Chances are that the font you (or the admin/package maintainer of
964	your system/os) have specified does not cover all the characters you want
965	to display.
966		1531
967	B<rxvt-unicode> makes a best-effort try at finding a replacement	1532	The unix domain socket path used by @@RXVT_NAME@@c(1) and
968	font. Often the result is fine, but sometimes the chosen font looks	1533	@@RXVT_NAME@@d(1).
969	bad. In that case, select a font of your taste and add it to the font
970	list, e.g.:
971		1534
972	@@RXVT_NAME@@ -fn basefont,font2,font3...	1535	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
973		1536
974	When rxvt-unicode sees a character, it will first look at the base	1537	=item B<HOME>
975	font. If the base font does not contain the character, it will go to the
976	next font, and so on.
977		1538
978	The only limitation is that all the fonts must not be larger than the base	1539	Used to locate the default directory for the unix domain socket for
979	font, as the base font defines the principial cell size, which must be the	1540	daemon communications and to locate various resource files (such as
980	same due to the way terminals work.	1541	C<.Xdefaults>)
981		1542
982	=item Why do some chinese characters look so different than others?	1543	=item B<XAPPLRESDIR>
983		1544
984	This is because there is a difference between script and language --	1545	Directory where various X resource files are being located.
985	rxvt-unicode does not know which language the text that is output
986	is, as it only knows the unicode character codes. If rxvt-unicode
987	first sees a japanese character, it might choose a japanese font for
988	it. Subseqzuent japanese characters will take that font. Now, many chinese
989	characters aren't represented in japanese fonts, so when the first
990	non-japanese character comes up, rxvt-unicode will look for a chinese font
991	-- unfortunately at this point, it will still use the japanese font for
992	japanese characters that are also chinese.
993		1546
994	The workaround is easy: just tag a chinese font at the end of your font	1547	=item B<XENVIRONMENT>
995	list (see the previous question). The key is to view the font list as
996	a preference list: If you expect more japanese, list a japanese font
997	first. If you expect more chinese, put a chinese font first.
998		1548
999	In the future it might be possible to switch preferences at runtime (the	1549	If set and accessible, gives the name of a X resource file to be loaded by
1000	internal data structure has no problem with using different fonts for
1001	the same character at the same time, but no interface for this has been
1002	designed yet).
1003
1004	=item How does rxvt-unicode determine the encoding to use?
1005
1006	=item Is there an option to switch encodings?
1007
1008	Unlike some other terminals, rxvt-unicode has no encoding switch, and no
1009	specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
1010	UTF-8 or any other encodings with respect to terminal I/O.
1011
1012	The reasons is that there exists a perfectly fine mechanism for selecting
1013	the encoding, doing I/O and (most important) communicating this to all
1014	applications so everybody agrees on character properties such as width and
1015	code number. This mechanism is the I<locale>.
1016
1017	Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
1018	programs doing the same (that is, most) will automatically agree in the
1019	interpretation of characters.
1020
1021	Unfortunately, there is no system-independent way to select locales, nor
1022	is there a standard on how locale specifiers will look like.
1023
1024	On most systems, the content of the C<LC_CTYPE> environment variable
1025	contains an arbitrary string which corresponds to an already-installed
1026	locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
1027	C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
1028	(i.e. C<de> or C<german>) are also common.
1029
1030	Rxvt-unicode ignores all other locale categories, and except for
1031	the encoding, ignores country or language-specific settings,
1032	i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the same for rxvt-unicode.
1033
1034	If you want to use a specific encoding you have to make sure you start
1035	rxvt-unicode with the correct C<LC_CTYPE> category.
1036
1037	=item Can I switch locales at runtime?
1038
1039	Yes, using an escape sequence. Try sth. like this, which sets
1040	rxvt-unicode's idea of C<LC_CTYPE>.
1041
1042	printf '\e]701;%s\007' ja_JP.SJIS
1043
1044	See also the previous question.
1045
1046	Sometimes this capability is rather handy when you want to work in one
1047	locale (e.g. C<de_DE.UTF-8>) but some programs don't support UTF-8. For
1048	example, I use this script to start C<xjdic>, which first switches to a
1049	locale supported by xjdic and back later:
1050
1051	printf '\e]701;%s\007' ja_JP.SJIS
1052	xjdic -js
1053	printf '\e]701;%s\007' de_DE.UTF-8
1054
1055	=item Can I switch the fonts at runtime?
1056
1057	Yes, using an escape sequence. Try sth. like this, which has the same
1058	effect as using the C<-fn> switch, and takes effect immediately:
1059
1060	printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
1061
1062	This is useful if you e.g. work primarily with japanese (and prefer a
1063	japanese font), but you have to switch to chinese temporarily, where
1064	japanese fonts would only be in your way.
1065
1066	You can think of this as a kind of manual ISO-2022 switching.
1067
1068	=item Mouse cut/paste suddenly no longer works.
1069
1070	Make sure that mouse reporting is actually turned off since killing
1071	some editors prematurely may leave the mouse in mouse report mode. I've
1072	heard that tcsh may use mouse reporting unless it otherwise specified. A
1073	quick check is to see if cut/paste works when the Alt or Shift keys are
1074	depressed. See @@RXVT_NAME@@(7)
1075
1076	=item What's with this bold/blink stuff?
1077
1078	If no bold colour is set via C<colorBD:>, bold will invert text using the
1079	standard foreground colour.
1080
1081	For the standard background colour, blinking will actually make the
1082	text blink when compiled with C<--enable-blinking>. with standard
1083	colours. Without C<--enable-blinking>, the blink attribute will be
1084	ignored.
1085
1086	On ANSI colours, bold/blink attributes are used to set high-intensity
1087	foreground/background colors.
1088
1089	color0-7 are the low-intensity colors.
1090
1091	color8-15 are the corresponding high-intensity colors.
1092
1093	=item I don't like the screen colors. How do I change them?
1094
1095	You can change the screen colors at run-time using F<~/.Xdefaults>
1096	resources (or as long-options).
1097
1098	Here are values that are supposed to resemble a VGA screen,
1099	including the murky brown that passes for low-intensity yellow:
1100
1101	Rxvt*color0: #000000
1102	Rxvt*color1: #A80000
1103	Rxvt*color2: #00A800
1104	Rxvt*color3: #A8A800
1105	Rxvt*color4: #0000A8
1106	Rxvt*color5: #A800A8
1107	Rxvt*color6: #00A8A8
1108	Rxvt*color7: #A8A8A8
1109
1110	Rxvt*color8: #000054
1111	Rxvt*color9: #FF0054
1112	Rxvt*color10: #00FF54
1113	Rxvt*color11: #FFFF54
1114	Rxvt*color12: #0000FF
1115	Rxvt*color13: #FF00FF
1116	Rxvt*color14: #00FFFF
1117	Rxvt*color15: #FFFFFF
1118
1119	=item What's with the strange Backspace/Delete key behaviour?
1120
1121	Assuming that the physical Backspace key corresponds to the
1122	BackSpace keysym (not likely for Linux ... see the following
1123	question) there are two standard values that can be used for
1124	Backspace: C<^H> and C<^?>.
1125
1126	Historically, either value is correct, but rxvt-unicode adopts the debian
1127	policy of using C<^?> when unsure, because it's the one only only correct
1128	choice :).
1129
1130	Rxvt-unicode tries to inherit the current stty settings and uses the value
1131	of `erase' to guess the value for backspace. If rxvt-unicode wasn't
1132	started from a terminal (say, from a menu or by remote shell), then the
1133	system value of `erase', which corresponds to CERASE in <termios.h>, will
1134	be used (which may not be the same as your stty setting).
1135
1136	For starting a new rxvt-unicode:
1137
1138	# use Backspace = ^H
1139	$ stty erase ^H
1140	$ @@RXVT_NAME@@	1550	@@RXVT_NAME@@.
1141
1142	# use Backspace = ^?
1143	$ stty erase ^?
1144	$ @@RXVT_NAME@@
1145
1146	Toggle with "ESC[36h" / "ESC[36l" as documented in @@RXVT_NAME@@(7).
1147
1148	For an existing rxvt-unicode:
1149
1150	# use Backspace = ^H
1151	$ stty erase ^H
1152	$ echo -n "^[[36h"
1153
1154	# use Backspace = ^?
1155	$ stty erase ^?
1156	$ echo -n "^[[36l"
1157
1158	This helps satisfy some of the Backspace discrepancies that occur, but
1159	if you use Backspace = C<^H>, make sure that the termcap/terminfo value
1160	properly reflects that.
1161
1162	The Delete key is a another casualty of the ill-defined Backspace problem.
1163	To avoid confusion between the Backspace and Delete keys, the Delete
1164	key has been assigned an escape sequence to match the vt100 for Execute
1165	(ESC[3~) and is in the supplied termcap/terminfo.
1166
1167	Some other Backspace problems:
1168
1169	some editors use termcap/terminfo,
1170	some editors (vim I'm told) expect Backspace = ^H,
1171	GNU Emacs (and Emacs-like editors) use ^H for help.
1172
1173	Perhaps someday this will all be resolved in a consistent manner.
1174
1175	=item I don't like the key-bindings. How do I change them?
1176
1177	There are some compile-time selections available via configure. Unless
1178	you have run "configure" with the C<--disable-resources> option you can
1179	use the `keysym' resource to alter the keystrings associated with keysym
1180	0xFF00 - 0xFFFF (function, cursor keys, etc).
1181
1182	Here's an example for a tn3270 session started using `@@RXVT_NAME@@ -name tn3270'
1183
1184	!# ----- special uses ------:
1185	! tn3270 login, remap function and arrow keys.
1186	tn3270*font: *clean-bold-*-*--15-*
1187
1188	! keysym - used by rxvt only
1189	! Delete - ^D
1190	tn3270*keysym.0xFFFF: \004
1191
1192	! Home - ^A
1193	tn3270*keysym.0xFF50: \001
1194	! Left - ^B
1195	tn3270*keysym.0xFF51: \002
1196	! Up - ^P
1197	tn3270*keysym.0xFF52: \020
1198	! Right - ^F
1199	tn3270*keysym.0xFF53: \006
1200	! Down - ^N
1201	tn3270*keysym.0xFF54: \016
1202	! End - ^E
1203	tn3270*keysym.0xFF57: \005
1204
1205	! F1 - F12
1206	tn3270*keysym.0xFFBE: \e1
1207	tn3270*keysym.0xFFBF: \e2
1208	tn3270*keysym.0xFFC0: \e3
1209	tn3270*keysym.0xFFC1: \e4
1210	tn3270*keysym.0xFFC2: \e5
1211	tn3270*keysym.0xFFC3: \e6
1212	tn3270*keysym.0xFFC4: \e7
1213	tn3270*keysym.0xFFC5: \e8
1214	tn3270*keysym.0xFFC6: \e9
1215	tn3270*keysym.0xFFC7: \e0
1216	tn3270*keysym.0xFFC8: \e-
1217	tn3270*keysym.0xFFC9: \e=
1218
1219	! map Prior/Next to F7/F8
1220	tn3270*keysym.0xFF55: \e7
1221	tn3270*keysym.0xFF56: \e8
1222
1223	=item I'm using keyboard model XXX that has extra Prior/Next/Insert keys.
1224	How do I make use of them? For example, the Sun Keyboard type 4
1225	has the following mappings that rxvt-unicode doesn't recognize.
1226
1227	KP_Insert == Insert
1228	F22 == Print
1229	F27 == Home
1230	F29 == Prior
1231	F33 == End
1232	F35 == Next
1233
1234	Rather than have rxvt-unicode try to accomodate all the various possible keyboard
1235	mappings, it is better to use `xmodmap' to remap the keys as required for
1236	your particular machine.
1237
1238	=item How do I distinguish if I'm running rxvt-unicode or a regular xterm?
1239	I need this to decide about setting colors etc.
1240
1241	rxvt and rxvt-unicode always export the variable "COLORTERM", so you can
1242	check and see if that is set. Note that several programs, JED, slrn,
1243	Midnight Commander automatically check this variable to decide whether or
1244	not to use color.
1245
1246	=item How do I set the correct, full IP address for the DISPLAY variable?
1247
1248	If you've compiled rxvt-unicode with DISPLAY_IS_IP and ahve enabled
1249	insecure mode then it is possible to use the following shell script
1250	snippets to correctly set the display. If your version of rxvt-unicode
1251	wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
1252	the COLORTERM variable can be used to distinguish rxvt-unicode from a
1253	regular xterm.
1254
1255	Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
1256	snippets:
1257
1258	# Bourne/Korn/POSIX family of shells:
1259	[ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
1260	if [ ${TERM:-foo} = xterm ]; then
1261	stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
1262	echo -n '^[Z'
1263	read term_id
1264	stty icanon echo
1265	if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
1266	echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
1267	read DISPLAY # set it in our local shell
1268	fi
1269	fi
1270
1271	=item How do I compile the manual pages for myself?
1272
1273	You need to have a recent version of perl installed as F</usr/bin/perl>,
1274	one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to
1275	the doc subdirectory and enter C<make alldoc>.
1276		1551
1277	=back	1552	=back
1278		1553
1279	=head1 ENVIRONMENT
1280
1281	B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM>
1282	and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X
1283	window id number of the B<@@RXVT_NAME@@> window and it also uses and
1284	sets the environment variable B<DISPLAY> to specify which display
1285	terminal to use. B<@@RXVT_NAME@@> uses the environment variables
1286	B<RXVTPATH> and B<PATH> to find XPM files.
1287
1288	=head1 FILES	1554	=head1 FILES
1289		1555
1290	=over 4	1556	=over 4
1291		1557
1292	=item B</etc/utmp>
1293
1294	System file for login records.
1295
1296	=item B</usr/lib/X11/rgb.txt>	1558	=item B</usr/lib/X11/rgb.txt>
1297		1559
1298	Color names.	1560	Color names.
1299		1561
1300	=back	1562	=back
1301		1563
1302	=head1 SEE ALSO	1564	=head1 SEE ALSO
1303		1565
1304	@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)	1566	@@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)
1305
1306	=head1 BUGS
1307
1308	Check the BUGS file for an up-to-date list.
1309
1310	Cursor change support is not yet implemented.
1311
1312	Click-and-drag doesn't work with X11 mouse report overriding.
1313		1567
1314	=head1 CURRENT PROJECT COORDINATOR	1568	=head1 CURRENT PROJECT COORDINATOR
1315		1569
1316	=over 4	1570	=over 4
1317		1571
1318	=item Project Coordinator	1572	=item Project Coordinator
1319		1573
1320	@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@>	1574	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1321		1575
1322	=item Web page maintainter	1576	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1323
1324	@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1325
1326	L<@@RXVT_WEBPAGE@@>
1327		1577
1328	=back	1578	=back
1329		1579
1330	=head1 AUTHORS	1580	=head1 AUTHORS
1331		1581
…		…
1353		1603
1354	Project Coordinator (changes.txt 2.21a to 2.4.5)	1604	Project Coordinator (changes.txt 2.21a to 2.4.5)
1355		1605
1356	=item Geoff Wing L<< <gcw@pobox.com> >>	1606	=item Geoff Wing L<< <gcw@pobox.com> >>
1357		1607
1358	Rewrote screen display and text selection routines. Project Coordinator	1608	Rewrote screen display and text selection routines.
		1609
1359	(changes.txt 2.4.6 - rxvt-unicode)	1610	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1360		1611
1361	=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >>	1612	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1362		1613
1363	Forked rxvt-unicode, rewrote most of the display code and internal	1614	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1364	character handling to store text in unicode, improve xterm	1615	extension, random hacks, numerous bugfixes and extensions.
1365	compatibility and apply numerous other bugfixes and extensions.
1366		1616
1367	Project Coordinator (Changes 1.0 -)	1617	Project Coordinator (Changes 1.0 -)
1368		1618
		1619	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
		1620
		1621	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
		1622
1369	=back	1623	=back
1370		1624

Diff Legend

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