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.22 by root, Tue Aug 24 15:46:27 2004 UTC vs.
Revision 1.131 by ayin, Sat Jun 9 09:05:38 2007 UTC

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

Diff Legend

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