ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/rxvt-unicode/doc/rxvt.1.pod

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

Diff Legend

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